diff --git a/.azure-pipelines/PrettierCheck.yml b/.azure-pipelines/PrettierCheck.yml
index f0dd05c49e7d..6880699cf0c2 100644
--- a/.azure-pipelines/PrettierCheck.yml
+++ b/.azure-pipelines/PrettierCheck.yml
@@ -1,6 +1,5 @@
jobs:
- job: "PrettierCheck"
- condition: "not(variables['PRIVATE'])"
variables:
NODE_OPTIONS: '--max-old-space-size=8192'
pool:
diff --git a/.azure-pipelines/SDKAutomation.yml b/.azure-pipelines/SDKAutomation.yml
index a567d468ab0b..982a0fd77d77 100644
--- a/.azure-pipelines/SDKAutomation.yml
+++ b/.azure-pipelines/SDKAutomation.yml
@@ -41,9 +41,8 @@ jobs:
SDK_REPO_NAME: azure-sdk-for-go
Trenton:
SDK_REPO_NAME: azure-sdk-for-trenton
- ${{ if eq(variables['ENABLE_RESOURCE_MANAGER_SCHEMAS'], 'true') }}:
- Schema:
- SDK_REPO_NAME: azure-resource-manager-schemas
+ Schema:
+ SDK_REPO_NAME: azure-resource-manager-schemas
steps:
- checkout: none
- script: |
@@ -80,6 +79,7 @@ jobs:
-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)
diff --git a/.azure-pipelines/Spellcheck.yml b/.azure-pipelines/Spellcheck.yml
index 5d7e59f14160..4adb4fc0c266 100644
--- a/.azure-pipelines/Spellcheck.yml
+++ b/.azure-pipelines/Spellcheck.yml
@@ -1,6 +1,5 @@
jobs:
- job: "Spellcheck"
- condition: "not(variables['PRIVATE'])"
variables:
NODE_OPTIONS: '--max-old-space-size=8192'
pool:
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
index 3c2cfcde11b6..cc4fa7417dcd 100644
--- a/.github/PULL_REQUEST_TEMPLATE.md
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -14,6 +14,8 @@ If any further question about AME onboarding or validation tools, please view th
- Adding a new API version
- Adding a new service
+- [ ] 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.
+
- [ ] 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
diff --git a/.github/comment.yml b/.github/comment.yml
new file mode 100644
index 000000000000..d52fd9f8c403
--- /dev/null
+++ b/.github/comment.yml
@@ -0,0 +1,33 @@
+---
+- rule:
+ type: checkbox
+ keywords:
+ - "Removing API(s)"
+ - "Updating API in stable version"
+ onCheckedLabels:
+ - breakingChange
+
+- rule:
+ type: checkbox
+ keywords:
+ - "WaitForARMFeedback"
+ 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} "
+
+- rule:
+ type: checkbox
+ keywords:
+ - "I have reviewed the [documentation](https://aka.ms/ameonboard) for the workflow."
+ onCheckedComments: "Hi, @${PRAuthor} Thanks for your PR. I am workflow bot for review process. Here are some small tips.
Please ensure to do self-check against checklists in first PR comment.
PR assignee is the person auto-assigned and responsible for your current PR reviewing and merging.
If there is CI failure(s), to fix CI error(s) is mandatory for PR merging; or you need to provide justification in PR comment for explanation. [How to fix?](https://github.com/Azure/azure-rest-api-specs/blob/master/documentation/ci-fix.md)
Any feedback about review process or workflow bot, pls contact swagger and tools team. vsswagger@microsoft.com"
+
+- rule:
+ type: label
+ label: BreakingChangeReviewRequired
+ onLabeledComments: "Hi @${PRAuthor}, one or multiple breaking change(s) is detected in your PR. Pls follow [breaking change policy](https://aka.ms/AzBreakingChangesPolicy) to request breaking change review and approval before proceeding swagger PR review. "
+
+- rule:
+ type: label
+ label: ApprovedOkToMerge
+ onLabeledComments: "Hi @${PRAuthor},Your PR is approved. Congratulations.
If your PR is in public repo (azure-rest-api-specs), PR assignee will merge all updates in the PR shortly afterwards; or pause the PR merge, you need to put on a label DoNotMerge to PR as soon as possible.
If your PR is in private repo (azure-rest-api-specs-pr), there won’t be PR merge. Please refer to this [wiki](https://dev.azure.com/azure-sdk/internal/_wiki/wikis/internal.wiki/205/RP-Scenarios-to-Contribute-to-Swagger?anchor=**public-repository-vs.-private-repository**) for further guidance on how to proceed.
"
diff --git a/.github/issue_assignment.yml b/.github/issue_assignment.yml
index a33797d7ddb7..40be9f7f70ed 100644
--- a/.github/issue_assignment.yml
+++ b/.github/issue_assignment.yml
@@ -4,7 +4,7 @@
assignees:
- yungezz
- erich-wang
- - NullMDR
+ - PhoenixHe-msft
- raych1
- lirenhe
- weidongxu-microsoft
@@ -19,4 +19,3 @@
- qianwens
- ruowan
- MyronFanQiu
- - jianyexi
diff --git a/.github/pull_request_assignment.yml b/.github/pull_request_assignment.yml
index abdb98fcfd0c..c014dedd9e78 100644
--- a/.github/pull_request_assignment.yml
+++ b/.github/pull_request_assignment.yml
@@ -1,4 +1,11 @@
---
+- rule:
+ # eventgrid data-plane PR
+ paths:
+ - "specification/eventgrid/data-plane/**"
+ reviewers:
+ - lmazuel
+
- rule:
# data-plane PR
paths:
@@ -8,12 +15,13 @@
- jhendrixMSFT
- lmazuel
- tjprescott
+
- rule:
paths:
- "specification/network/**"
reviewers:
- - MyronFanQiu
+ - kairu-ms
- lirenhe
- rule:
@@ -22,6 +30,11 @@
reviewers:
- MyronFanQiu
+- rule:
+ paths: "specification/@(resources|powerplatform)/**"
+ reviewers:
+ - raych1
+
- rule:
paths: "specification/compute/**"
reviewers:
@@ -29,11 +42,6 @@
- fengzhou-msft
- yungezz
-- rule:
- paths: "specification/@(resources|powerplatform)/**"
- reviewers:
- - raych1
-
- rule:
paths:
- "specification/machinelearningservices/**"
@@ -64,7 +72,7 @@
- "specification/monitor/**"
reviewers:
- weidongxu-microsoft
- - MyronFanQiu
+ - kairu-ms
- rule:
paths:
@@ -73,11 +81,11 @@
- qianwens
- Juliehzl
-- rule:
- paths: "specification/mediaservices/**"
- reviewers:
- - allenjzhang
+- rule:
+ paths: "specification/mediaservices/**"
+ reviewers:
+ - allenjzhang
- rule:
paths:
- "specification/@(keyvault|notificationhubs)/**"
@@ -89,7 +97,7 @@
paths:
- "specification/@(containerservice|containerinstance)/**"
reviewers:
- - NullMDR
+ - PhoenixHe-msft
- fengzhou-msft
- yungezz
@@ -104,7 +112,7 @@
paths:
- "specification/portal/**"
reviewers:
- - NullMDR
+ - PhoenixHe-msft
- rule:
paths:
@@ -128,7 +136,25 @@
- ".azure-pipelines-preproduction/**"
reviewers:
- akning-ms
- - NullMDR
+ - PhoenixHe-msft
+
+- rule:
+ paths:
+ - "documentation/**"
+ reviewers:
+ - josefree
+ - akning-ms
+
+- rule:
+ paths:
+ - "**/package.json"
+ - ".github/**"
+ - "**/azure-pipelines.yml"
+ - ".azure-pipelines/**"
+ - ".azure-pipelines-preproduction/**"
+ reviewers:
+ - akning-ms
+ - PhoenixHe-msft
- raych1
- rule:
@@ -138,17 +164,16 @@
reviewers:
- yungezz
- erich-wang
- - NullMDR
- - raych1
+ - PhoenixHe-msft
- lirenhe
- weidongxu-microsoft
- ArcturusZhang
- xccc-msft
+ - raych1
- ChenTanyi
- fengzhou-msft
- njuCZ
- akning-ms
- - markcowl
- leni-msft
- qianwens
- ruowan
diff --git a/CODEOWNERS b/CODEOWNERS
index 189ce8104fc5..85d25e6344a8 100644
--- a/CODEOWNERS
+++ b/CODEOWNERS
@@ -1,14 +1,14 @@
/specification/analysisservices/ @taiwu
/specification/alertsmanagement/ @ofirmanor @olalavi @erangon @orieldar @ilaizi @shakednai1 @khaboasb @orenhor
/specification/apimanagement/ @promoisha @solankisamir
-/specification/applicationinsights/ @alexeldeib
+/specification/applicationinsights/ @alexeldeib @reyang @TimothyMothra @ramthi @rajkumar-rangaraj @markwolff @trask @hectorhdzg @lzchen
/specification/asazure/ @athipp
/specification/authorization/ @darshanhs90 @stankovski
/specification/automation/ @vrdmr
/specification/azsadmin/ @deathly809
/specification/batch/ @matthchr @xingwu1
/specification/batchai/ @alexanderyukhanov
-/specification/billing/ @wilcobmsft
+/specification/billing/ @wilcobmsft @asarkar84
/specification/cdn/ @csmengwan @injyzarif @prakharsharma10
/specification/cognitiveservices/ @felixwa @yangyuan
/specification/compute/ @bilaakpan-ms @sandido @dkulkarni-ms @haagha @madewithsmiles @MS-syh2qs @grizzlytheodore @hyonholee @mabhard @danielli90 @smotwani @ppatwa @vikramd-ms @savyasachisamal @yunusm @ZhidongPeng @nkuchta @maheshnemichand @najams @changov
@@ -60,7 +60,7 @@
/specification/relay/ @sethmanheim @v-ajnava
/specification/resources/ @Tiano2017 @rajshah11 @vivsriaus
/specification/scheduler/ @pinwang81
-/specification/search/data-plane/ @brjohnstmsft @arv100kri @bleroy
+/specification/search/data-plane/ @brjohnstmsft @arv100kri @bleroy @heaths @AlexGhiondea
/specification/search/resource-manager/ @abhi1509 @miwelsh @tjacobhi
/specification/serialconsole/ @amitchat @craigw @asinn826
/specification/service-map/ @daveirwin1
diff --git a/azure-rest-api-specs b/azure-rest-api-specs
deleted file mode 160000
index f83281b2fed8..000000000000
--- a/azure-rest-api-specs
+++ /dev/null
@@ -1 +0,0 @@
-Subproject commit f83281b2fed8011962c4e91b7b0270f6391a0832
diff --git a/cSpell.json b/cSpell.json
index 15c786ff967f..18bace57769c 100644
--- a/cSpell.json
+++ b/cSpell.json
@@ -728,13 +728,24 @@
"Fcontoso",
"Fpushpins"
]
- }
- ,
+ },
{
"filename": "**/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-09-21-preview2/communicationserviceschat.json",
"words": [
"readreceipts"
]
+ },
+ {
+ "filename": "**/specification/communication/data-plane/Microsoft.CommunicationServicesAdministration/preview/2020-07-20-preview1/communicationservicesadministration.json",
+ "words": [
+ "areacodes",
+ "locationoptions",
+ "phonenumbers",
+ "phoneplangroups",
+ "phoneplans",
+ "pstn",
+ "unconfiguring"
+ ]
}
]
-}
+}
\ No newline at end of file
diff --git a/custom-words.txt b/custom-words.txt
index 6aa19385dc88..b073225beb55 100644
--- a/custom-words.txt
+++ b/custom-words.txt
@@ -282,6 +282,7 @@ Certificatethumbprint
certverify
Chademo
chainer
+changedSince
changepoint
changestate
CHECKACCESS
@@ -317,6 +318,7 @@ clustermonitoring
clustername
Cmdkey
cmdlet
+CMAF
CMMI
CNAME
cntk
@@ -404,6 +406,7 @@ Datacenter
datacenters
datacontenttype
datadisk
+Datadog
datafactory
datafactoryv
dataflows
@@ -479,6 +482,7 @@ devtestlabs
dewpoint
dhcp
diagnosticcontext
+diarization
digitaltwins
DIMM
disableautoscale
@@ -869,6 +873,7 @@ libtrust
lifecycle
lifetimejobstats
lifetimepoolstats
+Liftr
Linestring
linkedservices
linkexpiryinminutes
@@ -1159,6 +1164,7 @@ Paypal
PBIE
PCIE
PCNET
+PDFs
peerings
Pendingissuance
Pendingrevocation
@@ -1204,6 +1210,7 @@ powerbidedicated
powerbiembedded
poweredoff
poweroff
+pptx
prebackup
prebackupvalidation
prebuilts
@@ -1631,6 +1638,7 @@ tablevaluedfunctions
tagname
tagsandregions
tagvalue
+TARGETDURATION
taskcompletion
taskcounts
taskfailure
@@ -1675,7 +1683,9 @@ topqueries
topquery
TPEG
traceback
+traceparent
traceroute
+tracestate
trafficmanager
trafficmanageranalytics
trafficmanagerprofiles
@@ -1739,6 +1749,7 @@ unparsed
unprepare
unprepares
unpreparing
+Unprocessable
Unprovision
unprovisioned
Unprovisioning
@@ -1963,3 +1974,12 @@ Setget
Ruleproperties
shamir_share
dllpath
+MSIX
+msix
+MSIXpackages
+msixpackages
+appxmanifest
+Appxmanifest
+msixpackage
+xml
+Creds
\ No newline at end of file
diff --git a/documentation/Semantic-and-Model-Violations-Reference.md b/documentation/Semantic-and-Model-Violations-Reference.md
index de459aa90c63..0742ec712138 100644
--- a/documentation/Semantic-and-Model-Violations-Reference.md
+++ b/documentation/Semantic-and-Model-Violations-Reference.md
@@ -59,10 +59,12 @@ This document lists the set of automated rules that can be validated against swa
| [REMOTE_NOT_VALID](#REMOTE_NOT_VALID) | |
| [INVALID_REQUEST_PARAMETER](#INVALID_REQUEST_PARAMETER) | |
| [INVALID_RESPONSE_CODE](#INVALID_RESPONSE_CODE) | |
+| [INVALID_RESPONSE_BODY](#INVALID_RESPONSE_BODY) | |
| [MISSING_REQUIRED_PARAMETER](#MISSING_REQUIRED_PARAMETER) | |
| [KEYWORD_TYPE_EXPECTED](#KEYWORD_TYPE_EXPECTED) | |
| [READONLY_PROPERTY_NOT_ALLOWED_IN_REQUEST](#READONLY_PROPERTY_NOT_ALLOWED_IN_REQUEST) | |
| [SCHEMA_VALIDATION_FAILED](#SCHEMA_VALIDATION_FAILED) | |
+| [DISCRIMINATOR_VALUE_NOT_FOUND](#DISCRIMINATOR_VALUE_NOT_FOUND) | |
| [DISCRIMINATOR_NOT_REQUIRED](#DISCRIMINATOR_NOT_REQUIRED) | [OAV131](#DISCRIMINATOR_NOT_REQUIRED) |
| [RESPONSE_BODY_NOT_IN_EXAMPLE](#RESPONSE_BODY_NOT_IN_EXAMPLE) | [OAV130](#RESPONSE_BODY_NOT_IN_EXAMPLE) |
| [DOUBLE_FORWARD_SLASHES_IN_URL](#DOUBLE_FORWARD_SLASHES_IN_URL) | [OAV129](#DOUBLE_FORWARD_SLASHES_IN_URL) |
@@ -546,6 +548,15 @@ This document lists the set of automated rules that can be validated against swa
**How to fix the violation**: Remove extra response code definition in example or correct it.
+### INVALID_RESPONSE_BODY
+
+**Output Message**:Body is required in response but not provided
+
+**Description**: Body schema is defined in swagger but body is not found in example or traffic.
+
+**How to fix the violation**: Add response body.
+
+
### KEYWORD_TYPE_EXPECTED
**Output Message**: Keyword 'type' is expected to be of type 'array,boolean,integer,number,null,object,string'.
@@ -611,6 +622,14 @@ This document lists the set of automated rules that can be validated against swa
**How to fix the violation**: Provide the requried property in example or remove this property from the required list of the definition in swagger spec. Or add items property if the type is array.
+### DISCRIMINATOR_VALUE_NOT_FOUND
+
+**Output Message**: Discriminator value "{0}" not found
+
+**Description**: The property used as discriminator has a value {0} but it's not found in swagger spec.
+
+**How to fix the violation**: Add the model that has the discriminator value or fix the discriminator value. The discriminator value could be specified by model name in definitions or by "x-ms-discriminator-value".
+
### DISCRIMINATOR_NOT_REQUIRED
diff --git a/documentation/code-gen/configure-go-sdk.md b/documentation/code-gen/configure-go-sdk.md
new file mode 100644
index 000000000000..b044ee08363f
--- /dev/null
+++ b/documentation/code-gen/configure-go-sdk.md
@@ -0,0 +1,291 @@
+# Readme Configuration Guide for Azure SDK for Go
+
+This file describe how to configure readme files to make it available for Azure SDK for Go code generation.
+
+## Common Configuration
+
+Configure basic package information.
+
+### Basic Information
+
+Configure package title/description/tag.
+~~~~
+// file: readme.md
+
+``` yaml
+title: xxxxConfigurationClient
+description: xxxx Configuration Client
+openapi-type: arm
+tag: package-xxxx-xx-xx
+```
+~~~~
+
+### tag
+
+Tags are used to define what swagger files are used in specific client SDK. In Single-API client, only one tag can be used to generate SDK client.
+A tag can contains a bunch of swagger files which are used to generate the SDK.
+
+The name of a tag should be in form of package-yyyy-mm-dd[-xxx], for example below tag names are available:
+- package-2020-02-03
+- package-2020-03-22-preview
+- package-2020-05-03-only
+
+while the below tag names are invalid names:
+- 2020-03-04
+- package-preview-2020-03-04
+
+A tag can be configured like below:
+~~~~
+// file: readme.md
+
+
+### Tag: package-2019-12-01
+
+These settings apply only when `--tag=package-2019-12-01` is specified on the command line.
+
+``` yaml $(tag) == 'package-2019-12-01'
+input-file:
+- Microsoft.Compute/stable/2019-12-01/compute.json
+- Microsoft.Compute/stable/2019-12-01/runCommands.json
+- Microsoft.Compute/stable/2019-12-01/gallery.json
+```
+~~~~
+
+
+## Swagger to SDK
+
+To make Azure SDK for Go can be generated from the tag, swagger-to-sdk need to be configured:
+
+~~~
+// file: readme.md
+
+## 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-go
+ - ...
+
+
+## Go
+
+See configuration in [readme.go.md](./readme.go.md)
+~~~
+
+## Go Configuration
+
+Go dedicated configurations are configured in `readme.go.md`.
+
+The typical namespace/package-name in azure-sdk-for-go must start with a lower case letter and can only contain lower case letters and numbers.
+And the typical output-folder in the azure-sdk-for-go is like `$(typescript-sdk-folder)/services/$(namespace)/mgmt/yyyy-mm-dd/$(namespace)` where the `yyyy-mm-dd` is the version of this package.
+
+Go SDK supports multi-api by default, therefore you must add a batch section in the `readme.go.md`.
+
+A typical readme.go.md is like this:
+~~~
+// file: readme.go.md
+
+## 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-2019-12-01
+```
+
+### Tag: package-2019-12-01 and go
+
+These settings apply only when `--tag=package-2019-12-01 --go` is specified on the command line.
+Please also specify `--go-sdk-folder=`.
+
+```yaml $(tag) == 'package-2019-12-01' && $(go)
+namespace: yourservicename
+output-folder: $(go-sdk-folder)/services/$(namespace)/mgmt/2019-12-01/$(namespace)
+```
+~~~
+
+## Preview package and stable package
+
+Preview tags and stable tags are defined as the following:
+
+- A tag is a preview tag when there is at least one input swagger file is preview.
+- A tag is a stable tag when all of its swagger files are stable.
+
+A stable tag generates a stable package in `azure-sdk-for-go`, and its `output-folder` must be in this pattern:
+```
+output-folder: $(go-sdk-folder)/services/$(namespace)/mgmt/yyyy-mm-dd/$(namespace)
+```
+The `output-folder` here must not be under the `preview` subdirectory.
+
+A preview tag generates a preview package in `azure-sdk-for-go`, and its `output-folder` must be in this pattern:
+```
+output-folder: $(go-sdk-folder)/services/preview/$(namespace)/mgmt/yyyy-mm-dd-preview/$(namespace)
+```
+The `output-folder` here must be under the `preview` subdirectory.
+
+These rules must be applied, otherwise the go code generator will throw exceptions.
+
+## Multi-packages
+
+The batch is a tag list which are used in the one RP has multi-package scenarios. For example,
+the Resources RP has several independent packages like features, lock, policy.
+First of all, you need to have different yaml block for each package to define the default tag for that specific package.
+~~~
+// file: readme.md
+## Configuration
+
+### Basic Information
+
+These are the global settings for the Resource API.
+
+``` yaml
+openapi-type: arm
+```
+
+``` yaml $(package-features)
+tag: package-features-2015-12
+```
+
+``` yaml $(package-locks)
+tag: package-locks-2016-09
+```
+
+``` yaml $(package-policy)
+tag: package-policy-2019-09
+```
+
+``` yaml $(package-resources)
+tag: package-resources-2020-06
+```
+
+~~~
+Then for each default tag, you can define the input swagger like normal tag.
+~~~
+
+### Tag: package-features-2015-12
+
+These settings apply only when `--tag=package-features-2015-12` is specified on the command line.
+
+``` yaml $(tag) == 'package-features-2015-12'
+input-file:
+- Microsoft.Features/stable/2015-12-01/features.json
+```
+
+### Tag: package-locks-2016-09-preview
+
+These settings apply only when `--tag=package-locks-2016-09-preview` is specified on the command line.
+
+``` yaml $(tag) == 'package-locks-2016-09-preview'
+input-file:
+- Microsoft.Authorization/preview/2016-09-01/locks.json
+```
+
+### Tag: package-policy-2019-09
+
+These settings apply only when `--tag=package-policy-2019-09` is specified on the command line.
+
+``` yaml $(tag) == 'package-policy-2019-09'
+input-file:
+- Microsoft.Authorization/stable/2019-09-01/policyAssignments.json
+- Microsoft.Authorization/stable/2019-09-01/policyDefinitions.json
+- Microsoft.Authorization/stable/2019-09-01/policySetDefinitions.json
+
+# Needed when there is more than one input file
+override-info:
+ title: PolicyClient
+```
+
+### Tag: package-resources-2020-06
+
+These settings apply only when `--tag=package-resources-2020-06` is specified on the command line.
+
+``` yaml $(tag) == 'package-resources-2020-06'
+input-file:
+- Microsoft.Resources/stable/2020-06-01/resources.json
+```
+~~~
+
+Finally, in your readme.go.md you should include what packages you want to include in the Azure SDK for Go.
+And in each package's section define the default package name output folder in azure-sdk-for-go repo etc.
+
+~~~
+## 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-features-2015-12
+ - tag: package-locks-2016-09-preview
+ - tag: package-policy-2019-09
+ - tag: package-resources-2020-06
+```
+
+### Tag: package-features-2015-12 and go
+
+These settings apply only when `--tag=package-features-2015-12 --go` is specified on the command line.
+Please also specify `--go-sdk-folder=`.
+
+```yaml $(tag) == 'package-features-2015-12' && $(go)
+namespace: features
+output-folder: $(go-sdk-folder)/services/resources/mgmt/2015-12-01-preview/$(namespace)
+```
+
+### Tag: package-locks-2016-09-preview and go
+
+These settings apply only when `--tag=package-locks-2016-09-preview --go` is specified on the command line.
+Please also specify `--go-sdk-folder=`.
+
+```yaml $(tag) == 'package-locks-2016-09-preview' && $(go)
+namespace: locks
+output-folder: $(go-sdk-folder)/services/preview/resources/mgmt/2016-09-01-preview/$(namespace)
+```
+
+### Tag: package-policy-2019-09 and go
+
+These settings apply only when `--tag=package-policy-2019-09 --go` is specified on the command line.
+Please also specify `--go-sdk-folder=`.
+
+```yaml $(tag) == 'package-policy-2019-09' && $(go)
+namespace: policy
+output-folder: $(go-sdk-folder)/services/resources/mgmt/2019-09-01/$(namespace)
+```
+
+### Tag: package-resources-2020-06 and go
+
+These settings apply only when `--tag=package-resources-2020-06 --go` is specified on the command line.
+Please also specify `--go-sdk-folder=`.
+
+```yaml $(tag) == 'package-resources-2020-06' && $(go)
+namespace: resources
+output-folder: $(go-sdk-folder)/services/resources/mgmt/2020-06-01/$(namespace)
+```
+~~~
+
+
+## Run codegen
+
+After configure all the readme files, autorest can be used to generate SDK.
+~~~
+autorest --go --use="@microsoft.azure/autorest.go@~2.1.156" --multiapi --preview-chk --use-onever --go-sdk-folder=/path/to/azure-sdk-for-go /path/to/azure-rest-api-specs/specification/storage/resource-manager/readme.md
+~~~
diff --git a/documentation/samplefiles/readme.azureresourceschema.md b/documentation/samplefiles/readme.azureresourceschema.md
new file mode 100644
index 000000000000..819cac202170
--- /dev/null
+++ b/documentation/samplefiles/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-yourservicename-YYYY-MM-DD
+
+```
+
+Please also specify `--azureresourceschema-folder=`.
+
+### Tag: schema-yourservicename-YYYY-MM-DD and azureresourceschema
+
+``` yaml $(tag) == 'schema-yourservicename-YYYY-MM-DD' && $(azureresourceschema)
+output-folder: $(azureresourceschema-folder)/schemas
+
+# all the input files in this apiVersion
+input-file:
+ - Microsoft.YourServiceName/stable/YYYY-MM-DD/YourServiceName.json
+
+```
diff --git a/documentation/samplefiles/samplereadme.md b/documentation/samplefiles/samplereadme.md
index f76fab965fc8..af02111a6c18 100644
--- a/documentation/samplefiles/samplereadme.md
+++ b/documentation/samplefiles/samplereadme.md
@@ -56,6 +56,9 @@ swagger-to-sdk:
- repo: azure-sdk-for-ruby
after_scripts:
- bundle install && rake arm:regen_all_profiles['azure_mgmt_YourServiceName']
+ - repo: azure-resource-manager-schemas
+ after_scripts:
+ - node sdkauto_afterscript.js yourservicename/resource-manager
```
## Go
@@ -77,3 +80,7 @@ See configuration in [readme.typescript.md](https://github.com/Azure/azure-rest-
## CSharp
See configuration in [readme.csharp.md](https://github.com/Azure/azure-rest-api-specs/blob/master/documentation/samplefiles/readme.chsarp.md)
+
+## AzureResourceSchema
+
+See configuration in [readme.azureresourceschema.md](https://github.com/Azure/azure-rest-api-specs/blob/master/documentation/samplefiles/readme.azureresourceschema.md)
diff --git a/documentation/sdkautomation/sdk_customization.md b/documentation/sdkautomation/sdk_customization.md
new file mode 100644
index 000000000000..de083379fcf2
--- /dev/null
+++ b/documentation/sdkautomation/sdk_customization.md
@@ -0,0 +1,801 @@
+# SDK Automation Customization
+
+This is the specification of the new SDK Automation customization configuration.
+Old customization that hardcoded in sdk automation will still work but this new
+approach is preferred.
+
+## SDK Automation workflow
+
+### Opened PR Validation Trigger
+
+SDK Automation is launched with matrix in azure pipeline. For each language configured:
+
+1. Get the PR merge commit and clone the spec repo on the merge commit.
+
+2. Get the PR changed file list. For each changed file, find the nearest readme.md in parent folder. Get list of related readme.md.
+
+3. Filter the list of readme.md with: find the `swagger-to-sdk` section in the readme.md, and see if the specified language is configured for that readme.md. Example of `swagger-to-sdk` in SDK Automation:
+```
+```yaml $(swagger-to-sdk)
+swagger-to-sdk:
+ - repo: azure-sdk-for-python
+ - repo: azure-sdk-for-java
+ - repo: azure-sdk-for-go
+ - repo: azure-sdk-for-js
+```
+```
+If the configured language is not found here, generation for this readme.md will be skipped.
+
+4. Get `specificationRepositoryConfiguration.json` from spec repo default branch. See [SpecRepoConfig](#specrepoconfig). Get the repo and branch config in the file.
+
+5. Clone __mainRepository__ and checkout __mainBranch__. If __secondaryRepository__ is specified then checkout __secondaryRepository__ and __secondaryBranch__ instead.
+
+6. Get `swagger_to_sdk_config.json` from cloned SDK repository. The config file path could be customized by __configFilePath__ in spec config. For the definition of the config see [SwaggerToSdkConfig](#swaggertosdkconfig).
+
+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`.
+
+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.
+
+10. Get generated package. If __packageFolderFromFileSearch__ is defined with file search then package folder is detected based on git diff in SDK repository and algorithm described in [SwaggerToSdkConfig Schema](#swaggertosdkconfig-schema). Else package folder is from [generateOutput.json](#generateoutput). For each package ___loop the rest steps___.
+
+11. Launch __buildScript__ to build the package. Collect the artifacts by config __artifactPathFromFileSearch__. This step could be skipped if it's not defined in [SwaggerToSdkConfig](#swaggertosdkconfig) and it's covered by __generateScript__ and the result could be found in [generateOutput.json](#generateoutput).
+
+12. Upload all the package related artifacts to Azure Storage Blob Container. All the artifact for one package is uploaded in one folder. These file could be downloaded on URL prefixed by __downloadUrlPrefix__ defined in [InstallInstructionScriptInput](#installinstructionscriptinput). It's redirected by openapiHub by design, and for SDK Automation on public repo the redirect don't need auth, but for SDK Automation in private repo it requires microsoft AAD auth. User could authenticate and download via web page oauth in browser or bearer token auth with `az rest --resource` in command line.
+
+13. Launch __changelogScript__ to get changelog and detect breaking change. This step could be skipped if changelog and breaking change could be found in [generateOutput.json](#generateoutput). If breaking change is found, the spec PR will be labelled with `CI-BreakingChange-`.
+
+14. Launch __installInstructionScript__ to get install instruction for that package. This step could be skipped if install instruction could be found in [generateOutput.json](#generateoutput). The lite install instruction will be shown in spec PR comment, the full install instruction will be shown in generated SDK PR.
+
+15. Commit the package related code in SDK repository. Force push to [GenerationBranch](#generationbranch) in __integrationRepository__. Create or update [GenerationPR](#generationpr) from [GenerationBranch](#generationbranch) to [MainBranch](#mainbranch) in __integrationRepository__. If __integrationRepository__ is a fork of __mainRepository__, its [MainBranch](#mainbranch) should be synced once a day.
+
+### Continuous Integration (PR Merged) Trigger
+
+Almost the same as opened PR trigger, with different on step 15:
+
+15. Commit the package related code in SDK repository. Close [GenerationPR](#generationpr) and delete [GenerationBranch](#generationbranch). Force push to [IntegrationBranch](#integrationbranch) in __integrationRepository__. Create or update [IntegrationPR](#integrationpr) from [IntegrationBranch](#integrationbranch) to [MainBranch](#mainbranch) in __mainRepository__. Close the [integrationPR](#integrationPR) if __closeIntegrationPR__ in [SwaggerToSdkConfig](#swaggertosdkconfig) is set to true.
+
+
+## Definitions
+
+### SpecRepoConfig
+This is type of file `./specificationRepositoryConfiguration.json` in swagger spec repo.
+
+#### SpecRepoConfig Example
+```json
+{
+ "sdkRepositoryMappings": {
+ "azure-sdk-for-js": {
+ "integrationRepository": "AzureSDKAutomation/azure-sdk-for-js",
+ "mainRepository": "Azure/azure-sdk-for-js"
+ },
+ "azure-sdk-for-python": {
+ "integrationRepository": "AzureSDKAutomation/azure-sdk-for-python",
+ "mainRepository": "Azure/azure-sdk-for-python",
+ "mainBranch": "release/v3"
+ },
+ "azure-sdk-for-python-track2": {
+ "integrationRepository": "AzureSDKAutomation/azure-sdk-for-python",
+ "mainRepository": "Azure/azure-sdk-for-python"
+ },
+ "azure-sdk-for-trenton": {
+ "integrationRepository": "Azure/azure-sdk-for-trenton",
+ "mainRepository": "Azure/azure-sdk-for-trenton",
+ "secondaryRepository": "Azure/azure-sdk-for-trenton",
+ "secondaryBranch": "secondary"
+ }
+ },
+ "overrides": {
+ "Azure/azure-rest-api-specs-pr": {
+ "sdkRepositoryMappings": {
+ "azure-sdk-for-js": {
+ "integrationRepository": "azure-sdk/azure-sdk-for-js-pr",
+ "mainRepository": "Azure/azure-sdk-for-js-pr"
+ },
+ "azure-sdk-for-python": {
+ "integrationRepository": "azure-sdk/azure-sdk-for-python-pr",
+ "mainRepository": "Azure/azure-sdk-for-python-pr",
+ "mainBranch": "release/v3"
+ },
+ "azure-sdk-for-python-track2": {
+ "integrationRepository": "azure-sdk/azure-sdk-for-python-pr",
+ "mainRepository": "Azure/azure-sdk-for-python-pr"
+ }
+ }
+ }
+ }
+}
+```
+
+#### SpecRepoConfig Schema
+``` jsonc
+{
+ "type": "object",
+ "properties": {
+ "sdkRepositoryMappings": {
+ // A mapping of SDK repository names to the names of the SDK repositories
+ // that all interaction should go to instead.
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/definitions/SdkRepositoryConfig"
+ },
+ "propertyNames": {
+ // The property name is the sdk name identifier.
+ "type": "string"
+ }
+ },
+ "overrides": {
+ // Override config for specific repository.
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/"
+ },
+ "propertyNames": {
+ // The property name is the sdk repo ref.
+ "$ref": "#/definitions/RepositoryName"
+ }
+ },
+ "required": [
+ "sdkRepositoryMappings"
+ ]
+ },
+ "definitions": {
+ "RepositoryName": {
+ // Reference to a repository on github. Could be or /.
+ // By default the is the same as the owner of the spec repo.
+ "type": "string"
+ },
+ "SdkRepositoryConfig": {
+ "type": "object",
+ "properties": {
+ "mainRepository": {
+ // The repository that the final release PR will targeting.
+ "$ref": "#/definitions/RepositoryName"
+ },
+ "mainBranch": {
+ // Base branch of codegen branches
+ "default": "master",
+ "type": "string"
+ },
+ "integrationRepository": {
+ // The repository that hold generation branch, generation PR and integration branch.
+ // By default it's the same as mainRepository
+ "$ref": "#/definitions/RepositoryName"
+ },
+ "secondaryRepository": {
+ // Codegen runs on this repository.
+ // By default it's the same as 'mainRepository' but it could be different.
+ "$ref": "#/definitions/RepositoryName"
+ },
+ "secondaryBranch": {
+ // Codegen runs on this branch on secondaryRepository.
+ // By default it's the same as 'mainBranch' but it could be different.
+ "type": "string"
+ },
+ "integrationBranchPrefix": {
+ // The prefix that will be applied to the beginning of integration branches
+ "type": "string",
+ "default": "sdkAutomation"
+ },
+ "configFilePath": {
+ // Path to swagger-to-sdk config in sdk repo
+ "default": "swagger_to_sdk_config.json"
+ }
+ },
+ "required": [
+ "mainRepository"
+ ]
+ }
+ }
+}
+```
+
+### SwaggerToSdkConfig
+This is type of file `./swagger_to_sdk_config.json` in sdk repo.
+The running environment of these scripts would be expected to be __Ubuntu 18.04__ on Azure Pipeline. This may change in the future. All the running script should be executable.
+The working folder of all the scripts is the __root folder of sdk repo__.
+
+#### SwaggerToSdkConfig Example
+``` jsonc
+{
+ "advancedOptions": {
+ "createSdkPullRequests": true,
+ "generationCallMode": "one-for-all-configs"
+ },
+ "initOptions": {
+ "initScript": {
+ "path": "./eng/tools/sdk_init"
+ }
+ },
+ "generateOptions": {
+ // Param:
+ // generateInput.json: See #GenerateInput .
+ // generateOutput.json: See #GenerateOutput .
+ "generateScript": {
+ "path": "./eng/tools/sdk_generate",
+ "stderr": {
+ "showInComment": true
+ },
+ "stdout": {
+ // Show logs start with "[Autorest]" in PR comment.
+ "showInComment": "^\\[Autorest\\]"
+ }
+ },
+
+ "parseGenerateOutput": true
+ },
+ "packageOptions": {
+ // Param:
+ "buildScript": {
+ "path": "./eng/tools/sdk_package",
+ "stderr": {
+ // Everything in stderr will show in comment and mark package with warning.
+ "showInComment": true,
+ "scriptWarning": true
+ },
+ "exitCode": {
+ // If exit code is not zero, mark package with warning instead of error.
+ "result": "warning"
+ }
+ },
+
+ // Param:
+ "changelogScript": {
+ "path": "./eng/tools/sdk_breaking_change",
+ "breakingChangeDetect": "Breaking Change"
+ }
+ },
+ "artifactOptions": {
+ // Param:
+ // installInstructionInput.json: See #InstallInstructionScriptInput .
+ // installInstructionOutput.json: See #InstallInstructionScriptOutput .
+ "installInstructionScript": {
+ "path": "./eng/tools/sdk_install_instruction"
+ }
+ }
+}
+```
+
+#### SwaggerToSdkConfig Schema
+``` jsonc
+{
+ "type": "object",
+ "properties": {
+ "advancedOptions": {
+ // To keep backward compatibility, but will not list schema for old config options.
+ "properties": {
+ "createSdkPullRequests": {
+ // Should SDK Automation create PR or not.
+ "type": "boolean",
+ "default": true
+ },
+ "closeIntegrationPR": {
+ // Should SDK Automation close integrationPR to reduce noise.
+ "type": "boolean",
+ "default": true
+ },
+ "generationCallMode": {
+ // If we have multiple related readme.md, should we call generation once with
+ // all the readme.md or should we call generation multiple times and one per readme.md.
+ "type": "string",
+ "enum": [
+ "one-per-config",
+ "one-for-all-configs"
+ ],
+ "default": "one-for-all-configs"
+ }
+ }
+ },
+ "initOptions": {
+ // Init the environment. Install dependencies.
+ "type": "object",
+ "properties": {
+ "initScript": {
+ // Script to init.
+ "$ref": "#/definitions/RunOptions"
+ }
+ },
+ "required": [
+ "initScript"
+ ]
+ },
+ "generateOptions": {
+ // Generate the SDK code.
+ "type": "object",
+ "properties": {
+ "generateScript": {
+ // Script to generate the SDK code.
+ // Param:
+ // generateInput.json: See #GenerateInput
+ // generateOutput.json: See #GenerateOutput
+ "$ref": "#/definitions/RunOptions"
+ },
+ "preprocessDryRunGetPackageName": {
+ // If this options is set to true, generateScript will first run with
+ // "dryRun": true to get package name and related readme.md,
+ // then for each package, checkout the expected branch and launch generateScript.
+ "type": "boolean",
+ "default": false
+ },
+ "parseGenerateOutput": {
+ // Will this script output to generateOutput.json.
+ // If not, default behavior will be applied that outcome will be
+ // detected automatically based on filename regex search.
+ "type": "boolean",
+ "default": true
+ }
+ },
+ "required": [
+ "generateScript"
+ ]
+ },
+ "packageOptions": {
+ // Get package folder and build / get changelog
+ "type": "object",
+ "properties": {
+ "packageFolderFromFileSearch": {
+ "oneOf": [
+ {
+ // If this option is set to object, then package folder will be detected automatically.
+ // based on filename regex search.
+ // This options must be set to object if parseGenerateOutput is false.
+ "type": "object",
+ "properties": {
+ "searchRegex": {
+ // Search algorithm:
+ // For each changed file detected after generation
+ // PotentialPackageFolder = folder of changed file
+ // While PotentialPackageFolder is not root folder of sdk repo:
+ // If PotentialPackageFolder contains a file that matches the searchRegex:
+ // PackageFolder found, break
+ // Else:
+ // PotentialPackageFolder = parent folder of PotentialPackageFolder
+ "type": "string",
+ "format": "regex"
+ },
+ "pageNamePrefix": {
+ // Prefix to be appended to packageName. By default packageName will be the folder name of packageFolder
+ "type": "string"
+ }
+ },
+ "required": [
+ "searchRegex"
+ ]
+ },
+ {
+ // If this option is set to false, then package folder will be from generateOutput.json.
+ "const": false
+ }
+ ],
+ "default": false,
+ },
+ "buildScript": {
+ // Build the generated sdk.
+ // Param:
+ // Package folder could be a list separated by space if it's from generateOutput.json.
+ "$ref": "#/definitions/RunOptions"
+ },
+ "changelogScript": {
+ // Changelog generation and breaking-change detection.
+ // Param:
+ // Package folder could be a list separated by space if it's from generateOutput.json.
+ // Expected output from stdout/stderr: Changelog in markdown
+ "allOf": {
+ "$ref": "#/definitions/RunOptions"
+ },
+ "properties": {
+ "breakingChangeDetect": {
+ // If stdout or stderr matches this in output of changelog tool
+ // then we assume this SDK has breaking change.
+ "$ref": "#/definitions/RunLogFilterOptions"
+ }
+ }
+ }
+ }
+ },
+ "artifactOptions": {
+ "artifactPathFromFileSearch": {
+ "oneOf": [
+ {
+ // If this option is set to object, then artifacts will be detected automatically
+ // based on filename regex search.
+ // This options must be set to object if parseGenerateOutput is false.
+ "type": "object",
+ "properties": {
+ "searchRegex": {
+ // Any file under package folder matching the searchRegex is package artifact.
+ "type": "string",
+ "format": "regex",
+ }
+ }
+ },
+ {
+ // If this option is set to false, then package folder will be from generateOutput.json
+ "const": false
+ }
+ ],
+ "default": false
+ },
+ "installInstructionScript": {
+ // Generate install instruction that could be shown in spec PR comment (lite version)
+ // or in generated SDK PR (full version).
+ // If generateOutput.json contains installInstruction then this could be skipped.
+ // Param:
+ // installInstructionInput.json: See #InstallInstructionScriptInput .
+ // installInstructionOutput.json: See #InstallInstructionScriptInput .
+ "allOf": {
+ "$ref": "#/definitions/RunOptions"
+ }
+ }
+ }
+ },
+ "definitions": {
+ "RunOptions": {
+ // Options to run a script and collect log.
+ "type": "object",
+ "properties": {
+ "path": {
+ // Script path related to repo root
+ "type": "string"
+ },
+ "logPrefix": {
+ // Prefix to be added to SDK Automation log. By default it would be filename of the script.
+ "type": "string"
+ },
+ "stdout": {
+ // How should SDK Automation handle the script stdout stream
+ "$ref": "#/definitions/RunLogOptions"
+ },
+ "stderr": {
+ // How should SDK Automation handle the script stderr stream
+ "$ref": "#/definitions/RunLogOptions"
+ },
+ "exitCode": {
+ // How should SDK Automation handle non-zero exitCode.
+ "showInComment": {
+ // Should we show this error in comment.
+ "type": "boolean",
+ "default": true
+ },
+ "result": {
+ // If script has non-error exitCode how should we mark the script's result.
+ "type": "string",
+ "enum": [
+ "error", "warning", "ignore"
+ ],
+ "default": "error"
+ }
+ },
+ "required": [
+ "path"
+ ]
+ }
+ },
+ "RunLogOptions": {
+ // How should SDK Automation handle the log stream.
+ "showInComment": {
+ // Should we show this stream in comment.
+ "$ref": "#/definitions/RunLogFilterOptions"
+ },
+ "scriptError": {
+ // If any line match, assume the script fails.
+ "$ref": "#/definitions/RunLogFilterOptions"
+ },
+ "scriptWarning": {
+ // If any line match, assume the script warns.
+ "$ref": "#/definitions/RunLogFilterOptions"
+ }
+ },
+ "RunLogFilterOptions": {
+ "oneOf": [
+ {
+ // If line of log match this regex then hit
+ "type": "string",
+ "format": "regex"
+ },
+ {
+ // If set to true, any line of log will hit
+ "type": "boolean"
+ }
+ ],
+ "default": false
+ }
+ }
+}
+```
+
+### GenerateInput
+
+Input file for generate script.
+
+#### GenerateInput Example
+
+```jsonc
+{
+ "dryRun": false,
+ "specFolder": "/z/work/azure-rest-api-specs",
+ "headSha": "fce3400431eff281bddd04bed9727e63765b8da0",
+ "headRef": "refs/pull/1234/merge",
+ "repoHttpsUrl": "https://github.com/Azure/azure-rest-api-specs.git",
+ "trigger": "pull_request",
+ "changedFiles": [
+ "specification/cdn/something/cdn.json"
+ ],
+ "relatedReadmeMdFiles": [
+ "specification/cdn/something/readme.md"
+ ]
+}
+```
+
+#### GenerateInput Schema
+
+```jsonc
+{
+ "type": "object",
+ "properties": {
+ "dryRun": {
+ // If dryRun is true, generateScript is expected to parse readme.md
+ // and output the package list with package name and related readme.md.
+ // Should not run codegen at this time.
+ "type": "boolean"
+ },
+ "specFolder": {
+ // Path to local spec folder.
+ "type": "string"
+ },
+ "headSha": {
+ // Git head sha.
+ "type": "string"
+ },
+ "headRef": {
+ // Git head ref.
+ // Format will be "refs/pull//merge" or "refs/heads/".
+ "type": "string"
+ },
+ "repoHttpsUrl": {
+ // Spec repo url in https without auth.
+ "type": "string"
+ },
+ "trigger": {
+ // How this generation is triggered.
+ "type": "string",
+ "enum": [
+ "pullRequest",
+ "continuousIntegration"
+ ]
+ },
+ "changedFiles": {
+ // Changed file list in spec PR.
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "relatedReadmeMdFiles": {
+ // Related readme.md files that pending generation.
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "installInstructionInput": {
+ // See #InstallInstructionScriptInput
+ "$ref": "#/definitions/InstallInstructionScriptInput"
+ }
+ },
+ "required": [
+ "specFolder", "headSha", "headRef", "repoHttpsUrl",
+ "trigger", "changedFiles", "relatedReadmeMdFiles"
+ ]
+}
+```
+
+### GenerateOutput
+
+Output file for generate script.
+
+#### GenerateOutput Example
+
+```jsonc
+{
+ "packages": [
+ {
+ "packageName": "Microsoft.Cdn",
+ "path": [
+ "sdk/cdn"
+ ],
+ "readmeMd": [
+ "specification/cdn/something/readme.md"
+ ],
+ "changelog": {
+ "content": "Feature: something \n Breaking Changes: something\n",
+ "hasBreakingChange": true
+ },
+ "artifacts": [
+ "sdk/cdn/cdn.nuget",
+ "sdk/cdn/cdn.snuget"
+ ],
+ "installInstructions": {
+ "full": "To install something...",
+ "lite": "dotnet something"
+ },
+ "result": "success"
+ }
+ ]
+}
+```
+
+#### GenerateOutput Schema
+
+```jsonc
+{
+ "type": "object",
+ "properties": {
+ "packages": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/PackageResult"
+ }
+ }
+ },
+ "required": [
+ "packages"
+ ],
+ "definitions": {
+ "PackageResult": {
+ "properties": {
+ "packageName": {
+ // Name of package. Will be used in branch name and PR title.
+ // By default it's folder name of first entry in path.
+ "type": "string",
+ },
+ "path": {
+ // List of package content paths.
+ // If the path points to a folder then
+ // all the content under the folder will be included.
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "readmeMd": {
+ // List of related readmeMd of this package.
+ // Must provide this field if dryRun is true.
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "changelog": {
+ "type": "object",
+ "properties": {
+ "content": {
+ // Content of changelog in markdown
+ "type": "string"
+ },
+ "hasBreakingChange": {
+ // Does the new package has breaking change
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "content"
+ ]
+ },
+ "artifacts": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "installInstructions": {
+ // See #InstallInstructionScriptOutput
+ "$ref": "#/definitions/InstallInstructionScriptOutput"
+ },
+ },
+ "required": [
+ "path"
+ ]
+ }
+ }
+}
+```
+
+### InstallInstructionScriptInput
+
+Input of install instruction script.
+
+#### InstallInstructionScriptInput Example
+
+```jsonc
+{
+ "packageName": "Microsoft.Cdn",
+ "artifacts": [
+ "sdk/cdn/cdn.nuget",
+ "sdk/cdn/cdn.snuget"
+ ],
+ "isPublic": true,
+ "downloadUrlPrefix": "https://portal.azure-devex-tools.com/api/sdk-dl-pub?p=Azure/azure-rest-api-specs/1234/azure-sdk-for-net/",
+ "downloadCommandTemplate": "curl -L \"{URL}\" -o {FILENAME}",
+ "trigger": "pullRequest",
+}
+```
+
+#### InstallInstructionScriptInput Schema
+
+```jsonc
+{
+ "type": "object",
+ "properties": {
+ "packageName": {
+ // The package name. May be skipped if sdk automation don't know the info yet.
+ "type": "string"
+ },
+ "artifacts": {
+ // List of artifact's path. May be skipped if sdk automation don't know the info yet.
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "isPublic": {
+ // Is the download url public accessible.
+ // If it's false, the download command template will be
+ // az rest --resource -u "{URL}" --output-file {FILENAME}
+ "type": "boolean",
+ },
+ "downloadUrlPrefix": {
+ // All the artifacts will be uploaded and user could access the artifact via
+ // a link composed by this prefix and artifact filename.
+ "type": "string"
+ },
+ "downloadCommandTemplate": {
+ // Download command template. Replace {URL} and {FILENAME} to get the real command.
+ "type": "string"
+ },
+ "trigger": {
+ "type": "string",
+ "enum": [
+ "pullRequest",
+ "continuousIntegration"
+ ]
+ }
+ }
+}
+```
+
+### InstallInstructionScriptOutput
+
+Output of install instruction script.
+
+#### InstallInstructionScriptOutput Example
+
+```jsonc
+{
+ "full": "To install something...",
+}
+```
+
+#### InstallInstructionScriptInput Schema
+
+```jsonc
+{
+ "type": "object",
+ "properties": {
+ "full": {
+ // Full version of install instruction will be shown in generated SDK PR.
+ // Should be in markdown format.
+ "type": "string"
+ },
+ "lite": {
+ // Lite version of install instruction will be shown in generated SDK PR.
+ // Should be in markdown format.
+ "type": "string"
+ }
+ },
+ "required": [
+ "full"
+ ]
+}
+```
diff --git a/profile/2020-09-01-hybrid.json b/profile/2020-09-01-hybrid.json
index 9e91801fb7f8..4ba660dc88c7 100644
--- a/profile/2020-09-01-hybrid.json
+++ b/profile/2020-09-01-hybrid.json
@@ -212,37 +212,31 @@
"2017-04-01": [
{
"resourceType": "checkNameAvailability",
- "path":"https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/EventHub.json"
+ "path":"https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/CheckNameAvailability.json"
},
{
"resourceType": "namespaces/authorizationRules",
- "path":"https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/EventHub.json"
+ "path":"https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/AuthorizationRules.json"
},
{
"resourceType": "namespaces/eventhubs",
- "path":"https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/EventHub.json"
+ "path":"https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/eventhubs.json"
},
{
"resourceType": "namespaces/eventhubs/authorizationRules",
- "path":"https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/EventHub.json"
+ "path":"https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/AuthorizationRules.json"
},
{
"resourceType": "namespaces/eventhubs/consumerGroups",
- "path":"https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/EventHub.json"
+ "path":"https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/consumergroups.json"
},
{
"resourceType": "operations",
- "path":"https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/EventHub.json"
+ "path":"https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/operations.json"
},
{
"resourceType": "sku",
- "path":"https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/EventHub.json"
- }
- ],
- "2015-08-01": [
- {
- "resourceType": "checkNamespaceAvailability",
- "path":"https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2015-08-01/EventHub.json"
+ "path":"https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/sku.json"
}
]
},
@@ -365,80 +359,80 @@
]
},
"microsoft.resources": {
- "2019-10-01": [
+ "2016-06-01": [
{
- "resourceType": "subscriptions",
- "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/resources/resource-manager/Microsoft.Resources/stable/2018-06-01/subscriptions.json"
+ "resourceType": "subscriptions",
+ "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/resources/resource-manager/Microsoft.Resources/stable/2016-06-01/subscriptions.json"
},
{
- "resourceType": "subscriptions/locations",
- "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/resources/resource-manager/Microsoft.Resources/stable/2018-06-01/subscriptions.json"
+ "resourceType": "subscriptions/locations",
+ "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/resources/resource-manager/Microsoft.Resources/stable/2016-06-01/subscriptions.json"
},
{
- "resourceType": "tenants",
- "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/resources/resource-manager/Microsoft.Resources/stable/2018-06-01/subscriptions.json"
+ "resourceType": "tenants",
+ "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/resources/resource-manager/Microsoft.Resources/stable/2016-06-01/subscriptions.json"
}
- ],
- "2018-05-01": [
+ ],
+ "2019-10-01": [
{
"resourceType": "deployments",
- "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/resources/resource-manager/Microsoft.Resources/stable/2018-05-01/resources.json"
+ "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/resources/resource-manager/Microsoft.Resources/stable/2019-10-01/resources.json"
},
{
"resourceType": "deployments/operations",
- "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/resources/resource-manager/Microsoft.Resources/stable/2018-05-01/resources.json"
+ "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/resources/resource-manager/Microsoft.Resources/stable/2019-10-01/resources.json"
},
{
"resourceType": "links",
- "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/resources/resource-manager/Microsoft.Resources/stable/2018-05-01/resources.json"
+ "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/resources/resource-manager/Microsoft.Resources/stable/2019-10-01/resources.json"
},
{
"resourceType": "locations",
- "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/resources/resource-manager/Microsoft.Resources/stable/2018-05-01/resources.json"
+ "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/resources/resource-manager/Microsoft.Resources/stable/2019-10-01/resources.json"
},
{
"resourceType": "operations",
- "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/resources/resource-manager/Microsoft.Resources/stable/2018-05-01/resources.json"
+ "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/resources/resource-manager/Microsoft.Resources/stable/2019-10-01/resources.json"
},
{
"resourceType": "providers",
- "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/resources/resource-manager/Microsoft.Resources/stable/2018-05-01/resources.json"
+ "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/resources/resource-manager/Microsoft.Resources/stable/2019-10-01/resources.json"
},
{
"resourceType": "resourceGroups",
- "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/resources/resource-manager/Microsoft.Resources/stable/2018-05-01/resources.json"
+ "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/resources/resource-manager/Microsoft.Resources/stable/2019-10-01/resources.json"
},
{
"resourceType": "resources",
- "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/resources/resource-manager/Microsoft.Resources/stable/2018-05-01/resources.json"
+ "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/resources/resource-manager/Microsoft.Resources/stable/2019-10-01/resources.json"
},
{
"resourceType": "subscriptions/operationresults",
- "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/resources/resource-manager/Microsoft.Resources/stable/2018-05-01/resources.json"
+ "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/resources/resource-manager/Microsoft.Resources/stable/2019-10-01/resources.json"
},
{
"resourceType": "subscriptions/providers",
- "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/resources/resource-manager/Microsoft.Resources/stable/2018-05-01/resources.json"
+ "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/resources/resource-manager/Microsoft.Resources/stable/2019-10-01/resources.json"
},
{
"resourceType": "subscriptions/resourceGroups",
- "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/resources/resource-manager/Microsoft.Resources/stable/2018-05-01/resources.json"
+ "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/resources/resource-manager/Microsoft.Resources/stable/2019-10-01/resources.json"
},
{
"resourceType": "subscriptions/resourceGroups/resources",
- "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/resources/resource-manager/Microsoft.Resources/stable/2018-05-01/resources.json"
+ "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/resources/resource-manager/Microsoft.Resources/stable/2019-10-01/resources.json"
},
{
"resourceType": "subscriptions/resources",
- "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/resources/resource-manager/Microsoft.Resources/stable/2018-05-01/resources.json"
+ "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/resources/resource-manager/Microsoft.Resources/stable/2019-10-01/resources.json"
},
{
"resourceType": "subscriptions/tagNames",
- "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/resources/resource-manager/Microsoft.Resources/stable/2018-05-01/resources.json"
+ "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/resources/resource-manager/Microsoft.Resources/stable/2019-10-01/resources.json"
},
{
"resourceType": "subscriptions/tagNames/tagValues",
- "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/resources/resource-manager/Microsoft.Resources/stable/2018-05-01/resources.json"
+ "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/resources/resource-manager/Microsoft.Resources/stable/2019-10-01/resources.json"
}
]
},
diff --git a/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2020-07-01-preview/adp.json b/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2020-07-01-preview/adp.json
new file mode 100644
index 000000000000..eb9395934bae
--- /dev/null
+++ b/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2020-07-01-preview/adp.json
@@ -0,0 +1,1040 @@
+{
+ "swagger": "2.0",
+ "info": {
+ "version": "2020-07-01-preview",
+ "title": "adp",
+ "description": "Microsoft Autonomous Development Platform"
+ },
+ "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.AutonomousDevelopmentPlatform/operations": {
+ "get": {
+ "tags": [
+ "Operations"
+ ],
+ "description": "Lists all of the available Autonomous Development Platform provider operations.",
+ "operationId": "Operations_List",
+ "x-ms-examples": {
+ "List operations": {
+ "$ref": "./examples/AdpOperationsList.json"
+ }
+ },
+ "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/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/providers/Microsoft.AutonomousDevelopmentPlatform/accounts": {
+ "get": {
+ "tags": [
+ "Accounts"
+ ],
+ "operationId": "Accounts_List",
+ "description": "List all ADP accounts available under the subscription",
+ "x-ms-examples": {
+ "List accounts": {
+ "$ref": "./examples/AdpAccountsList.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/AccountList"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AutonomousDevelopmentPlatform/accounts": {
+ "get": {
+ "tags": [
+ "Accounts"
+ ],
+ "operationId": "Accounts_ListByResourceGroup",
+ "description": "List all ADP accounts available under the resource group",
+ "x-ms-examples": {
+ "List accounts by resource group": {
+ "$ref": "./examples/AdpAccountsListByResourceGroup.json"
+ }
+ },
+ "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"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/AccountList"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AutonomousDevelopmentPlatform/accounts/{accountName}": {
+ "get": {
+ "tags": [
+ "Accounts"
+ ],
+ "operationId": "Accounts_Get",
+ "description": "Gets the properties of an ADP account.",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/AccountNameParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The ADP account properties were retrieved successfully.",
+ "schema": {
+ "$ref": "#/definitions/Account"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Get account": {
+ "$ref": "./examples/AdpAccountGet.json"
+ }
+ }
+ },
+ "patch": {
+ "tags": [
+ "Accounts"
+ ],
+ "operationId": "Accounts_Update",
+ "x-ms-long-running-operation": true,
+ "description": "Updates the properties of an existing ADP account.",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/AccountNameParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "in": "body",
+ "name": "parameters",
+ "description": "The parameters to provide for the current ADP account.",
+ "schema": {
+ "$ref": "#/definitions/AccountPatch"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The resource was updated successfully.",
+ "schema": {
+ "$ref": "#/definitions/Account"
+ }
+ },
+ "201": {
+ "description": "The resource will be updated asynchronously.",
+ "schema": {
+ "$ref": "#/definitions/Account"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Patch account": {
+ "$ref": "./examples/AdpAccountPatch.json"
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "Accounts"
+ ],
+ "operationId": "Accounts_CreateOrUpdate",
+ "description": "Creates or updates an ADP account.",
+ "x-ms-long-running-operation": true,
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/AccountNameParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "in": "body",
+ "name": "parameters",
+ "description": "The parameters to provide for the ADP account.",
+ "schema": {
+ "$ref": "#/definitions/Account"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The ADP account was successfully updated.",
+ "schema": {
+ "$ref": "#/definitions/Account"
+ }
+ },
+ "201": {
+ "description": "The resource will be updated asynchronously.",
+ "schema": {
+ "$ref": "#/definitions/Account"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Put account": {
+ "$ref": "./examples/AdpAccountPut.json"
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "Accounts"
+ ],
+ "operationId": "Accounts_Delete",
+ "description": "Deletes an ADP account.",
+ "x-ms-long-running-operation": true,
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/AccountNameParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The ADP account was successfully deleted."
+ },
+ "202": {
+ "description": "The ADP account will be deleted asynchronously."
+ },
+ "204": {
+ "description": "The ADP account does not exist."
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Delete account": {
+ "$ref": "./examples/AdpAccountDelete.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AutonomousDevelopmentPlatform/accounts/{accountName}/dataPools": {
+ "get": {
+ "tags": [
+ "DataPools"
+ ],
+ "operationId": "DataPools_List",
+ "description": "Lists the data pools under the ADP account.",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/AccountNameParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The list of data pools that was successfully retrieved.",
+ "schema": {
+ "$ref": "#/definitions/DataPoolList"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-examples": {
+ "List Data Pools": {
+ "$ref": "./examples/AdpDataPoolsList.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AutonomousDevelopmentPlatform/accounts/{accountName}/dataPools/{dataPoolName}": {
+ "get": {
+ "tags": [
+ "DataPools"
+ ],
+ "operationId": "DataPools_Get",
+ "description": "Gets the properties of a Data Pool.",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/AccountNameParameter"
+ },
+ {
+ "$ref": "#/parameters/DataPoolNameParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The Data Pool that was successfully retrieved.",
+ "schema": {
+ "$ref": "#/definitions/DataPool"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Get Data Pool": {
+ "$ref": "./examples/AdpDataPoolGet.json"
+ }
+ }
+ },
+ "patch": {
+ "tags": [
+ "DataPools"
+ ],
+ "operationId": "DataPools_Update",
+ "description": "Updates the properties of an existing Data Pool.",
+ "x-ms-long-running-operation": true,
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/AccountNameParameter"
+ },
+ {
+ "$ref": "#/parameters/DataPoolNameParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "in": "body",
+ "name": "parameters",
+ "description": "The parameters to provide for the Data Pool.",
+ "schema": {
+ "$ref": "#/definitions/DataPoolPatch"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The Data Pool was updated successfully.",
+ "schema": {
+ "$ref": "#/definitions/DataPool"
+ }
+ },
+ "201": {
+ "description": "The Data Pool will be updated asynchronously.",
+ "schema": {
+ "$ref": "#/definitions/DataPool"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Patch Data Pool": {
+ "$ref": "./examples/AdpDataPoolPatch.json"
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "DataPools"
+ ],
+ "operationId": "DataPools_CreateOrUpdate",
+ "description": "Creates or updates a Data Pool.",
+ "x-ms-long-running-operation": true,
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/AccountNameParameter"
+ },
+ {
+ "$ref": "#/parameters/DataPoolNameParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "in": "body",
+ "name": "parameters",
+ "description": "The parameters to provide for the Data Pool.",
+ "schema": {
+ "$ref": "#/definitions/DataPool"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The Data Pool was successfully updated.",
+ "schema": {
+ "$ref": "#/definitions/DataPool"
+ }
+ },
+ "201": {
+ "description": "The Data Pool will be updated asynchronously.",
+ "schema": {
+ "$ref": "#/definitions/DataPool"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Put Data Pool": {
+ "$ref": "./examples/AdpDataPoolPut.json"
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "DataPools"
+ ],
+ "operationId": "DataPools_Delete",
+ "description": "Deletes a Data Pool.",
+ "x-ms-long-running-operation": true,
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/AccountNameParameter"
+ },
+ {
+ "$ref": "#/parameters/DataPoolNameParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The Data Pool was successfully deleted."
+ },
+ "202": {
+ "description": "The Data Pool will be deleted asynchronously."
+ },
+ "204": {
+ "description": "The Data Pool does not exist."
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Delete Data Pool": {
+ "$ref": "./examples/AdpDataPoolDelete.json"
+ }
+ }
+ }
+ }
+ },
+ "definitions": {
+ "Tags": {
+ "description": "Resource tags",
+ "properties": {
+ "tags": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ },
+ "x-ms-mutability": [
+ "read",
+ "create",
+ "update"
+ ],
+ "description": "Resource tags."
+ }
+ }
+ },
+ "Account": {
+ "description": "An ADP account.",
+ "type": "object",
+ "properties": {
+ "properties": {
+ "description": "List of account properties",
+ "type": "object",
+ "x-ms-client-flatten": true,
+ "$ref": "#/definitions/AccountProperties"
+ },
+ "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"
+ }
+ ]
+ },
+ "AccountPatch": {
+ "description": "An ADP account.",
+ "type": "object",
+ "properties": {
+ "properties": {
+ "description": "List of account properties",
+ "type": "object",
+ "x-ms-client-flatten": true,
+ "$ref": "#/definitions/AccountProperties"
+ }
+ },
+ "allOf": [
+ {
+ "$ref": "#/definitions/Tags"
+ }
+ ]
+ },
+ "AccountProperties": {
+ "description": "ADP account properties",
+ "properties": {
+ "accountId": {
+ "description": "The account's data-plane ID",
+ "type": "string",
+ "readOnly": true
+ },
+ "provisioningState": {
+ "readOnly": true,
+ "type": "string",
+ "description": "Gets the status of the account at the time the operation was called.",
+ "enum": [
+ "Succeeded",
+ "Failed",
+ "Canceled",
+ "Accepted",
+ "Provisioning",
+ "Deleting"
+ ],
+ "x-ms-enum": {
+ "name": "ProvisioningState",
+ "modelAsString": true
+ }
+ }
+ }
+ },
+ "AccountList": {
+ "properties": {
+ "value": {
+ "readOnly": true,
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/Account"
+ },
+ "description": "List of accounts and their properties."
+ },
+ "nextLink": {
+ "type": "string",
+ "description": "URL to get the next set of operation list results if there are any."
+ }
+ },
+ "description": "The list operation response, that contains the data pools and their properties."
+ },
+ "DataPool": {
+ "description": "An ADP Data Pool.",
+ "properties": {
+ "properties": {
+ "description": "List of data pool properties",
+ "type": "object",
+ "x-ms-client-flatten": true,
+ "$ref": "#/definitions/DataPoolProperties"
+ }
+ },
+ "allOf": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/Resource"
+ }
+ ]
+ },
+ "DataPoolPatch": {
+ "description": "An ADP Data Pool.",
+ "properties": {
+ "properties": {
+ "description": "List of data pool properties",
+ "type": "object",
+ "x-ms-client-flatten": true,
+ "$ref": "#/definitions/DataPoolBaseProperties"
+ }
+ },
+ "allOf": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/Resource"
+ }
+ ]
+ },
+ "DataPoolBaseProperties": {
+ "description": "Data Pool properties",
+ "properties": {
+ "dataPoolId": {
+ "description": "The Data Pool's data-plane ID",
+ "type": "string",
+ "readOnly": true
+ },
+ "provisioningState": {
+ "readOnly": true,
+ "type": "string",
+ "description": "Gets the status of the data pool at the time the operation was called.",
+ "enum": [
+ "Succeeded",
+ "Failed",
+ "Canceled",
+ "Accepted",
+ "Provisioning",
+ "Deleting"
+ ],
+ "x-ms-enum": {
+ "name": "ProvisioningState",
+ "modelAsString": true
+ }
+ },
+ "locations": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/DataPoolLocation"
+ },
+ "minItems": 1,
+ "description": "Gets or sets the collection of locations where Data Pool resources should be created."
+ }
+ }
+ },
+ "DataPoolProperties": {
+ "description": "Data Pool properties",
+ "allOf": [
+ {
+ "$ref": "#/definitions/DataPoolBaseProperties"
+ }
+ ],
+ "required": [
+ "locations"
+ ]
+ },
+ "DataPoolLocation": {
+ "description": "Location of a Data Pool",
+ "properties": {
+ "name": {
+ "description": "The location name",
+ "type": "string"
+ }
+ },
+ "required": [
+ "name"
+ ]
+ },
+ "DataPoolList": {
+ "properties": {
+ "value": {
+ "readOnly": true,
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/DataPool"
+ },
+ "description": "List of data pools and their properties."
+ },
+ "nextLink": {
+ "type": "string",
+ "description": "URL to get the next set of operation list results if there are any."
+ }
+ },
+ "description": "The list operation response, that contains the data pools and their properties."
+ },
+ "Operation": {
+ "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": {
+ "$ref": "#/definitions/OperationProperties",
+ "description": "Properties of the operation",
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "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"
+ }
+ }
+ },
+ "OperationProperties": {
+ "description": "Additional details about an operation.",
+ "type": "object",
+ "x-ms-client-flatten": true,
+ "properties": {
+ "serviceSpecification": {
+ "description": "Details about a service operation.",
+ "$ref": "#/definitions/OperationServiceSpecification"
+ }
+ }
+ },
+ "OperationServiceSpecification": {
+ "description": "Details about a service operation.",
+ "type": "object",
+ "properties": {
+ "logSpecifications": {
+ "description": "Details about operations related to logs.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/OperationLogSpecification"
+ }
+ },
+ "metricSpecifications": {
+ "description": "Details about operations related to metrics.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/OperationMetricSpecification"
+ }
+ }
+ }
+ },
+ "OperationLogSpecification": {
+ "description": "Details about an operation related to logs.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "The name of the log category.",
+ "type": "string"
+ },
+ "displayName": {
+ "description": "Localized display name.",
+ "type": "string"
+ },
+ "blobDuration": {
+ "description": "Blobs created in the customer storage account, per hour.",
+ "type": "string"
+ }
+ }
+ },
+ "OperationMetricSpecification": {
+ "description": "Details about an operation related to metrics.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "The name of the metric.",
+ "type": "string"
+ },
+ "displayName": {
+ "description": "Localized display name of the metric.",
+ "type": "string"
+ },
+ "displayDescription": {
+ "description": "The description of the metric.",
+ "type": "string"
+ },
+ "unit": {
+ "description": "The unit that the metric is measured in.",
+ "type": "string"
+ },
+ "aggregationType": {
+ "description": "The type of metric aggregation.",
+ "type": "string"
+ },
+ "enableRegionalMdmAccount": {
+ "description": "Whether or not the service is using regional MDM accounts.",
+ "type": "string"
+ },
+ "sourceMdmAccount": {
+ "description": "The name of the MDM account.",
+ "type": "string"
+ },
+ "sourceMdmNamespace": {
+ "description": "The name of the MDM namespace.",
+ "type": "string"
+ },
+ "availabilities": {
+ "description": "Defines how often data for metrics becomes available.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/OperationMetricAvailability"
+ }
+ }
+ }
+ },
+ "OperationMetricAvailability": {
+ "description": "Defines how often data for a metric becomes available.",
+ "type": "object",
+ "properties": {
+ "timeGrain": {
+ "description": "The granularity for the metric.",
+ "type": "string"
+ },
+ "blobDuration": {
+ "description": "Blob created in the customer storage account, per hour.",
+ "type": "string"
+ }
+ }
+ },
+ "OperationListResult": {
+ "description": "Available operations of the service.",
+ "properties": {
+ "value": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/Operation"
+ },
+ "description": "List of operations supported by the Resource Provider."
+ },
+ "nextLink": {
+ "type": "string",
+ "description": "URL to get the next set of operation list results if there are any."
+ }
+ }
+ },
+ "ErrorResponse": {
+ "description": "Error response.",
+ "properties": {
+ "error": {
+ "$ref": "#/definitions/ErrorDefinition",
+ "description": "The error details."
+ }
+ }
+ },
+ "ErrorDefinition": {
+ "description": "Error definition.",
+ "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"
+ },
+ "readOnly": true
+ }
+ }
+ }
+ },
+ "parameters": {
+ "AccountNameParameter": {
+ "name": "accountName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the ADP account.",
+ "pattern": "^[a-z0-9]+(-[a-z0-9]+)*",
+ "maxLength": 50,
+ "x-ms-parameter-location": "method"
+ },
+ "DataPoolNameParameter": {
+ "name": "dataPoolName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the Data Pool.",
+ "pattern": "^[a-z0-9]+(-[a-z0-9]+)*",
+ "maxLength": 50,
+ "x-ms-parameter-location": "method"
+ }
+ }
+}
diff --git a/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2020-07-01-preview/examples/AdpAccountDelete.json b/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2020-07-01-preview/examples/AdpAccountDelete.json
new file mode 100644
index 000000000000..f56df2a354f3
--- /dev/null
+++ b/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2020-07-01-preview/examples/AdpAccountDelete.json
@@ -0,0 +1,13 @@
+{
+ "parameters": {
+ "accountName": "sampleacct",
+ "resourceGroupName": "adpClient",
+ "api-version": "2020-07-01-preview",
+ "subscriptionId": "subid"
+ },
+ "responses": {
+ "200": {},
+ "202": {},
+ "204": {}
+ }
+}
diff --git a/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2020-07-01-preview/examples/AdpAccountGet.json b/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2020-07-01-preview/examples/AdpAccountGet.json
new file mode 100644
index 000000000000..b26fb2fd4abb
--- /dev/null
+++ b/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2020-07-01-preview/examples/AdpAccountGet.json
@@ -0,0 +1,22 @@
+{
+ "parameters": {
+ "accountName": "sampleacct",
+ "resourceGroupName": "adpClient",
+ "api-version": "2020-07-01-preview",
+ "subscriptionId": "subid"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.AutonomousDevelopmentPlatform/accounts/adp1",
+ "name": "adp1",
+ "location": "Global",
+ "type": "Microsoft.AutonomousDevelopmentPlatform/accounts",
+ "tags": {},
+ "properties": {
+ "accountId": "id"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2020-07-01-preview/examples/AdpAccountPatch.json b/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2020-07-01-preview/examples/AdpAccountPatch.json
new file mode 100644
index 000000000000..52f5a7518d75
--- /dev/null
+++ b/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2020-07-01-preview/examples/AdpAccountPatch.json
@@ -0,0 +1,33 @@
+{
+ "parameters": {
+ "accountName": "sampleacct",
+ "resourceGroupName": "adpClient",
+ "api-version": "2020-07-01-preview",
+ "subscriptionId": "subid",
+ "parameters": {
+ "properties": {}
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.AutonomousDevelopmentPlatform/accounts/adp1",
+ "name": "adp1",
+ "location": "Global",
+ "type": "Microsoft.AutonomousDevelopmentPlatform/accounts",
+ "tags": {},
+ "properties": {}
+ }
+ },
+ "201": {
+ "body": {
+ "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.AutonomousDevelopmentPlatform/accounts/adp1",
+ "name": "adp1",
+ "location": "Global",
+ "type": "Microsoft.AutonomousDevelopmentPlatform/accounts",
+ "tags": {},
+ "properties": {}
+ }
+ }
+ }
+}
diff --git a/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2020-07-01-preview/examples/AdpAccountPut.json b/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2020-07-01-preview/examples/AdpAccountPut.json
new file mode 100644
index 000000000000..2eb9a55173d3
--- /dev/null
+++ b/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2020-07-01-preview/examples/AdpAccountPut.json
@@ -0,0 +1,34 @@
+{
+ "parameters": {
+ "accountName": "sampleacct",
+ "resourceGroupName": "adpClient",
+ "api-version": "2020-07-01-preview",
+ "subscriptionId": "subid",
+ "parameters": {
+ "location": "Global",
+ "properties": {}
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.AutonomousDevelopmentPlatform/accounts/adp1",
+ "name": "adp1",
+ "location": "Global",
+ "type": "Microsoft.AutonomousDevelopmentPlatform/accounts",
+ "tags": {},
+ "properties": {}
+ }
+ },
+ "201": {
+ "body": {
+ "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.AutonomousDevelopmentPlatform/accounts/adp1",
+ "name": "adp1",
+ "location": "Global",
+ "type": "Microsoft.AutonomousDevelopmentPlatform/accounts",
+ "tags": {},
+ "properties": {}
+ }
+ }
+ }
+}
diff --git a/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2020-07-01-preview/examples/AdpAccountsList.json b/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2020-07-01-preview/examples/AdpAccountsList.json
new file mode 100644
index 000000000000..ec1224c955e4
--- /dev/null
+++ b/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2020-07-01-preview/examples/AdpAccountsList.json
@@ -0,0 +1,26 @@
+{
+ "parameters": {
+ "resourceGroupName": "adpClient",
+ "api-version": "2020-07-01-preview",
+ "subscriptionId": "subid"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.AutonomousDevelopmentPlatform/accounts/adp1",
+ "name": "adp1",
+ "type": "Microsoft.AutonomousDevelopmentPlatform/accounts",
+ "location": "Global",
+ "tags": {},
+ "properties": {
+ "accountId": "id"
+ }
+ }
+ ],
+ "nextLink": "link"
+ }
+ }
+ }
+}
diff --git a/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2020-07-01-preview/examples/AdpAccountsListByResourceGroup.json b/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2020-07-01-preview/examples/AdpAccountsListByResourceGroup.json
new file mode 100644
index 000000000000..d3a341af516f
--- /dev/null
+++ b/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2020-07-01-preview/examples/AdpAccountsListByResourceGroup.json
@@ -0,0 +1,26 @@
+{
+ "parameters": {
+ "api-version": "2020-07-01-preview",
+ "subscriptionId": "subid",
+ "resourceGroupName": "adpClient"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.AutonomousDevelopmentPlatform/accounts/adp1",
+ "name": "adp1",
+ "type": "Microsoft.AutonomousDevelopmentPlatform/accounts",
+ "location": "Global",
+ "tags": {},
+ "properties": {
+ "accountId": "id"
+ }
+ }
+ ],
+ "nextLink": "link"
+ }
+ }
+ }
+}
diff --git a/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2020-07-01-preview/examples/AdpDataPoolDelete.json b/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2020-07-01-preview/examples/AdpDataPoolDelete.json
new file mode 100644
index 000000000000..ea2ac77d762c
--- /dev/null
+++ b/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2020-07-01-preview/examples/AdpDataPoolDelete.json
@@ -0,0 +1,14 @@
+{
+ "parameters": {
+ "accountName": "sampleacct",
+ "dataPoolName": "sampledp",
+ "resourceGroupName": "adpClient",
+ "api-version": "2020-07-01-preview",
+ "subscriptionId": "subid"
+ },
+ "responses": {
+ "200": {},
+ "202": {},
+ "204": {}
+ }
+}
diff --git a/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2020-07-01-preview/examples/AdpDataPoolGet.json b/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2020-07-01-preview/examples/AdpDataPoolGet.json
new file mode 100644
index 000000000000..6be7714e47a0
--- /dev/null
+++ b/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2020-07-01-preview/examples/AdpDataPoolGet.json
@@ -0,0 +1,26 @@
+{
+ "parameters": {
+ "accountName": "sampleacct",
+ "dataPoolName": "sampledp",
+ "resourceGroupName": "adpClient",
+ "api-version": "2020-07-01-preview",
+ "subscriptionId": "subid"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.AutonomousDevelopmentPlatform/accounts/adp1/dataPools/dp1",
+ "name": "dp1",
+ "type": "Microsoft.AutonomousDevelopmentPlatform/accounts/dataPools",
+ "properties": {
+ "dataPoolId": "id",
+ "locations": [
+ {
+ "name": "westus"
+ }
+ ]
+ }
+ }
+ }
+ }
+}
diff --git a/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2020-07-01-preview/examples/AdpDataPoolPatch.json b/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2020-07-01-preview/examples/AdpDataPoolPatch.json
new file mode 100644
index 000000000000..3e1343f70936
--- /dev/null
+++ b/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2020-07-01-preview/examples/AdpDataPoolPatch.json
@@ -0,0 +1,48 @@
+{
+ "parameters": {
+ "accountName": "sampleacct",
+ "dataPoolName": "sampledp",
+ "resourceGroupName": "adpClient",
+ "api-version": "2020-07-01-preview",
+ "subscriptionId": "subid",
+ "parameters": {
+ "properties": {
+ "locations": [
+ {
+ "name": "westus"
+ }
+ ]
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.AutonomousDevelopmentPlatform/accounts/adp1/dataPools/dp1",
+ "name": "dp1",
+ "type": "Microsoft.AutonomousDevelopmentPlatform/accounts/dataPools",
+ "properties": {
+ "locations": [
+ {
+ "name": "westus"
+ }
+ ]
+ }
+ }
+ },
+ "201": {
+ "body": {
+ "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.AutonomousDevelopmentPlatform/accounts/adp1/dataPools/dp1",
+ "name": "dp1",
+ "type": "Microsoft.AutonomousDevelopmentPlatform/accounts/dataPools",
+ "properties": {
+ "locations": [
+ {
+ "name": "westus"
+ }
+ ]
+ }
+ }
+ }
+ }
+}
diff --git a/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2020-07-01-preview/examples/AdpDataPoolPut.json b/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2020-07-01-preview/examples/AdpDataPoolPut.json
new file mode 100644
index 000000000000..3e1343f70936
--- /dev/null
+++ b/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2020-07-01-preview/examples/AdpDataPoolPut.json
@@ -0,0 +1,48 @@
+{
+ "parameters": {
+ "accountName": "sampleacct",
+ "dataPoolName": "sampledp",
+ "resourceGroupName": "adpClient",
+ "api-version": "2020-07-01-preview",
+ "subscriptionId": "subid",
+ "parameters": {
+ "properties": {
+ "locations": [
+ {
+ "name": "westus"
+ }
+ ]
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.AutonomousDevelopmentPlatform/accounts/adp1/dataPools/dp1",
+ "name": "dp1",
+ "type": "Microsoft.AutonomousDevelopmentPlatform/accounts/dataPools",
+ "properties": {
+ "locations": [
+ {
+ "name": "westus"
+ }
+ ]
+ }
+ }
+ },
+ "201": {
+ "body": {
+ "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.AutonomousDevelopmentPlatform/accounts/adp1/dataPools/dp1",
+ "name": "dp1",
+ "type": "Microsoft.AutonomousDevelopmentPlatform/accounts/dataPools",
+ "properties": {
+ "locations": [
+ {
+ "name": "westus"
+ }
+ ]
+ }
+ }
+ }
+ }
+}
diff --git a/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2020-07-01-preview/examples/AdpDataPoolsList.json b/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2020-07-01-preview/examples/AdpDataPoolsList.json
new file mode 100644
index 000000000000..61c1d13a4930
--- /dev/null
+++ b/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2020-07-01-preview/examples/AdpDataPoolsList.json
@@ -0,0 +1,30 @@
+{
+ "parameters": {
+ "accountName": "sampleacct",
+ "resourceGroupName": "adpClient",
+ "api-version": "2020-07-01-preview",
+ "subscriptionId": "subid"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.AutonomousDevelopmentPlatform/accounts/adp1/dataPools/dp1",
+ "name": "dp1",
+ "type": "Microsoft.AutonomousDevelopmentPlatform/accounts/dataPools",
+ "properties": {
+ "dataPoolId": "id",
+ "locations": [
+ {
+ "name": "westus"
+ }
+ ]
+ }
+ }
+ ],
+ "nextLink": "link"
+ }
+ }
+ }
+}
diff --git a/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2020-07-01-preview/examples/AdpOperationsList.json b/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2020-07-01-preview/examples/AdpOperationsList.json
new file mode 100644
index 000000000000..e2f05ce8376f
--- /dev/null
+++ b/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2020-07-01-preview/examples/AdpOperationsList.json
@@ -0,0 +1,40 @@
+{
+ "parameters": {
+ "api-version": "2020-07-01-preview"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "name": "Microsoft.AutonomousDevelopmentPlatform/accounts/read",
+ "display": {
+ "provider": "Microsoft Autonomous Development Platform",
+ "resource": "Account",
+ "operation": "Read accounts",
+ "description": "Read accounts"
+ }
+ },
+ {
+ "name": "Microsoft.AutonomousDevelopmentPlatform/accounts/write",
+ "display": {
+ "provider": "Microsoft Autonomous Development Platform",
+ "resource": "Account",
+ "operation": "Update accounts",
+ "description": "Update accounts"
+ }
+ },
+ {
+ "name": "Microsoft.AutonomousDevelopmentPlatform/accounts/delete",
+ "display": {
+ "provider": "Microsoft Autonomous Development Platform",
+ "resource": "Account",
+ "operation": "Delete accounts",
+ "description": "Delete accounts"
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/adp/resource-manager/readme.az.md b/specification/adp/resource-manager/readme.az.md
new file mode 100644
index 000000000000..ad394bde867b
--- /dev/null
+++ b/specification/adp/resource-manager/readme.az.md
@@ -0,0 +1,12 @@
+## AZ
+
+These settings apply only when `--az` is specified on the command line.
+
+``` yaml $(az) && $(target-mode) != 'core'
+az:
+ extensions: adp
+ namespace: azure.mgmt.adp
+ package-name: azure-mgmt-adp
+az-output-folder: $(azure-cli-extension-folder)/src/adp
+python-sdk-output-folder: "$(az-output-folder)/azext_adp/vendored_sdks/adp"
+```
diff --git a/specification/adp/resource-manager/readme.azureresourceschema.md b/specification/adp/resource-manager/readme.azureresourceschema.md
new file mode 100644
index 000000000000..a641baec289a
--- /dev/null
+++ b/specification/adp/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-adp-2020-07-01-preview
+
+```
+
+Please also specify `--azureresourceschema-folder=`.
+
+### Tag: schema-adp-2020-07-01-preview and azureresourceschema
+
+``` yaml $(tag) == 'schema-adp-2020-07-01-preview' && $(azureresourceschema)
+output-folder: $(azureresourceschema-folder)/schemas
+
+# all the input files in this apiVersion
+input-file:
+ - Microsoft.AutonomousDevelopmentPlatform/preview/2020-07-01-preview/adp.json
+
+```
diff --git a/specification/adp/resource-manager/readme.cli.md b/specification/adp/resource-manager/readme.cli.md
new file mode 100644
index 000000000000..bd1ae237a340
--- /dev/null
+++ b/specification/adp/resource-manager/readme.cli.md
@@ -0,0 +1,6 @@
+## CLI
+
+These settings don't need to apply `--cli` on the command line.
+
+``` yaml
+```
diff --git a/specification/adp/resource-manager/readme.csharp.md b/specification/adp/resource-manager/readme.csharp.md
new file mode 100644
index 000000000000..5ed6552b1f8c
--- /dev/null
+++ b/specification/adp/resource-manager/readme.csharp.md
@@ -0,0 +1,14 @@
+## 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
+ namespace: Microsoft.Azure.Management.AutonomousDevelopmentPlatform
+ output-folder: $(csharp-sdks-folder)/adp/Microsoft.Azure.Management.AutonomousDevelopmentPlatform/Generated
+```
diff --git a/specification/adp/resource-manager/readme.go.md b/specification/adp/resource-manager/readme.go.md
new file mode 100644
index 000000000000..428c70e15dbb
--- /dev/null
+++ b/specification/adp/resource-manager/readme.go.md
@@ -0,0 +1,19 @@
+## Go
+
+These settings apply only when `--go` is specified on the command line.
+
+```yaml $(go)
+go:
+ license-header: MICROSOFT_APACHE_NO_VERSION
+ namespace: adp
+ clear-output-folder: true
+```
+
+### 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.
+Please also specify `--go-sdks-folder=`.
+
+```yaml $(tag) == 'package-2020-07-01-preview' && $(go)
+output-folder: $(go-sdk-folder)/services/preview/adp/mgmt/2019-07-01-preview
+```
diff --git a/specification/adp/resource-manager/readme.md b/specification/adp/resource-manager/readme.md
new file mode 100644
index 000000000000..743ddf7e0100
--- /dev/null
+++ b/specification/adp/resource-manager/readme.md
@@ -0,0 +1,88 @@
+# adp
+
+> 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: AdpManagementClient
+openapi-type: arm
+tag: package-2020-07-01-preview
+```
+
+### Tag: package-2020-07-01-preview
+
+These settings apply only when `--tag=package-2020-07-01-preview` is specified on the command line.
+
+```yaml $(tag) == 'package-2020-07-01-preview'
+input-file:
+ - Microsoft.AutonomousDevelopmentPlatform/preview/2020-07-01-preview/adp.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_adp']
+ - repo: azure-cli-extensions
+ - repo: azure-resource-manager-schemas
+ after_scripts:
+ - node sdkauto_afterscript.js adp/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/adp/resource-manager/readme.python.md b/specification/adp/resource-manager/readme.python.md
new file mode 100644
index 000000000000..07758b81e1ea
--- /dev/null
+++ b/specification/adp/resource-manager/readme.python.md
@@ -0,0 +1,35 @@
+## 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-adp
+clear-output-folder: true
+no-namespace-folders: true
+modelerfour:
+ lenient-model-deduplication: true
+```
+
+```yaml $(multiapi)
+clear-output-folder: true
+batch:
+ - tag: package-2020-07-01-preview
+ - multiapiscript: true
+```
+
+``` yaml $(multiapiscript)
+output-folder: $(python-sdks-folder)/adp/azure-mgmt-adp/azure/mgmt/adp/
+clear-output-folder: false
+perform-load: false
+```
+
+``` yaml $(tag) == 'package-2020-07-01-preview'
+namespace: azure.mgmt.adp.v2020_07_01_preview
+output-folder: $(python-sdks-folder)/adp/azure-mgmt-adp/azure/mgmt/adp/v2020_07_01_preview
+python:
+ namespace: azure.mgmt.adp.v2020_07_01_preview
+ output-folder: $(python-sdks-folder)/adp/azure-mgmt-adp/azure/mgmt/adp/v2020_07_01_preview
+```
diff --git a/specification/adp/resource-manager/readme.ruby.md b/specification/adp/resource-manager/readme.ruby.md
new file mode 100644
index 000000000000..cedab1ae4f5d
--- /dev/null
+++ b/specification/adp/resource-manager/readme.ruby.md
@@ -0,0 +1,25 @@
+## Ruby
+
+These settings apply only when `--ruby` is specified on the command line.
+
+```yaml
+package-name: azure_mgmt_adp
+package-version: 2020-07-01-preview
+azure-arm: true
+```
+
+``` yaml $(ruby) && $(multiapi)
+batch:
+ - tag: package-2020-07-01-preview
+```
+
+
+### Tag: package-2020-07-01-preview and ruby
+
+These settings apply only when `--tag=package-2020-07-01-preview --ruby` is specified on the command line.
+Please also specify `--ruby-sdks-folder=`.
+
+```yaml $(tag) == 'package-2020-07-01-preview' && $(ruby)
+namespace: Azure::AutonomousDevelopmentPlatform::Mgmt::V2020_07_01_preview
+output-folder: $(ruby-sdks-folder)/management/azure_mgmt_adp/lib
+```
diff --git a/specification/adp/resource-manager/readme.typescript.md b/specification/adp/resource-manager/readme.typescript.md
new file mode 100644
index 000000000000..5bc90c6d3cbd
--- /dev/null
+++ b/specification/adp/resource-manager/readme.typescript.md
@@ -0,0 +1,14 @@
+## TypeScript
+
+These settings apply only when `--typescript` is specified on the command line.
+Please also specify `--typescript-sdks-folder=`.
+
+```yaml $(typescript)
+typescript:
+ azure-arm: true
+ package-name: "adp"
+ output-folder: "$(typescript-sdks-folder)/sdk/adp/arm-adp"
+ payload-flattening-threshold: 1
+ generate-metadata: true
+ override-client-name: AdpManagementClient
+```
diff --git a/specification/alertsmanagement/resource-manager/readme.go.md b/specification/alertsmanagement/resource-manager/readme.go.md
index 13f35726b3ee..5fa1c3add76b 100644
--- a/specification/alertsmanagement/resource-manager/readme.go.md
+++ b/specification/alertsmanagement/resource-manager/readme.go.md
@@ -12,19 +12,29 @@ go:
### Go multi-api
``` yaml $(go) && $(multiapi)
batch:
+ - tag: package-2019-06-preview
- tag: package-preview-2019-05
- tag: package-2019-03
- tag: package-2018-05
- tag: package-2018-05-preview
```
+### Tag: package-2019-06-preview and go
+
+These settings apply only when `--tag=package-2019-06-preview --go` is specified on the command line.
+Please also specify `--go-sdk-folder=`.
+
+``` yaml $(tag) == 'package-2019-06-preview' && $(go)
+output-folder: $(go-sdk-folder)/services/preview/$(namespace)/mgmt/2019-06-01-preview/$(namespace)
+```
+
### Tag: package-preview-2019-05 and go
These settings apply only when `--tag=package-preview-2019-05 --go` is specified on the command line.
Please also specify `--go-sdk-folder=`.
``` yaml $(tag) == 'package-preview-2019-05' && $(go)
-output-folder: $(go-sdk-folder)/services/preview/$(namespace)/mgmt/2019-05-05/$(namespace)
+output-folder: $(go-sdk-folder)/services/preview/$(namespace)/mgmt/2019-05-05-preview/$(namespace)
```
### Tag: package-2019-03 and go
diff --git a/specification/appconfiguration/resource-manager/readme.go.md b/specification/appconfiguration/resource-manager/readme.go.md
index 169e554cc7cc..8b9ca1624935 100644
--- a/specification/appconfiguration/resource-manager/readme.go.md
+++ b/specification/appconfiguration/resource-manager/readme.go.md
@@ -25,7 +25,7 @@ These settings apply only when `--tag=package-2020-06-01 --go` is specified on t
Please also specify `--go-sdk-folder=`.
``` yaml $(tag) == 'package-2020-06-01' && $(go)
-output-folder: $(go-sdk-folder)/services/preview/$(namespace)/mgmt/2020-06-01/$(namespace)
+output-folder: $(go-sdk-folder)/services/$(namespace)/mgmt/2020-06-01/$(namespace)
```
### Tag: package-2019-11-01-preview and go
diff --git a/specification/applicationinsights/data-plane/Monitor.Exporters/preview/2020-09-15_Preview/examples/track.json b/specification/applicationinsights/data-plane/Monitor.Exporters/preview/2020-09-15_Preview/examples/track.json
new file mode 100644
index 000000000000..dad4cd1bc839
--- /dev/null
+++ b/specification/applicationinsights/data-plane/Monitor.Exporters/preview/2020-09-15_Preview/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/2020-09-15_Preview/swagger.json b/specification/applicationinsights/data-plane/Monitor.Exporters/preview/2020-09-15_Preview/swagger.json
new file mode 100644
index 000000000000..53f0815ec32c
--- /dev/null
+++ b/specification/applicationinsights/data-plane/Monitor.Exporters/preview/2020-09-15_Preview/swagger.json
@@ -0,0 +1,1021 @@
+{
+ "swagger": "2.0",
+ "info": {
+ "version": "2020-09-15_Preview",
+ "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/",
+ "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",
+ "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 1 / 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
new file mode 100644
index 000000000000..b1ae6ed86f47
--- /dev/null
+++ b/specification/applicationinsights/data-plane/Monitor.Exporters/readme.md
@@ -0,0 +1,44 @@
+# Exporter for Azure Monitor
+> see https://aka.ms/autorest
+
+## 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
+
+The following are the settings for this using this API with AutoRest.
+
+``` yaml
+# specify the version of Autorest to use
+version: 1.0.1-20170402
+
+# (more settings here...)
+```
+
+### Basic Information
+
+These are the global settings for the schemaregistry.
+
+```yaml
+openapi-type: data-plane
+tag: 2020-09-15-preview
+```
+
+### Tag: 2020-09-15-preview
+
+These settings apply only when `--tag=2020-09-15-preview` is specified on the command line.
+
+```yaml $(tag) == '2020-09-15-preview'
+input-file:
+ - preview/2020-09-15_Preview/swagger.json
+```
+
diff --git a/specification/attestation/data-plane/readme.go.md b/specification/attestation/data-plane/readme.go.md
new file mode 100644
index 000000000000..a99623b96edf
--- /dev/null
+++ b/specification/attestation/data-plane/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
+ namespace: attestation
+ clear-output-folder: true
+```
+
+### Go multi-api
+
+``` yaml $(go) && $(multiapi)
+batch:
+ - tag: package-2018-09-preview
+```
+
+### Tag: package-2018-09-preview and go
+
+These settings apply only when `--tag=package-2018-09-preview --go` is specified on the command line.
+Please also specify `--go-sdk-folder=`.
+
+``` yaml $(tag) == 'package-2018-09-preview' && $(go)
+output-folder: $(go-sdk-folder)/services/preview/$(namespace)/2018-09-01-preview/$(namespace)
+```
diff --git a/specification/attestation/data-plane/readme.md b/specification/attestation/data-plane/readme.md
index f382f8bb7b01..c0dfa3499891 100644
--- a/specification/attestation/data-plane/readme.md
+++ b/specification/attestation/data-plane/readme.md
@@ -51,6 +51,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-go
```
## Python
@@ -72,7 +73,9 @@ csharp:
clear-output-folder: true
```
+## Go
+See configuration in [readme.go.md](./readme.go.md)
## Multi-API/Profile support for AutoRest v3 generators
diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoAttachedDatabaseConfigurationsCreateOrUpdate.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoAttachedDatabaseConfigurationsCreateOrUpdate.json
new file mode 100644
index 000000000000..3cd7dcc2bc03
--- /dev/null
+++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoAttachedDatabaseConfigurationsCreateOrUpdate.json
@@ -0,0 +1,61 @@
+{
+ "parameters": {
+ "subscriptionId": "12345678-1234-1234-1234-123456789098",
+ "resourceGroupName": "kustorptest",
+ "clusterName": "kustoclusterrptest4",
+ "attachedDatabaseConfigurationName": "attachedDatabaseConfigurations1",
+ "api-version": "2020-09-18",
+ "parameters": {
+ "location": "westus",
+ "properties": {
+ "clusterResourceId": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterLeader",
+ "databaseName": "kustodatabase",
+ "defaultPrincipalsModificationKind": "Union"
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4/attachedDatabaseConfigurations/attachedDatabaseConfigurations1",
+ "name": "KustoClusterRPTest4/attachedDatabaseConfigurations1",
+ "type": "Microsoft.Kusto/Clusters/AttachedDatabaseConfigurations",
+ "location": "westus",
+ "properties": {
+ "clusterResourceId": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterLeader",
+ "databaseName": "db1",
+ "defaultPrincipalsModificationKind": "Union",
+ "provisioningState": "Succeeded"
+ }
+ }
+ },
+ "201": {
+ "body": {
+ "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4/attachedDatabaseConfigurations/attachedDatabaseConfigurations1",
+ "name": "KustoClusterRPTest4/attachedDatabaseConfigurations1",
+ "type": "Microsoft.Kusto/Clusters/AttachedDatabaseConfigurations",
+ "location": "westus",
+ "properties": {
+ "clusterResourceId": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterLeader",
+ "databaseName": "db1",
+ "defaultPrincipalsModificationKind": "Union",
+ "provisioningState": "Creating"
+ }
+ }
+ },
+ "202": {
+ "body": {
+ "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4/attachedDatabaseConfigurations/attachedDatabaseConfigurations1",
+ "name": "KustoClusterRPTest4/attachedDatabaseConfigurations1",
+ "type": "Microsoft.Kusto/Clusters/AttachedDatabaseConfigurations",
+ "location": "westus",
+ "properties": {
+ "clusterResourceId": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterLeader",
+ "databaseName": "db1",
+ "defaultPrincipalsModificationKind": "Union",
+ "provisioningState": "Creating"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoAttachedDatabaseConfigurationsDelete.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoAttachedDatabaseConfigurationsDelete.json
new file mode 100644
index 000000000000..b4d3053b2661
--- /dev/null
+++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoAttachedDatabaseConfigurationsDelete.json
@@ -0,0 +1,14 @@
+{
+ "parameters": {
+ "subscriptionId": "12345678-1234-1234-1234-123456789098",
+ "resourceGroupName": "kustorptest",
+ "clusterName": "kustoclusterrptest4",
+ "attachedDatabaseConfigurationName": "attachedDatabaseConfigurations1",
+ "api-version": "2020-09-18"
+ },
+ "responses": {
+ "200": {},
+ "202": {},
+ "204": {}
+ }
+}
diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoAttachedDatabaseConfigurationsGet.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoAttachedDatabaseConfigurationsGet.json
new file mode 100644
index 000000000000..9084959fe306
--- /dev/null
+++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoAttachedDatabaseConfigurationsGet.json
@@ -0,0 +1,25 @@
+{
+ "parameters": {
+ "subscriptionId": "12345678-1234-1234-1234-123456789098",
+ "resourceGroupName": "kustorptest",
+ "clusterName": "kustoclusterrptest4",
+ "attachedDatabaseConfigurationName": "attachedDatabaseConfigurations1",
+ "api-version": "2020-09-18"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4/AttachedDatabaseConfigurations/attachedDatabaseConfigurations1",
+ "name": "KustoClusterRPTest4/attachedDatabaseConfigurations1",
+ "type": "Microsoft.Kusto/Clusters/AttachedDatabaseConfigurations",
+ "location": "westus",
+ "properties": {
+ "clusterResourceId": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4",
+ "databaseName": "*",
+ "defaultPrincipalsModificationKind": "Union",
+ "provisioningState": "Succeeded"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoAttachedDatabaseConfigurationsListByCluster.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoAttachedDatabaseConfigurationsListByCluster.json
new file mode 100644
index 000000000000..486ab7459f31
--- /dev/null
+++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoAttachedDatabaseConfigurationsListByCluster.json
@@ -0,0 +1,40 @@
+{
+ "parameters": {
+ "subscriptionId": "12345678-1234-1234-1234-123456789098",
+ "resourceGroupName": "kustorptest",
+ "clusterName": "kustoclusterrptest4",
+ "api-version": "2020-09-18"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4/AttachedDatabaseConfigurations/KustoDatabase8",
+ "name": "KustoClusterRPTest4/KustoDatabase8",
+ "type": "Microsoft.Kusto/Clusters/AttachedDatabaseConfigurations",
+ "location": "westus",
+ "properties": {
+ "clusterResourceId": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterLeader",
+ "databaseName": "db1",
+ "defaultPrincipalsModificationKind": "Union",
+ "provisioningState": "Succeeded"
+ }
+ },
+ {
+ "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4/AttachedDatabaseConfigurations/KustoDatabase9",
+ "name": "KustoClusterRPTest4/KustoDatabase9",
+ "type": "Microsoft.Kusto/Clusters/AttachedDatabaseConfigurations",
+ "location": "westus",
+ "properties": {
+ "clusterResourceId": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterLeader",
+ "databaseName": "db1",
+ "defaultPrincipalsModificationKind": "Union",
+ "provisioningState": "Succeeded"
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoClusterAddLanguageExtensions.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoClusterAddLanguageExtensions.json
new file mode 100644
index 000000000000..64fc755ae1fc
--- /dev/null
+++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoClusterAddLanguageExtensions.json
@@ -0,0 +1,22 @@
+{
+ "parameters": {
+ "subscriptionId": "12345678-1234-1234-1234-123456789098",
+ "resourceGroupName": "kustorptest",
+ "clusterName": "kustoclusterrptest4",
+ "api-version": "2020-09-18",
+ "languageExtensionsToAdd": {
+ "value": [
+ {
+ "languageExtensionName": "PYTHON"
+ },
+ {
+ "languageExtensionName": "R"
+ }
+ ]
+ }
+ },
+ "responses": {
+ "200": {},
+ "202": {}
+ }
+}
diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoClusterDetachFollowerDatabases.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoClusterDetachFollowerDatabases.json
new file mode 100644
index 000000000000..fa7219ff1b82
--- /dev/null
+++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoClusterDetachFollowerDatabases.json
@@ -0,0 +1,16 @@
+{
+ "parameters": {
+ "subscriptionId": "12345678-1234-1234-1234-123456789098",
+ "resourceGroupName": "kustorptest",
+ "clusterName": "kustoclusterrptest4",
+ "api-version": "2020-09-18",
+ "followerDatabaseToRemove": {
+ "clusterResourceId": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/clusters/leader4",
+ "attachedDatabaseConfigurationName": "myAttachedDatabaseConfiguration"
+ }
+ },
+ "responses": {
+ "200": {},
+ "202": {}
+ }
+}
diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoClusterListFollowerDatabases.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoClusterListFollowerDatabases.json
new file mode 100644
index 000000000000..f6fc5b64ce8a
--- /dev/null
+++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoClusterListFollowerDatabases.json
@@ -0,0 +1,26 @@
+{
+ "parameters": {
+ "subscriptionId": "12345678-1234-1234-1234-123456789098",
+ "resourceGroupName": "kustorptest",
+ "clusterName": "kustoclusterrptest4",
+ "api-version": "2020-09-18"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "attachedDatabaseConfigurationName": "attachedDbConfiguration",
+ "clusterResourceId": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/clusters/follower1",
+ "databaseName": "*"
+ },
+ {
+ "attachedDatabaseConfigurationName": "attachedDbConfiguration2",
+ "clusterResourceId": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/clusters/follower4",
+ "databaseName": "db1"
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoClusterListLanguageExtensions.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoClusterListLanguageExtensions.json
new file mode 100644
index 000000000000..32d0dabe8250
--- /dev/null
+++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoClusterListLanguageExtensions.json
@@ -0,0 +1,22 @@
+{
+ "parameters": {
+ "subscriptionId": "12345678-1234-1234-1234-123456789098",
+ "resourceGroupName": "kustorptest",
+ "clusterName": "kustoclusterrptest4",
+ "api-version": "2020-09-18"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "languageExtensionName": "PYTHON"
+ },
+ {
+ "languageExtensionName": "R"
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoClusterPrincipalAssignmentsCheckNameAvailability.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoClusterPrincipalAssignmentsCheckNameAvailability.json
new file mode 100644
index 000000000000..28b8998c1008
--- /dev/null
+++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoClusterPrincipalAssignmentsCheckNameAvailability.json
@@ -0,0 +1,21 @@
+{
+ "parameters": {
+ "subscriptionId": "12345678-1234-1234-1234-123456789098",
+ "resourceGroupName": "kustorptest",
+ "clusterName": "kustoclusterrptest4",
+ "principalAssignmentName": {
+ "name": "kustoprincipal1",
+ "type": "Microsoft.Kusto/clusters/principalAssignments"
+ },
+ "api-version": "2020-09-18"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "name": "kustoprincipal1",
+ "nameAvailable": false,
+ "message": "Name 'kustoprincipal1' is already taken. Please specify a different name"
+ }
+ }
+ }
+}
diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoClusterPrincipalAssignmentsCreateOrUpdate.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoClusterPrincipalAssignmentsCreateOrUpdate.json
new file mode 100644
index 000000000000..dd7571930885
--- /dev/null
+++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoClusterPrincipalAssignmentsCreateOrUpdate.json
@@ -0,0 +1,51 @@
+{
+ "parameters": {
+ "subscriptionId": "12345678-1234-1234-1234-123456789098",
+ "resourceGroupName": "kustorptest",
+ "clusterName": "kustoclusterrptest4",
+ "principalAssignmentName": "kustoprincipal1",
+ "api-version": "2020-09-18",
+ "parameters": {
+ "properties": {
+ "role": "AllDatabasesAdmin",
+ "principalId": "87654321-1234-1234-1234-123456789123",
+ "principalType": "App",
+ "tenantId": "12345678-1234-1234-1234-123456789123"
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/kustoclusterrptest4/PrincipalAssignments/kustoprincipal1",
+ "name": "kustoclusterrptest4/kustoprincipal1",
+ "type": "Microsoft.Kusto/Clusters/PrincipalAssignments",
+ "properties": {
+ "role": "Admin",
+ "principalId": "87654321-1234-1234-1234-123456789123",
+ "principalType": "App",
+ "tenantId": "12345678-1234-1234-1234-123456789123",
+ "tenantName": "tenantName",
+ "principalName": "TestApp",
+ "provisioningState": "Succeeded"
+ }
+ }
+ },
+ "201": {
+ "body": {
+ "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/kustoclusterrptest4/PrincipalAssignments/kustoprincipal1",
+ "name": "kustoclusterrptest4/kustoprincipal1",
+ "type": "Microsoft.Kusto/Clusters/PrincipalAssignments",
+ "properties": {
+ "role": "Admin",
+ "principalId": "87654321-1234-1234-1234-123456789123",
+ "principalType": "App",
+ "tenantId": "12345678-1234-1234-1234-123456789123",
+ "tenantName": "tenantName",
+ "principalName": "TestApp",
+ "provisioningState": "Succeeded"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoClusterPrincipalAssignmentsDelete.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoClusterPrincipalAssignmentsDelete.json
new file mode 100644
index 000000000000..7f1ec1602d86
--- /dev/null
+++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoClusterPrincipalAssignmentsDelete.json
@@ -0,0 +1,14 @@
+{
+ "parameters": {
+ "subscriptionId": "12345678-1234-1234-1234-123456789098",
+ "resourceGroupName": "kustorptest",
+ "clusterName": "kustoclusterrptest4",
+ "principalAssignmentName": "kustoprincipal1",
+ "api-version": "2020-09-18"
+ },
+ "responses": {
+ "200": {},
+ "202": {},
+ "204": {}
+ }
+}
diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoClusterPrincipalAssignmentsGet.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoClusterPrincipalAssignmentsGet.json
new file mode 100644
index 000000000000..21e5ab70c8f7
--- /dev/null
+++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoClusterPrincipalAssignmentsGet.json
@@ -0,0 +1,27 @@
+{
+ "parameters": {
+ "subscriptionId": "12345678-1234-1234-1234-123456789098",
+ "resourceGroupName": "kustorptest",
+ "clusterName": "kustoclusterrptest4",
+ "principalAssignmentName": "kustoprincipal1",
+ "api-version": "2020-09-18"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/kustoclusterrptest4/PrincipalAssignments/kustoprincipal1",
+ "name": "kustoclusterrptest4/kustoprincipal1",
+ "type": "Microsoft.Kusto/Clusters/PrincipalAssignments",
+ "properties": {
+ "role": "Admin",
+ "principalId": "87654321-1234-1234-1234-123456789123",
+ "principalType": "App",
+ "tenantId": "12345678-1234-1234-1234-123456789123",
+ "tenantName": "tenantName",
+ "principalName": "TestApp",
+ "provisioningState": "Succeeded"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoClusterPrincipalAssignmentsList.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoClusterPrincipalAssignmentsList.json
new file mode 100644
index 000000000000..080811fea6db
--- /dev/null
+++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoClusterPrincipalAssignmentsList.json
@@ -0,0 +1,45 @@
+{
+ "parameters": {
+ "subscriptionId": "12345678-1234-1234-1234-123456789098",
+ "resourceGroupName": "kustorptest",
+ "clusterName": "kustoclusterrptest4",
+ "databaseName": "Kustodatabase8",
+ "api-version": "2020-09-18"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/kustoclusterrptest4/Databases/Kustodatabase8/PrincipalAssignments/kustoprincipal1",
+ "name": "kustoclusterrptest4/Kustodatabase8/kustoprincipal1",
+ "type": "Microsoft.Kusto/Clusters/Databases/PrincipalAssignments",
+ "properties": {
+ "role": "Admin",
+ "principalId": "87654321-1234-1234-1234-123456789123",
+ "principalType": "App",
+ "tenantId": "12345678-1234-1234-1234-123456789123",
+ "tenantName": "tenantName",
+ "principalName": "TestApp",
+ "provisioningState": "Succeeded"
+ }
+ },
+ {
+ "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/kustoclusterrptest4/Databases/Kustodatabase8/PrincipalAssignments/kustoprincipal1",
+ "name": "kustoclusterrptest4/Kustodatabase8/kustoprincipal2",
+ "type": "Microsoft.Kusto/Clusters/Databases/PrincipalAssignments",
+ "properties": {
+ "role": "Admin",
+ "principalId": "87654321-1234-1234-1234-123456789123",
+ "principalType": "App",
+ "tenantId": "12345678-1234-1234-1234-123456789123",
+ "tenantName": "tenantName",
+ "principalName": "TestApp",
+ "provisioningState": "Succeeded"
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoClusterRemoveLanguageExtensions.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoClusterRemoveLanguageExtensions.json
new file mode 100644
index 000000000000..6cdfd1e46b90
--- /dev/null
+++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoClusterRemoveLanguageExtensions.json
@@ -0,0 +1,22 @@
+{
+ "parameters": {
+ "subscriptionId": "12345678-1234-1234-1234-123456789098",
+ "resourceGroupName": "kustorptest",
+ "clusterName": "kustoclusterrptest4",
+ "api-version": "2020-09-18",
+ "languageExtensionsToRemove": {
+ "value": [
+ {
+ "languageExtensionName": "PYTHON"
+ },
+ {
+ "languageExtensionName": "R"
+ }
+ ]
+ }
+ },
+ "responses": {
+ "200": {},
+ "202": {}
+ }
+}
diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoClustersCheckNameAvailability.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoClustersCheckNameAvailability.json
new file mode 100644
index 000000000000..a2298cbd294e
--- /dev/null
+++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoClustersCheckNameAvailability.json
@@ -0,0 +1,20 @@
+{
+ "parameters": {
+ "subscriptionId": "12345678-1234-1234-1234-123456789098",
+ "api-version": "2020-09-18",
+ "location": "wus",
+ "clusterName": {
+ "name": "kustoclusterrptest4",
+ "type": "Microsoft.Kusto/clusters"
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "name": "kuskusprod",
+ "nameAvailable": false,
+ "message": "Name 'kuskusprod' is already taken. Please specify a different name"
+ }
+ }
+ }
+}
diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoClustersCreateOrUpdate.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoClustersCreateOrUpdate.json
new file mode 100644
index 000000000000..da62b0b8fabb
--- /dev/null
+++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoClustersCreateOrUpdate.json
@@ -0,0 +1,88 @@
+{
+ "parameters": {
+ "subscriptionId": "12345678-1234-1234-1234-123456789098",
+ "resourceGroupName": "kustorptest",
+ "clusterName": "kustoclusterrptest4",
+ "api-version": "2020-09-18",
+ "parameters": {
+ "location": "westus",
+ "sku": {
+ "name": "Standard_L8s",
+ "capacity": 2,
+ "tier": "Standard"
+ },
+ "identity": {
+ "type": "SystemAssigned"
+ },
+ "properties": {
+ "enableStreamingIngest": true,
+ "enablePurge": true,
+ "enableDoubleEncryption": false
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4",
+ "name": "KustoClusterRPTest4",
+ "type": "Microsoft.Kusto/Clusters",
+ "location": "westus",
+ "properties": {
+ "provisioningState": "Succeeded",
+ "enableStreamingIngest": true,
+ "enablePurge": true,
+ "enableDoubleEncryption": false,
+ "keyVaultProperties": {
+ "keyVaultUri": "https://dummy.keyvault.com",
+ "keyName": "keyName",
+ "keyVersion": "keyVersion"
+ },
+ "engineType": "V2"
+ },
+ "sku": {
+ "name": "Standard_L8s",
+ "capacity": 2,
+ "tier": "Standard"
+ },
+ "identity": {
+ "type": "SystemAssigned",
+ "tenantId": "b932977f-6277-4ab7-a2cd-5bd21f07aaf4",
+ "principalId": "faabad1f-4876-463c-af9d-6ba2d2d2394c",
+ "userAssignedIdentities": {}
+ }
+ }
+ },
+ "201": {
+ "body": {
+ "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4",
+ "name": "KustoClusterRPTest4",
+ "type": "Microsoft.Kusto/Clusters",
+ "location": "westus",
+ "properties": {
+ "provisioningState": "Succeeded",
+ "enableStreamingIngest": true,
+ "enablePurge": true,
+ "enableDoubleEncryption": false,
+ "keyVaultProperties": {
+ "keyVaultUri": "https://dummy.keyvault.com",
+ "keyName": "keyName",
+ "keyVersion": "keyVersion"
+ },
+ "engineType": "V2"
+ },
+ "sku": {
+ "name": "Standard_L8s",
+ "capacity": 2,
+ "tier": "Standard"
+ },
+ "identity": {
+ "type": "SystemAssigned",
+ "tenantId": "b932977f-6277-4ab7-a2cd-5bd21f07aaf4",
+ "principalId": "faabad1f-4876-463c-af9d-6ba2d2d2394c",
+ "userAssignedIdentities": {}
+ }
+ }
+ }
+ }
+}
diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoClustersDelete.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoClustersDelete.json
new file mode 100644
index 000000000000..07afa7145686
--- /dev/null
+++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoClustersDelete.json
@@ -0,0 +1,13 @@
+{
+ "parameters": {
+ "subscriptionId": "12345678-1234-1234-1234-123456789098",
+ "resourceGroupName": "kustorptest",
+ "clusterName": "kustoclusterrptest4",
+ "api-version": "2020-09-18"
+ },
+ "responses": {
+ "200": {},
+ "202": {},
+ "204": {}
+ }
+}
diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoClustersDiagnoseVirtualNetwork.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoClustersDiagnoseVirtualNetwork.json
new file mode 100644
index 000000000000..4d28dd726a9a
--- /dev/null
+++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoClustersDiagnoseVirtualNetwork.json
@@ -0,0 +1,18 @@
+{
+ "parameters": {
+ "subscriptionId": "12345678-1234-1234-1234-123456789098",
+ "resourceGroupName": "kustorptest",
+ "clusterName": "kustoclusterrptest4",
+ "api-version": "2020-09-18"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "findings": [
+ "Outbound dependency 'Storage:443' might not be satisfied (Outbound)"
+ ]
+ }
+ },
+ "202": {}
+ }
+}
diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoClustersGet.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoClustersGet.json
new file mode 100644
index 000000000000..4eed52534e40
--- /dev/null
+++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoClustersGet.json
@@ -0,0 +1,40 @@
+{
+ "parameters": {
+ "subscriptionId": "12345678-1234-1234-1234-123456789098",
+ "resourceGroupName": "kustorptest",
+ "clusterName": "kustoclusterrptest4",
+ "api-version": "2020-09-18"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4",
+ "name": "KustoClusterRPTest4",
+ "type": "Microsoft.Kusto/Clusters",
+ "location": "westus",
+ "properties": {
+ "provisioningState": "Succeeded",
+ "enableStreamingIngest": true,
+ "enablePurge": false,
+ "keyVaultProperties": {
+ "keyVaultUri": "https://dummy.keyvault.com",
+ "keyName": "keyName",
+ "keyVersion": "keyVersion"
+ },
+ "engineType": "V2"
+ },
+ "sku": {
+ "name": "Standard_L8s",
+ "capacity": 2,
+ "tier": "Standard"
+ },
+ "identity": {
+ "type": "SystemAssigned",
+ "tenantId": "b932977f-6277-4ab7-a2cd-5bd21f07aaf4",
+ "principalId": "faabad1f-4876-463c-af9d-6ba2d2d2394c",
+ "userAssignedIdentities": {}
+ }
+ }
+ }
+ }
+}
diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoClustersList.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoClustersList.json
new file mode 100644
index 000000000000..ae7841c260b0
--- /dev/null
+++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoClustersList.json
@@ -0,0 +1,48 @@
+{
+ "parameters": {
+ "subscriptionId": "12345678-1234-1234-1234-123456789098",
+ "api-version": "2020-09-18"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4",
+ "name": "KustoClusterRPTest4",
+ "type": "Microsoft.Kusto/Clusters",
+ "location": "westus",
+ "properties": {
+ "provisioningState": "Succeeded",
+ "keyVaultProperties": {
+ "keyVaultUri": "https://dummy.keyvault.com",
+ "keyName": "keyName",
+ "keyVersion": "keyVersion"
+ },
+ "engineType": "V2"
+ },
+ "sku": {
+ "name": "Standard_L8s",
+ "capacity": 2,
+ "tier": "Standard"
+ }
+ },
+ {
+ "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest3",
+ "name": "KustoClusterRPTest3",
+ "type": "Microsoft.Kusto/Clusters",
+ "location": "westus",
+ "properties": {
+ "provisioningState": "Succeeded"
+ },
+ "sku": {
+ "name": "Standard_L8s",
+ "capacity": 2,
+ "tier": "Standard"
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoClustersListByResourceGroup.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoClustersListByResourceGroup.json
new file mode 100644
index 000000000000..eb34b2c020ab
--- /dev/null
+++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoClustersListByResourceGroup.json
@@ -0,0 +1,49 @@
+{
+ "parameters": {
+ "subscriptionId": "12345678-1234-1234-1234-123456789098",
+ "resourceGroupName": "kustorptest",
+ "api-version": "2020-09-18"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4",
+ "name": "KustoClusterRPTest4",
+ "type": "Microsoft.Kusto/Clusters",
+ "location": "westus",
+ "properties": {
+ "provisioningState": "Succeeded",
+ "keyVaultProperties": {
+ "keyVaultUri": "https://dummy.keyvault.com",
+ "keyName": "keyName",
+ "keyVersion": "keyVersion"
+ },
+ "engineType": "V2"
+ },
+ "sku": {
+ "name": "Standard_L8s",
+ "capacity": 2,
+ "tier": "Standard"
+ }
+ },
+ {
+ "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest3",
+ "name": "KustoClusterRPTest3",
+ "type": "Microsoft.Kusto/Clusters",
+ "location": "westus",
+ "properties": {
+ "provisioningState": "Succeeded"
+ },
+ "sku": {
+ "name": "Standard_L8s",
+ "capacity": 2,
+ "tier": "Standard"
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoClustersListResourceSkus.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoClustersListResourceSkus.json
new file mode 100644
index 000000000000..e3068b3326cc
--- /dev/null
+++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoClustersListResourceSkus.json
@@ -0,0 +1,68 @@
+{
+ "parameters": {
+ "subscriptionId": "12345678-1234-1234-1234-123456789098",
+ "resourceGroupName": "kustorptest",
+ "clusterName": "kustoclusterrptest4",
+ "api-version": "2020-09-18"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "resourceType": "clusters",
+ "sku": {
+ "name": "Standard_D13_v2",
+ "tier": "Standard"
+ },
+ "capacity": {
+ "minimum": 2,
+ "maximum": 100,
+ "default": 2,
+ "scaleType": "automatic"
+ }
+ },
+ {
+ "resourceType": "clusters",
+ "sku": {
+ "name": "Standard_D14_v2",
+ "tier": "Standard"
+ },
+ "capacity": {
+ "minimum": 2,
+ "maximum": 100,
+ "default": 2,
+ "scaleType": "automatic"
+ }
+ },
+ {
+ "resourceType": "clusters",
+ "sku": {
+ "name": "Standard_L8s",
+ "tier": "Standard"
+ },
+ "capacity": {
+ "minimum": 2,
+ "maximum": 100,
+ "default": 2,
+ "scaleType": "automatic"
+ }
+ },
+ {
+ "resourceType": "clusters",
+ "sku": {
+ "name": "Standard_L16s",
+ "tier": "Standard"
+ },
+ "capacity": {
+ "minimum": 2,
+ "maximum": 100,
+ "default": 2,
+ "scaleType": "automatic"
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoClustersListSkus.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoClustersListSkus.json
new file mode 100644
index 000000000000..3ab882df762b
--- /dev/null
+++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoClustersListSkus.json
@@ -0,0 +1,103 @@
+{
+ "parameters": {
+ "subscriptionId": "12345678-1234-1234-1234-123456789098",
+ "resourceGroupName": "kustorptest",
+ "api-version": "2020-09-18"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "name": "Standard_D13_v2",
+ "tier": "Standard",
+ "locations": [
+ "West US",
+ "West Europe"
+ ],
+ "locationInfo": [
+ {
+ "location": "West US",
+ "zones": [
+ "1",
+ "2",
+ "3"
+ ]
+ },
+ {
+ "location": "West Europe",
+ "zones": []
+ }
+ ]
+ },
+ {
+ "name": "Standard_D14_v2",
+ "tier": "Standard",
+ "locations": [
+ "West US",
+ "West Europe"
+ ],
+ "locationInfo": [
+ {
+ "location": "West US",
+ "zones": [
+ "1",
+ "2",
+ "3"
+ ]
+ },
+ {
+ "location": "West Europe",
+ "zones": []
+ }
+ ]
+ },
+ {
+ "name": "L8",
+ "tier": "Standard",
+ "locations": [
+ "West US",
+ "West Europe"
+ ],
+ "locationInfo": [
+ {
+ "location": "West US",
+ "zones": [
+ "1",
+ "2",
+ "3"
+ ]
+ },
+ {
+ "location": "West Europe",
+ "zones": []
+ }
+ ]
+ },
+ {
+ "name": "L16",
+ "tier": "Standard",
+ "locations": [
+ "West US",
+ "West Europe"
+ ],
+ "locationInfo": [
+ {
+ "location": "West US",
+ "zones": [
+ "1",
+ "2",
+ "3"
+ ]
+ },
+ {
+ "location": "West Europe",
+ "zones": []
+ }
+ ]
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoClustersStart.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoClustersStart.json
new file mode 100644
index 000000000000..980f22a32831
--- /dev/null
+++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoClustersStart.json
@@ -0,0 +1,12 @@
+{
+ "parameters": {
+ "subscriptionId": "12345678-1234-1234-1234-123456789098",
+ "resourceGroupName": "kustorptest",
+ "clusterName": "kustoclusterrptest4",
+ "api-version": "2020-09-18"
+ },
+ "responses": {
+ "200": {},
+ "202": {}
+ }
+}
diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoClustersStop.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoClustersStop.json
new file mode 100644
index 000000000000..980f22a32831
--- /dev/null
+++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoClustersStop.json
@@ -0,0 +1,12 @@
+{
+ "parameters": {
+ "subscriptionId": "12345678-1234-1234-1234-123456789098",
+ "resourceGroupName": "kustorptest",
+ "clusterName": "kustoclusterrptest4",
+ "api-version": "2020-09-18"
+ },
+ "responses": {
+ "200": {},
+ "202": {}
+ }
+}
diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoClustersUpdate.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoClustersUpdate.json
new file mode 100644
index 000000000000..b770f9d74a4b
--- /dev/null
+++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoClustersUpdate.json
@@ -0,0 +1,111 @@
+{
+ "parameters": {
+ "subscriptionId": "12345678-1234-1234-1234-123456789098",
+ "resourceGroupName": "kustorptest",
+ "clusterName": "kustoclusterrptest4",
+ "api-version": "2020-09-18",
+ "parameters": {
+ "location": "westus"
+ },
+ "identity": {
+ "type": "SystemAssigned"
+ },
+ "properties": {
+ "enableStreamingIngest": true,
+ "enablePurge": true,
+ "keyVaultProperties": {
+ "keyVaultUri": "https://dummy.keyvault.com",
+ "keyName": "keyName",
+ "keyVersion": "keyVersion"
+ },
+ "engineType": "V2"
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4",
+ "name": "KustoClusterRPTest4",
+ "type": "Microsoft.Kusto/Clusters",
+ "location": "westus",
+ "properties": {
+ "provisioningState": "Succeeded",
+ "enableStreamingIngest": true,
+ "enablePurge": true,
+ "keyVaultProperties": {
+ "keyVaultUri": "https://dummy.keyvault.com",
+ "keyName": "keyName",
+ "keyVersion": "keyVersion"
+ },
+ "engineType": "V2"
+ },
+ "sku": {
+ "name": "Standard_L8s",
+ "capacity": 2,
+ "tier": "Standard"
+ },
+ "identity": {
+ "type": "SystemAssigned",
+ "tenantId": "b932977f-6277-4ab7-a2cd-5bd21f07aaf4",
+ "principalId": "faabad1f-4876-463c-af9d-6ba2d2d2394c",
+ "userAssignedIdentities": {}
+ }
+ }
+ },
+ "201": {
+ "body": {
+ "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4",
+ "name": "KustoClusterRPTest4",
+ "type": "Microsoft.Kusto/Clusters",
+ "location": "westus",
+ "properties": {
+ "provisioningState": "Succeeded",
+ "enableStreamingIngest": true,
+ "enablePurge": true,
+ "keyVaultProperties": {
+ "keyVaultUri": "https://dummy.keyvault.com",
+ "keyName": "keyName",
+ "keyVersion": "keyVersion"
+ },
+ "engineType": "V2"
+ },
+ "sku": {
+ "name": "Standard_L8s",
+ "capacity": 2,
+ "tier": "Standard"
+ },
+ "identity": {
+ "type": "SystemAssigned",
+ "tenantId": "b932977f-6277-4ab7-a2cd-5bd21f07aaf4",
+ "principalId": "faabad1f-4876-463c-af9d-6ba2d2d2394c",
+ "userAssignedIdentities": {}
+ }
+ }
+ },
+ "202": {
+ "body": {
+ "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4",
+ "name": "KustoClusterRPTest4",
+ "type": "Microsoft.Kusto/Clusters",
+ "location": "westus",
+ "properties": {
+ "provisioningState": "Succeeded",
+ "enableStreamingIngest": true,
+ "enablePurge": true,
+ "engineType": "V2"
+ },
+ "sku": {
+ "name": "Standard_L8s",
+ "capacity": 2,
+ "tier": "Standard"
+ },
+ "identity": {
+ "type": "SystemAssigned",
+ "tenantId": "b932977f-6277-4ab7-a2cd-5bd21f07aaf4",
+ "principalId": "faabad1f-4876-463c-af9d-6ba2d2d2394c",
+ "userAssignedIdentities": {}
+ }
+ }
+ }
+ }
+}
diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoDataConnectionValidationAsync.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoDataConnectionValidationAsync.json
new file mode 100644
index 000000000000..487600856acd
--- /dev/null
+++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoDataConnectionValidationAsync.json
@@ -0,0 +1,30 @@
+{
+ "parameters": {
+ "subscriptionId": "12345678-1234-1234-1234-123456789098",
+ "resourceGroupName": "kustorptest",
+ "clusterName": "kustoclusterrptest4",
+ "databaseName": "KustoDatabase8",
+ "api-version": "2020-09-18",
+ "parameters": {
+ "dataConnectionName": "DataConnections8",
+ "properties": {
+ "kind": "EventHub",
+ "eventHubResourceId": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.EventHub/namespaces/eventhubTestns1/eventhubs/eventhubTest1",
+ "consumerGroup": "testConsumerGroup1"
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": [
+ {
+ "errorMessage": "Event hub's namespace does not exist"
+ },
+ {
+ "errorMessage": "Database does not exist"
+ }
+ ]
+ },
+ "202": {}
+ }
+}
diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoDataConnectionsCheckNameAvailability.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoDataConnectionsCheckNameAvailability.json
new file mode 100644
index 000000000000..2903d8f64139
--- /dev/null
+++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoDataConnectionsCheckNameAvailability.json
@@ -0,0 +1,23 @@
+{
+ "parameters": {
+ "api-version": "2020-09-18",
+ "subscriptionId": "12345678-1234-1234-1234-123456789098",
+ "resourceGroupName": "kustorptest",
+ "clusterName": "kustoclusterrptest4",
+ "databaseName": "KustoDatabase8",
+ "dataConnectionName": {
+ "name": "DataConnections8",
+ "type": "Microsoft.Kusto/clusters/databases/dataConnections"
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "name": "DataConnections8",
+ "nameAvailable": false,
+ "message": "Name 'DataConnections8' is already taken. Please specify a different name.",
+ "reason": "AlreadyExists"
+ }
+ }
+ }
+}
diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoDataConnectionsCreateOrUpdate.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoDataConnectionsCreateOrUpdate.json
new file mode 100644
index 000000000000..1fb8d3788065
--- /dev/null
+++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoDataConnectionsCreateOrUpdate.json
@@ -0,0 +1,59 @@
+{
+ "parameters": {
+ "subscriptionId": "12345678-1234-1234-1234-123456789098",
+ "resourceGroupName": "kustorptest",
+ "clusterName": "kustoclusterrptest4",
+ "databaseName": "KustoDatabase8",
+ "api-version": "2020-09-18",
+ "dataConnectionName": "DataConnections8",
+ "parameters": {
+ "location": "westus",
+ "kind": "EventHub",
+ "properties": {
+ "eventHubResourceId": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.EventHub/namespaces/eventhubTestns1/eventhubs/eventhubTest1",
+ "consumerGroup": "testConsumerGroup1"
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4/Databases/KustoDatabase8/DataConnections/DataConnections8",
+ "name": "KustoClusterRPTest4/KustoDatabase8/DataConnections8",
+ "type": "Microsoft.Kusto/Clusters/Databases/DataConnections",
+ "location": "westus",
+ "kind": "EventHub",
+ "properties": {
+ "eventHubResourceId": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.EventHub/namespaces/eventhubTestns1/eventhubs/eventhubTest1",
+ "consumerGroup": "testConsumerGroup1"
+ }
+ }
+ },
+ "201": {
+ "body": {
+ "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4/Databases/KustoDatabase8/DataConnections/DataConnections8",
+ "name": "KustoClusterRPTest4/KustoDatabase8/DataConnections8",
+ "type": "Microsoft.Kusto/Clusters/Databases/DataConnections",
+ "location": "westus",
+ "kind": "EventHub",
+ "properties": {
+ "eventHubResourceId": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.EventHub/namespaces/eventhubTestns1/eventhubs/eventhubTest1",
+ "consumerGroup": "testConsumerGroup1"
+ }
+ }
+ },
+ "202": {
+ "body": {
+ "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4/Databases/KustoDatabase8/DataConnections/DataConnections8",
+ "name": "KustoClusterRPTest4/KustoDatabase8/DataConnections8",
+ "type": "Microsoft.Kusto/Clusters/Databases/DataConnections",
+ "location": "westus",
+ "kind": "EventHub",
+ "properties": {
+ "eventHubResourceId": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.EventHub/namespaces/eventhubTestns1/eventhubs/eventhubTest1",
+ "consumerGroup": "testConsumerGroup1"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoDataConnectionsDelete.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoDataConnectionsDelete.json
new file mode 100644
index 000000000000..05a772ff4ed3
--- /dev/null
+++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoDataConnectionsDelete.json
@@ -0,0 +1,15 @@
+{
+ "parameters": {
+ "subscriptionId": "12345678-1234-1234-1234-123456789098",
+ "resourceGroupName": "kustorptest",
+ "clusterName": "kustoclusterrptest4",
+ "databaseName": "KustoDatabase8",
+ "api-version": "2020-09-18",
+ "dataConnectionName": "kustoeventhubconnection1"
+ },
+ "responses": {
+ "200": {},
+ "202": {},
+ "204": {}
+ }
+}
diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoDataConnectionsGet.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoDataConnectionsGet.json
new file mode 100644
index 000000000000..d9abaf9772b0
--- /dev/null
+++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoDataConnectionsGet.json
@@ -0,0 +1,25 @@
+{
+ "parameters": {
+ "subscriptionId": "12345678-1234-1234-1234-123456789098",
+ "resourceGroupName": "kustorptest",
+ "clusterName": "kustoclusterrptest4",
+ "databaseName": "KustoDatabase8",
+ "api-version": "2020-09-18",
+ "dataConnectionName": "DataConnections8"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4/Databases/KustoDatabase8/DataConnections/DataConnections8",
+ "name": "KustoClusterRPTest4/KustoDatabase8/DataConnections8",
+ "type": "Microsoft.Kusto/Clusters/Databases/DataConnections",
+ "location": "westus",
+ "kind": "EventHub",
+ "properties": {
+ "eventHubResourceId": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.EventHub/namespaces/eventhubTestns1/eventhubs/eventhubTest1",
+ "consumerGroup": "testConsumerGroup1"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoDataConnectionsListByDatabase.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoDataConnectionsListByDatabase.json
new file mode 100644
index 000000000000..4c7e09b7d2fb
--- /dev/null
+++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoDataConnectionsListByDatabase.json
@@ -0,0 +1,39 @@
+{
+ "parameters": {
+ "subscriptionId": "12345678-1234-1234-1234-123456789098",
+ "resourceGroupName": "kustorptest",
+ "clusterName": "kustoclusterrptest4",
+ "databaseName": "KustoDatabase8",
+ "api-version": "2020-09-18"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4/Databases/KustoDatabase8/DataConnections/KustoDataConnection8",
+ "name": "KustoClusterRPTest4/KustoDatabase8/KustoDataConnection8",
+ "type": "Microsoft.Kusto/Clusters/Databases/DataConnections",
+ "location": "westus",
+ "kind": "EventHub",
+ "properties": {
+ "eventHubResourceId": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.EventHub/namespaces/eventhubTestns1/eventhubs/eventhubTest1",
+ "consumerGroup": "testConsumerGroup1"
+ }
+ },
+ {
+ "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4/Databases/KustoDatabase9/DataConnections/KustoDataConnection9",
+ "name": "KustoClusterRPTest4/KustoDatabase9/KustoDataConnection9",
+ "type": "Microsoft.Kusto/Clusters/Databases/DataConnections",
+ "location": "westus",
+ "kind": "EventHub",
+ "properties": {
+ "eventHubResourceId": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.EventHub/namespaces/eventhubTestns2/eventhubs/eventhubTest2",
+ "consumerGroup": "testConsumerGroup2"
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoDataConnectionsUpdate.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoDataConnectionsUpdate.json
new file mode 100644
index 000000000000..1fb8d3788065
--- /dev/null
+++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoDataConnectionsUpdate.json
@@ -0,0 +1,59 @@
+{
+ "parameters": {
+ "subscriptionId": "12345678-1234-1234-1234-123456789098",
+ "resourceGroupName": "kustorptest",
+ "clusterName": "kustoclusterrptest4",
+ "databaseName": "KustoDatabase8",
+ "api-version": "2020-09-18",
+ "dataConnectionName": "DataConnections8",
+ "parameters": {
+ "location": "westus",
+ "kind": "EventHub",
+ "properties": {
+ "eventHubResourceId": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.EventHub/namespaces/eventhubTestns1/eventhubs/eventhubTest1",
+ "consumerGroup": "testConsumerGroup1"
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4/Databases/KustoDatabase8/DataConnections/DataConnections8",
+ "name": "KustoClusterRPTest4/KustoDatabase8/DataConnections8",
+ "type": "Microsoft.Kusto/Clusters/Databases/DataConnections",
+ "location": "westus",
+ "kind": "EventHub",
+ "properties": {
+ "eventHubResourceId": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.EventHub/namespaces/eventhubTestns1/eventhubs/eventhubTest1",
+ "consumerGroup": "testConsumerGroup1"
+ }
+ }
+ },
+ "201": {
+ "body": {
+ "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4/Databases/KustoDatabase8/DataConnections/DataConnections8",
+ "name": "KustoClusterRPTest4/KustoDatabase8/DataConnections8",
+ "type": "Microsoft.Kusto/Clusters/Databases/DataConnections",
+ "location": "westus",
+ "kind": "EventHub",
+ "properties": {
+ "eventHubResourceId": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.EventHub/namespaces/eventhubTestns1/eventhubs/eventhubTest1",
+ "consumerGroup": "testConsumerGroup1"
+ }
+ }
+ },
+ "202": {
+ "body": {
+ "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4/Databases/KustoDatabase8/DataConnections/DataConnections8",
+ "name": "KustoClusterRPTest4/KustoDatabase8/DataConnections8",
+ "type": "Microsoft.Kusto/Clusters/Databases/DataConnections",
+ "location": "westus",
+ "kind": "EventHub",
+ "properties": {
+ "eventHubResourceId": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.EventHub/namespaces/eventhubTestns1/eventhubs/eventhubTest1",
+ "consumerGroup": "testConsumerGroup1"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoDatabaseAddPrincipals.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoDatabaseAddPrincipals.json
new file mode 100644
index 000000000000..f4b6adfd87b2
--- /dev/null
+++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoDatabaseAddPrincipals.json
@@ -0,0 +1,69 @@
+{
+ "parameters": {
+ "subscriptionId": "12345678-1234-1234-1234-123456789098",
+ "resourceGroupName": "kustorptest",
+ "clusterName": "kustoclusterrptest4",
+ "databaseName": "KustoDatabase8",
+ "api-version": "2020-09-18",
+ "databasePrincipalsToAdd": {
+ "value": [
+ {
+ "name": "Some User",
+ "role": "Admin",
+ "type": "User",
+ "fqn": "aaduser=some_guid",
+ "email": "user@microsoft.com",
+ "appId": ""
+ },
+ {
+ "name": "Kusto",
+ "role": "Viewer",
+ "type": "Group",
+ "fqn": "aadgroup=some_guid",
+ "email": "kusto@microsoft.com",
+ "appId": ""
+ },
+ {
+ "name": "SomeApp",
+ "role": "Admin",
+ "type": "App",
+ "fqn": "aadapp=some_guid_app_id",
+ "email": "",
+ "appId": "some_guid_app_id"
+ }
+ ]
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "name": "Some User",
+ "role": "Admin",
+ "type": "User",
+ "fqn": "aaduser=some_guid",
+ "email": "user@microsoft.com",
+ "appId": ""
+ },
+ {
+ "name": "Kusto",
+ "role": "Viewer",
+ "type": "Group",
+ "fqn": "aadgroup=some_guid",
+ "email": "kusto@microsoft.com",
+ "appId": ""
+ },
+ {
+ "name": "SomeApp",
+ "role": "Admin",
+ "type": "App",
+ "fqn": "aadapp=some_guid_app_id",
+ "email": "",
+ "appId": "some_guid_app_id"
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoDatabaseListPrincipals.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoDatabaseListPrincipals.json
new file mode 100644
index 000000000000..ad1c9c42eb2b
--- /dev/null
+++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoDatabaseListPrincipals.json
@@ -0,0 +1,41 @@
+{
+ "parameters": {
+ "subscriptionId": "12345678-1234-1234-1234-123456789098",
+ "resourceGroupName": "kustorptest",
+ "clusterName": "kustoclusterrptest4",
+ "databaseName": "KustoDatabase8",
+ "api-version": "2020-09-18"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "name": "Some User",
+ "role": "Admin",
+ "type": "User",
+ "fqn": "aaduser=some_guid",
+ "email": "user@microsoft.com",
+ "appId": ""
+ },
+ {
+ "name": "Kusto",
+ "role": "Viewer",
+ "type": "Group",
+ "fqn": "aadgroup=some_guid",
+ "email": "kusto@microsoft.com",
+ "appId": ""
+ },
+ {
+ "name": "SomeApp",
+ "role": "Admin",
+ "type": "App",
+ "fqn": "aadapp=some_guid_app_id",
+ "email": "",
+ "appId": "some_guid_app_id"
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoDatabasePrincipalAssignmentsCheckNameAvailability.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoDatabasePrincipalAssignmentsCheckNameAvailability.json
new file mode 100644
index 000000000000..7321c6c47b03
--- /dev/null
+++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoDatabasePrincipalAssignmentsCheckNameAvailability.json
@@ -0,0 +1,22 @@
+{
+ "parameters": {
+ "subscriptionId": "12345678-1234-1234-1234-123456789098",
+ "resourceGroupName": "kustorptest",
+ "clusterName": "kustoclusterrptest4",
+ "databaseName": "Kustodatabase8",
+ "principalAssignmentName": {
+ "name": "kustoprincipal1",
+ "type": "Microsoft.Kusto/clusters/databases/principalAssignments"
+ },
+ "api-version": "2020-09-18"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "name": "kustoprincipal1",
+ "nameAvailable": false,
+ "message": "Name 'kustoprincipal1' is already taken. Please specify a different name"
+ }
+ }
+ }
+}
diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoDatabasePrincipalAssignmentsCreateOrUpdate.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoDatabasePrincipalAssignmentsCreateOrUpdate.json
new file mode 100644
index 000000000000..4cf19b4d4be5
--- /dev/null
+++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoDatabasePrincipalAssignmentsCreateOrUpdate.json
@@ -0,0 +1,52 @@
+{
+ "parameters": {
+ "subscriptionId": "12345678-1234-1234-1234-123456789098",
+ "resourceGroupName": "kustorptest",
+ "clusterName": "kustoclusterrptest4",
+ "databaseName": "Kustodatabase8",
+ "principalAssignmentName": "kustoprincipal1",
+ "api-version": "2020-09-18",
+ "parameters": {
+ "properties": {
+ "role": "Admin",
+ "principalId": "87654321-1234-1234-1234-123456789123",
+ "principalType": "App",
+ "tenantId": "12345678-1234-1234-1234-123456789123"
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/kustoclusterrptest4/Databases/Kustodatabase8/PrincipalAssignments/kustoprincipal1",
+ "name": "kustoclusterrptest4/Kustodatabase8/kustoprincipal1",
+ "type": "Microsoft.Kusto/Clusters/Databases/PrincipalAssignments",
+ "properties": {
+ "role": "Admin",
+ "principalId": "87654321-1234-1234-1234-123456789123",
+ "principalType": "App",
+ "tenantId": "12345678-1234-1234-1234-123456789123",
+ "tenantName": "tenantName",
+ "principalName": "TestApp",
+ "provisioningState": "Succeeded"
+ }
+ }
+ },
+ "201": {
+ "body": {
+ "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/kustoclusterrptest4/Databases/Kustodatabase8/PrincipalAssignments/kustoprincipal1",
+ "name": "kustoclusterrptest4/Kustodatabase8/kustoprincipal1",
+ "type": "Microsoft.Kusto/Clusters/Databases/PrincipalAssignments",
+ "properties": {
+ "role": "Admin",
+ "principalId": "87654321-1234-1234-1234-123456789123",
+ "principalType": "App",
+ "tenantId": "12345678-1234-1234-1234-123456789123",
+ "tenantName": "tenantName",
+ "principalName": "TestApp",
+ "provisioningState": "Succeeded"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoDatabasePrincipalAssignmentsDelete.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoDatabasePrincipalAssignmentsDelete.json
new file mode 100644
index 000000000000..5973f67ea030
--- /dev/null
+++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoDatabasePrincipalAssignmentsDelete.json
@@ -0,0 +1,15 @@
+{
+ "parameters": {
+ "subscriptionId": "12345678-1234-1234-1234-123456789098",
+ "resourceGroupName": "kustorptest",
+ "clusterName": "kustoclusterrptest4",
+ "databaseName": "Kustodatabase8",
+ "principalAssignmentName": "kustoprincipal1",
+ "api-version": "2020-09-18"
+ },
+ "responses": {
+ "200": {},
+ "202": {},
+ "204": {}
+ }
+}
diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoDatabasePrincipalAssignmentsGet.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoDatabasePrincipalAssignmentsGet.json
new file mode 100644
index 000000000000..77dfcf895e20
--- /dev/null
+++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoDatabasePrincipalAssignmentsGet.json
@@ -0,0 +1,28 @@
+{
+ "parameters": {
+ "subscriptionId": "12345678-1234-1234-1234-123456789098",
+ "resourceGroupName": "kustorptest",
+ "clusterName": "kustoclusterrptest4",
+ "databaseName": "Kustodatabase8",
+ "principalAssignmentName": "kustoprincipal1",
+ "api-version": "2020-09-18"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/kustoclusterrptest4/Databases/Kustodatabase8/PrincipalAssignments/kustoprincipal1",
+ "name": "kustoclusterrptest4/Kustodatabase8/kustoprincipal1",
+ "type": "Microsoft.Kusto/Clusters/Databases/PrincipalAssignments",
+ "properties": {
+ "role": "Admin",
+ "principalId": "87654321-1234-1234-1234-123456789123",
+ "principalType": "App",
+ "tenantId": "12345678-1234-1234-1234-123456789123",
+ "tenantName": "tenantName",
+ "principalName": "TestApp",
+ "provisioningState": "Succeeded"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoDatabasePrincipalAssignmentsList.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoDatabasePrincipalAssignmentsList.json
new file mode 100644
index 000000000000..080811fea6db
--- /dev/null
+++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoDatabasePrincipalAssignmentsList.json
@@ -0,0 +1,45 @@
+{
+ "parameters": {
+ "subscriptionId": "12345678-1234-1234-1234-123456789098",
+ "resourceGroupName": "kustorptest",
+ "clusterName": "kustoclusterrptest4",
+ "databaseName": "Kustodatabase8",
+ "api-version": "2020-09-18"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/kustoclusterrptest4/Databases/Kustodatabase8/PrincipalAssignments/kustoprincipal1",
+ "name": "kustoclusterrptest4/Kustodatabase8/kustoprincipal1",
+ "type": "Microsoft.Kusto/Clusters/Databases/PrincipalAssignments",
+ "properties": {
+ "role": "Admin",
+ "principalId": "87654321-1234-1234-1234-123456789123",
+ "principalType": "App",
+ "tenantId": "12345678-1234-1234-1234-123456789123",
+ "tenantName": "tenantName",
+ "principalName": "TestApp",
+ "provisioningState": "Succeeded"
+ }
+ },
+ {
+ "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/kustoclusterrptest4/Databases/Kustodatabase8/PrincipalAssignments/kustoprincipal1",
+ "name": "kustoclusterrptest4/Kustodatabase8/kustoprincipal2",
+ "type": "Microsoft.Kusto/Clusters/Databases/PrincipalAssignments",
+ "properties": {
+ "role": "Admin",
+ "principalId": "87654321-1234-1234-1234-123456789123",
+ "principalType": "App",
+ "tenantId": "12345678-1234-1234-1234-123456789123",
+ "tenantName": "tenantName",
+ "principalName": "TestApp",
+ "provisioningState": "Succeeded"
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoDatabaseRemovePrincipals.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoDatabaseRemovePrincipals.json
new file mode 100644
index 000000000000..c8a35a599846
--- /dev/null
+++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoDatabaseRemovePrincipals.json
@@ -0,0 +1,69 @@
+{
+ "parameters": {
+ "subscriptionId": "12345678-1234-1234-1234-123456789098",
+ "resourceGroupName": "kustorptest",
+ "clusterName": "kustoclusterrptest4",
+ "databaseName": "KustoDatabase8",
+ "api-version": "2020-09-18",
+ "databasePrincipalsToRemove": {
+ "value": [
+ {
+ "name": "Some User",
+ "role": "Admin",
+ "type": "User",
+ "fqn": "aaduser=some_guid",
+ "email": "user@microsoft.com",
+ "appId": ""
+ },
+ {
+ "name": "Kusto",
+ "role": "Viewer",
+ "type": "Group",
+ "fqn": "aadgroup=some_guid",
+ "email": "kusto@microsoft.com",
+ "appId": ""
+ },
+ {
+ "name": "SomeApp",
+ "role": "Admin",
+ "type": "App",
+ "fqn": "aadapp=some_guid_app_id",
+ "email": "",
+ "appId": "some_guid_app_id"
+ }
+ ]
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "name": "Some User",
+ "role": "Admin",
+ "type": "User",
+ "fqn": "aaduser=some_guid",
+ "email": "user@microsoft.com",
+ "appId": ""
+ },
+ {
+ "name": "Kusto",
+ "role": "Viewer",
+ "type": "Group",
+ "fqn": "aadgroup=some_guid",
+ "email": "kusto@microsoft.com",
+ "appId": ""
+ },
+ {
+ "name": "SomeApp",
+ "role": "Admin",
+ "type": "App",
+ "fqn": "aadapp=some_guid_app_id",
+ "email": "",
+ "appId": "some_guid_app_id"
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoDatabasesCheckNameAvailability.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoDatabasesCheckNameAvailability.json
new file mode 100644
index 000000000000..6184f1f78580
--- /dev/null
+++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoDatabasesCheckNameAvailability.json
@@ -0,0 +1,21 @@
+{
+ "parameters": {
+ "subscriptionId": "12345678-1234-1234-1234-123456789098",
+ "api-version": "2020-09-18",
+ "resourceGroupName": "kustorptest",
+ "clusterName": "kustoclusterrptest4",
+ "resourceName": {
+ "name": "kustoresourcename1",
+ "type": "Microsoft.Kusto/clusters/databases"
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "name": "kustoresourcename1",
+ "nameAvailable": false,
+ "message": "Name 'kuskus' is already taken. Please specify a different name"
+ }
+ }
+ }
+}
diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoDatabasesCreateOrUpdate.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoDatabasesCreateOrUpdate.json
new file mode 100644
index 000000000000..e161d5a0a085
--- /dev/null
+++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoDatabasesCreateOrUpdate.json
@@ -0,0 +1,56 @@
+{
+ "parameters": {
+ "subscriptionId": "12345678-1234-1234-1234-123456789098",
+ "resourceGroupName": "kustorptest",
+ "clusterName": "kustoclusterrptest4",
+ "databaseName": "KustoDatabase8",
+ "api-version": "2020-09-18",
+ "parameters": {
+ "location": "westus",
+ "properties": {
+ "softDeletePeriod": "P1D"
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4/Databases/KustoDatabase8",
+ "name": "KustoClusterRPTest4/KustoDatabase8",
+ "type": "Microsoft.Kusto/Clusters/Databases",
+ "kind": "ReadWrite",
+ "location": "westus",
+ "properties": {
+ "softDeletePeriod": "P1D",
+ "provisioningState": "Succeeded"
+ }
+ }
+ },
+ "201": {
+ "body": {
+ "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4/Databases/KustoDatabase8",
+ "name": "KustoClusterRPTest4/KustoDatabase8",
+ "type": "Microsoft.Kusto/Clusters/Databases",
+ "location": "westus",
+ "kind": "ReadWrite",
+ "properties": {
+ "softDeletePeriod": "P1D",
+ "provisioningState": "Succeeded"
+ }
+ }
+ },
+ "202": {
+ "body": {
+ "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4/Databases/KustoDatabase8",
+ "name": "KustoClusterRPTest4/KustoDatabase8",
+ "type": "Microsoft.Kusto/Clusters/Databases",
+ "location": "westus",
+ "kind": "ReadWrite",
+ "properties": {
+ "softDeletePeriod": "P1D",
+ "provisioningState": "Succeeded"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoDatabasesDelete.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoDatabasesDelete.json
new file mode 100644
index 000000000000..f00f7b7e7313
--- /dev/null
+++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoDatabasesDelete.json
@@ -0,0 +1,14 @@
+{
+ "parameters": {
+ "subscriptionId": "12345678-1234-1234-1234-123456789098",
+ "resourceGroupName": "kustorptest",
+ "clusterName": "kustoclusterrptest4",
+ "databaseName": "KustoDatabase8",
+ "api-version": "2020-09-18"
+ },
+ "responses": {
+ "200": {},
+ "202": {},
+ "204": {}
+ }
+}
diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoDatabasesGet.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoDatabasesGet.json
new file mode 100644
index 000000000000..87cd1481ba25
--- /dev/null
+++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoDatabasesGet.json
@@ -0,0 +1,24 @@
+{
+ "parameters": {
+ "subscriptionId": "12345678-1234-1234-1234-123456789098",
+ "resourceGroupName": "kustorptest",
+ "clusterName": "kustoclusterrptest4",
+ "databaseName": "KustoDatabase8",
+ "api-version": "2020-09-18"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4/Databases/KustoDatabase8",
+ "name": "KustoClusterRPTest4/KustoDatabase8",
+ "type": "Microsoft.Kusto/Clusters/Databases",
+ "kind": "ReadWrite",
+ "location": "westus",
+ "properties": {
+ "softDeletePeriod": "P1D",
+ "provisioningState": "Succeeded"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoDatabasesListByCluster.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoDatabasesListByCluster.json
new file mode 100644
index 000000000000..5c6b1fcf6456
--- /dev/null
+++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoDatabasesListByCluster.json
@@ -0,0 +1,36 @@
+{
+ "parameters": {
+ "subscriptionId": "12345678-1234-1234-1234-123456789098",
+ "resourceGroupName": "kustorptest",
+ "clusterName": "kustoclusterrptest4",
+ "api-version": "2020-09-18"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4/Databases/KustoDatabase8",
+ "name": "KustoClusterRPTest4/KustoDatabase8",
+ "type": "Microsoft.Kusto/Clusters/Databases",
+ "location": "westus",
+ "properties": {
+ "softDeletePeriod": "P1D",
+ "provisioningState": "Succeeded"
+ }
+ },
+ {
+ "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4/Databases/KustoDatabase9",
+ "name": "KustoClusterRPTest4/KustoDatabase9",
+ "type": "Microsoft.Kusto/Clusters/Databases",
+ "location": "westus",
+ "properties": {
+ "softDeletePeriod": "P1D",
+ "provisioningState": "Succeeded"
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoDatabasesUpdate.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoDatabasesUpdate.json
new file mode 100644
index 000000000000..d9994e7244f7
--- /dev/null
+++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoDatabasesUpdate.json
@@ -0,0 +1,55 @@
+{
+ "parameters": {
+ "subscriptionId": "12345678-1234-1234-1234-123456789098",
+ "resourceGroupName": "kustorptest",
+ "clusterName": "kustoclusterrptest4",
+ "databaseName": "KustoDatabase8",
+ "api-version": "2020-09-18",
+ "parameters": {
+ "properties": {
+ "softDeletePeriod": "P1D"
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4/Databases/KustoDatabase8",
+ "name": "KustoClusterRPTest4/KustoDatabase8",
+ "type": "Microsoft.Kusto/Clusters/Databases",
+ "kind": "ReadWrite",
+ "location": "westus",
+ "properties": {
+ "softDeletePeriod": "P1D",
+ "provisioningState": "Succeeded"
+ }
+ }
+ },
+ "201": {
+ "body": {
+ "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4/Databases/KustoDatabase8",
+ "name": "KustoClusterRPTest4/KustoDatabase8",
+ "type": "Microsoft.Kusto/Clusters/Databases",
+ "kind": "ReadWrite",
+ "location": "westus",
+ "properties": {
+ "softDeletePeriod": "P1D",
+ "provisioningState": "Succeeded"
+ }
+ }
+ },
+ "202": {
+ "body": {
+ "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4/Databases/KustoDatabase8",
+ "name": "KustoClusterRPTest4/KustoDatabase8",
+ "type": "Microsoft.Kusto/Clusters/Databases",
+ "location": "westus",
+ "kind": "ReadWrite",
+ "properties": {
+ "softDeletePeriod": "P1D",
+ "provisioningState": "Succeeded"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoOperationsList.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoOperationsList.json
new file mode 100644
index 000000000000..f5e8a42bd538
--- /dev/null
+++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoOperationsList.json
@@ -0,0 +1,22 @@
+{
+ "parameters": {
+ "api-version": "2020-09-18"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "name": "operationName",
+ "display": {
+ "provider": "providerName",
+ "resource": "resourceName",
+ "operation": "operationName",
+ "description": "operation description"
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/kusto.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/kusto.json
new file mode 100644
index 000000000000..7ed04f444d6a
--- /dev/null
+++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/kusto.json
@@ -0,0 +1,4351 @@
+{
+ "swagger": "2.0",
+ "info": {
+ "title": "KustoManagementClient",
+ "version": "2020-09-18"
+ },
+ "host": "management.azure.com",
+ "schemes": [
+ "https"
+ ],
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "paths": {
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}": {
+ "get": {
+ "tags": [
+ "Clusters"
+ ],
+ "operationId": "Clusters_Get",
+ "x-ms-examples": {
+ "KustoClustersGet": {
+ "$ref": "./examples/KustoClustersGet.json"
+ }
+ },
+ "description": "Gets a Kusto cluster.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ResourceGroupParameter"
+ },
+ {
+ "$ref": "#/parameters/ClusterNameParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The Kusto cluster.",
+ "schema": {
+ "$ref": "#/definitions/Cluster"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "Clusters"
+ ],
+ "operationId": "Clusters_CreateOrUpdate",
+ "x-ms-examples": {
+ "KustoClustersCreateOrUpdate": {
+ "$ref": "./examples/KustoClustersCreateOrUpdate.json"
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "description": "Create or update a Kusto cluster.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ResourceGroupParameter"
+ },
+ {
+ "$ref": "#/parameters/ClusterNameParameter"
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/Cluster"
+ },
+ "description": "The Kusto cluster parameters supplied to the CreateOrUpdate operation."
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successfully updated the Cluster.",
+ "schema": {
+ "$ref": "#/definitions/Cluster"
+ }
+ },
+ "201": {
+ "description": "Successfully created the cluster.",
+ "schema": {
+ "$ref": "#/definitions/Cluster"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ }
+ },
+ "patch": {
+ "tags": [
+ "Clusters"
+ ],
+ "operationId": "Clusters_Update",
+ "x-ms-examples": {
+ "KustoClustersUpdate": {
+ "$ref": "./examples/KustoClustersUpdate.json"
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "description": "Update a Kusto cluster.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ResourceGroupParameter"
+ },
+ {
+ "$ref": "#/parameters/ClusterNameParameter"
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/ClusterUpdate"
+ },
+ "description": "The Kusto cluster parameters supplied to the Update operation."
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successfully updated the Cluster.",
+ "schema": {
+ "$ref": "#/definitions/Cluster"
+ }
+ },
+ "201": {
+ "description": "Successfully updated the cluster.",
+ "schema": {
+ "$ref": "#/definitions/Cluster"
+ }
+ },
+ "202": {
+ "description": "Successfully updated the cluster.",
+ "schema": {
+ "$ref": "#/definitions/Cluster"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "Clusters"
+ ],
+ "operationId": "Clusters_Delete",
+ "x-ms-examples": {
+ "KustoClustersDelete": {
+ "$ref": "./examples/KustoClustersDelete.json"
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "description": "Deletes a Kusto cluster.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ResourceGroupParameter"
+ },
+ {
+ "$ref": "#/parameters/ClusterNameParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK -- cluster deleted successfully."
+ },
+ "202": {
+ "description": "Accepted the delete cluster request."
+ },
+ "204": {
+ "description": "NoContent -- cluster does not exist in the subscription."
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/stop": {
+ "post": {
+ "tags": [
+ "Clusters"
+ ],
+ "operationId": "Clusters_Stop",
+ "x-ms-examples": {
+ "KustoClustersStop": {
+ "$ref": "./examples/KustoClustersStop.json"
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "description": "Stops a Kusto cluster.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ResourceGroupParameter"
+ },
+ {
+ "$ref": "#/parameters/ClusterNameParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK."
+ },
+ "202": {
+ "description": "Accepted"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/start": {
+ "post": {
+ "tags": [
+ "Clusters"
+ ],
+ "operationId": "Clusters_Start",
+ "x-ms-examples": {
+ "KustoClustersStart": {
+ "$ref": "./examples/KustoClustersStart.json"
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "description": "Starts a Kusto cluster.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ResourceGroupParameter"
+ },
+ {
+ "$ref": "#/parameters/ClusterNameParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK."
+ },
+ "202": {
+ "description": "Accepted."
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/checkPrincipalAssignmentNameAvailability": {
+ "post": {
+ "tags": [
+ "ClusterPrincipalAssignments"
+ ],
+ "operationId": "ClusterPrincipalAssignments_CheckNameAvailability",
+ "x-ms-examples": {
+ "KustoClusterPrincipalAssignmentsCheckNameAvailability": {
+ "$ref": "./examples/KustoClusterPrincipalAssignmentsCheckNameAvailability.json"
+ }
+ },
+ "description": "Checks that the principal assignment name is valid and is not already in use.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ResourceGroupParameter"
+ },
+ {
+ "$ref": "#/parameters/ClusterNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "name": "principalAssignmentName",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/ClusterPrincipalAssignmentCheckNameRequest"
+ },
+ "description": "The name of the principal assignment."
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK -- Operation to check the kusto resource name availability was successful.",
+ "schema": {
+ "$ref": "#/definitions/CheckNameResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/principalAssignments/{principalAssignmentName}": {
+ "get": {
+ "tags": [
+ "ClusterPrincipalAssignments"
+ ],
+ "operationId": "ClusterPrincipalAssignments_Get",
+ "x-ms-examples": {
+ "KustoClusterPrincipalAssignmentsGet": {
+ "$ref": "./examples/KustoClusterPrincipalAssignmentsGet.json"
+ }
+ },
+ "description": "Gets a Kusto cluster principalAssignment.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/ResourceGroupParameter"
+ },
+ {
+ "$ref": "#/parameters/ClusterNameParameter"
+ },
+ {
+ "$ref": "#/parameters/PrincipalAssignmentNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The Kusto cluster principal assignment object.",
+ "schema": {
+ "$ref": "#/definitions/ClusterPrincipalAssignment"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "ClusterPrincipalAssignments"
+ ],
+ "operationId": "ClusterPrincipalAssignments_CreateOrUpdate",
+ "x-ms-examples": {
+ "KustoClusterPrincipalAssignmentsCreateOrUpdate": {
+ "$ref": "./examples/KustoClusterPrincipalAssignmentsCreateOrUpdate.json"
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "description": "Create a Kusto cluster principalAssignment.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/ResourceGroupParameter"
+ },
+ {
+ "$ref": "#/parameters/ClusterNameParameter"
+ },
+ {
+ "$ref": "#/parameters/PrincipalAssignmentNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/ClusterPrincipalAssignment"
+ },
+ "description": "The Kusto cluster principalAssignment's parameters supplied for the operation."
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successfully updated the PrincipalAssignment.",
+ "schema": {
+ "$ref": "#/definitions/ClusterPrincipalAssignment"
+ }
+ },
+ "201": {
+ "description": "Successfully created the principalAssignment.",
+ "schema": {
+ "$ref": "#/definitions/ClusterPrincipalAssignment"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "ClusterPrincipalAssignments"
+ ],
+ "operationId": "ClusterPrincipalAssignments_Delete",
+ "x-ms-examples": {
+ "KustoClusterPrincipalAssignmentsDelete": {
+ "$ref": "./examples/KustoClusterPrincipalAssignmentsDelete.json"
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "description": "Deletes a Kusto cluster principalAssignment.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/ResourceGroupParameter"
+ },
+ {
+ "$ref": "#/parameters/ClusterNameParameter"
+ },
+ {
+ "$ref": "#/parameters/PrincipalAssignmentNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK -- principalAssignments deleted successfully."
+ },
+ "202": {
+ "description": "Accepted the delete principalAssignments request."
+ },
+ "204": {
+ "description": "NoContent -- principalAssignments does not exist in the subscription."
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/principalAssignments": {
+ "get": {
+ "tags": [
+ "ClusterPrincipalAssignments"
+ ],
+ "operationId": "ClusterPrincipalAssignments_List",
+ "x-ms-examples": {
+ "KustoPrincipalAssignmentsList": {
+ "$ref": "./examples/KustoClusterPrincipalAssignmentsList.json"
+ }
+ },
+ "description": "Lists all Kusto cluster principalAssignments.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/ResourceGroupParameter"
+ },
+ {
+ "$ref": "#/parameters/ClusterNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK.",
+ "schema": {
+ "$ref": "#/definitions/ClusterPrincipalAssignmentListResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": null
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/listFollowerDatabases": {
+ "post": {
+ "tags": [
+ "Clusters"
+ ],
+ "description": "Returns a list of databases that are owned by this cluster and were followed by another cluster.",
+ "operationId": "Clusters_ListFollowerDatabases",
+ "x-ms-examples": {
+ "KustoClusterListFollowerDatabases": {
+ "$ref": "./examples/KustoClusterListFollowerDatabases.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/ResourceGroupParameter"
+ },
+ {
+ "$ref": "#/parameters/ClusterNameParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successfully retrieved the list of followed databases.",
+ "schema": {
+ "$ref": "#/definitions/FollowerDatabaseListResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": null
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/detachFollowerDatabases": {
+ "post": {
+ "tags": [
+ "Clusters"
+ ],
+ "description": "Detaches all followers of a database owned by this cluster.",
+ "operationId": "Clusters_DetachFollowerDatabases",
+ "x-ms-examples": {
+ "KustoClusterDetachFollowerDatabases": {
+ "$ref": "./examples/KustoClusterDetachFollowerDatabases.json"
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "parameters": [
+ {
+ "$ref": "#/parameters/ResourceGroupParameter"
+ },
+ {
+ "$ref": "#/parameters/ClusterNameParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "name": "followerDatabaseToRemove",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/FollowerDatabaseDefinition"
+ },
+ "description": "The follower databases properties to remove."
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK."
+ },
+ "202": {
+ "description": "Accepted"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/diagnoseVirtualNetwork": {
+ "post": {
+ "tags": [
+ "Clusters"
+ ],
+ "description": "Diagnoses network connectivity status for external resources on which the service is dependent on.",
+ "operationId": "Clusters_DiagnoseVirtualNetwork",
+ "x-ms-examples": {
+ "KustoClusterDiagnoseVirtualNetwork": {
+ "$ref": "./examples/KustoClustersDiagnoseVirtualNetwork.json"
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-long-running-operation-options": {
+ "final-state-via": "location"
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/ResourceGroupParameter"
+ },
+ {
+ "$ref": "#/parameters/ClusterNameParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK.",
+ "schema": {
+ "$ref": "#/definitions/DiagnoseVirtualNetworkResult"
+ }
+ },
+ "202": {
+ "description": "Accepted"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters": {
+ "get": {
+ "tags": [
+ "Clusters"
+ ],
+ "operationId": "Clusters_ListByResourceGroup",
+ "x-ms-examples": {
+ "KustoClustersListByResourceGroup": {
+ "$ref": "./examples/KustoClustersListByResourceGroup.json"
+ }
+ },
+ "description": "Lists all Kusto clusters within a resource group.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ResourceGroupParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK.",
+ "schema": {
+ "$ref": "#/definitions/ClusterListResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": null
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/providers/Microsoft.Kusto/clusters": {
+ "get": {
+ "tags": [
+ "Clusters"
+ ],
+ "operationId": "Clusters_List",
+ "x-ms-examples": {
+ "KustoClustersList": {
+ "$ref": "./examples/KustoClustersList.json"
+ }
+ },
+ "description": "Lists all Kusto clusters within a subscription.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK.",
+ "schema": {
+ "$ref": "#/definitions/ClusterListResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": null
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/providers/Microsoft.Kusto/skus": {
+ "get": {
+ "description": "Lists eligible SKUs for Kusto resource provider.",
+ "x-ms-examples": {
+ "KustoClustersListSkus": {
+ "$ref": "./examples/KustoClustersListSkus.json"
+ }
+ },
+ "operationId": "Clusters_ListSkus",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK.",
+ "schema": {
+ "$ref": "#/definitions/SkuDescriptionList"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": null
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/providers/Microsoft.Kusto/locations/{location}/checkNameAvailability": {
+ "post": {
+ "tags": [
+ "Clusters"
+ ],
+ "operationId": "Clusters_CheckNameAvailability",
+ "x-ms-examples": {
+ "KustoClustersCheckNameAvailability": {
+ "$ref": "./examples/KustoClustersCheckNameAvailability.json"
+ }
+ },
+ "description": "Checks that the cluster name is valid and is not already in use.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "name": "location",
+ "in": "path",
+ "description": "Azure location.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "clusterName",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/ClusterCheckNameRequest"
+ },
+ "description": "The name of the cluster."
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK -- Operation to check the kusto resource name availability was successful.",
+ "schema": {
+ "$ref": "#/definitions/CheckNameResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/checkNameAvailability": {
+ "post": {
+ "tags": [
+ "Databases"
+ ],
+ "operationId": "Databases_CheckNameAvailability",
+ "x-ms-examples": {
+ "KustoDatabaseCheckNameAvailability": {
+ "$ref": "./examples/KustoDatabasesCheckNameAvailability.json"
+ }
+ },
+ "description": "Checks that the database name is valid and is not already in use.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ResourceGroupParameter"
+ },
+ {
+ "$ref": "#/parameters/ClusterNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "name": "resourceName",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/CheckNameRequest"
+ },
+ "description": "The name of the resource."
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK -- Operation to check the kusto resource name availability was successful.",
+ "schema": {
+ "$ref": "#/definitions/CheckNameResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/skus": {
+ "get": {
+ "tags": [
+ "Clusters"
+ ],
+ "operationId": "Clusters_ListSkusByResource",
+ "x-ms-examples": {
+ "KustoClustersListResourceSkus": {
+ "$ref": "./examples/KustoClustersListResourceSkus.json"
+ }
+ },
+ "description": "Returns the SKUs available for the provided resource.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ResourceGroupParameter"
+ },
+ {
+ "$ref": "#/parameters/ClusterNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK.",
+ "schema": {
+ "$ref": "#/definitions/ListResourceSkusResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": null
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/databases": {
+ "get": {
+ "tags": [
+ "Databases"
+ ],
+ "description": "Returns the list of databases of the given Kusto cluster.",
+ "operationId": "Databases_ListByCluster",
+ "x-ms-examples": {
+ "KustoDatabasesListByCluster": {
+ "$ref": "./examples/KustoDatabasesListByCluster.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/ResourceGroupParameter"
+ },
+ {
+ "$ref": "#/parameters/ClusterNameParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successfully retrieved the list of databases.",
+ "schema": {
+ "$ref": "#/definitions/DatabaseListResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": null
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/databases/{databaseName}": {
+ "get": {
+ "tags": [
+ "Databases"
+ ],
+ "description": "Returns a database.",
+ "operationId": "Databases_Get",
+ "x-ms-examples": {
+ "KustoDatabasesGet": {
+ "$ref": "./examples/KustoDatabasesGet.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/ResourceGroupParameter"
+ },
+ {
+ "$ref": "#/parameters/ClusterNameParameter"
+ },
+ {
+ "$ref": "#/parameters/DatabaseNameParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successfully retrieved the specified database.",
+ "schema": {
+ "$ref": "#/definitions/Database"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "Databases"
+ ],
+ "description": "Creates or updates a database.",
+ "operationId": "Databases_CreateOrUpdate",
+ "x-ms-examples": {
+ "KustoDatabasesCreateOrUpdate": {
+ "$ref": "./examples/KustoDatabasesCreateOrUpdate.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/ResourceGroupParameter"
+ },
+ {
+ "$ref": "#/parameters/ClusterNameParameter"
+ },
+ {
+ "$ref": "#/parameters/DatabaseNameParameter"
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/Database"
+ },
+ "description": "The database parameters supplied to the CreateOrUpdate operation."
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successfully updated the database.",
+ "schema": {
+ "$ref": "#/definitions/Database"
+ }
+ },
+ "201": {
+ "description": "Successfully created the database.",
+ "schema": {
+ "$ref": "#/definitions/Database"
+ }
+ },
+ "202": {
+ "description": "Accepted the create database request.",
+ "schema": {
+ "$ref": "#/definitions/Database"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true
+ },
+ "patch": {
+ "tags": [
+ "Databases"
+ ],
+ "description": "Updates a database.",
+ "operationId": "Databases_Update",
+ "x-ms-examples": {
+ "KustoDatabasesUpdate": {
+ "$ref": "./examples/KustoDatabasesUpdate.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/ResourceGroupParameter"
+ },
+ {
+ "$ref": "#/parameters/ClusterNameParameter"
+ },
+ {
+ "$ref": "#/parameters/DatabaseNameParameter"
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/Database"
+ },
+ "description": "The database parameters supplied to the Update operation."
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successfully updated the database.",
+ "schema": {
+ "$ref": "#/definitions/Database"
+ }
+ },
+ "201": {
+ "description": "Successfully updated the database.",
+ "schema": {
+ "$ref": "#/definitions/Database"
+ }
+ },
+ "202": {
+ "description": "Accepted the update database request.",
+ "schema": {
+ "$ref": "#/definitions/Database"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true
+ },
+ "delete": {
+ "tags": [
+ "Databases"
+ ],
+ "description": "Deletes the database with the given name.",
+ "operationId": "Databases_Delete",
+ "x-ms-examples": {
+ "KustoDatabasesDelete": {
+ "$ref": "./examples/KustoDatabasesDelete.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/ResourceGroupParameter"
+ },
+ {
+ "$ref": "#/parameters/ClusterNameParameter"
+ },
+ {
+ "$ref": "#/parameters/DatabaseNameParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successfully deleted the database."
+ },
+ "202": {
+ "description": "Accepted."
+ },
+ "204": {
+ "description": "The specified database does not exist."
+ },
+ "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.Kusto/clusters/{clusterName}/databases/{databaseName}/checkPrincipalAssignmentNameAvailability": {
+ "post": {
+ "tags": [
+ "DatabasePrincipalAssignments"
+ ],
+ "operationId": "DatabasePrincipalAssignments_CheckNameAvailability",
+ "x-ms-examples": {
+ "KustoDatabaseCheckNameAvailability": {
+ "$ref": "./examples/KustoDatabasePrincipalAssignmentsCheckNameAvailability.json"
+ }
+ },
+ "description": "Checks that the database principal assignment is valid and is not already in use.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ResourceGroupParameter"
+ },
+ {
+ "$ref": "#/parameters/ClusterNameParameter"
+ },
+ {
+ "$ref": "#/parameters/DatabaseNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "name": "principalAssignmentName",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/DatabasePrincipalAssignmentCheckNameRequest"
+ },
+ "description": "The name of the resource."
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK -- Operation to check the kusto resource name availability was successful.",
+ "schema": {
+ "$ref": "#/definitions/CheckNameResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/databases/{databaseName}/principalAssignments/{principalAssignmentName}": {
+ "get": {
+ "tags": [
+ "DatabasePrincipalAssignments"
+ ],
+ "operationId": "DatabasePrincipalAssignments_Get",
+ "x-ms-examples": {
+ "KustoDatabasePrincipalAssignmentsGet": {
+ "$ref": "./examples/KustoDatabasePrincipalAssignmentsGet.json"
+ }
+ },
+ "description": "Gets a Kusto cluster database principalAssignment.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/ResourceGroupParameter"
+ },
+ {
+ "$ref": "#/parameters/ClusterNameParameter"
+ },
+ {
+ "$ref": "#/parameters/DatabaseNameParameter"
+ },
+ {
+ "$ref": "#/parameters/PrincipalAssignmentNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The Kusto cluster database principal assignment object.",
+ "schema": {
+ "$ref": "#/definitions/DatabasePrincipalAssignment"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "DatabasePrincipalAssignments"
+ ],
+ "operationId": "DatabasePrincipalAssignments_CreateOrUpdate",
+ "x-ms-examples": {
+ "KustoDatabasePrincipalAssignmentsCreateOrUpdate": {
+ "$ref": "./examples/KustoDatabasePrincipalAssignmentsCreateOrUpdate.json"
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "description": "Creates a Kusto cluster database principalAssignment.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/ResourceGroupParameter"
+ },
+ {
+ "$ref": "#/parameters/ClusterNameParameter"
+ },
+ {
+ "$ref": "#/parameters/DatabaseNameParameter"
+ },
+ {
+ "$ref": "#/parameters/PrincipalAssignmentNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/DatabasePrincipalAssignment"
+ },
+ "description": "The Kusto principalAssignments parameters supplied for the operation."
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successfully updated the PrincipalAssignments.",
+ "schema": {
+ "$ref": "#/definitions/DatabasePrincipalAssignment"
+ }
+ },
+ "201": {
+ "description": "Successfully created the principalAssignments.",
+ "schema": {
+ "$ref": "#/definitions/DatabasePrincipalAssignment"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "DatabasePrincipalAssignments"
+ ],
+ "operationId": "DatabasePrincipalAssignments_Delete",
+ "x-ms-examples": {
+ "KustoDatabasePrincipalAssignmentsDelete": {
+ "$ref": "./examples/KustoDatabasePrincipalAssignmentsDelete.json"
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "description": "Deletes a Kusto principalAssignment.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/ResourceGroupParameter"
+ },
+ {
+ "$ref": "#/parameters/ClusterNameParameter"
+ },
+ {
+ "$ref": "#/parameters/DatabaseNameParameter"
+ },
+ {
+ "$ref": "#/parameters/PrincipalAssignmentNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK -- principalAssignments deleted successfully."
+ },
+ "202": {
+ "description": "Accepted the delete principalAssignments request."
+ },
+ "204": {
+ "description": "NoContent -- principalAssignments does not exist in the subscription."
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/databases/{databaseName}/principalAssignments": {
+ "get": {
+ "tags": [
+ "DatabasePrincipalAssignments"
+ ],
+ "operationId": "DatabasePrincipalAssignments_List",
+ "x-ms-examples": {
+ "KustoPrincipalAssignmentsList": {
+ "$ref": "./examples/KustoDatabasePrincipalAssignmentsList.json"
+ }
+ },
+ "description": "Lists all Kusto cluster database principalAssignments.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/ResourceGroupParameter"
+ },
+ {
+ "$ref": "#/parameters/ClusterNameParameter"
+ },
+ {
+ "$ref": "#/parameters/DatabaseNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK.",
+ "schema": {
+ "$ref": "#/definitions/DatabasePrincipalAssignmentListResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": null
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/databases/{databaseName}/listPrincipals": {
+ "post": {
+ "tags": [
+ "Databases"
+ ],
+ "description": "Returns a list of database principals of the given Kusto cluster and database.",
+ "operationId": "Databases_ListPrincipals",
+ "x-ms-examples": {
+ "KustoDatabaseListPrincipals": {
+ "$ref": "./examples/KustoDatabaseListPrincipals.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/ResourceGroupParameter"
+ },
+ {
+ "$ref": "#/parameters/ClusterNameParameter"
+ },
+ {
+ "$ref": "#/parameters/DatabaseNameParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successfully retrieved the list of database principals.",
+ "schema": {
+ "$ref": "#/definitions/DatabasePrincipalListResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": null
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/databases/{databaseName}/addPrincipals": {
+ "post": {
+ "tags": [
+ "Databases"
+ ],
+ "operationId": "Databases_AddPrincipals",
+ "x-ms-examples": {
+ "KustoDatabaseAddPrincipals": {
+ "$ref": "./examples/KustoDatabaseAddPrincipals.json"
+ }
+ },
+ "description": "Add Database principals permissions.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ResourceGroupParameter"
+ },
+ {
+ "$ref": "#/parameters/ClusterNameParameter"
+ },
+ {
+ "$ref": "#/parameters/DatabaseNameParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "name": "databasePrincipalsToAdd",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/DatabasePrincipalListRequest"
+ },
+ "description": "List of database principals to add."
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK -- Successfully added the list of database principals. Returns the updated list of principals.",
+ "schema": {
+ "$ref": "#/definitions/DatabasePrincipalListResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/attachedDatabaseConfigurations": {
+ "get": {
+ "tags": [
+ "AttachedDatabaseConfigurations"
+ ],
+ "description": "Returns the list of attached database configurations of the given Kusto cluster.",
+ "operationId": "AttachedDatabaseConfigurations_ListByCluster",
+ "x-ms-examples": {
+ "KustoAttachedDatabaseConfigurationsListByCluster": {
+ "$ref": "./examples/KustoAttachedDatabaseConfigurationsListByCluster.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/ResourceGroupParameter"
+ },
+ {
+ "$ref": "#/parameters/ClusterNameParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successfully retrieved the list of attached database configurations.",
+ "schema": {
+ "$ref": "#/definitions/AttachedDatabaseConfigurationListResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": null
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/attachedDatabaseConfigurations/{attachedDatabaseConfigurationName}": {
+ "get": {
+ "tags": [
+ "AttachedDatabaseConfigurations"
+ ],
+ "description": "Returns an attached database configuration.",
+ "operationId": "AttachedDatabaseConfigurations_Get",
+ "x-ms-examples": {
+ "AttachedDatabaseConfigurationsGet": {
+ "$ref": "./examples/KustoAttachedDatabaseConfigurationsGet.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/ResourceGroupParameter"
+ },
+ {
+ "$ref": "#/parameters/ClusterNameParameter"
+ },
+ {
+ "$ref": "#/parameters/AttachedDatabaseConfigurationNameParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successfully retrieved the specified attached database configuration.",
+ "schema": {
+ "$ref": "#/definitions/AttachedDatabaseConfiguration"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "AttachedDatabaseConfigurations"
+ ],
+ "description": "Creates or updates an attached database configuration.",
+ "operationId": "AttachedDatabaseConfigurations_CreateOrUpdate",
+ "x-ms-examples": {
+ "AttachedDatabaseConfigurationsCreateOrUpdate": {
+ "$ref": "./examples/KustoAttachedDatabaseConfigurationsCreateOrUpdate.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/ResourceGroupParameter"
+ },
+ {
+ "$ref": "#/parameters/ClusterNameParameter"
+ },
+ {
+ "$ref": "#/parameters/AttachedDatabaseConfigurationNameParameter"
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/AttachedDatabaseConfiguration"
+ },
+ "description": "The database parameters supplied to the CreateOrUpdate operation."
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successfully updated the database.",
+ "schema": {
+ "$ref": "#/definitions/AttachedDatabaseConfiguration"
+ }
+ },
+ "201": {
+ "description": "Successfully created the database.",
+ "schema": {
+ "$ref": "#/definitions/AttachedDatabaseConfiguration"
+ }
+ },
+ "202": {
+ "description": "Accepted the create database request.",
+ "schema": {
+ "$ref": "#/definitions/AttachedDatabaseConfiguration"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true
+ },
+ "delete": {
+ "tags": [
+ "AttachedDatabaseConfigurations"
+ ],
+ "description": "Deletes the attached database configuration with the given name.",
+ "operationId": "AttachedDatabaseConfigurations_Delete",
+ "x-ms-examples": {
+ "AttachedDatabaseConfigurationsDelete": {
+ "$ref": "./examples/KustoAttachedDatabaseConfigurationsDelete.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/ResourceGroupParameter"
+ },
+ {
+ "$ref": "#/parameters/ClusterNameParameter"
+ },
+ {
+ "$ref": "#/parameters/AttachedDatabaseConfigurationNameParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successfully deleted the database."
+ },
+ "202": {
+ "description": "Accepted."
+ },
+ "204": {
+ "description": "The specified database does not exist."
+ },
+ "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.Kusto/clusters/{clusterName}/databases/{databaseName}/removePrincipals": {
+ "post": {
+ "tags": [
+ "Databases"
+ ],
+ "operationId": "Databases_RemovePrincipals",
+ "x-ms-examples": {
+ "KustoDatabaseRemovePrincipals": {
+ "$ref": "./examples/KustoDatabaseRemovePrincipals.json"
+ }
+ },
+ "description": "Remove Database principals permissions.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ResourceGroupParameter"
+ },
+ {
+ "$ref": "#/parameters/ClusterNameParameter"
+ },
+ {
+ "$ref": "#/parameters/DatabaseNameParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "name": "databasePrincipalsToRemove",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/DatabasePrincipalListRequest"
+ },
+ "description": "List of database principals to remove."
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK -- Successfully removed the list of database principals. Returns the updated list of principals.",
+ "schema": {
+ "$ref": "#/definitions/DatabasePrincipalListResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/databases/{databaseName}/dataConnections": {
+ "get": {
+ "tags": [
+ "DataConnections"
+ ],
+ "description": "Returns the list of data connections of the given Kusto database.",
+ "operationId": "DataConnections_ListByDatabase",
+ "x-ms-examples": {
+ "KustoDatabasesListByCluster": {
+ "$ref": "./examples/KustoDataConnectionsListByDatabase.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/ResourceGroupParameter"
+ },
+ {
+ "$ref": "#/parameters/ClusterNameParameter"
+ },
+ {
+ "$ref": "#/parameters/DatabaseNameParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successfully retrieved the list of data connections.",
+ "schema": {
+ "$ref": "#/definitions/DataConnectionListResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": null
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/databases/{databaseName}/dataConnectionValidation": {
+ "post": {
+ "tags": [
+ "DataConnections"
+ ],
+ "operationId": "DataConnections_dataConnectionValidation",
+ "x-ms-examples": {
+ "KustoDataConnectionValidation": {
+ "$ref": "./examples/KustoDataConnectionValidationAsync.json"
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-long-running-operation-options": {
+ "final-state-via": "location"
+ },
+ "description": "Checks that the data connection parameters are valid.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ResourceGroupParameter"
+ },
+ {
+ "$ref": "#/parameters/ClusterNameParameter"
+ },
+ {
+ "$ref": "#/parameters/DatabaseNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/DataConnectionValidation"
+ },
+ "description": "The data connection parameters supplied to the CreateOrUpdate operation."
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK -- Operation to check the kusto resource name availability was successful.",
+ "schema": {
+ "$ref": "#/definitions/DataConnectionValidationListResult"
+ }
+ },
+ "202": {
+ "description": "Accepted"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/databases/{databaseName}/checkNameAvailability": {
+ "post": {
+ "tags": [
+ "DataConnections"
+ ],
+ "operationId": "DataConnections_CheckNameAvailability",
+ "x-ms-examples": {
+ "KustoDataConnectionsCheckNameAvailability": {
+ "$ref": "./examples/KustoDataConnectionsCheckNameAvailability.json"
+ }
+ },
+ "description": "Checks that the data connection name is valid and is not already in use.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ResourceGroupParameter"
+ },
+ {
+ "$ref": "#/parameters/ClusterNameParameter"
+ },
+ {
+ "$ref": "#/parameters/DatabaseNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "name": "dataConnectionName",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/DataConnectionCheckNameRequest"
+ },
+ "description": "The name of the data connection."
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK -- Operation to check the Kusto resource name availability was successful.",
+ "schema": {
+ "$ref": "#/definitions/CheckNameResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/databases/{databaseName}/dataConnections/{dataConnectionName}": {
+ "get": {
+ "tags": [
+ "DataConnections"
+ ],
+ "description": "Returns a data connection.",
+ "operationId": "DataConnections_Get",
+ "x-ms-examples": {
+ "KustoDataConnectionsGet": {
+ "$ref": "./examples/KustoDataConnectionsGet.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/ResourceGroupParameter"
+ },
+ {
+ "$ref": "#/parameters/ClusterNameParameter"
+ },
+ {
+ "$ref": "#/parameters/DatabaseNameParameter"
+ },
+ {
+ "$ref": "#/parameters/DataConnectionNameParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successfully retrieved the specified data connection.",
+ "schema": {
+ "$ref": "#/definitions/DataConnection"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "DataConnections"
+ ],
+ "description": "Creates or updates a data connection.",
+ "operationId": "DataConnections_CreateOrUpdate",
+ "x-ms-examples": {
+ "KustoDataConnectionsCreateOrUpdate": {
+ "$ref": "./examples/KustoDataConnectionsCreateOrUpdate.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/ResourceGroupParameter"
+ },
+ {
+ "$ref": "#/parameters/ClusterNameParameter"
+ },
+ {
+ "$ref": "#/parameters/DatabaseNameParameter"
+ },
+ {
+ "$ref": "#/parameters/DataConnectionNameParameter"
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/DataConnection"
+ },
+ "description": "The data connection parameters supplied to the CreateOrUpdate operation."
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successfully updated the data connection.",
+ "schema": {
+ "$ref": "#/definitions/DataConnection"
+ }
+ },
+ "201": {
+ "description": "Successfully created the data connection.",
+ "schema": {
+ "$ref": "#/definitions/DataConnection"
+ }
+ },
+ "202": {
+ "description": "Accepted the create data connection request.",
+ "schema": {
+ "$ref": "#/definitions/DataConnection"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true
+ },
+ "patch": {
+ "tags": [
+ "DataConnections"
+ ],
+ "description": "Updates a data connection.",
+ "operationId": "DataConnections_Update",
+ "x-ms-examples": {
+ "KustoDataConnectionsUpdate": {
+ "$ref": "./examples/KustoDataConnectionsUpdate.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/ResourceGroupParameter"
+ },
+ {
+ "$ref": "#/parameters/ClusterNameParameter"
+ },
+ {
+ "$ref": "#/parameters/DatabaseNameParameter"
+ },
+ {
+ "$ref": "#/parameters/DataConnectionNameParameter"
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/DataConnection"
+ },
+ "description": "The data connection parameters supplied to the Update operation."
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successfully updated the data connection.",
+ "schema": {
+ "$ref": "#/definitions/DataConnection"
+ }
+ },
+ "201": {
+ "description": "Successfully updated the data connection.",
+ "schema": {
+ "$ref": "#/definitions/DataConnection"
+ }
+ },
+ "202": {
+ "description": "Accepted the update data connection request.",
+ "schema": {
+ "$ref": "#/definitions/DataConnection"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true
+ },
+ "delete": {
+ "tags": [
+ "DataConnections"
+ ],
+ "description": "Deletes the data connection with the given name.",
+ "operationId": "DataConnections_Delete",
+ "x-ms-examples": {
+ "KustoDataConnectionsDelete": {
+ "$ref": "./examples/KustoDataConnectionsDelete.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/ResourceGroupParameter"
+ },
+ {
+ "$ref": "#/parameters/ClusterNameParameter"
+ },
+ {
+ "$ref": "#/parameters/DatabaseNameParameter"
+ },
+ {
+ "$ref": "#/parameters/DataConnectionNameParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successfully deleted the data connection."
+ },
+ "202": {
+ "description": "Accepted."
+ },
+ "204": {
+ "description": "The specified data connection does not exist."
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true
+ }
+ },
+ "/providers/Microsoft.Kusto/operations": {
+ "get": {
+ "tags": [
+ "Operations"
+ ],
+ "operationId": "Operations_List",
+ "x-ms-examples": {
+ "KustoOperationsList": {
+ "$ref": "./examples/KustoOperationsList.json"
+ }
+ },
+ "description": "Lists available operations for the Microsoft.Kusto 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}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/listLanguageExtensions": {
+ "post": {
+ "tags": [
+ "Clusters"
+ ],
+ "description": "Returns a list of language extensions that can run within KQL queries.",
+ "operationId": "Clusters_ListLanguageExtensions",
+ "x-ms-examples": {
+ "KustoClusterListLanguageExtensions": {
+ "$ref": "./examples/KustoClusterListLanguageExtensions.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/ResourceGroupParameter"
+ },
+ {
+ "$ref": "#/parameters/ClusterNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successfully retrieved the list of language extensions.",
+ "schema": {
+ "$ref": "#/definitions/LanguageExtensionsList"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": null
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/addLanguageExtensions": {
+ "post": {
+ "tags": [
+ "Clusters"
+ ],
+ "description": "Add a list of language extensions that can run within KQL queries.",
+ "operationId": "Clusters_AddLanguageExtensions",
+ "x-ms-examples": {
+ "KustoClusterAddLanguageExtensions": {
+ "$ref": "./examples/KustoClusterAddLanguageExtensions.json"
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "parameters": [
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/ResourceGroupParameter"
+ },
+ {
+ "$ref": "#/parameters/ClusterNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "name": "languageExtensionsToAdd",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/LanguageExtensionsList"
+ },
+ "description": "The language extensions to add."
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK."
+ },
+ "202": {
+ "description": "Accepted"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/removeLanguageExtensions": {
+ "post": {
+ "tags": [
+ "Clusters"
+ ],
+ "description": "Remove a list of language extensions that can run within KQL queries.",
+ "operationId": "Clusters_RemoveLanguageExtensions",
+ "x-ms-examples": {
+ "KustoClusterRemoveLanguageExtensions": {
+ "$ref": "./examples/KustoClusterRemoveLanguageExtensions.json"
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "parameters": [
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/ResourceGroupParameter"
+ },
+ {
+ "$ref": "#/parameters/ClusterNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "name": "languageExtensionsToRemove",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/LanguageExtensionsList"
+ },
+ "description": "The language extensions to remove."
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK."
+ },
+ "202": {
+ "description": "Accepted"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ }
+ }
+ }
+ },
+ "definitions": {
+ "ClusterProperties": {
+ "properties": {
+ "state": {
+ "type": "string",
+ "readOnly": true,
+ "description": "The state of the resource.",
+ "enum": [
+ "Creating",
+ "Unavailable",
+ "Running",
+ "Deleting",
+ "Deleted",
+ "Stopping",
+ "Stopped",
+ "Starting",
+ "Updating"
+ ],
+ "x-ms-enum": {
+ "name": "State",
+ "modelAsString": true
+ }
+ },
+ "provisioningState": {
+ "type": "string",
+ "readOnly": true,
+ "description": "The provisioned state of the resource.",
+ "enum": [
+ "Running",
+ "Creating",
+ "Deleting",
+ "Succeeded",
+ "Failed",
+ "Moving"
+ ],
+ "x-ms-enum": {
+ "name": "ProvisioningState",
+ "modelAsString": true
+ }
+ },
+ "uri": {
+ "type": "string",
+ "readOnly": true,
+ "description": "The cluster URI."
+ },
+ "dataIngestionUri": {
+ "type": "string",
+ "readOnly": true,
+ "description": "The cluster data ingestion URI."
+ },
+ "stateReason": {
+ "type": "string",
+ "readOnly": true,
+ "description": "The reason for the cluster's current state."
+ },
+ "trustedExternalTenants": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/TrustedExternalTenant"
+ },
+ "description": "The cluster's external tenants."
+ },
+ "optimizedAutoscale": {
+ "type": "object",
+ "$ref": "#/definitions/OptimizedAutoscale",
+ "description": "Optimized auto scale definition."
+ },
+ "enableDiskEncryption": {
+ "description": "A boolean value that indicates if the cluster's disks are encrypted.",
+ "type": "boolean"
+ },
+ "enableStreamingIngest": {
+ "description": "A boolean value that indicates if the streaming ingest is enabled.",
+ "default": false,
+ "type": "boolean"
+ },
+ "virtualNetworkConfiguration": {
+ "type": "object",
+ "$ref": "#/definitions/VirtualNetworkConfiguration",
+ "description": "Virtual network definition."
+ },
+ "keyVaultProperties": {
+ "type": "object",
+ "$ref": "#/definitions/KeyVaultProperties",
+ "description": "KeyVault properties for the cluster encryption."
+ },
+ "enablePurge": {
+ "description": "A boolean value that indicates if the purge operations are enabled.",
+ "default": false,
+ "type": "boolean"
+ },
+ "languageExtensions": {
+ "type": "object",
+ "$ref": "#/definitions/LanguageExtensionsList",
+ "readOnly": true,
+ "description": "List of the cluster's language extensions."
+ },
+ "enableDoubleEncryption": {
+ "description": "A boolean value that indicates if double encryption is enabled.",
+ "default": false,
+ "type": "boolean"
+ },
+ "engineType": {
+ "type": "string",
+ "description": "The engine type",
+ "enum": [
+ "V2",
+ "V3"
+ ],
+ "x-ms-enum": {
+ "name": "EngineType",
+ "modelAsString": true
+ }
+ }
+ },
+ "description": "Class representing the Kusto cluster properties."
+ },
+ "TrustedExternalTenant": {
+ "properties": {
+ "value": {
+ "type": "string",
+ "description": "GUID representing an external tenant."
+ }
+ },
+ "description": "Represents a tenant ID that is trusted by the cluster."
+ },
+ "AzureResourceSku": {
+ "properties": {
+ "resourceType": {
+ "type": "string",
+ "description": "Resource Namespace and Type."
+ },
+ "sku": {
+ "$ref": "#/definitions/AzureSku",
+ "description": "The SKU details."
+ },
+ "capacity": {
+ "$ref": "#/definitions/AzureCapacity",
+ "description": "The number of instances of the cluster."
+ }
+ },
+ "description": "Azure resource SKU definition."
+ },
+ "AzureCapacity": {
+ "type": "object",
+ "required": [
+ "minimum",
+ "maximum",
+ "default",
+ "scaleType"
+ ],
+ "properties": {
+ "scaleType": {
+ "description": "Scale type.",
+ "type": "string",
+ "enum": [
+ "automatic",
+ "manual",
+ "none"
+ ],
+ "x-ms-enum": {
+ "name": "AzureScaleType",
+ "modelAsString": true
+ }
+ },
+ "minimum": {
+ "description": "Minimum allowed capacity.",
+ "type": "integer"
+ },
+ "maximum": {
+ "description": "Maximum allowed capacity.",
+ "type": "integer"
+ },
+ "default": {
+ "description": "The default capacity that would be used.",
+ "type": "integer"
+ }
+ },
+ "description": "Azure capacity definition."
+ },
+ "SkuDescriptionList": {
+ "description": "The list of the EngagementFabric SKU descriptions",
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "SKU descriptions",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/SkuDescription"
+ },
+ "readOnly": true
+ }
+ }
+ },
+ "SkuDescription": {
+ "description": "The Kusto SKU description of given resource type",
+ "type": "object",
+ "properties": {
+ "resourceType": {
+ "description": "The resource type",
+ "type": "string",
+ "readOnly": true
+ },
+ "name": {
+ "description": "The name of the SKU",
+ "type": "string",
+ "readOnly": true
+ },
+ "tier": {
+ "description": "The tier of the SKU",
+ "type": "string",
+ "readOnly": true
+ },
+ "locations": {
+ "description": "The set of locations that the SKU is available",
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "readOnly": true
+ },
+ "locationInfo": {
+ "description": "Locations and zones",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/SkuLocationInfoItem"
+ },
+ "readOnly": true
+ },
+ "restrictions": {
+ "description": "The restrictions because of which SKU cannot be used",
+ "type": "array",
+ "items": {
+ "type": "object"
+ },
+ "readOnly": true
+ }
+ }
+ },
+ "SkuLocationInfoItem": {
+ "description": "The locations and zones info for SKU.",
+ "type": "object",
+ "required": [
+ "location"
+ ],
+ "properties": {
+ "location": {
+ "description": "The available location of the SKU.",
+ "type": "string"
+ },
+ "zones": {
+ "description": "The available zone of the SKU.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "AzureSku": {
+ "type": "object",
+ "required": [
+ "name",
+ "tier"
+ ],
+ "properties": {
+ "name": {
+ "description": "SKU name.",
+ "type": "string",
+ "enum": [
+ "Standard_DS13_v2+1TB_PS",
+ "Standard_DS13_v2+2TB_PS",
+ "Standard_DS14_v2+3TB_PS",
+ "Standard_DS14_v2+4TB_PS",
+ "Standard_D13_v2",
+ "Standard_D14_v2",
+ "Standard_L8s",
+ "Standard_L16s",
+ "Standard_D11_v2",
+ "Standard_D12_v2",
+ "Standard_L4s",
+ "Dev(No SLA)_Standard_D11_v2",
+ "Standard_E64i_v3",
+ "Standard_E2a_v4",
+ "Standard_E4a_v4",
+ "Standard_E8a_v4",
+ "Standard_E16a_v4",
+ "Standard_E8as_v4+1TB_PS",
+ "Standard_E8as_v4+2TB_PS",
+ "Standard_E16as_v4+3TB_PS",
+ "Standard_E16as_v4+4TB_PS",
+ "Dev(No SLA)_Standard_E2a_v4"
+ ],
+ "x-ms-enum": {
+ "name": "AzureSkuName",
+ "modelAsString": true
+ }
+ },
+ "capacity": {
+ "description": "The number of instances of the cluster.",
+ "type": "integer"
+ },
+ "tier": {
+ "description": "SKU tier.",
+ "type": "string",
+ "enum": [
+ "Basic",
+ "Standard"
+ ],
+ "x-ms-enum": {
+ "name": "AzureSkuTier",
+ "modelAsString": true
+ }
+ }
+ },
+ "description": "Azure SKU definition."
+ },
+ "Zones": {
+ "description": "An array represents the availability zones of the cluster.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "OptimizedAutoscale": {
+ "type": "object",
+ "required": [
+ "version",
+ "isEnabled",
+ "minimum",
+ "maximum"
+ ],
+ "properties": {
+ "version": {
+ "description": "The version of the template defined, for instance 1.",
+ "type": "integer"
+ },
+ "isEnabled": {
+ "description": "A boolean value that indicate if the optimized autoscale feature is enabled or not.",
+ "type": "boolean"
+ },
+ "minimum": {
+ "description": "Minimum allowed instances count.",
+ "type": "integer"
+ },
+ "maximum": {
+ "description": "Maximum allowed instances count.",
+ "type": "integer"
+ }
+ },
+ "description": "A class that contains the optimized auto scale definition."
+ },
+ "VirtualNetworkConfiguration": {
+ "type": "object",
+ "required": [
+ "subnetId",
+ "enginePublicIpId",
+ "dataManagementPublicIpId"
+ ],
+ "properties": {
+ "subnetId": {
+ "description": "The subnet resource id.",
+ "type": "string"
+ },
+ "enginePublicIpId": {
+ "description": "Engine service's public IP address resource id.",
+ "type": "string"
+ },
+ "dataManagementPublicIpId": {
+ "description": "Data management's service public IP address resource id.",
+ "type": "string"
+ }
+ },
+ "description": "A class that contains virtual network definition."
+ },
+ "DatabaseStatistics": {
+ "type": "object",
+ "readOnly": true,
+ "properties": {
+ "size": {
+ "type": "number",
+ "description": "The database size - the total size of compressed data and index in bytes."
+ }
+ },
+ "description": "A class that contains database statistics information."
+ },
+ "AttachedDatabaseConfigurationProperties": {
+ "properties": {
+ "provisioningState": {
+ "type": "string",
+ "readOnly": true,
+ "description": "The provisioned state of the resource.",
+ "enum": [
+ "Running",
+ "Creating",
+ "Deleting",
+ "Succeeded",
+ "Failed",
+ "Moving"
+ ],
+ "x-ms-enum": {
+ "name": "ProvisioningState",
+ "modelAsString": true
+ }
+ },
+ "databaseName": {
+ "type": "string",
+ "description": "The name of the database which you would like to attach, use * if you want to follow all current and future databases."
+ },
+ "clusterResourceId": {
+ "type": "string",
+ "description": "The resource id of the cluster where the databases you would like to attach reside."
+ },
+ "attachedDatabaseNames": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "readOnly": true,
+ "description": "The list of databases from the clusterResourceId which are currently attached to the cluster."
+ },
+ "defaultPrincipalsModificationKind": {
+ "type": "string",
+ "enum": [
+ "Union",
+ "Replace",
+ "None"
+ ],
+ "x-ms-enum": {
+ "name": "DefaultPrincipalsModificationKind",
+ "modelAsString": true
+ },
+ "description": "The default principals modification kind"
+ }
+ },
+ "description": "Class representing the an attached database configuration properties of kind specific.",
+ "required": [
+ "databaseName",
+ "clusterResourceId",
+ "defaultPrincipalsModificationKind"
+ ]
+ },
+ "ReadWriteDatabaseProperties": {
+ "properties": {
+ "provisioningState": {
+ "type": "string",
+ "readOnly": true,
+ "description": "The provisioned state of the resource.",
+ "enum": [
+ "Running",
+ "Creating",
+ "Deleting",
+ "Succeeded",
+ "Failed",
+ "Moving"
+ ],
+ "x-ms-enum": {
+ "name": "ProvisioningState",
+ "modelAsString": true
+ }
+ },
+ "softDeletePeriod": {
+ "type": "string",
+ "format": "duration",
+ "description": "The time the data should be kept before it stops being accessible to queries in TimeSpan."
+ },
+ "hotCachePeriod": {
+ "type": "string",
+ "format": "duration",
+ "description": "The time the data should be kept in cache for fast queries in TimeSpan."
+ },
+ "statistics": {
+ "$ref": "#/definitions/DatabaseStatistics",
+ "description": "The statistics of the database."
+ },
+ "isFollowed": {
+ "type": "boolean",
+ "readOnly": true,
+ "description": "Indicates whether the database is followed."
+ }
+ },
+ "description": "Class representing the Kusto database properties."
+ },
+ "ReadOnlyFollowingDatabaseProperties": {
+ "properties": {
+ "provisioningState": {
+ "type": "string",
+ "readOnly": true,
+ "description": "The provisioned state of the resource.",
+ "enum": [
+ "Running",
+ "Creating",
+ "Deleting",
+ "Succeeded",
+ "Failed",
+ "Moving"
+ ],
+ "x-ms-enum": {
+ "name": "ProvisioningState",
+ "modelAsString": true
+ }
+ },
+ "softDeletePeriod": {
+ "type": "string",
+ "readOnly": true,
+ "format": "duration",
+ "description": "The time the data should be kept before it stops being accessible to queries in TimeSpan."
+ },
+ "hotCachePeriod": {
+ "type": "string",
+ "format": "duration",
+ "description": "The time the data should be kept in cache for fast queries in TimeSpan."
+ },
+ "statistics": {
+ "$ref": "#/definitions/DatabaseStatistics",
+ "description": "The statistics of the database."
+ },
+ "leaderClusterResourceId": {
+ "type": "string",
+ "readOnly": true,
+ "description": "The name of the leader cluster"
+ },
+ "attachedDatabaseConfigurationName": {
+ "type": "string",
+ "readOnly": true,
+ "description": "The name of the attached database configuration cluster"
+ },
+ "principalsModificationKind": {
+ "type": "string",
+ "readOnly": true,
+ "enum": [
+ "Union",
+ "Replace",
+ "None"
+ ],
+ "x-ms-enum": {
+ "name": "PrincipalsModificationKind",
+ "modelAsString": true
+ },
+ "description": "The principals modification kind of the database"
+ }
+ },
+ "description": "Class representing the Kusto database properties."
+ },
+ "EventHubConnectionProperties": {
+ "properties": {
+ "eventHubResourceId": {
+ "type": "string",
+ "description": "The resource ID of the event hub to be used to create a data connection."
+ },
+ "consumerGroup": {
+ "type": "string",
+ "description": "The event hub consumer group."
+ },
+ "tableName": {
+ "type": "string",
+ "description": "The table where the data should be ingested. Optionally the table information can be added to each message."
+ },
+ "mappingRuleName": {
+ "type": "string",
+ "description": "The mapping rule to be used to ingest the data. Optionally the mapping information can be added to each message."
+ },
+ "dataFormat": {
+ "$ref": "#/definitions/EventHubDataFormat",
+ "description": "The data format of the message. Optionally the data format can be added to each message."
+ },
+ "eventSystemProperties": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "System properties of the event hub"
+ },
+ "compression": {
+ "$ref": "#/definitions/Compression",
+ "description": "The event hub messages compression type"
+ },
+ "provisioningState": {
+ "type": "string",
+ "readOnly": true,
+ "description": "The provisioned state of the resource.",
+ "enum": [
+ "Running",
+ "Creating",
+ "Deleting",
+ "Succeeded",
+ "Failed",
+ "Moving"
+ ],
+ "x-ms-enum": {
+ "name": "ProvisioningState",
+ "modelAsString": true
+ }
+ }
+ },
+ "required": [
+ "eventHubResourceId",
+ "consumerGroup"
+ ],
+ "description": "Class representing the Kusto event hub connection properties."
+ },
+ "IotHubConnectionProperties": {
+ "properties": {
+ "iotHubResourceId": {
+ "type": "string",
+ "description": "The resource ID of the Iot hub to be used to create a data connection."
+ },
+ "consumerGroup": {
+ "type": "string",
+ "description": "The iot hub consumer group."
+ },
+ "tableName": {
+ "type": "string",
+ "description": "The table where the data should be ingested. Optionally the table information can be added to each message."
+ },
+ "mappingRuleName": {
+ "type": "string",
+ "description": "The mapping rule to be used to ingest the data. Optionally the mapping information can be added to each message."
+ },
+ "dataFormat": {
+ "$ref": "#/definitions/IotHubDataFormat",
+ "description": "The data format of the message. Optionally the data format can be added to each message."
+ },
+ "eventSystemProperties": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "System properties of the iot hub"
+ },
+ "sharedAccessPolicyName": {
+ "type": "string",
+ "description": "The name of the share access policy"
+ },
+ "provisioningState": {
+ "type": "string",
+ "readOnly": true,
+ "description": "The provisioned state of the resource.",
+ "enum": [
+ "Running",
+ "Creating",
+ "Deleting",
+ "Succeeded",
+ "Failed",
+ "Moving"
+ ],
+ "x-ms-enum": {
+ "name": "ProvisioningState",
+ "modelAsString": true
+ }
+ }
+ },
+ "required": [
+ "iotHubResourceId",
+ "consumerGroup",
+ "sharedAccessPolicyName"
+ ],
+ "description": "Class representing the Kusto Iot hub connection properties."
+ },
+ "EventHubDataFormat": {
+ "description": "The data format of the message. Optionally the data format can be added to each message.",
+ "type": "string",
+ "enum": [
+ "MULTIJSON",
+ "JSON",
+ "CSV",
+ "TSV",
+ "SCSV",
+ "SOHSV",
+ "PSV",
+ "TXT",
+ "RAW",
+ "SINGLEJSON",
+ "AVRO",
+ "TSVE",
+ "PARQUET",
+ "ORC",
+ "APACHEAVRO",
+ "W3CLOGFILE"
+ ],
+ "x-ms-enum": {
+ "name": "eventHubDataFormat",
+ "modelAsString": true
+ }
+ },
+ "IotHubDataFormat": {
+ "description": "The data format of the message. Optionally the data format can be added to each message.",
+ "type": "string",
+ "enum": [
+ "MULTIJSON",
+ "JSON",
+ "CSV",
+ "TSV",
+ "SCSV",
+ "SOHSV",
+ "PSV",
+ "TXT",
+ "RAW",
+ "SINGLEJSON",
+ "AVRO",
+ "TSVE",
+ "PARQUET",
+ "ORC",
+ "APACHEAVRO",
+ "W3CLOGFILE"
+ ],
+ "x-ms-enum": {
+ "name": "iotHubDataFormat",
+ "modelAsString": true
+ }
+ },
+ "EventGridDataFormat": {
+ "description": "The data format of the message. Optionally the data format can be added to each message.",
+ "type": "string",
+ "enum": [
+ "MULTIJSON",
+ "JSON",
+ "CSV",
+ "TSV",
+ "SCSV",
+ "SOHSV",
+ "PSV",
+ "TXT",
+ "RAW",
+ "SINGLEJSON",
+ "AVRO",
+ "TSVE",
+ "PARQUET",
+ "ORC",
+ "APACHEAVRO",
+ "W3CLOGFILE"
+ ],
+ "x-ms-enum": {
+ "name": "eventGridDataFormat",
+ "modelAsString": true
+ }
+ },
+ "BlobStorageEventType": {
+ "description": "The name of blob storage event type to process.",
+ "type": "string",
+ "enum": [
+ "Microsoft.Storage.BlobCreated",
+ "Microsoft.Storage.BlobRenamed"
+ ],
+ "x-ms-enum": {
+ "name": "blobStorageEventType",
+ "modelAsString": true
+ }
+ },
+ "Compression": {
+ "description": "The compression type",
+ "type": "string",
+ "enum": [
+ "None",
+ "GZip"
+ ],
+ "x-ms-enum": {
+ "name": "compression",
+ "modelAsString": true
+ }
+ },
+ "EventGridConnectionProperties": {
+ "properties": {
+ "storageAccountResourceId": {
+ "type": "string",
+ "description": "The resource ID of the storage account where the data resides."
+ },
+ "eventHubResourceId": {
+ "type": "string",
+ "description": "The resource ID where the event grid is configured to send events."
+ },
+ "consumerGroup": {
+ "type": "string",
+ "description": "The event hub consumer group."
+ },
+ "tableName": {
+ "type": "string",
+ "description": "The table where the data should be ingested. Optionally the table information can be added to each message."
+ },
+ "mappingRuleName": {
+ "type": "string",
+ "description": "The mapping rule to be used to ingest the data. Optionally the mapping information can be added to each message."
+ },
+ "dataFormat": {
+ "$ref": "#/definitions/EventGridDataFormat",
+ "description": "The data format of the message. Optionally the data format can be added to each message."
+ },
+ "ignoreFirstRecord": {
+ "type": "boolean",
+ "description": "A Boolean value that, if set to true, indicates that ingestion should ignore the first record of every file"
+ },
+ "blobStorageEventType": {
+ "$ref": "#/definitions/BlobStorageEventType",
+ "description": "The name of blob storage event type to process."
+ },
+ "provisioningState": {
+ "type": "string",
+ "readOnly": true,
+ "description": "The provisioned state of the resource.",
+ "enum": [
+ "Running",
+ "Creating",
+ "Deleting",
+ "Succeeded",
+ "Failed",
+ "Moving"
+ ],
+ "x-ms-enum": {
+ "name": "ProvisioningState",
+ "modelAsString": true
+ }
+ }
+ },
+ "required": [
+ "storageAccountResourceId",
+ "eventHubResourceId",
+ "consumerGroup"
+ ],
+ "description": "Class representing the Kusto event grid connection properties."
+ },
+ "Cluster": {
+ "required": [
+ "sku"
+ ],
+ "properties": {
+ "sku": {
+ "$ref": "#/definitions/AzureSku",
+ "description": "The SKU of the cluster."
+ },
+ "zones": {
+ "$ref": "#/definitions/Zones",
+ "description": "The availability zones of the cluster."
+ },
+ "identity": {
+ "$ref": "#/definitions/Identity",
+ "description": "The identity of the cluster, if configured."
+ },
+ "properties": {
+ "x-ms-client-flatten": true,
+ "$ref": "#/definitions/ClusterProperties",
+ "description": "The cluster properties."
+ }
+ },
+ "allOf": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/TrackedResource"
+ }
+ ],
+ "description": "Class representing a Kusto cluster."
+ },
+ "ClusterUpdate": {
+ "properties": {
+ "tags": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ },
+ "x-ms-mutability": [
+ "read",
+ "create",
+ "update"
+ ],
+ "description": "Resource tags."
+ },
+ "location": {
+ "type": "string",
+ "description": "Resource location."
+ },
+ "sku": {
+ "$ref": "#/definitions/AzureSku",
+ "description": "The SKU of the cluster."
+ },
+ "identity": {
+ "$ref": "#/definitions/Identity",
+ "description": "The identity of the cluster, if configured."
+ },
+ "properties": {
+ "x-ms-client-flatten": true,
+ "description": "The cluster properties.",
+ "$ref": "#/definitions/ClusterProperties"
+ }
+ },
+ "allOf": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/Resource"
+ }
+ ],
+ "description": "Class representing an update to a Kusto cluster."
+ },
+ "AttachedDatabaseConfigurationListResult": {
+ "properties": {
+ "value": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/AttachedDatabaseConfiguration"
+ },
+ "description": "The list of attached database configurations."
+ }
+ },
+ "description": "The list attached database configurations operation response."
+ },
+ "AttachedDatabaseConfiguration": {
+ "properties": {
+ "location": {
+ "type": "string",
+ "description": "Resource location."
+ },
+ "properties": {
+ "x-ms-client-flatten": true,
+ "description": "The properties of the attached database configuration.",
+ "$ref": "#/definitions/AttachedDatabaseConfigurationProperties"
+ }
+ },
+ "allOf": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ProxyResource"
+ }
+ ],
+ "description": "Class representing an attached database configuration."
+ },
+ "Database": {
+ "required": [
+ "kind"
+ ],
+ "properties": {
+ "location": {
+ "type": "string",
+ "description": "Resource location."
+ },
+ "kind": {
+ "description": "Kind of the database",
+ "enum": [
+ "ReadWrite",
+ "ReadOnlyFollowing"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "Kind",
+ "modelAsString": true
+ }
+ }
+ },
+ "allOf": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ProxyResource"
+ }
+ ],
+ "description": "Class representing a Kusto database.",
+ "discriminator": "kind"
+ },
+ "ReadWriteDatabase": {
+ "properties": {
+ "properties": {
+ "x-ms-client-flatten": true,
+ "description": "The database properties.",
+ "$ref": "#/definitions/ReadWriteDatabaseProperties"
+ }
+ },
+ "allOf": [
+ {
+ "$ref": "#/definitions/Database"
+ }
+ ],
+ "description": "Class representing a read write database.",
+ "x-ms-discriminator-value": "ReadWrite"
+ },
+ "ReadOnlyFollowingDatabase": {
+ "properties": {
+ "properties": {
+ "x-ms-client-flatten": true,
+ "description": "The database properties.",
+ "$ref": "#/definitions/ReadOnlyFollowingDatabaseProperties"
+ }
+ },
+ "allOf": [
+ {
+ "$ref": "#/definitions/Database"
+ }
+ ],
+ "description": "Class representing a read only following database.",
+ "x-ms-discriminator-value": "ReadOnlyFollowing"
+ },
+ "DatabasePrincipal": {
+ "type": "object",
+ "required": [
+ "name",
+ "role",
+ "type"
+ ],
+ "properties": {
+ "role": {
+ "description": "Database principal role.",
+ "type": "string",
+ "enum": [
+ "Admin",
+ "Ingestor",
+ "Monitor",
+ "User",
+ "UnrestrictedViewers",
+ "Viewer"
+ ],
+ "x-ms-enum": {
+ "name": "DatabasePrincipalRole",
+ "modelAsString": true
+ }
+ },
+ "name": {
+ "description": "Database principal name.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Database principal type.",
+ "type": "string",
+ "enum": [
+ "App",
+ "Group",
+ "User"
+ ],
+ "x-ms-enum": {
+ "name": "DatabasePrincipalType",
+ "modelAsString": true
+ }
+ },
+ "fqn": {
+ "description": "Database principal fully qualified name.",
+ "type": "string"
+ },
+ "email": {
+ "description": "Database principal email if exists.",
+ "type": "string"
+ },
+ "appId": {
+ "description": "Application id - relevant only for application principal type.",
+ "type": "string"
+ },
+ "tenantName": {
+ "type": "string",
+ "readOnly": true,
+ "description": "The tenant name of the principal"
+ }
+ },
+ "description": "A class representing database principal entity."
+ },
+ "DatabasePrincipalProperties": {
+ "type": "object",
+ "required": [
+ "principalId",
+ "role",
+ "principalType"
+ ],
+ "properties": {
+ "principalId": {
+ "description": "The principal ID assigned to the database principal. It can be a user email, application ID, or security group name.",
+ "type": "string"
+ },
+ "role": {
+ "description": "Database principal role.",
+ "type": "string",
+ "enum": [
+ "Admin",
+ "Ingestor",
+ "Monitor",
+ "User",
+ "UnrestrictedViewers",
+ "Viewer"
+ ],
+ "x-ms-enum": {
+ "name": "DatabasePrincipalRole",
+ "modelAsString": true
+ }
+ },
+ "tenantId": {
+ "type": "string",
+ "description": "The tenant id of the principal"
+ },
+ "principalType": {
+ "description": "Principal type.",
+ "type": "string",
+ "enum": [
+ "App",
+ "Group",
+ "User"
+ ],
+ "x-ms-enum": {
+ "name": "PrincipalType",
+ "modelAsString": true
+ }
+ },
+ "tenantName": {
+ "type": "string",
+ "readOnly": true,
+ "description": "The tenant name of the principal"
+ },
+ "principalName": {
+ "type": "string",
+ "readOnly": true,
+ "description": "The principal name"
+ },
+ "provisioningState": {
+ "type": "string",
+ "readOnly": true,
+ "description": "The provisioned state of the resource.",
+ "enum": [
+ "Running",
+ "Creating",
+ "Deleting",
+ "Succeeded",
+ "Failed",
+ "Moving"
+ ],
+ "x-ms-enum": {
+ "name": "ProvisioningState",
+ "modelAsString": true
+ }
+ }
+ },
+ "description": "A class representing database principal property."
+ },
+ "ClusterPrincipalProperties": {
+ "type": "object",
+ "required": [
+ "principalId",
+ "role",
+ "principalType"
+ ],
+ "properties": {
+ "principalId": {
+ "description": "The principal ID assigned to the cluster principal. It can be a user email, application ID, or security group name.",
+ "type": "string"
+ },
+ "role": {
+ "description": "Cluster principal role.",
+ "type": "string",
+ "enum": [
+ "AllDatabasesAdmin",
+ "AllDatabasesViewer"
+ ],
+ "x-ms-enum": {
+ "name": "ClusterPrincipalRole",
+ "modelAsString": true
+ }
+ },
+ "tenantId": {
+ "type": "string",
+ "description": "The tenant id of the principal"
+ },
+ "principalType": {
+ "description": "Principal type.",
+ "type": "string",
+ "enum": [
+ "App",
+ "Group",
+ "User"
+ ],
+ "x-ms-enum": {
+ "name": "PrincipalType",
+ "modelAsString": true
+ }
+ },
+ "tenantName": {
+ "type": "string",
+ "readOnly": true,
+ "description": "The tenant name of the principal"
+ },
+ "principalName": {
+ "type": "string",
+ "readOnly": true,
+ "description": "The principal name"
+ },
+ "provisioningState": {
+ "type": "string",
+ "readOnly": true,
+ "description": "The provisioned state of the resource.",
+ "enum": [
+ "Running",
+ "Creating",
+ "Deleting",
+ "Succeeded",
+ "Failed",
+ "Moving"
+ ],
+ "x-ms-enum": {
+ "name": "ProvisioningState",
+ "modelAsString": true
+ }
+ }
+ },
+ "description": "A class representing cluster principal property."
+ },
+ "DatabasePrincipalAssignment": {
+ "properties": {
+ "properties": {
+ "x-ms-client-flatten": true,
+ "$ref": "#/definitions/DatabasePrincipalProperties",
+ "description": "The database principal."
+ }
+ },
+ "allOf": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ProxyResource"
+ }
+ ],
+ "description": "Class representing a database principal assignment."
+ },
+ "ClusterPrincipalAssignment": {
+ "properties": {
+ "properties": {
+ "x-ms-client-flatten": true,
+ "$ref": "#/definitions/ClusterPrincipalProperties",
+ "description": "The cluster principal."
+ }
+ },
+ "allOf": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ProxyResource"
+ }
+ ],
+ "description": "Class representing a cluster principal assignment."
+ },
+ "ClusterListResult": {
+ "properties": {
+ "value": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/Cluster"
+ },
+ "description": "The list of Kusto clusters."
+ }
+ },
+ "description": "The list Kusto clusters operation response."
+ },
+ "DatabaseListResult": {
+ "properties": {
+ "value": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/Database"
+ },
+ "description": "The list of Kusto databases."
+ }
+ },
+ "description": "The list Kusto databases operation response."
+ },
+ "DatabasePrincipalAssignmentListResult": {
+ "properties": {
+ "value": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/DatabasePrincipalAssignment"
+ },
+ "description": "The list of Kusto database principal assignments."
+ }
+ },
+ "description": "The list Kusto database principal assignments operation response."
+ },
+ "ClusterPrincipalAssignmentListResult": {
+ "properties": {
+ "value": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ClusterPrincipalAssignment"
+ },
+ "description": "The list of Kusto cluster principal assignments."
+ }
+ },
+ "description": "The list Kusto cluster principal assignments operation response."
+ },
+ "DatabasePrincipalListResult": {
+ "properties": {
+ "value": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/DatabasePrincipal"
+ },
+ "description": "The list of Kusto database principals."
+ }
+ },
+ "description": "The list Kusto database principals operation response."
+ },
+ "FollowerDatabaseListResult": {
+ "properties": {
+ "value": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/FollowerDatabaseDefinition"
+ },
+ "description": "The list of follower database result."
+ }
+ },
+ "description": "The list Kusto database principals operation response."
+ },
+ "DataConnection": {
+ "required": [
+ "kind"
+ ],
+ "properties": {
+ "location": {
+ "type": "string",
+ "description": "Resource location."
+ },
+ "kind": {
+ "description": "Kind of the endpoint for the data connection",
+ "enum": [
+ "EventHub",
+ "EventGrid",
+ "IotHub"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "Kind",
+ "modelAsString": true
+ }
+ }
+ },
+ "allOf": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ProxyResource"
+ }
+ ],
+ "description": "Class representing an data connection.",
+ "discriminator": "kind"
+ },
+ "DataConnectionValidationResult": {
+ "type": "object",
+ "properties": {
+ "errorMessage": {
+ "type": "string",
+ "description": "A message which indicates a problem in data connection validation."
+ }
+ },
+ "description": "The result returned from a data connection validation request."
+ },
+ "DatabasePrincipalListRequest": {
+ "properties": {
+ "value": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/DatabasePrincipal"
+ },
+ "description": "The list of Kusto database principals."
+ }
+ },
+ "description": "The list Kusto database principals operation request."
+ },
+ "FollowerDatabaseDefinition": {
+ "type": "object",
+ "required": [
+ "clusterResourceId",
+ "attachedDatabaseConfigurationName"
+ ],
+ "properties": {
+ "clusterResourceId": {
+ "type": "string",
+ "description": "Resource id of the cluster that follows a database owned by this cluster."
+ },
+ "attachedDatabaseConfigurationName": {
+ "type": "string",
+ "description": "Resource name of the attached database configuration in the follower cluster."
+ },
+ "databaseName": {
+ "type": "string",
+ "readOnly": true,
+ "description": "The database name owned by this cluster that was followed. * in case following all databases."
+ }
+ },
+ "description": "A class representing follower database request."
+ },
+ "DiagnoseVirtualNetworkResult": {
+ "properties": {
+ "findings": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "The list of network connectivity diagnostic finding"
+ }
+ }
+ },
+ "DataConnectionValidation": {
+ "properties": {
+ "dataConnectionName": {
+ "type": "string",
+ "description": "The name of the data connection."
+ },
+ "properties": {
+ "$ref": "#/definitions/DataConnection",
+ "description": "The data connection properties to validate."
+ }
+ },
+ "description": "Class representing an data connection validation."
+ },
+ "EventHubDataConnection": {
+ "properties": {
+ "properties": {
+ "x-ms-client-flatten": true,
+ "description": "The Event Hub data connection properties to validate.",
+ "$ref": "#/definitions/EventHubConnectionProperties"
+ }
+ },
+ "allOf": [
+ {
+ "$ref": "#/definitions/DataConnection"
+ }
+ ],
+ "description": "Class representing an event hub data connection.",
+ "x-ms-discriminator-value": "EventHub"
+ },
+ "IotHubDataConnection": {
+ "properties": {
+ "properties": {
+ "x-ms-client-flatten": true,
+ "description": "The Iot Hub data connection properties.",
+ "$ref": "#/definitions/IotHubConnectionProperties"
+ }
+ },
+ "allOf": [
+ {
+ "$ref": "#/definitions/DataConnection"
+ }
+ ],
+ "description": "Class representing an iot hub data connection.",
+ "x-ms-discriminator-value": "IotHub"
+ },
+ "EventGridDataConnection": {
+ "properties": {
+ "properties": {
+ "x-ms-client-flatten": true,
+ "description": "The properties of the Event Grid data connection.",
+ "$ref": "#/definitions/EventGridConnectionProperties"
+ }
+ },
+ "allOf": [
+ {
+ "$ref": "#/definitions/DataConnection"
+ }
+ ],
+ "description": "Class representing an Event Grid data connection.",
+ "x-ms-discriminator-value": "EventGrid"
+ },
+ "DataConnectionValidationListResult": {
+ "properties": {
+ "value": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/DataConnectionValidationResult"
+ },
+ "description": "The list of Kusto data connection validation errors."
+ }
+ },
+ "description": "The list Kusto data connection validation result."
+ },
+ "DataConnectionListResult": {
+ "properties": {
+ "value": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/DataConnection"
+ },
+ "description": "The list of Kusto data connections."
+ }
+ },
+ "description": "The list Kusto data connections operation response."
+ },
+ "CloudError": {
+ "x-ms-external": true,
+ "properties": {
+ "error": {
+ "$ref": "#/definitions/CloudErrorBody",
+ "description": "An error response from Kusto."
+ }
+ },
+ "description": "An error response from Kusto."
+ },
+ "ClusterCheckNameRequest": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "Cluster name."
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Microsoft.Kusto/clusters"
+ ],
+ "x-ms-enum": {
+ "name": "Type",
+ "modelAsString": false
+ },
+ "description": "The type of resource, Microsoft.Kusto/clusters."
+ }
+ },
+ "required": [
+ "name",
+ "type"
+ ],
+ "description": "The result returned from a cluster check name availability request."
+ },
+ "CheckNameRequest": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "Resource name."
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Microsoft.Kusto/clusters/databases",
+ "Microsoft.Kusto/clusters/attachedDatabaseConfigurations"
+ ],
+ "x-ms-enum": {
+ "name": "Type",
+ "modelAsString": false
+ },
+ "description": "The type of resource, for instance Microsoft.Kusto/clusters/databases."
+ }
+ },
+ "required": [
+ "name",
+ "type"
+ ],
+ "description": "The result returned from a database check name availability request."
+ },
+ "ClusterPrincipalAssignmentCheckNameRequest": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "Principal Assignment resource name."
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Microsoft.Kusto/clusters/principalAssignments"
+ ],
+ "x-ms-enum": {
+ "name": "Type",
+ "modelAsString": false
+ },
+ "description": "The type of resource, Microsoft.Kusto/clusters/principalAssignments."
+ }
+ },
+ "required": [
+ "name",
+ "type"
+ ],
+ "description": "A principal assignment check name availability request."
+ },
+ "DataConnectionCheckNameRequest": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "Data Connection name."
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Microsoft.Kusto/clusters/databases/dataConnections"
+ ],
+ "x-ms-enum": {
+ "name": "Type",
+ "modelAsString": false
+ },
+ "description": "The type of resource, Microsoft.Kusto/clusters/databases/dataConnections."
+ }
+ },
+ "required": [
+ "name",
+ "type"
+ ],
+ "description": "A data connection check name availability request."
+ },
+ "DatabasePrincipalAssignmentCheckNameRequest": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "Principal Assignment resource name."
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Microsoft.Kusto/clusters/databases/principalAssignments"
+ ],
+ "x-ms-enum": {
+ "name": "Type",
+ "modelAsString": false
+ },
+ "description": "The type of resource, Microsoft.Kusto/clusters/databases/principalAssignments."
+ }
+ },
+ "required": [
+ "name",
+ "type"
+ ],
+ "description": "A principal assignment check name availability request."
+ },
+ "CheckNameResult": {
+ "type": "object",
+ "properties": {
+ "nameAvailable": {
+ "type": "boolean",
+ "description": "Specifies a Boolean value that indicates if the name is available."
+ },
+ "name": {
+ "type": "string",
+ "description": "The name that was checked."
+ },
+ "message": {
+ "type": "string",
+ "description": "Message indicating an unavailable name due to a conflict, or a description of the naming rules that are violated."
+ },
+ "reason": {
+ "type": "string",
+ "enum": [
+ "Invalid",
+ "AlreadyExists"
+ ],
+ "x-ms-enum": {
+ "name": "reason",
+ "modelAsString": true
+ },
+ "description": "Message providing the reason why the given name is invalid."
+ }
+ },
+ "description": "The result returned from a check name availability request."
+ },
+ "ListResourceSkusResult": {
+ "description": "List of available SKUs for a Kusto Cluster.",
+ "type": "object",
+ "properties": {
+ "value": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/AzureResourceSku"
+ },
+ "description": "The collection of available SKUs for an existing resource."
+ }
+ }
+ },
+ "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 displaying 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 Kusto."
+ },
+ "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.",
+ "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."
+ }
+ }
+ },
+ "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"
+ },
+ "display": {
+ "title": "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.",
+ "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",
+ "x-ms-client-flatten": 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": "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 all identities.",
+ "enum": [
+ "None",
+ "SystemAssigned",
+ "UserAssigned",
+ "SystemAssigned, UserAssigned"
+ ],
+ "x-ms-enum": {
+ "name": "IdentityType",
+ "modelAsString": true
+ }
+ },
+ "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 the Kusto cluster. 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": "Identity for the resource."
+ },
+ "KeyVaultProperties": {
+ "description": "Properties of the key vault.",
+ "required": [
+ "keyName",
+ "keyVaultUri"
+ ],
+ "properties": {
+ "keyName": {
+ "type": "string",
+ "description": "The name of the key vault key.",
+ "x-ms-client-name": "KeyName"
+ },
+ "keyVersion": {
+ "type": "string",
+ "description": "The version of the key vault key.",
+ "x-ms-client-name": "KeyVersion"
+ },
+ "keyVaultUri": {
+ "type": "string",
+ "description": "The Uri of the key vault.",
+ "x-ms-client-name": "KeyVaultUri"
+ },
+ "userIdentity": {
+ "type": "string",
+ "description": "The user assigned identity (ARM resource id) that has access to the key.",
+ "x-ms-client-name": "UserIdentity"
+ }
+ }
+ },
+ "LanguageExtensionName": {
+ "description": "Language extension that can run within KQL query.",
+ "type": "string",
+ "enum": [
+ "PYTHON",
+ "R"
+ ],
+ "x-ms-enum": {
+ "name": "languageExtensionName",
+ "modelAsString": true
+ }
+ },
+ "LanguageExtension": {
+ "type": "object",
+ "description": "The language extension object.",
+ "properties": {
+ "languageExtensionName": {
+ "$ref": "#/definitions/LanguageExtensionName",
+ "description": "The language extension name."
+ }
+ }
+ },
+ "LanguageExtensionsList": {
+ "properties": {
+ "value": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/LanguageExtension"
+ },
+ "description": "The list of language extensions."
+ }
+ },
+ "description": "The list of language extension objects."
+ }
+ },
+ "parameters": {
+ "SubscriptionIdParameter": {
+ "name": "subscriptionId",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call."
+ },
+ "ApiVersionParameter": {
+ "name": "api-version",
+ "in": "query",
+ "required": true,
+ "type": "string",
+ "description": "Client API Version."
+ },
+ "ClusterNameParameter": {
+ "name": "clusterName",
+ "in": "path",
+ "description": "The name of the Kusto cluster.",
+ "required": true,
+ "type": "string",
+ "x-ms-parameter-location": "method"
+ },
+ "AttachedDatabaseConfigurationNameParameter": {
+ "name": "attachedDatabaseConfigurationName",
+ "in": "path",
+ "description": "The name of the attached database configuration.",
+ "required": true,
+ "type": "string",
+ "x-ms-parameter-location": "method"
+ },
+ "ResourceGroupParameter": {
+ "name": "resourceGroupName",
+ "in": "path",
+ "description": "The name of the resource group containing the Kusto cluster.",
+ "required": true,
+ "type": "string",
+ "x-ms-parameter-location": "method"
+ },
+ "DatabaseNameParameter": {
+ "name": "databaseName",
+ "in": "path",
+ "description": "The name of the database in the Kusto cluster.",
+ "required": true,
+ "type": "string",
+ "x-ms-parameter-location": "method"
+ },
+ "DataConnectionNameParameter": {
+ "name": "dataConnectionName",
+ "in": "path",
+ "description": "The name of the data connection.",
+ "required": true,
+ "type": "string",
+ "x-ms-parameter-location": "method"
+ },
+ "PrincipalAssignmentNameParameter": {
+ "name": "principalAssignmentName",
+ "in": "path",
+ "description": "The name of the Kusto principalAssignment.",
+ "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": "Azure Active Directory OAuth2 Flow",
+ "scopes": {
+ "user_impersonation": "impersonate your user account"
+ }
+ }
+ }
+}
diff --git a/specification/azure-kusto/resource-manager/readme.go.md b/specification/azure-kusto/resource-manager/readme.go.md
index ed01044bbc85..53a36056359e 100644
--- a/specification/azure-kusto/resource-manager/readme.go.md
+++ b/specification/azure-kusto/resource-manager/readme.go.md
@@ -13,6 +13,7 @@ go:
``` yaml $(go) && $(multiapi)
batch:
+ - tag: package-2020-09-18
- tag: package-2018-09-07-preview
- tag: package-2019-01-21
- tag: package-2019-05-15
@@ -22,6 +23,15 @@ batch:
- tag: package-2020-06-14
```
+### Tag: package-2020-09-18 and go
+
+These settings apply only when `--tag=package-2020-09-18 --go` is specified on the command line.
+Please also specify `--go-sdk-folder=`.
+
+``` yaml $(tag) == 'package-2020-09-18' && $(go)
+output-folder: $(go-sdk-folder)/services/$(namespace)/mgmt/2020-09-18/$(namespace)
+```
+
### Tag: package-2018-09-07-preview and go
These settings apply only when `--tag=package-2018-09-07-preview --go` is specified on the command line.
diff --git a/specification/azure-kusto/resource-manager/readme.md b/specification/azure-kusto/resource-manager/readme.md
index 043249c10db0..8f7b35f48286 100644
--- a/specification/azure-kusto/resource-manager/readme.md
+++ b/specification/azure-kusto/resource-manager/readme.md
@@ -28,14 +28,23 @@ These are the global settings for the Kusto API.
title: KustoManagementClient
description: 'The Azure Kusto management API provides a RESTful set of web services that interact with Azure Kusto services to manage your clusters and databases. The API enables you to create, update, and delete clusters and databases.'
openapi-type: arm
-tag: package-2020-06-14
+tag: package-2020-09-18
```
+
+### Tag: package-2020-09-18
+
+These settings apply only when `--tag=package-2020-09-18` is specified on the command line.
+
+```yaml $(tag) == 'package-2020-09-18'
+input-file:
+ - Microsoft.Kusto/stable/2020-09-18/kusto.json
+```
### Tag: package-2020-06-14
These settings apply only when `--tag=package-2020-06-14` is specified on the command line.
-```yaml $(tag) == 'package-2020-06-14'
+``` yaml $(tag) == 'package-2020-06-14'
input-file:
- Microsoft.Kusto/stable/2020-06-14/kusto.json
```
diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2020-03-01-preview/azurestackhci.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2020-03-01-preview/azurestackhci.json
index de3d90772ef0..f68062eb0abc 100644
--- a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2020-03-01-preview/azurestackhci.json
+++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2020-03-01-preview/azurestackhci.json
@@ -50,7 +50,7 @@
"200": {
"description": "OK",
"schema": {
- "$ref": "#/definitions/OperationList"
+ "$ref": "#/definitions/AvailableOperations"
}
},
"default": {
@@ -545,60 +545,76 @@
}
}
},
- "OperationList": {
- "description": "List of available operations.",
+ "AvailableOperations": {
+ "description": "Available operations of the service",
"type": "object",
"properties": {
"value": {
- "description": "List of operations.",
+ "description": "Collection of available operation details",
+ "uniqueItems": false,
"type": "array",
"items": {
- "$ref": "#/definitions/Operation"
+ "$ref": "#/definitions/OperationDetail"
}
},
"nextLink": {
- "description": "Link to the next set of results.",
- "type": "string",
- "readOnly": true
+ "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"
}
}
},
- "Operation": {
- "description": "Operation details.",
+ "OperationDetail": {
+ "description": "Operation detail payload",
"type": "object",
"properties": {
"name": {
- "description": "Name of the operation.",
- "type": "string",
- "readOnly": true
+ "description": "Name of the operation",
+ "type": "string"
+ },
+ "isDataAction": {
+ "description": "Indicates whether the operation is a data action",
+ "type": "boolean"
},
"display": {
"$ref": "#/definitions/OperationDisplay",
- "description": "Operation properties."
+ "description": "Display of the operation"
+ },
+ "origin": {
+ "description": "Origin of the operation",
+ "type": "string"
+ },
+ "properties": {
+ "$ref": "#/definitions/OperationProperties",
+ "description": "Properties of the operation"
}
}
},
"OperationDisplay": {
- "description": "Operation properties.",
+ "description": "Operation display payload",
"type": "object",
"properties": {
"provider": {
- "description": "Resource provider name.",
+ "description": "Resource provider of the operation",
"type": "string"
},
"resource": {
- "description": "Resource type name.",
+ "description": "Resource of the operation",
"type": "string"
},
"operation": {
- "description": "Operation name.",
+ "description": "Localized friendly name for the operation",
"type": "string"
},
"description": {
- "description": "Operation description.",
+ "description": "Localized friendly description for the operation",
"type": "string"
}
}
+ },
+ "OperationProperties": {
+ "description": "Operation properties.",
+ "type": "object",
+ "properties": {}
}
},
"parameters": {
diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2020-10-01/azurestackhci.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2020-10-01/azurestackhci.json
new file mode 100644
index 000000000000..bdb7c992b8de
--- /dev/null
+++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2020-10-01/azurestackhci.json
@@ -0,0 +1,630 @@
+{
+ "swagger": "2.0",
+ "info": {
+ "version": "2020-10-01",
+ "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": "#/definitions/AvailableOperations"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/providers/Microsoft.AzureStackHCI/clusters": {
+ "get": {
+ "tags": [
+ "Clusters"
+ ],
+ "operationId": "Clusters_ListBySubscription",
+ "x-ms-examples": {
+ "ListClusters": {
+ "$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": {
+ "ListClusters": {
+ "$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": {
+ "GetClusters": {
+ "$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": {
+ "GetClusters": {
+ "$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": {
+ "GetClusters": {
+ "$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/ClusterUpdate"
+ }
+ }
+ ],
+ "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": {
+ "GetClusters": {
+ "$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": {
+ "properties": {
+ "description": "Cluster properties.",
+ "$ref": "#/definitions/ClusterProperties",
+ "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
+ },
+ "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"
+ },
+ "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
+ }
+ }
+ },
+ "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
+ }
+ }
+ },
+ "ClusterUpdate": {
+ "description": "Cluster details to update.",
+ "type": "object",
+ "properties": {
+ "tags": {
+ "description": "Resource tags.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "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": {
+ "$ref": "#/definitions/OperationProperties",
+ "description": "Properties of the operation"
+ }
+ }
+ },
+ "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"
+ }
+ }
+ },
+ "OperationProperties": {
+ "description": "Operation properties.",
+ "type": "object",
+ "properties": {}
+ }
+ },
+ "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/stable/2020-10-01/examples/CreateCluster.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2020-10-01/examples/CreateCluster.json
new file mode 100644
index 000000000000..c41cd8a2e52e
--- /dev/null
+++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2020-10-01/examples/CreateCluster.json
@@ -0,0 +1,36 @@
+{
+ "parameters": {
+ "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b",
+ "resourceGroupName": "test-rg",
+ "clusterName": "myCluster",
+ "api-version": "2020-10-01",
+ "cluster": {
+ "location": "East US",
+ "properties": {
+ "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": {},
+ "properties": {
+ "provisioningState": "Succeeded",
+ "status": "NotYetRegistered",
+ "cloudId": "a3c0468f-e38e-4dda-ac48-817f620536f0",
+ "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/stable/2020-10-01/examples/DeleteCluster.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2020-10-01/examples/DeleteCluster.json
new file mode 100644
index 000000000000..b0a231f2d232
--- /dev/null
+++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2020-10-01/examples/DeleteCluster.json
@@ -0,0 +1,12 @@
+{
+ "parameters": {
+ "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b",
+ "resourceGroupName": "test-rg",
+ "clusterName": "myCluster",
+ "api-version": "2020-10-01"
+ },
+ "responses": {
+ "200": {},
+ "204": {}
+ }
+}
diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2020-10-01/examples/GetCluster.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2020-10-01/examples/GetCluster.json
new file mode 100644
index 000000000000..449f80e35488
--- /dev/null
+++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2020-10-01/examples/GetCluster.json
@@ -0,0 +1,72 @@
+{
+ "parameters": {
+ "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b",
+ "resourceGroupName": "test-rg",
+ "clusterName": "myCluster",
+ "api-version": "2020-10-01"
+ },
+ "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": {},
+ "properties": {
+ "provisioningState": "Succeeded",
+ "status": "ConnectedRecently",
+ "cloudId": "a3c0468f-e38e-4dda-ac48-817f620536f0",
+ "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/stable/2020-10-01/examples/ListClustersByResourceGroup.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2020-10-01/examples/ListClustersByResourceGroup.json
new file mode 100644
index 000000000000..fd2dcdcf0015
--- /dev/null
+++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2020-10-01/examples/ListClustersByResourceGroup.json
@@ -0,0 +1,92 @@
+{
+ "parameters": {
+ "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b",
+ "resourceGroupName": "test-rg",
+ "api-version": "2020-10-01"
+ },
+ "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": {},
+ "properties": {
+ "provisioningState": "Succeeded",
+ "status": "NotYetRegistered",
+ "cloudId": "91c2b355-4826-4e96-9164-e3f26dcf1cdd",
+ "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": {},
+ "properties": {
+ "provisioningState": "Succeeded",
+ "status": "ConnectedRecently",
+ "cloudId": "a3c0468f-e38e-4dda-ac48-817f620536f0",
+ "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/stable/2020-10-01/examples/ListClustersBySubscription.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2020-10-01/examples/ListClustersBySubscription.json
new file mode 100644
index 000000000000..4c2a50dda8ea
--- /dev/null
+++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2020-10-01/examples/ListClustersBySubscription.json
@@ -0,0 +1,91 @@
+{
+ "parameters": {
+ "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b",
+ "api-version": "2020-10-01"
+ },
+ "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": {},
+ "properties": {
+ "provisioningState": "Succeeded",
+ "status": "NotYetRegistered",
+ "cloudId": "91c2b355-4826-4e96-9164-e3f26dcf1cdd",
+ "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": {},
+ "properties": {
+ "provisioningState": "Succeeded",
+ "status": "ConnectedRecently",
+ "cloudId": "a3c0468f-e38e-4dda-ac48-817f620536f0",
+ "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/stable/2020-10-01/examples/UpdateCluster.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2020-10-01/examples/UpdateCluster.json
new file mode 100644
index 000000000000..324a193b5145
--- /dev/null
+++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2020-10-01/examples/UpdateCluster.json
@@ -0,0 +1,81 @@
+{
+ "parameters": {
+ "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b",
+ "resourceGroupName": "test-rg",
+ "clusterName": "myCluster",
+ "api-version": "2020-10-01",
+ "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"
+ },
+ "properties": {
+ "provisioningState": "Succeeded",
+ "status": "ConnectedRecently",
+ "cloudId": "91c2b355-4826-4e96-9164-e3f26dcf1cdd",
+ "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/readme.go.md b/specification/azurestackhci/resource-manager/readme.go.md
index fddd0e002a49..6d7b9a0233d3 100644
--- a/specification/azurestackhci/resource-manager/readme.go.md
+++ b/specification/azurestackhci/resource-manager/readme.go.md
@@ -12,9 +12,20 @@ go:
```yaml $(go) && $(multiapi)
batch:
+ - tag: package-2020-10
- tag: package-2020-03-01-preview
```
+### Tag: package-2020-10 and go
+
+These settings apply only when `--tag=package-2020-10 --go` is specified on the command line.
+Please also specify `--go-sdks-folder=`.
+
+```yaml $(tag) == 'package-2020-10' && $(go)
+namespace: azurestackhci
+output-folder: $(go-sdk-folder)/services/$(namespace)/mgmt/2020-10-01/$(namespace)
+```
+
### Tag: package-2020-03-01-preview and go
These settings apply only when `--tag=package-2020-03-01-preview --go` is specified on the command line.
diff --git a/specification/azurestackhci/resource-manager/readme.java.md b/specification/azurestackhci/resource-manager/readme.java.md
new file mode 100644
index 000000000000..bf96908f4e24
--- /dev/null
+++ b/specification/azurestackhci/resource-manager/readme.java.md
@@ -0,0 +1,36 @@
+## 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.azurestackhci
+license-header: MICROSOFT_MIT_NO_CODEGEN
+payload-flattening-threshold: 1
+output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-azurestackhci
+```
+
+# Validation
+
+
+### Java multi-api
+
+``` yaml $(java) && $(multiapi)
+batch:
+ - tag: package-2020-10
+```
+
+### Tag: package-2020-10 and java
+
+These settings apply only when `--tag=package-2020-10 --java` is specified on the command line.
+Please also specify `--azure-libraries-for-java=`.
+
+``` yaml $(tag) == 'package-2020-10' && $(java) && $(multiapi)
+java:
+ namespace: com.microsoft.azure.management.azurestackhci.v2020_10_01
+ output-folder: $(azure-libraries-for-java-folder)/sdk/azurestackhci/mgmt-v2020_10_01
+regenerate-manager: true
+generate-interface: true
+```
diff --git a/specification/azurestackhci/resource-manager/readme.md b/specification/azurestackhci/resource-manager/readme.md
index fcd244ab9316..64b34d2f9f98 100644
--- a/specification/azurestackhci/resource-manager/readme.md
+++ b/specification/azurestackhci/resource-manager/readme.md
@@ -24,27 +24,36 @@ For other options on installation see [Installing AutoRest](https://aka.ms/autor
These are the global settings for the azurestackhci.
-```yaml
+``` yaml
title: AzureStackHCIClient
description: Azure Stack HCI management service
openapi-type: arm
-tag: package-2020-03-01-preview
+tag: package-2020-10
```
## Suppression
-```yaml
+``` yaml
directive:
- suppress: R3020
from: azurestackhci.json
reason: Microsoft.AzureStackHCI is the correct name for our RP.
```
+
+### Tag: package-2020-10
+
+These settings apply only when `--tag=package-2020-10` is specified on the command line.
+
+```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.
-```yaml $(tag) == 'package-2020-03-01-preview'
+``` yaml $(tag) == 'package-2020-03-01-preview'
input-file:
- Microsoft.AzureStackHCI/preview/2020-03-01-preview/azurestackhci.json
```
@@ -58,7 +67,7 @@ input-file:
This section describes what SDK should be generated by the automatic system.
This is not used by Autorest itself.
-```yaml $(swagger-to-sdk)
+``` yaml $(swagger-to-sdk)
swagger-to-sdk:
- repo: azure-sdk-for-python
- repo: azure-sdk-for-java
@@ -76,6 +85,10 @@ swagger-to-sdk:
See configuration in [readme.go.md](./readme.go.md)
+## Java
+
+See configuration in [readme.java.md](./readme.java.md)
+
## Python
See configuration in [readme.python.md](./readme.python.md)
@@ -95,4 +108,3 @@ See configuration in [readme.csharp.md](./readme.csharp.md)
## AzureResourceSchema
See configuration in [readme.azureresourceschema.md](./readme.azureresourceschema.md)
-
diff --git a/specification/baremetalinfrastructure/resource-manager/readme.go.md b/specification/baremetalinfrastructure/resource-manager/readme.go.md
index 1157b0905cb3..1677cc7854ec 100644
--- a/specification/baremetalinfrastructure/resource-manager/readme.go.md
+++ b/specification/baremetalinfrastructure/resource-manager/readme.go.md
@@ -15,5 +15,5 @@ Please also specify `--go-sdks-folder=`.
``` yaml $(tag) == 'package-2020-05' && $(go)
-output-folder: $(go-sdk-folder)/services/$(namespace)/mgmt/2020-05-01/$(namespace)
+output-folder: $(go-sdk-folder)/services/preview/$(namespace)/mgmt/2020-05-01-preview/$(namespace)
```
### Tag: package-2018-11-preview and go
diff --git a/specification/botservice/resource-manager/readme.md b/specification/botservice/resource-manager/readme.md
index b94651179da3..f2d4bf12432c 100644
--- a/specification/botservice/resource-manager/readme.md
+++ b/specification/botservice/resource-manager/readme.md
@@ -99,6 +99,7 @@ swagger-to-sdk:
- repo: azure-resource-manager-schemas
after_scripts:
- node sdkauto_afterscript.js botservice/resource-manager
+ - repo: azure-sdk-for-js
```
## C#
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 e3ccabfbb2ca..72bfef245f21 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
@@ -2557,7 +2557,6 @@
"description": "Defines the parameters for RemoteAddress match conditions",
"required": [
"operator",
- "matchValues",
"@odata.type"
],
"properties": {
@@ -2604,7 +2603,6 @@
"description": "Defines the parameters for RequestMethod match conditions",
"required": [
"operator",
- "matchValues",
"@odata.type"
],
"properties": {
@@ -2651,7 +2649,6 @@
"description": "Defines the parameters for QueryString match conditions",
"required": [
"operator",
- "matchValues",
"@odata.type"
],
"properties": {
@@ -2704,8 +2701,6 @@
"description": "Defines the parameters for PostArgs match conditions",
"required": [
"operator",
- "matchValues",
- "selector",
"@odata.type"
],
"properties": {
@@ -2762,7 +2757,6 @@
"description": "Defines the parameters for RequestUri match conditions",
"required": [
"operator",
- "matchValues",
"@odata.type"
],
"properties": {
@@ -2815,8 +2809,6 @@
"description": "Defines the parameters for RequestHeader match conditions",
"required": [
"operator",
- "matchValues",
- "selector",
"@odata.type"
],
"properties": {
@@ -2873,7 +2865,6 @@
"description": "Defines the parameters for RequestBody match conditions",
"required": [
"operator",
- "matchValues",
"@odata.type"
],
"properties": {
@@ -2926,7 +2917,6 @@
"description": "Defines the parameters for RequestScheme match conditions ",
"required": [
"operator",
- "matchValues",
"@odata.type"
],
"properties": {
@@ -2964,7 +2954,6 @@
"description": "Defines the parameters for UrlPath match conditions",
"required": [
"operator",
- "matchValues",
"@odata.type"
],
"properties": {
@@ -3018,7 +3007,6 @@
"description": "Defines the parameters for UrlFileExtension match conditions",
"required": [
"operator",
- "matchValues",
"@odata.type"
],
"properties": {
@@ -3071,7 +3059,6 @@
"description": "Defines the parameters for UrlFilename match conditions",
"required": [
"operator",
- "matchValues",
"@odata.type"
],
"properties": {
@@ -3124,7 +3111,6 @@
"description": "Defines the parameters for HttpVersion match conditions",
"required": [
"operator",
- "matchValues",
"@odata.type"
],
"properties": {
@@ -3162,8 +3148,6 @@
"description": "Defines the parameters for Cookies match conditions",
"required": [
"operator",
- "matchValues",
- "selector",
"@odata.type"
],
"properties": {
@@ -3220,7 +3204,6 @@
"description": "Defines the parameters for IsDevice match conditions",
"required": [
"operator",
- "matchValues",
"@odata.type"
],
"properties": {
@@ -4072,7 +4055,6 @@
"resourceGroupName",
"vaultName",
"secretName",
- "secretVersion",
"updateRule",
"deleteRule"
],
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 e2b319a2e9d7..85e58bdd2080 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
@@ -2567,7 +2567,6 @@
"description": "Defines the parameters for RemoteAddress match conditions",
"required": [
"operator",
- "matchValues",
"@odata.type"
],
"properties": {
@@ -2614,7 +2613,6 @@
"description": "Defines the parameters for RequestMethod match conditions",
"required": [
"operator",
- "matchValues",
"@odata.type"
],
"properties": {
@@ -2661,7 +2659,6 @@
"description": "Defines the parameters for QueryString match conditions",
"required": [
"operator",
- "matchValues",
"@odata.type"
],
"properties": {
@@ -2714,8 +2711,6 @@
"description": "Defines the parameters for PostArgs match conditions",
"required": [
"operator",
- "matchValues",
- "selector",
"@odata.type"
],
"properties": {
@@ -2772,7 +2767,6 @@
"description": "Defines the parameters for RequestUri match conditions",
"required": [
"operator",
- "matchValues",
"@odata.type"
],
"properties": {
@@ -2825,8 +2819,6 @@
"description": "Defines the parameters for RequestHeader match conditions",
"required": [
"operator",
- "matchValues",
- "selector",
"@odata.type"
],
"properties": {
@@ -2883,7 +2875,6 @@
"description": "Defines the parameters for RequestBody match conditions",
"required": [
"operator",
- "matchValues",
"@odata.type"
],
"properties": {
@@ -2936,7 +2927,6 @@
"description": "Defines the parameters for RequestScheme match conditions ",
"required": [
"operator",
- "matchValues",
"@odata.type"
],
"properties": {
@@ -2974,7 +2964,6 @@
"description": "Defines the parameters for UrlPath match conditions",
"required": [
"operator",
- "matchValues",
"@odata.type"
],
"properties": {
@@ -3028,7 +3017,6 @@
"description": "Defines the parameters for UrlFileExtension match conditions",
"required": [
"operator",
- "matchValues",
"@odata.type"
],
"properties": {
@@ -3081,7 +3069,6 @@
"description": "Defines the parameters for UrlFilename match conditions",
"required": [
"operator",
- "matchValues",
"@odata.type"
],
"properties": {
@@ -3134,7 +3121,6 @@
"description": "Defines the parameters for HttpVersion match conditions",
"required": [
"operator",
- "matchValues",
"@odata.type"
],
"properties": {
@@ -3172,8 +3158,6 @@
"description": "Defines the parameters for Cookies match conditions",
"required": [
"operator",
- "matchValues",
- "selector",
"@odata.type"
],
"properties": {
@@ -3230,7 +3214,6 @@
"description": "Defines the parameters for IsDevice match conditions",
"required": [
"operator",
- "matchValues",
"@odata.type"
],
"properties": {
@@ -4082,7 +4065,6 @@
"resourceGroupName",
"vaultName",
"secretName",
- "secretVersion",
"updateRule",
"deleteRule"
],
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 4282327a5c0a..985cc15ee100 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
@@ -3037,7 +3037,6 @@
"description": "Defines the parameters for RemoteAddress match conditions",
"required": [
"operator",
- "matchValues",
"@odata.type"
],
"properties": {
@@ -3084,7 +3083,6 @@
"description": "Defines the parameters for RequestMethod match conditions",
"required": [
"operator",
- "matchValues",
"@odata.type"
],
"properties": {
@@ -3131,7 +3129,6 @@
"description": "Defines the parameters for QueryString match conditions",
"required": [
"operator",
- "matchValues",
"@odata.type"
],
"properties": {
@@ -3184,8 +3181,6 @@
"description": "Defines the parameters for PostArgs match conditions",
"required": [
"operator",
- "matchValues",
- "selector",
"@odata.type"
],
"properties": {
@@ -3242,7 +3237,6 @@
"description": "Defines the parameters for RequestUri match conditions",
"required": [
"operator",
- "matchValues",
"@odata.type"
],
"properties": {
@@ -3295,8 +3289,6 @@
"description": "Defines the parameters for RequestHeader match conditions",
"required": [
"operator",
- "matchValues",
- "selector",
"@odata.type"
],
"properties": {
@@ -3353,7 +3345,6 @@
"description": "Defines the parameters for RequestBody match conditions",
"required": [
"operator",
- "matchValues",
"@odata.type"
],
"properties": {
@@ -3406,7 +3397,6 @@
"description": "Defines the parameters for RequestScheme match conditions ",
"required": [
"operator",
- "matchValues",
"@odata.type"
],
"properties": {
@@ -3444,7 +3434,6 @@
"description": "Defines the parameters for UrlPath match conditions",
"required": [
"operator",
- "matchValues",
"@odata.type"
],
"properties": {
@@ -3498,7 +3487,6 @@
"description": "Defines the parameters for UrlFileExtension match conditions",
"required": [
"operator",
- "matchValues",
"@odata.type"
],
"properties": {
@@ -3551,7 +3539,6 @@
"description": "Defines the parameters for UrlFilename match conditions",
"required": [
"operator",
- "matchValues",
"@odata.type"
],
"properties": {
@@ -3604,7 +3591,6 @@
"description": "Defines the parameters for HttpVersion match conditions",
"required": [
"operator",
- "matchValues",
"@odata.type"
],
"properties": {
@@ -3642,8 +3628,6 @@
"description": "Defines the parameters for Cookies match conditions",
"required": [
"operator",
- "matchValues",
- "selector",
"@odata.type"
],
"properties": {
@@ -3700,7 +3684,6 @@
"description": "Defines the parameters for IsDevice match conditions",
"required": [
"operator",
- "matchValues",
"@odata.type"
],
"properties": {
@@ -4868,7 +4851,6 @@
"resourceGroupName",
"vaultName",
"secretName",
- "secretVersion",
"updateRule",
"deleteRule"
],
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 40bda7fa0c28..5b5bb55288fa 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
@@ -3054,7 +3054,6 @@
"description": "Defines the parameters for RemoteAddress match conditions",
"required": [
"operator",
- "matchValues",
"@odata.type"
],
"properties": {
@@ -3101,7 +3100,6 @@
"description": "Defines the parameters for RequestMethod match conditions",
"required": [
"operator",
- "matchValues",
"@odata.type"
],
"properties": {
@@ -3148,7 +3146,6 @@
"description": "Defines the parameters for QueryString match conditions",
"required": [
"operator",
- "matchValues",
"@odata.type"
],
"properties": {
@@ -3201,8 +3198,6 @@
"description": "Defines the parameters for PostArgs match conditions",
"required": [
"operator",
- "matchValues",
- "selector",
"@odata.type"
],
"properties": {
@@ -3259,7 +3254,6 @@
"description": "Defines the parameters for RequestUri match conditions",
"required": [
"operator",
- "matchValues",
"@odata.type"
],
"properties": {
@@ -3312,8 +3306,6 @@
"description": "Defines the parameters for RequestHeader match conditions",
"required": [
"operator",
- "matchValues",
- "selector",
"@odata.type"
],
"properties": {
@@ -3370,7 +3362,6 @@
"description": "Defines the parameters for RequestBody match conditions",
"required": [
"operator",
- "matchValues",
"@odata.type"
],
"properties": {
@@ -3423,7 +3414,6 @@
"description": "Defines the parameters for RequestScheme match conditions ",
"required": [
"operator",
- "matchValues",
"@odata.type"
],
"properties": {
@@ -3461,7 +3451,6 @@
"description": "Defines the parameters for UrlPath match conditions",
"required": [
"operator",
- "matchValues",
"@odata.type"
],
"properties": {
@@ -3515,7 +3504,6 @@
"description": "Defines the parameters for UrlFileExtension match conditions",
"required": [
"operator",
- "matchValues",
"@odata.type"
],
"properties": {
@@ -3568,7 +3556,6 @@
"description": "Defines the parameters for UrlFilename match conditions",
"required": [
"operator",
- "matchValues",
"@odata.type"
],
"properties": {
@@ -3621,7 +3608,6 @@
"description": "Defines the parameters for HttpVersion match conditions",
"required": [
"operator",
- "matchValues",
"@odata.type"
],
"properties": {
@@ -3659,8 +3645,6 @@
"description": "Defines the parameters for Cookies match conditions",
"required": [
"operator",
- "matchValues",
- "selector",
"@odata.type"
],
"properties": {
@@ -3717,7 +3701,6 @@
"description": "Defines the parameters for IsDevice match conditions",
"required": [
"operator",
- "matchValues",
"@odata.type"
],
"properties": {
@@ -4982,7 +4965,6 @@
"resourceGroupName",
"vaultName",
"secretName",
- "secretVersion",
"updateRule",
"deleteRule"
],
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 2fcd9a9690c9..24ba251127d2 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
@@ -3054,7 +3054,6 @@
"description": "Defines the parameters for RemoteAddress match conditions",
"required": [
"operator",
- "matchValues",
"@odata.type"
],
"properties": {
@@ -3101,7 +3100,6 @@
"description": "Defines the parameters for RequestMethod match conditions",
"required": [
"operator",
- "matchValues",
"@odata.type"
],
"properties": {
@@ -3148,7 +3146,6 @@
"description": "Defines the parameters for QueryString match conditions",
"required": [
"operator",
- "matchValues",
"@odata.type"
],
"properties": {
@@ -3201,8 +3198,6 @@
"description": "Defines the parameters for PostArgs match conditions",
"required": [
"operator",
- "matchValues",
- "selector",
"@odata.type"
],
"properties": {
@@ -3259,7 +3254,6 @@
"description": "Defines the parameters for RequestUri match conditions",
"required": [
"operator",
- "matchValues",
"@odata.type"
],
"properties": {
@@ -3312,8 +3306,6 @@
"description": "Defines the parameters for RequestHeader match conditions",
"required": [
"operator",
- "matchValues",
- "selector",
"@odata.type"
],
"properties": {
@@ -3370,7 +3362,6 @@
"description": "Defines the parameters for RequestBody match conditions",
"required": [
"operator",
- "matchValues",
"@odata.type"
],
"properties": {
@@ -3423,7 +3414,6 @@
"description": "Defines the parameters for RequestScheme match conditions ",
"required": [
"operator",
- "matchValues",
"@odata.type"
],
"properties": {
@@ -3461,7 +3451,6 @@
"description": "Defines the parameters for UrlPath match conditions",
"required": [
"operator",
- "matchValues",
"@odata.type"
],
"properties": {
@@ -3515,7 +3504,6 @@
"description": "Defines the parameters for UrlFileExtension match conditions",
"required": [
"operator",
- "matchValues",
"@odata.type"
],
"properties": {
@@ -3568,7 +3556,6 @@
"description": "Defines the parameters for UrlFilename match conditions",
"required": [
"operator",
- "matchValues",
"@odata.type"
],
"properties": {
@@ -3621,7 +3608,6 @@
"description": "Defines the parameters for HttpVersion match conditions",
"required": [
"operator",
- "matchValues",
"@odata.type"
],
"properties": {
@@ -3659,8 +3645,6 @@
"description": "Defines the parameters for Cookies match conditions",
"required": [
"operator",
- "matchValues",
- "selector",
"@odata.type"
],
"properties": {
@@ -3717,7 +3701,6 @@
"description": "Defines the parameters for IsDevice match conditions",
"required": [
"operator",
- "matchValues",
"@odata.type"
],
"properties": {
@@ -5038,7 +5021,6 @@
"resourceGroupName",
"vaultName",
"secretName",
- "secretVersion",
"updateRule",
"deleteRule"
],
diff --git a/specification/cdn/resource-manager/readme.go.md b/specification/cdn/resource-manager/readme.go.md
index b53dccbfb0c7..a660c2a5dd61 100644
--- a/specification/cdn/resource-manager/readme.go.md
+++ b/specification/cdn/resource-manager/readme.go.md
@@ -29,7 +29,7 @@ These settings apply only when `--tag=package-2020-04 --go` is specified on the
Please also specify `--go-sdk-folder=`.
``` yaml $(tag) == 'package-2020-04' && $(go)
-output-folder: $(go-sdk-folder)/services/preview/$(namespace)/mgmt/2020-04-15/$(namespace)
+output-folder: $(go-sdk-folder)/services/$(namespace)/mgmt/2020-04-15/$(namespace)
```
### Tag: package-2019-04 and go
diff --git a/specification/cognitiveservices/data-plane/ComputerVision/readme.go.md b/specification/cognitiveservices/data-plane/ComputerVision/readme.go.md
index 97861eeff941..1386894f71a3 100644
--- a/specification/cognitiveservices/data-plane/ComputerVision/readme.go.md
+++ b/specification/cognitiveservices/data-plane/ComputerVision/readme.go.md
@@ -16,6 +16,7 @@ batch:
- tag: release_2_0
- tag: release_2_1
- tag: release_3_0
+ - tag: release_3_1
```
### Tag: release_2_0 and go
@@ -45,11 +46,20 @@ Please also specify `--go-sdk-folder=`.
+
+``` yaml $(tag) == 'release_3_1_preview_2' && $(go)
+output-folder: $(go-sdk-folder)/services/preview/cognitiveservices/v3.1-preview.2/$(namespace)
+```
+
### Tag: release_3_1 and go
These settings apply only when `--tag=release_3_1 --go` is specified on the command line.
Please also specify `--go-sdk-folder=`.
``` yaml $(tag) == 'release_3_1' && $(go)
-output-folder: $(go-sdk-folder)/services/preview/cognitiveservices/v3.1-preview.2/$(namespace)
+output-folder: $(go-sdk-folder)/services/cognitiveservices/v3.1/$(namespace)
```
\ No newline at end of file
diff --git a/specification/cognitiveservices/data-plane/ComputerVision/readme.md b/specification/cognitiveservices/data-plane/ComputerVision/readme.md
index af1edea7aad7..aa285d970a63 100644
--- a/specification/cognitiveservices/data-plane/ComputerVision/readme.md
+++ b/specification/cognitiveservices/data-plane/ComputerVision/readme.md
@@ -4,11 +4,11 @@
Configuration for generating Computer Vision SDK.
-The current release is `release_3_0`.
+The current release is `release_3_1`.
``` yaml
-tag: release_3_0
+tag: release_3_1
add-credentials: true
openapi-type: data-plane
```
@@ -57,6 +57,15 @@ input-file:
- preview/v3.1-preview.2/Ocr.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/ComputerVision.json
+ - stable/v3.1/Ocr.json
+```
+
## Swagger to SDK
This section describes what SDK should be generated by the automatic system.
diff --git a/specification/cognitiveservices/data-plane/ComputerVision/readme.ruby.md b/specification/cognitiveservices/data-plane/ComputerVision/readme.ruby.md
index 019525023fad..b93a320d0992 100644
--- a/specification/cognitiveservices/data-plane/ComputerVision/readme.ruby.md
+++ b/specification/cognitiveservices/data-plane/ComputerVision/readme.ruby.md
@@ -41,4 +41,15 @@ Please also specify `--ruby-sdks-folder=`.
+
+``` yaml $(tag) == 'release_3_1' && $(ruby)
+namespace: "Azure::CognitiveServices::ComputerVision::V3_1"
+output-folder: $(ruby-sdks-folder)/data/azure_cognitiveservices_computervision/lib
+title: "ComputerVisionClient"
```
\ No newline at end of file
diff --git a/specification/cognitiveservices/data-plane/ComputerVision/stable/v3.1/ComputerVision.json b/specification/cognitiveservices/data-plane/ComputerVision/stable/v3.1/ComputerVision.json
new file mode 100644
index 000000000000..35ef27a5a632
--- /dev/null
+++ b/specification/cognitiveservices/data-plane/ComputerVision/stable/v3.1/ComputerVision.json
@@ -0,0 +1,1840 @@
+{
+ "swagger": "2.0",
+ "info": {
+ "version": "3.1",
+ "title": "Computer Vision Client",
+ "description": "The Computer Vision API provides state-of-the-art algorithms to process images and return information. For example, it can be used to determine if an image contains mature content, or it can be used to find all the faces in an image. It also has other features like estimating dominant and accent colors, categorizing the content of images, and describing an image with complete English sentences. Additionally, it can also intelligently generate images thumbnails for displaying large images effectively."
+ },
+ "securityDefinitions": {
+ "apim_key": {
+ "type": "apiKey",
+ "name": "Ocp-Apim-Subscription-Key",
+ "in": "header"
+ }
+ },
+ "security": [
+ {
+ "apim_key": []
+ }
+ ],
+ "x-ms-parameterized-host": {
+ "hostTemplate": "{Endpoint}",
+ "useSchemePrefix": false,
+ "parameters": [
+ {
+ "$ref": "#/parameters/Endpoint"
+ }
+ ]
+ },
+ "host": "westcentralus.api.cognitive.microsoft.com",
+ "basePath": "/vision/v3.1",
+ "schemes": [
+ "https"
+ ],
+ "paths": {
+ "/analyze": {
+ "post": {
+ "description": "This operation extracts a rich set of visual features based on the image content.\r\nTwo input methods are supported -- (1) Uploading an image or (2) specifying an image URL. Within your request, there is an optional parameter to allow you to choose which features to return. By default, image categories are returned in the response.\r\nA successful response will be returned in JSON. If the request failed, the response will contain an error code and a message to help understand what went wrong.",
+ "operationId": "AnalyzeImage",
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/VisualFeatures"
+ },
+ {
+ "name": "details",
+ "in": "query",
+ "description": "A string indicating which domain-specific details to return. Multiple values should be comma-separated. Valid visual feature types include: Celebrities - identifies celebrities if detected in the image, Landmarks - identifies notable landmarks in the image.",
+ "required": false,
+ "type": "array",
+ "items": {
+ "type": "string",
+ "enum": [
+ "Celebrities",
+ "Landmarks"
+ ],
+ "x-nullable": false,
+ "x-ms-enum": {
+ "name": "Details",
+ "modelAsString": false
+ }
+ },
+ "collectionFormat": "csv",
+ "x-nullable": true
+ },
+ {
+ "$ref": "#/parameters/ServiceLanguage"
+ },
+ {
+ "$ref": "#/parameters/DescriptionExclude"
+ },
+ {
+ "$ref": "#/parameters/ImageUrl"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The response include the extracted features in JSON format. Here is the definitions for enumeration types:\r\n ClipartType\r\n Non - clipart = 0, ambiguous = 1, normal - clipart = 2, good - clipart = 3. LineDrawingTypeNon - LineDrawing = 0, LineDrawing = 1.",
+ "schema": {
+ "$ref": "#/definitions/ImageAnalysis"
+ }
+ },
+ "default": {
+ "description": "Error response.",
+ "schema": {
+ "$ref": "#/definitions/ComputerVisionError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Successful AnalyzeImage request": {
+ "$ref": "./examples/SuccessfulAnalyzeImageWithUrl.json"
+ }
+ }
+ }
+ },
+ "/describe": {
+ "post": {
+ "description": "This operation generates a description of an image in human readable language with complete sentences. The description is based on a collection of content tags, which are also returned by the operation. More than one description can be generated for each image. Descriptions are ordered by their confidence score. Descriptions may include results from celebrity and landmark domain models, if applicable.\r\nTwo input methods are supported -- (1) Uploading an image or (2) specifying an image URL.\r\nA successful response will be returned in JSON. If the request failed, the response will contain an error code and a message to help understand what went wrong.",
+ "operationId": "DescribeImage",
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "name": "maxCandidates",
+ "in": "query",
+ "description": "Maximum number of candidate descriptions to be returned. The default is 1.",
+ "required": false,
+ "type": "integer",
+ "format": "int32",
+ "default": 1,
+ "x-nullable": true
+ },
+ {
+ "$ref": "#/parameters/ServiceLanguage"
+ },
+ {
+ "$ref": "#/parameters/DescriptionExclude"
+ },
+ {
+ "$ref": "#/parameters/ImageUrl"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Image description object.",
+ "schema": {
+ "$ref": "#/definitions/ImageDescription"
+ }
+ },
+ "default": {
+ "description": "Error response.",
+ "schema": {
+ "$ref": "#/definitions/ComputerVisionError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Successful DescribeImage request": {
+ "$ref": "./examples/SuccessfulDescribeImageWithUrl.json"
+ }
+ }
+ }
+ },
+ "/detect": {
+ "post": {
+ "description": "Performs object detection on the specified image.\r\nTwo input methods are supported -- (1) Uploading an image or (2) specifying an image URL.\r\nA successful response will be returned in JSON. If the request failed, the response will contain an error code and a message to help understand what went wrong.",
+ "operationId": "DetectObjects",
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/ImageUrl"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The response include the detected objects in JSON format.",
+ "schema": {
+ "$ref": "#/definitions/DetectResult"
+ }
+ },
+ "default": {
+ "description": "Error response.",
+ "schema": {
+ "$ref": "#/definitions/ComputerVisionError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Successful DetectObjects request": {
+ "$ref": "./examples/SuccessfulDetectObjectsWithUrl.json"
+ }
+ }
+ }
+ },
+ "/models": {
+ "get": {
+ "description": "This operation returns the list of domain-specific models that are supported by the Computer Vision API. Currently, the API supports following domain-specific models: celebrity recognizer, landmark recognizer.\r\nA successful response will be returned in JSON. If the request failed, the response will contain an error code and a message to help understand what went wrong.",
+ "operationId": "ListModels",
+ "consumes": [],
+ "produces": [
+ "application/json"
+ ],
+ "responses": {
+ "200": {
+ "description": "List of available domain models.",
+ "schema": {
+ "$ref": "#/definitions/ListModelsResult"
+ }
+ },
+ "default": {
+ "description": "Error response.",
+ "schema": {
+ "$ref": "#/definitions/ComputerVisionError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Successful ListModels request": {
+ "$ref": "./examples/SuccessfulListModels.json"
+ }
+ }
+ }
+ },
+ "/models/{model}/analyze": {
+ "post": {
+ "description": "This operation recognizes content within an image by applying a domain-specific model. The list of domain-specific models that are supported by the Computer Vision API can be retrieved using the /models GET request. Currently, the API provides following domain-specific models: celebrities, landmarks.\r\nTwo input methods are supported -- (1) Uploading an image or (2) specifying an image URL.\r\nA successful response will be returned in JSON.\r\nIf the request failed, the response will contain an error code and a message to help understand what went wrong.",
+ "operationId": "AnalyzeImageByDomain",
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "name": "model",
+ "in": "path",
+ "description": "The domain-specific content to recognize.",
+ "required": true,
+ "type": "string",
+ "x-nullable": true
+ },
+ {
+ "$ref": "#/parameters/ServiceLanguage"
+ },
+ {
+ "$ref": "#/parameters/ImageUrl"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Analysis result based on the domain model.",
+ "schema": {
+ "$ref": "#/definitions/DomainModelResults"
+ }
+ },
+ "default": {
+ "description": "Error response.",
+ "schema": {
+ "$ref": "#/definitions/ComputerVisionError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Successful AnalyzeImageByDomain request": {
+ "$ref": "./examples/SuccessfulAnalyzeImageByDomainWithUrl.json"
+ }
+ }
+ }
+ },
+ "/ocr": {
+ "post": {
+ "description": "Optical Character Recognition (OCR) detects text in an image and extracts the recognized characters into a machine-usable character stream.\r\nUpon success, the OCR results will be returned.\r\nUpon failure, the error code together with an error message will be returned. The error code can be one of InvalidImageUrl, InvalidImageFormat, InvalidImageSize, NotSupportedImage, NotSupportedLanguage, or InternalServerError.",
+ "operationId": "RecognizePrintedText",
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/DetectOrientation"
+ },
+ {
+ "$ref": "#/parameters/OcrLanguage"
+ },
+ {
+ "$ref": "#/parameters/ImageUrl"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The OCR results in the hierarchy of region/line/word. The results include text, bounding box for regions, lines and words. The angle, in radians, of the detected text with respect to the closest horizontal or vertical direction. After rotating the input image clockwise by this angle, the recognized text lines become horizontal or vertical. In combination with the orientation property it can be used to overlay recognition results correctly on the original image, by rotating either the original image or recognition results by a suitable angle around the center of the original image. If the angle cannot be confidently detected, this property is not present. If the image contains text at different angles, only part of the text will be recognized correctly.",
+ "schema": {
+ "$ref": "#/definitions/OcrResult"
+ }
+ },
+ "default": {
+ "description": "Error response.",
+ "schema": {
+ "$ref": "#/definitions/ComputerVisionError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Successful RecognizePrintedText request": {
+ "$ref": "./examples/SuccessfulRecognizePrintedTextWithUrl.json"
+ }
+ }
+ }
+ },
+ "/tag": {
+ "post": {
+ "description": "This operation generates a list of words, or tags, that are relevant to the content of the supplied image. The Computer Vision API can return tags based on objects, living beings, scenery or actions found in images. Unlike categories, tags are not organized according to a hierarchical classification system, but correspond to image content. Tags may contain hints to avoid ambiguity or provide context, for example the tag \"ascomycete\" may be accompanied by the hint \"fungus\".\r\nTwo input methods are supported -- (1) Uploading an image or (2) specifying an image URL.\r\nA successful response will be returned in JSON. If the request failed, the response will contain an error code and a message to help understand what went wrong.",
+ "operationId": "TagImage",
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/ServiceLanguage"
+ },
+ {
+ "$ref": "#/parameters/ImageUrl"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Image tags object.",
+ "schema": {
+ "$ref": "#/definitions/TagResult"
+ }
+ },
+ "default": {
+ "description": "Error response.",
+ "schema": {
+ "$ref": "#/definitions/ComputerVisionError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Successful TagImage request": {
+ "$ref": "./examples/SuccessfulTagImageWithUrl.json"
+ }
+ }
+ }
+ },
+ "/generateThumbnail": {
+ "post": {
+ "description": "This operation generates a thumbnail image with the user-specified width and height. By default, the service analyzes the image, identifies the region of interest (ROI), and generates smart cropping coordinates based on the ROI. Smart cropping helps when you specify an aspect ratio that differs from that of the input image.\r\nA successful response contains the thumbnail image binary. If the request failed, the response contains an error code and a message to help determine what went wrong.\r\nUpon failure, the error code and an error message are returned. The error code could be one of InvalidImageUrl, InvalidImageFormat, InvalidImageSize, InvalidThumbnailSize, NotSupportedImage, FailedToProcess, Timeout, or InternalServerError.",
+ "operationId": "GenerateThumbnail",
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/octet-stream"
+ ],
+ "parameters": [
+ {
+ "name": "width",
+ "in": "query",
+ "description": "Width of the thumbnail, in pixels. It must be between 1 and 1024. Recommended minimum of 50.",
+ "required": true,
+ "type": "integer",
+ "format": "int32",
+ "maximum": 1024,
+ "minimum": 1,
+ "x-nullable": false
+ },
+ {
+ "name": "height",
+ "in": "query",
+ "description": "Height of the thumbnail, in pixels. It must be between 1 and 1024. Recommended minimum of 50.",
+ "required": true,
+ "type": "integer",
+ "format": "int32",
+ "maximum": 1024,
+ "minimum": 1,
+ "x-nullable": false
+ },
+ {
+ "name": "smartCropping",
+ "in": "query",
+ "description": "Boolean flag for enabling smart cropping.",
+ "required": false,
+ "type": "boolean",
+ "default": false,
+ "x-nullable": true
+ },
+ {
+ "$ref": "#/parameters/ImageUrl"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The generated thumbnail in binary format.",
+ "schema": {
+ "type": "file"
+ }
+ },
+ "default": {
+ "description": "Error response.",
+ "schema": {
+ "$ref": "#/definitions/ComputerVisionError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Successful GenerateThumbnail request": {
+ "$ref": "./examples/SuccessfulGenerateThumbnailWithUrl.json"
+ }
+ }
+ }
+ },
+ "/areaOfInterest": {
+ "post": {
+ "description": "This operation returns a bounding box around the most important area of the image.\r\nA successful response will be returned in JSON. If the request failed, the response contains an error code and a message to help determine what went wrong.\r\nUpon failure, the error code and an error message are returned. The error code could be one of InvalidImageUrl, InvalidImageFormat, InvalidImageSize, NotSupportedImage, FailedToProcess, Timeout, or InternalServerError.",
+ "operationId": "GetAreaOfInterest",
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/ImageUrl"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The response includes the extracted area of interest in JSON format.",
+ "schema": {
+ "$ref": "#/definitions/AreaOfInterestResult"
+ }
+ },
+ "default": {
+ "description": "Error response.",
+ "schema": {
+ "$ref": "#/definitions/ComputerVisionError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Successful GetAreaOfInterest request": {
+ "$ref": "./examples/SuccessfulGetAreaOfInterestWithUrl.json"
+ }
+ }
+ }
+ }
+ },
+ "definitions": {
+ "ImageAnalysis": {
+ "description": "Result of AnalyzeImage operation.",
+ "type": "object",
+ "properties": {
+ "categories": {
+ "description": "An array indicating identified categories.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/Category"
+ },
+ "x-nullable": true
+ },
+ "adult": {
+ "$ref": "#/definitions/AdultInfo",
+ "description": "An object describing whether the image contains adult-oriented content and/or is racy."
+ },
+ "color": {
+ "$ref": "#/definitions/ColorInfo",
+ "description": "An object providing additional metadata describing color attributes."
+ },
+ "imageType": {
+ "$ref": "#/definitions/ImageType",
+ "description": "An object providing possible image types and matching confidence levels."
+ },
+ "tags": {
+ "description": "A list of tags with confidence level.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ImageTag"
+ },
+ "x-nullable": true
+ },
+ "description": {
+ "$ref": "#/definitions/ImageDescriptionDetails",
+ "description": "A collection of content tags, along with a list of captions sorted by confidence level, and image metadata."
+ },
+ "faces": {
+ "description": "An array of possible faces within the image.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/FaceDescription"
+ },
+ "x-nullable": true
+ },
+ "objects": {
+ "description": "Array of objects describing what was detected in the image.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/DetectedObject"
+ },
+ "x-nullable": true
+ },
+ "brands": {
+ "description": "Array of brands detected in the image.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/DetectedBrand"
+ },
+ "x-nullable": true
+ },
+ "requestId": {
+ "description": "Id of the REST API request.",
+ "type": "string",
+ "x-nullable": true
+ },
+ "metadata": {
+ "$ref": "#/definitions/ImageMetadata"
+ }
+ },
+ "x-nullable": true
+ },
+ "Category": {
+ "description": "An object describing identified category.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "Name of the category.",
+ "type": "string",
+ "x-nullable": true
+ },
+ "score": {
+ "format": "double",
+ "description": "Scoring of the category.",
+ "type": "number",
+ "x-nullable": false
+ },
+ "detail": {
+ "$ref": "#/definitions/CategoryDetail",
+ "description": "Details of the identified category."
+ }
+ },
+ "x-nullable": true
+ },
+ "AdultInfo": {
+ "description": "An object describing whether the image contains adult-oriented content and/or is racy.",
+ "type": "object",
+ "properties": {
+ "isAdultContent": {
+ "description": "A value indicating if the image contains adult-oriented content.",
+ "type": "boolean",
+ "x-nullable": false
+ },
+ "isRacyContent": {
+ "description": "A value indicating if the image is racy.",
+ "type": "boolean",
+ "x-nullable": false
+ },
+ "isGoryContent": {
+ "description": "A value indicating if the image is gory.",
+ "type": "boolean",
+ "x-nullable": false
+ },
+ "adultScore": {
+ "format": "double",
+ "description": "Score from 0 to 1 that indicates how much the content is considered adult-oriented within the image.",
+ "type": "number",
+ "x-nullable": false
+ },
+ "racyScore": {
+ "format": "double",
+ "description": "Score from 0 to 1 that indicates how suggestive is the image.",
+ "type": "number",
+ "x-nullable": false
+ },
+ "goreScore": {
+ "format": "double",
+ "description": "Score from 0 to 1 that indicates how gory is the image.",
+ "type": "number",
+ "x-nullable": false
+ }
+ },
+ "x-nullable": true
+ },
+ "ColorInfo": {
+ "description": "An object providing additional metadata describing color attributes.",
+ "type": "object",
+ "properties": {
+ "dominantColorForeground": {
+ "description": "Possible dominant foreground color.",
+ "type": "string",
+ "x-nullable": true
+ },
+ "dominantColorBackground": {
+ "description": "Possible dominant background color.",
+ "type": "string",
+ "x-nullable": true
+ },
+ "dominantColors": {
+ "description": "An array of possible dominant colors.",
+ "type": "array",
+ "items": {
+ "type": "string",
+ "x-nullable": true
+ },
+ "x-nullable": true
+ },
+ "accentColor": {
+ "description": "Possible accent color.",
+ "type": "string",
+ "x-nullable": true
+ },
+ "isBWImg": {
+ "description": "A value indicating if the image is black and white.",
+ "type": "boolean",
+ "x-nullable": false
+ }
+ },
+ "x-nullable": true
+ },
+ "ImageType": {
+ "description": "An object providing possible image types and matching confidence levels.",
+ "type": "object",
+ "properties": {
+ "clipArtType": {
+ "format": "int32",
+ "description": "Confidence level that the image is a clip art.",
+ "type": "integer",
+ "x-nullable": false
+ },
+ "lineDrawingType": {
+ "format": "int32",
+ "description": "Confidence level that the image is a line drawing.",
+ "type": "integer",
+ "x-nullable": false
+ }
+ },
+ "x-nullable": true
+ },
+ "ImageTag": {
+ "description": "An entity observation in the image, along with the confidence score.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "Name of the entity.",
+ "type": "string",
+ "x-nullable": true
+ },
+ "confidence": {
+ "format": "double",
+ "description": "The level of confidence that the entity was observed.",
+ "type": "number",
+ "x-nullable": false
+ },
+ "hint": {
+ "description": "Optional hint/details for this tag.",
+ "type": "string",
+ "x-nullable": true
+ }
+ },
+ "x-nullable": true
+ },
+ "ImageDescriptionDetails": {
+ "description": "A collection of content tags, along with a list of captions sorted by confidence level, and image metadata.",
+ "type": "object",
+ "properties": {
+ "tags": {
+ "description": "A collection of image tags.",
+ "type": "array",
+ "items": {
+ "type": "string",
+ "x-nullable": true
+ },
+ "x-nullable": true
+ },
+ "captions": {
+ "description": "A list of captions, sorted by confidence level.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ImageCaption"
+ },
+ "x-nullable": true
+ }
+ },
+ "x-nullable": true
+ },
+ "FaceDescription": {
+ "description": "An object describing a face identified in the image.",
+ "type": "object",
+ "properties": {
+ "age": {
+ "format": "int32",
+ "description": "Possible age of the face.",
+ "type": "integer",
+ "x-nullable": false
+ },
+ "gender": {
+ "description": "Possible gender of the face.",
+ "enum": [
+ "Male",
+ "Female"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "Gender",
+ "modelAsString": false
+ },
+ "x-nullable": true
+ },
+ "faceRectangle": {
+ "$ref": "#/definitions/FaceRectangle",
+ "description": "Rectangle in the image containing the identified face."
+ }
+ },
+ "x-nullable": true
+ },
+ "DetectedObject": {
+ "description": "An object detected in an image.",
+ "type": "object",
+ "properties": {
+ "rectangle": {
+ "$ref": "#/definitions/BoundingRect",
+ "description": "Approximate location of the detected object.",
+ "readOnly": true
+ },
+ "object": {
+ "description": "Label for the object.",
+ "type": "string",
+ "x-nullable": true
+ },
+ "confidence": {
+ "format": "double",
+ "description": "Confidence score of having observed the object in the image, as a value ranging from 0 to 1.",
+ "type": "number",
+ "x-nullable": false
+ },
+ "parent": {
+ "$ref": "#/definitions/ObjectHierarchy",
+ "description": "The parent object, from a taxonomy perspective.\r\nThe parent object is a more generic form of this object. For example, a 'bulldog' would have a parent of 'dog'."
+ }
+ },
+ "x-nullable": true
+ },
+ "DetectedBrand": {
+ "description": "A brand detected in an image.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "Label for the brand.",
+ "type": "string",
+ "readOnly": true,
+ "x-nullable": true
+ },
+ "confidence": {
+ "format": "double",
+ "description": "Confidence score of having observed the brand in the image, as a value ranging from 0 to 1.",
+ "type": "number",
+ "readOnly": true,
+ "x-nullable": false
+ },
+ "rectangle": {
+ "$ref": "#/definitions/BoundingRect",
+ "description": "Approximate location of the detected brand.",
+ "readOnly": true
+ }
+ },
+ "x-nullable": true
+ },
+ "ImageMetadata": {
+ "description": "Image metadata.",
+ "type": "object",
+ "properties": {
+ "width": {
+ "format": "int32",
+ "description": "Image width, in pixels.",
+ "type": "integer",
+ "x-nullable": false
+ },
+ "height": {
+ "format": "int32",
+ "description": "Image height, in pixels.",
+ "type": "integer",
+ "x-nullable": false
+ },
+ "format": {
+ "description": "Image format.",
+ "type": "string",
+ "x-nullable": true
+ }
+ },
+ "x-nullable": true
+ },
+ "CategoryDetail": {
+ "description": "An object describing additional category details.",
+ "type": "object",
+ "properties": {
+ "celebrities": {
+ "description": "An array of celebrities if any identified.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/CelebritiesModel"
+ },
+ "x-nullable": true
+ },
+ "landmarks": {
+ "description": "An array of landmarks if any identified.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/LandmarksModel"
+ },
+ "x-nullable": true
+ }
+ },
+ "x-nullable": true
+ },
+ "ImageCaption": {
+ "description": "An image caption, i.e. a brief description of what the image depicts.",
+ "type": "object",
+ "properties": {
+ "text": {
+ "description": "The text of the caption.",
+ "type": "string",
+ "x-nullable": true
+ },
+ "confidence": {
+ "format": "double",
+ "description": "The level of confidence the service has in the caption.",
+ "type": "number",
+ "x-nullable": false
+ }
+ },
+ "x-nullable": true
+ },
+ "FaceRectangle": {
+ "description": "An object describing face rectangle.",
+ "type": "object",
+ "properties": {
+ "left": {
+ "format": "int32",
+ "description": "X-coordinate of the top left point of the face, in pixels.",
+ "type": "integer",
+ "x-nullable": false
+ },
+ "top": {
+ "format": "int32",
+ "description": "Y-coordinate of the top left point of the face, in pixels.",
+ "type": "integer",
+ "x-nullable": false
+ },
+ "width": {
+ "format": "int32",
+ "description": "Width measured from the top-left point of the face, in pixels.",
+ "type": "integer",
+ "x-nullable": false
+ },
+ "height": {
+ "format": "int32",
+ "description": "Height measured from the top-left point of the face, in pixels.",
+ "type": "integer",
+ "x-nullable": false
+ }
+ },
+ "x-nullable": true
+ },
+ "BoundingRect": {
+ "description": "A bounding box for an area inside an image.",
+ "type": "object",
+ "properties": {
+ "x": {
+ "format": "int32",
+ "description": "X-coordinate of the top left point of the area, in pixels.",
+ "type": "integer",
+ "x-nullable": false
+ },
+ "y": {
+ "format": "int32",
+ "description": "Y-coordinate of the top left point of the area, in pixels.",
+ "type": "integer",
+ "x-nullable": false
+ },
+ "w": {
+ "format": "int32",
+ "description": "Width measured from the top-left point of the area, in pixels.",
+ "type": "integer",
+ "x-nullable": false
+ },
+ "h": {
+ "format": "int32",
+ "description": "Height measured from the top-left point of the area, in pixels.",
+ "type": "integer",
+ "x-nullable": false
+ }
+ },
+ "x-nullable": false
+ },
+ "ObjectHierarchy": {
+ "description": "An object detected inside an image.",
+ "type": "object",
+ "properties": {
+ "object": {
+ "description": "Label for the object.",
+ "type": "string",
+ "x-nullable": true
+ },
+ "confidence": {
+ "format": "double",
+ "description": "Confidence score of having observed the object in the image, as a value ranging from 0 to 1.",
+ "type": "number",
+ "x-nullable": false
+ },
+ "parent": {
+ "$ref": "#/definitions/ObjectHierarchy",
+ "description": "The parent object, from a taxonomy perspective.\r\nThe parent object is a more generic form of this object. For example, a 'bulldog' would have a parent of 'dog'."
+ }
+ },
+ "x-nullable": true
+ },
+ "CelebritiesModel": {
+ "description": "An object describing possible celebrity identification.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "Name of the celebrity.",
+ "type": "string",
+ "x-nullable": true
+ },
+ "confidence": {
+ "format": "double",
+ "description": "Confidence level for the celebrity recognition as a value ranging from 0 to 1.",
+ "type": "number",
+ "x-nullable": false
+ },
+ "faceRectangle": {
+ "$ref": "#/definitions/FaceRectangle",
+ "description": "Location of the identified face in the image."
+ }
+ },
+ "x-nullable": true
+ },
+ "LandmarksModel": {
+ "description": "A landmark recognized in the image.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "Name of the landmark.",
+ "type": "string",
+ "x-nullable": true
+ },
+ "confidence": {
+ "format": "double",
+ "description": "Confidence level for the landmark recognition as a value ranging from 0 to 1.",
+ "type": "number",
+ "x-nullable": false
+ }
+ },
+ "x-nullable": true
+ },
+ "ImageDescription": {
+ "description": "A collection of content tags, along with a list of captions sorted by confidence level, and image metadata.",
+ "type": "object",
+ "properties": {
+ "description": {
+ "$ref": "#/definitions/ImageDescriptionDetails",
+ "description": "A collection of content tags, along with a list of captions sorted by confidence level, and image metadata.",
+ "x-ms-client-flatten": true
+ },
+ "requestId": {
+ "description": "Id of the REST API request.",
+ "type": "string",
+ "x-nullable": true
+ },
+ "metadata": {
+ "$ref": "#/definitions/ImageMetadata"
+ }
+ },
+ "x-nullable": true
+ },
+ "DetectResult": {
+ "description": "Result of a DetectImage call.",
+ "type": "object",
+ "properties": {
+ "objects": {
+ "description": "An array of detected objects.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/DetectedObject"
+ },
+ "readOnly": true,
+ "x-nullable": true
+ },
+ "requestId": {
+ "description": "Id of the REST API request.",
+ "type": "string",
+ "x-nullable": true
+ },
+ "metadata": {
+ "$ref": "#/definitions/ImageMetadata"
+ }
+ },
+ "x-nullable": true
+ },
+ "ListModelsResult": {
+ "description": "Result of the List Domain Models operation.",
+ "type": "object",
+ "properties": {
+ "models": {
+ "description": "An array of supported models.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ModelDescription"
+ },
+ "readOnly": true,
+ "x-nullable": true
+ }
+ },
+ "x-nullable": true
+ },
+ "ModelDescription": {
+ "description": "An object describing supported model by name and categories.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "The name of the model.",
+ "type": "string",
+ "x-nullable": true
+ },
+ "categories": {
+ "description": "Categories of the model.",
+ "type": "array",
+ "items": {
+ "type": "string",
+ "x-nullable": true
+ },
+ "x-nullable": true
+ }
+ },
+ "x-nullable": true
+ },
+ "DomainModelResults": {
+ "description": "Result of image analysis using a specific domain model including additional metadata.",
+ "type": "object",
+ "properties": {
+ "result": {
+ "description": "Model-specific response.",
+ "type": "object",
+ "x-ms-client-flatten": true
+ },
+ "requestId": {
+ "description": "Id of the REST API request.",
+ "type": "string",
+ "x-nullable": true
+ },
+ "metadata": {
+ "$ref": "#/definitions/ImageMetadata"
+ }
+ },
+ "x-nullable": true
+ },
+ "OcrResult": {
+ "type": "object",
+ "properties": {
+ "language": {
+ "description": "The BCP-47 language code of the text in the image.",
+ "type": "string",
+ "x-nullable": true
+ },
+ "textAngle": {
+ "format": "double",
+ "description": "The angle, in radians, of the detected text with respect to the closest horizontal or vertical direction. After rotating the input image clockwise by this angle, the recognized text lines become horizontal or vertical. In combination with the orientation property it can be used to overlay recognition results correctly on the original image, by rotating either the original image or recognition results by a suitable angle around the center of the original image. If the angle cannot be confidently detected, this property is not present. If the image contains text at different angles, only part of the text will be recognized correctly.",
+ "type": "number",
+ "x-nullable": false
+ },
+ "orientation": {
+ "description": "Orientation of the text recognized in the image, if requested. The value (up, down, left, or right) refers to the direction that the top of the recognized text is facing, after the image has been rotated around its center according to the detected text angle (see textAngle property).\r\nIf detection of the orientation was not requested, or no text is detected, the value is 'NotDetected'.",
+ "type": "string",
+ "x-nullable": true
+ },
+ "regions": {
+ "description": "An array of objects, where each object represents a region of recognized text.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/OcrRegion"
+ },
+ "x-nullable": true
+ }
+ },
+ "x-nullable": true
+ },
+ "OcrRegion": {
+ "description": "A region consists of multiple lines (e.g. a column of text in a multi-column document).",
+ "type": "object",
+ "properties": {
+ "boundingBox": {
+ "description": "Bounding box of a recognized region. The four integers represent the x-coordinate of the left edge, the y-coordinate of the top edge, width, and height of the bounding box, in the coordinate system of the input image, after it has been rotated around its center according to the detected text angle (see textAngle property), with the origin at the top-left corner, and the y-axis pointing down.",
+ "type": "string",
+ "x-nullable": true
+ },
+ "lines": {
+ "description": "An array of recognized lines of text.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/OcrLine"
+ },
+ "x-nullable": true
+ }
+ },
+ "x-nullable": true
+ },
+ "OcrLine": {
+ "description": "An object describing a single recognized line of text.",
+ "type": "object",
+ "properties": {
+ "boundingBox": {
+ "description": "Bounding box of a recognized line. The four integers represent the x-coordinate of the left edge, the y-coordinate of the top edge, width, and height of the bounding box, in the coordinate system of the input image, after it has been rotated around its center according to the detected text angle (see textAngle property), with the origin at the top-left corner, and the y-axis pointing down.",
+ "type": "string",
+ "x-nullable": true
+ },
+ "words": {
+ "description": "An array of objects, where each object represents a recognized word.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/OcrWord"
+ },
+ "x-nullable": true
+ }
+ },
+ "x-nullable": true
+ },
+ "OcrWord": {
+ "description": "Information on a recognized word.",
+ "type": "object",
+ "properties": {
+ "boundingBox": {
+ "description": "Bounding box of a recognized word. The four integers represent the x-coordinate of the left edge, the y-coordinate of the top edge, width, and height of the bounding box, in the coordinate system of the input image, after it has been rotated around its center according to the detected text angle (see textAngle property), with the origin at the top-left corner, and the y-axis pointing down.",
+ "type": "string",
+ "x-nullable": true
+ },
+ "text": {
+ "description": "String value of a recognized word.",
+ "type": "string",
+ "x-nullable": true
+ }
+ },
+ "x-nullable": true
+ },
+ "TagResult": {
+ "description": "The results of a image tag operation, including any tags and image metadata.",
+ "type": "object",
+ "properties": {
+ "tags": {
+ "description": "A list of tags with confidence level.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ImageTag"
+ },
+ "x-nullable": true
+ },
+ "requestId": {
+ "description": "Id of the REST API request.",
+ "type": "string",
+ "x-nullable": true
+ },
+ "metadata": {
+ "$ref": "#/definitions/ImageMetadata"
+ }
+ },
+ "x-nullable": true
+ },
+ "AreaOfInterestResult": {
+ "description": "Result of AreaOfInterest operation.",
+ "type": "object",
+ "properties": {
+ "areaOfInterest": {
+ "$ref": "#/definitions/BoundingRect",
+ "description": "A bounding box for an area of interest inside an image.",
+ "readOnly": true
+ },
+ "requestId": {
+ "description": "Id of the REST API request.",
+ "type": "string",
+ "x-nullable": true
+ },
+ "metadata": {
+ "$ref": "#/definitions/ImageMetadata"
+ }
+ },
+ "x-nullable": true
+ },
+ "ImageUrl": {
+ "required": [
+ "url"
+ ],
+ "type": "object",
+ "properties": {
+ "url": {
+ "description": "Publicly reachable URL of an image.",
+ "type": "string"
+ }
+ }
+ },
+ "ComputerVisionError": {
+ "description": "Details about the API request error.",
+ "required": [
+ "code",
+ "message"
+ ],
+ "type": "object",
+ "properties": {
+ "code": {
+ "description": "The error code.",
+ "enum": [
+ "InvalidImageFormat",
+ "UnsupportedMediaType",
+ "InvalidImageUrl",
+ "NotSupportedFeature",
+ "NotSupportedImage",
+ "Timeout",
+ "InternalServerError",
+ "InvalidImageSize",
+ "BadArgument",
+ "DetectFaceError",
+ "NotSupportedLanguage",
+ "InvalidThumbnailSize",
+ "InvalidDetails",
+ "InvalidModel",
+ "CancelledRequest",
+ "NotSupportedVisualFeature",
+ "FailedToProcess",
+ "Unspecified",
+ "StorageException"
+ ],
+ "x-ms-enum": {
+ "name": "ComputerVisionErrorCodes",
+ "modelAsString": true
+ }
+ },
+ "message": {
+ "description": "A message explaining the error reported by the service.",
+ "type": "string"
+ },
+ "requestId": {
+ "description": "A unique request identifier.",
+ "type": "string"
+ }
+ }
+ },
+ "LandmarkResults": {
+ "description": "Result of domain-specific classifications for the domain of landmarks.",
+ "type": "object",
+ "properties": {
+ "landmarks": {
+ "description": "List of landmarks recognized in the image.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/LandmarksModel"
+ },
+ "x-nullable": true
+ },
+ "requestId": {
+ "description": "Id of the REST API request.",
+ "type": "string",
+ "x-nullable": true
+ },
+ "metadata": {
+ "$ref": "#/definitions/ImageMetadata"
+ }
+ },
+ "x-nullable": true
+ },
+ "CelebrityResults": {
+ "description": "Result of domain-specific classifications for the domain of celebrities.",
+ "type": "object",
+ "properties": {
+ "celebrities": {
+ "description": "List of celebrities recognized in the image.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/CelebritiesModel"
+ },
+ "x-nullable": true
+ },
+ "requestId": {
+ "description": "Id of the REST API request.",
+ "type": "string",
+ "x-nullable": true
+ },
+ "metadata": {
+ "$ref": "#/definitions/ImageMetadata"
+ }
+ },
+ "x-nullable": true
+ }
+ },
+ "parameters": {
+ "Endpoint": {
+ "name": "Endpoint",
+ "in": "path",
+ "description": "Supported Cognitive Services endpoints.",
+ "required": true,
+ "type": "string",
+ "x-ms-parameter-location": "client",
+ "x-ms-skip-url-encoding": true
+ },
+ "ImageStream": {
+ "name": "Image",
+ "in": "body",
+ "description": "An image stream.",
+ "required": true,
+ "schema": {
+ "format": "file",
+ "type": "object"
+ },
+ "x-ms-parameter-location": "method"
+ },
+ "ImageUrl": {
+ "name": "ImageUrl",
+ "in": "body",
+ "description": "A JSON document with a URL pointing to the image that is to be analyzed.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/ImageUrl"
+ },
+ "x-ms-parameter-location": "method",
+ "x-ms-client-flatten": true
+ },
+ "ServiceLanguage": {
+ "name": "language",
+ "in": "query",
+ "description": "The desired language for output generation. If this parameter is not specified, the default value is "en".Supported languages:en - English, Default. es - Spanish, ja - Japanese, pt - Portuguese, zh - Simplified Chinese.",
+ "required": false,
+ "type": "string",
+ "default": "en",
+ "enum": [
+ "en",
+ "es",
+ "ja",
+ "pt",
+ "zh"
+ ],
+ "x-ms-parameter-location": "method",
+ "x-nullable": false
+ },
+ "DescriptionExclude": {
+ "name": "descriptionExclude",
+ "in": "query",
+ "description": "Turn off specified domain models when generating the description.",
+ "required": false,
+ "type": "array",
+ "items": {
+ "type": "string",
+ "enum": [
+ "Celebrities",
+ "Landmarks"
+ ],
+ "x-nullable": false,
+ "x-ms-enum": {
+ "name": "DescriptionExclude",
+ "modelAsString": false
+ }
+ },
+ "collectionFormat": "csv",
+ "x-nullable": true,
+ "x-ms-parameter-location": "method"
+ },
+ "OcrLanguage": {
+ "name": "language",
+ "in": "query",
+ "description": "The BCP-47 language code of the text to be detected in the image. The default value is 'unk'.",
+ "required": false,
+ "type": "string",
+ "default": "unk",
+ "enum": [
+ "unk",
+ "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-parameter-location": "method",
+ "x-nullable": false,
+ "x-ms-enum": {
+ "name": "OcrLanguages",
+ "modelAsString": false
+ }
+ },
+ "VisualFeatures": {
+ "name": "visualFeatures",
+ "in": "query",
+ "description": "A string indicating what visual feature types to return. Multiple values should be comma-separated. Valid visual feature types include: Categories - categorizes image content according to a taxonomy defined in documentation. Tags - tags the image with a detailed list of words related to the image content. Description - describes the image content with a complete English sentence. Faces - detects if faces are present. If present, generate coordinates, gender and age. ImageType - detects if image is clipart or a line drawing. Color - determines the accent color, dominant color, and whether an image is black&white. Adult - detects if the image is pornographic in nature (depicts nudity or a sex act), or is gory (depicts extreme violence or blood). Sexually suggestive content (aka racy content) is also detected. Objects - detects various objects within an image, including the approximate location. The Objects argument is only available in English. Brands - detects various brands within an image, including the approximate location. The Brands argument is only available in English.",
+ "required": false,
+ "type": "array",
+ "items": {
+ "type": "string",
+ "enum": [
+ "ImageType",
+ "Faces",
+ "Adult",
+ "Categories",
+ "Color",
+ "Tags",
+ "Description",
+ "Objects",
+ "Brands"
+ ],
+ "x-nullable": false,
+ "x-ms-enum": {
+ "name": "VisualFeatureTypes",
+ "modelAsString": false
+ }
+ },
+ "collectionFormat": "csv",
+ "x-ms-parameter-location": "method"
+ },
+ "DetectOrientation": {
+ "name": "detectOrientation",
+ "in": "query",
+ "description": "Whether detect the text orientation in the image. With detectOrientation=true the OCR service tries to detect the image orientation and correct it before further processing (e.g. if it's upside-down).",
+ "required": true,
+ "type": "boolean",
+ "default": true,
+ "x-ms-parameter-location": "method"
+ }
+ },
+ "x-ms-paths": {
+ "/analyze?overload=stream": {
+ "post": {
+ "description": "This operation extracts a rich set of visual features based on the image content.\r\nTwo input methods are supported -- (1) Uploading an image or (2) specifying an image URL. Within your request, there is an optional parameter to allow you to choose which features to return. By default, image categories are returned in the response.\r\nA successful response will be returned in JSON. If the request failed, the response will contain an error code and a message to help understand what went wrong.",
+ "operationId": "AnalyzeImageInStream",
+ "consumes": [
+ "application/octet-stream",
+ "multipart/form-data"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/VisualFeatures"
+ },
+ {
+ "name": "details",
+ "in": "query",
+ "description": "A string indicating which domain-specific details to return. Multiple values should be comma-separated. Valid visual feature types include: Celebrities - identifies celebrities if detected in the image, Landmarks - identifies notable landmarks in the image.",
+ "required": false,
+ "type": "array",
+ "items": {
+ "type": "string",
+ "enum": [
+ "Celebrities",
+ "Landmarks"
+ ],
+ "x-nullable": false,
+ "x-ms-enum": {
+ "name": "Details",
+ "modelAsString": false
+ }
+ },
+ "collectionFormat": "csv",
+ "x-nullable": true
+ },
+ {
+ "$ref": "#/parameters/ServiceLanguage"
+ },
+ {
+ "$ref": "#/parameters/DescriptionExclude"
+ },
+ {
+ "$ref": "#/parameters/ImageStream"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The response include the extracted features in JSON format. Here is the definitions for enumeration types:\r\n ClipartType\r\n Non - clipart = 0, ambiguous = 1, normal - clipart = 2, good - clipart = 3. LineDrawingTypeNon - LineDrawing = 0, LineDrawing = 1.",
+ "schema": {
+ "$ref": "#/definitions/ImageAnalysis"
+ }
+ },
+ "default": {
+ "description": "Error response.",
+ "schema": {
+ "$ref": "#/definitions/ComputerVisionError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Successful AnalyzeImage request": {
+ "$ref": "./examples/SuccessfulAnalyzeImageWithStream.json"
+ }
+ }
+ }
+ },
+ "/areaOfInterest?overload=stream": {
+ "post": {
+ "description": "This operation returns a bounding box around the most important area of the image.\r\nA successful response will be returned in JSON. If the request failed, the response contains an error code and a message to help determine what went wrong.\r\nUpon failure, the error code and an error message are returned. The error code could be one of InvalidImageUrl, InvalidImageFormat, InvalidImageSize, NotSupportedImage, FailedToProcess, Timeout, or InternalServerError.",
+ "operationId": "GetAreaOfInterestInStream",
+ "consumes": [
+ "application/octet-stream",
+ "multipart/form-data"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/ImageStream"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The response includes the extracted area of interest in JSON format.",
+ "schema": {
+ "$ref": "#/definitions/AreaOfInterestResult"
+ }
+ },
+ "default": {
+ "description": "Error response.",
+ "schema": {
+ "$ref": "#/definitions/ComputerVisionError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Successful GetAreaOfInterest request": {
+ "$ref": "./examples/SuccessfulGetAreaOfInterestWithStream.json"
+ }
+ }
+ }
+ },
+ "/describe?overload=stream": {
+ "post": {
+ "description": "This operation generates a description of an image in human readable language with complete sentences. The description is based on a collection of content tags, which are also returned by the operation. More than one description can be generated for each image. Descriptions are ordered by their confidence score. Descriptions may include results from celebrity and landmark domain models, if applicable.\r\nTwo input methods are supported -- (1) Uploading an image or (2) specifying an image URL.\r\nA successful response will be returned in JSON. If the request failed, the response will contain an error code and a message to help understand what went wrong.",
+ "operationId": "DescribeImageInStream",
+ "consumes": [
+ "application/octet-stream",
+ "multipart/form-data"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "name": "maxCandidates",
+ "in": "query",
+ "description": "Maximum number of candidate descriptions to be returned. The default is 1.",
+ "required": false,
+ "type": "integer",
+ "format": "int32",
+ "default": 1,
+ "x-nullable": true
+ },
+ {
+ "$ref": "#/parameters/ServiceLanguage"
+ },
+ {
+ "$ref": "#/parameters/DescriptionExclude"
+ },
+ {
+ "$ref": "#/parameters/ImageStream"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Image description object.",
+ "schema": {
+ "$ref": "#/definitions/ImageDescription"
+ }
+ },
+ "default": {
+ "description": "Error response.",
+ "schema": {
+ "$ref": "#/definitions/ComputerVisionError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Successful DescribeImage request": {
+ "$ref": "./examples/SuccessfulDescribeImageWithStream.json"
+ }
+ }
+ }
+ },
+ "/detect?overload=stream": {
+ "post": {
+ "description": "Performs object detection on the specified image.\r\nTwo input methods are supported -- (1) Uploading an image or (2) specifying an image URL.\r\nA successful response will be returned in JSON. If the request failed, the response will contain an error code and a message to help understand what went wrong.",
+ "operationId": "DetectObjectsInStream",
+ "consumes": [
+ "application/octet-stream",
+ "multipart/form-data"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/ImageStream"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The response include the detected objects in JSON format.",
+ "schema": {
+ "$ref": "#/definitions/DetectResult"
+ }
+ },
+ "default": {
+ "description": "Error response.",
+ "schema": {
+ "$ref": "#/definitions/ComputerVisionError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Successful DetectObjects request": {
+ "$ref": "./examples/SuccessfulDetectObjectsWithStream.json"
+ }
+ }
+ }
+ },
+ "/generateThumbnail?overload=stream": {
+ "post": {
+ "description": "This operation generates a thumbnail image with the user-specified width and height. By default, the service analyzes the image, identifies the region of interest (ROI), and generates smart cropping coordinates based on the ROI. Smart cropping helps when you specify an aspect ratio that differs from that of the input image.\r\nA successful response contains the thumbnail image binary. If the request failed, the response contains an error code and a message to help determine what went wrong.\r\nUpon failure, the error code and an error message are returned. The error code could be one of InvalidImageUrl, InvalidImageFormat, InvalidImageSize, InvalidThumbnailSize, NotSupportedImage, FailedToProcess, Timeout, or InternalServerError.",
+ "operationId": "GenerateThumbnailInStream",
+ "consumes": [
+ "application/octet-stream",
+ "multipart/form-data"
+ ],
+ "produces": [
+ "application/octet-stream"
+ ],
+ "parameters": [
+ {
+ "name": "width",
+ "in": "query",
+ "description": "Width of the thumbnail, in pixels. It must be between 1 and 1024. Recommended minimum of 50.",
+ "required": true,
+ "type": "integer",
+ "format": "int32",
+ "maximum": 1024,
+ "minimum": 1,
+ "x-nullable": false
+ },
+ {
+ "name": "height",
+ "in": "query",
+ "description": "Height of the thumbnail, in pixels. It must be between 1 and 1024. Recommended minimum of 50.",
+ "required": true,
+ "type": "integer",
+ "format": "int32",
+ "maximum": 1024,
+ "minimum": 1,
+ "x-nullable": false
+ },
+ {
+ "name": "smartCropping",
+ "in": "query",
+ "description": "Boolean flag for enabling smart cropping.",
+ "required": false,
+ "type": "boolean",
+ "default": false,
+ "x-nullable": true
+ },
+ {
+ "$ref": "#/parameters/ImageStream"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The generated thumbnail in binary format.",
+ "schema": {
+ "type": "file"
+ }
+ },
+ "default": {
+ "description": "Error response.",
+ "schema": {
+ "$ref": "#/definitions/ComputerVisionError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Successful GenerateThumbnail request": {
+ "$ref": "./examples/SuccessfulGenerateThumbnailWithStream.json"
+ }
+ }
+ }
+ },
+ "/models/{model}/analyze?overload=stream": {
+ "post": {
+ "description": "This operation recognizes content within an image by applying a domain-specific model. The list of domain-specific models that are supported by the Computer Vision API can be retrieved using the /models GET request. Currently, the API provides following domain-specific models: celebrities, landmarks.\r\nTwo input methods are supported -- (1) Uploading an image or (2) specifying an image URL.\r\nA successful response will be returned in JSON.\r\nIf the request failed, the response will contain an error code and a message to help understand what went wrong.",
+ "operationId": "AnalyzeImageByDomainInStream",
+ "consumes": [
+ "application/octet-stream",
+ "multipart/form-data"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "name": "model",
+ "in": "path",
+ "description": "The domain-specific content to recognize.",
+ "required": true,
+ "type": "string",
+ "x-nullable": true
+ },
+ {
+ "$ref": "#/parameters/ServiceLanguage"
+ },
+ {
+ "$ref": "#/parameters/ImageStream"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Analysis result based on the domain model.",
+ "schema": {
+ "$ref": "#/definitions/DomainModelResults"
+ }
+ },
+ "default": {
+ "description": "Error response.",
+ "schema": {
+ "$ref": "#/definitions/ComputerVisionError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Successful AnalyzeImageByDomain request": {
+ "$ref": "./examples/SuccessfulAnalyzeImageByDomainWithStream.json"
+ }
+ }
+ }
+ },
+ "/ocr?overload=stream": {
+ "post": {
+ "description": "Optical Character Recognition (OCR) detects text in an image and extracts the recognized characters into a machine-usable character stream.\r\nUpon success, the OCR results will be returned.\r\nUpon failure, the error code together with an error message will be returned. The error code can be one of InvalidImageUrl, InvalidImageFormat, InvalidImageSize, NotSupportedImage, NotSupportedLanguage, or InternalServerError.",
+ "operationId": "RecognizePrintedTextInStream",
+ "consumes": [
+ "application/octet-stream",
+ "multipart/form-data"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/DetectOrientation"
+ },
+ {
+ "$ref": "#/parameters/OcrLanguage"
+ },
+ {
+ "$ref": "#/parameters/ImageStream"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The OCR results in the hierarchy of region/line/word. The results include text, bounding box for regions, lines and words. The angle, in radians, of the detected text with respect to the closest horizontal or vertical direction. After rotating the input image clockwise by this angle, the recognized text lines become horizontal or vertical. In combination with the orientation property it can be used to overlay recognition results correctly on the original image, by rotating either the original image or recognition results by a suitable angle around the center of the original image. If the angle cannot be confidently detected, this property is not present. If the image contains text at different angles, only part of the text will be recognized correctly.",
+ "schema": {
+ "$ref": "#/definitions/OcrResult"
+ }
+ },
+ "default": {
+ "description": "Error response.",
+ "schema": {
+ "$ref": "#/definitions/ComputerVisionError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Successful RecognizePrintedText request": {
+ "$ref": "./examples/SuccessfulRecognizePrintedTextWithStream.json"
+ }
+ }
+ }
+ },
+ "/tag?overload=stream": {
+ "post": {
+ "description": "This operation generates a list of words, or tags, that are relevant to the content of the supplied image. The Computer Vision API can return tags based on objects, living beings, scenery or actions found in images. Unlike categories, tags are not organized according to a hierarchical classification system, but correspond to image content. Tags may contain hints to avoid ambiguity or provide context, for example the tag \"ascomycete\" may be accompanied by the hint \"fungus\".\r\nTwo input methods are supported -- (1) Uploading an image or (2) specifying an image URL.\r\nA successful response will be returned in JSON. If the request failed, the response will contain an error code and a message to help understand what went wrong.",
+ "operationId": "TagImageInStream",
+ "consumes": [
+ "application/octet-stream",
+ "multipart/form-data"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/ServiceLanguage"
+ },
+ {
+ "$ref": "#/parameters/ImageStream"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Image tags object.",
+ "schema": {
+ "$ref": "#/definitions/TagResult"
+ }
+ },
+ "default": {
+ "description": "Error response.",
+ "schema": {
+ "$ref": "#/definitions/ComputerVisionError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Successful TagImage request": {
+ "$ref": "./examples/SuccessfulTagImageWithStream.json"
+ }
+ }
+ }
+ }
+ }
+}
diff --git a/specification/cognitiveservices/data-plane/ComputerVision/stable/v3.1/Ocr.json b/specification/cognitiveservices/data-plane/ComputerVision/stable/v3.1/Ocr.json
new file mode 100644
index 000000000000..9d0e2df9700a
--- /dev/null
+++ b/specification/cognitiveservices/data-plane/ComputerVision/stable/v3.1/Ocr.json
@@ -0,0 +1,452 @@
+{
+ "swagger": "2.0",
+ "info": {
+ "version": "3.1",
+ "title": "Computer Vision Client",
+ "description": "The Computer Vision API provides state-of-the-art algorithms to process images and return information. For example, it can be used to determine if an image contains mature content, or it can be used to find all the faces in an image. It also has other features like estimating dominant and accent colors, categorizing the content of images, and describing an image with complete English sentences. Additionally, it can also intelligently generate images thumbnails for displaying large images effectively."
+ },
+ "securityDefinitions": {
+ "apim_key": {
+ "type": "apiKey",
+ "name": "Ocp-Apim-Subscription-Key",
+ "in": "header"
+ }
+ },
+ "security": [
+ {
+ "apim_key": []
+ }
+ ],
+ "x-ms-parameterized-host": {
+ "hostTemplate": "{Endpoint}",
+ "useSchemePrefix": false,
+ "parameters": [
+ {
+ "$ref": "#/parameters/Endpoint"
+ }
+ ]
+ },
+ "host": "westcentralus.api.cognitive.microsoft.com",
+ "basePath": "/vision/v3.1",
+ "schemes": [
+ "https"
+ ],
+ "paths": {
+ "/read/analyze": {
+ "post": {
+ "description": "Use this interface to get the result of a Read operation, employing the state-of-the-art Optical Character Recognition (OCR) algorithms optimized for text-heavy documents. When you use the Read interface, the response contains a field called 'Operation-Location'. The 'Operation-Location' field contains the URL that you must use for your 'GetReadResult' operation to access OCR results.",
+ "operationId": "Read",
+ "parameters": [
+ {
+ "$ref": "#/parameters/OcrDetectionLanguage"
+ },
+ {
+ "$ref": "#/parameters/ImageUrl"
+ }
+ ],
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "responses": {
+ "202": {
+ "description": "The service has accepted the request and will start processing later.",
+ "headers": {
+ "Operation-Location": {
+ "description": "URL to query for status of the operation. The operation ID will expire in 48 hours. ",
+ "type": "string"
+ }
+ }
+ },
+ "default": {
+ "description": "Error response.",
+ "schema": {
+ "$ref": "#/definitions/ComputerVisionError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Successful Analyze request": {
+ "$ref": "./examples/SuccessfulReadWithUrl.json"
+ }
+ }
+ }
+ },
+ "/read/analyzeResults/{operationId}": {
+ "get": {
+ "description": "This interface is used for getting OCR results of Read operation. The URL to this interface should be retrieved from 'Operation-Location' field returned from Read interface.",
+ "operationId": "GetReadResult",
+ "parameters": [
+ {
+ "name": "operationId",
+ "in": "path",
+ "description": "Id of read operation returned in the response of the 'Read' interface.",
+ "required": true,
+ "type": "string",
+ "format": "uuid"
+ }
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "responses": {
+ "200": {
+ "description": "Returns the read operation status.",
+ "schema": {
+ "$ref": "#/definitions/ReadOperationResult"
+ }
+ },
+ "default": {
+ "description": "Error response.",
+ "schema": {
+ "$ref": "#/definitions/ComputerVisionError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Successful Get Read Result request": {
+ "$ref": "./examples/SuccessfulGetReadResult.json"
+ }
+ }
+ }
+ }
+ },
+ "x-ms-paths": {
+ "/read/analyze?overload=stream": {
+ "post": {
+ "description": "Use this interface to get the result of a Read operation, employing the state-of-the-art Optical Character Recognition (OCR) algorithms optimized for text-heavy documents. When you use the Read interface, the response contains a field called 'Operation-Location'. The 'Operation-Location' field contains the URL that you must use for your 'GetReadResult' operation to access OCR results.",
+ "operationId": "ReadInStream",
+ "parameters": [
+ {
+ "$ref": "#/parameters/OcrDetectionLanguage"
+ },
+ {
+ "$ref": "#/parameters/ImageStream"
+ }
+ ],
+ "consumes": [
+ "application/octet-stream"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "responses": {
+ "202": {
+ "description": "The service has accepted the request and will start processing later.",
+ "headers": {
+ "Operation-Location": {
+ "description": "URL to query for status of the operation. The operation ID will expire in 48 hours. ",
+ "type": "string"
+ }
+ }
+ },
+ "default": {
+ "description": "Error response.",
+ "schema": {
+ "$ref": "#/definitions/ComputerVisionError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Successful Analyze request": {
+ "$ref": "./examples/SuccessfulReadWithStream.json"
+ }
+ }
+ }
+ }
+ },
+ "definitions": {
+ "ReadOperationResult": {
+ "type": "object",
+ "description": "OCR result of the read operation.",
+ "properties": {
+ "status": {
+ "description": "Status of the read operation.",
+ "$ref": "#/definitions/OperationStatus"
+ },
+ "createdDateTime": {
+ "type": "string",
+ "description": "Get UTC date time the batch operation was submitted.",
+ "x-nullable": false
+ },
+ "lastUpdatedDateTime": {
+ "type": "string",
+ "description": "Get last updated UTC date time of this batch operation.",
+ "x-nullable": false
+ },
+ "analyzeResult": {
+ "description": "Analyze batch operation result.",
+ "type": "object",
+ "$ref": "#/definitions/analyzeResults"
+ }
+ }
+ },
+ "OperationStatus": {
+ "type": "string",
+ "description": "Status code of the text operation.",
+ "enum": [
+ "notStarted",
+ "running",
+ "failed",
+ "succeeded"
+ ],
+ "x-ms-enum": {
+ "name": "OperationStatusCodes",
+ "modelAsString": false
+ },
+ "x-nullable": false
+ },
+ "ReadResult": {
+ "description": "Text extracted from a page in the input document.",
+ "type": "object",
+ "required": [
+ "page",
+ "angle",
+ "width",
+ "height",
+ "unit",
+ "lines"
+ ],
+ "properties": {
+ "page": {
+ "description": "The 1-based page number of the recognition result.",
+ "type": "integer"
+ },
+ "language": {
+ "description": "The BCP-47 language code of the recognized text page.",
+ "type": "string"
+ },
+ "angle": {
+ "description": "The orientation of the image in degrees in the clockwise direction. Range between [-180, 180).",
+ "type": "number"
+ },
+ "width": {
+ "description": "The width of the image in pixels or the PDF in inches.",
+ "type": "number"
+ },
+ "height": {
+ "description": "The height of the image in pixels or the PDF in inches.",
+ "type": "number"
+ },
+ "unit": {
+ "description": "The unit used in the Width, Height and BoundingBox. For images, the unit is 'pixel'. For PDF, the unit is 'inch'.",
+ "type": "string",
+ "enum": [
+ "pixel",
+ "inch"
+ ],
+ "x-ms-enum": {
+ "name": "TextRecognitionResultDimensionUnit",
+ "modelAsString": false
+ },
+ "x-nullable": false
+ },
+ "lines": {
+ "description": "A list of recognized text lines.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/Line"
+ }
+ }
+ }
+ },
+ "analyzeResults": {
+ "description": "Analyze batch operation result.",
+ "type": "object",
+ "required": [
+ "version",
+ "readResults"
+ ],
+ "properties": {
+ "version": {
+ "description": "Version of schema used for this result.",
+ "type": "string"
+ },
+ "readResults": {
+ "description": "Text extracted from the input.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ReadResult"
+ }
+ }
+ }
+ },
+ "Line": {
+ "description": "An object representing a recognized text line.",
+ "type": "object",
+ "required": [
+ "boundingBox",
+ "text",
+ "words"
+ ],
+ "properties": {
+ "language": {
+ "description": "The BCP-47 language code of the recognized text line. Only provided where the language of the line differs from the page's.",
+ "type": "string"
+ },
+ "boundingBox": {
+ "description": "Bounding box of a recognized line.",
+ "$ref": "#/definitions/BoundingBox"
+ },
+ "text": {
+ "description": "The text content of the line.",
+ "type": "string"
+ },
+ "words": {
+ "description": "List of words in the text line.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/Word"
+ }
+ }
+ }
+ },
+ "Word": {
+ "description": "An object representing a recognized word.",
+ "type": "object",
+ "required": [
+ "boundingBox",
+ "text",
+ "confidence"
+ ],
+ "properties": {
+ "boundingBox": {
+ "description": "Bounding box of a recognized word.",
+ "$ref": "#/definitions/BoundingBox"
+ },
+ "text": {
+ "description": "The text content of the word.",
+ "type": "string"
+ },
+ "confidence": {
+ "description": "Qualitative confidence measure.",
+ "type": "number",
+ "format": "float"
+ }
+ }
+ },
+ "BoundingBox": {
+ "description": "Quadrangle bounding box, with coordinates in original image. The eight numbers represent the four points (x-coordinate, y-coordinate from the left-top corner of the image) of the detected rectangle from the left-top corner in the clockwise direction. For images, coordinates are in pixels. For PDF, coordinates are in inches.",
+ "type": "array",
+ "items": {
+ "type": "number",
+ "x-nullable": false
+ }
+ },
+ "ComputerVisionError": {
+ "description": "Details about the API request error.",
+ "required": [
+ "code",
+ "message"
+ ],
+ "type": "object",
+ "properties": {
+ "code": {
+ "description": "The error code.",
+ "enum": [
+ "InvalidImageFormat",
+ "UnsupportedMediaType",
+ "InvalidImageUrl",
+ "NotSupportedFeature",
+ "NotSupportedImage",
+ "Timeout",
+ "InternalServerError",
+ "InvalidImageSize",
+ "BadArgument",
+ "DetectFaceError",
+ "NotSupportedLanguage",
+ "InvalidThumbnailSize",
+ "InvalidDetails",
+ "InvalidModel",
+ "CancelledRequest",
+ "NotSupportedVisualFeature",
+ "FailedToProcess",
+ "Unspecified",
+ "StorageException"
+ ],
+ "x-ms-enum": {
+ "name": "ComputerVisionErrorCodes",
+ "modelAsString": true
+ }
+ },
+ "message": {
+ "description": "A message explaining the error reported by the service.",
+ "type": "string"
+ },
+ "requestId": {
+ "description": "A unique request identifier.",
+ "type": "string"
+ }
+ }
+ },
+ "ImageUrl": {
+ "type": "object",
+ "required": [
+ "url"
+ ],
+ "properties": {
+ "url": {
+ "description": "Publicly reachable URL of an image.",
+ "type": "string"
+ }
+ }
+ }
+ },
+ "parameters": {
+ "OcrDetectionLanguage": {
+ "name": "language",
+ "in": "query",
+ "description": "The BCP-47 language code of the text in the document. Currently, only English ('en'), Dutch (‘nl’), French (‘fr’), German (‘de’), Italian (‘it’), Portuguese (‘pt), and Spanish ('es') are supported. Read supports auto language identification and multi-language documents, so only provide a language code if you would like to force the documented to be processed as that specific language.",
+ "required": false,
+ "default": "en",
+ "x-ms-parameter-location": "method",
+ "type": "string",
+ "x-ms-enum": {
+ "name": "OcrDetectionLanguage",
+ "modelAsString": true
+ },
+ "enum": [
+ "en",
+ "es",
+ "fr",
+ "de",
+ "it",
+ "nl",
+ "pt"
+ ]
+ },
+ "ImageUrl": {
+ "name": "ImageUrl",
+ "in": "body",
+ "required": true,
+ "x-ms-parameter-location": "method",
+ "x-ms-client-flatten": true,
+ "description": "A JSON document with a URL pointing to the image that is to be analyzed.",
+ "schema": {
+ "$ref": "#/definitions/ImageUrl"
+ }
+ },
+ "ImageStream": {
+ "name": "Image",
+ "in": "body",
+ "required": true,
+ "x-ms-parameter-location": "method",
+ "description": "An image stream.",
+ "schema": {
+ "type": "object",
+ "format": "file"
+ }
+ },
+ "Endpoint": {
+ "name": "Endpoint",
+ "description": "Supported Cognitive Services endpoints.",
+ "x-ms-parameter-location": "client",
+ "required": true,
+ "type": "string",
+ "in": "path",
+ "x-ms-skip-url-encoding": true
+ }
+ }
+}
diff --git a/specification/cognitiveservices/data-plane/ComputerVision/stable/v3.1/examples/SuccessfulAnalyzeImageByDomainWithStream.json b/specification/cognitiveservices/data-plane/ComputerVision/stable/v3.1/examples/SuccessfulAnalyzeImageByDomainWithStream.json
new file mode 100644
index 000000000000..a3cd00555cc6
--- /dev/null
+++ b/specification/cognitiveservices/data-plane/ComputerVision/stable/v3.1/examples/SuccessfulAnalyzeImageByDomainWithStream.json
@@ -0,0 +1,34 @@
+{
+ "parameters": {
+ "Endpoint": "https://westus.api.cognitive.microsoft.com",
+ "Ocp-Apim-Subscription-Key": "{API key}",
+ "model": "Celebrities",
+ "Image": "{binary}"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "requestId": "f0027b4b-dc0d-4082-9228-1545ed246b03",
+ "metadata": {
+ "width": 1500,
+ "height": 1000,
+ "format": "Jpeg"
+ },
+ "result": {
+ "celebrities": [
+ {
+ "name": "Satya Nadella",
+ "faceRectangle": {
+ "left": 597,
+ "top": 162,
+ "width": 248,
+ "height": 248
+ },
+ "confidence": 0.999028444
+ }
+ ]
+ }
+ }
+ }
+ }
+}
diff --git a/specification/cognitiveservices/data-plane/ComputerVision/stable/v3.1/examples/SuccessfulAnalyzeImageByDomainWithUrl.json b/specification/cognitiveservices/data-plane/ComputerVision/stable/v3.1/examples/SuccessfulAnalyzeImageByDomainWithUrl.json
new file mode 100644
index 000000000000..92ead72b5f8f
--- /dev/null
+++ b/specification/cognitiveservices/data-plane/ComputerVision/stable/v3.1/examples/SuccessfulAnalyzeImageByDomainWithUrl.json
@@ -0,0 +1,36 @@
+{
+ "parameters": {
+ "Endpoint": "https://westus.api.cognitive.microsoft.com",
+ "Ocp-Apim-Subscription-Key": "{API key}",
+ "model": "Celebrities",
+ "ImageUrl": {
+ "url": "{url}"
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "requestId": "f0027b4b-dc0d-4082-9228-1545ed246b03",
+ "metadata": {
+ "width": 1500,
+ "height": 1000,
+ "format": "Jpeg"
+ },
+ "result": {
+ "celebrities": [
+ {
+ "name": "Satya Nadella",
+ "faceRectangle": {
+ "left": 597,
+ "top": 162,
+ "width": 248,
+ "height": 248
+ },
+ "confidence": 0.999028444
+ }
+ ]
+ }
+ }
+ }
+ }
+}
diff --git a/specification/cognitiveservices/data-plane/ComputerVision/stable/v3.1/examples/SuccessfulAnalyzeImageWithStream.json b/specification/cognitiveservices/data-plane/ComputerVision/stable/v3.1/examples/SuccessfulAnalyzeImageWithStream.json
new file mode 100644
index 000000000000..ba86791a7e36
--- /dev/null
+++ b/specification/cognitiveservices/data-plane/ComputerVision/stable/v3.1/examples/SuccessfulAnalyzeImageWithStream.json
@@ -0,0 +1,176 @@
+{
+ "parameters": {
+ "Endpoint": "https://westus.api.cognitive.microsoft.com",
+ "Ocp-Apim-Subscription-Key": "{API key}",
+ "visualFeatures": [
+ "Categories",
+ "Adult",
+ "Tags",
+ "Description",
+ "Faces",
+ "Color",
+ "ImageType",
+ "Objects",
+ "Brands"
+ ],
+ "details": [
+ "Celebrities",
+ "Landmarks"
+ ],
+ "language": "en",
+ "Image": "{binary}"
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": {
+ "categories": [
+ {
+ "name": "abstract_",
+ "score": 0.00390625
+ },
+ {
+ "name": "people_",
+ "score": 0.83984375,
+ "detail": {
+ "celebrities": [
+ {
+ "name": "Satya Nadella",
+ "faceRectangle": {
+ "left": 597,
+ "top": 162,
+ "width": 248,
+ "height": 248
+ },
+ "confidence": 0.999028444
+ }
+ ],
+ "landmarks": [
+ {
+ "name": "Forbidden City",
+ "confidence": 0.9978346
+ }
+ ]
+ }
+ }
+ ],
+ "adult": {
+ "isAdultContent": false,
+ "isRacyContent": false,
+ "isGoryContent": false,
+ "adultScore": 0.0934349000453949,
+ "racyScore": 0.068613491952419281,
+ "goreScore": 0.012872257380997575
+ },
+ "tags": [
+ {
+ "name": "person",
+ "confidence": 0.98979085683822632
+ },
+ {
+ "name": "man",
+ "confidence": 0.94493889808654785
+ },
+ {
+ "name": "outdoor",
+ "confidence": 0.938492476940155
+ },
+ {
+ "name": "window",
+ "confidence": 0.89513939619064331
+ },
+ {
+ "name": "pangolin",
+ "confidence": 0.7250059783791661,
+ "hint": "mammal"
+ }
+ ],
+ "description": {
+ "tags": [
+ "person",
+ "man",
+ "outdoor",
+ "window",
+ "glasses"
+ ],
+ "captions": [
+ {
+ "text": "Satya Nadella sitting on a bench",
+ "confidence": 0.48293603002174407
+ }
+ ]
+ },
+ "requestId": "0dbec5ad-a3d3-4f7e-96b4-dfd57efe967d",
+ "metadata": {
+ "width": 1500,
+ "height": 1000,
+ "format": "Jpeg"
+ },
+ "faces": [
+ {
+ "age": 44,
+ "gender": "Male",
+ "faceRectangle": {
+ "left": 593,
+ "top": 160,
+ "width": 250,
+ "height": 250
+ }
+ }
+ ],
+ "color": {
+ "dominantColorForeground": "Brown",
+ "dominantColorBackground": "Brown",
+ "dominantColors": [
+ "Brown",
+ "Black"
+ ],
+ "accentColor": "873B59",
+ "isBWImg": false
+ },
+ "imageType": {
+ "clipArtType": 0,
+ "lineDrawingType": 0
+ },
+ "objects": [
+ {
+ "rectangle": {
+ "x": 0,
+ "y": 0,
+ "w": 50,
+ "h": 50
+ },
+ "object": "tree",
+ "confidence": 0.9,
+ "parent": {
+ "object": "plant",
+ "confidence": 0.95
+ }
+ }
+ ],
+ "brands": [
+ {
+ "name": "Pepsi",
+ "confidence": 0.857,
+ "rectangle": {
+ "x": 489,
+ "y": 79,
+ "w": 161,
+ "h": 177
+ }
+ },
+ {
+ "name": "Coca-Cola",
+ "confidence": 0.893,
+ "rectangle": {
+ "x": 216,
+ "y": 55,
+ "w": 171,
+ "h": 372
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/cognitiveservices/data-plane/ComputerVision/stable/v3.1/examples/SuccessfulAnalyzeImageWithUrl.json b/specification/cognitiveservices/data-plane/ComputerVision/stable/v3.1/examples/SuccessfulAnalyzeImageWithUrl.json
new file mode 100644
index 000000000000..be78226e0e16
--- /dev/null
+++ b/specification/cognitiveservices/data-plane/ComputerVision/stable/v3.1/examples/SuccessfulAnalyzeImageWithUrl.json
@@ -0,0 +1,184 @@
+{
+ "parameters": {
+ "Endpoint": "https://westus.api.cognitive.microsoft.com",
+ "Ocp-Apim-Subscription-Key": "{API key}",
+ "visualFeatures": [
+ "Categories",
+ "Adult",
+ "Tags",
+ "Description",
+ "Faces",
+ "Color",
+ "ImageType",
+ "Objects",
+ "Brands"
+ ],
+ "details": [
+ "Celebrities",
+ "Landmarks"
+ ],
+ "language": "en",
+ "ImageUrl": {
+ "url": "{url}"
+ }
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": {
+ "categories": [
+ {
+ "name": "abstract_",
+ "score": 0.00390625
+ },
+ {
+ "name": "people_",
+ "score": 0.83984375,
+ "detail": {
+ "celebrities": [
+ {
+ "name": "Satya Nadella",
+ "faceRectangle": {
+ "left": 597,
+ "top": 162,
+ "width": 248,
+ "height": 248
+ },
+ "confidence": 0.999028444
+ }
+ ]
+ }
+ },
+ {
+ "name": "building_",
+ "score": 0.984375,
+ "detail": {
+ "landmarks": [
+ {
+ "name": "Forbidden City",
+ "confidence": 0.98290169239044189
+ }
+ ]
+ }
+ }
+ ],
+ "adult": {
+ "isAdultContent": false,
+ "isRacyContent": false,
+ "isGoryContent": false,
+ "adultScore": 0.0934349000453949,
+ "racyScore": 0.068613491952419281,
+ "goreScore": 0.012872257380997575
+ },
+ "tags": [
+ {
+ "name": "person",
+ "confidence": 0.98979085683822632
+ },
+ {
+ "name": "man",
+ "confidence": 0.94493889808654785
+ },
+ {
+ "name": "outdoor",
+ "confidence": 0.938492476940155
+ },
+ {
+ "name": "window",
+ "confidence": 0.89513939619064331
+ },
+ {
+ "name": "pangolin",
+ "confidence": 0.7250059783791661,
+ "hint": "mammal"
+ }
+ ],
+ "description": {
+ "tags": [
+ "person",
+ "man",
+ "outdoor",
+ "window",
+ "glasses"
+ ],
+ "captions": [
+ {
+ "text": "Satya Nadella sitting on a bench",
+ "confidence": 0.48293603002174407
+ }
+ ]
+ },
+ "requestId": "0dbec5ad-a3d3-4f7e-96b4-dfd57efe967d",
+ "metadata": {
+ "width": 1500,
+ "height": 1000,
+ "format": "Jpeg"
+ },
+ "faces": [
+ {
+ "age": 44,
+ "gender": "Male",
+ "faceRectangle": {
+ "left": 593,
+ "top": 160,
+ "width": 250,
+ "height": 250
+ }
+ }
+ ],
+ "color": {
+ "dominantColorForeground": "Brown",
+ "dominantColorBackground": "Brown",
+ "dominantColors": [
+ "Brown",
+ "Black"
+ ],
+ "accentColor": "873B59",
+ "isBWImg": false
+ },
+ "imageType": {
+ "clipArtType": 0,
+ "lineDrawingType": 0
+ },
+ "objects": [
+ {
+ "rectangle": {
+ "x": 0,
+ "y": 0,
+ "w": 50,
+ "h": 50
+ },
+ "object": "tree",
+ "confidence": 0.9,
+ "parent": {
+ "object": "plant",
+ "confidence": 0.95
+ }
+ }
+ ],
+ "brands": [
+ {
+ "name": "Pepsi",
+ "confidence": 0.857,
+ "rectangle": {
+ "x": 489,
+ "y": 79,
+ "w": 161,
+ "h": 177
+ }
+ },
+ {
+ "name": "Coca-Cola",
+ "confidence": 0.893,
+ "rectangle": {
+ "x": 216,
+ "y": 55,
+ "w": 171,
+ "h": 372
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/cognitiveservices/data-plane/ComputerVision/stable/v3.1/examples/SuccessfulDescribeImageWithStream.json b/specification/cognitiveservices/data-plane/ComputerVision/stable/v3.1/examples/SuccessfulDescribeImageWithStream.json
new file mode 100644
index 000000000000..071248140600
--- /dev/null
+++ b/specification/cognitiveservices/data-plane/ComputerVision/stable/v3.1/examples/SuccessfulDescribeImageWithStream.json
@@ -0,0 +1,44 @@
+{
+ "parameters": {
+ "Endpoint": "https://westus.api.cognitive.microsoft.com",
+ "Ocp-Apim-Subscription-Key": "{API key}",
+ "maxCandidates": 1,
+ "Image": "{binary}"
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": {
+ "description": {
+ "tags": [
+ "person",
+ "man",
+ "outdoor",
+ "window",
+ "glasses"
+ ],
+ "captions": [
+ {
+ "text": "Satya Nadella sitting on a bench",
+ "confidence": 0.48293603002174407
+ },
+ {
+ "text": "Satya Nadella is sitting on a bench",
+ "confidence": 0.40037006815422832
+ },
+ {
+ "text": "Satya Nadella sitting in front of a building",
+ "confidence": 0.38035155997373377
+ }
+ ]
+ },
+ "requestId": "ed2de1c6-fb55-4686-b0da-4da6e05d283f",
+ "metadata": {
+ "width": 1500,
+ "height": 1000,
+ "format": "Jpeg"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/cognitiveservices/data-plane/ComputerVision/stable/v3.1/examples/SuccessfulDescribeImageWithUrl.json b/specification/cognitiveservices/data-plane/ComputerVision/stable/v3.1/examples/SuccessfulDescribeImageWithUrl.json
new file mode 100644
index 000000000000..087ac0515231
--- /dev/null
+++ b/specification/cognitiveservices/data-plane/ComputerVision/stable/v3.1/examples/SuccessfulDescribeImageWithUrl.json
@@ -0,0 +1,46 @@
+{
+ "parameters": {
+ "Endpoint": "https://westus.api.cognitive.microsoft.com",
+ "Ocp-Apim-Subscription-Key": "{API key}",
+ "maxCandidates": 1,
+ "ImageUrl": {
+ "url": "{url}"
+ }
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": {
+ "description": {
+ "tags": [
+ "person",
+ "man",
+ "outdoor",
+ "window",
+ "glasses"
+ ],
+ "captions": [
+ {
+ "text": "Satya Nadella sitting on a bench",
+ "confidence": 0.48293603002174407
+ },
+ {
+ "text": "Satya Nadella is sitting on a bench",
+ "confidence": 0.40037006815422832
+ },
+ {
+ "text": "Satya Nadella sitting in front of a building",
+ "confidence": 0.38035155997373377
+ }
+ ]
+ },
+ "requestId": "ed2de1c6-fb55-4686-b0da-4da6e05d283f",
+ "metadata": {
+ "width": 1500,
+ "height": 1000,
+ "format": "Jpeg"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/cognitiveservices/data-plane/ComputerVision/stable/v3.1/examples/SuccessfulDetectObjectsWithStream.json b/specification/cognitiveservices/data-plane/ComputerVision/stable/v3.1/examples/SuccessfulDetectObjectsWithStream.json
new file mode 100644
index 000000000000..8f4ad7fd73aa
--- /dev/null
+++ b/specification/cognitiveservices/data-plane/ComputerVision/stable/v3.1/examples/SuccessfulDetectObjectsWithStream.json
@@ -0,0 +1,35 @@
+{
+ "parameters": {
+ "Endpoint": "https://westus.api.cognitive.microsoft.com",
+ "Ocp-Apim-Subscription-Key": "{API key}",
+ "Image": "{binary}"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "objects": [
+ {
+ "rectangle": {
+ "x": 0,
+ "y": 0,
+ "w": 50,
+ "h": 50
+ },
+ "object": "tree",
+ "confidence": 0.9,
+ "parent": {
+ "object": "plant",
+ "confidence": 0.95
+ }
+ }
+ ],
+ "requestId": "1ad0e45e-b7b4-4be3-8042-53be96103337",
+ "metadata": {
+ "width": 100,
+ "height": 100,
+ "format": "Jpeg"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/cognitiveservices/data-plane/ComputerVision/stable/v3.1/examples/SuccessfulDetectObjectsWithUrl.json b/specification/cognitiveservices/data-plane/ComputerVision/stable/v3.1/examples/SuccessfulDetectObjectsWithUrl.json
new file mode 100644
index 000000000000..7ea387eb41be
--- /dev/null
+++ b/specification/cognitiveservices/data-plane/ComputerVision/stable/v3.1/examples/SuccessfulDetectObjectsWithUrl.json
@@ -0,0 +1,37 @@
+{
+ "parameters": {
+ "Endpoint": "https://westus.api.cognitive.microsoft.com",
+ "Ocp-Apim-Subscription-Key": "{API key}",
+ "ImageUrl": {
+ "url": "{url}"
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "objects": [
+ {
+ "rectangle": {
+ "x": 0,
+ "y": 0,
+ "w": 50,
+ "h": 50
+ },
+ "object": "tree",
+ "confidence": 0.9,
+ "parent": {
+ "object": "plant",
+ "confidence": 0.95
+ }
+ }
+ ],
+ "requestId": "1ad0e45e-b7b4-4be3-8042-53be96103337",
+ "metadata": {
+ "width": 100,
+ "height": 100,
+ "format": "Jpeg"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/cognitiveservices/data-plane/ComputerVision/stable/v3.1/examples/SuccessfulGenerateThumbnailWithStream.json b/specification/cognitiveservices/data-plane/ComputerVision/stable/v3.1/examples/SuccessfulGenerateThumbnailWithStream.json
new file mode 100644
index 000000000000..22d52fbe7644
--- /dev/null
+++ b/specification/cognitiveservices/data-plane/ComputerVision/stable/v3.1/examples/SuccessfulGenerateThumbnailWithStream.json
@@ -0,0 +1,16 @@
+{
+ "parameters": {
+ "Endpoint": "https://westus.api.cognitive.microsoft.com",
+ "Ocp-Apim-Subscription-Key": "{API key}",
+ "width": "500",
+ "height": "500",
+ "smartCropping": true,
+ "Image": "{binary}"
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": "{binary}"
+ }
+ }
+}
diff --git a/specification/cognitiveservices/data-plane/ComputerVision/stable/v3.1/examples/SuccessfulGenerateThumbnailWithUrl.json b/specification/cognitiveservices/data-plane/ComputerVision/stable/v3.1/examples/SuccessfulGenerateThumbnailWithUrl.json
new file mode 100644
index 000000000000..28744179ecb8
--- /dev/null
+++ b/specification/cognitiveservices/data-plane/ComputerVision/stable/v3.1/examples/SuccessfulGenerateThumbnailWithUrl.json
@@ -0,0 +1,18 @@
+{
+ "parameters": {
+ "Endpoint": "https://westus.api.cognitive.microsoft.com",
+ "Ocp-Apim-Subscription-Key": "{API key}",
+ "width": "500",
+ "height": "500",
+ "smartCropping": true,
+ "ImageUrl": {
+ "url": "{url}"
+ }
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": "{Binary}"
+ }
+ }
+}
diff --git a/specification/cognitiveservices/data-plane/ComputerVision/stable/v3.1/examples/SuccessfulGetAreaOfInterestWithStream.json b/specification/cognitiveservices/data-plane/ComputerVision/stable/v3.1/examples/SuccessfulGetAreaOfInterestWithStream.json
new file mode 100644
index 000000000000..ae32a21a551e
--- /dev/null
+++ b/specification/cognitiveservices/data-plane/ComputerVision/stable/v3.1/examples/SuccessfulGetAreaOfInterestWithStream.json
@@ -0,0 +1,26 @@
+{
+ "parameters": {
+ "Endpoint": "https://westus.api.cognitive.microsoft.com",
+ "Ocp-Apim-Subscription-Key": "{API key}",
+ "Image": "{binary}"
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": {
+ "areaOfInterest": {
+ "h": 951,
+ "w": 950,
+ "x": 160,
+ "y": 0
+ },
+ "requestId": "ed2de1c6-fb55-4686-b0da-4da6e05d283f",
+ "metadata": {
+ "format": "Jpeg",
+ "height": 951,
+ "width": 1378
+ }
+ }
+ }
+ }
+}
diff --git a/specification/cognitiveservices/data-plane/ComputerVision/stable/v3.1/examples/SuccessfulGetAreaOfInterestWithUrl.json b/specification/cognitiveservices/data-plane/ComputerVision/stable/v3.1/examples/SuccessfulGetAreaOfInterestWithUrl.json
new file mode 100644
index 000000000000..7d6d08208836
--- /dev/null
+++ b/specification/cognitiveservices/data-plane/ComputerVision/stable/v3.1/examples/SuccessfulGetAreaOfInterestWithUrl.json
@@ -0,0 +1,28 @@
+{
+ "parameters": {
+ "Endpoint": "https://westus.api.cognitive.microsoft.com",
+ "Ocp-Apim-Subscription-Key": "{API key}",
+ "ImageUrl": {
+ "url": "{url}"
+ }
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": {
+ "areaOfInterest": {
+ "h": 951,
+ "w": 950,
+ "x": 160,
+ "y": 0
+ },
+ "requestId": "ed2de1c6-fb55-4686-b0da-4da6e05d283f",
+ "metadata": {
+ "format": "Jpeg",
+ "height": 951,
+ "width": 1378
+ }
+ }
+ }
+ }
+}
diff --git a/specification/cognitiveservices/data-plane/ComputerVision/stable/v3.1/examples/SuccessfulGetReadResult.json b/specification/cognitiveservices/data-plane/ComputerVision/stable/v3.1/examples/SuccessfulGetReadResult.json
new file mode 100644
index 000000000000..944e52b9d113
--- /dev/null
+++ b/specification/cognitiveservices/data-plane/ComputerVision/stable/v3.1/examples/SuccessfulGetReadResult.json
@@ -0,0 +1,369 @@
+{
+ "parameters": {
+ "Endpoint": "{Endpoint}",
+ "Ocp-Apim-Subscription-Key": "{API key}",
+ "operationId": "e56ffa6e-1ee4-4042-bc07-993db706c95f"
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": {
+ "status": "succeeded",
+ "createdDateTime": "2019-10-03T14:32:04.236Z",
+ "lastUpdatedDateTime": "2019-10-03T14:38:14.852Z",
+ "analyzeResult": {
+ "version": "v3.1",
+ "readResults": [
+ {
+ "page": 1,
+ "language": "en",
+ "angle": 49.59,
+ "width": 600,
+ "height": 400,
+ "unit": "pixel",
+ "lines": [
+ {
+ "boundingBox": [
+ 202,
+ 618,
+ 2047,
+ 643,
+ 2046,
+ 840,
+ 200,
+ 813
+ ],
+ "text": "Our greatest glory is not",
+ "words": [
+ {
+ "boundingBox": [
+ 204,
+ 627,
+ 481,
+ 628,
+ 481,
+ 830,
+ 204,
+ 829
+ ],
+ "text": "Our",
+ "confidence": 0.164
+ },
+ {
+ "boundingBox": [
+ 519,
+ 628,
+ 1057,
+ 630,
+ 1057,
+ 832,
+ 518,
+ 830
+ ],
+ "text": "greatest",
+ "confidence": 0.164
+ },
+ {
+ "boundingBox": [
+ 1114,
+ 630,
+ 1549,
+ 631,
+ 1548,
+ 833,
+ 1114,
+ 832
+ ],
+ "text": "glory",
+ "confidence": 0.164
+ },
+ {
+ "boundingBox": [
+ 1586,
+ 631,
+ 1785,
+ 632,
+ 1784,
+ 834,
+ 1586,
+ 833
+ ],
+ "text": "is",
+ "confidence": 0.164
+ },
+ {
+ "boundingBox": [
+ 1822,
+ 632,
+ 2115,
+ 633,
+ 2115,
+ 835,
+ 1822,
+ 834
+ ],
+ "text": "not",
+ "confidence": 0.164
+ }
+ ]
+ },
+ {
+ "boundingBox": [
+ 420,
+ 1273,
+ 2954,
+ 1250,
+ 2958,
+ 1488,
+ 422,
+ 1511
+ ],
+ "text": "but in rising every time we fall",
+ "words": [
+ {
+ "boundingBox": [
+ 423,
+ 1269,
+ 634,
+ 1268,
+ 635,
+ 1507,
+ 424,
+ 1508
+ ],
+ "text": "but",
+ "confidence": 0.164
+ },
+ {
+ "boundingBox": [
+ 667,
+ 1268,
+ 808,
+ 1268,
+ 809,
+ 1506,
+ 668,
+ 1507
+ ],
+ "text": "in",
+ "confidence": 0.164
+ },
+ {
+ "boundingBox": [
+ 874,
+ 1267,
+ 1289,
+ 1265,
+ 1290,
+ 1504,
+ 875,
+ 1506
+ ],
+ "text": "rising",
+ "confidence": 0.164
+ },
+ {
+ "boundingBox": [
+ 1331,
+ 1265,
+ 1771,
+ 1263,
+ 1772,
+ 1502,
+ 1332,
+ 1504
+ ],
+ "text": "every",
+ "confidence": 0.164
+ },
+ {
+ "boundingBox": [
+ 1812,
+ 1263,
+ 2178,
+ 1261,
+ 2179,
+ 1500,
+ 1813,
+ 1502
+ ],
+ "text": "time",
+ "confidence": 0.164
+ },
+ {
+ "boundingBox": [
+ 2219,
+ 1261,
+ 2510,
+ 1260,
+ 2511,
+ 1498,
+ 2220,
+ 1500
+ ],
+ "text": "we",
+ "confidence": 0.164
+ },
+ {
+ "boundingBox": [
+ 2551,
+ 1260,
+ 3016,
+ 1258,
+ 3017,
+ 1496,
+ 2552,
+ 1498
+ ],
+ "text": "fall",
+ "confidence": 0.164
+ }
+ ]
+ },
+ {
+ "language": "es",
+ "boundingBox": [
+ 1612,
+ 903,
+ 2744,
+ 935,
+ 2738,
+ 1139,
+ 1607,
+ 1107
+ ],
+ "text": "Viva la vida",
+ "words": [
+ {
+ "boundingBox": [
+ 323,
+ 454,
+ 416,
+ 449,
+ 418,
+ 494,
+ 325,
+ 501
+ ],
+ "text": "Viva",
+ "confidence": 0.164
+ },
+ {
+ "boundingBox": [
+ 92,
+ 550,
+ 429,
+ 541,
+ 430,
+ 591,
+ 94,
+ 600
+ ],
+ "text": "la",
+ "confidence": 0.164
+ },
+ {
+ "boundingBox": [
+ 58,
+ 466,
+ 268,
+ 458,
+ 270,
+ 505,
+ 161,
+ 512
+ ],
+ "text": "vida",
+ "confidence": 0.164
+ }
+ ]
+ }
+ ]
+ },
+ {
+ "page": 2,
+ "language": "en",
+ "angle": 1.32,
+ "width": 600,
+ "height": 400,
+ "unit": "pixel",
+ "lines": [
+ {
+ "boundingBox": [
+ 1612,
+ 903,
+ 2744,
+ 935,
+ 2738,
+ 1139,
+ 1607,
+ 1107
+ ],
+ "text": "in never failing ,",
+ "words": [
+ {
+ "boundingBox": [
+ 1611,
+ 934,
+ 1707,
+ 933,
+ 1708,
+ 1147,
+ 1613,
+ 1147
+ ],
+ "text": "in",
+ "confidence": 0.164
+ },
+ {
+ "boundingBox": [
+ 1753,
+ 933,
+ 2132,
+ 930,
+ 2133,
+ 1144,
+ 1754,
+ 1146
+ ],
+ "text": "never",
+ "confidence": 0.999
+ },
+ {
+ "boundingBox": [
+ 2162,
+ 930,
+ 2673,
+ 927,
+ 2674,
+ 1140,
+ 2164,
+ 1144
+ ],
+ "text": "failing",
+ "confidence": 0.164
+ },
+ {
+ "boundingBox": [
+ 2703,
+ 926,
+ 2788,
+ 926,
+ 2790,
+ 1139,
+ 2705,
+ 1140
+ ],
+ "text": ",",
+ "confidence": 0.164
+ }
+ ]
+ }
+ ]
+ }
+ ]
+ }
+ }
+ }
+ }
+}
diff --git a/specification/cognitiveservices/data-plane/ComputerVision/stable/v3.1/examples/SuccessfulListModels.json b/specification/cognitiveservices/data-plane/ComputerVision/stable/v3.1/examples/SuccessfulListModels.json
new file mode 100644
index 000000000000..54e72d376431
--- /dev/null
+++ b/specification/cognitiveservices/data-plane/ComputerVision/stable/v3.1/examples/SuccessfulListModels.json
@@ -0,0 +1,27 @@
+{
+ "parameters": {
+ "Endpoint": "https://westus.api.cognitive.microsoft.com",
+ "Ocp-Apim-Subscription-Key": "{API key}"
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": {
+ "models": [
+ {
+ "name": "celebrities",
+ "categories": [
+ "people_"
+ ]
+ },
+ {
+ "name": "landmarks",
+ "categories": [
+ "building_"
+ ]
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/cognitiveservices/data-plane/ComputerVision/stable/v3.1/examples/SuccessfulReadWithStream.json b/specification/cognitiveservices/data-plane/ComputerVision/stable/v3.1/examples/SuccessfulReadWithStream.json
new file mode 100644
index 000000000000..a9728b640867
--- /dev/null
+++ b/specification/cognitiveservices/data-plane/ComputerVision/stable/v3.1/examples/SuccessfulReadWithStream.json
@@ -0,0 +1,15 @@
+{
+ "parameters": {
+ "Endpoint": "{Endpoint}",
+ "Ocp-Apim-Subscription-Key": "{API key}",
+ "language": "en",
+ "Image": "{binary}"
+ },
+ "responses": {
+ "202": {
+ "header": {
+ "location": "https://{domain}/vision/v3.1/read/e56ffa6e-1ee4-4042-bc07-993db706c95f"
+ }
+ }
+ }
+}
diff --git a/specification/cognitiveservices/data-plane/ComputerVision/stable/v3.1/examples/SuccessfulReadWithUrl.json b/specification/cognitiveservices/data-plane/ComputerVision/stable/v3.1/examples/SuccessfulReadWithUrl.json
new file mode 100644
index 000000000000..60c4dc56a96c
--- /dev/null
+++ b/specification/cognitiveservices/data-plane/ComputerVision/stable/v3.1/examples/SuccessfulReadWithUrl.json
@@ -0,0 +1,17 @@
+{
+ "parameters": {
+ "Endpoint": "{Endpoint}",
+ "Ocp-Apim-Subscription-Key": "{API key}",
+ "language": "en",
+ "ImageUrl": {
+ "url": "{url}"
+ }
+ },
+ "responses": {
+ "202": {
+ "header": {
+ "Operation-Location": "https://{domain}/vision/v3.1/read/e56ffa6e-1ee4-4042-bc07-993db706c95f"
+ }
+ }
+ }
+}
diff --git a/specification/cognitiveservices/data-plane/ComputerVision/stable/v3.1/examples/SuccessfulRecognizePrintedTextWithStream.json b/specification/cognitiveservices/data-plane/ComputerVision/stable/v3.1/examples/SuccessfulRecognizePrintedTextWithStream.json
new file mode 100644
index 000000000000..201d0fe48254
--- /dev/null
+++ b/specification/cognitiveservices/data-plane/ComputerVision/stable/v3.1/examples/SuccessfulRecognizePrintedTextWithStream.json
@@ -0,0 +1,77 @@
+{
+ "parameters": {
+ "Endpoint": "https://westus.api.cognitive.microsoft.com",
+ "Ocp-Apim-Subscription-Key": "{API key}",
+ "detectOrientation": "true",
+ "language": "en",
+ "Image": "{binary}"
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": {
+ "language": "en",
+ "textAngle": -2.0000000000000338,
+ "orientation": "Up",
+ "regions": [
+ {
+ "boundingBox": "462,379,497,258",
+ "lines": [
+ {
+ "boundingBox": "462,379,497,74",
+ "words": [
+ {
+ "boundingBox": "462,379,41,73",
+ "text": "A"
+ },
+ {
+ "boundingBox": "523,379,153,73",
+ "text": "GOAL"
+ },
+ {
+ "boundingBox": "694,379,265,74",
+ "text": "WITHOUT"
+ }
+ ]
+ },
+ {
+ "boundingBox": "565,471,289,74",
+ "words": [
+ {
+ "boundingBox": "565,471,41,73",
+ "text": "A"
+ },
+ {
+ "boundingBox": "626,471,150,73",
+ "text": "PLAN"
+ },
+ {
+ "boundingBox": "801,472,53,73",
+ "text": "IS"
+ }
+ ]
+ },
+ {
+ "boundingBox": "519,563,375,74",
+ "words": [
+ {
+ "boundingBox": "519,563,149,74",
+ "text": "JUST"
+ },
+ {
+ "boundingBox": "683,564,41,72",
+ "text": "A"
+ },
+ {
+ "boundingBox": "741,564,153,73",
+ "text": "WISH"
+ }
+ ]
+ }
+ ]
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/cognitiveservices/data-plane/ComputerVision/stable/v3.1/examples/SuccessfulRecognizePrintedTextWithUrl.json b/specification/cognitiveservices/data-plane/ComputerVision/stable/v3.1/examples/SuccessfulRecognizePrintedTextWithUrl.json
new file mode 100644
index 000000000000..a0b8bc84e37b
--- /dev/null
+++ b/specification/cognitiveservices/data-plane/ComputerVision/stable/v3.1/examples/SuccessfulRecognizePrintedTextWithUrl.json
@@ -0,0 +1,79 @@
+{
+ "parameters": {
+ "Endpoint": "https://westus.api.cognitive.microsoft.com",
+ "Ocp-Apim-Subscription-Key": "{API key}",
+ "detectOrientation": "true",
+ "language": "en",
+ "ImageUrl": {
+ "url": "{url}"
+ }
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": {
+ "language": "en",
+ "textAngle": -2.0000000000000338,
+ "orientation": "Up",
+ "regions": [
+ {
+ "boundingBox": "462,379,497,258",
+ "lines": [
+ {
+ "boundingBox": "462,379,497,74",
+ "words": [
+ {
+ "boundingBox": "462,379,41,73",
+ "text": "A"
+ },
+ {
+ "boundingBox": "523,379,153,73",
+ "text": "GOAL"
+ },
+ {
+ "boundingBox": "694,379,265,74",
+ "text": "WITHOUT"
+ }
+ ]
+ },
+ {
+ "boundingBox": "565,471,289,74",
+ "words": [
+ {
+ "boundingBox": "565,471,41,73",
+ "text": "A"
+ },
+ {
+ "boundingBox": "626,471,150,73",
+ "text": "PLAN"
+ },
+ {
+ "boundingBox": "801,472,53,73",
+ "text": "IS"
+ }
+ ]
+ },
+ {
+ "boundingBox": "519,563,375,74",
+ "words": [
+ {
+ "boundingBox": "519,563,149,74",
+ "text": "JUST"
+ },
+ {
+ "boundingBox": "683,564,41,72",
+ "text": "A"
+ },
+ {
+ "boundingBox": "741,564,153,73",
+ "text": "WISH"
+ }
+ ]
+ }
+ ]
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/cognitiveservices/data-plane/ComputerVision/stable/v3.1/examples/SuccessfulTagImageWithStream.json b/specification/cognitiveservices/data-plane/ComputerVision/stable/v3.1/examples/SuccessfulTagImageWithStream.json
new file mode 100644
index 000000000000..813a645d0086
--- /dev/null
+++ b/specification/cognitiveservices/data-plane/ComputerVision/stable/v3.1/examples/SuccessfulTagImageWithStream.json
@@ -0,0 +1,53 @@
+{
+ "parameters": {
+ "Endpoint": "https://westus.api.cognitive.microsoft.com",
+ "Ocp-Apim-Subscription-Key": "{API key}",
+ "Image": "{binary}"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "tags": [
+ {
+ "name": "grass",
+ "confidence": 0.9999997615814209
+ },
+ {
+ "name": "outdoor",
+ "confidence": 0.99997067451477051
+ },
+ {
+ "name": "sky",
+ "confidence": 0.99928975105285645
+ },
+ {
+ "name": "building",
+ "confidence": 0.99646323919296265
+ },
+ {
+ "name": "house",
+ "confidence": 0.99279803037643433
+ },
+ {
+ "name": "lawn",
+ "confidence": 0.82268029451370239
+ },
+ {
+ "name": "green",
+ "confidence": 0.64122253656387329
+ },
+ {
+ "name": "residential",
+ "confidence": 0.31403225660324097
+ }
+ ],
+ "requestId": "1ad0e45e-b7b4-4be3-8042-53be96103337",
+ "metadata": {
+ "width": 400,
+ "height": 400,
+ "format": "Jpeg"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/cognitiveservices/data-plane/ComputerVision/stable/v3.1/examples/SuccessfulTagImageWithUrl.json b/specification/cognitiveservices/data-plane/ComputerVision/stable/v3.1/examples/SuccessfulTagImageWithUrl.json
new file mode 100644
index 000000000000..0dcf0304a33a
--- /dev/null
+++ b/specification/cognitiveservices/data-plane/ComputerVision/stable/v3.1/examples/SuccessfulTagImageWithUrl.json
@@ -0,0 +1,55 @@
+{
+ "parameters": {
+ "Endpoint": "https://westus.api.cognitive.microsoft.com",
+ "Ocp-Apim-Subscription-Key": "{API key}",
+ "ImageUrl": {
+ "url": "{url}"
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "tags": [
+ {
+ "name": "grass",
+ "confidence": 0.9999997615814209
+ },
+ {
+ "name": "outdoor",
+ "confidence": 0.99997067451477051
+ },
+ {
+ "name": "sky",
+ "confidence": 0.99928975105285645
+ },
+ {
+ "name": "building",
+ "confidence": 0.99646323919296265
+ },
+ {
+ "name": "house",
+ "confidence": 0.99279803037643433
+ },
+ {
+ "name": "lawn",
+ "confidence": 0.82268029451370239
+ },
+ {
+ "name": "green",
+ "confidence": 0.64122253656387329
+ },
+ {
+ "name": "residential",
+ "confidence": 0.31403225660324097
+ }
+ ],
+ "requestId": "1ad0e45e-b7b4-4be3-8042-53be96103337",
+ "metadata": {
+ "width": 400,
+ "height": 400,
+ "format": "Jpeg"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/cognitiveservices/data-plane/QnAMaker/preview/v5.0-preview.1/QnAMaker.json b/specification/cognitiveservices/data-plane/QnAMaker/preview/v5.0-preview.1/QnAMaker.json
new file mode 100644
index 000000000000..26ef7ee004ab
--- /dev/null
+++ b/specification/cognitiveservices/data-plane/QnAMaker/preview/v5.0-preview.1/QnAMaker.json
@@ -0,0 +1,1923 @@
+{
+ "swagger": "2.0",
+ "info": {
+ "version": "v5.0-preview.1",
+ "title": "QnAMaker Client",
+ "description": "An API for QnAMaker Service"
+ },
+ "securityDefinitions": {
+ "apim_key": {
+ "type": "apiKey",
+ "name": "Ocp-Apim-Subscription-Key",
+ "in": "header"
+ }
+ },
+ "security": [
+ {
+ "apim_key": []
+ }
+ ],
+ "x-ms-parameterized-host": {
+ "hostTemplate": "{Endpoint}/qnamaker/v5.0-preview.1",
+ "useSchemePrefix": false,
+ "parameters": [
+ {
+ "$ref": "#/parameters/Endpoint"
+ }
+ ]
+ },
+ "paths": {
+ "/endpointSettings": {
+ "get": {
+ "summary": "Gets endpoint settings for an endpoint.",
+ "operationId": "EndpointSettings_GetSettings",
+ "parameters": [],
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "responses": {
+ "200": {
+ "description": "Response with endpoint settings info in it.",
+ "schema": {
+ "$ref": "#/definitions/EndpointSettingsDTO"
+ },
+ "x-nullable": true
+ },
+ "default": {
+ "description": "Error response.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Successful query": {
+ "$ref": "./examples/SuccessfulGetEpSettings.json"
+ }
+ }
+ },
+ "patch": {
+ "tags": [
+ "EndpointKeys"
+ ],
+ "summary": "Updates endpoint settings for an endpoint.",
+ "operationId": "EndpointSettings_UpdateSettings",
+ "parameters": [
+ {
+ "$ref": "#/parameters/EndpointSettingsPayload"
+ }
+ ],
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "responses": {
+ "204": {
+ "description": "HTTP 204 No Content."
+ },
+ "default": {
+ "description": "Error response.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Successful query": {
+ "$ref": "./examples/SuccessfulSetEpSettings.json"
+ }
+ }
+ }
+ },
+ "/endpointkeys": {
+ "get": {
+ "summary": "Gets endpoint keys for an endpoint",
+ "operationId": "EndpointKeys_GetKeys",
+ "parameters": [],
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "responses": {
+ "200": {
+ "description": "Response with endpoint info in it.",
+ "schema": {
+ "$ref": "#/definitions/EndpointKeysDTO"
+ },
+ "x-nullable": true
+ },
+ "default": {
+ "description": "Error response.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Successful query": {
+ "$ref": "./examples/SuccessfulGetEpKeys.json"
+ }
+ }
+ }
+ },
+ "/endpointkeys/{keyType}": {
+ "patch": {
+ "tags": [
+ "EndpointKeys"
+ ],
+ "summary": "Re-generates an endpoint key.",
+ "operationId": "EndpointKeys_RefreshKeys",
+ "parameters": [
+ {
+ "$ref": "#/parameters/KeyType"
+ }
+ ],
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "responses": {
+ "200": {
+ "description": "Details of the endpoint keys generated.",
+ "schema": {
+ "$ref": "#/definitions/EndpointKeysDTO"
+ },
+ "x-nullable": true
+ },
+ "default": {
+ "description": "Error response.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Successful query": {
+ "$ref": "./examples/SuccessfulSetEpKeys.json"
+ }
+ }
+ }
+ },
+ "/alterations": {
+ "get": {
+ "tags": [
+ "Alterations"
+ ],
+ "summary": "Download alterations from runtime.",
+ "operationId": "Alterations_Get",
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "responses": {
+ "200": {
+ "description": "Alterations data.",
+ "schema": {
+ "$ref": "#/definitions/WordAlterationsDTO"
+ },
+ "x-nullable": true
+ },
+ "default": {
+ "description": "Error response.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Successful query": {
+ "$ref": "./examples/SuccessfulGetAlts.json"
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "Alterations"
+ ],
+ "summary": "Replace alterations data.",
+ "operationId": "Alterations_Replace",
+ "parameters": [
+ {
+ "$ref": "#/parameters/WordAlterations"
+ }
+ ],
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "responses": {
+ "204": {
+ "description": "HTTP 204 No Content."
+ },
+ "default": {
+ "description": "Error response.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Successful query": {
+ "$ref": "./examples/SuccessfulSetAlts.json"
+ }
+ }
+ }
+ },
+ "/alterations/{kbId}": {
+ "get": {
+ "tags": [
+ "Alterations"
+ ],
+ "summary": "Download alterations per Knowledgebase (QnAMaker Managed).",
+ "operationId": "Alterations_GetAlterationsForKb",
+ "parameters": [
+ {
+ "$ref": "#/parameters/KbId"
+ }
+ ],
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "responses": {
+ "200": {
+ "description": "Alterations data.",
+ "schema": {
+ "$ref": "#/definitions/WordAlterationsDTO"
+ },
+ "x-nullable": true
+ },
+ "default": {
+ "description": "Error response.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Successful query": {
+ "$ref": "./examples/SuccessfulGetAltsForKb.json"
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "Alterations"
+ ],
+ "summary": "Replace alterations data per Knowledgebase (QnAMaker Managed).",
+ "operationId": "Alterations_ReplaceAlterationsForKb",
+ "parameters": [
+ {
+ "$ref": "#/parameters/KbId"
+ },
+ {
+ "$ref": "#/parameters/WordAlterations"
+ }
+ ],
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "responses": {
+ "204": {
+ "description": "HTTP 204 No Content."
+ },
+ "default": {
+ "description": "Error response.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Successful query": {
+ "$ref": "./examples/SuccessfulSetAltsForKb.json"
+ }
+ }
+ }
+ },
+ "/knowledgebases": {
+ "get": {
+ "tags": [
+ "Knowledgebases"
+ ],
+ "summary": "Gets all knowledgebases for a user.",
+ "operationId": "Knowledgebase_ListAll",
+ "parameters": [],
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "responses": {
+ "200": {
+ "description": "Collection of knowledgebases.",
+ "schema": {
+ "$ref": "#/definitions/KnowledgebasesDTO"
+ },
+ "x-nullable": true
+ },
+ "default": {
+ "description": "Error response.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Successful query": {
+ "$ref": "./examples/SuccessfulKbsResponse.json"
+ }
+ }
+ }
+ },
+ "/operations/{operationId}": {
+ "get": {
+ "tags": [
+ "Operations"
+ ],
+ "summary": "Gets details of a specific long running operation.",
+ "operationId": "Operations_GetDetails",
+ "parameters": [
+ {
+ "$ref": "#/parameters/OperationId"
+ }
+ ],
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "responses": {
+ "200": {
+ "description": "Details of the long running operation.",
+ "schema": {
+ "$ref": "#/definitions/Operation"
+ },
+ "x-nullable": true,
+ "headers": {
+ "RetryAfter": {
+ "type": "integer",
+ "description": "Indicates how long the client should wait before sending a follow up request. The header will be present only if the operation is running or has not started yet."
+ }
+ }
+ },
+ "default": {
+ "description": "Error response.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Successful query": {
+ "$ref": "./examples/SuccessfulGetOps.json"
+ }
+ }
+ }
+ },
+ "/knowledgebases/{kbId}": {
+ "get": {
+ "tags": [
+ "Knowledgebases"
+ ],
+ "summary": "Gets details of a specific knowledgebase.",
+ "operationId": "Knowledgebase_GetDetails",
+ "parameters": [
+ {
+ "$ref": "#/parameters/KbId"
+ }
+ ],
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "responses": {
+ "200": {
+ "description": "Details of the knowledgebase.",
+ "schema": {
+ "$ref": "#/definitions/KnowledgebaseDTO"
+ },
+ "x-nullable": true
+ },
+ "default": {
+ "description": "Error response.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Successful query": {
+ "$ref": "./examples/SuccessfulGetKb.json"
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "Knowledgebases"
+ ],
+ "summary": "Deletes the knowledgebase and all its data.",
+ "operationId": "Knowledgebase_Delete",
+ "parameters": [
+ {
+ "$ref": "#/parameters/KbId"
+ }
+ ],
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "responses": {
+ "204": {
+ "description": "HTTP 204 No content."
+ },
+ "default": {
+ "description": "Error response.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Successful query": {
+ "$ref": "./examples/SuccessfulDelKb.json"
+ }
+ }
+ },
+ "post": {
+ "tags": [
+ "Knowledgebases"
+ ],
+ "summary": "Publishes all changes in test index of a knowledgebase to its prod index.",
+ "operationId": "Knowledgebase_Publish",
+ "parameters": [
+ {
+ "$ref": "#/parameters/KbId"
+ }
+ ],
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "responses": {
+ "204": {
+ "description": "HTTP 204 No content."
+ },
+ "default": {
+ "description": "Error response.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Successful query": {
+ "$ref": "./examples/SuccessfulPubKb.json"
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "Knowledgebases"
+ ],
+ "summary": "Replace knowledgebase contents.",
+ "operationId": "Knowledgebase_Replace",
+ "parameters": [
+ {
+ "$ref": "#/parameters/KbId"
+ },
+ {
+ "$ref": "#/parameters/ReplaceKb"
+ }
+ ],
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "responses": {
+ "204": {
+ "description": "HTTP 204 No content."
+ },
+ "default": {
+ "description": "Error response.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Successful query": {
+ "$ref": "./examples/SuccessfulRepKb.json"
+ }
+ }
+ },
+ "patch": {
+ "tags": [
+ "Knowledgebases"
+ ],
+ "summary": "Asynchronous operation to modify a knowledgebase.",
+ "operationId": "Knowledgebase_Update",
+ "parameters": [
+ {
+ "$ref": "#/parameters/KbId"
+ },
+ {
+ "$ref": "#/parameters/UpdateKb"
+ }
+ ],
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "responses": {
+ "202": {
+ "description": "Details of the asynchronous operation.",
+ "schema": {
+ "$ref": "#/definitions/Operation"
+ },
+ "x-nullable": true,
+ "headers": {
+ "Location": {
+ "type": "string",
+ "description": "Relative URI to the target location of the asynchronous operation. Client should poll this resource to get status of the operation."
+ }
+ }
+ },
+ "default": {
+ "description": "Error response.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Successful query": {
+ "$ref": "./examples/SuccessfulUpdKb.json"
+ }
+ }
+ }
+ },
+ "/knowledgebases/create": {
+ "post": {
+ "tags": [
+ "Knowledgebases"
+ ],
+ "summary": "Asynchronous operation to create a new knowledgebase.",
+ "operationId": "Knowledgebase_Create",
+ "parameters": [
+ {
+ "$ref": "#/parameters/CreateKbPayload"
+ }
+ ],
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "responses": {
+ "202": {
+ "description": "Details of the asynchronous operation.",
+ "schema": {
+ "$ref": "#/definitions/Operation"
+ },
+ "x-nullable": true
+ },
+ "default": {
+ "description": "Error response.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Successful query": {
+ "$ref": "./examples/SuccessfulCreateKb.json"
+ }
+ }
+ }
+ },
+ "/knowledgebases/{kbId}/{environment}/qna": {
+ "get": {
+ "tags": [
+ "Knowledgebases"
+ ],
+ "summary": "Download the knowledgebase.",
+ "operationId": "Knowledgebase_Download",
+ "parameters": [
+ {
+ "$ref": "#/parameters/KbId"
+ },
+ {
+ "$ref": "#/parameters/Environment"
+ },
+ {
+ "name": "source",
+ "in": "query",
+ "description": "The source property filter to apply.",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "name": "changedSince",
+ "in": "query",
+ "description": "The last changed status property filter to apply.",
+ "required": false,
+ "type": "string"
+ }
+ ],
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "responses": {
+ "200": {
+ "description": "Collection of all Q-A in the knowledgebase.",
+ "schema": {
+ "$ref": "#/definitions/QnADocumentsDTO"
+ },
+ "x-nullable": true
+ },
+ "default": {
+ "description": "Error response.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Successful query": {
+ "$ref": "./examples/SuccessfulDownloadKb.json"
+ }
+ }
+ }
+ },
+ "/knowledgebases/{kbId}/generateAnswer": {
+ "post": {
+ "tags": [
+ "Knowledgebases"
+ ],
+ "summary": "GenerateAnswer call to query knowledgebase (QnA Maker Managed).",
+ "operationId": "Knowledgebase_GenerateAnswer",
+ "parameters": [
+ {
+ "$ref": "#/parameters/KbId"
+ },
+ {
+ "$ref": "#/parameters/GenerateAnswerPayload"
+ }
+ ],
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "responses": {
+ "200": {
+ "description": "GenerateAnswer call response.",
+ "schema": {
+ "$ref": "#/definitions/QnASearchResultList"
+ }
+ },
+ "default": {
+ "description": "Error response.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Successful query": {
+ "$ref": "./examples/SuccessfulGenAns.json"
+ }
+ }
+ }
+ },
+ "/knowledgebases/{kbId}/train": {
+ "post": {
+ "tags": [
+ "Knowledgebases"
+ ],
+ "summary": "Train call to add suggestions to knowledgebase (QnAMaker Managed).",
+ "operationId": "Knowledgebase_Train",
+ "parameters": [
+ {
+ "$ref": "#/parameters/KbId"
+ },
+ {
+ "$ref": "#/parameters/TrainPayload"
+ }
+ ],
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "responses": {
+ "204": {
+ "description": "HTTP 204 No Content."
+ },
+ "default": {
+ "description": "Error response.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Successful query": {
+ "$ref": "./examples/SuccessfulTrain.json"
+ }
+ }
+ }
+ }
+ },
+ "definitions": {
+ "UpdateKbOperationDTO": {
+ "type": "object",
+ "description": "Contains list of QnAs to be updated",
+ "additionalProperties": false,
+ "properties": {
+ "add": {
+ "description": "An instance of CreateKbInputDTO for add operation",
+ "allOf": [
+ {
+ "$ref": "#/definitions/CreateKbInputDTO"
+ }
+ ]
+ },
+ "delete": {
+ "description": "An instance of DeleteKbContentsDTO for delete Operation",
+ "allOf": [
+ {
+ "$ref": "#/definitions/DeleteKbContentsDTO"
+ }
+ ]
+ },
+ "update": {
+ "description": "An instance of UpdateKbContentsDTO for Update Operation",
+ "allOf": [
+ {
+ "$ref": "#/definitions/UpdateKbContentsDTO"
+ }
+ ]
+ },
+ "enableHierarchicalExtraction": {
+ "type": "boolean",
+ "description": "Enable hierarchical extraction of Q-A from files and urls. The value set during KB creation will be used if this field is not present."
+ },
+ "defaultAnswerUsedForExtraction": {
+ "type": "string",
+ "description": "Text string to be used as the answer in any Q-A which has no extracted answer from the document but has a hierarchy. Required when EnableHierarchicalExtraction field is set to True.",
+ "maxLength": 300,
+ "minLength": 1
+ }
+ }
+ },
+ "UpdateKbContentsDTO": {
+ "type": "object",
+ "description": "PATCH body schema for Update operation in Update Kb",
+ "additionalProperties": false,
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "Friendly name for the knowledgebase."
+ },
+ "qnaList": {
+ "type": "array",
+ "description": "List of Q-A (UpdateQnaDTO) to be added to the knowledgebase.",
+ "items": {
+ "$ref": "#/definitions/UpdateQnaDTO"
+ }
+ },
+ "urls": {
+ "type": "array",
+ "description": "List of existing URLs to be refreshed. The content will be extracted again and re-indexed.",
+ "maxLength": 10,
+ "items": {
+ "type": "string"
+ }
+ },
+ "defaultAnswer": {
+ "type": "string",
+ "description": "Default answer sent to user if no good match is found in the KB.",
+ "maxLength": 300,
+ "minLength": 1
+ }
+ }
+ },
+ "UpdateQnaDTO": {
+ "type": "object",
+ "description": "PATCH Body schema for Update Qna List",
+ "additionalProperties": false,
+ "properties": {
+ "id": {
+ "type": "integer",
+ "description": "Unique id for the Q-A",
+ "format": "int32",
+ "maximum": 2147483647,
+ "minimum": 0
+ },
+ "answer": {
+ "type": "string",
+ "description": "Answer text"
+ },
+ "source": {
+ "type": "string",
+ "description": "Source from which Q-A was indexed. eg. https://docs.microsoft.com/en-us/azure/cognitive-services/QnAMaker/FAQs",
+ "maxLength": 300
+ },
+ "questions": {
+ "description": "List of questions associated with the answer.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/UpdateQuestionsDTO"
+ }
+ ]
+ },
+ "metadata": {
+ "description": "List of metadata associated with the answer to be updated",
+ "allOf": [
+ {
+ "$ref": "#/definitions/UpdateMetadataDTO"
+ }
+ ]
+ },
+ "context": {
+ "description": "Context associated with Qna to be updated.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/UpdateContextDTO"
+ }
+ ]
+ }
+ }
+ },
+ "UpdateQuestionsDTO": {
+ "type": "object",
+ "description": "PATCH Body schema for Update Kb which contains list of questions to be added and deleted",
+ "additionalProperties": false,
+ "properties": {
+ "add": {
+ "type": "array",
+ "description": "List of questions to be added",
+ "maxLength": 100,
+ "items": {
+ "type": "string"
+ }
+ },
+ "delete": {
+ "type": "array",
+ "description": "List of questions to be deleted.",
+ "maxLength": 100,
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "UpdateMetadataDTO": {
+ "type": "object",
+ "description": "PATCH Body schema to represent list of Metadata to be updated",
+ "additionalProperties": false,
+ "properties": {
+ "delete": {
+ "type": "array",
+ "description": "List of Metadata associated with answer to be deleted",
+ "maxLength": 100,
+ "items": {
+ "$ref": "#/definitions/MetadataDTO"
+ }
+ },
+ "add": {
+ "type": "array",
+ "description": "List of metadata associated with answer to be added",
+ "maxLength": 100,
+ "items": {
+ "$ref": "#/definitions/MetadataDTO"
+ }
+ }
+ }
+ },
+ "UpdateContextDTO": {
+ "type": "object",
+ "description": "Update Body schema to represent context to be updated",
+ "properties": {
+ "promptsToDelete": {
+ "type": "array",
+ "description": "List of prompts associated with qna to be deleted",
+ "items": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ "promptsToAdd": {
+ "type": "array",
+ "description": "List of prompts to be added to the qna.",
+ "items": {
+ "$ref": "#/definitions/PromptDTO"
+ }
+ },
+ "isContextOnly": {
+ "type": "boolean",
+ "description": "To mark if a prompt is relevant only with a previous question or not.\ntrue - Do not include this QnA as search result for queries without context\nfalse - ignores context and includes this QnA in search result"
+ }
+ }
+ },
+ "DeleteKbContentsDTO": {
+ "type": "object",
+ "description": "PATCH body schema of Delete Operation in UpdateKb",
+ "additionalProperties": false,
+ "properties": {
+ "ids": {
+ "type": "array",
+ "description": "List of Qna Ids to be deleted",
+ "items": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ "sources": {
+ "type": "array",
+ "description": "List of sources to be deleted from knowledgebase.",
+ "maxLength": 300,
+ "minLength": 1,
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "CreateKbInputDTO": {
+ "type": "object",
+ "description": "Input to create KB.",
+ "additionalProperties": false,
+ "properties": {
+ "qnaList": {
+ "type": "array",
+ "description": "List of QNA to be added to the index. Ids are generated by the service and should be omitted.",
+ "items": {
+ "$ref": "#/definitions/QnADTO"
+ }
+ },
+ "urls": {
+ "type": "array",
+ "description": "List of URLs to be added to knowledgebase.",
+ "maxLength": 10,
+ "items": {
+ "type": "string"
+ }
+ },
+ "files": {
+ "type": "array",
+ "description": "List of files to be added to knowledgebase.",
+ "maxLength": 10,
+ "items": {
+ "$ref": "#/definitions/FileDTO"
+ }
+ }
+ }
+ },
+ "QnADocumentsDTO": {
+ "type": "object",
+ "description": "List of QnADTO",
+ "additionalProperties": false,
+ "properties": {
+ "qnaDocuments": {
+ "type": "array",
+ "description": "List of answers.",
+ "items": {
+ "$ref": "#/definitions/QnADTO"
+ }
+ }
+ }
+ },
+ "CreateKbDTO": {
+ "type": "object",
+ "description": "Post body schema for CreateKb operation.",
+ "additionalProperties": false,
+ "required": [
+ "name"
+ ],
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "Friendly name for the knowledgebase.",
+ "maxLength": 100,
+ "minLength": 1
+ },
+ "qnaList": {
+ "type": "array",
+ "description": "List of Q-A (QnADTO) to be added to the knowledgebase. Q-A Ids are assigned by the service and should be omitted.",
+ "maxLength": 1000,
+ "items": {
+ "$ref": "#/definitions/QnADTO"
+ }
+ },
+ "urls": {
+ "type": "array",
+ "description": "List of URLs to be used for extracting Q-A.",
+ "maxLength": 10,
+ "items": {
+ "type": "string"
+ }
+ },
+ "files": {
+ "type": "array",
+ "description": "List of files from which to Extract Q-A.",
+ "maxLength": 10,
+ "items": {
+ "$ref": "#/definitions/FileDTO"
+ }
+ },
+ "enableHierarchicalExtraction": {
+ "type": "boolean",
+ "description": "Enable hierarchical extraction of Q-A from files and urls. Value to be considered False if this field is not present."
+ },
+ "defaultAnswerUsedForExtraction": {
+ "type": "string",
+ "description": "Text string to be used as the answer in any Q-A which has no extracted answer from the document but has a hierarchy. Required when EnableHierarchicalExtraction field is set to True.",
+ "maxLength": 300,
+ "minLength": 1
+ },
+ "language": {
+ "type": "string",
+ "description": "Language of the knowledgebase. Please find the list of supported languages here.",
+ "maxLength": 100,
+ "minLength": 1
+ },
+ "enableMultipleLanguages": {
+ "type": "boolean",
+ "description": "Set to true to enable creating KBs in different languages for the same resource."
+ },
+ "defaultAnswer": {
+ "type": "string",
+ "description": "Default answer sent to user if no good match is found in the KB.",
+ "maxLength": 300,
+ "minLength": 1
+ }
+ }
+ },
+ "FileDTO": {
+ "type": "object",
+ "description": "DTO to hold details of uploaded files.",
+ "additionalProperties": false,
+ "required": [
+ "fileName",
+ "fileUri"
+ ],
+ "properties": {
+ "fileName": {
+ "type": "string",
+ "description": "File name. Supported file types are \".tsv\", \".pdf\", \".txt\", \".docx\", \".xlsx\".",
+ "maxLength": 200,
+ "minLength": 1
+ },
+ "fileUri": {
+ "type": "string",
+ "description": "Public URI of the file."
+ }
+ }
+ },
+ "ReplaceKbDTO": {
+ "type": "object",
+ "description": "Post body schema for Replace KB operation.",
+ "additionalProperties": false,
+ "required": [
+ "qnAList"
+ ],
+ "properties": {
+ "qnAList": {
+ "type": "array",
+ "description": "List of Q-A (QnADTO) to be added to the knowledgebase. Q-A Ids are assigned by the service and should be omitted.",
+ "items": {
+ "$ref": "#/definitions/QnADTO"
+ }
+ }
+ }
+ },
+ "QnADTO": {
+ "type": "object",
+ "description": "Q-A object.",
+ "additionalProperties": false,
+ "required": [
+ "answer",
+ "questions"
+ ],
+ "properties": {
+ "id": {
+ "type": "integer",
+ "description": "Unique id for the Q-A.",
+ "format": "int32"
+ },
+ "answer": {
+ "type": "string",
+ "description": "Answer text",
+ "maxLength": 25000,
+ "minLength": 1
+ },
+ "source": {
+ "type": "string",
+ "description": "Source from which Q-A was indexed. eg. https://docs.microsoft.com/en-us/azure/cognitive-services/QnAMaker/FAQs",
+ "maxLength": 300
+ },
+ "questions": {
+ "type": "array",
+ "description": "List of questions associated with the answer.",
+ "maxLength": 100,
+ "minLength": 1,
+ "items": {
+ "type": "string"
+ }
+ },
+ "metadata": {
+ "type": "array",
+ "description": "List of metadata associated with the answer.",
+ "maxLength": 10,
+ "items": {
+ "$ref": "#/definitions/MetadataDTO"
+ }
+ },
+ "context": {
+ "description": "Context of a QnA",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ContextDTO"
+ }
+ ]
+ },
+ "lastUpdatedTimestamp": {
+ "type": "string",
+ "description": "Timestamp when the QnA was last updated.",
+ "maxLength": 300
+ }
+ }
+ },
+ "ContextDTO": {
+ "type": "object",
+ "description": "Context associated with Qna.",
+ "properties": {
+ "isContextOnly": {
+ "type": "boolean",
+ "description": "To mark if a prompt is relevant only with a previous question or not.\ntrue - Do not include this QnA as search result for queries without context\nfalse - ignores context and includes this QnA in search result"
+ },
+ "prompts": {
+ "type": "array",
+ "description": "List of prompts associated with the answer.",
+ "maxItems": 20,
+ "items": {
+ "$ref": "#/definitions/PromptDTO"
+ }
+ }
+ }
+ },
+ "PromptDTO": {
+ "type": "object",
+ "description": "Prompt for an answer.",
+ "properties": {
+ "displayOrder": {
+ "type": "integer",
+ "description": "Index of the prompt - used in ordering of the prompts",
+ "format": "int32"
+ },
+ "qnaId": {
+ "type": "integer",
+ "description": "Qna id corresponding to the prompt - if QnaId is present, QnADTO object is ignored.",
+ "format": "int32"
+ },
+ "qna": {
+ "description": "QnADTO - Either QnaId or QnADTO needs to be present in a PromptDTO object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/QnADTO"
+ }
+ ]
+ },
+ "displayText": {
+ "type": "string",
+ "description": "Text displayed to represent a follow up question prompt",
+ "maxLength": 200
+ }
+ }
+ },
+ "MetadataDTO": {
+ "type": "object",
+ "description": "Name - value pair of metadata.",
+ "additionalProperties": false,
+ "required": [
+ "name",
+ "value"
+ ],
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "Metadata name.",
+ "maxLength": 100,
+ "minLength": 1
+ },
+ "value": {
+ "type": "string",
+ "description": "Metadata value.",
+ "maxLength": 500,
+ "minLength": 1
+ }
+ }
+ },
+ "ErrorResponse": {
+ "type": "object",
+ "description": "Error response. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.",
+ "additionalProperties": false,
+ "properties": {
+ "error": {
+ "description": "The error object.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/Error"
+ }
+ ]
+ }
+ }
+ },
+ "Error": {
+ "type": "object",
+ "description": "The error object. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.",
+ "additionalProperties": false,
+ "required": [
+ "code"
+ ],
+ "properties": {
+ "code": {
+ "description": "One of a server-defined set of error codes.",
+ "$ref": "#/definitions/ErrorCode"
+ },
+ "message": {
+ "type": "string",
+ "description": "A human-readable representation of the error."
+ },
+ "target": {
+ "type": "string",
+ "description": "The target of the error."
+ },
+ "details": {
+ "type": "array",
+ "description": "An array of details about specific errors that led to this reported error.",
+ "items": {
+ "$ref": "#/definitions/Error"
+ }
+ },
+ "innerError": {
+ "description": "An object containing more specific information than the current object about the error.",
+ "$ref": "#/definitions/InnerErrorModel"
+ }
+ }
+ },
+ "ErrorCode": {
+ "type": "string",
+ "description": "Human readable error code.",
+ "x-ms-enum": {
+ "name": "ErrorCodeType",
+ "modelAsString": true
+ },
+ "enum": [
+ "BadArgument",
+ "Forbidden",
+ "NotFound",
+ "KbNotFound",
+ "Unauthorized",
+ "Unspecified",
+ "EndpointKeysError",
+ "QuotaExceeded",
+ "QnaRuntimeError",
+ "SKULimitExceeded",
+ "OperationNotFound",
+ "ServiceError",
+ "ValidationFailure",
+ "ExtractionFailure"
+ ]
+ },
+ "InnerErrorModel": {
+ "type": "object",
+ "description": "An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.",
+ "additionalProperties": false,
+ "properties": {
+ "code": {
+ "type": "string",
+ "description": "A more specific error code than was provided by the containing error."
+ },
+ "innerError": {
+ "description": "An object containing more specific information than the current object about the error.",
+ "$ref": "#/definitions/InnerErrorModel"
+ }
+ }
+ },
+ "Operation": {
+ "type": "object",
+ "description": "Record to track long running operation.",
+ "additionalProperties": false,
+ "properties": {
+ "operationState": {
+ "description": "Operation state.",
+ "$ref": "#/definitions/OperationState"
+ },
+ "createdTimestamp": {
+ "type": "string",
+ "description": "Timestamp when the operation was created."
+ },
+ "lastActionTimestamp": {
+ "type": "string",
+ "description": "Timestamp when the current state was entered."
+ },
+ "resourceLocation": {
+ "type": "string",
+ "description": "Relative URI to the target resource location for completed resources."
+ },
+ "userId": {
+ "type": "string",
+ "description": "User Id"
+ },
+ "operationId": {
+ "type": "string",
+ "description": "Operation Id."
+ },
+ "errorResponse": {
+ "description": "Error details in case of failures.",
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "OperationState": {
+ "type": "string",
+ "description": "Enumeration of operation states.",
+ "x-ms-enum": {
+ "name": "OperationStateType",
+ "modelAsString": true
+ },
+ "enum": [
+ "Failed",
+ "NotStarted",
+ "Running",
+ "Succeeded"
+ ]
+ },
+ "KnowledgebasesDTO": {
+ "type": "object",
+ "description": "Collection of knowledgebases owned by a user.",
+ "additionalProperties": false,
+ "properties": {
+ "knowledgebases": {
+ "type": "array",
+ "description": "Collection of knowledgebase records.",
+ "items": {
+ "$ref": "#/definitions/KnowledgebaseDTO"
+ }
+ }
+ }
+ },
+ "KnowledgebaseDTO": {
+ "type": "object",
+ "description": "Response schema for CreateKb operation.",
+ "additionalProperties": false,
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "Unique id that identifies a knowledgebase."
+ },
+ "hostName": {
+ "type": "string",
+ "description": "URL host name at which the knowledgebase is hosted."
+ },
+ "lastAccessedTimestamp": {
+ "type": "string",
+ "description": "Time stamp at which the knowledgebase was last accessed (UTC)."
+ },
+ "lastChangedTimestamp": {
+ "type": "string",
+ "description": "Time stamp at which the knowledgebase was last modified (UTC)."
+ },
+ "lastPublishedTimestamp": {
+ "type": "string",
+ "description": "Time stamp at which the knowledgebase was last published (UTC)."
+ },
+ "name": {
+ "type": "string",
+ "description": "Friendly name of the knowledgebase."
+ },
+ "userId": {
+ "type": "string",
+ "description": "User who created / owns the knowledgebase."
+ },
+ "urls": {
+ "type": "array",
+ "description": "URL sources from which Q-A were extracted and added to the knowledgebase.",
+ "items": {
+ "type": "string"
+ }
+ },
+ "sources": {
+ "type": "array",
+ "description": "Custom sources from which Q-A were extracted or explicitly added to the knowledgebase.",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "EndpointSettingsDTO": {
+ "type": "object",
+ "description": "Endpoint settings.",
+ "additionalProperties": false,
+ "properties": {
+ "activeLearning": {
+ "description": "Active Learning settings of the endpoint.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ActiveLearningSettingsDTO"
+ }
+ ]
+ }
+ }
+ },
+ "ActiveLearningSettingsDTO": {
+ "type": "object",
+ "description": "Active Learning settings of the endpoint.",
+ "additionalProperties": false,
+ "properties": {
+ "enable": {
+ "type": "string",
+ "description": "True/False string providing Active Learning"
+ }
+ }
+ },
+ "WordAlterationsDTO": {
+ "type": "object",
+ "description": "Collection of word alterations.",
+ "additionalProperties": false,
+ "required": [
+ "wordAlterations"
+ ],
+ "properties": {
+ "wordAlterations": {
+ "type": "array",
+ "description": "Collection of word alterations.",
+ "maxLength": 10000,
+ "items": {
+ "$ref": "#/definitions/AlterationsDTO"
+ }
+ }
+ }
+ },
+ "AlterationsDTO": {
+ "type": "object",
+ "description": "Collection of words that are synonyms.",
+ "additionalProperties": false,
+ "required": [
+ "alterations"
+ ],
+ "properties": {
+ "alterations": {
+ "type": "array",
+ "description": "Words that are synonymous with each other.",
+ "maxLength": 20,
+ "minLength": 1,
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "EndpointKeysDTO": {
+ "type": "object",
+ "description": "Schema for EndpointKeys generate/refresh operations.",
+ "additionalProperties": false,
+ "properties": {
+ "primaryEndpointKey": {
+ "type": "string",
+ "description": "Primary Access Key."
+ },
+ "secondaryEndpointKey": {
+ "type": "string",
+ "description": "Secondary Access Key."
+ },
+ "installedVersion": {
+ "type": "string",
+ "description": "Current version of runtime."
+ },
+ "lastStableVersion": {
+ "type": "string",
+ "description": "Latest version of runtime."
+ },
+ "language": {
+ "type": "string",
+ "description": "Language setting of runtime."
+ }
+ }
+ },
+ "QueryDTO": {
+ "type": "object",
+ "description": "POST body schema to query the knowledgebase.",
+ "additionalProperties": false,
+ "properties": {
+ "qnaId": {
+ "type": "string",
+ "description": "Exact qnaId to fetch from the knowledgebase, this field takes priority over question."
+ },
+ "question": {
+ "type": "string",
+ "description": "User question to query against the knowledge base."
+ },
+ "top": {
+ "type": "integer",
+ "description": "Max number of answers to be returned for the question.",
+ "format": "int32"
+ },
+ "userId": {
+ "type": "string",
+ "description": "Unique identifier for the user."
+ },
+ "isTest": {
+ "type": "boolean",
+ "description": "Query against the test index."
+ },
+ "scoreThreshold": {
+ "type": "number",
+ "description": "Minimum threshold score for answers."
+ },
+ "context": {
+ "description": "Context object with previous QnA's information.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/QueryContextDTO"
+ }
+ ]
+ },
+ "rankerType": {
+ "type": "string",
+ "description": "Optional field. Set to 'QuestionOnly' for using a question only Ranker."
+ },
+ "strictFilters": {
+ "type": "array",
+ "description": "Find QnAs that are associated with the given list of metadata.",
+ "items": {
+ "$ref": "#/definitions/MetadataDTO"
+ }
+ },
+ "strictFiltersCompoundOperationType": {
+ "type": "string",
+ "description": "Optional field. Set to 'OR' for using OR operation for strict filters.",
+ "x-ms-enum": {
+ "name": "StrictFiltersCompoundOperationType",
+ "modelAsString": true
+ },
+ "enum": [
+ "AND",
+ "OR"
+ ]
+ },
+ "answerSpanRequest": {
+ "description": "To configure Answer span prediction feature.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/AnswerSpanRequestDTO"
+ }
+ ]
+ }
+ }
+ },
+ "QueryContextDTO": {
+ "type": "object",
+ "description": "Context object with previous QnA's information.",
+ "additionalProperties": false,
+ "properties": {
+ "previousQnaId": {
+ "type": "integer",
+ "description": "Previous QnA Id - qnaId of the top result."
+ },
+ "previousUserQuery": {
+ "type": "string",
+ "description": "Previous user query."
+ }
+ }
+ },
+ "QnASearchResultList": {
+ "type": "object",
+ "description": "Represents List of Question Answers.",
+ "additionalProperties": false,
+ "properties": {
+ "answers": {
+ "type": "array",
+ "description": "Represents Search Result list.",
+ "items": {
+ "$ref": "#/definitions/QnASearchResult"
+ }
+ }
+ }
+ },
+ "QnASearchResult": {
+ "type": "object",
+ "description": "Represents Search Result.",
+ "additionalProperties": false,
+ "properties": {
+ "questions": {
+ "type": "array",
+ "description": "List of questions.",
+ "items": {
+ "type": "string"
+ }
+ },
+ "answer": {
+ "type": "string",
+ "description": "Answer."
+ },
+ "score": {
+ "type": "number",
+ "description": "Search result score."
+ },
+ "id": {
+ "type": "integer",
+ "description": "Id of the QnA result.",
+ "format": "int32"
+ },
+ "source": {
+ "type": "string",
+ "description": "Source of QnA result."
+ },
+ "metadata": {
+ "type": "array",
+ "description": "List of metadata.",
+ "items": {
+ "$ref": "#/definitions/MetadataDTO"
+ }
+ },
+ "context": {
+ "type": "object",
+ "description": "Context object of the QnA",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ContextDTO"
+ }
+ ]
+ },
+ "answerSpan": {
+ "type": "object",
+ "description": "Answer span object of QnA with respect to user's question.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/AnswerSpanResponseDTO"
+ }
+ ]
+ }
+ }
+ },
+ "FeedbackRecordsDTO": {
+ "type": "object",
+ "description": "Active learning feedback records.",
+ "additionalProperties": false,
+ "properties": {
+ "feedbackRecords": {
+ "type": "array",
+ "description": "List of feedback records.",
+ "maxLength": 1000,
+ "items": {
+ "$ref": "#/definitions/FeedbackRecordDTO"
+ }
+ }
+ }
+ },
+ "FeedbackRecordDTO": {
+ "type": "object",
+ "description": "Active learning feedback record.",
+ "additionalProperties": false,
+ "properties": {
+ "userId": {
+ "type": "string",
+ "description": "Unique identifier for the user."
+ },
+ "userQuestion": {
+ "type": "string",
+ "description": "The suggested question being provided as feedback.",
+ "maxLength": 1000
+ },
+ "qnaId": {
+ "type": "integer",
+ "description": "The qnaId for which the suggested question is provided as feedback.",
+ "format": "int32"
+ }
+ }
+ },
+ "AnswerSpanRequestDTO": {
+ "type": "object",
+ "description": "To configure Answer span prediction feature.",
+ "additionalProperties": false,
+ "properties": {
+ "enable": {
+ "type": "boolean",
+ "description": "Enable or Disable Answer Span prediction."
+ },
+ "scoreThreshold": {
+ "type": "number",
+ "format": "double",
+ "description": "Minimum threshold score required to include an answer span."
+ },
+ "topAnswersWithSpan": {
+ "type": "integer",
+ "description": "Number of Top answers to be considered for span prediction.",
+ "format": "int32",
+ "maximum": 10,
+ "minimum": 1
+ }
+ }
+ },
+ "AnswerSpanResponseDTO": {
+ "type": "object",
+ "description": "Answer span object of QnA.",
+ "additionalProperties": false,
+ "properties": {
+ "text": {
+ "type": "string",
+ "description": "Predicted text of answer span."
+ },
+ "score": {
+ "type": "number",
+ "description": "Predicted score of answer span.",
+ "format": "double"
+ },
+ "startIndex": {
+ "type": "integer",
+ "description": "Start index of answer span in answer.",
+ "format": "int32"
+ },
+ "endIndex": {
+ "type": "integer",
+ "description": "End index of answer span in answer.",
+ "format": "int32"
+ }
+ }
+ }
+ },
+ "parameters": {
+ "Environment": {
+ "type": "string",
+ "name": "environment",
+ "in": "path",
+ "required": true,
+ "x-nullable": false,
+ "description": "Specifies whether environment is Test or Prod.",
+ "x-ms-enum": {
+ "name": "EnvironmentType",
+ "modelAsString": true
+ },
+ "enum": [
+ "Prod",
+ "Test"
+ ],
+ "x-ms-parameter-location": "method"
+ },
+ "CreateKbPayload": {
+ "name": "createKbPayload",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/CreateKbDTO"
+ },
+ "x-nullable": true,
+ "description": "Post body of the request.",
+ "x-ms-parameter-location": "method"
+ },
+ "UpdateKb": {
+ "name": "updateKb",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/UpdateKbOperationDTO"
+ },
+ "x-nullable": true,
+ "description": "Post body of the request.",
+ "x-ms-parameter-location": "method"
+ },
+ "ReplaceKb": {
+ "name": "replaceKb",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/ReplaceKbDTO"
+ },
+ "x-nullable": true,
+ "description": "An instance of ReplaceKbDTO which contains list of qnas to be uploaded",
+ "x-ms-parameter-location": "method"
+ },
+ "KbId": {
+ "type": "string",
+ "name": "kbId",
+ "in": "path",
+ "required": true,
+ "x-nullable": false,
+ "description": "Knowledgebase id.",
+ "x-ms-parameter-location": "method"
+ },
+ "OperationId": {
+ "type": "string",
+ "name": "operationId",
+ "in": "path",
+ "required": true,
+ "x-nullable": false,
+ "description": "Operation id.",
+ "x-ms-parameter-location": "method"
+ },
+ "WordAlterations": {
+ "name": "wordAlterations",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/WordAlterationsDTO"
+ },
+ "x-nullable": true,
+ "description": "New alterations data.",
+ "x-ms-parameter-location": "method"
+ },
+ "KeyType": {
+ "type": "string",
+ "name": "keyType",
+ "in": "path",
+ "required": true,
+ "x-nullable": false,
+ "description": "Type of Key",
+ "x-ms-parameter-location": "method"
+ },
+ "GenerateAnswerPayload": {
+ "name": "generateAnswerPayload",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/QueryDTO"
+ },
+ "x-nullable": true,
+ "description": "Post body of the request.",
+ "x-ms-parameter-location": "method"
+ },
+ "TrainPayload": {
+ "name": "trainPayload",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/FeedbackRecordsDTO"
+ },
+ "x-nullable": true,
+ "description": "Post body of the request.",
+ "x-ms-parameter-location": "method"
+ },
+ "Endpoint": {
+ "name": "Endpoint",
+ "description": "Supported Cognitive Services endpoint (e.g., https://< qnamaker-resource-name >.api.cognitiveservices.azure.com).",
+ "x-ms-parameter-location": "client",
+ "required": true,
+ "type": "string",
+ "in": "path",
+ "x-ms-skip-url-encoding": true
+ },
+ "EndpointSettingsPayload": {
+ "name": "endpointSettingsPayload",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/EndpointSettingsDTO"
+ },
+ "x-nullable": true,
+ "description": "Post body of the request.",
+ "x-ms-parameter-location": "method"
+ }
+ }
+}
diff --git a/specification/cognitiveservices/data-plane/QnAMaker/preview/v5.0-preview.1/examples/SuccessfulCreateKb.json b/specification/cognitiveservices/data-plane/QnAMaker/preview/v5.0-preview.1/examples/SuccessfulCreateKb.json
new file mode 100644
index 000000000000..2f0bc8e9ee82
--- /dev/null
+++ b/specification/cognitiveservices/data-plane/QnAMaker/preview/v5.0-preview.1/examples/SuccessfulCreateKb.json
@@ -0,0 +1,93 @@
+{
+ "parameters": {
+ "Endpoint": "{Endpoint}",
+ "Content-Type": "application/json",
+ "Ocp-Apim-Subscription-Key": "{API key}",
+ "createKbPayload": {
+ "name": "QnA Maker FAQ",
+ "qnaList": [
+ {
+ "id": 0,
+ "answer": "You can change the default message if you use the QnAMakerDialog. See this for details: https://docs.botframework.com/en-us/azure-bot-service/templates/qnamaker/#navtitle",
+ "source": "Custom Editorial",
+ "questions": [
+ "How can I change the default message from QnA Maker?"
+ ],
+ "metadata": []
+ },
+ {
+ "id": 0,
+ "answer": "You can use our REST apis to create a KB. See here for details: https://docs.microsoft.com/en-us/rest/api/cognitiveservices/qnamaker/knowledgebase/create",
+ "source": "Custom Editorial",
+ "questions": [
+ "How do I programmatically create a KB?"
+ ],
+ "metadata": [
+ {
+ "name": "category",
+ "value": "api"
+ }
+ ],
+ "context": {
+ "isContextOnly": false,
+ "prompts": [
+ {
+ "displayOrder": 1,
+ "displayText": "Update KB",
+ "qna": {
+ "answer": "You can use our REST apis to update your KB. See here for details: https://docs.microsoft.com/en-us/rest/api/cognitiveservices/qnamaker/knowledgebase/update",
+ "questions": [
+ "How do I programmatically update my KB?"
+ ],
+ "metadata": [
+ {
+ "name": "category",
+ "value": "api"
+ }
+ ],
+ "context": {
+ "isContextOnly": false,
+ "prompts": [
+ {
+ "displayOrder": 1,
+ "displayText": "Refresh Endpoint Keys",
+ "qna": {
+ "answer": "You can use our REST apis to refresh endpoint keys. See here for details: https://docs.microsoft.com/en-us/rest/api/cognitiveservices/qnamaker/endpointkeys/refreshkeys",
+ "questions": [
+ "How do I programmatically refresh endpoint keys?"
+ ]
+ }
+ }
+ ]
+ }
+ }
+ }
+ ]
+ }
+ }
+ ],
+ "urls": [
+ "https://docs.microsoft.com/en-in/azure/cognitive-services/qnamaker/faqs",
+ "https://docs.microsoft.com/en-us/bot-framework/resources-bot-framework-faq"
+ ],
+ "files": [
+ {
+ "fileName": "SurfaceManual.pdf",
+ "fileUri": "https://download.microsoft.com/download/2/9/B/29B20383-302C-4517-A006-B0186F04BE28/surface-pro-4-user-guide-EN.pdf"
+ }
+ ]
+ }
+ },
+ "responses": {
+ "202": {
+ "headers": {},
+ "body": {
+ "operationState": "NotStarted",
+ "createdTimestamp": "2018-03-19T07:38:46Z",
+ "lastActionTimestamp": "2018-03-19T07:39:29Z",
+ "userId": "86bb8390-56c0-42c2-9f81-3de161981191",
+ "operationId": "03a4f4ce-30a6-4ec6-b436-02bcdf6153e1"
+ }
+ }
+ }
+}
diff --git a/specification/cognitiveservices/data-plane/QnAMaker/preview/v5.0-preview.1/examples/SuccessfulDelKb.json b/specification/cognitiveservices/data-plane/QnAMaker/preview/v5.0-preview.1/examples/SuccessfulDelKb.json
new file mode 100644
index 000000000000..bcd50173c37b
--- /dev/null
+++ b/specification/cognitiveservices/data-plane/QnAMaker/preview/v5.0-preview.1/examples/SuccessfulDelKb.json
@@ -0,0 +1,11 @@
+{
+ "parameters": {
+ "Endpoint": "{Endpoint}",
+ "Content-Type": "application/json",
+ "Ocp-Apim-Subscription-Key": "{API key}",
+ "kbId": "9d091697-fb8c-4ed5-9ac0-35bf8273bfff"
+ },
+ "responses": {
+ "204": {}
+ }
+}
diff --git a/specification/cognitiveservices/data-plane/QnAMaker/preview/v5.0-preview.1/examples/SuccessfulDownloadKb.json b/specification/cognitiveservices/data-plane/QnAMaker/preview/v5.0-preview.1/examples/SuccessfulDownloadKb.json
new file mode 100644
index 000000000000..9c4bb3d38824
--- /dev/null
+++ b/specification/cognitiveservices/data-plane/QnAMaker/preview/v5.0-preview.1/examples/SuccessfulDownloadKb.json
@@ -0,0 +1,96 @@
+{
+ "parameters": {
+ "Endpoint": "{Endpoint}",
+ "Content-Type": "application/json",
+ "Ocp-Apim-Subscription-Key": "{API key}",
+ "kbId": "9d091697-fb8c-4ed5-9ac0-35bf8273bfff",
+ "environment": "Test"
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": {
+ "qnaDocuments": [
+ {
+ "id": 1,
+ "answer": "You can change the default message if you use the QnAMakerDialog. See this for details: https://docs.botframework.com/en-us/azure-bot-service/templates/qnamaker/#navtitle",
+ "source": "Custom Editorial",
+ "questions": [
+ "How can I change the default message from QnA Maker?"
+ ],
+ "metadata": [],
+ "context": {
+ "isContextOnly": false,
+ "prompts": []
+ },
+ "lastUpdatedTimestamp": "2020-08-27T16:00:30.272746+00:00"
+ },
+ {
+ "id": 2,
+ "answer": "You can use our REST apis to create a KB. See here for details: https://docs.microsoft.com/en-us/rest/api/cognitiveservices/qnamaker/knowledgebase/create",
+ "source": "Custom Editorial",
+ "questions": [
+ "How do I programmatically create a KB?"
+ ],
+ "metadata": [
+ {
+ "name": "category",
+ "value": "api"
+ }
+ ],
+ "context": {
+ "isContextOnly": false,
+ "prompts": [
+ {
+ "displayOrder": 1,
+ "qnaId": 3,
+ "displayText": "Update KB"
+ }
+ ]
+ },
+ "lastUpdatedTimestamp": "2020-08-27T16:00:30.272746+00:00"
+ },
+ {
+ "id": 3,
+ "answer": "You can use our REST apis to update your KB. See here for details: https://docs.microsoft.com/en-us/rest/api/cognitiveservices/qnamaker/knowledgebase/update",
+ "source": "Editorial",
+ "questions": [
+ "How do I programmatically update my KB?"
+ ],
+ "metadata": [
+ {
+ "name": "category",
+ "value": "api"
+ }
+ ],
+ "context": {
+ "isContextOnly": false,
+ "prompts": [
+ {
+ "displayOrder": 1,
+ "qnaId": 4,
+ "displayText": "Refresh Endpoint Keys"
+ }
+ ]
+ },
+ "lastUpdatedTimestamp": "2020-08-27T16:00:30.272746+00:00"
+ },
+ {
+ "id": 4,
+ "answer": "You can use our REST apis to refresh endpoint keys. See here for details: https://docs.microsoft.com/en-us/rest/api/cognitiveservices/qnamaker/endpointkeys/refreshkeys",
+ "source": "Editorial",
+ "questions": [
+ "How do I programmatically refresh endpoint keys?"
+ ],
+ "metadata": [],
+ "context": {
+ "isContextOnly": false,
+ "prompts": []
+ },
+ "lastUpdatedTimestamp": "2020-08-27T16:00:30.272746+00:00"
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/cognitiveservices/data-plane/QnAMaker/preview/v5.0-preview.1/examples/SuccessfulGenAns.json b/specification/cognitiveservices/data-plane/QnAMaker/preview/v5.0-preview.1/examples/SuccessfulGenAns.json
new file mode 100644
index 000000000000..c225ade135db
--- /dev/null
+++ b/specification/cognitiveservices/data-plane/QnAMaker/preview/v5.0-preview.1/examples/SuccessfulGenAns.json
@@ -0,0 +1,59 @@
+{
+ "parameters": {
+ "Endpoint": "{Endpoint}",
+ "Ocp-Apim-Subscription-Key": "{API key}",
+ "Content-Type": "application/json",
+ "kbId": "9d091697-fb8c-4ed5-9ac0-35bf8273bfff",
+ "generateAnswerPayload": {
+ "question": "How much time it takes to complete quickstart guide?",
+ "top": 6,
+ "isTest": true,
+ "context": {
+ "previousQnaId": 9,
+ "previousUserQuery": "Where are QnA Maker quickstarts?"
+ },
+ "scoreThreshold": 20,
+ "strictFilters": [
+ {
+ "name": "category",
+ "value": "api"
+ }
+ ],
+ "answerSpanRequest": {
+ "enable": true,
+ "scoreThreshold": 25,
+ "topAnswersWithSpan": 1
+ },
+ "userId": "sd53lsY="
+ }
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": {
+ "answers": [
+ {
+ "questions": [
+ "Complete a quickstart"
+ ],
+ "answer": "We offer quickstarts in most popular programming languages, each designed to teach you basic design patterns, and have you running code in less than 10 minutes. See the following list for the quickstart for each feature.\n\n* [Get started with the LUIS client library](https://docs.microsoft.com/en-us/azure/cognitive-services/qnamaker/quickstarts/quickstart-sdk)\n\n* [Get started with the LUIS portal](https://docs.microsoft.com/en-us/azure/cognitive-services/qnamaker/quickstarts/create-publish-knowledge-base)\n\n* [Get started with the LUIS REST APis](https://docs.microsoft.com/en-us/azure/cognitive-services/qnamaker/quickstarts/quickstart-rest-curl)",
+ "score": 46.11,
+ "id": 9,
+ "source": "Editorial",
+ "metadata": [],
+ "context": {
+ "isContextOnly": false,
+ "prompts": []
+ },
+ "answerSpan": {
+ "text": "less than 10 minutes",
+ "score": 54.92,
+ "startIndex": 139,
+ "endIndex": 159
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/cognitiveservices/data-plane/QnAMaker/preview/v5.0-preview.1/examples/SuccessfulGetAlts.json b/specification/cognitiveservices/data-plane/QnAMaker/preview/v5.0-preview.1/examples/SuccessfulGetAlts.json
new file mode 100644
index 000000000000..465b1152950e
--- /dev/null
+++ b/specification/cognitiveservices/data-plane/QnAMaker/preview/v5.0-preview.1/examples/SuccessfulGetAlts.json
@@ -0,0 +1,34 @@
+{
+ "parameters": {
+ "Endpoint": "{Endpoint}",
+ "Content-Type": "application/json",
+ "Ocp-Apim-Subscription-Key": "{API key}"
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": {
+ "wordAlterations": [
+ {
+ "alterations": [
+ "qnamaker",
+ "qna maker"
+ ]
+ },
+ {
+ "alterations": [
+ "botframework",
+ "bot framework"
+ ]
+ },
+ {
+ "alterations": [
+ "webchat",
+ "web chat"
+ ]
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/cognitiveservices/data-plane/QnAMaker/preview/v5.0-preview.1/examples/SuccessfulGetAltsForKb.json b/specification/cognitiveservices/data-plane/QnAMaker/preview/v5.0-preview.1/examples/SuccessfulGetAltsForKb.json
new file mode 100644
index 000000000000..dcd63a18be30
--- /dev/null
+++ b/specification/cognitiveservices/data-plane/QnAMaker/preview/v5.0-preview.1/examples/SuccessfulGetAltsForKb.json
@@ -0,0 +1,35 @@
+{
+ "parameters": {
+ "Endpoint": "{Endpoint}",
+ "Content-Type": "application/json",
+ "Ocp-Apim-Subscription-Key": "{API key}",
+ "kbId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": {
+ "wordAlterations": [
+ {
+ "alterations": [
+ "qnamaker",
+ "qna maker"
+ ]
+ },
+ {
+ "alterations": [
+ "botframework",
+ "bot framework"
+ ]
+ },
+ {
+ "alterations": [
+ "webchat",
+ "web chat"
+ ]
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/cognitiveservices/data-plane/QnAMaker/preview/v5.0-preview.1/examples/SuccessfulGetEpKeys.json b/specification/cognitiveservices/data-plane/QnAMaker/preview/v5.0-preview.1/examples/SuccessfulGetEpKeys.json
new file mode 100644
index 000000000000..a32d6baa42de
--- /dev/null
+++ b/specification/cognitiveservices/data-plane/QnAMaker/preview/v5.0-preview.1/examples/SuccessfulGetEpKeys.json
@@ -0,0 +1,18 @@
+{
+ "parameters": {
+ "Endpoint": "{Endpoint}",
+ "Content-Type": "application/json",
+ "Ocp-Apim-Subscription-Key": "{API key}"
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": {
+ "primaryEndpointKey": "73e88a14-694a-44d5-883b-184a68aa8530",
+ "secondaryEndpointKey": "b2c98c16-ca31-4294-8626-6c57454a5063",
+ "installedVersion": "4.0.5",
+ "lastStableVersion": "4.0.6"
+ }
+ }
+ }
+}
diff --git a/specification/cognitiveservices/data-plane/QnAMaker/preview/v5.0-preview.1/examples/SuccessfulGetEpSettings.json b/specification/cognitiveservices/data-plane/QnAMaker/preview/v5.0-preview.1/examples/SuccessfulGetEpSettings.json
new file mode 100644
index 000000000000..97cc7fcac360
--- /dev/null
+++ b/specification/cognitiveservices/data-plane/QnAMaker/preview/v5.0-preview.1/examples/SuccessfulGetEpSettings.json
@@ -0,0 +1,17 @@
+{
+ "parameters": {
+ "Endpoint": "{Endpoint}",
+ "Content-Type": "application/json",
+ "Ocp-Apim-Subscription-Key": "{API key}"
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": {
+ "activeLearning": {
+ "enable": "True"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/cognitiveservices/data-plane/QnAMaker/preview/v5.0-preview.1/examples/SuccessfulGetKb.json b/specification/cognitiveservices/data-plane/QnAMaker/preview/v5.0-preview.1/examples/SuccessfulGetKb.json
new file mode 100644
index 000000000000..fbec604c70f5
--- /dev/null
+++ b/specification/cognitiveservices/data-plane/QnAMaker/preview/v5.0-preview.1/examples/SuccessfulGetKb.json
@@ -0,0 +1,30 @@
+{
+ "parameters": {
+ "Endpoint": "{Endpoint}",
+ "Content-Type": "application/json",
+ "Ocp-Apim-Subscription-Key": "{API key}",
+ "kbId": "9d091697-fb8c-4ed5-9ac0-35bf8273bfff"
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": {
+ "id": "9d091697-fb8c-4ed5-9ac0-35bf8273bfff",
+ "hostName": "https://myqnamakerbot.azurewebsites.net",
+ "lastAccessedTimestamp": "2018-03-16T10:59:46Z",
+ "lastChangedTimestamp": "2018-03-16T10:58:10Z",
+ "lastPublishedTimestamp": "2018-03-16T10:59:56Z",
+ "name": "My QnA Maker Bot",
+ "userId": "03a4f4ce-30a6-4ec6-b436-02bcdf6153e1",
+ "urls": [
+ "https://docs.microsoft.com/en-in/azure/cognitive-services/qnamaker/faqs",
+ "https://docs.microsoft.com/en-us/bot-framework/resources-bot-framework-faq"
+ ],
+ "sources": [
+ "Custom Editorial",
+ "SurfaceManual.pdf"
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/cognitiveservices/data-plane/QnAMaker/preview/v5.0-preview.1/examples/SuccessfulGetOps.json b/specification/cognitiveservices/data-plane/QnAMaker/preview/v5.0-preview.1/examples/SuccessfulGetOps.json
new file mode 100644
index 000000000000..85e84d90aed9
--- /dev/null
+++ b/specification/cognitiveservices/data-plane/QnAMaker/preview/v5.0-preview.1/examples/SuccessfulGetOps.json
@@ -0,0 +1,21 @@
+{
+ "parameters": {
+ "Endpoint": "{Endpoint}",
+ "Content-Type": "application/json",
+ "Ocp-Apim-Subscription-Key": "{API key}",
+ "operationId": "03a4f4ce-30a6-4ec6-b436-02bcdf6153e1"
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": {
+ "operationState": "Succeeded",
+ "createdTimestamp": "2018-03-19T07:38:46Z",
+ "lastActionTimestamp": "2018-03-19T07:39:29Z",
+ "resourceLocation": "https://westus.api.cognitive.microsoft.com/qnamaker/v4.0/knowledgebases/9d091697-fb8c-4ed5-9ac0-35bf8273bfff",
+ "userId": "86bb8390-56c0-42c2-9f81-3de161981191",
+ "operationId": "03a4f4ce-30a6-4ec6-b436-02bcdf6153e1"
+ }
+ }
+ }
+}
diff --git a/specification/cognitiveservices/data-plane/QnAMaker/preview/v5.0-preview.1/examples/SuccessfulKbsResponse.json b/specification/cognitiveservices/data-plane/QnAMaker/preview/v5.0-preview.1/examples/SuccessfulKbsResponse.json
new file mode 100644
index 000000000000..aab19445e730
--- /dev/null
+++ b/specification/cognitiveservices/data-plane/QnAMaker/preview/v5.0-preview.1/examples/SuccessfulKbsResponse.json
@@ -0,0 +1,33 @@
+{
+ "parameters": {
+ "Endpoint": "{Endpoint}",
+ "Content-Type": "application/json",
+ "Ocp-Apim-Subscription-Key": "{API key}"
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": {
+ "knowledgebases": [
+ {
+ "id": "9d091697-fb8c-4ed5-9ac0-35bf8273bfff",
+ "hostName": "https://myqnamakerbot.azurewebsites.net",
+ "lastAccessedTimestamp": "2018-03-16T10:59:46Z",
+ "lastChangedTimestamp": "2018-03-16T10:58:10Z",
+ "lastPublishedTimestamp": "2018-03-16T10:59:56Z",
+ "name": "My QnA Maker Bot",
+ "userId": "03a4f4ce-30a6-4ec6-b436-02bcdf6153e1",
+ "urls": [
+ "https://docs.microsoft.com/en-in/azure/cognitive-services/qnamaker/faqs",
+ "https://docs.microsoft.com/en-us/bot-framework/resources-bot-framework-faq"
+ ],
+ "sources": [
+ "Custom Editorial",
+ "SurfaceManual.pdf"
+ ]
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/cognitiveservices/data-plane/QnAMaker/preview/v5.0-preview.1/examples/SuccessfulPubKb.json b/specification/cognitiveservices/data-plane/QnAMaker/preview/v5.0-preview.1/examples/SuccessfulPubKb.json
new file mode 100644
index 000000000000..bcd50173c37b
--- /dev/null
+++ b/specification/cognitiveservices/data-plane/QnAMaker/preview/v5.0-preview.1/examples/SuccessfulPubKb.json
@@ -0,0 +1,11 @@
+{
+ "parameters": {
+ "Endpoint": "{Endpoint}",
+ "Content-Type": "application/json",
+ "Ocp-Apim-Subscription-Key": "{API key}",
+ "kbId": "9d091697-fb8c-4ed5-9ac0-35bf8273bfff"
+ },
+ "responses": {
+ "204": {}
+ }
+}
diff --git a/specification/cognitiveservices/data-plane/QnAMaker/preview/v5.0-preview.1/examples/SuccessfulRepKb.json b/specification/cognitiveservices/data-plane/QnAMaker/preview/v5.0-preview.1/examples/SuccessfulRepKb.json
new file mode 100644
index 000000000000..fd6ba1224539
--- /dev/null
+++ b/specification/cognitiveservices/data-plane/QnAMaker/preview/v5.0-preview.1/examples/SuccessfulRepKb.json
@@ -0,0 +1,38 @@
+{
+ "parameters": {
+ "Endpoint": "{Endpoint}",
+ "Content-Type": "application/json",
+ "Ocp-Apim-Subscription-Key": "{API key}",
+ "kbId": "9d091697-fb8c-4ed5-9ac0-35bf8273bfff",
+ "replaceKb": {
+ "qnAList": [
+ {
+ "id": 0,
+ "answer": "You can change the default message if you use the QnAMakerDialog. See this for details: https://docs.botframework.com/en-us/azure-bot-service/templates/qnamaker/#navtitle",
+ "source": "Custom Editorial",
+ "questions": [
+ "How can I change the default message from QnA Maker?"
+ ],
+ "metadata": []
+ },
+ {
+ "id": 0,
+ "answer": "You can use our REST apis to create a KB. See here for details: https://docs.microsoft.com/en-us/rest/api/cognitiveservices/qnamaker/knowledgebase/create",
+ "source": "Custom Editorial",
+ "questions": [
+ "How do I programmatically create a KB?"
+ ],
+ "metadata": [
+ {
+ "name": "category",
+ "value": "api"
+ }
+ ]
+ }
+ ]
+ }
+ },
+ "responses": {
+ "204": {}
+ }
+}
diff --git a/specification/cognitiveservices/data-plane/QnAMaker/preview/v5.0-preview.1/examples/SuccessfulSetAlts.json b/specification/cognitiveservices/data-plane/QnAMaker/preview/v5.0-preview.1/examples/SuccessfulSetAlts.json
new file mode 100644
index 000000000000..ba8facefde92
--- /dev/null
+++ b/specification/cognitiveservices/data-plane/QnAMaker/preview/v5.0-preview.1/examples/SuccessfulSetAlts.json
@@ -0,0 +1,32 @@
+{
+ "parameters": {
+ "Endpoint": "{Endpoint}",
+ "Content-Type": "application/json",
+ "Ocp-Apim-Subscription-Key": "{API key}",
+ "wordAlterations": {
+ "wordAlterations": [
+ {
+ "alterations": [
+ "qnamaker",
+ "qna maker"
+ ]
+ },
+ {
+ "alterations": [
+ "botframework",
+ "bot framework"
+ ]
+ },
+ {
+ "alterations": [
+ "webchat",
+ "web chat"
+ ]
+ }
+ ]
+ }
+ },
+ "responses": {
+ "204": {}
+ }
+}
diff --git a/specification/cognitiveservices/data-plane/QnAMaker/preview/v5.0-preview.1/examples/SuccessfulSetAltsForKb.json b/specification/cognitiveservices/data-plane/QnAMaker/preview/v5.0-preview.1/examples/SuccessfulSetAltsForKb.json
new file mode 100644
index 000000000000..6dc5ca492391
--- /dev/null
+++ b/specification/cognitiveservices/data-plane/QnAMaker/preview/v5.0-preview.1/examples/SuccessfulSetAltsForKb.json
@@ -0,0 +1,33 @@
+{
+ "parameters": {
+ "Endpoint": "{Endpoint}",
+ "Content-Type": "application/json",
+ "Ocp-Apim-Subscription-Key": "{API key}",
+ "kbId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
+ "wordAlterations": {
+ "wordAlterations": [
+ {
+ "alterations": [
+ "qnamaker",
+ "qna maker"
+ ]
+ },
+ {
+ "alterations": [
+ "botframework",
+ "bot framework"
+ ]
+ },
+ {
+ "alterations": [
+ "webchat",
+ "web chat"
+ ]
+ }
+ ]
+ }
+ },
+ "responses": {
+ "204": {}
+ }
+}
diff --git a/specification/cognitiveservices/data-plane/QnAMaker/preview/v5.0-preview.1/examples/SuccessfulSetEpKeys.json b/specification/cognitiveservices/data-plane/QnAMaker/preview/v5.0-preview.1/examples/SuccessfulSetEpKeys.json
new file mode 100644
index 000000000000..925d4f65d77d
--- /dev/null
+++ b/specification/cognitiveservices/data-plane/QnAMaker/preview/v5.0-preview.1/examples/SuccessfulSetEpKeys.json
@@ -0,0 +1,19 @@
+{
+ "parameters": {
+ "Endpoint": "{Endpoint}",
+ "Content-Type": "application/json",
+ "Ocp-Apim-Subscription-Key": "{API key}",
+ "keyType": "PrimaryKey"
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": {
+ "primaryEndpointKey": "73e88a14-694a-44d5-883b-184a68aa8530",
+ "secondaryEndpointKey": "b2c98c16-ca31-4294-8626-6c57454a5063",
+ "installedVersion": "4.0.5",
+ "lastStableVersion": "4.0.6"
+ }
+ }
+ }
+}
diff --git a/specification/cognitiveservices/data-plane/QnAMaker/preview/v5.0-preview.1/examples/SuccessfulSetEpSettings.json b/specification/cognitiveservices/data-plane/QnAMaker/preview/v5.0-preview.1/examples/SuccessfulSetEpSettings.json
new file mode 100644
index 000000000000..468c0b59680a
--- /dev/null
+++ b/specification/cognitiveservices/data-plane/QnAMaker/preview/v5.0-preview.1/examples/SuccessfulSetEpSettings.json
@@ -0,0 +1,15 @@
+{
+ "parameters": {
+ "Endpoint": "{Endpoint}",
+ "Content-Type": "application/json",
+ "Ocp-Apim-Subscription-Key": "{API key}",
+ "endpointSettingsPayload": {
+ "activeLearning": {
+ "enable": "True"
+ }
+ }
+ },
+ "responses": {
+ "204": {}
+ }
+}
diff --git a/specification/cognitiveservices/data-plane/QnAMaker/preview/v5.0-preview.1/examples/SuccessfulTrain.json b/specification/cognitiveservices/data-plane/QnAMaker/preview/v5.0-preview.1/examples/SuccessfulTrain.json
new file mode 100644
index 000000000000..4dabb5d81c35
--- /dev/null
+++ b/specification/cognitiveservices/data-plane/QnAMaker/preview/v5.0-preview.1/examples/SuccessfulTrain.json
@@ -0,0 +1,20 @@
+{
+ "parameters": {
+ "Endpoint": "{Endpoint}",
+ "Ocp-Apim-Subscription-Key": "{Primary/Secondary Endpoint Key}",
+ "Content-Type": "application/json",
+ "kbId": "9d091697-fb8c-4ed5-9ac0-35bf8273bfff",
+ "trainPayload": {
+ "feedbackRecords": [
+ {
+ "userId": "sd53lsY=",
+ "userQuestion": "qna maker with luis",
+ "qnaId": 4
+ }
+ ]
+ }
+ },
+ "responses": {
+ "204": {}
+ }
+}
diff --git a/specification/cognitiveservices/data-plane/QnAMaker/preview/v5.0-preview.1/examples/SuccessfulUpdKb.json b/specification/cognitiveservices/data-plane/QnAMaker/preview/v5.0-preview.1/examples/SuccessfulUpdKb.json
new file mode 100644
index 000000000000..3c717ca27123
--- /dev/null
+++ b/specification/cognitiveservices/data-plane/QnAMaker/preview/v5.0-preview.1/examples/SuccessfulUpdKb.json
@@ -0,0 +1,155 @@
+{
+ "parameters": {
+ "Endpoint": "{Endpoint}",
+ "Content-Type": "application/json",
+ "Ocp-Apim-Subscription-Key": "{API key}",
+ "kbId": "9d091697-fb8c-4ed5-9ac0-35bf8273bfff",
+ "updateKb": {
+ "add": {
+ "qnaList": [
+ {
+ "id": 0,
+ "answer": "You can change the default message if you use the QnAMakerDialog. See this for details: https://docs.botframework.com/en-us/azure-bot-service/templates/qnamaker/#navtitle",
+ "source": "Custom Editorial",
+ "questions": [
+ "How can I change the default message from QnA Maker?"
+ ],
+ "metadata": []
+ }
+ ],
+ "urls": [
+ "https://docs.microsoft.com/en-us/azure/cognitive-services/Emotion/FAQ"
+ ],
+ "files": [
+ {
+ "fileName": "SurfaceManual.pdf",
+ "fileUri": "https://download.microsoft.com/download/2/9/B/29B20383-302C-4517-A006-B0186F04BE28/surface-pro-4-user-guide-EN.pdf"
+ }
+ ]
+ },
+ "delete": {
+ "ids": [
+ 13,
+ 35
+ ]
+ },
+ "update": {
+ "name": "QnA Maker FAQ Prompts Bot",
+ "qnaList": [
+ {
+ "id": 2,
+ "answer": "You can use our REST apis to create a KB. See here for details: https://docs.microsoft.com/en-us/rest/api/cognitiveservices/qnamaker/knowledgebase/create",
+ "source": "Custom Editorial",
+ "questions": {
+ "add": [],
+ "delete": []
+ },
+ "metadata": {
+ "add": [],
+ "delete": []
+ },
+ "context": {
+ "isContextOnly": false,
+ "promptsToAdd": [
+ {
+ "displayText": "Add Prompts",
+ "displayOrder": 0,
+ "qna": {
+ "id": 0,
+ "answer": "Click here to know more https://docs.microsoft.com/en-us/azure/cognitive-services/qnamaker/how-to/multiturn-conversation",
+ "source": "Editorial",
+ "questions": [
+ "How can I add prompts?"
+ ],
+ "metadata": [],
+ "context": {
+ "isContextOnly": false,
+ "prompts": []
+ }
+ },
+ "qnaId": 0
+ },
+ {
+ "displayText": "Delete Prompts",
+ "displayOrder": 0,
+ "qna": {
+ "id": 0,
+ "answer": "Click here to know more https://docs.microsoft.com/en-us/azure/cognitive-services/qnamaker/how-to/multiturn-conversation",
+ "source": "Editorial",
+ "questions": [
+ "How can I delete delete prompts?"
+ ],
+ "metadata": [],
+ "context": {
+ "isContextOnly": false,
+ "prompts": []
+ }
+ },
+ "qnaId": 0
+ },
+ {
+ "displayText": "Update Knowledgebase",
+ "displayOrder": 0,
+ "qna": null,
+ "qnaId": 3
+ }
+ ],
+ "promptsToDelete": [
+ 3
+ ]
+ }
+ },
+ {
+ "id": 3,
+ "answer": "You can use our REST apis to update your KB. See here for details: https://docs.microsoft.com/en-us/rest/api/cognitiveservices/qnamaker/knowledgebase/update",
+ "source": "Custom Editorial",
+ "questions": {
+ "add": [],
+ "delete": []
+ },
+ "metadata": {
+ "delete": [
+ {
+ "name": "category",
+ "value": "api"
+ }
+ ],
+ "add": [
+ {
+ "name": "category",
+ "value": "programmatic"
+ }
+ ]
+ },
+ "context": {
+ "isContextOnly": false,
+ "promptsToAdd": [
+ {
+ "displayText": "Regenerate Endpoint keys",
+ "displayOrder": 1,
+ "qna": null,
+ "qnaId": 4
+ }
+ ],
+ "promptsToDelete": [
+ 4
+ ]
+ }
+ }
+ ]
+ }
+ }
+ },
+ "responses": {
+ "202": {
+ "headers": {},
+ "body": {
+ "operationState": "NotStarted",
+ "createdTimestamp": "2018-03-19T07:38:46Z",
+ "lastActionTimestamp": "2018-03-19T07:39:29Z",
+ "userId": "86bb8390-56c0-42c2-9f81-3de161981191",
+ "operationId": "03a4f4ce-30a6-4ec6-b436-02bcdf6153e1"
+ }
+ }
+ }
+}
diff --git a/specification/cognitiveservices/data-plane/QnAMaker/readme.go.md b/specification/cognitiveservices/data-plane/QnAMaker/readme.go.md
index 214d27ace71d..ac3d12f87b38 100644
--- a/specification/cognitiveservices/data-plane/QnAMaker/readme.go.md
+++ b/specification/cognitiveservices/data-plane/QnAMaker/readme.go.md
@@ -14,6 +14,7 @@ go:
batch:
- tag: release_4_0
- tag: runtime_release_4_0
+ - tag: release_5_0_preview.1
```
### Tag: release_4_0 and go
@@ -35,3 +36,13 @@ Please also specify `--go-sdk-folder=`.
+
+``` yaml $(tag) == 'release_5_0_preview.1' && $(go)
+namespace: qnamaker
+output-folder: $(go-sdk-folder)/services/preview/$(namespace)/cognitiveservices/v5.0-preview.1/$(namespace)
+```
diff --git a/specification/cognitiveservices/data-plane/QnAMaker/readme.md b/specification/cognitiveservices/data-plane/QnAMaker/readme.md
index 23b55def218b..df7bb80d5701 100644
--- a/specification/cognitiveservices/data-plane/QnAMaker/readme.md
+++ b/specification/cognitiveservices/data-plane/QnAMaker/readme.md
@@ -5,6 +5,8 @@
Configuration for generating QnAMaker SDK.
The current release is `release_4_0`.
+A preview release `release_5_0_preview.1` is also available.
+
``` yaml
@@ -12,21 +14,33 @@ tag: release_4_0
add-credentials: true
openapi-type: data-plane
```
-# Releases
-### Release 4.0
-These settings apply only when `--tag=release_4_0` is specified on the command line.
+``` yaml
+tag: runtime_release_4_0
+add-credentials: true
+openapi-type: data-plane
+```
-``` yaml $(tag) == 'release_4_0'
-input-file: stable/v4.0/QnAMaker.json
+``` yaml
+tag: release_5_0_preview.1
+add-credentials: true
+openapi-type: data-plane
```
``` yaml
-tag: runtime_release_4_0
+tag: runtime_release_preview.1
add-credentials: true
openapi-type: data-plane
```
-# Runtime Releases
+
+# Releases
+
+### Release 4.0
+These settings apply only when `--tag=release_4_0` is specified on the command line.
+
+``` yaml $(tag) == 'release_4_0'
+input-file: stable/v4.0/QnAMaker.json
+```
### Runtime Release 4.0
These settings apply only when `--tag=runtime_release_4_0` is specified on the command line.
@@ -35,10 +49,18 @@ These settings apply only when `--tag=runtime_release_4_0` is specified on the c
input-file: stable/v4.0/QnAMakerRuntime.json
```
+### Release 5.0-preview.1
+These settings apply only when `--tag=release_5_0_preview.1` is specified on the command line.
+
+``` yaml $(tag) == 'release_5_0_preview.1'
+input-file: preview/v5.0-preview.1/QnAMaker.json
+```
+
``` yaml
batch:
- tag: release_4_0
- tag: runtime_release_4_0
+ - tag: release_5_0_preview.1
```
## Swagger to SDK
@@ -59,9 +81,10 @@ swagger-to-sdk:
```
-## CSharp Settings
-These settings apply only when `--csharp` is specified on the command line.
-``` yaml $(csharp)
+## CSharp Settings Release 4.0
+These settings apply only when `--csharp --tag=release_4_0` is specified on the command line.
+
+``` yaml $(csharp) && $(tag) == 'release_4_0'
csharp:
sync-methods: None
license-header: MICROSOFT_MIT_NO_VERSION
@@ -71,6 +94,29 @@ csharp:
clear-output-folder: true
```
+``` yaml $(csharp) && $(tag) == 'runtime_release_4_0'
+csharp:
+ sync-methods: None
+ license-header: MICROSOFT_MIT_NO_VERSION
+ azure-arm: false
+ namespace: Microsoft.Azure.CognitiveServices.Knowledge.QnAMaker
+ output-folder: $(csharp-sdks-folder)/CognitiveServices/Knowledge.QnAMaker/src/Generated
+ clear-output-folder: true
+```
+## CSharp Settings Release 5.0-preview.1
+
+These settings apply only when `--csharp --tag=release_5_0_preview.1` is specified on the command line.
+
+``` yaml $(csharp) && $(tag) == 'release_5_0_preview.1'
+csharp:
+ sync-methods: None
+ license-header: MICROSOFT_MIT_NO_VERSION
+ azure-arm: false
+ namespace: Microsoft.Azure.CognitiveServices.Knowledge.QnAMaker
+ output-folder: $(csharp-sdks-folder)/CognitiveServices/Knowledge.QnAMaker/preview/src/Generated
+ clear-output-folder: true
+```
+
## Python
See configuration in [readme.python.md](./readme.python.md)
@@ -81,10 +127,10 @@ See configuration in [readme.go.md](./readme.go.md)
## Java
-These settings apply only when `--java` is specified on the command line.
+These settings apply only when `--java --tag=release_4_0` is specified on the command line.
Please also specify `--azure-libraries-for-java-folder=`.
-``` yaml $(java)
+``` yaml $(java) && $(tag) == 'release_4_0'
java:
azure-arm: true
namespace: com.microsoft.azure.cognitiveservices.knowledge.qnamaker
@@ -95,6 +141,21 @@ java:
with-single-async-method: true
```
+
+These settings apply only when `--java --tag=release_5_0_preview` is specified on the command line.
+Please also specify `--azure-libraries-for-java-folder=`.
+
+``` yaml $(java) && $(tag) == 'release_5_0_preview.1'
+java:
+ azure-arm: true
+ namespace: com.microsoft.azure.cognitiveservices.knowledge.qnamaker
+ license-header: MICROSOFT_MIT_NO_CODEGEN
+ payload-flattening-threshold: 1
+ output-folder: $(azure-libraries-for-java-folder)/cognitiveservices/data-plane/knowledge/qnamaker/preview
+ with-optional-parameters: true
+ with-single-async-method: true
+```
+
## Multi-API/Profile support for AutoRest v3 generators
AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files.
@@ -109,7 +170,7 @@ require: $(this-folder)/../../../../profiles/readme.md
input-file:
- $(this-folder)/stable/v4.0/QnAMaker.json
- $(this-folder)/stable/v4.0/QnAMakerRuntime.json
-
+ - $(this-folder)/preview/v5.0-preview.1/QnAMaker.json
```
If there are files that should not be in the `all-api-versions` set,
diff --git a/specification/cognitiveservices/data-plane/QnAMaker/readme.nodejs.md b/specification/cognitiveservices/data-plane/QnAMaker/readme.nodejs.md
index 4a819e11716c..3f98fa061bd4 100644
--- a/specification/cognitiveservices/data-plane/QnAMaker/readme.nodejs.md
+++ b/specification/cognitiveservices/data-plane/QnAMaker/readme.nodejs.md
@@ -1,9 +1,9 @@
## Node.js
-These settings apply only when `--nodejs` is specified on the command line.
+These settings apply only when `--nodejs --tag=release_4_0` is specified on the command line.
Please also specify `--node-sdks-folder=`.
-``` yaml $(nodejs)
+``` yaml $(tag) == 'release_4_0' && $(nodejs)
nodejs:
package-name: azure-cognitiveservices-qnamaker
output-folder: $(node-sdks-folder)/lib/services/cognitiveServicesQnAMaker
@@ -12,3 +12,16 @@ nodejs:
generate-package-json: true
generate-readme-md: true
```
+
+These settings apply only when `--nodejs --tag=release_5_0_preview.1` is specified on the command line.
+Please also specify `--node-sdks-folder=`.
+
+``` yaml $(tag) == 'release_5_0_preview.1' && $(nodejs)
+nodejs:
+ package-name: azure-cognitiveservices-qnamaker-preview
+ output-folder: $(node-sdks-folder)/lib/services/cognitiveServicesQnAMaker/preview
+ azure-arm: false
+ generate-license-txt: true
+ generate-package-json: true
+ generate-readme-md: true
+```
diff --git a/specification/cognitiveservices/data-plane/QnAMaker/readme.python.md b/specification/cognitiveservices/data-plane/QnAMaker/readme.python.md
index 28c107b25da3..6be17bcb15d8 100644
--- a/specification/cognitiveservices/data-plane/QnAMaker/readme.python.md
+++ b/specification/cognitiveservices/data-plane/QnAMaker/readme.python.md
@@ -12,11 +12,18 @@ package-name: azure-cognitiveservices-knowledge-qnamaker
no-namespace-folders: true
clear-output-folder: true
```
+
``` yaml $(tag) == 'release_4_0'
namespace: azure.cognitiveservices.knowledge.qnamaker.authoring
output-folder: $(python-sdks-folder)/cognitiveservices/azure-cognitiveservices-knowledge-qnamaker/azure/cognitiveservices/knowledge/qnamaker/authoring
```
+
``` yaml $(tag) == 'runtime_release_4_0'
namespace: azure.cognitiveservices.knowledge.qnamaker.runtime
output-folder: $(python-sdks-folder)/cognitiveservices/azure-cognitiveservices-knowledge-qnamaker/azure/cognitiveservices/knowledge/qnamaker/runtime
```
+
+``` yaml $(tag) == 'release_5_0_preview.1'
+namespace: azure.cognitiveservices.knowledge.qnamaker.preview
+output-folder: $(python-sdks-folder)/cognitiveservices/azure-cognitiveservices-knowledge-qnamaker/azure/cognitiveservices/knowledge/qnamaker/preview/
+```
diff --git a/specification/cognitiveservices/data-plane/QnAMaker/readme.ruby.md b/specification/cognitiveservices/data-plane/QnAMaker/readme.ruby.md
index 9466e290b772..cbcfc7220bdd 100644
--- a/specification/cognitiveservices/data-plane/QnAMaker/readme.ruby.md
+++ b/specification/cognitiveservices/data-plane/QnAMaker/readme.ruby.md
@@ -4,7 +4,7 @@ These settings apply only when `--ruby` is specified on the command line.
``` yaml
package-name: azure_cognitiveservices_qnamaker
-package-version: "0.16.0"
+package-version: "1.0.0"
azure-arm: true
```
@@ -13,6 +13,7 @@ azure-arm: true
``` yaml $(ruby) && $(multiapi)
batch:
- tag: release_4_0
+ - tag: release_5_0_preview.1
```
### Tag: release_4_0 and ruby
@@ -23,4 +24,15 @@ Please also specify `--ruby-sdks-folder=`.
+
+``` yaml $(tag) == 'release_5_0_preview.1' && $(ruby)
+namespace: "Azure::CognitiveServices::Qnamaker::V5_0_preview_1"
+output-folder: $(ruby-sdks-folder)/data/azure_cognitiveservices_qnamaker/lib
```
\ No newline at end of file
diff --git a/specification/cognitiveservices/data-plane/QnAMaker/readme.typescript.md b/specification/cognitiveservices/data-plane/QnAMaker/readme.typescript.md
index f796e6157012..14a2b6368a71 100644
--- a/specification/cognitiveservices/data-plane/QnAMaker/readme.typescript.md
+++ b/specification/cognitiveservices/data-plane/QnAMaker/readme.typescript.md
@@ -3,10 +3,21 @@
These settings apply only when `--typescript` is specified on the command line.
Please also specify `--typescript-sdks-folder=`.
-``` yaml $(typescript)
+``` yaml $(tag) == 'release_4_0' && $(typescript)
typescript:
package-name: "@azure/cognitiveservices-qnamaker"
output-folder: "$(typescript-sdks-folder)/sdk/cognitiveservices/cognitiveservices-qnamaker"
azure-arm: false
generate-metadata: true
```
+
+These settings apply only when `--typescript` is specified on the command line.
+Please also specify `--typescript-sdks-folder=`.
+
+``` yaml $(tag) == 'release_5_0_preview.1' && $(typescript)
+typescript:
+ package-name: "@azure/cognitiveservices-qnamaker"
+ output-folder: "$(typescript-sdks-folder)/sdk/cognitiveservices/cognitiveservices-qnamaker/preview"
+ azure-arm: false
+ generate-metadata: true
+```
diff --git a/specification/cognitiveservices/data-plane/QnAMaker/stable/v4.0/QnAMaker.json b/specification/cognitiveservices/data-plane/QnAMaker/stable/v4.0/QnAMaker.json
index 4e2a55047833..0f218c5ea51c 100644
--- a/specification/cognitiveservices/data-plane/QnAMaker/stable/v4.0/QnAMaker.json
+++ b/specification/cognitiveservices/data-plane/QnAMaker/stable/v4.0/QnAMaker.json
@@ -77,11 +77,8 @@
"application/json"
],
"responses": {
- "200": {
- "description": "Response with endpointSettings update status.",
- "schema": {
- "type": "string"
- }
+ "204": {
+ "description": "HTTP 204 No Content."
},
"default": {
"description": "Error response.",
@@ -567,6 +564,12 @@
},
{
"$ref": "#/parameters/Environment"
+ },
+ {
+ "$ref": "#/parameters/source"
+ },
+ {
+ "$ref": "#/parameters/changedSince"
}
],
"consumes": [
@@ -902,7 +905,7 @@
},
"language": {
"type": "string",
- "description": "Language of the knowledgebase.",
+ "description": "Language of the knowledgebase. Please find the list of supported languages here.",
"maxLength": 100,
"minLength": 1
}
@@ -1418,6 +1421,24 @@
"description": "Knowledgebase id.",
"x-ms-parameter-location": "method"
},
+ "source": {
+ "type": "string",
+ "name": "source",
+ "in": "query",
+ "required": false,
+ "x-nullable": false,
+ "description": "The source property filter to apply. Sample value: Editorial, smartLight%20FAQ.tsv .",
+ "x-ms-parameter-location": "method"
+ },
+ "changedSince": {
+ "type": "string",
+ "name": "changedSince",
+ "in": "query",
+ "required": false,
+ "x-nullable": false,
+ "description": "changedSince property is used to return all QnAs created or updated after a specific time duration. The user can filter QnAs by seconds (s), minutes (m), hours (h) and days (d). The user may use any integral value along with the suffix for time. For instance, the value of 5m returns all QnA pairs updated or created in the last 5 minutes.",
+ "x-ms-parameter-location": "method"
+ },
"OperationId": {
"type": "string",
"name": "operationId",
@@ -1449,7 +1470,7 @@
},
"Endpoint": {
"name": "Endpoint",
- "description": "Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus.api.cognitive.microsoft.com).",
+ "description": "Supported Cognitive Services endpoint (e.g., https://< qnamaker-resource-name> .api.cognitiveservices.azure.com).",
"x-ms-parameter-location": "client",
"required": true,
"type": "string",
diff --git a/specification/cognitiveservices/data-plane/QnAMaker/stable/v4.0/QnAMakerRuntime.json b/specification/cognitiveservices/data-plane/QnAMaker/stable/v4.0/QnAMakerRuntime.json
index 843426973bd1..04490d47590a 100644
--- a/specification/cognitiveservices/data-plane/QnAMaker/stable/v4.0/QnAMakerRuntime.json
+++ b/specification/cognitiveservices/data-plane/QnAMaker/stable/v4.0/QnAMakerRuntime.json
@@ -339,7 +339,7 @@
},
"userId": {
"type": "string",
- "description": "Unique identifier for the user."
+ "description": "Unique identifier for the user. Optional parameter for telemetry. For more information, refer Analytics and Telemetry."
},
"isTest": {
"type": "boolean",
diff --git a/specification/cognitiveservices/data-plane/QnAMaker/stable/v4.0/examples/SuccessfulRepKb.json b/specification/cognitiveservices/data-plane/QnAMaker/stable/v4.0/examples/SuccessfulRepKb.json
index 640d3f21dc32..fd6ba1224539 100644
--- a/specification/cognitiveservices/data-plane/QnAMaker/stable/v4.0/examples/SuccessfulRepKb.json
+++ b/specification/cognitiveservices/data-plane/QnAMaker/stable/v4.0/examples/SuccessfulRepKb.json
@@ -5,7 +5,7 @@
"Ocp-Apim-Subscription-Key": "{API key}",
"kbId": "9d091697-fb8c-4ed5-9ac0-35bf8273bfff",
"replaceKb": {
- "qnaList": [
+ "qnAList": [
{
"id": 0,
"answer": "You can change the default message if you use the QnAMakerDialog. See this for details: https://docs.botframework.com/en-us/azure-bot-service/templates/qnamaker/#navtitle",
diff --git a/specification/cognitiveservices/data-plane/QnAMaker/stable/v4.0/examples/SuccessfulSetEpSettings.json b/specification/cognitiveservices/data-plane/QnAMaker/stable/v4.0/examples/SuccessfulSetEpSettings.json
index a12bd163bd89..468c0b59680a 100644
--- a/specification/cognitiveservices/data-plane/QnAMaker/stable/v4.0/examples/SuccessfulSetEpSettings.json
+++ b/specification/cognitiveservices/data-plane/QnAMaker/stable/v4.0/examples/SuccessfulSetEpSettings.json
@@ -10,9 +10,6 @@
}
},
"responses": {
- "200": {
- "headers": {},
- "body": "Successfully updated endpoint settings"
- }
+ "204": {}
}
}
diff --git a/specification/cognitiveservices/data-plane/QnAMaker/stable/v4.0/examples/SuccessfulUpdKb.json b/specification/cognitiveservices/data-plane/QnAMaker/stable/v4.0/examples/SuccessfulUpdKb.json
index 0a767648beb6..3c717ca27123 100644
--- a/specification/cognitiveservices/data-plane/QnAMaker/stable/v4.0/examples/SuccessfulUpdKb.json
+++ b/specification/cognitiveservices/data-plane/QnAMaker/stable/v4.0/examples/SuccessfulUpdKb.json
@@ -48,9 +48,6 @@
"add": [],
"delete": []
},
- "alternateQuestionClusters": {
- "delete": []
- },
"context": {
"isContextOnly": false,
"promptsToAdd": [
@@ -65,7 +62,6 @@
"How can I add prompts?"
],
"metadata": [],
- "alternateQuestionClusters": [],
"context": {
"isContextOnly": false,
"prompts": []
@@ -84,7 +80,6 @@
"How can I delete delete prompts?"
],
"metadata": [],
- "alternateQuestionClusters": [],
"context": {
"isContextOnly": false,
"prompts": []
@@ -126,9 +121,6 @@
}
]
},
- "alternateQuestionClusters": {
- "delete": []
- },
"context": {
"isContextOnly": false,
"promptsToAdd": [
diff --git a/specification/common-types/resource-management/v2/types.json b/specification/common-types/resource-management/v2/types.json
index 7ee7093af3e8..7ef5fc2bb4a0 100644
--- a/specification/common-types/resource-management/v2/types.json
+++ b/specification/common-types/resource-management/v2/types.json
@@ -24,6 +24,7 @@
"description": "The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts."
}
},
+ "description": "The resource model definition for a ARM tracked top level resource",
"x-ms-azure-resource": true
},
"AzureEntityResource": {
diff --git a/specification/communication/data-plane/Microsoft.CommunicationServicesAdministration/preview/2020-07-20-preview1/communicationservicesadministration.json b/specification/communication/data-plane/Microsoft.CommunicationServicesAdministration/preview/2020-07-20-preview1/communicationservicesadministration.json
new file mode 100644
index 000000000000..84d87cd2c9b0
--- /dev/null
+++ b/specification/communication/data-plane/Microsoft.CommunicationServicesAdministration/preview/2020-07-20-preview1/communicationservicesadministration.json
@@ -0,0 +1,2056 @@
+{
+ "swagger": "2.0",
+ "info": {
+ "title": "Phone Number Administration Service",
+ "description": "Phone Number Administration Service",
+ "contact": {
+ "email": "acsdevexdisc@microsoft.com"
+ },
+ "version": "2020-07-20-preview1"
+ },
+ "paths": {
+ "/administration/phonenumbers/phonenumbers": {
+ "get": {
+ "tags": [
+ "AcquiredNumbers"
+ ],
+ "summary": "Gets the list of the acquired phone numbers.",
+ "operationId": "PhoneNumberAdministration_GetAllPhoneNumbers",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "in": "query",
+ "name": "locale",
+ "description": "A language-locale pairing which will be used to localize the names of countries",
+ "type": "string",
+ "default": "en-US"
+ },
+ {
+ "in": "query",
+ "name": "skip",
+ "description": "An optional parameter for how many entries to skip, for pagination purposes.",
+ "type": "integer",
+ "format": "int32",
+ "default": 0
+ },
+ {
+ "in": "query",
+ "name": "take",
+ "description": "An optional parameter for how many entries to return, for pagination purposes.",
+ "type": "integer",
+ "format": "int32",
+ "default": 100
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "schema": {
+ "$ref": "#/definitions/AcquiredPhoneNumbers"
+ }
+ },
+ "default": {
+ "description": "Failure",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink",
+ "itemName": "phoneNumbers"
+ },
+ "x-ms-examples": {
+ "List acquired phone numbers": {
+ "$ref": "./examples/GetAcquiredPhoneNumbersAsync.json"
+ }
+ }
+ }
+ },
+ "/administration/phonenumbers/countries/{countryCode}/areacodes": {
+ "post": {
+ "tags": [
+ "AreaCodes"
+ ],
+ "summary": "Gets a list of the supported area codes",
+ "operationId": "PhoneNumberAdministration_GetAllAreaCodes",
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "in": "query",
+ "name": "locationType",
+ "description": "The type of location information required by the plan.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "in": "path",
+ "name": "countryCode",
+ "description": "The ISO 3166-2 country code",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "in": "query",
+ "name": "phonePlanId",
+ "description": "The plan id from which to search area codes.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "in": "body",
+ "name": "body",
+ "description": "Location options for when location type is selection.",
+ "schema": {
+ "$ref": "#/definitions/LocationOptionsQueries"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "schema": {
+ "$ref": "#/definitions/AreaCodes"
+ }
+ },
+ "default": {
+ "description": "Failure",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Get area codes": {
+ "$ref": "./examples/GetAreaCodesAsync.json"
+ }
+ }
+ }
+ },
+ "/administration/phonenumbers/capabilities/{capabilitiesUpdateId}": {
+ "get": {
+ "tags": [
+ "Capabilities"
+ ],
+ "summary": "Get capabilities by capabilities update id.",
+ "operationId": "PhoneNumberAdministration_GetCapabilitiesUpdate",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "in": "path",
+ "name": "capabilitiesUpdateId",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "schema": {
+ "$ref": "#/definitions/UpdatePhoneNumberCapabilitiesResponse"
+ }
+ },
+ "default": {
+ "description": "Failure",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Get number capabilities update": {
+ "$ref": "./examples/GetNumberCapabilitiesUpdateAsync.json"
+ }
+ }
+ }
+ },
+ "/administration/phonenumbers/capabilities": {
+ "post": {
+ "tags": [
+ "Capabilities"
+ ],
+ "summary": "Adds or removes phone number capabilities",
+ "operationId": "PhoneNumberAdministration_UpdateCapabilities",
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "in": "body",
+ "name": "body",
+ "description": "",
+ "schema": {
+ "$ref": "#/definitions/UpdateNumberCapabilitiesRequest"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "schema": {
+ "$ref": "#/definitions/UpdateNumberCapabilitiesResponse"
+ }
+ },
+ "default": {
+ "description": "Failure",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Update number capabilities": {
+ "$ref": "./examples/UpdateNumberCapabilitiesAsync.json"
+ }
+ }
+ }
+ },
+ "/administration/phonenumbers/countries": {
+ "get": {
+ "tags": [
+ "Countries"
+ ],
+ "summary": "Gets a list of supported countries",
+ "operationId": "PhoneNumberAdministration_GetAllSupportedCountries",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "in": "query",
+ "name": "locale",
+ "description": "A language-locale pairing which will be used to localize the names of countries",
+ "type": "string",
+ "default": "en-US"
+ },
+ {
+ "in": "query",
+ "name": "skip",
+ "description": "An optional parameter for how many entries to skip, for pagination purposes.",
+ "type": "integer",
+ "format": "int32",
+ "default": 0
+ },
+ {
+ "in": "query",
+ "name": "take",
+ "description": "An optional parameter for how many entries to return, for pagination purposes.",
+ "type": "integer",
+ "format": "int32",
+ "default": 100
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "schema": {
+ "$ref": "#/definitions/PhoneNumberCountries"
+ }
+ },
+ "default": {
+ "description": "Failure",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink",
+ "itemName": "countries"
+ },
+ "x-ms-examples": {
+ "Get countries": {
+ "$ref": "./examples/GetCountriesAsync.json"
+ }
+ }
+ }
+ },
+ "/administration/phonenumbers/numberconfiguration": {
+ "post": {
+ "tags": [
+ "NumberConfiguration"
+ ],
+ "summary": "Endpoint for getting number configurations",
+ "operationId": "PhoneNumberAdministration_GetNumberConfiguration",
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "in": "body",
+ "name": "body",
+ "description": "The phone number whose configuration is to be fetched",
+ "schema": {
+ "$ref": "#/definitions/NumberConfigurationPhoneNumber"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "schema": {
+ "$ref": "#/definitions/NumberConfigurationResponse"
+ }
+ },
+ "default": {
+ "description": "Failure",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Get number configuration for phone number": {
+ "$ref": "./examples/GetNumberConfigurationAsync.json"
+ }
+ }
+ }
+ },
+ "/administration/phonenumbers/numberconfiguration/configure": {
+ "patch": {
+ "tags": [
+ "NumberConfiguration"
+ ],
+ "summary": "Endpoint for configuring a pstn number",
+ "operationId": "PhoneNumberAdministration_ConfigureNumber",
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "in": "body",
+ "name": "body",
+ "description": "Details of pstn number configuration of the given phoneNumber",
+ "schema": {
+ "$ref": "#/definitions/NumberConfiguration"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success"
+ },
+ "default": {
+ "description": "Failure",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Configure phone number": {
+ "$ref": "./examples/ConfigurePhoneNumberAsync.json"
+ }
+ }
+ }
+ },
+ "/administration/phonenumbers/numberconfiguration/unconfigure": {
+ "patch": {
+ "tags": [
+ "NumberConfiguration"
+ ],
+ "summary": "Endpoint for unconfiguring a pstn number by removing the configuration",
+ "operationId": "PhoneNumberAdministration_UnconfigureNumber",
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "in": "body",
+ "name": "body",
+ "description": "The phone number to un-configure",
+ "schema": {
+ "$ref": "#/definitions/NumberConfigurationPhoneNumber"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success"
+ },
+ "default": {
+ "description": "Failure",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Unconfigure phone number": {
+ "$ref": "./examples/UnconfigurePhoneNumberAsync.json"
+ }
+ }
+ }
+ },
+ "/administration/phonenumbers/countries/{countryCode}/phoneplangroups": {
+ "get": {
+ "tags": [
+ "Plans"
+ ],
+ "summary": "Gets a list of phone plan groups for the given country",
+ "operationId": "PhoneNumberAdministration_GetPhonePlanGroups",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "in": "path",
+ "name": "countryCode",
+ "description": "The ISO 3166-2 country code.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "in": "query",
+ "name": "locale",
+ "description": "A language-locale pairing which will be used to localize the names of countries",
+ "type": "string",
+ "default": "en-US"
+ },
+ {
+ "in": "query",
+ "name": "includeRateInformation",
+ "type": "boolean",
+ "default": false
+ },
+ {
+ "in": "query",
+ "name": "skip",
+ "description": "An optional parameter for how many entries to skip, for pagination purposes.",
+ "type": "integer",
+ "format": "int32",
+ "default": 0
+ },
+ {
+ "in": "query",
+ "name": "take",
+ "description": "An optional parameter for how many entries to return, for pagination purposes.",
+ "type": "integer",
+ "format": "int32",
+ "default": 100
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "schema": {
+ "$ref": "#/definitions/PhonePlanGroups"
+ }
+ },
+ "default": {
+ "description": "Failure",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink",
+ "itemName": "phonePlanGroups"
+ },
+ "x-ms-examples": {
+ "Get plans": {
+ "$ref": "./examples/GetPhonePlanGroupsAsync.json"
+ }
+ }
+ }
+ },
+ "/administration/phonenumbers/countries/{countryCode}/phoneplangroups/{phonePlanGroupId}/phoneplans": {
+ "get": {
+ "tags": [
+ "Plans"
+ ],
+ "summary": "Gets a list of phone plans for a phone plan group",
+ "operationId": "PhoneNumberAdministration_GetPhonePlans",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "in": "path",
+ "name": "countryCode",
+ "description": "The ISO 3166-2 country code.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "in": "path",
+ "name": "phonePlanGroupId",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "in": "query",
+ "name": "locale",
+ "description": "A language-locale pairing which will be used to localize the names of countries",
+ "type": "string",
+ "default": "en-US"
+ },
+ {
+ "in": "query",
+ "name": "skip",
+ "description": "An optional parameter for how many entries to skip, for pagination purposes.",
+ "type": "integer",
+ "format": "int32",
+ "default": 0
+ },
+ {
+ "in": "query",
+ "name": "take",
+ "description": "An optional parameter for how many entries to return, for pagination purposes.",
+ "type": "integer",
+ "format": "int32",
+ "default": 100
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "schema": {
+ "$ref": "#/definitions/PhonePlansResponse"
+ }
+ },
+ "default": {
+ "description": "Failure",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink",
+ "itemName": "phonePlans"
+ },
+ "x-ms-examples": {
+ "Get plans": {
+ "$ref": "./examples/GetPhonePlansAsync.json"
+ }
+ }
+ }
+ },
+ "/administration/phonenumbers/countries/{countryCode}/phoneplangroups/{phonePlanGroupId}/phoneplans/{phonePlanId}/locationoptions": {
+ "get": {
+ "tags": [
+ "Plans"
+ ],
+ "summary": "Gets a list of location options for a phone plan",
+ "operationId": "PhoneNumberAdministration_GetPhonePlanLocationOptions",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "in": "path",
+ "name": "countryCode",
+ "description": "The ISO 3166-2 country code.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "in": "path",
+ "name": "phonePlanGroupId",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "in": "path",
+ "name": "phonePlanId",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "in": "query",
+ "name": "locale",
+ "description": "A language-locale pairing which will be used to localize the names of countries",
+ "type": "string",
+ "default": "en-US"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "schema": {
+ "$ref": "#/definitions/LocationOptionsResponse"
+ }
+ },
+ "default": {
+ "description": "Failure",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Get plans": {
+ "$ref": "./examples/GetLocationOptionsAsync.json"
+ }
+ }
+ }
+ },
+ "/administration/phonenumbers/releases/{releaseId}": {
+ "get": {
+ "tags": [
+ "Release"
+ ],
+ "summary": "Gets a release by a release id",
+ "operationId": "PhoneNumberAdministration_GetReleaseById",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "in": "path",
+ "name": "releaseId",
+ "description": "Represents the release id",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "schema": {
+ "$ref": "#/definitions/PhoneNumberRelease"
+ }
+ },
+ "default": {
+ "description": "Failure",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Get release by id": {
+ "$ref": "./examples/GetReleaseByIdAsync.json"
+ }
+ }
+ }
+ },
+ "/administration/phonenumbers/releases": {
+ "post": {
+ "tags": [
+ "Release"
+ ],
+ "summary": "Creates a release for the given phone numbers",
+ "operationId": "PhoneNumberAdministration_ReleasePhoneNumbers",
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "in": "body",
+ "name": "body",
+ "description": "Config api Release request",
+ "schema": {
+ "$ref": "#/definitions/ReleaseRequest"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "schema": {
+ "$ref": "#/definitions/ReleaseResponse"
+ }
+ },
+ "default": {
+ "description": "Failure",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Get release": {
+ "$ref": "./examples/CreateReleaseAsync.json"
+ }
+ }
+ },
+ "get": {
+ "tags": [
+ "Release"
+ ],
+ "summary": "Gets a list of all releases",
+ "operationId": "PhoneNumberAdministration_GetAllReleases",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "in": "query",
+ "name": "skip",
+ "description": "An optional parameter for how many entries to skip, for pagination purposes.",
+ "type": "integer",
+ "format": "int32",
+ "default": 0
+ },
+ {
+ "in": "query",
+ "name": "take",
+ "description": "An optional parameter for how many entries to return, for pagination purposes.",
+ "type": "integer",
+ "format": "int32",
+ "default": 100
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "schema": {
+ "$ref": "#/definitions/PhoneNumberEntities"
+ }
+ },
+ "default": {
+ "description": "Failure",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink",
+ "itemName": "entities"
+ },
+ "x-ms-examples": {
+ "Get all releases": {
+ "$ref": "./examples/GetAllReleasesAsync.json"
+ }
+ }
+ }
+ },
+ "/administration/phonenumbers/searches/{searchId}": {
+ "get": {
+ "tags": [
+ "Search"
+ ],
+ "summary": "Get search by search id",
+ "operationId": "PhoneNumberAdministration_GetSearchById",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "in": "path",
+ "name": "searchId",
+ "description": "The search id to be searched for",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "schema": {
+ "$ref": "#/definitions/PhoneNumberSearch"
+ }
+ },
+ "default": {
+ "description": "Failure",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Get search by search id": {
+ "$ref": "./examples/GetSearchByIdAsync.json"
+ }
+ }
+ }
+ },
+ "/administration/phonenumbers/searches": {
+ "post": {
+ "tags": [
+ "Search"
+ ],
+ "summary": "Creates a phone number search",
+ "operationId": "PhoneNumberAdministration_CreateSearch",
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "in": "body",
+ "name": "body",
+ "description": "Defines the search options",
+ "schema": {
+ "$ref": "#/definitions/CreateSearchOptions"
+ }
+ }
+ ],
+ "responses": {
+ "201": {
+ "description": "Success",
+ "schema": {
+ "$ref": "#/definitions/CreateSearchResponse"
+ }
+ },
+ "default": {
+ "description": "Failure",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Create search": {
+ "$ref": "./examples/CreateSearchAsync.json"
+ }
+ }
+ },
+ "get": {
+ "tags": [
+ "Search"
+ ],
+ "summary": "Gets a list of all searches",
+ "operationId": "PhoneNumberAdministration_GetAllSearches",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "in": "query",
+ "name": "skip",
+ "description": "An optional parameter for how many entries to skip, for pagination purposes.",
+ "type": "integer",
+ "format": "int32",
+ "default": 0
+ },
+ {
+ "in": "query",
+ "name": "take",
+ "description": "An optional parameter for how many entries to return, for pagination purposes.",
+ "type": "integer",
+ "format": "int32",
+ "default": 100
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "schema": {
+ "$ref": "#/definitions/PhoneNumberEntities"
+ }
+ },
+ "default": {
+ "description": "Failure",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink",
+ "itemName": "entities"
+ },
+ "x-ms-examples": {
+ "Get all searches": {
+ "$ref": "./examples/GetAllSearchesAsync.json"
+ }
+ }
+ }
+ },
+ "/administration/phonenumbers/searches/{searchId}/cancel": {
+ "post": {
+ "tags": [
+ "Search"
+ ],
+ "summary": "Cancels the search. This means existing numbers in the search will be made available.",
+ "operationId": "PhoneNumberAdministration_CancelSearch",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "in": "path",
+ "name": "searchId",
+ "description": "The search id to be canceled",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "202": {
+ "description": "Success"
+ },
+ "default": {
+ "description": "Failure",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Cancel phone number search": {
+ "$ref": "./examples/CancelSearchAsync.json"
+ }
+ }
+ }
+ },
+ "/administration/phonenumbers/searches/{searchId}/purchase": {
+ "post": {
+ "tags": [
+ "Search"
+ ],
+ "summary": "Purchases the phone number search.",
+ "operationId": "PhoneNumberAdministration_PurchaseSearch",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "in": "path",
+ "name": "searchId",
+ "description": "The search id to be purchased",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "202": {
+ "description": "Success"
+ },
+ "default": {
+ "description": "Failure",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Purchase phone number search": {
+ "$ref": "./examples/PurchaseSearchAsync.json"
+ }
+ }
+ }
+ }
+ },
+ "definitions": {
+ "AcquiredPhoneNumber": {
+ "description": "Represents an acquired phone number.",
+ "required": [
+ "acquiredCapabilities",
+ "availableCapabilities",
+ "phoneNumber"
+ ],
+ "type": "object",
+ "properties": {
+ "phoneNumber": {
+ "description": "String of the E.164 format of the phone number",
+ "type": "string"
+ },
+ "acquiredCapabilities": {
+ "description": "The set of all acquired capabilities of the phone number.",
+ "type": "array",
+ "items": {
+ "description": "Represents the capabilities of a phone number.",
+ "enum": [
+ "UserAssignment",
+ "FirstPartyVoiceAppAssignment",
+ "ConferenceAssignment",
+ "P2PSmsEnabled",
+ "Geographic",
+ "NonGeographic",
+ "TollCalling",
+ "TollFreeCalling",
+ "Premium",
+ "P2PSmsCapable",
+ "A2PSmsCapable",
+ "A2PSmsEnabled",
+ "Calling",
+ "TollFree",
+ "FirstPartyAppAssignment",
+ "ThirdPartyAppAssignment",
+ "Azure",
+ "Office365",
+ "InboundCalling",
+ "OutboundCalling",
+ "InboundA2PSms",
+ "OutboundA2PSms",
+ "InboundP2PSms",
+ "OutboundP2PSms"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "Capability",
+ "modelAsString": true
+ }
+ }
+ },
+ "availableCapabilities": {
+ "description": "The set of all available capabilities that can be acquired for this phone number.",
+ "type": "array",
+ "items": {
+ "description": "Represents the capabilities of a phone number.",
+ "enum": [
+ "UserAssignment",
+ "FirstPartyVoiceAppAssignment",
+ "ConferenceAssignment",
+ "P2PSmsEnabled",
+ "Geographic",
+ "NonGeographic",
+ "TollCalling",
+ "TollFreeCalling",
+ "Premium",
+ "P2PSmsCapable",
+ "A2PSmsCapable",
+ "A2PSmsEnabled",
+ "Calling",
+ "TollFree",
+ "FirstPartyAppAssignment",
+ "ThirdPartyAppAssignment",
+ "Azure",
+ "Office365",
+ "InboundCalling",
+ "OutboundCalling",
+ "InboundA2PSms",
+ "OutboundA2PSms",
+ "InboundP2PSms",
+ "OutboundP2PSms"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "Capability",
+ "modelAsString": true
+ }
+ }
+ },
+ "assignmentStatus": {
+ "description": "The assignment status of the phone number. Conveys what type of entity the number is assigned to.",
+ "enum": [
+ "Unassigned",
+ "Unknown",
+ "UserAssigned",
+ "ConferenceAssigned",
+ "FirstPartyAppAssigned",
+ "ThirdPartyAppAssigned"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "AssignmentStatus",
+ "modelAsString": true
+ }
+ },
+ "placeName": {
+ "description": "The name of the place of the phone number.",
+ "type": "string"
+ },
+ "activationState": {
+ "description": "The activation state of the phone number. Can be \"Activated\", \"AssignmentPending\", \"AssignmentFailed\", \"UpdatePending\", \"UpdateFailed\"",
+ "enum": [
+ "Activated",
+ "AssignmentPending",
+ "AssignmentFailed",
+ "UpdatePending",
+ "UpdateFailed"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "ActivationState",
+ "modelAsString": true
+ }
+ }
+ }
+ },
+ "AcquiredPhoneNumbers": {
+ "description": "A wrapper of list of phone numbers",
+ "type": "object",
+ "properties": {
+ "phoneNumbers": {
+ "description": "Represents a list of phone numbers",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/AcquiredPhoneNumber"
+ }
+ },
+ "nextLink": {
+ "description": "Represents the URL link to the next page",
+ "type": "string"
+ }
+ }
+ },
+ "ErrorBody": {
+ "description": "Represents a service error response body.",
+ "type": "object",
+ "properties": {
+ "code": {
+ "description": "The error code in the error response.",
+ "type": "string"
+ },
+ "message": {
+ "description": "The error message in the error response.",
+ "type": "string"
+ }
+ }
+ },
+ "ErrorResponse": {
+ "description": "Represents a service error response.",
+ "type": "object",
+ "properties": {
+ "error": {
+ "$ref": "#/definitions/ErrorBody"
+ }
+ }
+ },
+ "LocationOptionsQuery": {
+ "description": "Represents a location options parameter, used for fetching area codes.",
+ "type": "object",
+ "properties": {
+ "labelId": {
+ "description": "Represents the location option label id, returned from the GetLocationOptions API.",
+ "type": "string"
+ },
+ "optionsValue": {
+ "description": "Represents the location options value, returned from the GetLocationOptions API.",
+ "type": "string"
+ }
+ }
+ },
+ "LocationOptionsQueries": {
+ "description": "Represents a list of location option queries, used for fetching area codes.",
+ "type": "object",
+ "properties": {
+ "locationOptions": {
+ "description": "Represents the underlying list of countries.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/LocationOptionsQuery"
+ }
+ }
+ }
+ },
+ "AreaCodes": {
+ "description": "Represents a list of area codes.",
+ "type": "object",
+ "properties": {
+ "primaryAreaCodes": {
+ "description": "Represents the list of primary area codes.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "secondaryAreaCodes": {
+ "description": "Represents the list of secondary area codes.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "nextLink": {
+ "description": "Represents the URL link to the next page",
+ "type": "string"
+ }
+ }
+ },
+ "NumberUpdateCapabilities": {
+ "description": "Represents an individual number capabilities update request",
+ "type": "object",
+ "properties": {
+ "add": {
+ "description": "Capabilities to be added to a phone number",
+ "type": "array",
+ "items": {
+ "description": "Represents the capabilities of a phone number.",
+ "enum": [
+ "UserAssignment",
+ "FirstPartyVoiceAppAssignment",
+ "ConferenceAssignment",
+ "P2PSmsEnabled",
+ "Geographic",
+ "NonGeographic",
+ "TollCalling",
+ "TollFreeCalling",
+ "Premium",
+ "P2PSmsCapable",
+ "A2PSmsCapable",
+ "A2PSmsEnabled",
+ "Calling",
+ "TollFree",
+ "FirstPartyAppAssignment",
+ "ThirdPartyAppAssignment",
+ "Azure",
+ "Office365",
+ "InboundCalling",
+ "OutboundCalling",
+ "InboundA2PSms",
+ "OutboundA2PSms",
+ "InboundP2PSms",
+ "OutboundP2PSms"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "Capability",
+ "modelAsString": true
+ }
+ }
+ },
+ "remove": {
+ "description": "Capabilities to be removed from a phone number",
+ "type": "array",
+ "items": {
+ "description": "Represents the capabilities of a phone number.",
+ "enum": [
+ "UserAssignment",
+ "FirstPartyVoiceAppAssignment",
+ "ConferenceAssignment",
+ "P2PSmsEnabled",
+ "Geographic",
+ "NonGeographic",
+ "TollCalling",
+ "TollFreeCalling",
+ "Premium",
+ "P2PSmsCapable",
+ "A2PSmsCapable",
+ "A2PSmsEnabled",
+ "Calling",
+ "TollFree",
+ "FirstPartyAppAssignment",
+ "ThirdPartyAppAssignment",
+ "Azure",
+ "Office365",
+ "InboundCalling",
+ "OutboundCalling",
+ "InboundA2PSms",
+ "OutboundA2PSms",
+ "InboundP2PSms",
+ "OutboundP2PSms"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "Capability",
+ "modelAsString": true
+ }
+ }
+ }
+ }
+ },
+ "UpdatePhoneNumberCapabilitiesResponse": {
+ "description": "Response for getting a phone number update capabilities.",
+ "type": "object",
+ "properties": {
+ "capabilitiesUpdateId": {
+ "description": "The id of the phone number capabilities update",
+ "type": "string"
+ },
+ "createdAt": {
+ "format": "date-time",
+ "description": "The time the capabilities update was created",
+ "type": "string"
+ },
+ "capabilitiesUpdateStatus": {
+ "description": "Status of the capabilities update.",
+ "enum": [
+ "Pending",
+ "InProgress",
+ "Complete",
+ "Error"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "CapabilitiesUpdateStatus",
+ "modelAsString": true
+ }
+ },
+ "phoneNumberCapabilitiesUpdates": {
+ "description": "The capabilities update for each of a set of phone numbers.",
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/definitions/NumberUpdateCapabilities"
+ }
+ }
+ }
+ },
+ "UpdateNumberCapabilitiesRequest": {
+ "description": "Represents a numbers capabilities update request",
+ "required": [
+ "phoneNumberCapabilitiesUpdate"
+ ],
+ "type": "object",
+ "properties": {
+ "phoneNumberCapabilitiesUpdate": {
+ "description": "The map of phone numbers to the capabilities update applied to the phone number.",
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/definitions/NumberUpdateCapabilities"
+ }
+ }
+ }
+ },
+ "UpdateNumberCapabilitiesResponse": {
+ "description": "Represents a number capability update response.",
+ "required": [
+ "capabilitiesUpdateId"
+ ],
+ "type": "object",
+ "properties": {
+ "capabilitiesUpdateId": {
+ "description": "The capabilities id",
+ "type": "string"
+ }
+ }
+ },
+ "PhoneNumberCountry": {
+ "description": "Represents a country.",
+ "required": [
+ "countryCode",
+ "localizedName"
+ ],
+ "type": "object",
+ "properties": {
+ "localizedName": {
+ "description": "Represents the name of the country.",
+ "type": "string"
+ },
+ "countryCode": {
+ "description": "Represents the abbreviated name of the country.",
+ "type": "string"
+ }
+ }
+ },
+ "PhoneNumberCountries": {
+ "description": "Represents a wrapper around a list of countries.",
+ "type": "object",
+ "properties": {
+ "countries": {
+ "description": "Represents the underlying list of countries.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/PhoneNumberCountry"
+ }
+ },
+ "nextLink": {
+ "description": "Represents the URL link to the next page",
+ "type": "string"
+ }
+ }
+ },
+ "NumberConfigurationPhoneNumber": {
+ "description": "The phone number wrapper representing a number configuration request",
+ "required": [
+ "phoneNumber"
+ ],
+ "type": "object",
+ "properties": {
+ "phoneNumber": {
+ "description": "The phone number in the E.164 format",
+ "type": "string"
+ }
+ }
+ },
+ "PstnConfiguration": {
+ "description": "Definition for pstn number configuration",
+ "required": [
+ "callbackUrl"
+ ],
+ "type": "object",
+ "properties": {
+ "callbackUrl": {
+ "description": "The webhook URL on the phone number configuration.",
+ "type": "string"
+ },
+ "applicationId": {
+ "description": "The application id of the application to which to configure",
+ "type": "string"
+ }
+ }
+ },
+ "NumberConfigurationResponse": {
+ "description": "Definition for number configuration",
+ "required": [
+ "pstnConfiguration"
+ ],
+ "type": "object",
+ "properties": {
+ "pstnConfiguration": {
+ "$ref": "#/definitions/PstnConfiguration"
+ }
+ }
+ },
+ "NumberConfiguration": {
+ "description": "Definition for number configuration",
+ "required": [
+ "phoneNumber",
+ "pstnConfiguration"
+ ],
+ "type": "object",
+ "properties": {
+ "pstnConfiguration": {
+ "$ref": "#/definitions/PstnConfiguration"
+ },
+ "phoneNumber": {
+ "description": "The phone number to configure",
+ "type": "string"
+ }
+ }
+ },
+ "CarrierDetails": {
+ "description": "Represents carrier details.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "Name of carrier details",
+ "type": "string"
+ },
+ "localizedName": {
+ "description": "Display name of carrier details",
+ "type": "string"
+ }
+ }
+ },
+ "RateInformation": {
+ "description": "Represents a wrapper of rate information",
+ "type": "object",
+ "properties": {
+ "monthlyRate": {
+ "format": "double",
+ "description": "The monthly rate of a phone plan group",
+ "type": "number"
+ },
+ "currencyType": {
+ "description": "The currency of a phone plan group",
+ "enum": [
+ "USD"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "CurrencyType",
+ "modelAsString": true
+ }
+ },
+ "rateErrorMessage": {
+ "description": "The error code of a phone plan group",
+ "type": "string"
+ }
+ }
+ },
+ "PhonePlanGroup": {
+ "description": "Represents a plan group.",
+ "required": [
+ "localizedDescription",
+ "localizedName",
+ "phonePlanGroupId"
+ ],
+ "type": "object",
+ "properties": {
+ "phonePlanGroupId": {
+ "description": "The id of the plan group",
+ "type": "string"
+ },
+ "phoneNumberType": {
+ "description": "The phone number type of the plan group",
+ "enum": [
+ "Unknown",
+ "Geographic",
+ "TollFree",
+ "Indirect"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "PhoneNumberType",
+ "modelAsString": true
+ }
+ },
+ "localizedName": {
+ "description": "The name of the plan group.",
+ "type": "string"
+ },
+ "localizedDescription": {
+ "description": "The description of the plan group.",
+ "type": "string"
+ },
+ "carrierDetails": {
+ "$ref": "#/definitions/CarrierDetails"
+ },
+ "rateInformation": {
+ "$ref": "#/definitions/RateInformation"
+ }
+ }
+ },
+ "PhonePlanGroups": {
+ "description": "Represents a wrapper of list of plan groups.",
+ "type": "object",
+ "properties": {
+ "phonePlanGroups": {
+ "description": "The underlying list of phone plan groups.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/PhonePlanGroup"
+ }
+ },
+ "nextLink": {
+ "description": "Represents the URL link to the next page",
+ "type": "string"
+ }
+ }
+ },
+ "PhonePlan": {
+ "description": "Represents a phone plan.",
+ "required": [
+ "localizedName",
+ "locationType",
+ "phonePlanId"
+ ],
+ "type": "object",
+ "properties": {
+ "phonePlanId": {
+ "description": "The phone plan id",
+ "type": "string"
+ },
+ "localizedName": {
+ "description": "The name of the phone plan",
+ "type": "string"
+ },
+ "locationType": {
+ "description": "The location type of the phone plan.",
+ "enum": [
+ "CivicAddress",
+ "NotRequired",
+ "Selection"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "LocationType",
+ "modelAsString": true
+ }
+ },
+ "areaCodes": {
+ "description": "The list of available area codes in the phone plan.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "capabilities": {
+ "description": "Capabilities of the phone plan.",
+ "type": "array",
+ "items": {
+ "description": "Represents the capabilities of a phone number.",
+ "enum": [
+ "UserAssignment",
+ "FirstPartyVoiceAppAssignment",
+ "ConferenceAssignment",
+ "P2PSmsEnabled",
+ "Geographic",
+ "NonGeographic",
+ "TollCalling",
+ "TollFreeCalling",
+ "Premium",
+ "P2PSmsCapable",
+ "A2PSmsCapable",
+ "A2PSmsEnabled",
+ "Calling",
+ "TollFree",
+ "FirstPartyAppAssignment",
+ "ThirdPartyAppAssignment",
+ "Azure",
+ "Office365",
+ "InboundCalling",
+ "OutboundCalling",
+ "InboundA2PSms",
+ "OutboundA2PSms",
+ "InboundP2PSms",
+ "OutboundP2PSms"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "Capability",
+ "modelAsString": true
+ }
+ }
+ },
+ "maximumSearchSize": {
+ "format": "int32",
+ "description": "The maximum number of phone numbers one can acquire in a search in this phone plan.",
+ "type": "integer"
+ }
+ }
+ },
+ "PhonePlansResponse": {
+ "description": "Represents a wrapper around a list of countries.",
+ "type": "object",
+ "properties": {
+ "phonePlans": {
+ "description": "Represents the underlying list of phone plans.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/PhonePlan"
+ }
+ },
+ "nextLink": {
+ "description": "Represents the URL link to the next page",
+ "type": "string"
+ }
+ }
+ },
+ "LocationOptionsDetails": {
+ "description": "Represents location options details.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "The name of the location options",
+ "type": "string"
+ },
+ "value": {
+ "description": "The abbreviated name of the location options",
+ "type": "string"
+ },
+ "locationOptions": {
+ "description": "The underlying location options",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/LocationOptions"
+ }
+ }
+ }
+ },
+ "LocationOptions": {
+ "description": "Represents a location options.",
+ "type": "object",
+ "properties": {
+ "labelId": {
+ "description": "The label id of the location.",
+ "type": "string"
+ },
+ "labelName": {
+ "description": "The display name of the location.",
+ "type": "string"
+ },
+ "options": {
+ "description": "The underlying location option details.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/LocationOptionsDetails"
+ }
+ }
+ }
+ },
+ "LocationOptionsResponse": {
+ "description": "Represents a wrapper around a list of location options.",
+ "type": "object",
+ "properties": {
+ "locationOptions": {
+ "$ref": "#/definitions/LocationOptions"
+ }
+ }
+ },
+ "PhoneNumberReleaseDetails": {
+ "type": "object",
+ "properties": {
+ "status": {
+ "description": "The release status of a phone number.",
+ "enum": [
+ "Pending",
+ "Success",
+ "Error",
+ "InProgress"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "PhoneNumberReleaseStatus",
+ "modelAsString": true
+ }
+ },
+ "errorCode": {
+ "format": "int32",
+ "description": "The error code in the case the status is error.",
+ "type": "integer"
+ }
+ }
+ },
+ "PhoneNumberRelease": {
+ "description": "Represents a release",
+ "type": "object",
+ "properties": {
+ "releaseId": {
+ "description": "The id of the release.",
+ "type": "string"
+ },
+ "createdAt": {
+ "format": "date-time",
+ "description": "The creation time of the release.",
+ "type": "string"
+ },
+ "status": {
+ "description": "The release status.",
+ "enum": [
+ "Pending",
+ "InProgress",
+ "Complete",
+ "Failed",
+ "Expired"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "ReleaseStatus",
+ "modelAsString": true
+ }
+ },
+ "errorMessage": {
+ "description": "The underlying error message of a release.",
+ "type": "string"
+ },
+ "phoneNumberReleaseStatusDetails": {
+ "description": "The list of phone numbers in the release, mapped to its individual statuses.",
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/definitions/PhoneNumberReleaseDetails"
+ }
+ }
+ }
+ },
+ "ReleaseRequest": {
+ "description": "Represents a release request.",
+ "required": [
+ "phoneNumbers"
+ ],
+ "type": "object",
+ "properties": {
+ "phoneNumbers": {
+ "description": "The list of phone numbers in the release request.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "ReleaseResponse": {
+ "description": "Represents a release response.",
+ "required": [
+ "releaseId"
+ ],
+ "type": "object",
+ "properties": {
+ "releaseId": {
+ "description": "The release id of a created release.",
+ "type": "string"
+ }
+ }
+ },
+ "PhoneNumberEntity": {
+ "description": "Represents a phone number entity, as part of the response when calling get all searches or releases.",
+ "type": "object",
+ "properties": {
+ "id": {
+ "description": "The id of the entity. It is the search id of a search. It is the release id of a release.",
+ "type": "string"
+ },
+ "createdAt": {
+ "format": "date-time",
+ "description": "Date and time the entity is created.",
+ "type": "string"
+ },
+ "displayName": {
+ "description": "Name of the entity.",
+ "type": "string"
+ },
+ "quantity": {
+ "format": "int32",
+ "description": "Quantity of requested phone numbers in the entity.",
+ "type": "integer"
+ },
+ "quantityObtained": {
+ "format": "int32",
+ "description": "Quantity of acquired phone numbers in the entity.",
+ "type": "integer"
+ },
+ "status": {
+ "description": "Status of the entity.",
+ "type": "string"
+ },
+ "focDate": {
+ "format": "date-time",
+ "description": "The Firm Order Confirmation date of the phone number entity.",
+ "type": "string"
+ }
+ }
+ },
+ "PhoneNumberEntities": {
+ "description": "Represents a list of searches or releases, as part of the response when fetching all searches or releases.",
+ "type": "object",
+ "properties": {
+ "entities": {
+ "description": "The underlying list of entities.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/PhoneNumberEntity"
+ }
+ },
+ "nextLink": {
+ "description": "Represents the URL link to the next page",
+ "type": "string"
+ }
+ }
+ },
+ "PhoneNumberSearch": {
+ "description": "Represents a phone number search",
+ "type": "object",
+ "properties": {
+ "searchId": {
+ "description": "The id of the search.",
+ "type": "string"
+ },
+ "displayName": {
+ "description": "The name of the search.",
+ "type": "string"
+ },
+ "createdAt": {
+ "format": "date-time",
+ "description": "The creation time of the search.",
+ "type": "string"
+ },
+ "description": {
+ "description": "The description of the search.",
+ "type": "string"
+ },
+ "phonePlanIds": {
+ "description": "The phone plan ids of the search.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "areaCode": {
+ "description": "The area code of the search.",
+ "type": "string"
+ },
+ "quantity": {
+ "format": "int32",
+ "description": "The quantity of phone numbers in the search.",
+ "type": "integer"
+ },
+ "locationOptions": {
+ "description": "The location options of the search.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/LocationOptionsDetails"
+ }
+ },
+ "status": {
+ "description": "The status of the search.",
+ "enum": [
+ "Pending",
+ "InProgress",
+ "Reserved",
+ "Expired",
+ "Expiring",
+ "Completing",
+ "Refreshing",
+ "Success",
+ "Manual",
+ "Cancelled",
+ "Cancelling",
+ "Error",
+ "PurchasePending"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "SearchStatus",
+ "modelAsString": true
+ }
+ },
+ "phoneNumbers": {
+ "description": "The list of phone numbers in the search, in the case the status is reserved or success.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "reservationExpiryDate": {
+ "format": "date-time",
+ "description": "The date that search expires and the numbers become available.",
+ "type": "string"
+ },
+ "errorCode": {
+ "format": "int32",
+ "description": "The error code of the search.",
+ "type": "integer"
+ }
+ }
+ },
+ "CreateSearchOptions": {
+ "description": "Represents a search creation option.",
+ "required": [
+ "areaCode",
+ "description",
+ "displayName",
+ "phonePlanIds"
+ ],
+ "type": "object",
+ "properties": {
+ "displayName": {
+ "description": "Display name of the search.",
+ "maxLength": 255,
+ "type": "string"
+ },
+ "description": {
+ "description": "Description of the search.",
+ "maxLength": 255,
+ "type": "string"
+ },
+ "phonePlanIds": {
+ "description": "The plan subtype ids from which to create the search.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "areaCode": {
+ "description": "The area code from which to create the search.",
+ "type": "string"
+ },
+ "quantity": {
+ "format": "int32",
+ "description": "The quantity of phone numbers to request.",
+ "maximum": 2147483647,
+ "minimum": 1,
+ "type": "integer"
+ },
+ "locationOptions": {
+ "description": "The location options of the search.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/LocationOptionsDetails"
+ }
+ }
+ }
+ },
+ "CreateSearchResponse": {
+ "description": "Represents a search creation response.",
+ "required": [
+ "searchId"
+ ],
+ "type": "object",
+ "properties": {
+ "searchId": {
+ "description": "The search id of the search that was created.",
+ "type": "string"
+ }
+ }
+ }
+ },
+ "parameters": {
+ "ApiVersionParameter": {
+ "in": "query",
+ "name": "api-version",
+ "description": "Version of API to invoke",
+ "required": true,
+ "type": "string"
+ },
+ "Endpoint": {
+ "in": "path",
+ "name": "endpoint",
+ "description": "The endpoint of the Azure Communication resource.",
+ "required": true,
+ "type": "string",
+ "x-ms-skip-url-encoding": true,
+ "x-ms-parameter-location": "client"
+ }
+ },
+ "securityDefinitions": {
+ "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/Microsoft.CommunicationServicesAdministration/preview/2020-07-20-preview1/examples/CancelSearchAsync.json b/specification/communication/data-plane/Microsoft.CommunicationServicesAdministration/preview/2020-07-20-preview1/examples/CancelSearchAsync.json
new file mode 100644
index 000000000000..0d393b557bc5
--- /dev/null
+++ b/specification/communication/data-plane/Microsoft.CommunicationServicesAdministration/preview/2020-07-20-preview1/examples/CancelSearchAsync.json
@@ -0,0 +1,10 @@
+{
+ "parameters": {
+ "api-version": "2020-07-20-preview1",
+ "endpoint": "https://resourcename.communications.azure.net/",
+ "searchId": "0cc077cd-333a-39fd-90f7-560b1e06c63e"
+ },
+ "responses": {
+ "202": {}
+ }
+}
diff --git a/specification/communication/data-plane/Microsoft.CommunicationServicesAdministration/preview/2020-07-20-preview1/examples/ConfigurePhoneNumberAsync.json b/specification/communication/data-plane/Microsoft.CommunicationServicesAdministration/preview/2020-07-20-preview1/examples/ConfigurePhoneNumberAsync.json
new file mode 100644
index 000000000000..d95a9053bddb
--- /dev/null
+++ b/specification/communication/data-plane/Microsoft.CommunicationServicesAdministration/preview/2020-07-20-preview1/examples/ConfigurePhoneNumberAsync.json
@@ -0,0 +1,16 @@
+{
+ "parameters": {
+ "api-version": "2020-07-20-preview1",
+ "body": {
+ "phoneNumber": "+11234567890",
+ "pstnConfiguration": {
+ "callbackUrl": "www.callback.com",
+ "applicationId": "abc123"
+ }
+ },
+ "endpoint": "https://resourcename.communications.azure.net/"
+ },
+ "responses": {
+ "200": {}
+ }
+}
diff --git a/specification/communication/data-plane/Microsoft.CommunicationServicesAdministration/preview/2020-07-20-preview1/examples/CreateReleaseAsync.json b/specification/communication/data-plane/Microsoft.CommunicationServicesAdministration/preview/2020-07-20-preview1/examples/CreateReleaseAsync.json
new file mode 100644
index 000000000000..b1c75ce1facd
--- /dev/null
+++ b/specification/communication/data-plane/Microsoft.CommunicationServicesAdministration/preview/2020-07-20-preview1/examples/CreateReleaseAsync.json
@@ -0,0 +1,19 @@
+{
+ "parameters": {
+ "api-version": "2020-07-20-preview1",
+ "body": {
+ "phoneNumbers": [
+ "+11234567890"
+ ]
+ },
+ "endpoint": "https://resourcename.communications.azure.net/"
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": {
+ "releaseId": "0cc077cd-333a-39fd-90f7-560b1e06c63e"
+ }
+ }
+ }
+}
diff --git a/specification/communication/data-plane/Microsoft.CommunicationServicesAdministration/preview/2020-07-20-preview1/examples/CreateSearchAsync.json b/specification/communication/data-plane/Microsoft.CommunicationServicesAdministration/preview/2020-07-20-preview1/examples/CreateSearchAsync.json
new file mode 100644
index 000000000000..2e253c17abc1
--- /dev/null
+++ b/specification/communication/data-plane/Microsoft.CommunicationServicesAdministration/preview/2020-07-20-preview1/examples/CreateSearchAsync.json
@@ -0,0 +1,29 @@
+{
+ "parameters": {
+ "api-version": "2020-07-20-preview1",
+ "body": {
+ "displayName": "Name",
+ "description": "Search Description",
+ "phonePlanIds": [
+ "0cc077cd-333a-39fd-90f7-560b1e06c63e"
+ ],
+ "areaCode": "425",
+ "quantity": 2,
+ "locationOptions": [
+ {
+ "name": "state",
+ "value": "WA"
+ }
+ ]
+ },
+ "endpoint": "https://resourcename.communications.azure.net/"
+ },
+ "responses": {
+ "201": {
+ "headers": {},
+ "body": {
+ "searchId": "0cc077cd-5337-7msf-964e-560b1e06c63e"
+ }
+ }
+ }
+}
diff --git a/specification/communication/data-plane/Microsoft.CommunicationServicesAdministration/preview/2020-07-20-preview1/examples/GetAcquiredPhoneNumbersAsync.json b/specification/communication/data-plane/Microsoft.CommunicationServicesAdministration/preview/2020-07-20-preview1/examples/GetAcquiredPhoneNumbersAsync.json
new file mode 100644
index 000000000000..3ad4280fe83a
--- /dev/null
+++ b/specification/communication/data-plane/Microsoft.CommunicationServicesAdministration/preview/2020-07-20-preview1/examples/GetAcquiredPhoneNumbersAsync.json
@@ -0,0 +1,42 @@
+{
+ "parameters": {
+ "api-version": "2020-07-20-preview1",
+ "endpoint": "https://resourcename.communications.azure.net/",
+ "locale": "en-us"
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": {
+ "phoneNumbers": [
+ {
+ "phoneNumber": "+11234567890",
+ "acquiredCapabilities": [
+ "FirstPartyAppAssignment"
+ ],
+ "availableCapabilities": [
+ "FirstPartyAppAssignment",
+ "UserAssignment"
+ ],
+ "assignmentStatus": "Unassigned",
+ "placeName": "Toll-Free, United States",
+ "activationState": "Activated"
+ },
+ {
+ "phoneNumber": "+18003456789",
+ "acquiredCapabilities": [
+ "FirstPartyAppAssignment"
+ ],
+ "availableCapabilities": [
+ "FirstPartyAppAssignment",
+ "UserAssignment"
+ ],
+ "assignmentStatus": "Unassigned",
+ "placeName": "Toll-Free, United States",
+ "activationState": "Activated"
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/communication/data-plane/Microsoft.CommunicationServicesAdministration/preview/2020-07-20-preview1/examples/GetAllReleasesAsync.json b/specification/communication/data-plane/Microsoft.CommunicationServicesAdministration/preview/2020-07-20-preview1/examples/GetAllReleasesAsync.json
new file mode 100644
index 000000000000..29a8ddb4979e
--- /dev/null
+++ b/specification/communication/data-plane/Microsoft.CommunicationServicesAdministration/preview/2020-07-20-preview1/examples/GetAllReleasesAsync.json
@@ -0,0 +1,24 @@
+{
+ "parameters": {
+ "api-version": "2020-07-20-preview1",
+ "endpoint": "https://resourcename.communications.azure.net/"
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": {
+ "entities": [
+ {
+ "id": "0cc077cd-333a-39fd-90f7-560b1e06c63e",
+ "displayName": "Numbers for Vancouver Office",
+ "createdAt": "2020-06-18T17:11:52.5005818+00:00",
+ "quantity": 1,
+ "quantityObtained": 1,
+ "status": "completed",
+ "focDate": "2020-06-18T17:11:52.5005818+00:00"
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/communication/data-plane/Microsoft.CommunicationServicesAdministration/preview/2020-07-20-preview1/examples/GetAllSearchesAsync.json b/specification/communication/data-plane/Microsoft.CommunicationServicesAdministration/preview/2020-07-20-preview1/examples/GetAllSearchesAsync.json
new file mode 100644
index 000000000000..29a8ddb4979e
--- /dev/null
+++ b/specification/communication/data-plane/Microsoft.CommunicationServicesAdministration/preview/2020-07-20-preview1/examples/GetAllSearchesAsync.json
@@ -0,0 +1,24 @@
+{
+ "parameters": {
+ "api-version": "2020-07-20-preview1",
+ "endpoint": "https://resourcename.communications.azure.net/"
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": {
+ "entities": [
+ {
+ "id": "0cc077cd-333a-39fd-90f7-560b1e06c63e",
+ "displayName": "Numbers for Vancouver Office",
+ "createdAt": "2020-06-18T17:11:52.5005818+00:00",
+ "quantity": 1,
+ "quantityObtained": 1,
+ "status": "completed",
+ "focDate": "2020-06-18T17:11:52.5005818+00:00"
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/communication/data-plane/Microsoft.CommunicationServicesAdministration/preview/2020-07-20-preview1/examples/GetAreaCodesAsync.json b/specification/communication/data-plane/Microsoft.CommunicationServicesAdministration/preview/2020-07-20-preview1/examples/GetAreaCodesAsync.json
new file mode 100644
index 000000000000..1288173209cc
--- /dev/null
+++ b/specification/communication/data-plane/Microsoft.CommunicationServicesAdministration/preview/2020-07-20-preview1/examples/GetAreaCodesAsync.json
@@ -0,0 +1,22 @@
+{
+ "parameters": {
+ "api-version": "2020-07-20-preview1",
+ "endpoint": "https://resourcename.communications.azure.net/",
+ "locationType": "Selection",
+ "countryCode": "CA",
+ "phonePlanId": "0cc077cd-333a-39fd-90f7-560b1e06c63e"
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": {
+ "primaryAreaCodes": [
+ "236",
+ "604",
+ "778"
+ ],
+ "secondaryAreaCodes": []
+ }
+ }
+ }
+}
diff --git a/specification/communication/data-plane/Microsoft.CommunicationServicesAdministration/preview/2020-07-20-preview1/examples/GetCountriesAsync.json b/specification/communication/data-plane/Microsoft.CommunicationServicesAdministration/preview/2020-07-20-preview1/examples/GetCountriesAsync.json
new file mode 100644
index 000000000000..fe4dbb0b999f
--- /dev/null
+++ b/specification/communication/data-plane/Microsoft.CommunicationServicesAdministration/preview/2020-07-20-preview1/examples/GetCountriesAsync.json
@@ -0,0 +1,28 @@
+{
+ "parameters": {
+ "api-version": "2020-07-20-preview1",
+ "endpoint": "https://resourcename.communications.azure.net/",
+ "locale": "en-us"
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": {
+ "countries": [
+ {
+ "localizedName": "Australia",
+ "countryCode": "AU"
+ },
+ {
+ "localizedName": "Japan",
+ "countryCode": "JP"
+ },
+ {
+ "localizedName": "United States",
+ "countryCode": "US"
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/communication/data-plane/Microsoft.CommunicationServicesAdministration/preview/2020-07-20-preview1/examples/GetLocationOptionsAsync.json b/specification/communication/data-plane/Microsoft.CommunicationServicesAdministration/preview/2020-07-20-preview1/examples/GetLocationOptionsAsync.json
new file mode 100644
index 000000000000..b551fa840089
--- /dev/null
+++ b/specification/communication/data-plane/Microsoft.CommunicationServicesAdministration/preview/2020-07-20-preview1/examples/GetLocationOptionsAsync.json
@@ -0,0 +1,66 @@
+{
+ "parameters": {
+ "api-version": "2020-07-20-preview1",
+ "countryCode": "US",
+ "endpoint": "https://resourcename.communications.azure.net/",
+ "phonePlanGroupId": "671ee064-662f-4c3b-82a9-af2ab200dd5c",
+ "phonePlanId": "27b53eec-8ff4-4070-8900-fbeaabfd158a"
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": {
+ "locationOptions": {
+ "labelId": "state",
+ "labelName": "State",
+ "options": [
+ {
+ "name": "AK",
+ "value": "AK",
+ "locationOptions": [
+ {
+ "labelId": "city",
+ "labelName": "City",
+ "options": [
+ {
+ "name": "Anchorage",
+ "value": "NOAM-US-AK-AN"
+ }
+ ]
+ }
+ ]
+ },
+ {
+ "name": "AL",
+ "value": "AL",
+ "locationOptions": [
+ {
+ "labelId": "city",
+ "labelName": "City",
+ "options": [
+ {
+ "name": "Birmingham",
+ "value": "NOAM-US-AL-BI"
+ },
+ {
+ "name": "Huntsville",
+ "value": "NOAM-US-AL-HN"
+ },
+ {
+ "name": "Mobile",
+ "value": "NOAM-US-AL-MO"
+ },
+ {
+ "name": "Montgomery",
+ "value": "NOAM-US-AL-MN"
+ }
+ ]
+ }
+ ]
+ }
+ ]
+ }
+ }
+ }
+ }
+}
diff --git a/specification/communication/data-plane/Microsoft.CommunicationServicesAdministration/preview/2020-07-20-preview1/examples/GetNumberCapabilitiesUpdateAsync.json b/specification/communication/data-plane/Microsoft.CommunicationServicesAdministration/preview/2020-07-20-preview1/examples/GetNumberCapabilitiesUpdateAsync.json
new file mode 100644
index 000000000000..11949cff84a3
--- /dev/null
+++ b/specification/communication/data-plane/Microsoft.CommunicationServicesAdministration/preview/2020-07-20-preview1/examples/GetNumberCapabilitiesUpdateAsync.json
@@ -0,0 +1,26 @@
+{
+ "parameters": {
+ "api-version": "2020-07-20-preview1",
+ "endpoint": "https://resourcename.communications.azure.net/",
+ "capabilitiesUpdateId": "0cc077cd-333a-39fd-90f7-560b1e06c63e"
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": {
+ "capabilitiesUpdateId": "0cc077cd-333a-39fd-90f7-560b1e06c63e",
+ "createdAt": "2020-06-18T17:11:52.5005818+00:00",
+ "capabilitiesUpdateStatus": "Complete",
+ "phoneNumberCapabilitiesUpdates": {
+ "12345878991": {
+ "add": [],
+ "remove": [
+ "InboundA2PSms",
+ "OutboundA2PSms"
+ ]
+ }
+ }
+ }
+ }
+ }
+}
diff --git a/specification/communication/data-plane/Microsoft.CommunicationServicesAdministration/preview/2020-07-20-preview1/examples/GetNumberConfigurationAsync.json b/specification/communication/data-plane/Microsoft.CommunicationServicesAdministration/preview/2020-07-20-preview1/examples/GetNumberConfigurationAsync.json
new file mode 100644
index 000000000000..573d697b2934
--- /dev/null
+++ b/specification/communication/data-plane/Microsoft.CommunicationServicesAdministration/preview/2020-07-20-preview1/examples/GetNumberConfigurationAsync.json
@@ -0,0 +1,20 @@
+{
+ "parameters": {
+ "api-version": "2020-07-20-preview1",
+ "body": {
+ "phoneNumber": "+11234567890"
+ },
+ "endpoint": "https://resourcename.communications.azure.net/"
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": {
+ "pstnConfiguration": {
+ "callbackUrl": "www.callback.com",
+ "applicationId": "abc123"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/communication/data-plane/Microsoft.CommunicationServicesAdministration/preview/2020-07-20-preview1/examples/GetPhonePlanGroupsAsync.json b/specification/communication/data-plane/Microsoft.CommunicationServicesAdministration/preview/2020-07-20-preview1/examples/GetPhonePlanGroupsAsync.json
new file mode 100644
index 000000000000..f418ffd2ff23
--- /dev/null
+++ b/specification/communication/data-plane/Microsoft.CommunicationServicesAdministration/preview/2020-07-20-preview1/examples/GetPhonePlanGroupsAsync.json
@@ -0,0 +1,37 @@
+{
+ "parameters": {
+ "api-version": "2020-07-20-preview1",
+ "countryCode": "US",
+ "endpoint": "https://resourcename.communications.azure.net/",
+ "locale": "en-us"
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": {
+ "phonePlanGroups": [
+ {
+ "phonePlanGroupId": "671ee064-662f-4c3b-82a9-af2ab200dd5c",
+ "phoneNumberType": "Geographic",
+ "localizedName": "Geographic",
+ "localizedDescription": "These are Toll numbers",
+ "rateInformation": {
+ "monthlyRate": 2.0,
+ "currencyType": "USD"
+ }
+ },
+ {
+ "phonePlanGroupId": "d47a0cdc-8dc1-4e82-a29b-39067f7fc317",
+ "phoneNumberType": "TollFree",
+ "localizedName": "TollFree",
+ "localizedDescription": "These are toll free numbers used by Azure resources.",
+ "rateInformation": {
+ "monthlyRate": 1.0,
+ "currencyType": "USD"
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/communication/data-plane/Microsoft.CommunicationServicesAdministration/preview/2020-07-20-preview1/examples/GetPhonePlansAsync.json b/specification/communication/data-plane/Microsoft.CommunicationServicesAdministration/preview/2020-07-20-preview1/examples/GetPhonePlansAsync.json
new file mode 100644
index 000000000000..88ed446f84e8
--- /dev/null
+++ b/specification/communication/data-plane/Microsoft.CommunicationServicesAdministration/preview/2020-07-20-preview1/examples/GetPhonePlansAsync.json
@@ -0,0 +1,29 @@
+{
+ "parameters": {
+ "api-version": "2020-07-20-preview1",
+ "countryCode": "US",
+ "endpoint": "https://resourcename.communications.azure.net/",
+ "phonePlanGroupId": "671ee064-662f-4c3b-82a9-af2ab200dd5c"
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": {
+ "phonePlans": [
+ {
+ "phonePlanId": "27b53eec-8ff4-4070-8900-fbeaabfd158a",
+ "localizedName": "Outbound Only PSTN - Geographic",
+ "locationType": "Selection",
+ "capabilities": [
+ "Azure",
+ "OutboundCalling",
+ "ThirdPartyAppAssignment",
+ "Geographic"
+ ],
+ "maximumSearchSize": 100
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/communication/data-plane/Microsoft.CommunicationServicesAdministration/preview/2020-07-20-preview1/examples/GetReleaseByIdAsync.json b/specification/communication/data-plane/Microsoft.CommunicationServicesAdministration/preview/2020-07-20-preview1/examples/GetReleaseByIdAsync.json
new file mode 100644
index 000000000000..10813ab35c36
--- /dev/null
+++ b/specification/communication/data-plane/Microsoft.CommunicationServicesAdministration/preview/2020-07-20-preview1/examples/GetReleaseByIdAsync.json
@@ -0,0 +1,15 @@
+{
+ "parameters": {
+ "api-version": "2020-07-20-preview1",
+ "endpoint": "https://resourcename.communications.azure.net/",
+ "releaseId": "0cc077cd-333a-39fd-90f7-560b1e06c63e"
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": {
+ "releaseId": "0cc077cd-333a-39fd-90f7-560b1e06c63e"
+ }
+ }
+ }
+}
diff --git a/specification/communication/data-plane/Microsoft.CommunicationServicesAdministration/preview/2020-07-20-preview1/examples/GetSearchByIdAsync.json b/specification/communication/data-plane/Microsoft.CommunicationServicesAdministration/preview/2020-07-20-preview1/examples/GetSearchByIdAsync.json
new file mode 100644
index 000000000000..a0e892008493
--- /dev/null
+++ b/specification/communication/data-plane/Microsoft.CommunicationServicesAdministration/preview/2020-07-20-preview1/examples/GetSearchByIdAsync.json
@@ -0,0 +1,26 @@
+{
+ "parameters": {
+ "api-version": "2020-07-20-preview1",
+ "endpoint": "https://resourcename.communications.azure.net/",
+ "searchId": "0cc077cd-333a-39fd-90f7-560b1e06c63e"
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": {
+ "searchId": "0cc077cd-333a-39fd-90f7-560b1e06c63e",
+ "displayName": "Numbers for Vancouver Office",
+ "createdAt": "2020-06-18T17:11:52.5005818+00:00",
+ "description": "Get some new numbers for our office in Vancouver",
+ "phonePlanIds": [
+ "0cc077cd-333a-39fd-90f7-560b1e06c63e"
+ ],
+ "areaCode": "604",
+ "quantity": 1,
+ "locationOptions": [],
+ "status": "completed",
+ "phoneNumbers": []
+ }
+ }
+ }
+}
diff --git a/specification/communication/data-plane/Microsoft.CommunicationServicesAdministration/preview/2020-07-20-preview1/examples/PurchaseSearchAsync.json b/specification/communication/data-plane/Microsoft.CommunicationServicesAdministration/preview/2020-07-20-preview1/examples/PurchaseSearchAsync.json
new file mode 100644
index 000000000000..0d393b557bc5
--- /dev/null
+++ b/specification/communication/data-plane/Microsoft.CommunicationServicesAdministration/preview/2020-07-20-preview1/examples/PurchaseSearchAsync.json
@@ -0,0 +1,10 @@
+{
+ "parameters": {
+ "api-version": "2020-07-20-preview1",
+ "endpoint": "https://resourcename.communications.azure.net/",
+ "searchId": "0cc077cd-333a-39fd-90f7-560b1e06c63e"
+ },
+ "responses": {
+ "202": {}
+ }
+}
diff --git a/specification/communication/data-plane/Microsoft.CommunicationServicesAdministration/preview/2020-07-20-preview1/examples/UnconfigurePhoneNumberAsync.json b/specification/communication/data-plane/Microsoft.CommunicationServicesAdministration/preview/2020-07-20-preview1/examples/UnconfigurePhoneNumberAsync.json
new file mode 100644
index 000000000000..e8da11cf3109
--- /dev/null
+++ b/specification/communication/data-plane/Microsoft.CommunicationServicesAdministration/preview/2020-07-20-preview1/examples/UnconfigurePhoneNumberAsync.json
@@ -0,0 +1,12 @@
+{
+ "parameters": {
+ "api-version": "2020-07-20-preview1",
+ "body": {
+ "phoneNumber": "+11234567890"
+ },
+ "endpoint": "https://resourcename.communications.azure.net/"
+ },
+ "responses": {
+ "200": {}
+ }
+}
diff --git a/specification/communication/data-plane/Microsoft.CommunicationServicesAdministration/preview/2020-07-20-preview1/examples/UpdateNumberCapabilitiesAsync.json b/specification/communication/data-plane/Microsoft.CommunicationServicesAdministration/preview/2020-07-20-preview1/examples/UpdateNumberCapabilitiesAsync.json
new file mode 100644
index 000000000000..612b5f2b2740
--- /dev/null
+++ b/specification/communication/data-plane/Microsoft.CommunicationServicesAdministration/preview/2020-07-20-preview1/examples/UpdateNumberCapabilitiesAsync.json
@@ -0,0 +1,32 @@
+{
+ "parameters": {
+ "api-version": "2020-07-20-preview1",
+ "body": {
+ "phoneNumberCapabilitiesUpdate": {
+ "12345878981": {
+ "add": [
+ "InboundA2PSms",
+ "OutboundA2PSms"
+ ],
+ "remove": []
+ },
+ "12345878991": {
+ "add": [],
+ "remove": [
+ "InboundA2PSms",
+ "OutboundA2PSms"
+ ]
+ }
+ }
+ },
+ "endpoint": "https://resourcename.communications.azure.net/"
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": {
+ "capabilitiesUpdateId": "0cc077cd-5337-7msf-964e-560b1e06c63e"
+ }
+ }
+ }
+}
diff --git a/specification/communication/data-plane/readme.md b/specification/communication/data-plane/readme.md
index e4d7480f69cd..32387d6d037d 100644
--- a/specification/communication/data-plane/readme.md
+++ b/specification/communication/data-plane/readme.md
@@ -35,6 +35,7 @@ These settings apply only when `--tag=package-2020-07-20-preview1` is specified
```yaml $(tag) == 'package-2020-07-20-preview1'
input-file:
+ - Microsoft.CommunicationServicesAdministration/preview/2020-07-20-preview1/communicationservicesadministration.json
- Microsoft.CommunicationServicesSms/preview/2020-07-20-preview1/communicationservicessms.json
title:
Azure Communication Services
diff --git a/specification/communication/resource-manager/readme.md b/specification/communication/resource-manager/readme.md
index 2191f6dd16bf..f5b5483ca415 100644
--- a/specification/communication/resource-manager/readme.md
+++ b/specification/communication/resource-manager/readme.md
@@ -53,8 +53,7 @@ swagger-to-sdk:
- repo: azure-sdk-for-python
- repo: azure-sdk-for-python-track2
- repo: azure-sdk-for-go
- after_scripts:
- - bundle install && rake arm:regen_all_profiles['azure_mgmt_vsonline']
+ - repo: azure-sdk-for-js
```
## CSharp
@@ -68,3 +67,7 @@ See configuration in [readme.python.md](./readme.python.md)
## Go
See configuration in [readme.go.md](./readme.go.md)
+
+## Typescript
+
+See configuration in [readme.typescript.md](./readme.typescript.md)
diff --git a/specification/communication/resource-manager/readme.typescript.md b/specification/communication/resource-manager/readme.typescript.md
new file mode 100644
index 000000000000..702c0e38144e
--- /dev/null
+++ b/specification/communication/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-communication"
+ output-folder: "$(typescript-sdks-folder)/sdk/communication/arm-communication"
+ clear-output-folder: true
+ generate-metadata: true
+```
diff --git a/specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/sharedGallery.json b/specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/sharedGallery.json
index c3d8a76c77d1..1579fa58a3ea 100644
--- a/specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/sharedGallery.json
+++ b/specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/sharedGallery.json
@@ -532,7 +532,7 @@
],
"x-ms-enum": {
"name": "HyperVGeneration",
- "modelAsString": false
+ "modelAsString": true
}
},
"features": {
diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/compute.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/compute.json
index d7d39de3f591..7c34a03be331 100644
--- a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/compute.json
+++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/compute.json
@@ -4380,7 +4380,7 @@
"VirtualMachineScaleSets"
],
"operationId": "VirtualMachineScaleSets_ConvertToSinglePlacementGroup",
- "description": "Converts SinglePlacementGroup property to false for a existing virtual machine scale set.",
+ "description": "Converts SinglePlacementGroup property to true for a existing virtual machine scale set.",
"parameters": [
{
"name": "resourceGroupName",
diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/compute.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/compute.json
index f0df5077fd9c..cf7a3113540a 100644
--- a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/compute.json
+++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/compute.json
@@ -4535,7 +4535,7 @@
"VirtualMachineScaleSets"
],
"operationId": "VirtualMachineScaleSets_ConvertToSinglePlacementGroup",
- "description": "Converts SinglePlacementGroup property to false for a existing virtual machine scale set.",
+ "description": "Converts SinglePlacementGroup property to true for a existing virtual machine scale set.",
"parameters": [
{
"name": "resourceGroupName",
diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-12-01/compute.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-12-01/compute.json
index 4e9f646b5399..338767d2b350 100644
--- a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-12-01/compute.json
+++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-12-01/compute.json
@@ -4877,7 +4877,7 @@
"VirtualMachineScaleSets"
],
"operationId": "VirtualMachineScaleSets_ConvertToSinglePlacementGroup",
- "description": "Converts SinglePlacementGroup property to false for a existing virtual machine scale set.",
+ "description": "Converts SinglePlacementGroup property to true for a existing virtual machine scale set.",
"parameters": [
{
"name": "resourceGroupName",
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 7bd220c78877..e680df16e276 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
@@ -2799,6 +2799,13 @@
"type": "string",
"description": "The name of the virtual machine."
},
+ {
+ "name": "forceDeletion",
+ "in": "query",
+ "required": false,
+ "type": "boolean",
+ "description": "Optional parameter to force delete virtual machines."
+ },
{
"$ref": "#/parameters/ApiVersionParameter"
},
diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateOrUpdateRunCommand.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateOrUpdateRunCommand.json
new file mode 100644
index 000000000000..db92b1fe3928
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateOrUpdateRunCommand.json
@@ -0,0 +1,95 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "myResourceGroup",
+ "vmName": "myVM",
+ "runCommandName": "myRunCommand",
+ "api-version": "2020-06-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": "user1pwd",
+ "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/2020-06-01/examples/CreateOrUpdateVirtualMachineScaleSetVMRunCommands.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateOrUpdateVirtualMachineScaleSetVMRunCommands.json
new file mode 100644
index 000000000000..47a3f58b14ac
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateOrUpdateVirtualMachineScaleSetVMRunCommands.json
@@ -0,0 +1,88 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "myResourceGroup",
+ "vmScaleSetName": "myvmScaleSet",
+ "instanceId": "0",
+ "runCommandName": "myRunCommand",
+ "api-version": "2020-06-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": "user1pwd",
+ "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/2020-06-01/examples/DeleteRunCommand.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/DeleteRunCommand.json
new file mode 100644
index 000000000000..36cc3049720f
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/DeleteRunCommand.json
@@ -0,0 +1,14 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "myResourceGroup",
+ "vmName": "myVM",
+ "runCommandName": "myRunCommand",
+ "api-version": "2020-06-01"
+ },
+ "responses": {
+ "200": {},
+ "202": {},
+ "204": {}
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/DeleteVirtualMachineScaleSetVMRunCommands.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/DeleteVirtualMachineScaleSetVMRunCommands.json
new file mode 100644
index 000000000000..9eb3ffc247fd
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/DeleteVirtualMachineScaleSetVMRunCommands.json
@@ -0,0 +1,15 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "myResourceGroup",
+ "vmScaleSetName": "myvmScaleSet",
+ "instanceId": "0",
+ "runCommandName": "myRunCommand",
+ "api-version": "2020-06-01"
+ },
+ "responses": {
+ "200": {},
+ "202": {},
+ "204": {}
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/GetRunCommand.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/GetRunCommand.json
new file mode 100644
index 000000000000..b4e049882c4d
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/GetRunCommand.json
@@ -0,0 +1,42 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "myResourceGroup",
+ "vmName": "myVM",
+ "runCommandName": "myRunCommand",
+ "api-version": "2020-06-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/2020-06-01/examples/GetVirtualMachineScaleSetVMRunCommands.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/GetVirtualMachineScaleSetVMRunCommands.json
new file mode 100644
index 000000000000..94186291bb52
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/GetVirtualMachineScaleSetVMRunCommands.json
@@ -0,0 +1,43 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "myResourceGroup",
+ "vmScaleSetName": "myvmScaleSet",
+ "instanceId": "0",
+ "runCommandName": "myRunCommand",
+ "api-version": "2020-06-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/2020-06-01/examples/ListRunCommandsInVM.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/ListRunCommandsInVM.json
new file mode 100644
index 000000000000..d3194a3468af
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/ListRunCommandsInVM.json
@@ -0,0 +1,45 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "myResourceGroup",
+ "vmName": "myVM",
+ "api-version": "2020-06-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/2020-06-01/examples/ListVirtualMachineScaleSetVMRunCommands.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/ListVirtualMachineScaleSetVMRunCommands.json
new file mode 100644
index 000000000000..79e9c50e4cd5
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/ListVirtualMachineScaleSetVMRunCommands.json
@@ -0,0 +1,42 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "myResourceGroup",
+ "vmScaleSetName": "myvmScaleSet",
+ "instanceId": "0",
+ "api-version": "2020-06-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/2020-06-01/examples/UpdateRunCommand.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/UpdateRunCommand.json
new file mode 100644
index 000000000000..bfccb6265f7a
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/UpdateRunCommand.json
@@ -0,0 +1,49 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "myResourceGroup",
+ "vmName": "myVM",
+ "runCommandName": "myRunCommand",
+ "api-version": "2020-06-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/2020-06-01/examples/UpdateVirtualMachineScaleSetVMRunCommands.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/UpdateVirtualMachineScaleSetVMRunCommands.json
new file mode 100644
index 000000000000..9107248c7c82
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/UpdateVirtualMachineScaleSetVMRunCommands.json
@@ -0,0 +1,50 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "myResourceGroup",
+ "vmScaleSetName": "myvmScaleSet",
+ "instanceId": "0",
+ "runCommandName": "myRunCommand",
+ "api-version": "2020-06-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/2020-06-01/runCommands.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/runCommands.json
index 9759cd8205e8..a8383302baad 100644
--- a/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/runCommands.json
+++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/runCommands.json
@@ -248,6 +248,679 @@
"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": {
@@ -451,6 +1124,299 @@
"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": {
diff --git a/specification/compute/resource-manager/readme.go.md b/specification/compute/resource-manager/readme.go.md
index 561571b385b6..8ef9b3f63da9 100644
--- a/specification/compute/resource-manager/readme.go.md
+++ b/specification/compute/resource-manager/readme.go.md
@@ -31,6 +31,7 @@ directive:
```yaml $(go) && $(multiapi)
batch:
+ - tag: package-2020-06-30
- tag: package-2020-06-01
- tag: package-2019-12-01
- tag: package-2019-07
@@ -50,6 +51,16 @@ batch:
- tag: package-container-service-2015-11-preview
```
+### Tag: package-2020-06-30 and go
+
+These settings apply only when `--tag=package-2020-06-30 --go` is specified on the command line.
+Please also specify `--go-sdk-folder=`.
+
+```yaml $(tag)=='package-2020-06-30' && $(go)
+namespace: compute
+output-folder: $(go-sdk-folder)/services/$(namespace)/mgmt/2020-06-30/$(namespace)
+```
+
### Tag: package-2020-06-01 and go
These settings apply only when `--tag=package-2020-06-01 --go` 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 53c612d8d114..8dc4338cd615 100644
--- a/specification/compute/resource-manager/readme.python.md
+++ b/specification/compute/resource-manager/readme.python.md
@@ -44,6 +44,7 @@ Generate all API versions currently shipped for this package
```yaml $(multiapi) && !$(track2)
batch:
+ - tag: package-2020-09-30-only
- tag: package-2020-06-30-only
- tag: package-2020-06-01-only
- tag: package-2020-05-01-only
@@ -67,6 +68,7 @@ batch:
```yaml $(multiapi) && $(track2)
clear-output-folder: true
batch:
+ - tag: package-2020-09-30-only
- tag: package-2020-06-30-only
- tag: package-2020-06-01-only
- tag: package-2020-05-01-only
@@ -94,6 +96,19 @@ clear-output-folder: false
perform-load: false
```
+### Tag: package-2020-09-30-only and python
+
+These settings apply only when `--tag=package-2020-09-30-only --python` is specified on the command line.
+Please also specify `--python-sdks-folder=`.
+
+``` yaml $(tag) == 'package-2020-09-30-only'
+namespace: azure.mgmt.compute.v2020_09_30
+output-folder: $(python-sdks-folder)/compute/azure-mgmt-compute/azure/mgmt/compute/v2020_09_30
+python:
+ namespace: azure.mgmt.compute.v2020_09_30
+ output-folder: $(python-sdks-folder)/compute/azure-mgmt-compute/azure/mgmt/compute/v2020_09_30
+```
+
### Tag: package-2020-06-30-only and python
These settings apply only when `--tag=package-2020-06-30-only --python` is specified on the command line.
diff --git a/specification/confluent/resource-manager/Microsoft.Confluent/preview/2020-03-01-preview/confluent.json b/specification/confluent/resource-manager/Microsoft.Confluent/preview/2020-03-01-preview/confluent.json
new file mode 100644
index 000000000000..548105316200
--- /dev/null
+++ b/specification/confluent/resource-manager/Microsoft.Confluent/preview/2020-03-01-preview/confluent.json
@@ -0,0 +1,719 @@
+{
+ "swagger": "2.0",
+ "info": {
+ "title": "Microsoft.Confluent",
+ "version": "2020-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": {
+ "/providers/Microsoft.Confluent/operations": {
+ "get": {
+ "tags": [
+ "Organization"
+ ],
+ "summary": "List all operations provided by Microsoft.Confluent.",
+ "operationId": "OrganizationOperations_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": {
+ "OrganizationOperations_List": {
+ "$ref": "./examples/OrganizationOperations_List.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/providers/Microsoft.Confluent/organizations": {
+ "get": {
+ "tags": [
+ "Organization"
+ ],
+ "summary": "List all organizations under the specified subscription.",
+ "operationId": "Organization_ListBySubscription",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "schema": {
+ "$ref": "#/definitions/OrganizationResourceListResult"
+ }
+ },
+ "default": {
+ "description": "Default error response.",
+ "schema": {
+ "$ref": "#/definitions/ResourceProviderDefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-examples": {
+ "Organization_ListBySubscription": {
+ "$ref": "./examples/Organization_ListBySubscription.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Confluent/organizations": {
+ "get": {
+ "tags": [
+ "Organization"
+ ],
+ "summary": "List all Organizations under the specified resource group.",
+ "operationId": "Organization_ListByResourceGroup",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/ResourceGroupParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "schema": {
+ "$ref": "#/definitions/OrganizationResourceListResult"
+ }
+ },
+ "default": {
+ "description": "Default error response.",
+ "schema": {
+ "$ref": "#/definitions/ResourceProviderDefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-examples": {
+ "Organization_ListByResourceGroup": {
+ "$ref": "./examples/Organization_ListByResourceGroup.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Confluent/organizations/{organizationName}": {
+ "get": {
+ "tags": [
+ "Organization"
+ ],
+ "summary": "Get the properties of a specific Organization resource.",
+ "operationId": "Organization_Get",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/ResourceGroupParameter"
+ },
+ {
+ "$ref": "#/parameters/OrganizationResourceNameParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "schema": {
+ "$ref": "#/definitions/OrganizationResource"
+ }
+ },
+ "default": {
+ "description": "Default error response.",
+ "schema": {
+ "$ref": "#/definitions/ResourceProviderDefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Organization_Get": {
+ "$ref": "./examples/Organization_Get.json"
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "Organization"
+ ],
+ "summary": "Create Organization resource",
+ "operationId": "Organization_Create",
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/ResourceGroupParameter"
+ },
+ {
+ "$ref": "#/parameters/OrganizationResourceNameParameter"
+ },
+ {
+ "in": "body",
+ "name": "body",
+ "description": "Organization resource model",
+ "schema": {
+ "$ref": "#/definitions/OrganizationResource"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "schema": {
+ "$ref": "#/definitions/OrganizationResource"
+ }
+ },
+ "201": {
+ "description": "Created",
+ "schema": {
+ "$ref": "#/definitions/OrganizationResource"
+ }
+ },
+ "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": {
+ "Organization_Create": {
+ "$ref": "./examples/Organization_Create.json"
+ }
+ }
+ },
+ "patch": {
+ "tags": [
+ "Organization"
+ ],
+ "summary": "Update Organization resource",
+ "operationId": "Organization_Update",
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/ResourceGroupParameter"
+ },
+ {
+ "$ref": "#/parameters/OrganizationResourceNameParameter"
+ },
+ {
+ "in": "body",
+ "name": "body",
+ "description": "Updated Organization resource",
+ "schema": {
+ "$ref": "#/definitions/OrganizationResourceUpdate"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "schema": {
+ "$ref": "#/definitions/OrganizationResource"
+ }
+ },
+ "default": {
+ "description": "Default error response.",
+ "schema": {
+ "$ref": "#/definitions/ResourceProviderDefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Confluent_Update": {
+ "$ref": "./examples/Organization_Update.json"
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "Organization"
+ ],
+ "summary": "Delete Organization resource",
+ "operationId": "Organization_Delete",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/ResourceGroupParameter"
+ },
+ {
+ "$ref": "#/parameters/OrganizationResourceNameParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success"
+ },
+ "202": {
+ "description": "Accepted"
+ },
+ "204": {
+ "description": "The specified confluent resource does not exist in the subscription."
+ },
+ "default": {
+ "description": "Default error response.",
+ "schema": {
+ "$ref": "#/definitions/ResourceProviderDefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-long-running-operation-options": {
+ "final-state-via": "location"
+ },
+ "x-ms-examples": {
+ "Confluent_Delete": {
+ "$ref": "./examples/Organization_Delete.json"
+ }
+ }
+ }
+ }
+ },
+ "definitions": {
+ "OperationDisplay": {
+ "description": "The object that represents the operation.",
+ "type": "object",
+ "properties": {
+ "provider": {
+ "description": "Service provider: Microsoft.Confluent",
+ "type": "string"
+ },
+ "resource": {
+ "description": "Type on which the operation is performed, e.g., 'clusters'.",
+ "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": "An Confluent 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"
+ }
+ }
+ },
+ "OperationListResult": {
+ "description": "Result of GET request to list Confluent operations.",
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "List of Confluent operations supported by the Microsoft.Confluent 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"
+ }
+ }
+ },
+ "ErrorResponseBody": {
+ "description": "Response body of Error",
+ "title": "ErrorResponseBody",
+ "type": "object",
+ "properties": {
+ "code": {
+ "description": "Error code",
+ "type": "string",
+ "readOnly": true
+ },
+ "message": {
+ "description": "Error message",
+ "type": "string",
+ "readOnly": true
+ },
+ "target": {
+ "description": "Error target",
+ "type": "string",
+ "readOnly": true
+ },
+ "details": {
+ "description": "Error detail",
+ "type": "array",
+ "readOnly": true,
+ "items": {
+ "$ref": "#/definitions/ErrorResponseBody"
+ }
+ }
+ }
+ },
+ "ResourceProviderDefaultErrorResponse": {
+ "type": "object",
+ "description": "Default error response for resource provider",
+ "title": "ResourceProviderDefaultErrorResponse",
+ "properties": {
+ "error": {
+ "description": "Response body of Error",
+ "readOnly": true,
+ "$ref": "#/definitions/ErrorResponseBody"
+ }
+ }
+ },
+ "ProvisioningState": {
+ "enum": [
+ "Accepted",
+ "Creating",
+ "Updating",
+ "Deleting",
+ "Succeeded",
+ "Failed",
+ "Canceled",
+ "Deleted",
+ "NotSpecified"
+ ],
+ "type": "string",
+ "description": "Provision states for confluent RP",
+ "title": "ProvisioningState",
+ "x-ms-enum": {
+ "name": "ProvisionState",
+ "modelAsString": true
+ }
+ },
+ "SaaSOfferStatus": {
+ "enum": [
+ "Started",
+ "PendingFulfillmentStart",
+ "InProgress",
+ "Subscribed",
+ "Suspended",
+ "Reinstated",
+ "Succeeded",
+ "Failed",
+ "Unsubscribed",
+ "Updating"
+ ],
+ "type": "string",
+ "description": "SaaS Offer Status for confluent RP",
+ "title": "SaaSOfferStatus",
+ "x-ms-enum": {
+ "modelAsString": true,
+ "name": "SaaSOfferStatus"
+ }
+ },
+ "OfferDetail": {
+ "description": "Confluent Offer detail",
+ "type": "object",
+ "properties": {
+ "publisherId": {
+ "description": "Publisher Id",
+ "maxLength": 50,
+ "type": "string"
+ },
+ "id": {
+ "description": "Offer Id",
+ "maxLength": 50,
+ "type": "string"
+ },
+ "planId": {
+ "description": "Offer Plan Id",
+ "maxLength": 50,
+ "type": "string"
+ },
+ "planName": {
+ "description": "Offer Plan Name",
+ "maxLength": 50,
+ "type": "string"
+ },
+ "termUnit": {
+ "description": "Offer Plan Term unit",
+ "maxLength": 25,
+ "type": "string"
+ },
+ "status": {
+ "description": "SaaS Offer Status",
+ "$ref": "#/definitions/SaaSOfferStatus"
+ }
+ }
+ },
+ "UserDetail": {
+ "description": "Subscriber detail",
+ "type": "object",
+ "properties": {
+ "firstName": {
+ "description": "First name",
+ "maxLength": 50,
+ "type": "string"
+ },
+ "lastName": {
+ "description": "Last name",
+ "maxLength": 50,
+ "type": "string"
+ },
+ "emailAddress": {
+ "description": "Email address",
+ "pattern": "^[\\w\\.\\-+!%\"\\s]+@[a-zA-Z_]+?\\.[a-zA-Z]{2,3}$",
+ "type": "string"
+ }
+ }
+ },
+ "OrganizationResourceProperties": {
+ "description": "Organization resource property",
+ "type": "object",
+ "properties": {
+ "createdTime": {
+ "format": "date-time",
+ "description": "The creation time of the resource.",
+ "type": "string",
+ "readOnly": true
+ },
+ "provisioningState": {
+ "description": "Provision states for confluent RP",
+ "$ref": "#/definitions/ProvisioningState"
+ },
+ "organizationId": {
+ "description": "Id of the Confluent organization.",
+ "type": "string",
+ "readOnly": true
+ },
+ "ssoUrl": {
+ "description": "SSO url for the Confluent organization.",
+ "type": "string",
+ "readOnly": true
+ },
+ "offerDetail": {
+ "description": "Confluent offer detail",
+ "allOf": [
+ {
+ "$ref": "#/definitions/OfferDetail"
+ }
+ ]
+ },
+ "userDetail": {
+ "description": "Subscriber detail",
+ "allOf": [
+ {
+ "$ref": "#/definitions/UserDetail"
+ }
+ ]
+ }
+ }
+ },
+ "OrganizationResource": {
+ "description": "Organization resource.",
+ "type": "object",
+ "x-ms-azure-resource": true,
+ "properties": {
+ "id": {
+ "description": "The ARM id of 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
+ },
+ "properties": {
+ "x-ms-client-flatten": true,
+ "description": "Organization resource properties",
+ "allOf": [
+ {
+ "$ref": "#/definitions/OrganizationResourceProperties"
+ }
+ ]
+ },
+ "tags": {
+ "type": "object",
+ "description": "Organization resource tags",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "location": {
+ "description": "Location of Organization resource",
+ "type": "string"
+ }
+ }
+ },
+ "OrganizationResourceListResult": {
+ "description": "The response of a list operation.",
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "Result of a list operation.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/OrganizationResource"
+ }
+ },
+ "nextLink": {
+ "description": "Link to the next set of results, if any.",
+ "type": "string"
+ }
+ }
+ },
+ "OrganizationResourceUpdate": {
+ "description": "Organization Resource update",
+ "type": "object",
+ "properties": {
+ "tags": {
+ "description": "ARM resource tags",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "parameters": {
+ "ApiVersionParameter": {
+ "name": "api-version",
+ "in": "query",
+ "description": "Client Api Version.",
+ "required": true,
+ "type": "string",
+ "enum": [
+ "2020-03-01-preview"
+ ]
+ },
+ "SubscriptionIdParameter": {
+ "in": "path",
+ "name": "subscriptionId",
+ "description": "Microsoft Azure subscription id",
+ "required": true,
+ "type": "string"
+ },
+ "ResourceGroupParameter": {
+ "in": "path",
+ "name": "resourceGroupName",
+ "description": "Resource group name",
+ "required": true,
+ "type": "string",
+ "x-ms-parameter-location": "method"
+ },
+ "OrganizationResourceNameParameter": {
+ "in": "path",
+ "name": "organizationName",
+ "description": "Organization resource name",
+ "required": true,
+ "type": "string",
+ "x-ms-parameter-location": "method"
+ }
+ }
+}
diff --git a/specification/confluent/resource-manager/Microsoft.Confluent/preview/2020-03-01-preview/examples/OrganizationOperations_List.json b/specification/confluent/resource-manager/Microsoft.Confluent/preview/2020-03-01-preview/examples/OrganizationOperations_List.json
new file mode 100644
index 000000000000..cf08589e54db
--- /dev/null
+++ b/specification/confluent/resource-manager/Microsoft.Confluent/preview/2020-03-01-preview/examples/OrganizationOperations_List.json
@@ -0,0 +1,41 @@
+{
+ "parameters": {
+ "api-version": "2020-03-01-preview"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "name": "Microsoft.Confluent/organizations/Read",
+ "display": {
+ "provider": "Microsoft.Confluent",
+ "resource": "organizations",
+ "operation": "Get/List organization resources",
+ "description": "Read organization"
+ }
+ },
+ {
+ "name": "Microsoft.Confluent/organizations/Write",
+ "display": {
+ "provider": "Microsoft.Confluent",
+ "resource": "organizations",
+ "operation": "Create/Update organization resources",
+ "description": "Write organization"
+ }
+ },
+ {
+ "name": "Microsoft.Confluent/organizations/Delete",
+ "display": {
+ "provider": "Microsoft.Confluent",
+ "resource": "organizations",
+ "operation": "Delete organization resources",
+ "description": "Delete organization"
+ }
+ }
+ ],
+ "nextLink": null
+ }
+ }
+ }
+}
diff --git a/specification/confluent/resource-manager/Microsoft.Confluent/preview/2020-03-01-preview/examples/Organization_Create.json b/specification/confluent/resource-manager/Microsoft.Confluent/preview/2020-03-01-preview/examples/Organization_Create.json
new file mode 100644
index 000000000000..43c399cb2428
--- /dev/null
+++ b/specification/confluent/resource-manager/Microsoft.Confluent/preview/2020-03-01-preview/examples/Organization_Create.json
@@ -0,0 +1,90 @@
+{
+ "parameters": {
+ "api-version": "2020-03-01-preview",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "myResourceGroup",
+ "organizationName": "myOrganization",
+ "body": {
+ "properties": {
+ "offerDetail": {
+ "publisherId": "string",
+ "id": "string",
+ "planId": "string",
+ "planName": "string",
+ "termUnit": "string"
+ },
+ "userDetail": {
+ "firstName": "string",
+ "lastName": "string",
+ "emailAddress": "contoso@microsoft.com"
+ }
+ },
+ "tags": {
+ "Environment": "Dev"
+ },
+ "location": "West US"
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Confluent/organizations/myOrganization",
+ "name": "myOrganization",
+ "type": "Microsoft.Confluent/organizations",
+ "properties": {
+ "createdTime": "2020-05-09T14:28:47.284Z",
+ "provisioningState": "Succeeded",
+ "organizationId": "string",
+ "ssoUrl": "string",
+ "offerDetail": {
+ "publisherId": "string",
+ "id": "string",
+ "planId": "string",
+ "planName": "string",
+ "termUnit": "string",
+ "status": "Started"
+ },
+ "userDetail": {
+ "firstName": "string",
+ "lastName": "string",
+ "emailAddress": "contoso@microsoft.com"
+ }
+ },
+ "tags": {
+ "Environment": "Dev"
+ },
+ "location": "West US"
+ }
+ },
+ "201": {
+ "body": {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Confluent/organizations/myOrganization",
+ "name": "myOrganization",
+ "type": "Microsoft.Confluent/organizations",
+ "properties": {
+ "createdTime": "2020-05-09T14:28:47.284Z",
+ "provisioningState": "Accepted",
+ "organizationId": "string",
+ "ssoUrl": "string",
+ "offerDetail": {
+ "publisherId": "string",
+ "id": "string",
+ "planId": "string",
+ "planName": "string",
+ "termUnit": "string",
+ "status": "Started"
+ },
+ "userDetail": {
+ "firstName": "string",
+ "lastName": "string",
+ "emailAddress": "contoso@microsoft.com"
+ }
+ },
+ "tags": {
+ "Environment": "Dev"
+ },
+ "location": "West US"
+ }
+ }
+ }
+}
diff --git a/specification/confluent/resource-manager/Microsoft.Confluent/preview/2020-03-01-preview/examples/Organization_Delete.json b/specification/confluent/resource-manager/Microsoft.Confluent/preview/2020-03-01-preview/examples/Organization_Delete.json
new file mode 100644
index 000000000000..9621d3e6929b
--- /dev/null
+++ b/specification/confluent/resource-manager/Microsoft.Confluent/preview/2020-03-01-preview/examples/Organization_Delete.json
@@ -0,0 +1,13 @@
+{
+ "parameters": {
+ "api-version": "2020-03-01-preview",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "myResourceGroup",
+ "organizationName": "myOrganization"
+ },
+ "responses": {
+ "200": {},
+ "202": {},
+ "204": {}
+ }
+}
diff --git a/specification/confluent/resource-manager/Microsoft.Confluent/preview/2020-03-01-preview/examples/Organization_Get.json b/specification/confluent/resource-manager/Microsoft.Confluent/preview/2020-03-01-preview/examples/Organization_Get.json
new file mode 100644
index 000000000000..881c6de0d126
--- /dev/null
+++ b/specification/confluent/resource-manager/Microsoft.Confluent/preview/2020-03-01-preview/examples/Organization_Get.json
@@ -0,0 +1,40 @@
+{
+ "parameters": {
+ "api-version": "2020-03-01-preview",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "myResourceGroup",
+ "organizationName": "myOrganization"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Confluent/organizations/myOrganization",
+ "name": "myOrganization",
+ "type": "Microsoft.Confluent/organizations",
+ "properties": {
+ "createdTime": "2020-05-09T14:28:47.284Z",
+ "provisioningState": "Accepted",
+ "organizationId": "string",
+ "ssoUrl": "string",
+ "offerDetail": {
+ "publisherId": "string",
+ "id": "string",
+ "planId": "string",
+ "planName": "string",
+ "termUnit": "string",
+ "status": "Started"
+ },
+ "userDetail": {
+ "firstName": "string",
+ "lastName": "string",
+ "emailAddress": "contoso@microsoft.com"
+ }
+ },
+ "tags": {
+ "Environment": "Dev"
+ },
+ "location": "West US"
+ }
+ }
+ }
+}
diff --git a/specification/confluent/resource-manager/Microsoft.Confluent/preview/2020-03-01-preview/examples/Organization_ListByResourceGroup.json b/specification/confluent/resource-manager/Microsoft.Confluent/preview/2020-03-01-preview/examples/Organization_ListByResourceGroup.json
new file mode 100644
index 000000000000..8f8df808e8af
--- /dev/null
+++ b/specification/confluent/resource-manager/Microsoft.Confluent/preview/2020-03-01-preview/examples/Organization_ListByResourceGroup.json
@@ -0,0 +1,44 @@
+{
+ "parameters": {
+ "api-version": "2020-03-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.Confluent/organizations/myOrganizations",
+ "name": "myOrganizations",
+ "type": "Microsoft.Confluent/organizations",
+ "properties": {
+ "createdTime": "2020-05-09T14:28:47.284Z",
+ "provisioningState": "Accepted",
+ "organizationId": "string",
+ "ssoUrl": "string",
+ "offerDetail": {
+ "publisherId": "string",
+ "id": "string",
+ "planId": "string",
+ "planName": "string",
+ "termUnit": "string",
+ "status": "Started"
+ },
+ "userDetail": {
+ "firstName": "string",
+ "lastName": "string",
+ "emailAddress": "contoso@microsoft.com"
+ }
+ },
+ "tags": {
+ "Environment": "Dev"
+ },
+ "location": "West US"
+ }
+ ],
+ "nextLink": "string"
+ }
+ }
+ }
+}
diff --git a/specification/confluent/resource-manager/Microsoft.Confluent/preview/2020-03-01-preview/examples/Organization_ListBySubscription.json b/specification/confluent/resource-manager/Microsoft.Confluent/preview/2020-03-01-preview/examples/Organization_ListBySubscription.json
new file mode 100644
index 000000000000..77d8875f22c1
--- /dev/null
+++ b/specification/confluent/resource-manager/Microsoft.Confluent/preview/2020-03-01-preview/examples/Organization_ListBySubscription.json
@@ -0,0 +1,43 @@
+{
+ "parameters": {
+ "api-version": "2020-03-01-preview",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Confluent/organizations/myOrganizations",
+ "name": "myOrganizations",
+ "type": "Microsoft.Confluent/organizations",
+ "properties": {
+ "createdTime": "2020-05-09T14:28:47.284Z",
+ "provisioningState": "Accepted",
+ "organizationId": "string",
+ "ssoUrl": "string",
+ "offerDetail": {
+ "publisherId": "string",
+ "id": "string",
+ "planId": "string",
+ "planName": "string",
+ "termUnit": "string",
+ "status": "Started"
+ },
+ "userDetail": {
+ "firstName": "string",
+ "lastName": "string",
+ "emailAddress": "contoso@microsoft.com"
+ }
+ },
+ "tags": {
+ "Environment": "Dev"
+ },
+ "location": "West US"
+ }
+ ],
+ "nextLink": "string"
+ }
+ }
+ }
+}
diff --git a/specification/confluent/resource-manager/Microsoft.Confluent/preview/2020-03-01-preview/examples/Organization_Update.json b/specification/confluent/resource-manager/Microsoft.Confluent/preview/2020-03-01-preview/examples/Organization_Update.json
new file mode 100644
index 000000000000..ced813639343
--- /dev/null
+++ b/specification/confluent/resource-manager/Microsoft.Confluent/preview/2020-03-01-preview/examples/Organization_Update.json
@@ -0,0 +1,46 @@
+{
+ "parameters": {
+ "api-version": "2020-03-01-preview",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "myResourceGroup",
+ "organizationName": "myOrganization",
+ "body": {
+ "tags": {
+ "env": "dev",
+ "client": "dev-client"
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Confluent/organizations/myOrganization",
+ "name": "myOrganization",
+ "type": "Microsoft.Confluent/organizations",
+ "properties": {
+ "createdTime": "2020-05-09T14:28:47.284Z",
+ "provisioningState": "Succeeded",
+ "organizationId": "string",
+ "ssoUrl": "string",
+ "offerDetail": {
+ "publisherId": "string",
+ "id": "string",
+ "planId": "string",
+ "planName": "string",
+ "termUnit": "string",
+ "status": "Started"
+ },
+ "userDetail": {
+ "firstName": "string",
+ "lastName": "string",
+ "emailAddress": "contoso@microsoft.com"
+ }
+ },
+ "tags": {
+ "Environment": "Dev"
+ },
+ "location": "West US"
+ }
+ }
+ }
+}
diff --git a/specification/confluent/resource-manager/readme.azureresourceschema.md b/specification/confluent/resource-manager/readme.azureresourceschema.md
new file mode 100644
index 000000000000..4fd32b215793
--- /dev/null
+++ b/specification/confluent/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-confluent-2020-03-01-preview
+
+```
+
+Please also specify `--azureresourceschema-folder=`.
+
+### Tag: schema-confluent-2020-03-01-preview and azureresourceschema
+
+``` yaml $(tag) == 'schema-confluent-2020-03-01-preview' && $(azureresourceschema)
+output-folder: $(azureresourceschema-folder)/schemas
+
+# all the input files in this apiVersion
+input-file:
+ - Microsoft.Confluent/preview/2020-03-01-preview/confluent.json
+
+```
diff --git a/specification/confluent/resource-manager/readme.csharp.md b/specification/confluent/resource-manager/readme.csharp.md
new file mode 100644
index 000000000000..6ce99f227179
--- /dev/null
+++ b/specification/confluent/resource-manager/readme.csharp.md
@@ -0,0 +1,14 @@
+## 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.Confluent
+ payload-flattening-threshold: 1
+ output-folder: $(csharp-sdks-folder)/confluent/Microsoft.Azure.Management.Confluent/src/Generated
+ clear-output-folder: true
+```
\ No newline at end of file
diff --git a/specification/confluent/resource-manager/readme.go.md b/specification/confluent/resource-manager/readme.go.md
new file mode 100644
index 000000000000..b77f72b8db96
--- /dev/null
+++ b/specification/confluent/resource-manager/readme.go.md
@@ -0,0 +1,19 @@
+## Go
+
+These settings apply only when `--go` is specified on the command line.
+
+``` yaml $(go)
+go:
+ license-header: MICROSOFT_APACHE_NO_VERSION
+ namespace: confluent
+ clear-output-folder: true
+```
+
+### Tag: package-2020-03-01-preview and go
+
+These settings apply only when `--tag=package-2020-03-01-preview --go` is specified on the command line.
+Please also specify `--go-sdk-folder=`.
+
+``` yaml $(tag) == 'package-2020-03-01-preview' && $(go)
+output-folder: $(go-sdk-folder)/services/preview/$(namespace)/mgmt/2020-03-01-preview/$(namespace)
+```
\ No newline at end of file
diff --git a/specification/confluent/resource-manager/readme.java.md b/specification/confluent/resource-manager/readme.java.md
new file mode 100644
index 000000000000..77fc8ec919e6
--- /dev/null
+++ b/specification/confluent/resource-manager/readme.java.md
@@ -0,0 +1,33 @@
+## 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.confluent
+license-header: MICROSOFT_MIT_NO_CODEGEN
+payload-flattening-threshold: 1
+output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-confluent
+```
+
+### Java multi-api
+
+``` yaml $(java) && $(multiapi)
+batch:
+ - tag: package-2020-03-01-preview
+```
+
+### Tag: package-2020-03-01-preview and java
+
+These settings apply only when `--tag=package-2020-03-01-preview --java` is specified on the command line.
+Please also specify `--azure-libraries-for-java=`.
+
+``` yaml $(tag) == 'package-2020-03-01-preview' && $(java) && $(multiapi)
+java:
+ namespace: com.microsoft.azure.management.confluent.v2020_03_01_preview
+ output-folder: $(azure-libraries-for-java-folder)/sdk/confluent/mgmt-v2020_03_01_preview
+regenerate-manager: true
+generate-interface: true
+```
\ No newline at end of file
diff --git a/specification/confluent/resource-manager/readme.md b/specification/confluent/resource-manager/readme.md
new file mode 100644
index 000000000000..42587e59dd49
--- /dev/null
+++ b/specification/confluent/resource-manager/readme.md
@@ -0,0 +1,121 @@
+# Confluent
+
+> see https://aka.ms/autorest
+
+This is the AutoRest configuration file for Confluent.
+
+
+
+---
+## Getting Started
+To build the SDK for Confluent, 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 Confluent API.
+
+``` yaml
+title: ConfluentManagementClient
+openapi-type: arm
+openapi-subtype: rpaas
+tag: package-2020-03-01-preview
+```
+
+### Tag: package-2020-03-01-preview
+
+These settings apply only when `--tag=package-2020-03-01-preview` is specified on the command line.
+
+``` yaml $(tag) == 'package-2020-03-01-preview'
+input-file:
+- Microsoft.Confluent/preview/2020-03-01-preview/confluent.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-sdk-for-ruby
+ after_scripts:
+ - bundle install && rake arm:regen_all_profiles['azure_mgmt_confluent']
+ - repo: azure-cli-extensions
+ - repo: azure-resource-manager-schemas
+ after_scripts:
+ - node sdkauto_afterscript.js confluent/resource-manager
+```
+
+## C#
+
+See configuration in [readme.csharp.md](./readme.csharp.md)
+
+## Go
+
+See configuration in [readme.go.md](./readme.go.md)
+
+## Java
+
+See configuration in [readme.java.md](./readme.java.md)
+
+## Node.js
+
+See configuration in [readme.nodejs.md](./readme.nodejs.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)
+
+## AzureResourceSchema
+
+See configuration in [readme.azureresourceschema.md](./readme.azureresourceschema.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.Confluent/preview/2020-03-01-preview/confluent.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
+```
\ No newline at end of file
diff --git a/specification/confluent/resource-manager/readme.nodejs.md b/specification/confluent/resource-manager/readme.nodejs.md
new file mode 100644
index 000000000000..340d54169ee4
--- /dev/null
+++ b/specification/confluent/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-confluent
+ output-folder: $(node-sdks-folder)/lib/services/confluentManagement
+ generate-license-txt: true
+ generate-package-json: true
+ generate-readme-md: true
+```
diff --git a/specification/confluent/resource-manager/readme.python.md b/specification/confluent/resource-manager/readme.python.md
new file mode 100644
index 000000000000..f419f0b48043
--- /dev/null
+++ b/specification/confluent/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)
+python-mode: create
+python:
+ azure-arm: true
+ license-header: MICROSOFT_MIT_NO_VERSION
+ payload-flattening-threshold: 2
+ namespace: azure.mgmt.confluent
+ package-name: azure-mgmt-confluent
+ package-version: 2020-03-01-preview
+ clear-output-folder: true
+```
+``` yaml $(python) && $(python-mode) == 'update'
+python:
+ no-namespace-folders: true
+ output-folder: $(python-sdks-folder)/azure-mgmt-confluent/azure/mgmt/confluent
+```
+``` yaml $(python) && $(python-mode) == 'create'
+python:
+ basic-setup-py: true
+ output-folder: $(python-sdks-folder)/azure-mgmt-confluent
+```
\ No newline at end of file
diff --git a/specification/confluent/resource-manager/readme.ruby.md b/specification/confluent/resource-manager/readme.ruby.md
new file mode 100644
index 000000000000..44c50b6d016c
--- /dev/null
+++ b/specification/confluent/resource-manager/readme.ruby.md
@@ -0,0 +1,26 @@
+## Ruby
+
+These settings apply only when `--ruby` is specified on the command line.
+
+``` yaml
+package-name: azure_mgmt_confluent
+package-version: 2020-03-01-preview
+azure-arm: true
+```
+
+### Ruby multi-api
+
+``` yaml $(ruby) && $(multiapi)
+batch:
+ - tag: package-2020-03-01-preview
+```
+
+### Tag: package-2020-03-01-preview and ruby
+
+These settings apply only when `--tag=package-2020-03-01-preview --ruby` is specified on the command line.
+Please also specify `--ruby-sdks-folder=`.
+
+```yaml $(tag) == 'package-2020-03-01-preview' && $(ruby)
+namespace: Microsoft.Confluent
+output-folder: $(ruby-sdks-folder)/confluent
+```
\ No newline at end of file
diff --git a/specification/confluent/resource-manager/readme.typescript.md b/specification/confluent/resource-manager/readme.typescript.md
new file mode 100644
index 000000000000..408cc2d9b895
--- /dev/null
+++ b/specification/confluent/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-confluent"
+ output-folder: "$(typescript-sdks-folder)/sdk/confluent/arm-confluent"
+ clear-output-folder: true
+ generate-metadata: true
+```
\ No newline at end of file
diff --git a/specification/consumption/resource-manager/readme.go.md b/specification/consumption/resource-manager/readme.go.md
index 2cd5284033ad..a0de97215d8d 100644
--- a/specification/consumption/resource-manager/readme.go.md
+++ b/specification/consumption/resource-manager/readme.go.md
@@ -22,8 +22,17 @@ batch:
- tag: package-2018-08
- tag: package-2018-10
- tag: package-2019-01
+ - tag: package-2019-10
```
+### Tag: package-2019-10 and go
+
+These settings apply only when `--tag=package-2019-10 --go` is specified on the command line.
+Please also specify `--go-sdk-folder=`.
+
+``` yaml $(tag) == 'package-2019-10' && $(go)
+output-folder: $(go-sdk-folder)/services/$(namespace)/mgmt/2019-10-01/$(namespace)
+```
### Tag: package-2017-04-preview and go
diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-07-01/managedClusters.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-07-01/managedClusters.json
index 14b7db1b5c8d..5a07097c6d67 100644
--- a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-07-01/managedClusters.json
+++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-07-01/managedClusters.json
@@ -1232,7 +1232,7 @@
"tags": [
"AgentPools"
],
- "operationId": "ManagedClusters_UpgradeNodeImageVersion",
+ "operationId": "AgentPools_UpgradeNodeImageVersion",
"summary": "Upgrade node image version of an agent pool to the latest.",
"description": "Upgrade node image version of an agent pool to the latest.",
"parameters": [
diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-09-01/managedClusters.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-09-01/managedClusters.json
index 3ef7b8c1035b..be924c99384f 100644
--- a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-09-01/managedClusters.json
+++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-09-01/managedClusters.json
@@ -1323,7 +1323,7 @@
"tags": [
"AgentPools"
],
- "operationId": "ManagedClusters_UpgradeNodeImageVersion",
+ "operationId": "AgentPools_UpgradeNodeImageVersion",
"summary": "Upgrade node image version of an agent pool to the latest.",
"description": "Upgrade node image version of an agent pool to the latest.",
"parameters": [
diff --git a/specification/containerservice/resource-manager/readme.go.md b/specification/containerservice/resource-manager/readme.go.md
index 4ce9ad0f6647..a237557ee2bd 100644
--- a/specification/containerservice/resource-manager/readme.go.md
+++ b/specification/containerservice/resource-manager/readme.go.md
@@ -171,7 +171,7 @@ Please also specify `--go-sdk-folder=`.
``` yaml $(tag) == 'package-2020-04' && $(go)
-output-folder: $(go-sdk-folder)/services/cosmos-db/mgmt/2020-04-01/$(namespace)
+output-folder: $(go-sdk-folder)/services/preview/cosmos-db/mgmt/2020-04-01-preview/$(namespace)
```
### Tag: package-2020-03 and go
@@ -45,7 +45,7 @@ These settings apply only when `--tag=package-2020-03 --go` is specified on the
Please also specify `--go-sdk-folder=`.
``` yaml $(tag) == 'package-2020-03' && $(go)
-output-folder: $(go-sdk-folder)/services/cosmos-db/mgmt/2020-03-01/$(namespace)
+output-folder: $(go-sdk-folder)/services/preview/cosmos-db/mgmt/2020-03-01-preview/$(namespace)
```
### Tag: package-2019-12 and go
@@ -54,7 +54,7 @@ These settings apply only when `--tag=package-2019-12 --go` is specified on the
Please also specify `--go-sdk-folder=`.
``` yaml $(tag) == 'package-2019-12' && $(go)
-output-folder: $(go-sdk-folder)/services/cosmos-db/mgmt/2019-12-12/$(namespace)
+output-folder: $(go-sdk-folder)/services/preview/cosmos-db/mgmt/2019-12-12-preview/$(namespace)
```
### Tag: package-2019-08 and go
diff --git a/specification/cosmos-db/resource-manager/readme.md b/specification/cosmos-db/resource-manager/readme.md
index 7adb905df487..80054f71a6e8 100644
--- a/specification/cosmos-db/resource-manager/readme.md
+++ b/specification/cosmos-db/resource-manager/readme.md
@@ -38,6 +38,7 @@ These settings apply only when `--tag=package-2020-06-preview` is specified on t
input-file:
- Microsoft.DocumentDB/preview/2020-06-01-preview/cosmos-db.json
- Microsoft.DocumentDB/preview/2020-06-01-preview/notebook.json
+- Microsoft.DocumentDB/preview/2020-06-01-preview/rbac.json
- Microsoft.DocumentDB/preview/2019-08-01-preview/privateLinkResources.json
- Microsoft.DocumentDB/preview/2019-08-01-preview/privateEndpointConnection.json
```
@@ -220,6 +221,9 @@ directive:
- suppress: PathResourceProviderNamePascalCase
from: privateLinkResources.json
reason: The name of the provider is Microsoft.DocumentDB
+ - suppress: PathResourceProviderNamePascalCase
+ from: rbac.json
+ reason: The name of the provider is Microsoft.DocumentDB
```
---
@@ -273,3 +277,43 @@ See configuration in [readme.java.md](./readme.java.md)
See configuration in [readme.azureresourceschema.md](./readme.azureresourceschema.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.DocumentDB/preview/2020-06-01-preview/cosmos-db.json
+ - $(this-folder)/Microsoft.DocumentDB/preview/2020-06-01-preview/notebook.json
+ - $(this-folder)/Microsoft.DocumentDB/preview/2020-06-01-preview/rbac.json
+ - $(this-folder)/Microsoft.DocumentDB/preview/2019-08-01-preview/privateLinkResources.json
+ - $(this-folder)/Microsoft.DocumentDB/preview/2019-08-01-preview/privateEndpointConnection.json
+ - $(this-folder)/Microsoft.DocumentDB/stable/2020-04-01/cosmos-db.json
+ - $(this-folder)/Microsoft.DocumentDB/stable/2020-04-01/notebook.json
+ - $(this-folder)/Microsoft.DocumentDB/stable/2020-03-01/cosmos-db.json
+ - $(this-folder)/Microsoft.DocumentDB/stable/2020-03-01/notebook.json
+ - $(this-folder)/Microsoft.DocumentDB/stable/2019-12-12/cosmos-db.json
+ - $(this-folder)/Microsoft.DocumentDB/stable/2019-12-12/notebook.json
+ - $(this-folder)/Microsoft.DocumentDB/stable/2019-08-01/cosmos-db.json
+ - $(this-folder)/Microsoft.DocumentDB/stable/2019-08-01/notebook.json
+ - $(this-folder)/Microsoft.DocumentDB/stable/2015-04-08/cosmos-db.json
+ - $(this-folder)/Microsoft.DocumentDB/stable/2014-04-01/cosmos-db.json
+ - $(this-folder)/Microsoft.DocumentDB/stable/2015-11-06/cosmos-db.json
+ - $(this-folder)/Microsoft.DocumentDB/stable/2016-03-19/cosmos-db.json
+ - $(this-folder)/Microsoft.DocumentDB/stable/2016-03-31/cosmos-db.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/datadog/resource-manager/Microsoft.Datadog/preview/2020-02-01-preview/datadog.json b/specification/datadog/resource-manager/Microsoft.Datadog/preview/2020-02-01-preview/datadog.json
new file mode 100644
index 000000000000..08c44ae921da
--- /dev/null
+++ b/specification/datadog/resource-manager/Microsoft.Datadog/preview/2020-02-01-preview/datadog.json
@@ -0,0 +1,1795 @@
+{
+ "swagger": "2.0",
+ "info": {
+ "title": "Microsoft.Datadog",
+ "version": "2020-02-01-preview"
+ },
+ "host": "management.azure.com",
+ "schemes": [
+ "https"
+ ],
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "securityDefinitions": {
+ "azure_auth": {
+ "type": "oauth2",
+ "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize",
+ "flow": "implicit",
+ "description": "Azure Active Directory OAuth2 Flow",
+ "scopes": {
+ "user_impersonation": "impersonate your user account"
+ }
+ }
+ },
+ "paths": {
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Datadog/monitors/{monitorName}/listApiKeys": {
+ "post": {
+ "tags": [
+ "ApiKey"
+ ],
+ "summary": "List the api keys for a given monitor resource.",
+ "operationId": "ApiKeys_List",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/MonitorNameParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "schema": {
+ "$ref": "#/definitions/DatadogApiKeyListResponse"
+ }
+ },
+ "default": {
+ "description": "Default error response.",
+ "schema": {
+ "$ref": "#/definitions/ResourceProviderDefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-examples": {
+ "ApiKeys_List": {
+ "$ref": "./examples/ApiKeys_List.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Datadog/monitors/{monitorName}/getDefaultKey": {
+ "post": {
+ "tags": [
+ "ApiKey"
+ ],
+ "summary": "Get the default api key.",
+ "operationId": "ApiKeys_GetDefaultKey",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/MonitorNameParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "schema": {
+ "$ref": "#/definitions/DatadogApiKey"
+ }
+ },
+ "default": {
+ "description": "Default error response.",
+ "schema": {
+ "$ref": "#/definitions/ResourceProviderDefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "ApiKeys_GetDefaultKey": {
+ "$ref": "./examples/ApiKeys_GetDefaultKey.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Datadog/monitors/{monitorName}/setDefaultKey": {
+ "post": {
+ "tags": [
+ "ApiKey"
+ ],
+ "summary": "Set the default api key.",
+ "operationId": "ApiKeys_SetDefaultKey",
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/MonitorNameParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "in": "body",
+ "name": "body",
+ "schema": {
+ "$ref": "#/definitions/DatadogApiKey"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success"
+ },
+ "default": {
+ "description": "Default error response.",
+ "schema": {
+ "$ref": "#/definitions/ResourceProviderDefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "ApiKeys_SetDefaultKey": {
+ "$ref": "./examples/ApiKeys_SetDefaultKey.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Datadog/monitors/{monitorName}/listHosts": {
+ "post": {
+ "tags": [
+ "Hosts"
+ ],
+ "summary": "List the hosts for a given monitor resource.",
+ "operationId": "Hosts_List",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/MonitorNameParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "schema": {
+ "$ref": "#/definitions/DatadogHostListResponse"
+ }
+ },
+ "default": {
+ "description": "Default error response.",
+ "schema": {
+ "$ref": "#/definitions/ResourceProviderDefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-examples": {
+ "Hosts_List": {
+ "$ref": "./examples/Hosts_List.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Datadog/monitors/{monitorName}/listLinkedResources": {
+ "post": {
+ "tags": [
+ "LinkedResources"
+ ],
+ "summary": "List all Azure resources associated to the same Datadog organization as the target resource.",
+ "operationId": "LinkedResources_List",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/MonitorNameParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "schema": {
+ "$ref": "#/definitions/LinkedResourceListResponse"
+ }
+ },
+ "default": {
+ "description": "Default error response.",
+ "schema": {
+ "$ref": "#/definitions/ResourceProviderDefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-examples": {
+ "LinkedResources_List": {
+ "$ref": "./examples/LinkedResources_List.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Datadog/monitors/{monitorName}/listMonitoredResources": {
+ "post": {
+ "tags": [
+ "MonitoredResources"
+ ],
+ "summary": "List the resources currently being monitored by the Datadog monitor resource.",
+ "operationId": "MonitoredResources_List",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/MonitorNameParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter"
+ }
+ ],
+ "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"
+ }
+ }
+ }
+ },
+ "/providers/Microsoft.Datadog/operations": {
+ "get": {
+ "tags": [
+ "MonitorsResource"
+ ],
+ "summary": "List all operations provided by Microsoft.Datadog for the 2020-02-01-preview api version.",
+ "operationId": "Operations_List",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "schema": {
+ "$ref": "#/definitions/OperationListResult"
+ }
+ },
+ "default": {
+ "description": "Default error response.",
+ "schema": {
+ "$ref": "#/definitions/ResourceProviderDefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-examples": {
+ "Operations_List": {
+ "$ref": "./examples/Operations_List.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/providers/Microsoft.Datadog/monitors": {
+ "get": {
+ "tags": [
+ "MonitorsResource"
+ ],
+ "summary": "List all monitors under the specified subscription.",
+ "operationId": "Monitors_List",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "schema": {
+ "$ref": "#/definitions/DatadogMonitorResourceListResponse"
+ }
+ },
+ "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.Datadog/monitors": {
+ "get": {
+ "tags": [
+ "MonitorsResource"
+ ],
+ "summary": "List all monitors under the specified resource group.",
+ "operationId": "Monitors_ListByResourceGroup",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "schema": {
+ "$ref": "#/definitions/DatadogMonitorResourceListResponse"
+ }
+ },
+ "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.Datadog/monitors/{monitorName}": {
+ "get": {
+ "tags": [
+ "MonitorsResource"
+ ],
+ "summary": "Get the properties of a specific monitor resource.",
+ "operationId": "Monitors_Get",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/MonitorNameParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "schema": {
+ "$ref": "#/definitions/DatadogMonitorResource"
+ }
+ },
+ "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/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/MonitorNameParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "in": "body",
+ "name": "body",
+ "schema": {
+ "$ref": "#/definitions/DatadogMonitorResource"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "schema": {
+ "$ref": "#/definitions/DatadogMonitorResource"
+ }
+ },
+ "201": {
+ "description": "Success",
+ "schema": {
+ "$ref": "#/definitions/DatadogMonitorResource"
+ }
+ },
+ "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/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/MonitorNameParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "in": "body",
+ "name": "body",
+ "schema": {
+ "$ref": "#/definitions/DatadogMonitorResourceUpdateParameters"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "schema": {
+ "$ref": "#/definitions/DatadogMonitorResource"
+ }
+ },
+ "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/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/MonitorNameParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter"
+ }
+ ],
+ "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.Datadog/monitors/{monitorName}/refreshSetPasswordLink": {
+ "post": {
+ "tags": [
+ "RefreshSetPasswordLink"
+ ],
+ "summary": "Refresh the set password link and return a latest one.",
+ "operationId": "RefreshSetPassword_Get",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/MonitorNameParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "schema": {
+ "$ref": "#/definitions/DatadogSetPasswordLink"
+ }
+ },
+ "default": {
+ "description": "Default error response.",
+ "schema": {
+ "$ref": "#/definitions/ResourceProviderDefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "RefreshSetPassword_Get": {
+ "$ref": "./examples/RefreshSetPassword_Get.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Datadog/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/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/MonitorNameParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter"
+ }
+ ],
+ "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.Datadog/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/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/MonitorNameParameter"
+ },
+ {
+ "in": "path",
+ "name": "ruleSetName",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "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/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/MonitorNameParameter"
+ },
+ {
+ "in": "path",
+ "name": "ruleSetName",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter"
+ }
+ ],
+ "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"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Datadog/monitors/{monitorName}/singleSignOnConfigurations": {
+ "get": {
+ "tags": [
+ "SingleSignOn"
+ ],
+ "summary": "List the single sign-on configurations for a given monitor resource.",
+ "operationId": "SingleSignOnConfigurations_List",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/MonitorNameParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "schema": {
+ "$ref": "#/definitions/DatadogSingleSignOnResourceListResponse"
+ }
+ },
+ "default": {
+ "description": "Default error response.",
+ "schema": {
+ "$ref": "#/definitions/ResourceProviderDefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-examples": {
+ "SingleSignOnConfigurations_List": {
+ "$ref": "./examples/SingleSignOnConfigurations_List.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Datadog/monitors/{monitorName}/singleSignOnConfigurations/{configurationName}": {
+ "put": {
+ "tags": [
+ "SingleSignOn"
+ ],
+ "summary": "Configures single-sign-on for this resource.",
+ "operationId": "SingleSignOnConfigurations_CreateOrUpdate",
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/MonitorNameParameter"
+ },
+ {
+ "in": "path",
+ "name": "configurationName",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "in": "body",
+ "name": "body",
+ "schema": {
+ "$ref": "#/definitions/DatadogSingleSignOnResource"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "schema": {
+ "$ref": "#/definitions/DatadogSingleSignOnResource"
+ }
+ },
+ "201": {
+ "description": "Success",
+ "schema": {
+ "$ref": "#/definitions/DatadogSingleSignOnResource"
+ }
+ },
+ "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": {
+ "SingleSignOnConfigurations_CreateOrUpdate": {
+ "$ref": "./examples/SingleSignOnConfigurations_CreateOrUpdate.json"
+ }
+ }
+ },
+ "get": {
+ "tags": [
+ "SingleSignOn"
+ ],
+ "summary": "Gets the datadog single sign-on resource for the given Monitor.",
+ "operationId": "SingleSignOnConfigurations_Get",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/MonitorNameParameter"
+ },
+ {
+ "in": "path",
+ "name": "configurationName",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "schema": {
+ "$ref": "#/definitions/DatadogSingleSignOnResource"
+ }
+ },
+ "default": {
+ "description": "Default error response.",
+ "schema": {
+ "$ref": "#/definitions/ResourceProviderDefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "SingleSignOnConfigurations_Get": {
+ "$ref": "./examples/SingleSignOnConfigurations_Get.json"
+ }
+ }
+ }
+ }
+ },
+ "definitions": {
+ "DatadogApiKey": {
+ "required": [
+ "key"
+ ],
+ "type": "object",
+ "properties": {
+ "createdBy": {
+ "description": "The user that created the API key.",
+ "type": "string"
+ },
+ "name": {
+ "description": "The name of the API key.",
+ "type": "string"
+ },
+ "key": {
+ "description": "The value of the API key.",
+ "type": "string"
+ },
+ "created": {
+ "description": "The time of creation of the API key.",
+ "type": "string"
+ }
+ }
+ },
+ "DatadogApiKeyListResponse": {
+ "description": "Response of a list operation.",
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "Results of a list operation.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/DatadogApiKey"
+ }
+ },
+ "nextLink": {
+ "description": "Link to the next set of results, if any.",
+ "type": "string"
+ }
+ }
+ },
+ "ErrorResponseBody": {
+ "type": "object",
+ "properties": {
+ "code": {
+ "type": "string"
+ },
+ "message": {
+ "type": "string"
+ },
+ "target": {
+ "type": "string"
+ },
+ "details": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ErrorResponseBody"
+ }
+ }
+ }
+ },
+ "ResourceProviderDefaultErrorResponse": {
+ "type": "object",
+ "properties": {
+ "error": {
+ "$ref": "#/definitions/ErrorResponseBody"
+ }
+ }
+ },
+ "DatadogInstallMethod": {
+ "type": "object",
+ "properties": {
+ "tool": {
+ "description": "The tool.",
+ "type": "string"
+ },
+ "toolVersion": {
+ "description": "The tool version.",
+ "type": "string"
+ },
+ "installerVersion": {
+ "description": "The installer version.",
+ "type": "string"
+ }
+ }
+ },
+ "DatadogLogsAgent": {
+ "type": "object",
+ "properties": {
+ "transport": {
+ "description": "The transport.",
+ "type": "string"
+ }
+ }
+ },
+ "DatadogHostMetadata": {
+ "type": "object",
+ "properties": {
+ "agentVersion": {
+ "description": "The agent version.",
+ "type": "string"
+ },
+ "installMethod": {
+ "$ref": "#/definitions/DatadogInstallMethod"
+ },
+ "logsAgent": {
+ "$ref": "#/definitions/DatadogLogsAgent"
+ }
+ }
+ },
+ "DatadogHost": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "The name of the host.",
+ "type": "string"
+ },
+ "aliases": {
+ "description": "The aliases for the host.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "apps": {
+ "description": "The Datadog integrations reporting metrics for the host.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "meta": {
+ "$ref": "#/definitions/DatadogHostMetadata"
+ }
+ }
+ },
+ "DatadogHostListResponse": {
+ "description": "Response of a list operation.",
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "Results of a list operation.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/DatadogHost"
+ }
+ },
+ "nextLink": {
+ "description": "Link to the next set of results, if any.",
+ "type": "string"
+ }
+ }
+ },
+ "LinkedResource": {
+ "description": "The definition of a linked resource.",
+ "type": "object",
+ "properties": {
+ "id": {
+ "description": "The ARM id of the linked resource.",
+ "type": "string"
+ }
+ }
+ },
+ "LinkedResourceListResponse": {
+ "description": "Response of a list operation.",
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "Results of a list operation.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/LinkedResource"
+ }
+ },
+ "nextLink": {
+ "description": "Link to the next set of results, if any.",
+ "type": "string"
+ }
+ }
+ },
+ "MonitoredResource": {
+ "description": "The properties of a resource currently being monitored by the Datadog monitor resource.",
+ "type": "object",
+ "properties": {
+ "id": {
+ "description": "The ARM id of the resource.",
+ "type": "string"
+ },
+ "sendingMetrics": {
+ "description": "Flag indicating if resource is sending metrics to Datadog.",
+ "type": "boolean"
+ },
+ "reasonForMetricsStatus": {
+ "description": "Reason for why the resource is sending metrics (or why it is not sending).",
+ "type": "string"
+ },
+ "sendingLogs": {
+ "description": "Flag indicating if resource is sending logs to Datadog.",
+ "type": "boolean"
+ },
+ "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"
+ }
+ }
+ },
+ "OperationDisplay": {
+ "description": "The object that represents the operation.",
+ "type": "object",
+ "properties": {
+ "provider": {
+ "description": "Service provider, i.e., Microsoft.Datadog.",
+ "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.Datadog REST API operation.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "Operation name, i.e., {provider}/{resource}/{operation}.",
+ "type": "string"
+ },
+ "display": {
+ "$ref": "#/definitions/OperationDisplay"
+ },
+ "isDataAction": {
+ "description": "Indicates whether the operation is a data action",
+ "type": "boolean"
+ }
+ }
+ },
+ "OperationListResult": {
+ "description": "Result of GET request to list the Microsoft.Datadog operations.",
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "List of operations supported by the Microsoft.Datadog 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": {
+ "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",
+ "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"
+ }
+ },
+ "MarketplaceSubscriptionStatus": {
+ "description": "Flag specifying the Marketplace Subscription Status of the resource. If payment is not made in time, the resource will go in Suspended state.",
+ "enum": [
+ "Active",
+ "Suspended"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "modelAsString": true,
+ "name": "MarketplaceSubscriptionStatus"
+ }
+ },
+ "DatadogOrganizationProperties": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "Name of the Datadog organization.",
+ "type": "string",
+ "readOnly": true
+ },
+ "id": {
+ "description": "Id of the Datadog organization.",
+ "type": "string",
+ "readOnly": true
+ },
+ "linkingAuthCode": {
+ "description": "The auth code used to linking to an existing datadog organization.",
+ "type": "string",
+ "x-ms-mutability": [
+ "create"
+ ]
+ },
+ "linkingClientId": {
+ "description": "The client_id from an existing in exchange for an auth token to link organization.",
+ "type": "string",
+ "x-ms-mutability": [
+ "create"
+ ]
+ },
+ "enterpriseAppId": {
+ "description": "The Id of the Enterprise App used for Single sign on.",
+ "type": "string",
+ "x-ms-mutability": [
+ "create"
+ ]
+ }
+ }
+ },
+ "UserInfo": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "Name of the user",
+ "maxLength": 50,
+ "type": "string"
+ },
+ "emailAddress": {
+ "description": "Email of the user used by Datadog for contacting them if needed",
+ "pattern": "^[A-Za-z0-9._%+-]+@(?:[A-Za-z0-9-]+\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "phoneNumber": {
+ "description": "Phone number of the user used by Datadog for contacting them if needed",
+ "maxLength": 40,
+ "type": "string"
+ }
+ }
+ },
+ "LiftrResourceCategories": {
+ "enum": [
+ "Unknown",
+ "MonitorLogs"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "modelAsString": true,
+ "name": "LiftrResourceCategories"
+ },
+ "readOnly": true
+ },
+ "MonitorProperties": {
+ "description": "Properties specific to the monitor resource.",
+ "type": "object",
+ "properties": {
+ "provisioningState": {
+ "$ref": "#/definitions/ProvisioningState"
+ },
+ "monitoringStatus": {
+ "$ref": "#/definitions/MonitoringStatus"
+ },
+ "marketplaceSubscriptionStatus": {
+ "$ref": "#/definitions/MarketplaceSubscriptionStatus"
+ },
+ "datadogOrganizationProperties": {
+ "$ref": "#/definitions/DatadogOrganizationProperties"
+ },
+ "userInfo": {
+ "$ref": "#/definitions/UserInfo"
+ },
+ "liftrResourceCategory": {
+ "$ref": "#/definitions/LiftrResourceCategories"
+ },
+ "liftrResourcePreference": {
+ "description": "The priority of the resource.",
+ "format": "int32",
+ "type": "integer",
+ "readOnly": true
+ }
+ }
+ },
+ "ManagedIdentityTypes": {
+ "enum": [
+ "SystemAssigned",
+ "UserAssigned"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "modelAsString": true,
+ "name": "ManagedIdentityTypes"
+ }
+ },
+ "IdentityProperties": {
+ "type": "object",
+ "properties": {
+ "principalId": {
+ "description": "The identity ID.",
+ "type": "string",
+ "readOnly": true
+ },
+ "tenantId": {
+ "description": "The tenant ID of resource.",
+ "type": "string",
+ "readOnly": true
+ },
+ "type": {
+ "$ref": "#/definitions/ManagedIdentityTypes"
+ }
+ }
+ },
+ "DatadogMonitorResource": {
+ "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": {
+ "$ref": "#/definitions/ResourceSku"
+ },
+ "properties": {
+ "$ref": "#/definitions/MonitorProperties"
+ },
+ "identity": {
+ "$ref": "#/definitions/IdentityProperties"
+ },
+ "tags": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "location": {
+ "type": "string"
+ }
+ }
+ },
+ "DatadogMonitorResourceListResponse": {
+ "description": "Response of a list operation.",
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "Results of a list operation.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/DatadogMonitorResource"
+ }
+ },
+ "nextLink": {
+ "description": "Link to the next set of results, if any.",
+ "type": "string"
+ }
+ }
+ },
+ "MonitorUpdateProperties": {
+ "description": "The set of properties that can be update in a PATCH request to a monitor resource.",
+ "type": "object",
+ "properties": {
+ "monitoringStatus": {
+ "$ref": "#/definitions/MonitoringStatus"
+ }
+ }
+ },
+ "DatadogMonitorResourceUpdateParameters": {
+ "description": "The parameters for a PATCH request to a monitor resource.",
+ "type": "object",
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/MonitorUpdateProperties"
+ },
+ "tags": {
+ "description": "The new tags of the monitor resource.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "DatadogSetPasswordLink": {
+ "type": "object",
+ "properties": {
+ "setPasswordLink": {
+ "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": {
+ "$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 Azure subscription logs should be sent for the Monitor resource.",
+ "type": "boolean"
+ },
+ "sendResourceLogs": {
+ "description": "Flag specifying if Azure resource logs 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 SendResourceLogs 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"
+ }
+ }
+ }
+ },
+ "MetricRules": {
+ "description": "Set of rules for sending metrics for the Monitor resource.",
+ "type": "object",
+ "properties": {
+ "filteringTags": {
+ "description": "List of filtering tags to be used for capturing metrics. If empty, all resources will be captured. If only Exclude action is specified, the rules will apply to the list of all available resources. If Include actions are specified, the rules will only include resources with the associated tags.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/FilteringTag"
+ }
+ }
+ }
+ },
+ "MonitoringTagRulesProperties": {
+ "description": "Definition of the properties for a TagRules resource.",
+ "type": "object",
+ "properties": {
+ "logRules": {
+ "$ref": "#/definitions/LogRules"
+ },
+ "metricRules": {
+ "$ref": "#/definitions/MetricRules"
+ }
+ }
+ },
+ "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": {
+ "$ref": "#/definitions/MonitoringTagRulesProperties"
+ }
+ }
+ },
+ "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"
+ }
+ }
+ },
+ "SingleSignOnStates": {
+ "description": "Various states of the SSO resource",
+ "enum": [
+ "Initial",
+ "Enable",
+ "Disable",
+ "Existing"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "modelAsString": true,
+ "name": "SingleSignOnStates"
+ }
+ },
+ "DatadogSingleSignOnProperties": {
+ "type": "object",
+ "properties": {
+ "singleSignOnState": {
+ "$ref": "#/definitions/SingleSignOnStates"
+ },
+ "enterpriseAppId": {
+ "description": "The Id of the Enterprise App used for Single sign-on.",
+ "type": "string"
+ },
+ "singleSignOnUrl": {
+ "description": "The login URL specific to this Datadog Organization.",
+ "type": "string"
+ }
+ }
+ },
+ "DatadogSingleSignOnResource": {
+ "type": "object",
+ "x-ms-azure-resource": true,
+ "properties": {
+ "id": {
+ "description": "ARM id of the resource.",
+ "type": "string",
+ "readOnly": true
+ },
+ "name": {
+ "description": "Name of the configuration.",
+ "type": "string",
+ "readOnly": true
+ },
+ "type": {
+ "description": "The type of the resource.",
+ "type": "string",
+ "readOnly": true
+ },
+ "properties": {
+ "$ref": "#/definitions/DatadogSingleSignOnProperties"
+ }
+ }
+ },
+ "DatadogSingleSignOnResourceListResponse": {
+ "description": "Response of a list operation.",
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "Results of a list operation.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/DatadogSingleSignOnResource"
+ }
+ },
+ "nextLink": {
+ "description": "Link to the next set of results, if any.",
+ "type": "string"
+ }
+ }
+ }
+ },
+ "parameters": {
+ "SubscriptionIdParameter": {
+ "name": "subscriptionId",
+ "in": "path",
+ "description": "The Microsoft Azure subscription ID.",
+ "required": true,
+ "type": "string"
+ },
+ "ResourceGroupNameParameter": {
+ "name": "resourceGroupName",
+ "in": "path",
+ "description": "The name of the resource group to which the Datadog 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"
+ }
+ }
+}
diff --git a/specification/datadog/resource-manager/Microsoft.Datadog/preview/2020-02-01-preview/examples/ApiKeys_GetDefaultKey.json b/specification/datadog/resource-manager/Microsoft.Datadog/preview/2020-02-01-preview/examples/ApiKeys_GetDefaultKey.json
new file mode 100644
index 000000000000..c04777396993
--- /dev/null
+++ b/specification/datadog/resource-manager/Microsoft.Datadog/preview/2020-02-01-preview/examples/ApiKeys_GetDefaultKey.json
@@ -0,0 +1,18 @@
+{
+ "parameters": {
+ "api-version": "2020-02-01-preview",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "myResourceGroup",
+ "monitorName": "myMonitor"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "createdBy": "john@example.com",
+ "name": "",
+ "key": "1111111111111111aaaaaaaaaaaaaaaa",
+ "created": "2019-04-05 09:20:30"
+ }
+ }
+ }
+}
diff --git a/specification/datadog/resource-manager/Microsoft.Datadog/preview/2020-02-01-preview/examples/ApiKeys_List.json b/specification/datadog/resource-manager/Microsoft.Datadog/preview/2020-02-01-preview/examples/ApiKeys_List.json
new file mode 100644
index 000000000000..6abefd6ef88f
--- /dev/null
+++ b/specification/datadog/resource-manager/Microsoft.Datadog/preview/2020-02-01-preview/examples/ApiKeys_List.json
@@ -0,0 +1,29 @@
+{
+ "parameters": {
+ "api-version": "2020-02-01-preview",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "myResourceGroup",
+ "monitorName": "myMonitor"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "createdBy": "john@example.com",
+ "name": "",
+ "key": "1111111111111111aaaaaaaaaaaaaaaa",
+ "created": "2019-04-05 09:20:30"
+ },
+ {
+ "createdBy": "jane@example.com",
+ "name": "",
+ "key": "2111111111111111aaaaaaaaaaaaaaaa",
+ "created": "2019-04-05 09:19:53"
+ }
+ ],
+ "nextLink": null
+ }
+ }
+ }
+}
diff --git a/specification/datadog/resource-manager/Microsoft.Datadog/preview/2020-02-01-preview/examples/ApiKeys_SetDefaultKey.json b/specification/datadog/resource-manager/Microsoft.Datadog/preview/2020-02-01-preview/examples/ApiKeys_SetDefaultKey.json
new file mode 100644
index 000000000000..9ffba226528e
--- /dev/null
+++ b/specification/datadog/resource-manager/Microsoft.Datadog/preview/2020-02-01-preview/examples/ApiKeys_SetDefaultKey.json
@@ -0,0 +1,14 @@
+{
+ "parameters": {
+ "api-version": "2020-02-01-preview",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "myResourceGroup",
+ "monitorName": "myMonitor",
+ "requestBody": {
+ "key": "1111111111111111aaaaaaaaaaaaaaaa"
+ }
+ },
+ "responses": {
+ "200": {}
+ }
+}
diff --git a/specification/datadog/resource-manager/Microsoft.Datadog/preview/2020-02-01-preview/examples/Hosts_List.json b/specification/datadog/resource-manager/Microsoft.Datadog/preview/2020-02-01-preview/examples/Hosts_List.json
new file mode 100644
index 000000000000..e32923961c2b
--- /dev/null
+++ b/specification/datadog/resource-manager/Microsoft.Datadog/preview/2020-02-01-preview/examples/Hosts_List.json
@@ -0,0 +1,61 @@
+{
+ "parameters": {
+ "api-version": "2020-02-01-preview",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "myResourceGroup",
+ "monitorName": "myMonitor"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "name": "vm1",
+ "aliases": [
+ "vm1",
+ "65f2dd83-95ae-4f56-b6aa-a5dafc05f4cd"
+ ],
+ "apps": [
+ "ntp",
+ "agent"
+ ],
+ "meta": {
+ "agentVersion": "7.19.2",
+ "installMethod": {
+ "tool": "install_script",
+ "toolVersion": "install_script",
+ "installerVersion": "install_script-1.0.0"
+ },
+ "logsAgent": {
+ "transport": ""
+ }
+ }
+ },
+ {
+ "name": "vm2",
+ "aliases": [
+ "vm2",
+ "df631d9a-8178-4580-bf60-c697a5e8df4d"
+ ],
+ "apps": [
+ "infra",
+ "agent"
+ ],
+ "meta": {
+ "agentVersion": "7.18.1",
+ "installMethod": {
+ "tool": "install_script",
+ "toolVersion": "install_script",
+ "installerVersion": "install_script-1.0.0"
+ },
+ "logsAgent": {
+ "transport": "HTTP"
+ }
+ }
+ }
+ ],
+ "nextLink": null
+ }
+ }
+ }
+}
diff --git a/specification/datadog/resource-manager/Microsoft.Datadog/preview/2020-02-01-preview/examples/LinkedResources_List.json b/specification/datadog/resource-manager/Microsoft.Datadog/preview/2020-02-01-preview/examples/LinkedResources_List.json
new file mode 100644
index 000000000000..aab71d3d6090
--- /dev/null
+++ b/specification/datadog/resource-manager/Microsoft.Datadog/preview/2020-02-01-preview/examples/LinkedResources_List.json
@@ -0,0 +1,19 @@
+{
+ "parameters": {
+ "api-version": "2020-02-01-preview",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "myResourceGroup",
+ "monitorName": "myMonitor"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Datadog/monitors/myMonitor"
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/datadog/resource-manager/Microsoft.Datadog/preview/2020-02-01-preview/examples/MonitoredResources_List.json b/specification/datadog/resource-manager/Microsoft.Datadog/preview/2020-02-01-preview/examples/MonitoredResources_List.json
new file mode 100644
index 000000000000..5a55702d6546
--- /dev/null
+++ b/specification/datadog/resource-manager/Microsoft.Datadog/preview/2020-02-01-preview/examples/MonitoredResources_List.json
@@ -0,0 +1,23 @@
+{
+ "parameters": {
+ "api-version": "2020-02-01-preview",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "myResourceGroup",
+ "monitorName": "myMonitor"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVault",
+ "sendingMetrics": true,
+ "reasonForMetricsStatus": "CapturedByRules",
+ "sendingLogs": true,
+ "reasonForLogsStatus": "CapturedByRules"
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/datadog/resource-manager/Microsoft.Datadog/preview/2020-02-01-preview/examples/Monitors_Create.json b/specification/datadog/resource-manager/Microsoft.Datadog/preview/2020-02-01-preview/examples/Monitors_Create.json
new file mode 100644
index 000000000000..bc44d57782d9
--- /dev/null
+++ b/specification/datadog/resource-manager/Microsoft.Datadog/preview/2020-02-01-preview/examples/Monitors_Create.json
@@ -0,0 +1,86 @@
+{
+ "parameters": {
+ "api-version": "2020-02-01-preview",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "myResourceGroup",
+ "monitorName": "myMonitor",
+ "requestBody": {
+ "name": "myMonitor",
+ "sku": {
+ "name": "free_Monthly"
+ },
+ "properties": {
+ "monitoringStatus": "Enabled",
+ "datadogOrganizationProperties": {
+ "name": "myOrg",
+ "subscription": "pro",
+ "linkingAuthCode": "someAuthCode",
+ "linkingClientId": "00000000-0000-0000-0000-000000000000",
+ "enterpriseAppId": "00000000-0000-0000-0000-000000000000"
+ },
+ "userInfo": {
+ "name": "Alice",
+ "emailAddress": "alice@microsoft.com",
+ "phoneNumber": "123-456-7890"
+ }
+ },
+ "tags": {
+ "Environment": "Dev"
+ },
+ "location": "West US"
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/monitors/myMonitor",
+ "name": "myMonitor",
+ "type": "Microsoft.Datadog/monitors",
+ "sku": {
+ "name": "free_Monthly"
+ },
+ "properties": {
+ "provisioningState": "Succeeded",
+ "monitoringStatus": "Enabled",
+ "datadogOrganizationProperties": {
+ "name": "myOrg",
+ "id": "myOrg123",
+ "linkingAuthCode": null,
+ "linkingClientId": null,
+ "enterpriseAppId": null
+ },
+ "liftrResourceCategory": "MonitorLogs",
+ "liftrResourcePreference": 1
+ },
+ "tags": {
+ "Environment": "Dev"
+ },
+ "location": "West US"
+ }
+ },
+ "201": {
+ "body": {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/monitors/myMonitor",
+ "name": "myMonitor",
+ "type": "Microsoft.Datadog/monitors",
+ "sku": {
+ "name": "free_Monthly"
+ },
+ "properties": {
+ "provisioningState": "Accepted",
+ "monitoringStatus": "Enabled",
+ "datadogOrganizationProperties": {
+ "name": "myOrg",
+ "id": "myOrg123"
+ },
+ "liftrResourceCategory": "MonitorLogs",
+ "liftrResourcePreference": 1
+ },
+ "tags": {
+ "Environment": "Dev"
+ },
+ "location": "West US"
+ }
+ }
+ }
+}
diff --git a/specification/datadog/resource-manager/Microsoft.Datadog/preview/2020-02-01-preview/examples/Monitors_Delete.json b/specification/datadog/resource-manager/Microsoft.Datadog/preview/2020-02-01-preview/examples/Monitors_Delete.json
new file mode 100644
index 000000000000..fdcafff7b59b
--- /dev/null
+++ b/specification/datadog/resource-manager/Microsoft.Datadog/preview/2020-02-01-preview/examples/Monitors_Delete.json
@@ -0,0 +1,13 @@
+{
+ "parameters": {
+ "api-version": "2020-02-01-preview",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "myResourceGroup",
+ "monitorName": "myMonitor"
+ },
+ "responses": {
+ "200": {},
+ "202": {},
+ "204": {}
+ }
+}
diff --git a/specification/datadog/resource-manager/Microsoft.Datadog/preview/2020-02-01-preview/examples/Monitors_Get.json b/specification/datadog/resource-manager/Microsoft.Datadog/preview/2020-02-01-preview/examples/Monitors_Get.json
new file mode 100644
index 000000000000..9c3390fd0ab5
--- /dev/null
+++ b/specification/datadog/resource-manager/Microsoft.Datadog/preview/2020-02-01-preview/examples/Monitors_Get.json
@@ -0,0 +1,34 @@
+{
+ "parameters": {
+ "api-version": "2020-02-01-preview",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "myResourceGroup",
+ "monitorName": "myMonitor"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/monitors/myMonitor",
+ "name": "myMonitor",
+ "type": "Microsoft.Datadog/monitors",
+ "properties": {
+ "provisioningState": "Succeeded",
+ "monitoringStatus": "Enabled",
+ "datadogOrganizationProperties": {
+ "name": "myOrg",
+ "id": "myOrg123",
+ "linkingAuthCode": null,
+ "linkingClientId": null,
+ "enterpriseAppId": null
+ },
+ "liftrResourceCategory": "MonitorLogs",
+ "liftrResourcePreference": 1
+ },
+ "tags": {
+ "Environment": "Dev"
+ },
+ "location": "West US"
+ }
+ }
+ }
+}
diff --git a/specification/datadog/resource-manager/Microsoft.Datadog/preview/2020-02-01-preview/examples/Monitors_List.json b/specification/datadog/resource-manager/Microsoft.Datadog/preview/2020-02-01-preview/examples/Monitors_List.json
new file mode 100644
index 000000000000..b262da98f31f
--- /dev/null
+++ b/specification/datadog/resource-manager/Microsoft.Datadog/preview/2020-02-01-preview/examples/Monitors_List.json
@@ -0,0 +1,37 @@
+{
+ "parameters": {
+ "api-version": "2020-02-01-preview",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "myResourceGroup"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/monitors/myMonitor",
+ "name": "myMonitor",
+ "type": "Microsoft.Datadog/monitors",
+ "properties": {
+ "provisioningState": "Succeeded",
+ "monitoringStatus": "Enabled",
+ "datadogOrganizationProperties": {
+ "name": "myOrg",
+ "id": "myOrg123",
+ "linkingAuthCode": null,
+ "linkingClientId": null,
+ "enterpriseAppId": null
+ },
+ "liftrResourceCategory": "MonitorLogs",
+ "liftrResourcePreference": 1
+ },
+ "tags": {
+ "Environment": "Dev"
+ },
+ "location": "West US"
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/datadog/resource-manager/Microsoft.Datadog/preview/2020-02-01-preview/examples/Monitors_ListByResourceGroup.json b/specification/datadog/resource-manager/Microsoft.Datadog/preview/2020-02-01-preview/examples/Monitors_ListByResourceGroup.json
new file mode 100644
index 000000000000..b262da98f31f
--- /dev/null
+++ b/specification/datadog/resource-manager/Microsoft.Datadog/preview/2020-02-01-preview/examples/Monitors_ListByResourceGroup.json
@@ -0,0 +1,37 @@
+{
+ "parameters": {
+ "api-version": "2020-02-01-preview",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "myResourceGroup"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/monitors/myMonitor",
+ "name": "myMonitor",
+ "type": "Microsoft.Datadog/monitors",
+ "properties": {
+ "provisioningState": "Succeeded",
+ "monitoringStatus": "Enabled",
+ "datadogOrganizationProperties": {
+ "name": "myOrg",
+ "id": "myOrg123",
+ "linkingAuthCode": null,
+ "linkingClientId": null,
+ "enterpriseAppId": null
+ },
+ "liftrResourceCategory": "MonitorLogs",
+ "liftrResourcePreference": 1
+ },
+ "tags": {
+ "Environment": "Dev"
+ },
+ "location": "West US"
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/datadog/resource-manager/Microsoft.Datadog/preview/2020-02-01-preview/examples/Monitors_Update.json b/specification/datadog/resource-manager/Microsoft.Datadog/preview/2020-02-01-preview/examples/Monitors_Update.json
new file mode 100644
index 000000000000..533a811b225a
--- /dev/null
+++ b/specification/datadog/resource-manager/Microsoft.Datadog/preview/2020-02-01-preview/examples/Monitors_Update.json
@@ -0,0 +1,45 @@
+{
+ "parameters": {
+ "api-version": "2020-02-01-preview",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "myResourceGroup",
+ "monitorName": "myMonitor",
+ "requestBody": {
+ "properties": {
+ "monitoringStatus": "Enabled"
+ },
+ "tags": {
+ "Environment": "Dev"
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/monitors/myMonitor",
+ "name": "myMonitor",
+ "type": "Microsoft.Datadog/monitors",
+ "sku": {
+ "name": "free_Monthly"
+ },
+ "properties": {
+ "provisioningState": "Succeeded",
+ "monitoringStatus": "Enabled",
+ "datadogOrganizationProperties": {
+ "name": "myOrg",
+ "id": "myOrg123",
+ "linkingAuthCode": null,
+ "linkingClientId": null,
+ "enterpriseAppId": null
+ },
+ "liftrResourceCategory": "MonitorLogs",
+ "liftrResourcePreference": 1
+ },
+ "tags": {
+ "Environment": "Dev"
+ },
+ "location": "West US"
+ }
+ }
+ }
+}
diff --git a/specification/datadog/resource-manager/Microsoft.Datadog/preview/2020-02-01-preview/examples/Operations_List.json b/specification/datadog/resource-manager/Microsoft.Datadog/preview/2020-02-01-preview/examples/Operations_List.json
new file mode 100644
index 000000000000..3a4b7b298ef3
--- /dev/null
+++ b/specification/datadog/resource-manager/Microsoft.Datadog/preview/2020-02-01-preview/examples/Operations_List.json
@@ -0,0 +1,23 @@
+{
+ "parameters": {
+ "api-version": "2020-02-01-preview"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "name": "Microsoft.Datadog/monitors/write",
+ "display": {
+ "provider": "Microsoft.Datadog",
+ "resource": "monitors",
+ "operation": "write",
+ "description": "Write monitors resource"
+ }
+ }
+ ],
+ "nextLink": null
+ }
+ }
+ }
+}
diff --git a/specification/datadog/resource-manager/Microsoft.Datadog/preview/2020-02-01-preview/examples/RefreshSetPassword_Get.json b/specification/datadog/resource-manager/Microsoft.Datadog/preview/2020-02-01-preview/examples/RefreshSetPassword_Get.json
new file mode 100644
index 000000000000..2fc910d0b17b
--- /dev/null
+++ b/specification/datadog/resource-manager/Microsoft.Datadog/preview/2020-02-01-preview/examples/RefreshSetPassword_Get.json
@@ -0,0 +1,15 @@
+{
+ "parameters": {
+ "api-version": "2020-02-01-preview",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "myResourceGroup",
+ "monitorName": "myMonitor"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "setPasswordLink": "https://datadoghq.com/reset_password/tokenvalue123"
+ }
+ }
+ }
+}
diff --git a/specification/datadog/resource-manager/Microsoft.Datadog/preview/2020-02-01-preview/examples/SingleSignOnConfigurations_CreateOrUpdate.json b/specification/datadog/resource-manager/Microsoft.Datadog/preview/2020-02-01-preview/examples/SingleSignOnConfigurations_CreateOrUpdate.json
new file mode 100644
index 000000000000..3b8b4caac81f
--- /dev/null
+++ b/specification/datadog/resource-manager/Microsoft.Datadog/preview/2020-02-01-preview/examples/SingleSignOnConfigurations_CreateOrUpdate.json
@@ -0,0 +1,39 @@
+{
+ "parameters": {
+ "api-version": "2020-02-01-preview",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "myResourceGroup",
+ "monitorName": "myMonitor",
+ "configurationName": "default",
+ "requestBody": {
+ "properties": {
+ "singleSignOnState": "Enable",
+ "enterpriseAppId": "00000000-0000-0000-0000-000000000000"
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "name": "default",
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Datadog/monitors/myMonitor/singleSignOnConfigurations/default",
+ "properties": {
+ "singleSignOnState": "Enable",
+ "enterpriseAppId": "00000000-0000-0000-0000-000000000000",
+ "singleSignOnUrl": null
+ }
+ }
+ },
+ "201": {
+ "body": {
+ "name": "default",
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Datadog/monitors/myMonitor/singleSignOnConfigurations/default",
+ "properties": {
+ "singleSignOnState": "Enable",
+ "enterpriseAppId": "00000000-0000-0000-0000-000000000000",
+ "singleSignOnUrl": null
+ }
+ }
+ }
+ }
+}
diff --git a/specification/datadog/resource-manager/Microsoft.Datadog/preview/2020-02-01-preview/examples/SingleSignOnConfigurations_Get.json b/specification/datadog/resource-manager/Microsoft.Datadog/preview/2020-02-01-preview/examples/SingleSignOnConfigurations_Get.json
new file mode 100644
index 000000000000..021c2a64284b
--- /dev/null
+++ b/specification/datadog/resource-manager/Microsoft.Datadog/preview/2020-02-01-preview/examples/SingleSignOnConfigurations_Get.json
@@ -0,0 +1,22 @@
+{
+ "parameters": {
+ "api-version": "2020-02-01-preview",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "myResourceGroup",
+ "monitorName": "myMonitor",
+ "configurationName": "default"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "name": "default",
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Datadog/monitors/myMonitor/singleSignOnConfigurations/default",
+ "properties": {
+ "singleSignOnState": "Enable",
+ "enterpriseAppId": "00000000-0000-0000-0000-000000000000",
+ "singleSignOnUrl": "https://www.datadoghq.com/IAmSomeHash"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/datadog/resource-manager/Microsoft.Datadog/preview/2020-02-01-preview/examples/SingleSignOnConfigurations_List.json b/specification/datadog/resource-manager/Microsoft.Datadog/preview/2020-02-01-preview/examples/SingleSignOnConfigurations_List.json
new file mode 100644
index 000000000000..e472eac281c9
--- /dev/null
+++ b/specification/datadog/resource-manager/Microsoft.Datadog/preview/2020-02-01-preview/examples/SingleSignOnConfigurations_List.json
@@ -0,0 +1,25 @@
+{
+ "parameters": {
+ "api-version": "2020-02-01-preview",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "myResourceGroup",
+ "monitorName": "myMonitor"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "name": "default",
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Datadog/monitors/myMonitor/singleSignOnConfigurations/default",
+ "properties": {
+ "singleSignOnState": "Enable",
+ "enterpriseAppId": "00000000-0000-0000-0000-000000000000",
+ "singleSignOnUrl": "https://www.datadoghq.com/IAmSomeHash"
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/datadog/resource-manager/Microsoft.Datadog/preview/2020-02-01-preview/examples/TagRules_CreateOrUpdate.json b/specification/datadog/resource-manager/Microsoft.Datadog/preview/2020-02-01-preview/examples/TagRules_CreateOrUpdate.json
new file mode 100644
index 000000000000..4b5fd4503037
--- /dev/null
+++ b/specification/datadog/resource-manager/Microsoft.Datadog/preview/2020-02-01-preview/examples/TagRules_CreateOrUpdate.json
@@ -0,0 +1,64 @@
+{
+ "parameters": {
+ "api-version": "2020-02-01-preview",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "myResourceGroup",
+ "monitorName": "myMonitor",
+ "ruleSetName": "default",
+ "requestBody": {
+ "properties": {
+ "logRules": {
+ "sendAadLogs": false,
+ "sendSubscriptionLogs": true,
+ "sendResourceLogs": true,
+ "filteringTags": [
+ {
+ "name": "Environment",
+ "value": "Prod",
+ "action": "Include"
+ },
+ {
+ "name": "Environment",
+ "value": "Dev",
+ "action": "Exclude"
+ }
+ ]
+ },
+ "metricRules": {
+ "filteringTags": []
+ }
+ }
+ }
+ },
+ "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": {
+ "logRules": {
+ "sendAadLogs": false,
+ "sendSubscriptionLogs": true,
+ "sendResourceLogs": true,
+ "filteringTags": [
+ {
+ "name": "Environment",
+ "value": "Prod",
+ "action": "Include"
+ },
+ {
+ "name": "Environment",
+ "value": "Dev",
+ "action": "Exclude"
+ }
+ ]
+ },
+ "metricRules": {
+ "filteringTags": []
+ }
+ }
+ }
+ }
+ }
+}
diff --git a/specification/datadog/resource-manager/Microsoft.Datadog/preview/2020-02-01-preview/examples/TagRules_Get.json b/specification/datadog/resource-manager/Microsoft.Datadog/preview/2020-02-01-preview/examples/TagRules_Get.json
new file mode 100644
index 000000000000..6e6605f6287e
--- /dev/null
+++ b/specification/datadog/resource-manager/Microsoft.Datadog/preview/2020-02-01-preview/examples/TagRules_Get.json
@@ -0,0 +1,40 @@
+{
+ "parameters": {
+ "api-version": "2020-02-01-preview",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "myResourceGroup",
+ "monitorName": "myMonitor",
+ "ruleSetName": "default"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "name": "default",
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Datadog/monitors/myMonitor/tagRules/default",
+ "type": "Microsoft.Datadog/monitors/tagRules",
+ "properties": {
+ "logRules": {
+ "sendAadLogs": false,
+ "sendSubscriptionLogs": true,
+ "sendResourceLogs": true,
+ "filteringTags": [
+ {
+ "name": "Environment",
+ "value": "Prod",
+ "action": "Include"
+ },
+ {
+ "name": "Environment",
+ "value": "Dev",
+ "action": "Exclude"
+ }
+ ]
+ },
+ "metricRules": {
+ "filteringTags": []
+ }
+ }
+ }
+ }
+ }
+}
diff --git a/specification/datadog/resource-manager/Microsoft.Datadog/preview/2020-02-01-preview/examples/TagRules_List.json b/specification/datadog/resource-manager/Microsoft.Datadog/preview/2020-02-01-preview/examples/TagRules_List.json
new file mode 100644
index 000000000000..310676a49fd0
--- /dev/null
+++ b/specification/datadog/resource-manager/Microsoft.Datadog/preview/2020-02-01-preview/examples/TagRules_List.json
@@ -0,0 +1,43 @@
+{
+ "parameters": {
+ "api-version": "2020-02-01-preview",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "myResourceGroup",
+ "monitorName": "myMonitor"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "name": "default",
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Datadog/monitors/myMonitor/tagRules/default",
+ "type": "Microsoft.Datadog/monitors/tagRules",
+ "properties": {
+ "logRules": {
+ "sendAadLogs": false,
+ "sendSubscriptionLogs": true,
+ "sendResourceLogs": true,
+ "filteringTags": [
+ {
+ "name": "Environment",
+ "value": "Prod",
+ "action": "Include"
+ },
+ {
+ "name": "Environment",
+ "value": "Dev",
+ "action": "Exclude"
+ }
+ ]
+ },
+ "metricRules": {
+ "filteringTags": []
+ }
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/datadog/resource-manager/readme.az.md b/specification/datadog/resource-manager/readme.az.md
new file mode 100644
index 000000000000..255a40da1cd7
--- /dev/null
+++ b/specification/datadog/resource-manager/readme.az.md
@@ -0,0 +1,12 @@
+## AZ
+
+These settings apply only when `--az` is specified on the command line.
+
+``` yaml $(az) && $(target-mode) != 'core'
+az:
+ extensions: datadog
+ namespace: azure.mgmt.datadog
+ package-name: azure-mgmt-datadog
+az-output-folder: $(azure-cli-extension-folder)/src/datadog
+python-sdk-output-folder: "$(az-output-folder)/azext_datadog/vendored_sdks/datadog"
+```
diff --git a/specification/datadog/resource-manager/readme.azureresourceschema.md b/specification/datadog/resource-manager/readme.azureresourceschema.md
new file mode 100644
index 000000000000..acca975da361
--- /dev/null
+++ b/specification/datadog/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-datadog-2020-02-01-preview
+
+```
+
+Please also specify `--azureresourceschema-folder=`.
+
+### Tag: schema-datadog-2020-02-01-preview and azureresourceschema
+
+``` yaml $(tag) == 'schema-datadog-2020-02-01-preview' && $(azureresourceschema)
+output-folder: $(azureresourceschema-folder)/schemas
+
+# all the input files in this apiVersion
+input-file:
+ - Microsoft.Datadog/preview/2020-02-01-preview/datadog.json
+
+```
diff --git a/specification/datadog/resource-manager/readme.cli.md b/specification/datadog/resource-manager/readme.cli.md
new file mode 100644
index 000000000000..bd1ae237a340
--- /dev/null
+++ b/specification/datadog/resource-manager/readme.cli.md
@@ -0,0 +1,6 @@
+## CLI
+
+These settings don't need to apply `--cli` on the command line.
+
+``` yaml
+```
diff --git a/specification/datadog/resource-manager/readme.csharp.md b/specification/datadog/resource-manager/readme.csharp.md
new file mode 100644
index 000000000000..3c0da556150d
--- /dev/null
+++ b/specification/datadog/resource-manager/readme.csharp.md
@@ -0,0 +1,14 @@
+## 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.Datadog
+ payload-flattening-threshold: 1
+ output-folder: $(csharp-sdks-folder)/datadog/Microsoft.Azure.Management.Datadog/src/Generated
+ clear-output-folder: true
+```
diff --git a/specification/datadog/resource-manager/readme.go.md b/specification/datadog/resource-manager/readme.go.md
new file mode 100644
index 000000000000..847ccfd2fe30
--- /dev/null
+++ b/specification/datadog/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
+ namespace: datadog
+ clear-output-folder: true
+```
+
+### Go multi-api
+
+``` yaml $(go) && $(multiapi)
+batch:
+ - tag: package-2020-02-preview
+```
+
+### Tag: package-2020-02-preview and go
+
+These settings apply only when `--tag=package-2020-02-preview --go` is specified on the command line.
+Please also specify `--go-sdk-folder=`.
+
+``` yaml $(tag) == 'package-2020-02-preview' && $(go)
+output-folder: $(go-sdk-folder)/services/preview/$(namespace)/mgmt/2020-02-01-preview/$(namespace)
+```
diff --git a/specification/datadog/resource-manager/readme.java.md b/specification/datadog/resource-manager/readme.java.md
new file mode 100644
index 000000000000..df97395c3038
--- /dev/null
+++ b/specification/datadog/resource-manager/readme.java.md
@@ -0,0 +1,33 @@
+## 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.datadog
+license-header: MICROSOFT_MIT_NO_CODEGEN
+payload-flattening-threshold: 1
+output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-datadog
+```
+
+### Java multi-api
+
+``` yaml $(java) && $(multiapi)
+batch:
+ - tag: package-2020-02-preview
+```
+
+### Tag: package-2020-02-preview and java
+
+These settings apply only when `--tag=package-2020-02-preview --java` is specified on the command line.
+Please also specify `--azure-libraries-for-java=`.
+
+``` yaml $(tag) == 'package-2020-02-preview' && $(java) && $(multiapi)
+java:
+ namespace: com.microsoft.azure.management.datadog.v2020_02_01_preview
+ output-folder: $(azure-libraries-for-java-folder)/sdk/datadog/mgmt-v2020_02_01_preview
+regenerate-manager: true
+generate-interface: true
+```
\ No newline at end of file
diff --git a/specification/datadog/resource-manager/readme.md b/specification/datadog/resource-manager/readme.md
new file mode 100644
index 000000000000..faa0f77fae95
--- /dev/null
+++ b/specification/datadog/resource-manager/readme.md
@@ -0,0 +1,120 @@
+# Datadog
+
+> see https://aka.ms/autorest
+
+This is the AutoRest configuration file for Datadog.
+
+
+
+---
+## Getting Started
+To build the SDK for Datadog, 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 Datadog API.
+
+``` yaml
+title: Microsoft Datadog Client
+openapi-type: arm
+tag: package-2020-02-preview
+```
+
+### Tag: package-2020-02-preview
+
+These settings apply only when `--tag=package-2020-02-preview` is specified on the command line.
+
+``` yaml $(tag) == 'package-2020-02-preview'
+input-file:
+- Microsoft.Datadog/preview/2020-02-01-preview/datadog.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-python-track2
+ - repo: azure-sdk-for-java
+ - repo: azure-sdk-for-go
+ - repo: azure-sdk-for-js
+ - repo: azure-sdk-for-node
+ - repo: azure-sdk-for-ruby
+ after_scripts:
+ - bundle install && rake arm:regen_all_profiles['azure_mgmt_datadog']
+ - repo: azure-cli-extensions
+ - repo: azure-resource-manager-schemas
+ after_scripts:
+ - node sdkauto_afterscript.js datadog/resource-manager
+```
+
+## C#
+
+See configuration in [readme.csharp.md](./readme.csharp.md)
+
+## Go
+
+See configuration in [readme.go.md](./readme.go.md)
+
+## Java
+
+See configuration in [readme.java.md](./readme.java.md)
+
+## Node.js
+
+See configuration in [readme.nodejs.md](./readme.nodejs.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)
+
+
+## AzureResourceSchema
+
+See configuration in [readme.azureresourceschema.md](./readme.azureresourceschema.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.Datadog/preview/2020-02-01-preview/datadog.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/datadog/resource-manager/readme.nodejs.md b/specification/datadog/resource-manager/readme.nodejs.md
new file mode 100644
index 000000000000..565312e54cdc
--- /dev/null
+++ b/specification/datadog/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-datadog
+ output-folder: $(node-sdks-folder)/lib/services/datadogManagement
+ generate-license-txt: true
+ generate-package-json: true
+ generate-readme-md: true
+```
diff --git a/specification/datadog/resource-manager/readme.python.md b/specification/datadog/resource-manager/readme.python.md
new file mode 100644
index 000000000000..5768cbbc5bdd
--- /dev/null
+++ b/specification/datadog/resource-manager/readme.python.md
@@ -0,0 +1,43 @@
+## 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.datadog
+ package-name: azure-mgmt-datadog
+ package-version: 1.0.0
+ clear-output-folder: 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-datadog
+no-namespace-folders: true
+package-version: 1.0.0
+```
+
+``` yaml $(python) && $(python-mode) == 'update'
+python:
+ no-namespace-folders: true
+ output-folder: $(python-sdks-folder)/datadog/azure-mgmt-datadog/azure/mgmt/datadog
+no-namespace-folders: true
+output-folder: $(python-sdks-folder)/datadog/azure-mgmt-datadog/azure/mgmt/datadog
+```
+
+``` yaml $(python) && $(python-mode) == 'create'
+python:
+ basic-setup-py: true
+ output-folder: $(python-sdks-folder)/datadog/azure-mgmt-datadog
+basic-setup-py: true
+output-folder: $(python-sdks-folder)/datadog/azure-mgmt-datadog
+```
diff --git a/specification/datadog/resource-manager/readme.ruby.md b/specification/datadog/resource-manager/readme.ruby.md
new file mode 100644
index 000000000000..e67dde1680e2
--- /dev/null
+++ b/specification/datadog/resource-manager/readme.ruby.md
@@ -0,0 +1,26 @@
+## Ruby
+
+These settings apply only when `--ruby` is specified on the command line.
+
+``` yaml
+package-name: azure_mgmt_datadog
+package-version: 2020-02-01-preview
+azure-arm: true
+```
+
+### Ruby multi-api
+
+``` yaml $(ruby) && $(multiapi)
+batch:
+ - tag: package-2020-02-01-preview
+```
+
+### Tag: package-2020-02-01-preview and ruby
+
+These settings apply only when `--tag=package-2020-02-01-preview --ruby` is specified on the command line.
+Please also specify `--ruby-sdks-folder=`.
+
+``` yaml $(tag) == 'package-2020-02-01-preview' && $(ruby)
+namespace: "Azure::Datadog::Mgmt::V2020_02_01_preview"
+output-folder: $(ruby-sdks-folder)/management/azure_mgmt_datadog/lib
+```
diff --git a/specification/datadog/resource-manager/readme.typescript.md b/specification/datadog/resource-manager/readme.typescript.md
new file mode 100644
index 000000000000..4c69879e1b9b
--- /dev/null
+++ b/specification/datadog/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-datadog"
+ output-folder: "$(typescript-sdks-folder)/sdk/datadog/arm-datadog"
+ clear-output-folder: true
+ generate-metadata: true
+```
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 43909b01832d..43f2f1614abd 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
@@ -4886,6 +4886,18 @@
"globalParameters": {
"$ref": "#/definitions/GlobalParameterDefinitionSpecification",
"description": "List of parameters for factory."
+ },
+ "publicNetworkAccess": {
+ "description": "Whether or not public network access is allowed for the data factory.",
+ "enum": [
+ "Enabled",
+ "Disabled"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "PublicNetworkAccess",
+ "modelAsString": true
+ }
}
}
},
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 a573ecd8bde4..f822291740b8 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
@@ -908,7 +908,8 @@
"enum": [
"none",
"zlib",
- "snappy"
+ "snappy",
+ "lzo"
],
"x-ms-enum": {
"name": "orcCompressionCodec",
@@ -1520,6 +1521,38 @@
"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.",
+ "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.",
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 ac022366955a..f6c6c78b0d7b 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
@@ -2042,6 +2042,43 @@
"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.",
+ "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.",
@@ -2652,6 +2689,10 @@
"AmazonS3LinkedServiceTypeProperties": {
"description": "Amazon S3 linked service properties.",
"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)."
@@ -2664,6 +2705,10 @@
"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": {
+ "type": "object",
+ "description": "The session token for the S3 temporary security credential. 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)."
@@ -3244,6 +3289,10 @@
"ConcurLinkedServiceTypeProperties": {
"description": "Concur Service linked service properties.",
"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"
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 35aa8392c78c..0e319987eced 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
@@ -1475,9 +1475,13 @@
"$ref": "#/definitions/RedirectIncompatibleRowSettings"
},
"logStorageSettings": {
- "description": "Log storage settings customer need to provide when enabling session log.",
+ "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": {
@@ -2770,6 +2774,40 @@
}
}
},
+ "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": "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"
+ }
+ }
+ }
+ },
"MongoDbV2Source": {
"description": "A copy activity source for a MongoDB database.",
"type": "object",
@@ -4298,7 +4336,7 @@
}
},
"LogStorageSettings": {
- "description": "Log storage settings.",
+ "description": "(Deprecated. Please use LogSettings) Log storage settings.",
"type": "object",
"properties": {
"linkedServiceName": {
@@ -4325,6 +4363,58 @@
"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": "../datafactory.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",
diff --git a/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-07-15-preview/definitions/MigrateMySqlAzureDbForMySqlSyncTask.json b/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-07-15-preview/definitions/MigrateMySqlAzureDbForMySqlSyncTask.json
index fe9b45ba782e..177f0d78f18e 100644
--- a/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-07-15-preview/definitions/MigrateMySqlAzureDbForMySqlSyncTask.json
+++ b/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-07-15-preview/definitions/MigrateMySqlAzureDbForMySqlSyncTask.json
@@ -356,6 +356,13 @@
"additionalProperties": {
"type": "string"
}
+ },
+ "tableMap": {
+ "type": "object",
+ "description": "Mapping of source to target tables",
+ "additionalProperties": {
+ "type": "string"
+ }
}
}
}
diff --git a/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-07-15-preview/definitions/MigratePostgreSqlAzureDbForPostgreSqlSyncTask.json b/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-07-15-preview/definitions/MigratePostgreSqlAzureDbForPostgreSqlSyncTask.json
index 1d7ffee88df1..3ed8bce5713a 100644
--- a/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-07-15-preview/definitions/MigratePostgreSqlAzureDbForPostgreSqlSyncTask.json
+++ b/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-07-15-preview/definitions/MigratePostgreSqlAzureDbForPostgreSqlSyncTask.json
@@ -374,6 +374,23 @@
"additionalProperties": {
"type": "string"
}
+ },
+ "selectedTables": {
+ "type": "array",
+ "description": "Tables selected for migration",
+ "items": {
+ "$ref": "#/definitions/MigratePostgreSqlAzureDbForPostgreSqlSyncDatabaseTableInput"
+ }
+ }
+ }
+ },
+ "MigratePostgreSqlAzureDbForPostgreSqlSyncDatabaseTableInput": {
+ "type": "object",
+ "description": "Selected tables for the migration",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "Name of the table to migrate"
}
}
}
diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/desktopvirtualization.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/desktopvirtualization.json
index 8bee1f0e764a..08655276ef04 100644
--- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/desktopvirtualization.json
+++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/desktopvirtualization.json
@@ -2275,6 +2275,10 @@
"$ref": "#/definitions/RegistrationInfoPatch",
"description": "The registration info of HostPool."
},
+ "vmTemplate": {
+ "type": "string",
+ "description": "VM template for sessionhosts configuration within hostpool."
+ },
"ssoContext": {
"type": "string",
"description": "Path to keyvault containing ssoContext secret."
diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/ApplicationGroup_Create.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/ApplicationGroup_Create.json
index 8d6b4bb1382b..1323b6f7b04c 100644
--- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/ApplicationGroup_Create.json
+++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/ApplicationGroup_Create.json
@@ -13,7 +13,7 @@
"properties": {
"description": "des1",
"friendlyName": "friendly",
- "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1",
+ "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostPool1",
"applicationGroupType": "RemoteApp"
}
}
@@ -22,7 +22,7 @@
"200": {
"body": {
"name": "applicationGroup1",
- "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1",
+ "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1",
"type": "Microsoft.DesktopVirtualization/applicationGroups",
"location": "centralus",
"tags": {
@@ -32,8 +32,8 @@
"properties": {
"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",
+ "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"
}
}
@@ -41,7 +41,7 @@
"201": {
"body": {
"name": "applicationGroup1",
- "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1",
+ "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1",
"type": "Microsoft.DesktopVirtualization/applicationGroups",
"location": "centralus",
"tags": {
@@ -51,8 +51,8 @@
"properties": {
"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",
+ "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"
}
}
diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/ApplicationGroup_Delete.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/ApplicationGroup_Delete.json
index 79cf00e37e7c..fe87af2b8ad1 100644
--- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/ApplicationGroup_Delete.json
+++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/ApplicationGroup_Delete.json
@@ -8,7 +8,7 @@
"responses": {
"200": {
"name": "applicationGroup1",
- "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1",
+ "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1",
"type": "Microsoft.DesktopVirtualization/applicationGroups",
"location": "centralus",
"tags": {
@@ -18,8 +18,8 @@
"properties": {
"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",
+ "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"
}
},
diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/ApplicationGroup_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/ApplicationGroup_Get.json
index b7bb05752a8a..823c1bb55ec6 100644
--- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/ApplicationGroup_Get.json
+++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/ApplicationGroup_Get.json
@@ -9,7 +9,7 @@
"200": {
"body": {
"name": "applicationGroup1",
- "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1",
+ "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1",
"type": "Microsoft.DesktopVirtualization/applicationGroups",
"location": "centralus",
"tags": {
@@ -19,8 +19,8 @@
"properties": {
"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",
+ "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"
}
}
diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/ApplicationGroup_ListByResourceGroup.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/ApplicationGroup_ListByResourceGroup.json
index afcec930670e..18136fe1eae9 100644
--- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/ApplicationGroup_ListByResourceGroup.json
+++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/ApplicationGroup_ListByResourceGroup.json
@@ -11,7 +11,7 @@
"value": [
{
"name": "applicationGroup1",
- "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1",
+ "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1",
"type": "Microsoft.DesktopVirtualization/applicationGroups",
"location": "centralus",
"tags": {
@@ -21,14 +21,14 @@
"properties": {
"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",
+ "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"
}
},
{
"name": "applicationGroup2",
- "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup2",
+ "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup2",
"type": "Microsoft.DesktopVirtualization/applicationGroups",
"location": "centralus",
"tags": {
@@ -38,8 +38,8 @@
"properties": {
"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",
+ "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"
}
}
diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/ApplicationGroup_ListBySubscription.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/ApplicationGroup_ListBySubscription.json
index 6a7fe723d2ed..985bc6a50874 100644
--- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/ApplicationGroup_ListBySubscription.json
+++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/ApplicationGroup_ListBySubscription.json
@@ -10,7 +10,7 @@
"value": [
{
"name": "applicationGroup1",
- "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1",
+ "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1",
"type": "Microsoft.DesktopVirtualization/applicationGroups",
"location": "centralus",
"tags": {
@@ -20,14 +20,14 @@
"properties": {
"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",
+ "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"
}
},
{
"name": "applicationGroup2",
- "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup2",
+ "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup2",
"type": "Microsoft.DesktopVirtualization/applicationGroups",
"location": "centralus",
"tags": {
@@ -37,8 +37,8 @@
"properties": {
"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",
+ "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"
}
}
diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/ApplicationGroup_Update.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/ApplicationGroup_Update.json
index 0d6da727b913..cb865a4a4e97 100644
--- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/ApplicationGroup_Update.json
+++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/ApplicationGroup_Update.json
@@ -19,7 +19,7 @@
"200": {
"body": {
"name": "applicationGroup1",
- "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1",
+ "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1",
"type": "Microsoft.DesktopVirtualization/applicationGroups",
"location": "centralus",
"tags": {
@@ -29,8 +29,8 @@
"properties": {
"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",
+ "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"
}
}
diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/Desktop_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/Desktop_Get.json
index 26b94e09f7c8..9ba7029e8d05 100644
--- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/Desktop_Get.json
+++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/Desktop_Get.json
@@ -10,7 +10,7 @@
"200": {
"body": {
"name": "applicationGroup1/SessionDesktop",
- "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/applications/SessionDesktop",
+ "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/applications/SessionDesktop",
"type": "Microsoft.DesktopVirtualization/applicationGroups/desktops",
"properties": {
"description": "des1",
diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/Desktop_List.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/Desktop_List.json
index ed22d9f54aa9..278df9477b0a 100644
--- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/Desktop_List.json
+++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/Desktop_List.json
@@ -11,7 +11,7 @@
"value": [
{
"name": "applicationGroup1/SessionDesktop",
- "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/applications/SessionDesktop",
+ "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/applications/SessionDesktop",
"type": "Microsoft.DesktopVirtualization/applicationGroups/desktops",
"properties": {
"description": "des1",
diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/Desktop_Update.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/Desktop_Update.json
index 0a1f83fccb49..8b93343fdda7 100644
--- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/Desktop_Update.json
+++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/Desktop_Update.json
@@ -16,7 +16,7 @@
"200": {
"body": {
"name": "applicationGroup1/SessionDesktop",
- "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/desktops/SessionDesktop",
+ "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/desktops/SessionDesktop",
"type": "Microsoft.DesktopVirtualization/applicationGroups/desktops",
"properties": {
"description": "des1",
diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/HostPool_Create.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/HostPool_Create.json
index 12ea67762e9d..ba6d5d97f5ff 100644
--- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/HostPool_Create.json
+++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/HostPool_Create.json
@@ -22,6 +22,7 @@
"expirationTime": "2020-10-01T14:01:54.9571247Z",
"registrationTokenOperation": "Update"
},
+ "vmTemplate": "{json:json}",
"ssoContext": "KeyVaultPath",
"preferredAppGroupType": "Desktop"
}
@@ -31,8 +32,8 @@
"200": {
"body": {
"name": "hostPool1",
- "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1",
- "type": "/Microsoft.DesktopVirtualization/hostPools",
+ "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostPool1",
+ "type": "/Microsoft.DesktopVirtualization/hostpools",
"location": "centralus",
"tags": {
"key1": "value1",
@@ -53,7 +54,8 @@
"token": "token",
"registrationTokenOperation": "Update"
},
- "ssoContext": "KeyVaultPath",
+ "vmTemplate": "{json:json}",
+ "ssoContext": null,
"preferredAppGroupType": "Desktop"
}
}
@@ -61,8 +63,8 @@
"201": {
"body": {
"name": "hostPool1",
- "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1",
- "type": "/Microsoft.DesktopVirtualization/hostPools",
+ "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostPool1",
+ "type": "/Microsoft.DesktopVirtualization/hostpools",
"location": "centralus",
"tags": {
"key1": "value1",
@@ -83,7 +85,7 @@
"token": "token",
"registrationTokenOperation": "Update"
},
- "ssoContext": "KeyVaultPath",
+ "ssoContext": null,
"preferredAppGroupType": "Desktop"
}
}
diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/HostPool_Delete.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/HostPool_Delete.json
index 447fc42fc699..434d80ce221b 100644
--- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/HostPool_Delete.json
+++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/HostPool_Delete.json
@@ -9,8 +9,8 @@
"responses": {
"200": {
"name": "hostPool1",
- "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1",
- "type": "/Microsoft.DesktopVirtualization/hostPools",
+ "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostPool1",
+ "type": "/Microsoft.DesktopVirtualization/hostpools",
"location": "centralus",
"tags": {
"key1": "value1",
@@ -31,7 +31,8 @@
"token": "token",
"registrationTokenOperation": "Update"
},
- "ssoContext": "KeyVaultPath"
+ "vmTemplate": "{json:json}",
+ "ssoContext": null
}
},
"204": {}
diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/HostPool_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/HostPool_Get.json
index fb86c3da15ee..175c4fef704e 100644
--- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/HostPool_Get.json
+++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/HostPool_Get.json
@@ -9,8 +9,8 @@
"200": {
"body": {
"name": "hostPool1",
- "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1",
- "type": "/Microsoft.DesktopVirtualization/hostPools",
+ "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostPool1",
+ "type": "/Microsoft.DesktopVirtualization/hostpools",
"location": "centralus",
"tags": {
"key1": "value1",
@@ -31,7 +31,8 @@
"token": "token",
"registrationTokenOperation": "Update"
},
- "ssoContext": "KeyVaultPath",
+ "vmTemplate": "{json:json}",
+ "ssoContext": null,
"preferredAppGroupType": "Desktop"
}
}
diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/HostPool_List.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/HostPool_List.json
index 69ef8301a370..302dcc34c598 100644
--- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/HostPool_List.json
+++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/HostPool_List.json
@@ -9,8 +9,8 @@
"value": [
{
"name": "hostPool1",
- "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1",
- "type": "/Microsoft.DesktopVirtualization/hostPools",
+ "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostPool1",
+ "type": "/Microsoft.DesktopVirtualization/hostpools",
"location": "centralus",
"tags": {
"key1": "value1",
@@ -31,14 +31,15 @@
"token": "token",
"registrationTokenOperation": "Update"
},
- "ssoContext": "KeyVaultPath",
+ "vmTemplate": "{json:json}",
+ "ssoContext": null,
"preferredAppGroupType": "Desktop"
}
},
{
"name": "hostPool2",
- "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool2",
- "type": "/Microsoft.DesktopVirtualization/hostPools",
+ "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostPool2",
+ "type": "/Microsoft.DesktopVirtualization/hostpools",
"location": "centralus",
"tags": {
"key1": "value1",
@@ -59,7 +60,8 @@
"token": "token",
"registrationTokenOperation": "Update"
},
- "ssoContext": "KeyVaultPath",
+ "vmTemplate": "{json:json}",
+ "ssoContext": null,
"preferredAppGroupType": "Desktop"
}
}
diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/HostPool_ListByResourceGroup.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/HostPool_ListByResourceGroup.json
index 933bf9839591..6ae671b69976 100644
--- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/HostPool_ListByResourceGroup.json
+++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/HostPool_ListByResourceGroup.json
@@ -10,8 +10,8 @@
"value": [
{
"name": "hostPool1",
- "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1",
- "type": "/Microsoft.DesktopVirtualization/hostPools",
+ "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostPool1",
+ "type": "/Microsoft.DesktopVirtualization/hostpools",
"location": "centralus",
"tags": {
"key1": "value1",
@@ -32,14 +32,15 @@
"token": "token",
"registrationTokenOperation": "Update"
},
- "ssoContext": "KeyVaultPath",
+ "vmTemplate": "{json:json}",
+ "ssoContext": null,
"preferredAppGroupType": "Desktop"
}
},
{
"name": "hostPool2",
- "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool2",
- "type": "/Microsoft.DesktopVirtualization/hostPools",
+ "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostPool2",
+ "type": "/Microsoft.DesktopVirtualization/hostpools",
"location": "centralus",
"tags": {
"key1": "value1",
@@ -60,7 +61,8 @@
"token": "token",
"registrationTokenOperation": "Update"
},
- "ssoContext": "KeyVaultPath",
+ "vmTemplate": "{json:json}",
+ "ssoContext": null,
"preferredAppGroupType": "Desktop"
}
}
diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/HostPool_Update.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/HostPool_Update.json
index 833bf8716bbf..c885b024272c 100644
--- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/HostPool_Update.json
+++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/HostPool_Update.json
@@ -20,6 +20,7 @@
"expirationTime": "2020-10-01T15:01:54.9571247Z",
"registrationTokenOperation": "Update"
},
+ "vmTemplate": "{json:json}",
"ssoContext": "KeyVaultPath"
}
}
@@ -28,8 +29,8 @@
"200": {
"body": {
"name": "hostPool1",
- "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1",
- "type": "/Microsoft.DesktopVirtualization/hostPools",
+ "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostPool1",
+ "type": "/Microsoft.DesktopVirtualization/hostpools",
"location": "centralus",
"tags": {
"key1": "value1",
@@ -50,7 +51,8 @@
"token": "token",
"registrationTokenOperation": "Update"
},
- "ssoContext": "KeyVaultPath",
+ "vmTemplate": "{json:json}",
+ "ssoContext": null,
"preferredAppGroupType": "Desktop"
}
}
diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/SessionHost_Delete.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/SessionHost_Delete.json
index 12cae16ead92..8961354c5283 100644
--- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/SessionHost_Delete.json
+++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/SessionHost_Delete.json
@@ -10,7 +10,7 @@
"responses": {
"200": {
"name": "sessionHost1.microsoft.com",
- "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHosts/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": {
"lastHeartBeat": "2008-09-22T14:01:54.9571247Z",
@@ -26,7 +26,7 @@
"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"
+ "resourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.Compute/virtualMachines/sessionHost1"
}
},
"204": {}
diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/SessionHost_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/SessionHost_Get.json
index 7c4fc2180b4b..1006aadcae10 100644
--- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/SessionHost_Get.json
+++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/SessionHost_Get.json
@@ -10,7 +10,7 @@
"200": {
"body": {
"name": "sessionHost1.microsoft.com",
- "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHosts/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": {
"lastHeartBeat": "2008-09-22T14:01:54.9571247Z",
@@ -26,7 +26,7 @@
"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"
+ "resourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.Compute/virtualMachines/sessionHost1"
}
}
}
diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/SessionHost_List.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/SessionHost_List.json
index 12ba5cafb4f2..f683f51f839e 100644
--- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/SessionHost_List.json
+++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/SessionHost_List.json
@@ -11,7 +11,7 @@
"value": [
{
"name": "sessionHost1.microsoft.com",
- "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHosts/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": {
"lastHeartBeat": "2008-09-22T14:01:54.9571247Z",
@@ -27,12 +27,12 @@
"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"
+ "resourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.Compute/virtualMachines/sessionHost1"
}
},
{
"name": "sessionHost2.microsoft.com",
- "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHosts/sessionHost2microsoft.com",
+ "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostPool1/sessionHosts/sessionHost2microsoft.com",
"type": "Microsoft.DesktopVirtualization/hostPools/sessionhosts",
"properties": {
"lastHeartBeat": "2008-09-22T14:01:54.9571247Z",
@@ -48,7 +48,7 @@
"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"
+ "resourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.Compute/virtualMachines/sessionHost2"
}
}
]
diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/SessionHost_Update.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/SessionHost_Update.json
index 9353b6accd08..41356917763b 100644
--- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/SessionHost_Update.json
+++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/SessionHost_Update.json
@@ -16,7 +16,7 @@
"200": {
"body": {
"name": "sessionHost1.microsoft.com",
- "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHosts/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": {
"lastHeartBeat": "2019-01-11T19:27:13.6108027Z",
@@ -32,7 +32,7 @@
"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"
+ "resourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.Compute/virtualMachines/sessionHost1"
}
}
}
diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/StartMenuItem_List.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/StartMenuItem_List.json
index afd698213ed8..fa4017a89b86 100644
--- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/StartMenuItem_List.json
+++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/StartMenuItem_List.json
@@ -11,7 +11,7 @@
"value": [
{
"name": "application1",
- "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/startMenuItem/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",
@@ -24,7 +24,7 @@
},
{
"name": "application2",
- "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/startMenuItem/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",
diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/UserSession_Delete.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/UserSession_Delete.json
index da8cd8ae4bfb..ee13e7555380 100644
--- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/UserSession_Delete.json
+++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/UserSession_Delete.json
@@ -11,7 +11,7 @@
"responses": {
"200": {
"name": "1",
- "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHosts/sessionHost1.microsoft.com/userSessions/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": {
"userPrincipalName": "user1@microsoft.com",
diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/UserSession_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/UserSession_Get.json
index 06aac45ba81e..ad30b313730e 100644
--- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/UserSession_Get.json
+++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/UserSession_Get.json
@@ -11,7 +11,7 @@
"200": {
"body": {
"name": "1",
- "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHosts/sessionHost1.microsoft.com/userSessions/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": {
"userPrincipalName": "user1@microsoft.com",
diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/UserSession_List.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/UserSession_List.json
index cef72db2561d..771a4b13da70 100644
--- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/UserSession_List.json
+++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/UserSession_List.json
@@ -12,7 +12,7 @@
"value": [
{
"name": "1",
- "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHosts/sessionHost1.microsoft.com/userSessions/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": {
"userPrincipalName": "user1@microsoft.com",
@@ -24,7 +24,7 @@
},
{
"name": "2",
- "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHosts/sessionHost1.microsoft.com/userSessions/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": {
"userPrincipalName": "user1@microsoft.com",
diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/UserSession_ListByHostPool.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/UserSession_ListByHostPool.json
index 1c39908d8349..f6d1edc1f4dc 100644
--- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/UserSession_ListByHostPool.json
+++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/UserSession_ListByHostPool.json
@@ -12,7 +12,7 @@
"value": [
{
"name": "1",
- "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHosts/sessionHost1.microsoft.com/userSessions/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": {
"userPrincipalName": "user1@microsoft.com",
@@ -24,7 +24,7 @@
},
{
"name": "2",
- "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHosts/sessionHost1.microsoft.com/userSessions/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": {
"userPrincipalName": "user1@microsoft.com",
diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/Workspace_Create.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/Workspace_Create.json
index 7085ade8ceed..ff6de1e47064 100644
--- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/Workspace_Create.json
+++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/Workspace_Create.json
@@ -20,7 +20,7 @@
"200": {
"body": {
"name": "workspace1",
- "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1",
+ "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1",
"type": "Microsoft.DesktopVirtualization/workspaces",
"location": "centralus",
"tags": {
@@ -36,7 +36,7 @@
"201": {
"body": {
"name": "workspace1",
- "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1",
+ "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1",
"type": "Microsoft.DesktopVirtualization/workspaces",
"location": "centralus",
"tags": {
diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/Workspace_Delete.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/Workspace_Delete.json
index 2048117807aa..b1fac0b29d22 100644
--- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/Workspace_Delete.json
+++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/Workspace_Delete.json
@@ -8,7 +8,7 @@
"responses": {
"200": {
"name": "workspace1",
- "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1",
+ "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1",
"type": "Microsoft.DesktopVirtualization/workspaces",
"location": "centralus",
"tags": {
diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/Workspace_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/Workspace_Get.json
index dc613edd408b..96cec1aa7acf 100644
--- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/Workspace_Get.json
+++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/Workspace_Get.json
@@ -9,7 +9,7 @@
"200": {
"body": {
"name": "workspace1",
- "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1",
+ "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1",
"type": "Microsoft.DesktopVirtualization/workspaces",
"location": "centralus",
"tags": {
diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/Workspace_ListByResourceGroup.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/Workspace_ListByResourceGroup.json
index 6f6dc3ad0de8..2988972d0e2f 100644
--- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/Workspace_ListByResourceGroup.json
+++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/Workspace_ListByResourceGroup.json
@@ -10,7 +10,7 @@
"value": [
{
"name": "workspace1",
- "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1",
+ "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1",
"type": "Microsoft.DesktopVirtualization/workspaces",
"location": "centralus",
"tags": {
@@ -24,7 +24,7 @@
},
{
"name": "workspace2",
- "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace2",
+ "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace2",
"type": "Microsoft.DesktopVirtualization/workspaces",
"location": "centralus",
"tags": {
diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/Workspace_ListBySubscription.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/Workspace_ListBySubscription.json
index 79ec5eea61dd..49f61942a4ff 100644
--- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/Workspace_ListBySubscription.json
+++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/Workspace_ListBySubscription.json
@@ -9,7 +9,7 @@
"value": [
{
"name": "workspace1",
- "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1",
+ "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1",
"type": "Microsoft.DesktopVirtualization/workspaces",
"location": "centralus",
"tags": {
@@ -23,7 +23,7 @@
},
{
"name": "workspace2",
- "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace2",
+ "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace2",
"type": "Microsoft.DesktopVirtualization/workspaces",
"location": "centralus",
"tags": {
diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/Workspace_Update.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/Workspace_Update.json
index 33060dc90353..bd3f747371af 100644
--- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/Workspace_Update.json
+++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/Workspace_Update.json
@@ -19,7 +19,7 @@
"200": {
"body": {
"name": "workspace1",
- "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1",
+ "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1",
"type": "Microsoft.DesktopVirtualization/workspaces",
"location": "centralus",
"tags": {
diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2020-09-21-preview/desktopvirtualization.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2020-09-21-preview/desktopvirtualization.json
new file mode 100644
index 000000000000..3e0591c48caf
--- /dev/null
+++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2020-09-21-preview/desktopvirtualization.json
@@ -0,0 +1,3732 @@
+{
+ "swagger": "2.0",
+ "info": {
+ "version": "2020-09-21-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"
+ }
+ }
+ }
+ }
+ },
+ "/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/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}/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"
+ }
+ }
+ }
+ }
+ }
+ },
+ "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"
+ }
+ }
+ }
+ }
+ },
+ "Workspace": {
+ "type": "object",
+ "description": "Represents a Workspace definition.",
+ "allOf": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/TrackedResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "description": "Detailed properties for Workspace",
+ "x-ms-client-flatten": true,
+ "$ref": "#/definitions/WorkspaceProperties"
+ }
+ }
+ },
+ "WorkspaceProperties": {
+ "description": "Schema for Workspace properties.",
+ "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 resource Ids.",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "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/TrackedResource"
+ }
+ ],
+ "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": {
+ "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
+ }
+ }
+ },
+ "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/TrackedResource"
+ }
+ ],
+ "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": {
+ "friendlyName": {
+ "type": "string",
+ "description": "Friendly name of HostPool."
+ },
+ "description": {
+ "type": "string",
+ "description": "Description of HostPool."
+ },
+ "hostPoolType": {
+ "enum": [
+ "Personal",
+ "Pooled"
+ ],
+ "x-ms-enum": {
+ "name": "HostPoolType",
+ "modelAsString": true
+ },
+ "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.",
+ "x-nullable": false
+ },
+ "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"
+ }
+ },
+ "ssoContext": {
+ "type": "string",
+ "description": "Path to keyvault containing ssoContext secret."
+ },
+ "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
+ }
+ }
+ },
+ "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."
+ },
+ "ssoContext": {
+ "type": "string",
+ "description": "Path to keyvault containing ssoContext secret."
+ },
+ "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"
+ }
+ }
+ },
+ "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": {
+ "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": {
+ "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."
+ },
+ "friendlyName": {
+ "type": "string",
+ "description": "Friendly name 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": {
+ "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"
+ ],
+ "x-ms-enum": {
+ "name": "Status",
+ "modelAsString": true
+ },
+ "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."
+ }
+ }
+ },
+ "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": {
+ "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."
+ }
+ }
+ }
+ },
+ "parameters": {
+ "HostPoolNameParameter": {
+ "name": "hostPoolName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the host pool within the specified resource group",
+ "maxLength": 24,
+ "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": 24,
+ "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": 24,
+ "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"
+ }
+ }
+}
diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2020-09-21-preview/examples/ApplicationGroup_Create.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2020-09-21-preview/examples/ApplicationGroup_Create.json
new file mode 100644
index 000000000000..5ce43eb4a623
--- /dev/null
+++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2020-09-21-preview/examples/ApplicationGroup_Create.json
@@ -0,0 +1,61 @@
+{
+ "parameters": {
+ "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa",
+ "resourceGroupName": "resourceGroup1",
+ "applicationGroupName": "applicationGroup1",
+ "api-version": "2020-09-21-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"
+ }
+ }
+ },
+ "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": {
+ "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"
+ }
+ }
+ },
+ "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": {
+ "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"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2020-09-21-preview/examples/ApplicationGroup_Delete.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2020-09-21-preview/examples/ApplicationGroup_Delete.json
new file mode 100644
index 000000000000..79cbe2e56f03
--- /dev/null
+++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2020-09-21-preview/examples/ApplicationGroup_Delete.json
@@ -0,0 +1,28 @@
+{
+ "parameters": {
+ "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa",
+ "resourceGroupName": "resourceGroup1",
+ "applicationGroupName": "applicationGroup1",
+ "api-version": "2020-09-21-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"
+ },
+ "properties": {
+ "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"
+ }
+ },
+ "204": {}
+ }
+}
diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2020-09-21-preview/examples/ApplicationGroup_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2020-09-21-preview/examples/ApplicationGroup_Get.json
new file mode 100644
index 000000000000..c6bd8f15a1ab
--- /dev/null
+++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2020-09-21-preview/examples/ApplicationGroup_Get.json
@@ -0,0 +1,29 @@
+{
+ "parameters": {
+ "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa",
+ "resourceGroupName": "resourceGroup1",
+ "applicationGroupName": "applicationGroup1",
+ "api-version": "2020-09-21-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"
+ },
+ "properties": {
+ "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"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2020-09-21-preview/examples/ApplicationGroup_ListByResourceGroup.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2020-09-21-preview/examples/ApplicationGroup_ListByResourceGroup.json
new file mode 100644
index 000000000000..4c8752cfd907
--- /dev/null
+++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2020-09-21-preview/examples/ApplicationGroup_ListByResourceGroup.json
@@ -0,0 +1,50 @@
+{
+ "parameters": {
+ "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa",
+ "resourceGroupName": "resourceGroup1",
+ "api-version": "2020-09-21-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"
+ },
+ "properties": {
+ "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"
+ }
+ },
+ {
+ "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": {
+ "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"
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2020-09-21-preview/examples/ApplicationGroup_ListBySubscription.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2020-09-21-preview/examples/ApplicationGroup_ListBySubscription.json
new file mode 100644
index 000000000000..0c785da96edf
--- /dev/null
+++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2020-09-21-preview/examples/ApplicationGroup_ListBySubscription.json
@@ -0,0 +1,49 @@
+{
+ "parameters": {
+ "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa",
+ "api-version": "2020-09-21-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"
+ },
+ "properties": {
+ "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"
+ }
+ },
+ {
+ "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": {
+ "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"
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2020-09-21-preview/examples/ApplicationGroup_Update.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2020-09-21-preview/examples/ApplicationGroup_Update.json
new file mode 100644
index 000000000000..5defdb76250a
--- /dev/null
+++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2020-09-21-preview/examples/ApplicationGroup_Update.json
@@ -0,0 +1,39 @@
+{
+ "parameters": {
+ "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa",
+ "resourceGroupName": "resourceGroup1",
+ "applicationGroupName": "applicationGroup1",
+ "api-version": "2020-09-21-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"
+ },
+ "properties": {
+ "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"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2020-09-21-preview/examples/Application_Create.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2020-09-21-preview/examples/Application_Create.json
new file mode 100644
index 000000000000..29fe74aa3cdc
--- /dev/null
+++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2020-09-21-preview/examples/Application_Create.json
@@ -0,0 +1,67 @@
+{
+ "parameters": {
+ "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa",
+ "resourceGroupName": "resourceGroup1",
+ "applicationGroupName": "applicationGroup1",
+ "applicationName": "application1",
+ "api-version": "2020-09-21-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",
+ "properties": {
+ "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": {
+ "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/2020-09-21-preview/examples/Application_Delete.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2020-09-21-preview/examples/Application_Delete.json
new file mode 100644
index 000000000000..9425384b6d4b
--- /dev/null
+++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2020-09-21-preview/examples/Application_Delete.json
@@ -0,0 +1,32 @@
+{
+ "parameters": {
+ "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa",
+ "resourceGroupName": "resourceGroup1",
+ "applicationGroupName": "applicationGroup1",
+ "applicationName": "application1",
+ "api-version": "2020-09-21-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",
+ "properties": {
+ "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/2020-09-21-preview/examples/Application_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2020-09-21-preview/examples/Application_Get.json
new file mode 100644
index 000000000000..bd2bf92136a7
--- /dev/null
+++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2020-09-21-preview/examples/Application_Get.json
@@ -0,0 +1,33 @@
+{
+ "parameters": {
+ "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa",
+ "resourceGroupName": "resourceGroup1",
+ "applicationGroupName": "applicationGroup1",
+ "applicationName": "application1",
+ "api-version": "2020-09-21-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",
+ "properties": {
+ "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/2020-09-21-preview/examples/Application_List.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2020-09-21-preview/examples/Application_List.json
new file mode 100644
index 000000000000..a1f13464dbdc
--- /dev/null
+++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2020-09-21-preview/examples/Application_List.json
@@ -0,0 +1,56 @@
+{
+ "parameters": {
+ "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa",
+ "resourceGroupName": "resourceGroup1",
+ "applicationGroupName": "applicationGroup1",
+ "api-version": "2020-09-21-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",
+ "properties": {
+ "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": {
+ "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/2020-09-21-preview/examples/Application_Update.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2020-09-21-preview/examples/Application_Update.json
new file mode 100644
index 000000000000..1423f5d29c2b
--- /dev/null
+++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2020-09-21-preview/examples/Application_Update.json
@@ -0,0 +1,48 @@
+{
+ "parameters": {
+ "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa",
+ "resourceGroupName": "resourceGroup1",
+ "applicationGroupName": "applicationGroup1",
+ "applicationName": "application1",
+ "api-version": "2020-09-21-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",
+ "properties": {
+ "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/2020-09-21-preview/examples/Desktop_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2020-09-21-preview/examples/Desktop_Get.json
new file mode 100644
index 000000000000..78a8f7dd271a
--- /dev/null
+++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2020-09-21-preview/examples/Desktop_Get.json
@@ -0,0 +1,24 @@
+{
+ "parameters": {
+ "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa",
+ "resourceGroupName": "resourceGroup1",
+ "applicationGroupName": "applicationGroup1",
+ "desktopName": "SessionDesktop",
+ "api-version": "2020-09-21-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",
+ "properties": {
+ "description": "des1",
+ "friendlyName": "friendly",
+ "iconHash": "bEQ1n2HysrGxCDvgt4bfOtkET8ydzh5SXGM0KGTBPVc",
+ "iconContent": "AAABAAgAAAAAAAEAIAA7MwAAhgAAAEBAAAABACAAKEIAAMEzAAAwMAAAAQAgAKglAADpdQAAKCgAAAEA..."
+ }
+ }
+ }
+ }
+}
diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2020-09-21-preview/examples/Desktop_List.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2020-09-21-preview/examples/Desktop_List.json
new file mode 100644
index 000000000000..8511620d8c2e
--- /dev/null
+++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2020-09-21-preview/examples/Desktop_List.json
@@ -0,0 +1,27 @@
+{
+ "parameters": {
+ "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa",
+ "resourceGroupName": "resourceGroup1",
+ "applicationGroupName": "applicationGroup1",
+ "api-version": "2020-09-21-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",
+ "properties": {
+ "description": "des1",
+ "friendlyName": "friendly",
+ "iconHash": "bEQ1n2HysrGxCDvgt4bfOtkET8ydzh5SXGM0KGTBPVc",
+ "iconContent": "AAABAAgAAAAAAAEAIAA7MwAAhgAAAEBAAAABACAAKEIAAMEzAAAwMAAAAQAgAKglAADpdQAAKCgAAAEA..."
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2020-09-21-preview/examples/Desktop_Update.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2020-09-21-preview/examples/Desktop_Update.json
new file mode 100644
index 000000000000..a1c16b59f669
--- /dev/null
+++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2020-09-21-preview/examples/Desktop_Update.json
@@ -0,0 +1,30 @@
+{
+ "parameters": {
+ "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa",
+ "resourceGroupName": "resourceGroup1",
+ "applicationGroupName": "applicationGroup1",
+ "desktopName": "SessionDesktop",
+ "api-version": "2020-09-21-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",
+ "properties": {
+ "description": "des1",
+ "friendlyName": "friendly",
+ "iconHash": "bEQ1n2HysrGxCDvgt4bfOtkET8ydzh5SXGM0KGTBPVc",
+ "iconContent": "AAABAAgAAAAAAAEAIAA7MwAAhgAAAEBAAAABACAAKEIAAMEzAAAwMAAAAQAgAKglAADpdQAAKCgAAAEA..."
+ }
+ }
+ }
+ }
+}
diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2020-09-21-preview/examples/HostPool_Create.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2020-09-21-preview/examples/HostPool_Create.json
new file mode 100644
index 000000000000..21ab2ac34e18
--- /dev/null
+++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2020-09-21-preview/examples/HostPool_Create.json
@@ -0,0 +1,92 @@
+{
+ "parameters": {
+ "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa",
+ "resourceGroupName": "resourceGroup1",
+ "hostPoolName": "hostPool1",
+ "api-version": "2020-09-21-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"
+ },
+ "ssoContext": "KeyVaultPath",
+ "preferredAppGroupType": "Desktop"
+ }
+ }
+ },
+ "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": {
+ "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"
+ },
+ "ssoContext": "KeyVaultPath",
+ "preferredAppGroupType": "Desktop"
+ }
+ }
+ },
+ "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": {
+ "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"
+ },
+ "ssoContext": "KeyVaultPath",
+ "preferredAppGroupType": "Desktop"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2020-09-21-preview/examples/HostPool_Delete.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2020-09-21-preview/examples/HostPool_Delete.json
new file mode 100644
index 000000000000..d126268a6f01
--- /dev/null
+++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2020-09-21-preview/examples/HostPool_Delete.json
@@ -0,0 +1,39 @@
+{
+ "parameters": {
+ "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa",
+ "resourceGroupName": "resourceGroup1",
+ "hostPoolName": "hostPool1",
+ "api-version": "2020-09-21-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"
+ },
+ "properties": {
+ "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"
+ },
+ "ssoContext": "KeyVaultPath"
+ }
+ },
+ "204": {}
+ }
+}
diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2020-09-21-preview/examples/HostPool_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2020-09-21-preview/examples/HostPool_Get.json
new file mode 100644
index 000000000000..200848de43ad
--- /dev/null
+++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2020-09-21-preview/examples/HostPool_Get.json
@@ -0,0 +1,40 @@
+{
+ "parameters": {
+ "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa",
+ "resourceGroupName": "resourceGroup1",
+ "hostPoolName": "hostPool1",
+ "api-version": "2020-09-21-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"
+ },
+ "properties": {
+ "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"
+ },
+ "ssoContext": "KeyVaultPath",
+ "preferredAppGroupType": "Desktop"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2020-09-21-preview/examples/HostPool_List.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2020-09-21-preview/examples/HostPool_List.json
new file mode 100644
index 000000000000..8129f33a3970
--- /dev/null
+++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2020-09-21-preview/examples/HostPool_List.json
@@ -0,0 +1,70 @@
+{
+ "parameters": {
+ "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa",
+ "api-version": "2020-09-21-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"
+ },
+ "properties": {
+ "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"
+ },
+ "ssoContext": "KeyVaultPath",
+ "preferredAppGroupType": "Desktop"
+ }
+ },
+ {
+ "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": {
+ "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"
+ },
+ "ssoContext": "KeyVaultPath",
+ "preferredAppGroupType": "Desktop"
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2020-09-21-preview/examples/HostPool_ListByResourceGroup.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2020-09-21-preview/examples/HostPool_ListByResourceGroup.json
new file mode 100644
index 000000000000..bb9a9d6df4d4
--- /dev/null
+++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2020-09-21-preview/examples/HostPool_ListByResourceGroup.json
@@ -0,0 +1,71 @@
+{
+ "parameters": {
+ "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa",
+ "resourceGroupName": "resourceGroup1",
+ "api-version": "2020-09-21-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"
+ },
+ "properties": {
+ "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"
+ },
+ "ssoContext": "KeyVaultPath",
+ "preferredAppGroupType": "Desktop"
+ }
+ },
+ {
+ "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": {
+ "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"
+ },
+ "ssoContext": "KeyVaultPath",
+ "preferredAppGroupType": "Desktop"
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2020-09-21-preview/examples/HostPool_Update.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2020-09-21-preview/examples/HostPool_Update.json
new file mode 100644
index 000000000000..7a6bd475ab02
--- /dev/null
+++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2020-09-21-preview/examples/HostPool_Update.json
@@ -0,0 +1,59 @@
+{
+ "parameters": {
+ "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa",
+ "resourceGroupName": "resourceGroup1",
+ "hostPoolName": "hostPool1",
+ "api-version": "2020-09-21-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"
+ },
+ "ssoContext": "KeyVaultPath"
+ }
+ }
+ },
+ "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": {
+ "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"
+ },
+ "ssoContext": "KeyVaultPath",
+ "preferredAppGroupType": "Desktop"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2020-09-21-preview/examples/MsixImage_Expand_Post.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2020-09-21-preview/examples/MsixImage_Expand_Post.json
new file mode 100644
index 000000000000..60dfe53e0983
--- /dev/null
+++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2020-09-21-preview/examples/MsixImage_Expand_Post.json
@@ -0,0 +1,99 @@
+{
+ "parameters": {
+ "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa",
+ "resourceGroupName": "resourceGroup1",
+ "hostPoolName": "hostpool1",
+ "api-version": "2020-09-21-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/2020-09-21-preview/examples/MsixPackage_Create.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2020-09-21-preview/examples/MsixPackage_Create.json
new file mode 100644
index 000000000000..532cd6ff86d3
--- /dev/null
+++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2020-09-21-preview/examples/MsixPackage_Create.json
@@ -0,0 +1,114 @@
+{
+ "parameters": {
+ "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa",
+ "resourceGroupName": "resourceGroup1",
+ "hostPoolName": "hostpool1",
+ "api-version": "2020-09-21-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",
+ "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/preview/2020-09-21-preview/examples/MsixPackage_Delete.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2020-09-21-preview/examples/MsixPackage_Delete.json
new file mode 100644
index 000000000000..9dad5a645731
--- /dev/null
+++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2020-09-21-preview/examples/MsixPackage_Delete.json
@@ -0,0 +1,46 @@
+{
+ "parameters": {
+ "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa",
+ "resourceGroupName": "resourceGroup1",
+ "hostPoolName": "hostpool1",
+ "api-version": "2020-09-21-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",
+ "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/2020-09-21-preview/examples/MsixPackage_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2020-09-21-preview/examples/MsixPackage_Get.json
new file mode 100644
index 000000000000..94d954d575bf
--- /dev/null
+++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2020-09-21-preview/examples/MsixPackage_Get.json
@@ -0,0 +1,47 @@
+{
+ "parameters": {
+ "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa",
+ "resourceGroupName": "resourceGroup1",
+ "hostPoolName": "hostpool1",
+ "api-version": "2020-09-21-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",
+ "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/2020-09-21-preview/examples/MsixPackage_List.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2020-09-21-preview/examples/MsixPackage_List.json
new file mode 100644
index 000000000000..7fdead2582c4
--- /dev/null
+++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2020-09-21-preview/examples/MsixPackage_List.json
@@ -0,0 +1,84 @@
+{
+ "parameters": {
+ "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa",
+ "resourceGroupName": "resourceGroup1",
+ "hostPoolName": "hostpool1",
+ "api-version": "2020-09-21-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",
+ "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/preview/2020-09-21-preview/examples/MsixPackage_Update.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2020-09-21-preview/examples/MsixPackage_Update.json
new file mode 100644
index 000000000000..5e1cba8582be
--- /dev/null
+++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2020-09-21-preview/examples/MsixPackage_Update.json
@@ -0,0 +1,54 @@
+{
+ "parameters": {
+ "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa",
+ "resourceGroupName": "resourceGroup1",
+ "hostPoolName": "hostpool1",
+ "api-version": "2020-09-21-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",
+ "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/2020-09-21-preview/examples/OperationDescription_List.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2020-09-21-preview/examples/OperationDescription_List.json
new file mode 100644
index 000000000000..b9e1a66404fc
--- /dev/null
+++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2020-09-21-preview/examples/OperationDescription_List.json
@@ -0,0 +1,27 @@
+{
+ "parameters": {
+ "api-version": "2020-09-21-preview"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "name": "Microsoft.DesktopVirtualization/ssocontext/read",
+ "display": {
+ "provider": "Microsoft.DesktopVirtualization",
+ "resource": "ssocontext"
+ }
+ },
+ {
+ "name": "Microsoft.DesktopVirtualization/ssocontext/write",
+ "display": {
+ "provider": "Microsoft.DesktopVirtualization",
+ "resource": "ssocontext"
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2020-09-21-preview/examples/SessionHost_Delete.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2020-09-21-preview/examples/SessionHost_Delete.json
new file mode 100644
index 000000000000..5112fe0f16fa
--- /dev/null
+++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2020-09-21-preview/examples/SessionHost_Delete.json
@@ -0,0 +1,34 @@
+{
+ "parameters": {
+ "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa",
+ "resourceGroupName": "resourceGroup1",
+ "hostPoolName": "hostPool1",
+ "sessionHostName": "sessionHost1.microsoft.com",
+ "api-version": "2020-09-21-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",
+ "properties": {
+ "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"
+ }
+ },
+ "204": {}
+ }
+}
diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2020-09-21-preview/examples/SessionHost_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2020-09-21-preview/examples/SessionHost_Get.json
new file mode 100644
index 000000000000..a03c5581e0da
--- /dev/null
+++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2020-09-21-preview/examples/SessionHost_Get.json
@@ -0,0 +1,34 @@
+{
+ "parameters": {
+ "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa",
+ "resourceGroupName": "resourceGroup1",
+ "hostPoolName": "hostPool1",
+ "sessionHostName": "sessionHost1.microsoft.com",
+ "api-version": "2020-09-21-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",
+ "properties": {
+ "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"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2020-09-21-preview/examples/SessionHost_List.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2020-09-21-preview/examples/SessionHost_List.json
new file mode 100644
index 000000000000..4e8b0823fa0b
--- /dev/null
+++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2020-09-21-preview/examples/SessionHost_List.json
@@ -0,0 +1,58 @@
+{
+ "parameters": {
+ "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa",
+ "resourceGroupName": "resourceGroup1",
+ "hostPoolName": "hostPool1",
+ "api-version": "2020-09-21-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",
+ "properties": {
+ "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"
+ }
+ },
+ {
+ "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": {
+ "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"
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2020-09-21-preview/examples/SessionHost_Update.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2020-09-21-preview/examples/SessionHost_Update.json
new file mode 100644
index 000000000000..5a4c48c815de
--- /dev/null
+++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2020-09-21-preview/examples/SessionHost_Update.json
@@ -0,0 +1,40 @@
+{
+ "parameters": {
+ "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa",
+ "resourceGroupName": "resourceGroup1",
+ "hostPoolName": "hostPool1",
+ "sessionHostName": "sessionHost1.microsoft.com",
+ "api-version": "2020-09-21-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",
+ "properties": {
+ "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"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2020-09-21-preview/examples/StartMenuItem_List.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2020-09-21-preview/examples/StartMenuItem_List.json
new file mode 100644
index 000000000000..2e1ee505febf
--- /dev/null
+++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2020-09-21-preview/examples/StartMenuItem_List.json
@@ -0,0 +1,42 @@
+{
+ "parameters": {
+ "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa",
+ "resourceGroupName": "resourceGroup1",
+ "applicationGroupName": "applicationGroup1",
+ "api-version": "2020-09-21-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",
+ "friendlyName": "friendly",
+ "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",
+ "friendlyName": "friendly",
+ "filePath": "/path/to/file",
+ "commandLineArguments": "arguments",
+ "iconPath": "/path/to/icon",
+ "iconIndex": 1
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2020-09-21-preview/examples/UserSession_Delete.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2020-09-21-preview/examples/UserSession_Delete.json
new file mode 100644
index 000000000000..c4261c0d8203
--- /dev/null
+++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2020-09-21-preview/examples/UserSession_Delete.json
@@ -0,0 +1,26 @@
+{
+ "parameters": {
+ "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa",
+ "resourceGroupName": "resourceGroup1",
+ "hostPoolName": "hostPool1",
+ "sessionHostName": "sessionHost1.microsoft.com",
+ "userSessionId": "1",
+ "api-version": "2020-09-21-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",
+ "properties": {
+ "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/2020-09-21-preview/examples/UserSession_Disconnect_Post.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2020-09-21-preview/examples/UserSession_Disconnect_Post.json
new file mode 100644
index 000000000000..28323231cddf
--- /dev/null
+++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2020-09-21-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": "2020-09-21-preview"
+ },
+ "responses": {
+ "200": {}
+ }
+}
diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2020-09-21-preview/examples/UserSession_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2020-09-21-preview/examples/UserSession_Get.json
new file mode 100644
index 000000000000..171c9cf924da
--- /dev/null
+++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2020-09-21-preview/examples/UserSession_Get.json
@@ -0,0 +1,26 @@
+{
+ "parameters": {
+ "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa",
+ "resourceGroupName": "resourceGroup1",
+ "hostPoolName": "hostPool1",
+ "sessionHostName": "sessionHost1.microsoft.com",
+ "userSessionId": "1",
+ "api-version": "2020-09-21-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",
+ "properties": {
+ "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/2020-09-21-preview/examples/UserSession_List.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2020-09-21-preview/examples/UserSession_List.json
new file mode 100644
index 000000000000..88291383018e
--- /dev/null
+++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2020-09-21-preview/examples/UserSession_List.json
@@ -0,0 +1,41 @@
+{
+ "parameters": {
+ "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa",
+ "resourceGroupName": "resourceGroup1",
+ "hostPoolName": "hostPool1",
+ "sessionHostName": "sessionHost1.microsoft.com",
+ "api-version": "2020-09-21-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",
+ "properties": {
+ "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": {
+ "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/2020-09-21-preview/examples/UserSession_ListByHostPool.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2020-09-21-preview/examples/UserSession_ListByHostPool.json
new file mode 100644
index 000000000000..7ce285f3bec7
--- /dev/null
+++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2020-09-21-preview/examples/UserSession_ListByHostPool.json
@@ -0,0 +1,41 @@
+{
+ "parameters": {
+ "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa",
+ "resourceGroupName": "resourceGroup1",
+ "hostPoolName": "hostPool1",
+ "api-version": "2020-09-21-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",
+ "properties": {
+ "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": {
+ "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/2020-09-21-preview/examples/UserSession_SendMessage_Post.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2020-09-21-preview/examples/UserSession_SendMessage_Post.json
new file mode 100644
index 000000000000..dcb09cd5b6f8
--- /dev/null
+++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2020-09-21-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": "2020-09-21-preview",
+ "sendMessage": {
+ "messageTitle": "title",
+ "messageBody": "body"
+ }
+ },
+ "responses": {
+ "200": {}
+ }
+}
diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2020-09-21-preview/examples/Workspace_Create.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2020-09-21-preview/examples/Workspace_Create.json
new file mode 100644
index 000000000000..916e330d487c
--- /dev/null
+++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2020-09-21-preview/examples/Workspace_Create.json
@@ -0,0 +1,53 @@
+{
+ "parameters": {
+ "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa",
+ "resourceGroupName": "resourceGroup1",
+ "workspaceName": "workspace1",
+ "api-version": "2020-09-21-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"
+ },
+ "properties": {
+ "description": "des1",
+ "friendlyName": "friendly"
+ }
+ }
+ },
+ "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": {
+ "description": "des1",
+ "friendlyName": "friendly"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2020-09-21-preview/examples/Workspace_Delete.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2020-09-21-preview/examples/Workspace_Delete.json
new file mode 100644
index 000000000000..1c2020f4e608
--- /dev/null
+++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2020-09-21-preview/examples/Workspace_Delete.json
@@ -0,0 +1,25 @@
+{
+ "parameters": {
+ "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa",
+ "resourceGroupName": "resourceGroup1",
+ "workspaceName": "workspace1",
+ "api-version": "2020-09-21-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"
+ },
+ "properties": {
+ "description": "des1",
+ "friendlyName": "friendly"
+ }
+ },
+ "204": {}
+ }
+}
diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2020-09-21-preview/examples/Workspace_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2020-09-21-preview/examples/Workspace_Get.json
new file mode 100644
index 000000000000..d12e22e6de6d
--- /dev/null
+++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2020-09-21-preview/examples/Workspace_Get.json
@@ -0,0 +1,26 @@
+{
+ "parameters": {
+ "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa",
+ "resourceGroupName": "resourceGroup1",
+ "workspaceName": "workspace1",
+ "api-version": "2020-09-21-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"
+ },
+ "properties": {
+ "description": "des1",
+ "friendlyName": "friendly"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2020-09-21-preview/examples/Workspace_ListByResourceGroup.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2020-09-21-preview/examples/Workspace_ListByResourceGroup.json
new file mode 100644
index 000000000000..23904c4161cd
--- /dev/null
+++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2020-09-21-preview/examples/Workspace_ListByResourceGroup.json
@@ -0,0 +1,43 @@
+{
+ "parameters": {
+ "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa",
+ "resourceGroupName": "resourceGroup1",
+ "api-version": "2020-09-21-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"
+ },
+ "properties": {
+ "description": "des1",
+ "friendlyName": "friendly"
+ }
+ },
+ {
+ "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": {
+ "description": "des1",
+ "friendlyName": "friendly"
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2020-09-21-preview/examples/Workspace_ListBySubscription.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2020-09-21-preview/examples/Workspace_ListBySubscription.json
new file mode 100644
index 000000000000..a81eeec1dd00
--- /dev/null
+++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2020-09-21-preview/examples/Workspace_ListBySubscription.json
@@ -0,0 +1,42 @@
+{
+ "parameters": {
+ "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa",
+ "api-version": "2020-09-21-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"
+ },
+ "properties": {
+ "description": "des1",
+ "friendlyName": "friendly"
+ }
+ },
+ {
+ "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": {
+ "description": "des1",
+ "friendlyName": "friendly"
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2020-09-21-preview/examples/Workspace_Update.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2020-09-21-preview/examples/Workspace_Update.json
new file mode 100644
index 000000000000..5d7046c8047b
--- /dev/null
+++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2020-09-21-preview/examples/Workspace_Update.json
@@ -0,0 +1,36 @@
+{
+ "parameters": {
+ "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa",
+ "resourceGroupName": "resourceGroup1",
+ "workspaceName": "workspace1",
+ "api-version": "2020-09-21-preview",
+ "workspace": {
+ "tags": {
+ "tag1": "value1",
+ "tag2": "value2"
+ },
+ "properties": {
+ "description": "des1",
+ "friendlyName": "friendly"
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "name": "workspace1",
+ "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1",
+ "type": "Microsoft.DesktopVirtualization/workspaces",
+ "location": "centralus",
+ "tags": {
+ "key1": "value1",
+ "key2": "value2"
+ },
+ "properties": {
+ "description": "des1",
+ "friendlyName": "friendly"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/desktopvirtualization/resource-manager/readme.go.md b/specification/desktopvirtualization/resource-manager/readme.go.md
index c8527d1dc4fa..e4a606d6c6f5 100644
--- a/specification/desktopvirtualization/resource-manager/readme.go.md
+++ b/specification/desktopvirtualization/resource-manager/readme.go.md
@@ -15,6 +15,15 @@ batch:
- tag: package-2019-01-23-preview
- tag: package-2019-09-24-preview
- tag: package-2019-12-10-preview
+ - tag: package-2020-09-21-preview
+```
+### Tag: package-2020-09-21-preview and go
+
+These settings apply only when `--tag=package-2020-09-21-preview --go` is specified on the command line.
+Please also specify `--go-sdk-folder=`.
+
+``` yaml $(tag) == 'package-2020-09-21-preview' && $(go)
+output-folder: $(go-sdk-folder)/services/preview/$(namespace)/mgmt/2020-09-21-preview/$(namespace)
```
### Tag: package-2019-12-10-preview and go
diff --git a/specification/desktopvirtualization/resource-manager/readme.java.md b/specification/desktopvirtualization/resource-manager/readme.java.md
index 089093f5ff73..fb33f035a32f 100644
--- a/specification/desktopvirtualization/resource-manager/readme.java.md
+++ b/specification/desktopvirtualization/resource-manager/readme.java.md
@@ -16,18 +16,18 @@ output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-desktopvirtualizati
``` yaml $(java) && $(multiapi)
batch:
- - tag: package-2019-12-10-preview
+ - tag: package-2020-09-21-preview
```
-### Tag: package-2019-12-10-preview and java
+### Tag: package-2020-09-21-preview and java
-These settings apply only when `--tag=package-2019-12-10-preview --java` is specified on the command line.
+These settings apply only when `--tag=package-2020-09-21-preview --java` is specified on the command line.
Please also specify `--azure-libraries-for-java=`.
-``` yaml $(tag) == 'package-2019-12-10-preview' && $(java) && $(multiapi)
+``` yaml $(tag) == 'package-2020-09-21-preview' && $(java) && $(multiapi)
java:
- namespace: com.microsoft.azure.management.desktopvirtualization.v2019_12_10_preview
- output-folder: $(azure-libraries-for-java-folder)/sdk/desktopvirtualization/mgmt-v2019_12_10_preview
+ namespace: com.microsoft.azure.management.desktopvirtualization.v2020_09_21_preview
+ output-folder: $(azure-libraries-for-java-folder)/sdk/desktopvirtualization/mgmt-v2020_09_21_preview
regenerate-manager: true
generate-interface: true
```
diff --git a/specification/desktopvirtualization/resource-manager/readme.md b/specification/desktopvirtualization/resource-manager/readme.md
index 7096c08a98df..3824f31c9811 100644
--- a/specification/desktopvirtualization/resource-manager/readme.md
+++ b/specification/desktopvirtualization/resource-manager/readme.md
@@ -1,114 +1,152 @@
-# DesktopVirtualization
-
-> see https://aka.ms/autorest
-
-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`
-
-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-2019-12-10-preview
-```
-
-### Tag: package-2019-01-23-preview
-
-These settings apply only when `--tag=package-2019-01-23-preview` is specified on the command line.
-
-``` yaml $(tag) == 'package-2019-01-23-preview'
-input-file:
-- Microsoft.DesktopVirtualization/preview/2019-01-23-preview/desktopvirtualization.json
-```
-
-### Tag: package-2019-09-24-preview
-
-These settings apply only when `--tag=package-2019-09-24-preview` is specified on the command line.
-
-``` yaml $(tag) == 'package-2019-09-24-preview'
-input-file:
-- Microsoft.DesktopVirtualization/preview/2019-09-24-preview/desktopvirtualization.json
-```
-
-### Tag: package-2019-12-10-preview
-
-These settings apply only when `--tag=package-2019-12-10-preview` is specified on the command line.
-
-``` yaml $(tag) == 'package-2019-12-10-preview'
-input-file:
-- Microsoft.DesktopVirtualization/preview/2019-12-10-preview/desktopvirtualization.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-csharp
- - 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-sdk-for-ruby
- after_scripts:
- - bundle install && rake arm:regen_all_profiles['azure_mgmt_desktop_virtualization']
- - repo: azure-cli-extensions
+# DesktopVirtualization
+
+> see https://aka.ms/autorest
+
+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`
+
+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-2020-09-21-preview
+```
+
+### Tag: package-2020-09-21-preview
+
+``` yaml $(tag) == 'package-2020-09-21-preview'
+input-file:
+- Microsoft.DesktopVirtualization/preview/2020-09-21-preview/desktopvirtualization.json
+```
+
+### Tag: package-2019-12-10-preview
+
+These settings apply only when `--tag=package-2019-12-10-preview` is specified on the command line.
+
+``` yaml $(tag) == 'package-2019-12-10-preview'
+input-file:
+- Microsoft.DesktopVirtualization/preview/2019-12-10-preview/desktopvirtualization.json
+```
+
+### Tag: package-2019-01-23-preview
+
+These settings apply only when `--tag=package-2019-01-23-preview` is specified on the command line.
+
+``` yaml $(tag) == 'package-2019-01-23-preview'
+input-file:
+- Microsoft.DesktopVirtualization/preview/2019-01-23-preview/desktopvirtualization.json
+```
+
+### Tag: package-2019-09-24-preview
+
+These settings apply only when `--tag=package-2019-09-24-preview` is specified on the command line.
+
+``` yaml $(tag) == 'package-2019-09-24-preview'
+input-file:
+- Microsoft.DesktopVirtualization/preview/2019-09-24-preview/desktopvirtualization.json
+```
+
+### Tag: package-2019-12-10-preview
+
+These settings apply only when `--tag=package-2019-12-10-preview` is specified on the command line.
+
+``` yaml $(tag) == 'package-2019-12-10-preview'
+input-file:
+- Microsoft.DesktopVirtualization/preview/2019-12-10-preview/desktopvirtualization.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-csharp
+ - 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-sdk-for-ruby
+ after_scripts:
+ - bundle install && rake arm:regen_all_profiles['azure_mgmt_desktop_virtualization']
+ - repo: azure-cli-extensions
- repo: azure-resource-manager-schemas
after_scripts:
- node sdkauto_afterscript.js desktopvirtualization/resource-manager
-```
-
-## C#
-
-See configuration in [readme.csharp.md](./readme.csharp.md)
-
-## Python
-
-See configuration in [readme.python.md](./readme.python.md)
-
-## Java
-
-See configuration in [readme.java.md](./readme.java.md)
-
-## Go
-
-See configuration in [readme.go.md](./readme.go.md)
-
-## TypeScript
-
-See configuration in [readme.typescript.md](./readme.typescript.md)
-
-## Node
-
-See configuration in [readme.node.md](./readme.node.md)
-
-## Ruby
-
-See configuration in [readme.ruby.md](./readme.ruby.md)
-
-## AzureResourceSchema
-
-See configuration in [readme.azureresourceschema.md](./readme.azureresourceschema.md)
+```
+
+## C#
+
+See configuration in [readme.csharp.md](./readme.csharp.md)
+
+## Python
+
+See configuration in [readme.python.md](./readme.python.md)
+
+## Java
+
+See configuration in [readme.java.md](./readme.java.md)
+
+## Go
+
+See configuration in [readme.go.md](./readme.go.md)
+
+## TypeScript
+
+See configuration in [readme.typescript.md](./readme.typescript.md)
+
+## Node
+
+See configuration in [readme.node.md](./readme.node.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.DesktopVirtualization/preview/2019-01-23-preview/desktopvirtualization.json
+ - $(this-folder)/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/desktopvirtualization.json
+ - $(this-folder)/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/desktopvirtualization.json
+ - $(this-folder)/Microsoft.DesktopVirtualization/preview/2020-09-21-preview/desktopvirtualization.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
+```
\ No newline at end of file
diff --git a/specification/desktopvirtualization/resource-manager/readme.ruby.md b/specification/desktopvirtualization/resource-manager/readme.ruby.md
index 9491ec2d3560..d21dd9824864 100644
--- a/specification/desktopvirtualization/resource-manager/readme.ruby.md
+++ b/specification/desktopvirtualization/resource-manager/readme.ruby.md
@@ -15,6 +15,17 @@ batch:
- tag: package-2019-01-23-preview
- tag: package-2019-09-24-preview
- tag: package-2019-12-10-preview
+ - tag: package-2020-09-21-preview
+```
+
+### Tag: package-2020-09-21-preview and ruby
+
+These settings apply only when `--tag=package-2020-09-21-preview --ruby` is specified on the command line.
+Please also specify `--ruby-sdks-folder=`.
+
+``` yaml $(tag) == 'package-2020-09-21-preview' && $(ruby)
+namespace: "Azure::DesktopVirtualization::Mgmt::V2020_09_21_preview"
+output-folder: $(ruby-sdks-folder)/management/azure_mgmt_desktop_virtualization/lib
```
### Tag: package-2019-12-10-preview and ruby
diff --git a/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/stable/2020-10-31/digitaltwins.json b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/stable/2020-10-31/digitaltwins.json
new file mode 100644
index 000000000000..be9e053d7154
--- /dev/null
+++ b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/stable/2020-10-31/digitaltwins.json
@@ -0,0 +1,1624 @@
+{
+ "swagger": "2.0",
+ "info": {
+ "version": "2020-10-31",
+ "title": "Azure Digital Twins API",
+ "description": "A service for managing and querying digital twins and digital twin models."
+ },
+ "host": "digitaltwins-name.digitaltwins.azure.net",
+ "schemes": [
+ "https"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "consumes": [
+ "application/json"
+ ],
+ "paths": {
+ "/models": {
+ "parameters": [
+ {
+ "$ref": "#/parameters/traceparent"
+ },
+ {
+ "$ref": "#/parameters/tracestate"
+ }
+ ],
+ "post": {
+ "tags": [
+ "Models"
+ ],
+ "description": "Uploads one or more models. When any error occurs, no models are uploaded.\nStatus codes:\n* 201 Created\n* 400 Bad Request\n * DTDLParserError - The models provided are not valid DTDL.\n * InvalidArgument - The model id is invalid.\n * LimitExceeded - The maximum number of model ids allowed in 'dependenciesFor' has been reached.\n * ModelVersionNotSupported - The version of DTDL used is not supported.\n* 409 Conflict\n * ModelAlreadyExists - The model provided already exists.",
+ "operationId": "DigitalTwinModels_Add",
+ "x-ms-examples": {
+ "Add models": {
+ "$ref": "./examples/ModelAdd.json"
+ }
+ },
+ "parameters": [
+ {
+ "name": "models",
+ "in": "body",
+ "description": "An array of models to add.",
+ "required": false,
+ "schema": {
+ "type": "array",
+ "minItems": 1,
+ "uniqueItems": true,
+ "items": {
+ "type": "object"
+ }
+ }
+ },
+ {
+ "$ref": "#/parameters/api-version"
+ }
+ ],
+ "responses": {
+ "201": {
+ "description": "Success",
+ "schema": {
+ "$ref": "#/definitions/NonPagedDigitalTwinsModelDataCollection"
+ }
+ },
+ "default": {
+ "description": "Default response.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ }
+ },
+ "get": {
+ "tags": [
+ "Models"
+ ],
+ "description": "Retrieves model metadata and, optionally, model definitions.\nStatus codes:\n* 200 OK\n* 400 Bad Request\n * InvalidArgument - The model id is invalid.\n * LimitExceeded - The maximum number of model ids allowed in 'dependenciesFor' has been reached.\n* 404 Not Found\n * ModelNotFound - The model was not found.",
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "operationId": "DigitalTwinModels_List",
+ "x-ms-examples": {
+ "List models": {
+ "$ref": "./examples/ModelsGet.json"
+ },
+ "List models (include dependencies and definitions)": {
+ "$ref": "./examples/ModelsGetWithDependenciesAndIncludeModelDefinition.json"
+ }
+ },
+ "parameters": [
+ {
+ "name": "dependenciesFor",
+ "in": "query",
+ "description": "The set of the models which will have their dependencies retrieved. If omitted, all models are retrieved.",
+ "required": false,
+ "type": "array",
+ "collectionFormat": "multi",
+ "items": {
+ "type": "string"
+ }
+ },
+ {
+ "$ref": "#/parameters/includeModelDefinition"
+ },
+ {
+ "$ref": "#/parameters/max-items-per-page"
+ },
+ {
+ "$ref": "#/parameters/api-version"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "schema": {
+ "$ref": "#/definitions/PagedDigitalTwinsModelDataCollection"
+ }
+ },
+ "default": {
+ "description": "Default response.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/models/{id}": {
+ "parameters": [
+ {
+ "$ref": "#/parameters/traceparent"
+ },
+ {
+ "$ref": "#/parameters/tracestate"
+ }
+ ],
+ "get": {
+ "tags": [
+ "Models"
+ ],
+ "description": "Retrieves model metadata and optionally the model definition.\nStatus codes:\n* 200 OK\n* 400 Bad Request\n * InvalidArgument - The model id is invalid.\n * MissingArgument - The model id was not provided.\n* 404 Not Found\n * ModelNotFound - The model was not found.",
+ "operationId": "DigitalTwinModels_GetById",
+ "x-ms-examples": {
+ "Get a model by id": {
+ "$ref": "./examples/ModelGetById.json"
+ },
+ "Get a model by id (with definition)": {
+ "$ref": "./examples/ModelGetByIdWithIncludeModelDefinition.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/modelId"
+ },
+ {
+ "$ref": "#/parameters/includeModelDefinition"
+ },
+ {
+ "$ref": "#/parameters/api-version"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "schema": {
+ "$ref": "#/definitions/DigitalTwinsModelData"
+ }
+ },
+ "default": {
+ "description": "Default response.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ }
+ },
+ "patch": {
+ "tags": [
+ "Models"
+ ],
+ "description": "Updates the metadata for a model.\nStatus codes:\n* 204 No Content\n* 400 Bad Request\n * InvalidArgument - The model id is invalid.\n * JsonPatchInvalid - The JSON Patch provided is invalid.\n * MissingArgument - The model id was not provided.\n* 404 Not Found\n * ModelNotFound - The model was not found.\n* 409 Conflict\n * ModelReferencesNotDecommissioned - The model refers to models that are not decommissioned.",
+ "operationId": "DigitalTwinModels_Update",
+ "consumes": [
+ "application/json-patch+json"
+ ],
+ "x-ms-examples": {
+ "Decommission a model": {
+ "$ref": "./examples/ModelUpdateDecommissioned.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/modelId"
+ },
+ {
+ "name": "updateModel",
+ "description": "An update specification described by JSON Patch. Only the decommissioned property can be replaced.",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "object"
+ }
+ }
+ },
+ {
+ "$ref": "#/parameters/api-version"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Success"
+ },
+ "default": {
+ "description": "Default response.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "Models"
+ ],
+ "operationId": "DigitalTwinModels_Delete",
+ "description": "Deletes a model. A model can only be deleted if no other models reference it.\nStatus codes:\n* 204 No Content\n* 400 Bad Request\n * InvalidArgument - The model id is invalid.\n * MissingArgument - The model id was not provided.\n* 404 Not Found\n * ModelNotFound - The model was not found.\n* 409 Conflict\n * ModelReferencesNotDeleted - The model refers to models that are not deleted.",
+ "x-ms-examples": {
+ "Delete a model": {
+ "$ref": "./examples/DeleteModel.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/modelId"
+ },
+ {
+ "$ref": "#/parameters/api-version"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Success"
+ },
+ "default": {
+ "description": "Default response.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/query": {
+ "parameters": [
+ {
+ "$ref": "#/parameters/traceparent"
+ },
+ {
+ "$ref": "#/parameters/tracestate"
+ }
+ ],
+ "post": {
+ "tags": [
+ "Query"
+ ],
+ "operationId": "Query_QueryTwins",
+ "description": "Executes a query that allows traversing relationships and filtering by property values.\nStatus codes:\n* 200 OK\n* 400 Bad Request\n * BadRequest - The continuation token is invalid.\n * SqlQueryError - The query contains some errors.\n* 429 Too Many Requests\n * QuotaReachedError - The maximum query rate limit has been reached.",
+ "x-ms-examples": {
+ "Query for digital twins": {
+ "$ref": "./examples/QueryFirstPage.json"
+ },
+ "Retrieve paged query results": {
+ "$ref": "./examples/QueryNextPage.json"
+ },
+ "Query for digital twins through a relationship": {
+ "$ref": "./examples/QueryJoin.json"
+ }
+ },
+ "parameters": [
+ {
+ "name": "querySpecification",
+ "in": "body",
+ "description": "The query specification to execute.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/QuerySpecification"
+ }
+ },
+ {
+ "$ref": "#/parameters/max-items-per-page"
+ },
+ {
+ "$ref": "#/parameters/api-version"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "schema": {
+ "$ref": "#/definitions/QueryResult"
+ },
+ "headers": {
+ "query-charge": {
+ "description": "The query charge.",
+ "type": "number"
+ }
+ }
+ },
+ "default": {
+ "description": "Default response.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/digitaltwins/{id}": {
+ "parameters": [
+ {
+ "$ref": "#/parameters/traceparent"
+ },
+ {
+ "$ref": "#/parameters/tracestate"
+ }
+ ],
+ "get": {
+ "tags": [
+ "Twins"
+ ],
+ "operationId": "DigitalTwins_GetById",
+ "description": "Retrieves a digital twin.\nStatus codes:\n* 200 OK\n* 400 Bad Request\n * InvalidArgument - The digital twin id is invalid.\n* 404 Not Found\n * DigitalTwinNotFound - The digital twin was not found.",
+ "x-ms-examples": {
+ "Get a digital twin by id": {
+ "$ref": "./examples/GetTwin.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/digitalTwinId"
+ },
+ {
+ "$ref": "#/parameters/api-version"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "schema": {
+ "type": "object"
+ },
+ "headers": {
+ "ETag": {
+ "description": "Weak Etag.",
+ "type": "string"
+ }
+ }
+ },
+ "default": {
+ "description": "Default response.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "Twins"
+ ],
+ "operationId": "DigitalTwins_Add",
+ "description": "Adds or replaces a digital twin.\nStatus codes:\n* 200 OK\n* 400 Bad Request\n * InvalidArgument - The digital twin id or payload is invalid.\n * ModelDecommissioned - The model for the digital twin is decommissioned.\n * TwinLimitReached - The maximum number of digital twins allowed has been reached.\n * ValidationFailed - The digital twin payload is not valid.\n* 412 Precondition Failed\n * PreconditionFailed - The precondition check (If-Match or If-None-Match) failed.",
+ "x-ms-examples": {
+ "Add a digital twin": {
+ "$ref": "./examples/PutTwinBasicExample.json"
+ },
+ "Add a digital twin (with properties and components)": {
+ "$ref": "./examples/PutTwinAdvancedExample.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/digitalTwinId"
+ },
+ {
+ "name": "twin",
+ "description": "The digital twin instance being added. If provided, the $dtId property is ignored.",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "type": "object"
+ }
+ },
+ {
+ "$ref": "#/parameters/if-none-match-star"
+ },
+ {
+ "$ref": "#/parameters/api-version"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "schema": {
+ "type": "object"
+ },
+ "headers": {
+ "ETag": {
+ "description": "Weak Etag.",
+ "type": "string"
+ }
+ }
+ },
+ "202": {
+ "description": "Asynchronous Success"
+ },
+ "default": {
+ "description": "Default response.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "Twins"
+ ],
+ "operationId": "DigitalTwins_Delete",
+ "description": "Deletes a digital twin. All relationships referencing the digital twin must already be deleted.\nStatus codes:\n* 204 No Content\n* 400 Bad Request\n * InvalidArgument - The digital twin id is invalid.\n * RelationshipsNotDeleted - The digital twin contains relationships.\n* 404 Not Found\n * DigitalTwinNotFound - The digital twin was not found.\n* 412 Precondition Failed\n * PreconditionFailed - The precondition check (If-Match or If-None-Match) failed.",
+ "x-ms-examples": {
+ "Delete a digital twin": {
+ "$ref": "./examples/DeleteTwin.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/digitalTwinId"
+ },
+ {
+ "$ref": "#/parameters/if-match"
+ },
+ {
+ "$ref": "#/parameters/api-version"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Success"
+ },
+ "default": {
+ "description": "Default response.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ }
+ },
+ "patch": {
+ "tags": [
+ "Twins"
+ ],
+ "operationId": "DigitalTwins_Update",
+ "description": "Updates a digital twin.\nStatus codes:\n* 204 No Content\n* 400 Bad Request\n * InvalidArgument - The digital twin id or payload is invalid.\n * JsonPatchInvalid - The JSON Patch provided is invalid.\n * ValidationFailed - Applying the patch results in an invalid digital twin.\n* 404 Not Found\n * DigitalTwinNotFound - The digital twin was not found.\n* 412 Precondition Failed\n * PreconditionFailed - The precondition check (If-Match or If-None-Match) failed.",
+ "consumes": [
+ "application/json-patch+json"
+ ],
+ "x-ms-examples": {
+ "Update a digital twin": {
+ "$ref": "./examples/PatchTwinBasicExample.json"
+ },
+ "Update a digital twin (multiple updates)": {
+ "$ref": "./examples/PatchTwinAdvancedExample.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/digitalTwinId"
+ },
+ {
+ "name": "patchDocument",
+ "description": "An update specification described by JSON Patch. Updates to property values and $model elements may happen in the same request. Operations are limited to add, replace and remove.",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "object"
+ }
+ }
+ },
+ {
+ "$ref": "#/parameters/if-match"
+ },
+ {
+ "$ref": "#/parameters/api-version"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Success",
+ "headers": {
+ "ETag": {
+ "description": "Weak Etag.",
+ "type": "string"
+ }
+ }
+ },
+ "202": {
+ "description": "Asynchronous Success"
+ },
+ "default": {
+ "description": "Default response.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/digitaltwins/{id}/relationships/{relationshipId}": {
+ "parameters": [
+ {
+ "$ref": "#/parameters/traceparent"
+ },
+ {
+ "$ref": "#/parameters/tracestate"
+ }
+ ],
+ "get": {
+ "tags": [
+ "Twins"
+ ],
+ "operationId": "DigitalTwins_GetRelationshipById",
+ "description": "Retrieves a relationship between two digital twins.\nStatus codes:\n* 200 OK\n* 400 Bad Request\n * InvalidArgument - The digital twin id or relationship id is invalid.\n* 404 Not Found\n * DigitalTwinNotFound - The digital twin was not found.\n * RelationshipNotFound - The relationship was not found.",
+ "x-ms-examples": {
+ "Get a relationship by id": {
+ "$ref": "./examples/GetRelationshipById.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/digitalTwinId"
+ },
+ {
+ "$ref": "#/parameters/relationshipId"
+ },
+ {
+ "$ref": "#/parameters/api-version"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "schema": {
+ "type": "object"
+ },
+ "headers": {
+ "ETag": {
+ "description": "Weak Etag.",
+ "type": "string"
+ }
+ }
+ },
+ "default": {
+ "description": "Default response.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "Twins"
+ ],
+ "operationId": "DigitalTwins_AddRelationship",
+ "description": "Adds a relationship between two digital twins.\nStatus codes:\n* 200 OK\n* 400 Bad Request\n * InvalidArgument - The digital twin id, relationship id, or payload is invalid.\n * InvalidRelationship - The relationship is invalid.\n * OperationNotAllowed - The relationship cannot connect to the same digital twin.\n * ValidationFailed - The relationship content is invalid.\n* 404 Not Found\n * DigitalTwinNotFound - The digital twin was not found.\n * TargetTwinNotFound - The digital twin target of the relationship was not found.\n* 412 Precondition Failed\n * PreconditionFailed - The precondition check (If-Match or If-None-Match) failed.",
+ "x-ms-examples": {
+ "Create a relationship": {
+ "$ref": "./examples/CreateRelationshipBasicExample.json"
+ },
+ "Create a relationship (with properties)": {
+ "$ref": "./examples/CreateRelationshipAdvancedExample.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/digitalTwinId"
+ },
+ {
+ "$ref": "#/parameters/relationshipId"
+ },
+ {
+ "name": "relationship",
+ "in": "body",
+ "description": "The data for the relationship.",
+ "required": true,
+ "schema": {
+ "type": "object"
+ }
+ },
+ {
+ "$ref": "#/parameters/if-none-match-star"
+ },
+ {
+ "$ref": "#/parameters/api-version"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "schema": {
+ "type": "object"
+ },
+ "headers": {
+ "ETag": {
+ "description": "Weak Etag.",
+ "type": "string"
+ }
+ }
+ },
+ "default": {
+ "description": "Default response.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "Twins"
+ ],
+ "operationId": "DigitalTwins_DeleteRelationship",
+ "description": "Deletes a relationship between two digital twins.\nStatus codes:\n* 204 No Content\n* 400 Bad Request\n * InvalidArgument - The digital twin id or relationship id is invalid.\n* 404 Not Found\n * DigitalTwinNotFound - The digital twin was not found.\n * RelationshipNotFound - The relationship was not found.\n* 412 Precondition Failed\n * PreconditionFailed - The precondition check (If-Match or If-None-Match) failed.",
+ "x-ms-examples": {
+ "Delete a relationship": {
+ "$ref": "./examples/DeleteRelationship.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/digitalTwinId"
+ },
+ {
+ "$ref": "#/parameters/relationshipId"
+ },
+ {
+ "$ref": "#/parameters/if-match"
+ },
+ {
+ "$ref": "#/parameters/api-version"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Success"
+ },
+ "default": {
+ "description": "Default response.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ }
+ },
+ "patch": {
+ "tags": [
+ "Twins"
+ ],
+ "consumes": [
+ "application/json-patch+json"
+ ],
+ "operationId": "DigitalTwins_UpdateRelationship",
+ "description": "Updates the properties on a relationship between two digital twins.\nStatus codes:\n* 204 No Content\n* 400 Bad Request\n * InvalidArgument - The digital twin id or relationship id is invalid.\n * InvalidRelationship - The relationship is invalid.\n * JsonPatchInvalid - The JSON Patch provided is invalid.\n * ValidationFailed - The relationship content is invalid.\n* 404 Not Found\n * DigitalTwinNotFound - The digital twin was not found.\n * RelationshipNotFound - The relationship was not found.\n* 409 Conflict\n * RelationshipAlreadyExists - The relationship already exists.\n* 412 Precondition Failed\n * PreconditionFailed - The precondition check (If-Match or If-None-Match) failed.",
+ "x-ms-examples": {
+ "Update relationship properties": {
+ "$ref": "./examples/PatchRelationshipBasicExample.json"
+ },
+ "Update relationship properties (multiple updates)": {
+ "$ref": "./examples/PatchRelationshipAdvancedExample.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/digitalTwinId"
+ },
+ {
+ "$ref": "#/parameters/relationshipId"
+ },
+ {
+ "name": "patchDocument",
+ "description": "JSON Patch description of the update to the relationship properties.",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "object"
+ }
+ }
+ },
+ {
+ "$ref": "#/parameters/if-match"
+ },
+ {
+ "$ref": "#/parameters/api-version"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Success",
+ "headers": {
+ "ETag": {
+ "description": "Weak Etag.",
+ "type": "string"
+ }
+ }
+ },
+ "default": {
+ "description": "Default response.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/digitaltwins/{id}/relationships": {
+ "parameters": [
+ {
+ "$ref": "#/parameters/traceparent"
+ },
+ {
+ "$ref": "#/parameters/tracestate"
+ }
+ ],
+ "get": {
+ "tags": [
+ "Twins"
+ ],
+ "operationId": "DigitalTwins_ListRelationships",
+ "description": "Retrieves the relationships from a digital twin.\nStatus codes:\n* 200 OK\n* 400 Bad Request\n * InvalidArgument - The digital twin id is invalid.\n* 404 Not Found\n * DigitalTwinNotFound - The digital twin was not found.",
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-examples": {
+ "List relationships": {
+ "$ref": "./examples/GetRelationship.json"
+ },
+ "List relationships by name": {
+ "$ref": "./examples/GetRelationshipByRelationshipName.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/digitalTwinId"
+ },
+ {
+ "name": "relationshipName",
+ "description": "The name of the relationship.",
+ "in": "query",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/api-version"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "schema": {
+ "$ref": "#/definitions/RelationshipCollection"
+ }
+ },
+ "default": {
+ "description": "Default response.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/digitaltwins/{id}/incomingrelationships": {
+ "parameters": [
+ {
+ "$ref": "#/parameters/traceparent"
+ },
+ {
+ "$ref": "#/parameters/tracestate"
+ }
+ ],
+ "get": {
+ "tags": [
+ "Twins"
+ ],
+ "operationId": "DigitalTwins_ListIncomingRelationships",
+ "description": "Retrieves all incoming relationship for a digital twin.\nStatus codes:\n* 200 OK\n* 400 Bad Request\n * InvalidArgument - The digital twin id is invalid.\n* 404 Not Found\n * DigitalTwinNotFound - The digital twin was not found.",
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-examples": {
+ "List incoming relationships": {
+ "$ref": "./examples/GetIncomingRelationship.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/digitalTwinId"
+ },
+ {
+ "$ref": "#/parameters/api-version"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "schema": {
+ "$ref": "#/definitions/IncomingRelationshipCollection"
+ }
+ },
+ "default": {
+ "description": "Default response.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/digitaltwins/{id}/telemetry": {
+ "parameters": [
+ {
+ "$ref": "#/parameters/traceparent"
+ },
+ {
+ "$ref": "#/parameters/tracestate"
+ }
+ ],
+ "post": {
+ "tags": [
+ "Twins"
+ ],
+ "operationId": "DigitalTwins_SendTelemetry",
+ "description": "Sends telemetry on behalf of a digital twin.\nStatus codes:\n* 204 No Content\n* 400 Bad Request\n * InvalidArgument - The digital twin id or message id is invalid.\n * ValidationFailed - The telemetry content is invalid.\n* 404 Not Found\n * DigitalTwinNotFound - The digital twin was not found.",
+ "x-ms-examples": {
+ "Send telemetry": {
+ "$ref": "./examples/SendTelemetry.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/digitalTwinId"
+ },
+ {
+ "name": "telemetry",
+ "in": "body",
+ "description": "The telemetry measurements to send from the digital twin.",
+ "required": true,
+ "schema": {
+ "type": "object"
+ }
+ },
+ {
+ "name": "Message-Id",
+ "in": "header",
+ "description": "A unique message identifier (in the scope of the digital twin id) that is commonly used for de-duplicating messages.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "Telemetry-Source-Time",
+ "in": "header",
+ "description": "An RFC 3339 timestamp that identifies the time the telemetry was measured.",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/api-version"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Success"
+ },
+ "default": {
+ "description": "Default response.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/digitaltwins/{id}/components/{componentPath}/telemetry": {
+ "parameters": [
+ {
+ "$ref": "#/parameters/traceparent"
+ },
+ {
+ "$ref": "#/parameters/tracestate"
+ }
+ ],
+ "post": {
+ "tags": [
+ "Twins"
+ ],
+ "operationId": "DigitalTwins_SendComponentTelemetry",
+ "description": "Sends telemetry on behalf of a component in a digital twin.\nStatus codes:\n* 204 No Content\n* 400 Bad Request\n * InvalidArgument - The digital twin id, message id, or component path is invalid.\n * ValidationFailed - The telemetry content is invalid.\n* 404 Not Found\n * DigitalTwinNotFound - The digital twin was not found.\n * ComponentNotFound - The component path was not found.",
+ "x-ms-examples": {
+ "Send telemetry in a component": {
+ "$ref": "./examples/SendTelemetryFromComponent.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/digitalTwinId"
+ },
+ {
+ "$ref": "#/parameters/componentPath"
+ },
+ {
+ "name": "telemetry",
+ "in": "body",
+ "description": "The telemetry measurements to send from the digital twin's component.",
+ "required": true,
+ "schema": {
+ "type": "object"
+ }
+ },
+ {
+ "name": "Message-Id",
+ "in": "header",
+ "description": "A unique message identifier (in the scope of the digital twin id) that is commonly used for de-duplicating messages.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "Telemetry-Source-Time",
+ "in": "header",
+ "description": "An RFC 3339 timestamp that identifies the time the telemetry was measured.",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/api-version"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Success"
+ },
+ "default": {
+ "description": "Default response.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/digitaltwins/{id}/components/{componentPath}": {
+ "parameters": [
+ {
+ "$ref": "#/parameters/traceparent"
+ },
+ {
+ "$ref": "#/parameters/tracestate"
+ }
+ ],
+ "get": {
+ "tags": [
+ "Twins"
+ ],
+ "operationId": "DigitalTwins_GetComponent",
+ "description": "Retrieves a component from a digital twin.\nStatus codes:\n* 200 OK\n* 400 Bad Request\n * InvalidArgument - The digital twin id or component path is invalid.\n* 404 Not Found\n * DigitalTwinNotFound - The digital twin was not found.\n * ComponentNotFound - The component path was not found.",
+ "x-ms-examples": {
+ "Get a component in a digital twin": {
+ "$ref": "./examples/GetComponent.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/digitalTwinId"
+ },
+ {
+ "$ref": "#/parameters/componentPath"
+ },
+ {
+ "$ref": "#/parameters/api-version"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "schema": {
+ "type": "object"
+ },
+ "headers": {
+ "ETag": {
+ "description": "Weak Etag.",
+ "type": "string"
+ }
+ }
+ },
+ "default": {
+ "description": "Default response.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ }
+ },
+ "patch": {
+ "tags": [
+ "Twins"
+ ],
+ "operationId": "DigitalTwins_UpdateComponent",
+ "description": "Updates a component on a digital twin.\nStatus codes:\n* 204 No Content\n* 400 Bad Request\n * InvalidArgument - The digital twin id, component path, or payload is invalid.\n * JsonPatchInvalid - The JSON Patch provided is invalid.\n * ValidationFailed - Applying the patch results in an invalid digital twin.\n* 404 Not Found\n * DigitalTwinNotFound - The digital twin was not found.\n* 412 Precondition Failed\n * PreconditionFailed - The precondition check (If-Match or If-None-Match) failed.",
+ "x-ms-examples": {
+ "Update a component in a digital twin": {
+ "$ref": "./examples/PatchComponentBasicExample.json"
+ },
+ "Update a component in a digital twin (multiple updates)": {
+ "$ref": "./examples/PatchComponentAdvancedExample.json"
+ }
+ },
+ "consumes": [
+ "application/json-patch+json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/digitalTwinId"
+ },
+ {
+ "$ref": "#/parameters/componentPath"
+ },
+ {
+ "name": "patchDocument",
+ "description": "An update specification described by JSON Patch. Updates to property values and $model elements may happen in the same request. Operations are limited to add, replace and remove.",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "object"
+ }
+ }
+ },
+ {
+ "$ref": "#/parameters/if-match"
+ },
+ {
+ "$ref": "#/parameters/api-version"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Success",
+ "headers": {
+ "ETag": {
+ "description": "Weak Etag.",
+ "type": "string"
+ }
+ }
+ },
+ "202": {
+ "description": "Asynchronous Success"
+ },
+ "default": {
+ "description": "Default response.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/eventroutes": {
+ "parameters": [
+ {
+ "$ref": "#/parameters/traceparent"
+ },
+ {
+ "$ref": "#/parameters/tracestate"
+ }
+ ],
+ "get": {
+ "tags": [
+ "EventRoutes"
+ ],
+ "description": "Retrieves all event routes.\nStatus codes:\n* 200 OK",
+ "operationId": "EventRoutes_List",
+ "x-ms-examples": {
+ "List event routes": {
+ "$ref": "./examples/EventRoutesList.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/max-items-per-page"
+ },
+ {
+ "$ref": "#/parameters/api-version"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "schema": {
+ "$ref": "#/definitions/EventRouteCollection"
+ }
+ },
+ "default": {
+ "description": "Default response.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/eventroutes/{id}": {
+ "parameters": [
+ {
+ "$ref": "#/parameters/traceparent"
+ },
+ {
+ "$ref": "#/parameters/tracestate"
+ }
+ ],
+ "get": {
+ "tags": [
+ "EventRoutes"
+ ],
+ "description": "Retrieves an event route.\nStatus codes:\n* 200 OK\n* 404 Not Found\n * EventRouteNotFound - The event route was not found.",
+ "operationId": "EventRoutes_GetById",
+ "x-ms-examples": {
+ "Get an event route by id": {
+ "$ref": "./examples/EventRouteGet.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/eventRouteId"
+ },
+ {
+ "$ref": "#/parameters/api-version"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "schema": {
+ "$ref": "#/definitions/EventRoute"
+ }
+ },
+ "default": {
+ "description": "Default response.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "EventRoutes"
+ ],
+ "description": "Adds or replaces an event route.\nStatus codes:\n* 204 No Content\n* 400 Bad Request\n * EventRouteEndpointInvalid - The endpoint provided does not exist or is not active.\n * EventRouteFilterInvalid - The event route filter is invalid.\n * EventRouteIdInvalid - The event route id is invalid.\n * LimitExceeded - The maximum number of event routes allowed has been reached.",
+ "operationId": "EventRoutes_Add",
+ "x-ms-examples": {
+ "Add an event route": {
+ "$ref": "./examples/EventRoutePut.json"
+ },
+ "Add an event route (with filter)": {
+ "$ref": "./examples/EventRoutePutWithFilter.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/eventRouteId"
+ },
+ {
+ "name": "eventRoute",
+ "description": "The event route data",
+ "in": "body",
+ "schema": {
+ "$ref": "#/definitions/EventRoute"
+ }
+ },
+ {
+ "$ref": "#/parameters/api-version"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Success"
+ },
+ "default": {
+ "description": "Default response.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "EventRoutes"
+ ],
+ "description": "Deletes an event route.\nStatus codes:\n* 204 No Content\n* 404 Not Found\n * EventRouteNotFound - The event route was not found.",
+ "operationId": "EventRoutes_Delete",
+ "x-ms-examples": {
+ "Delete an event route": {
+ "$ref": "./examples/EventRouteDelete.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/eventRouteId"
+ },
+ {
+ "$ref": "#/parameters/api-version"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Success"
+ },
+ "default": {
+ "description": "Default response.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ }
+ }
+ }
+ },
+ "definitions": {
+ "EventRoute": {
+ "description": "A route which directs notification and telemetry events to an endpoint. Endpoints are a destination outside of Azure Digital Twins such as an EventHub.",
+ "type": "object",
+ "required": [
+ "endpointName",
+ "filter"
+ ],
+ "properties": {
+ "id": {
+ "description": "The id of the event route.",
+ "type": "string",
+ "readOnly": true
+ },
+ "endpointName": {
+ "description": "The name of the endpoint this event route is bound to.",
+ "type": "string"
+ },
+ "filter": {
+ "description": "An expression which describes the events which are routed to the endpoint.",
+ "type": "string"
+ }
+ }
+ },
+ "EventRouteCollection": {
+ "description": "A collection of EventRoute objects.",
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "The EventRoute objects.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/EventRoute"
+ }
+ },
+ "nextLink": {
+ "description": "A URI to retrieve the next page of results.",
+ "type": "string"
+ }
+ }
+ },
+ "NonPagedDigitalTwinsModelDataCollection": {
+ "description": "A collection of DigitalTwinsModelData objects.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/DigitalTwinsModelData"
+ }
+ },
+ "PagedDigitalTwinsModelDataCollection": {
+ "description": "A collection of DigitalTwinsModelData objects.",
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "The DigitalTwinsModelData objects.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/DigitalTwinsModelData"
+ }
+ },
+ "nextLink": {
+ "description": "A URI to retrieve the next page of objects.",
+ "type": "string"
+ }
+ }
+ },
+ "DigitalTwinsModelData": {
+ "description": "A model definition and metadata for that model.",
+ "required": [
+ "id"
+ ],
+ "type": "object",
+ "properties": {
+ "displayName": {
+ "description": "A language map that contains the localized display names as specified in the model definition.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "description": {
+ "description": "A language map that contains the localized descriptions as specified in the model definition.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "id": {
+ "description": "The id of the model as specified in the model definition.",
+ "type": "string"
+ },
+ "uploadTime": {
+ "description": "The time the model was uploaded to the service.",
+ "format": "date-time",
+ "type": "string"
+ },
+ "decommissioned": {
+ "description": "Indicates if the model is decommissioned. Decommissioned models cannot be referenced by newly created digital twins.",
+ "type": "boolean",
+ "default": false
+ },
+ "model": {
+ "description": "The model definition.",
+ "type": "object"
+ }
+ }
+ },
+ "RelationshipCollection": {
+ "description": "A collection of relationships which relate digital twins together.",
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "The relationship objects.",
+ "type": "array",
+ "items": {
+ "description": "The relationship JSON document.",
+ "type": "object"
+ }
+ },
+ "nextLink": {
+ "description": "A URI to retrieve the next page of objects.",
+ "type": "string"
+ }
+ }
+ },
+ "IncomingRelationshipCollection": {
+ "description": "A collection of incoming relationships which relate digital twins together.",
+ "type": "object",
+ "properties": {
+ "value": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/IncomingRelationship"
+ }
+ },
+ "nextLink": {
+ "type": "string",
+ "description": "A URI to retrieve the next page of objects."
+ }
+ }
+ },
+ "IncomingRelationship": {
+ "type": "object",
+ "description": "An incoming relationship.",
+ "properties": {
+ "$relationshipId": {
+ "type": "string",
+ "description": "A user-provided string representing the id of this relationship, unique in the context of the source digital twin, i.e. sourceId + relationshipId is unique in the context of the service."
+ },
+ "$sourceId": {
+ "type": "string",
+ "description": "The id of the source digital twin."
+ },
+ "$relationshipName": {
+ "type": "string",
+ "description": "The name of the relationship."
+ },
+ "$relationshipLink": {
+ "type": "string",
+ "description": "Link to the relationship, to be used for deletion."
+ }
+ }
+ },
+ "QuerySpecification": {
+ "description": "A query specification containing either a query statement or a continuation token from a previous query result.",
+ "type": "object",
+ "properties": {
+ "query": {
+ "description": "The query to execute. This value is ignored if a continuation token is provided.",
+ "type": "string"
+ },
+ "continuationToken": {
+ "description": "A token which is used to retrieve the next set of results from a previous query.",
+ "type": "string"
+ }
+ }
+ },
+ "QueryResult": {
+ "description": "The results of a query operation and an optional continuation token.",
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "The query results.",
+ "type": "array",
+ "items": {
+ "type": "object"
+ }
+ },
+ "continuationToken": {
+ "description": "A token which can be used to construct a new QuerySpecification to retrieve the next set of results.",
+ "type": "string"
+ }
+ }
+ },
+ "ErrorResponse": {
+ "description": "Error response.",
+ "properties": {
+ "error": {
+ "$ref": "#/definitions/Error",
+ "description": "The error details."
+ }
+ }
+ },
+ "Error": {
+ "description": "Error definition.",
+ "properties": {
+ "code": {
+ "description": "Service specific error code which serves as the substatus for the HTTP error code.",
+ "type": "string",
+ "readOnly": true
+ },
+ "message": {
+ "description": "A human-readable representation of the error.",
+ "type": "string",
+ "readOnly": true
+ },
+ "details": {
+ "description": "Internal error details.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/Error"
+ },
+ "readOnly": true
+ },
+ "innererror": {
+ "description": "An object containing more specific information than the current object about the error.",
+ "$ref": "#/definitions/InnerError"
+ }
+ }
+ },
+ "InnerError": {
+ "description": "A more specific error description than was provided by the containing error.",
+ "properties": {
+ "code": {
+ "description": "A more specific error code than was provided by the containing error.",
+ "type": "string"
+ },
+ "innererror": {
+ "description": "An object containing more specific information than the current object about the error.",
+ "$ref": "#/definitions/InnerError"
+ }
+ }
+ }
+ },
+ "securityDefinitions": {
+ "oauth2": {
+ "flow": "implicit",
+ "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize?resource=0b07f429-9f4b-4714-9392-cc5e8e80c8b0",
+ "type": "oauth2"
+ }
+ },
+ "parameters": {
+ "eventRouteId": {
+ "name": "id",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The id for an event route. The id is unique within event routes and case sensitive.",
+ "x-ms-parameter-location": "method"
+ },
+ "includeModelDefinition": {
+ "name": "includeModelDefinition",
+ "description": "When true the model definition will be returned as part of the result.",
+ "in": "query",
+ "required": false,
+ "type": "boolean",
+ "default": false,
+ "x-ms-parameter-location": "method"
+ },
+ "digitalTwinId": {
+ "name": "id",
+ "in": "path",
+ "description": "The id of the digital twin. The id is unique within the service and case sensitive.",
+ "type": "string",
+ "required": true,
+ "x-ms-parameter-location": "method"
+ },
+ "modelId": {
+ "name": "id",
+ "in": "path",
+ "description": "The id for the model. The id is globally unique and case sensitive.",
+ "required": true,
+ "type": "string",
+ "x-ms-parameter-location": "method"
+ },
+ "relationshipId": {
+ "name": "relationshipId",
+ "description": "The id of the relationship. The id is unique within the digital twin and case sensitive.",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "x-ms-parameter-location": "method"
+ },
+ "componentPath": {
+ "name": "componentPath",
+ "in": "path",
+ "description": "The name of the DTDL component.",
+ "type": "string",
+ "required": true,
+ "x-ms-parameter-location": "method"
+ },
+ "api-version": {
+ "name": "api-version",
+ "in": "query",
+ "description": "The requested API version.",
+ "required": true,
+ "type": "string",
+ "enum": [
+ "2020-10-31"
+ ]
+ },
+ "max-items-per-page": {
+ "name": "max-items-per-page",
+ "in": "header",
+ "description": "The maximum number of items to retrieve per request. The server may choose to return less than the requested number.",
+ "required": false,
+ "type": "integer",
+ "x-ms-client-name": "MaxItemsPerPage",
+ "x-ms-parameter-location": "method",
+ "x-ms-parameter-grouping": {
+ "postfix": "Options"
+ }
+ },
+ "if-none-match-star": {
+ "name": "If-None-Match",
+ "in": "header",
+ "description": "Only perform the operation if the entity does not already exist.",
+ "required": false,
+ "type": "string",
+ "enum": [
+ "*"
+ ],
+ "x-ms-parameter-location": "method",
+ "x-ms-parameter-grouping": {
+ "postfix": "Options"
+ }
+ },
+ "if-match": {
+ "name": "If-Match",
+ "in": "header",
+ "description": "Only perform the operation if the entity's etag matches one of the etags provided or * is provided.",
+ "required": false,
+ "type": "string",
+ "x-ms-parameter-location": "method",
+ "x-ms-parameter-grouping": {
+ "postfix": "Options"
+ }
+ },
+ "traceparent": {
+ "name": "traceparent",
+ "in": "header",
+ "description": "Identifies the request in a distributed tracing system.",
+ "required": false,
+ "type": "string",
+ "x-ms-parameter-location": "method",
+ "x-ms-parameter-grouping": {
+ "postfix": "Options"
+ }
+ },
+ "tracestate": {
+ "name": "tracestate",
+ "in": "header",
+ "description": "Provides vendor-specific trace identification information and is a companion to traceparent.",
+ "required": false,
+ "type": "string",
+ "x-ms-parameter-location": "method",
+ "x-ms-parameter-grouping": {
+ "postfix": "Options"
+ }
+ }
+ },
+ "security": [
+ {
+ "oauth2": []
+ }
+ ]
+}
diff --git a/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/stable/2020-10-31/examples/CreateRelationshipAdvancedExample.json b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/stable/2020-10-31/examples/CreateRelationshipAdvancedExample.json
new file mode 100644
index 000000000000..23e1422abcbe
--- /dev/null
+++ b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/stable/2020-10-31/examples/CreateRelationshipAdvancedExample.json
@@ -0,0 +1,26 @@
+{
+ "parameters": {
+ "api-version": "2020-10-31",
+ "id": "mySourceTwin",
+ "relationshipId": "myRelationshipId",
+ "relationship": {
+ "$targetId": "myTargetTwin",
+ "$relationshipName": "myRelationship",
+ "relationshipProperty1": 1,
+ "relationshipProperty2": "some value"
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "$relationshipId": "myRelationshipId",
+ "$sourceId": "mySourceTwin",
+ "$targetId": "myTargetTwin",
+ "$relationshipName": "myRelationship",
+ "relationshipProperty1": 1,
+ "relationshipProperty2": "some value",
+ "$etag": "W/\"1553dbf5-0052-4be8-bea8-46269075b503\""
+ }
+ }
+ }
+}
diff --git a/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/stable/2020-10-31/examples/CreateRelationshipBasicExample.json b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/stable/2020-10-31/examples/CreateRelationshipBasicExample.json
new file mode 100644
index 000000000000..8ddf2f83ba71
--- /dev/null
+++ b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/stable/2020-10-31/examples/CreateRelationshipBasicExample.json
@@ -0,0 +1,22 @@
+{
+ "parameters": {
+ "api-version": "2020-10-31",
+ "id": "mySourceTwin",
+ "relationshipId": "myRelationshipId",
+ "relationship": {
+ "$targetId": "myTargetTwin",
+ "$relationshipName": "myRelationship"
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "$relationshipId": "myRelationshipId",
+ "$sourceId": "mySourceTwin",
+ "$targetId": "myTargetTwin",
+ "$relationshipName": "myRelationship",
+ "$etag": "W/\"1553dbf5-0052-4be8-bea8-46269075b503\""
+ }
+ }
+ }
+}
diff --git a/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/stable/2020-10-31/examples/DeleteModel.json b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/stable/2020-10-31/examples/DeleteModel.json
new file mode 100644
index 000000000000..8f2728fe38e2
--- /dev/null
+++ b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/stable/2020-10-31/examples/DeleteModel.json
@@ -0,0 +1,9 @@
+{
+ "parameters": {
+ "api-version": "2020-10-31",
+ "id": "dtmi:com:example:Sample;1"
+ },
+ "responses": {
+ "204": {}
+ }
+}
diff --git a/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/stable/2020-10-31/examples/DeleteRelationship.json b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/stable/2020-10-31/examples/DeleteRelationship.json
new file mode 100644
index 000000000000..010ff9c5db72
--- /dev/null
+++ b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/stable/2020-10-31/examples/DeleteRelationship.json
@@ -0,0 +1,10 @@
+{
+ "parameters": {
+ "api-version": "2020-10-31",
+ "id": "myTwinId",
+ "relationshipId": "myRelationshipId"
+ },
+ "responses": {
+ "204": {}
+ }
+}
diff --git a/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/stable/2020-10-31/examples/DeleteTwin.json b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/stable/2020-10-31/examples/DeleteTwin.json
new file mode 100644
index 000000000000..3bf08e7c80c5
--- /dev/null
+++ b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/stable/2020-10-31/examples/DeleteTwin.json
@@ -0,0 +1,9 @@
+{
+ "parameters": {
+ "api-version": "2020-10-31",
+ "id": "myTwinId"
+ },
+ "responses": {
+ "204": {}
+ }
+}
diff --git a/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/stable/2020-10-31/examples/EventRouteDelete.json b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/stable/2020-10-31/examples/EventRouteDelete.json
new file mode 100644
index 000000000000..7a8618a1081d
--- /dev/null
+++ b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/stable/2020-10-31/examples/EventRouteDelete.json
@@ -0,0 +1,9 @@
+{
+ "parameters": {
+ "id": "eventroute-001",
+ "api-version": "2020-10-31"
+ },
+ "responses": {
+ "204": {}
+ }
+}
diff --git a/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/stable/2020-10-31/examples/EventRouteGet.json b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/stable/2020-10-31/examples/EventRouteGet.json
new file mode 100644
index 000000000000..b45b652cecaa
--- /dev/null
+++ b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/stable/2020-10-31/examples/EventRouteGet.json
@@ -0,0 +1,15 @@
+{
+ "parameters": {
+ "id": "eventroute-001",
+ "api-version": "2020-10-31"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "eventroute-001",
+ "endpointName": "endpoint-001",
+ "filter": "type = 'Microsoft.DigitalTwins.Twin.Create'"
+ }
+ }
+ }
+}
diff --git a/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/stable/2020-10-31/examples/EventRoutePut.json b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/stable/2020-10-31/examples/EventRoutePut.json
new file mode 100644
index 000000000000..937e1f7a8cd1
--- /dev/null
+++ b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/stable/2020-10-31/examples/EventRoutePut.json
@@ -0,0 +1,13 @@
+{
+ "parameters": {
+ "id": "eventroute-001",
+ "eventRoute": {
+ "endpointName": "endpoint-001",
+ "filter": "true"
+ },
+ "api-version": "2020-10-31"
+ },
+ "responses": {
+ "204": {}
+ }
+}
diff --git a/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/stable/2020-10-31/examples/EventRoutePutWithFilter.json b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/stable/2020-10-31/examples/EventRoutePutWithFilter.json
new file mode 100644
index 000000000000..63045804a4b6
--- /dev/null
+++ b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/stable/2020-10-31/examples/EventRoutePutWithFilter.json
@@ -0,0 +1,13 @@
+{
+ "parameters": {
+ "id": "eventroute-001",
+ "eventRoute": {
+ "endpointName": "endpoint-001",
+ "filter": "type = 'Microsoft.DigitalTwins.Twin.Create'"
+ },
+ "api-version": "2020-10-31"
+ },
+ "responses": {
+ "204": {}
+ }
+}
diff --git a/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/stable/2020-10-31/examples/EventRoutesList.json b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/stable/2020-10-31/examples/EventRoutesList.json
new file mode 100644
index 000000000000..8075d4942a96
--- /dev/null
+++ b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/stable/2020-10-31/examples/EventRoutesList.json
@@ -0,0 +1,24 @@
+{
+ "parameters": {
+ "api-version": "2020-10-31"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "eventroute-001",
+ "endpointName": "endpoint-001",
+ "filter": "type = 'Microsoft.DigitalTwins.Twin.Create'"
+ },
+ {
+ "id": "eventroute-002",
+ "endpointName": "endpoint-002",
+ "filter": "type = 'Microsoft.DigitalTwins.Twin.Create' OR type = 'microsoft.iot.telemetry'"
+ }
+ ],
+ "nextLink": "url-to-next-page"
+ }
+ }
+ }
+}
diff --git a/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/stable/2020-10-31/examples/GetComponent.json b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/stable/2020-10-31/examples/GetComponent.json
new file mode 100644
index 000000000000..3bfbe8c87b49
--- /dev/null
+++ b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/stable/2020-10-31/examples/GetComponent.json
@@ -0,0 +1,52 @@
+{
+ "parameters": {
+ "api-version": "2020-10-31",
+ "id": "myTwinId",
+ "componentPath": "myComponent"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "$metadata": {
+ "$model": "dtmi:com:example:interfaces:interfaceName;1",
+ "property1": {
+ "desiredValue": 1,
+ "desiredVersion": 1,
+ "ackVersion": 1,
+ "ackCode": 200,
+ "ackDescription": "description",
+ "lastUpdateTime": "2020-05-23T21:44:02Z"
+ },
+ "property2": {
+ "desiredValue": {
+ "subProperty1": "some value",
+ "subProperty2": "some other value"
+ },
+ "desiredVersion": 1,
+ "ackVersion": 1,
+ "ackCode": 200,
+ "ackDescription": "description",
+ "lastUpdateTime": "2020-05-23T21:44:02Z"
+ }
+ },
+ "property1": 1,
+ "property2": {
+ "subProperty1": "some value",
+ "subProperty2": "some other value"
+ },
+ "component1": {
+ "$metadata": {
+ "componentProperty": {
+ "desiredValue": "some value",
+ "desiredVersion": 1,
+ "ackVersion": 1,
+ "ackCode": 200,
+ "ackDescription": "description",
+ "lastUpdateTime": "2020-05-23T21:44:02Z"
+ }
+ }
+ }
+ }
+ }
+ }
+}
diff --git a/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/stable/2020-10-31/examples/GetIncomingRelationship.json b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/stable/2020-10-31/examples/GetIncomingRelationship.json
new file mode 100644
index 000000000000..69bef6f47357
--- /dev/null
+++ b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/stable/2020-10-31/examples/GetIncomingRelationship.json
@@ -0,0 +1,27 @@
+{
+ "parameters": {
+ "api-version": "2020-10-31",
+ "id": "mySourceTwin"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "$sourceId": "mySourceTwin",
+ "$relationshipId": "firstRelationshipId",
+ "$relationshipName": "myRelationship",
+ "$relationshipLink": "/digitaltwins/mySourceTwin/relationships/myRelationship/firstRelationshipId"
+ },
+ {
+ "$sourceId": "mySourceTwin",
+ "$relationshipId": "secondRelationshipId",
+ "$relationshipName": "myRelationship",
+ "$relationshipLink": "/digitaltwins/mySourceTwin/relationships/myRelationship/secondRelationshipId"
+ }
+ ],
+ "nextLink": "url-to-next-page"
+ }
+ }
+ }
+}
diff --git a/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/stable/2020-10-31/examples/GetRelationship.json b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/stable/2020-10-31/examples/GetRelationship.json
new file mode 100644
index 000000000000..919f6207c1c4
--- /dev/null
+++ b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/stable/2020-10-31/examples/GetRelationship.json
@@ -0,0 +1,31 @@
+{
+ "parameters": {
+ "api-version": "2020-10-31",
+ "id": "mySourceTwin"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "$sourceId": "mySourceTwin",
+ "$relationshipId": "firstRelationshipId",
+ "$targetId": "targetTwinId",
+ "$relationshipName": "myRelationship",
+ "$etag": "W/\"1553dbf5-0052-4be8-bea8-46269075b503\"",
+ "property": "value"
+ },
+ {
+ "$sourceId": "mySourceTwin",
+ "$relationshipId": "secondRelationshipId",
+ "$targetId": "targetTwinId",
+ "$relationshipName": "myRelationship",
+ "$etag": "W/\"2552a0a7-0666-4d5e-a67f-ece5b9b81fe0\"",
+ "property": "value"
+ }
+ ],
+ "nextLink": "url-to-next-page"
+ }
+ }
+ }
+}
diff --git a/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/stable/2020-10-31/examples/GetRelationshipById.json b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/stable/2020-10-31/examples/GetRelationshipById.json
new file mode 100644
index 000000000000..dd31b91a3591
--- /dev/null
+++ b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/stable/2020-10-31/examples/GetRelationshipById.json
@@ -0,0 +1,19 @@
+{
+ "parameters": {
+ "api-version": "2020-10-31",
+ "id": "mySourceTwin",
+ "relationshipId": "myRelationshipId"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "$relationshipId": "myRelationshipId",
+ "$sourceId": "mySourceTwin",
+ "$targetId": "myTargetTwin",
+ "$relationshipName": "myRelationship",
+ "$etag": "W/\"1553dbf5-0052-4be8-bea8-46269075b503\"",
+ "relationshipProperty": "some value"
+ }
+ }
+ }
+}
diff --git a/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/stable/2020-10-31/examples/GetRelationshipByRelationshipName.json b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/stable/2020-10-31/examples/GetRelationshipByRelationshipName.json
new file mode 100644
index 000000000000..18224390bc25
--- /dev/null
+++ b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/stable/2020-10-31/examples/GetRelationshipByRelationshipName.json
@@ -0,0 +1,32 @@
+{
+ "parameters": {
+ "api-version": "2020-10-31",
+ "id": "mySourceTwin",
+ "relationshipName": "myRelationship"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "$sourceId": "mySourceTwin",
+ "$relationshipId": "firstRelationshipId",
+ "$targetId": "targetTwinId",
+ "$relationshipName": "myRelationship",
+ "$etag": "W/\"1553dbf5-0052-4be8-bea8-46269075b503\"",
+ "property": "value"
+ },
+ {
+ "$sourceId": "mySourceTwin",
+ "$relationshipId": "secondRelationshipId",
+ "$targetId": "targetTwinId",
+ "$relationshipName": "myRelationship",
+ "$etag": "W/\"2552a0a7-0666-4d5e-a67f-ece5b9b81fe0\"",
+ "property": "value"
+ }
+ ],
+ "nextLink": "url-to-next-page"
+ }
+ }
+ }
+}
diff --git a/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/stable/2020-10-31/examples/GetTwin.json b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/stable/2020-10-31/examples/GetTwin.json
new file mode 100644
index 000000000000..dd68f5b7d31a
--- /dev/null
+++ b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/stable/2020-10-31/examples/GetTwin.json
@@ -0,0 +1,52 @@
+{
+ "parameters": {
+ "api-version": "2020-10-31",
+ "id": "myTwinId"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "$dtId": "myTwinId",
+ "$metadata": {
+ "$model": "dtmi:com:example:interfaces:interfaceName;1",
+ "property1": {
+ "desiredValue": 1,
+ "desiredVersion": 1,
+ "ackVersion": 1,
+ "ackCode": 200,
+ "ackDescription": "description",
+ "lastUpdateTime": "2020-05-23T21:44:02Z"
+ },
+ "property2": {
+ "desiredValue": {
+ "subProperty1": "some value",
+ "subProperty2": "some other value"
+ },
+ "desiredVersion": 1,
+ "ackVersion": 1,
+ "ackCode": 200,
+ "ackDescription": "description",
+ "lastUpdateTime": "2020-05-23T21:44:02Z"
+ }
+ },
+ "property1": 1,
+ "property2": {
+ "subProperty1": "some value",
+ "subProperty2": "some other value"
+ },
+ "component1": {
+ "$metadata": {
+ "componentProperty": {
+ "desiredValue": "some value",
+ "desiredVersion": 1,
+ "ackVersion": 1,
+ "ackCode": 200,
+ "ackDescription": "description",
+ "lastUpdateTime": "2020-05-23T21:44:02Z"
+ }
+ }
+ }
+ }
+ }
+ }
+}
diff --git a/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/stable/2020-10-31/examples/ModelAdd.json b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/stable/2020-10-31/examples/ModelAdd.json
new file mode 100644
index 000000000000..a5017f15d487
--- /dev/null
+++ b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/stable/2020-10-31/examples/ModelAdd.json
@@ -0,0 +1,47 @@
+{
+ "parameters": {
+ "models": [
+ {
+ "@id": "dtmi:com:example:Sample;1",
+ "@type": "Interface",
+ "displayName": "Sample Interface",
+ "contents": [
+ {
+ "@type": "Property",
+ "name": "name",
+ "displayName": "Sample instance name",
+ "schema": "string"
+ },
+ {
+ "@type": "Property",
+ "name": "temp",
+ "displayName": "Sample instance temperature",
+ "schema": "integer"
+ },
+ {
+ "@type": "Property",
+ "name": "comfortIndex",
+ "displayName": "Sample instance comfort index",
+ "schema": "integer"
+ }
+ ],
+ "@context": "dtmi:dtdl:context;2"
+ }
+ ],
+ "api-version": "2020-10-31"
+ },
+ "responses": {
+ "201": {
+ "body": [
+ {
+ "id": "dtmi:com:example:Sample;1",
+ "displayName": {
+ "en": "Sample Interface"
+ },
+ "uploadTime": "2020-03-01T17:32:28Z",
+ "decommissioned": false
+ }
+ ]
+ }
+ }
+}
diff --git a/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/stable/2020-10-31/examples/ModelGetById.json b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/stable/2020-10-31/examples/ModelGetById.json
new file mode 100644
index 000000000000..edd1e1125172
--- /dev/null
+++ b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/stable/2020-10-31/examples/ModelGetById.json
@@ -0,0 +1,15 @@
+{
+ "parameters": {
+ "id": "dtmi:com:example:Sample;1",
+ "api-version": "2020-10-31"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "dtmi:com:example:Sample;1",
+ "uploadTime": "2020-03-01T17:32:28Z",
+ "decommissioned": false
+ }
+ }
+ }
+}
diff --git a/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/stable/2020-10-31/examples/ModelGetByIdWithIncludeModelDefinition.json b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/stable/2020-10-31/examples/ModelGetByIdWithIncludeModelDefinition.json
new file mode 100644
index 000000000000..90f1ed206de8
--- /dev/null
+++ b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/stable/2020-10-31/examples/ModelGetByIdWithIncludeModelDefinition.json
@@ -0,0 +1,41 @@
+{
+ "parameters": {
+ "id": "dtmi:com:example:Sample;1",
+ "includeModelDefinition": true,
+ "api-version": "2020-10-31"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "dtmi:com:example:Sample;1",
+ "uploadTime": "2020-03-01T17:32:28Z",
+ "decommissioned": false,
+ "model": {
+ "@id": "dtmi:com:example:Sample;1",
+ "@type": "Interface",
+ "contents": [
+ {
+ "@type": "Property",
+ "name": "name",
+ "displayName": "Sample instance name",
+ "schema": "string"
+ },
+ {
+ "@type": "Property",
+ "name": "temp",
+ "displayName": "Sample instance temperature",
+ "schema": "integer"
+ },
+ {
+ "@type": "Property",
+ "name": "comfortIndex",
+ "displayName": "Sample instance comfort index",
+ "schema": "integer"
+ }
+ ],
+ "@context": "dtmi:dtdl:context;2"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/stable/2020-10-31/examples/ModelUpdateDecommissioned.json b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/stable/2020-10-31/examples/ModelUpdateDecommissioned.json
new file mode 100644
index 000000000000..47a17c17fd8f
--- /dev/null
+++ b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/stable/2020-10-31/examples/ModelUpdateDecommissioned.json
@@ -0,0 +1,16 @@
+{
+ "parameters": {
+ "id": "dtmi:com:example:Sample;1",
+ "updateModel": [
+ {
+ "op": "replace",
+ "path": "/decommissioned",
+ "value": true
+ }
+ ],
+ "api-version": "2020-10-31"
+ },
+ "responses": {
+ "204": {}
+ }
+}
diff --git a/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/stable/2020-10-31/examples/ModelsGet.json b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/stable/2020-10-31/examples/ModelsGet.json
new file mode 100644
index 000000000000..fd34a6fcc0d2
--- /dev/null
+++ b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/stable/2020-10-31/examples/ModelsGet.json
@@ -0,0 +1,35 @@
+{
+ "parameters": {
+ "api-version": "2020-10-31"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "dtmi:com:example:Sample;1",
+ "uploadTime": "2020-03-01T17:32:28Z",
+ "decommissioned": false
+ },
+ {
+ "id": "dtmi:com:example:SampleDeviceModel;1",
+ "displayName": {
+ "en": "My Device Model"
+ },
+ "uploadTime": "2020-05-01T17:32:28Z",
+ "decommissioned": false
+ },
+ {
+ "id": "dtmi:com:example:AnotherSample;1",
+ "displayName": {
+ "en": "My Sample"
+ },
+ "uploadTime": "2020-03-01T17:32:28Z",
+ "decommissioned": false
+ }
+ ],
+ "nextLink": "url-to-next-page"
+ }
+ }
+ }
+}
diff --git a/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/stable/2020-10-31/examples/ModelsGetWithDependenciesAndIncludeModelDefinition.json b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/stable/2020-10-31/examples/ModelsGetWithDependenciesAndIncludeModelDefinition.json
new file mode 100644
index 000000000000..16754af81549
--- /dev/null
+++ b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/stable/2020-10-31/examples/ModelsGetWithDependenciesAndIncludeModelDefinition.json
@@ -0,0 +1,70 @@
+{
+ "parameters": {
+ "includeModelDefinition": true,
+ "dependenciesFor": [
+ "dtmi:com:example:SampleDeviceModel;1"
+ ],
+ "x-ms-max-item-count": 20,
+ "api-version": "2020-10-31"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "dtmi:com:example:Sample;1",
+ "uploadTime": "2020-03-01T17:32:28Z",
+ "decommissioned": false,
+ "model": {
+ "@id": "dtmi:com:example:Sample;1",
+ "@type": "Interface",
+ "contents": [
+ {
+ "@type": "Property",
+ "name": "name",
+ "displayName": "Sample instance name",
+ "schema": "string"
+ },
+ {
+ "@type": "Property",
+ "name": "temp",
+ "displayName": "Sample instance temperature",
+ "schema": "integer"
+ },
+ {
+ "@type": "Property",
+ "name": "comfortIndex",
+ "displayName": "Sample instance comfort index",
+ "schema": "integer"
+ }
+ ],
+ "@context": "dtmi:dtdl:context;2"
+ }
+ },
+ {
+ "id": "dtmi:com:example:SampleDeviceModel;1",
+ "displayName": {
+ "en": "My Device Model"
+ },
+ "uploadTime": "2020-03-01T17:32:28Z",
+ "decommissioned": false,
+ "model": {
+ "@id": "dtmi:com:example:SampleDeviceModel;1",
+ "@type": "Interface",
+ "displayName": "My Device Model",
+ "contents": [
+ {
+ "@type": "Component",
+ "name": "Sample",
+ "schema": "dtmi:com:example:Sample;1"
+ }
+ ],
+ "@context": "dtmi:dtdl:context;2"
+ }
+ }
+ ],
+ "nextLink": "url-to-next-page"
+ }
+ }
+ }
+}
diff --git a/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/stable/2020-10-31/examples/PatchComponentAdvancedExample.json b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/stable/2020-10-31/examples/PatchComponentAdvancedExample.json
new file mode 100644
index 000000000000..cbf869751468
--- /dev/null
+++ b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/stable/2020-10-31/examples/PatchComponentAdvancedExample.json
@@ -0,0 +1,27 @@
+{
+ "parameters": {
+ "api-version": "2020-10-31",
+ "id": "myTwinId",
+ "componentPath": "myComponent",
+ "patchDocument": [
+ {
+ "op": "add",
+ "path": "/property1",
+ "value": 1
+ },
+ {
+ "op": "remove",
+ "path": "/property2"
+ },
+ {
+ "op": "replace",
+ "path": "/property3/subProperty1",
+ "value": "new value"
+ }
+ ]
+ },
+ "responses": {
+ "202": {},
+ "204": {}
+ }
+}
diff --git a/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/stable/2020-10-31/examples/PatchComponentBasicExample.json b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/stable/2020-10-31/examples/PatchComponentBasicExample.json
new file mode 100644
index 000000000000..14d2de803f73
--- /dev/null
+++ b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/stable/2020-10-31/examples/PatchComponentBasicExample.json
@@ -0,0 +1,18 @@
+{
+ "parameters": {
+ "api-version": "2020-10-31",
+ "id": "myTwinId",
+ "componentPath": "myComponent",
+ "patchDocument": [
+ {
+ "op": "add",
+ "path": "/property",
+ "value": 1
+ }
+ ]
+ },
+ "responses": {
+ "202": {},
+ "204": {}
+ }
+}
diff --git a/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/stable/2020-10-31/examples/PatchRelationshipAdvancedExample.json b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/stable/2020-10-31/examples/PatchRelationshipAdvancedExample.json
new file mode 100644
index 000000000000..9d9eea1c56a0
--- /dev/null
+++ b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/stable/2020-10-31/examples/PatchRelationshipAdvancedExample.json
@@ -0,0 +1,26 @@
+{
+ "parameters": {
+ "api-version": "2020-10-31",
+ "id": "myTwinId",
+ "relationshipId": "myRelationshipId",
+ "patchDocument": [
+ {
+ "op": "add",
+ "path": "/property1",
+ "value": 1
+ },
+ {
+ "op": "remove",
+ "path": "/property2"
+ },
+ {
+ "op": "replace",
+ "path": "/property3/subProperty1",
+ "value": "new value"
+ }
+ ]
+ },
+ "responses": {
+ "204": {}
+ }
+}
diff --git a/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/stable/2020-10-31/examples/PatchRelationshipBasicExample.json b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/stable/2020-10-31/examples/PatchRelationshipBasicExample.json
new file mode 100644
index 000000000000..a45183bf6c0f
--- /dev/null
+++ b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/stable/2020-10-31/examples/PatchRelationshipBasicExample.json
@@ -0,0 +1,17 @@
+{
+ "parameters": {
+ "api-version": "2020-10-31",
+ "id": "myTwinId",
+ "relationshipId": "myRelationshipId",
+ "patchDocument": [
+ {
+ "op": "add",
+ "path": "/property",
+ "value": 1
+ }
+ ]
+ },
+ "responses": {
+ "204": {}
+ }
+}
diff --git a/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/stable/2020-10-31/examples/PatchTwinAdvancedExample.json b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/stable/2020-10-31/examples/PatchTwinAdvancedExample.json
new file mode 100644
index 000000000000..f018af463d1a
--- /dev/null
+++ b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/stable/2020-10-31/examples/PatchTwinAdvancedExample.json
@@ -0,0 +1,26 @@
+{
+ "parameters": {
+ "api-version": "2020-10-31",
+ "id": "myNewTwinId",
+ "patchDocument": [
+ {
+ "op": "replace",
+ "path": "/property1",
+ "value": 1
+ },
+ {
+ "op": "add",
+ "path": "/property2/subProperty1",
+ "value": 1
+ },
+ {
+ "op": "remove",
+ "path": "/property3"
+ }
+ ]
+ },
+ "responses": {
+ "202": {},
+ "204": {}
+ }
+}
diff --git a/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/stable/2020-10-31/examples/PatchTwinBasicExample.json b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/stable/2020-10-31/examples/PatchTwinBasicExample.json
new file mode 100644
index 000000000000..4b5e3a015ece
--- /dev/null
+++ b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/stable/2020-10-31/examples/PatchTwinBasicExample.json
@@ -0,0 +1,17 @@
+{
+ "parameters": {
+ "api-version": "2020-10-31",
+ "id": "myNewTwinId",
+ "patchDocument": [
+ {
+ "op": "replace",
+ "path": "/property1",
+ "value": 1
+ }
+ ]
+ },
+ "responses": {
+ "202": {},
+ "204": {}
+ }
+}
diff --git a/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/stable/2020-10-31/examples/PutTwinAdvancedExample.json b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/stable/2020-10-31/examples/PutTwinAdvancedExample.json
new file mode 100644
index 000000000000..e52e9481e53b
--- /dev/null
+++ b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/stable/2020-10-31/examples/PutTwinAdvancedExample.json
@@ -0,0 +1,68 @@
+{
+ "parameters": {
+ "api-version": "2020-10-31",
+ "id": "myNewTwinId",
+ "If-None-Match": "*",
+ "twin": {
+ "$metadata": {
+ "$model": "dtmi:com:example:interfaces:interfaceName;1"
+ },
+ "property1": 1,
+ "property2": {
+ "subProperty1": "some value",
+ "subProperty2": "some other value"
+ },
+ "component1": {
+ "$metadata": {},
+ "componentProperty": "some value"
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "$dtId": "myNewTwinId",
+ "$metadata": {
+ "$model": "dtmi:com:example:interfaces:interfaceName;1",
+ "property1": {
+ "desiredValue": 1,
+ "desiredVersion": 1,
+ "ackVersion": 1,
+ "ackCode": 200,
+ "ackDescription": "description",
+ "lastUpdateTime": "2020-05-23T21:44:02Z"
+ },
+ "property2": {
+ "desiredValue": {
+ "subProperty1": "some value",
+ "subProperty2": "some other value"
+ },
+ "desiredVersion": 1,
+ "ackVersion": 1,
+ "ackCode": 200,
+ "ackDescription": "description",
+ "lastUpdateTime": "2020-05-23T21:44:02Z"
+ }
+ },
+ "property1": 1,
+ "property2": {
+ "subProperty1": "some value",
+ "subProperty2": "some other value"
+ },
+ "component1": {
+ "$metadata": {
+ "componentProperty": {
+ "desiredValue": "some value",
+ "desiredVersion": 1,
+ "ackVersion": 1,
+ "ackCode": 200,
+ "ackDescription": "description",
+ "lastUpdateTime": "2020-05-23T21:44:02Z"
+ }
+ }
+ }
+ }
+ },
+ "202": {}
+ }
+}
diff --git a/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/stable/2020-10-31/examples/PutTwinBasicExample.json b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/stable/2020-10-31/examples/PutTwinBasicExample.json
new file mode 100644
index 000000000000..144fd8fec259
--- /dev/null
+++ b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/stable/2020-10-31/examples/PutTwinBasicExample.json
@@ -0,0 +1,22 @@
+{
+ "parameters": {
+ "api-version": "2020-10-31",
+ "id": "myNewTwinId",
+ "twin": {
+ "$metadata": {
+ "$model": "dtmi:com:example:interfaces:interfaceName;1"
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "$dtId": "myNewTwinId",
+ "$metadata": {
+ "$model": "dtmi:com:example:interfaces:interfaceName;1"
+ }
+ }
+ },
+ "202": {}
+ }
+}
diff --git a/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/stable/2020-10-31/examples/QueryFirstPage.json b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/stable/2020-10-31/examples/QueryFirstPage.json
new file mode 100644
index 000000000000..ba4afbe86671
--- /dev/null
+++ b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/stable/2020-10-31/examples/QueryFirstPage.json
@@ -0,0 +1,44 @@
+{
+ "parameters": {
+ "querySpecification": {
+ "query": "SELECT * FROM DIGITALTWINS WHERE temp = 79"
+ },
+ "api-version": "2020-10-31"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "$dtId": "Twin-01",
+ "$metadata": {
+ "$model": "dtmi:com:example:Sample;1"
+ },
+ "name": "Sample01",
+ "temp": 79,
+ "comfortIndex": 50
+ },
+ {
+ "$dtId": "Twin-02",
+ "$metadata": {
+ "$model": "dtmi:com:example:Sample;1"
+ },
+ "name": "Sample02",
+ "temp": 79,
+ "comfortIndex": 50
+ },
+ {
+ "$dtId": "Twin-03",
+ "$metadata": {
+ "$model": "dtmi:com:example:Sample;1"
+ },
+ "name": "Sample03",
+ "temp": 79,
+ "comfortIndex": 50
+ }
+ ],
+ "continuationToken": ""
+ }
+ }
+ }
+}
diff --git a/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/stable/2020-10-31/examples/QueryJoin.json b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/stable/2020-10-31/examples/QueryJoin.json
new file mode 100644
index 000000000000..e6426f051780
--- /dev/null
+++ b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/stable/2020-10-31/examples/QueryJoin.json
@@ -0,0 +1,56 @@
+{
+ "parameters": {
+ "querySpecification": {
+ "query": "SELECT Widget, Gadget FROM DIGITALTWINS Widget JOIN Gadget RELATED Widget.Contains WHERE Widget.$dtId = 'Twin-01'"
+ },
+ "api-version": "2020-10-31"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "Widget": {
+ "$dtId": "Twin-01",
+ "$metadata": {
+ "$model": "dtmi:com:example:Sample;1"
+ },
+ "name": "Sample01",
+ "temp": 79,
+ "comfortIndex": 50
+ },
+ "Gadget": {
+ "$dtId": "Twin-02",
+ "$metadata": {
+ "$model": "dtmi:com:example:Sample;1"
+ },
+ "name": "Sample02",
+ "temp": 79,
+ "comfortIndex": 50
+ }
+ },
+ {
+ "Widget": {
+ "$dtId": "Twin-01",
+ "$metadata": {
+ "$model": "dtmi:com:example:Sample;1"
+ },
+ "name": "Sample01",
+ "temp": 79,
+ "comfortIndex": 50
+ },
+ "Gadget": {
+ "$dtId": "Twin-10",
+ "$metadata": {
+ "$model": "dtmi:com:example:Sample;1"
+ },
+ "name": "Sample10",
+ "temp": 79,
+ "comfortIndex": 50
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/stable/2020-10-31/examples/QueryNextPage.json b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/stable/2020-10-31/examples/QueryNextPage.json
new file mode 100644
index 000000000000..4c8028135709
--- /dev/null
+++ b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/stable/2020-10-31/examples/QueryNextPage.json
@@ -0,0 +1,43 @@
+{
+ "parameters": {
+ "querySpecification": {
+ "continuationToken": ""
+ },
+ "api-version": "2020-10-31"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "$dtId": "Twin-04",
+ "$metadata": {
+ "$model": "dtmi:com:example:Sample;1"
+ },
+ "name": "Sample04",
+ "temp": 79,
+ "comfortIndex": 50
+ },
+ {
+ "$dtId": "Twin-05",
+ "$metadata": {
+ "$model": "dtmi:com:example:Sample;1"
+ },
+ "name": "Sample05",
+ "temp": 79,
+ "comfortIndex": 50
+ },
+ {
+ "$dtId": "Twin-06",
+ "$metadata": {
+ "$model": "dtmi:com:example:Sample;1"
+ },
+ "name": "Sample06",
+ "temp": 79,
+ "comfortIndex": 50
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/stable/2020-10-31/examples/SendTelemetry.json b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/stable/2020-10-31/examples/SendTelemetry.json
new file mode 100644
index 000000000000..bf7bed32bcbc
--- /dev/null
+++ b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/stable/2020-10-31/examples/SendTelemetry.json
@@ -0,0 +1,14 @@
+{
+ "parameters": {
+ "api-version": "2020-10-31",
+ "id": "myTwinId",
+ "Message-Id": "e5ca50dd-ca31-4fae-8d84-3af5a72b10c5",
+ "Telemetry-Source-Time": "1985-04-12T23:20:50.52Z",
+ "telemetry": {
+ "temperature": 1
+ }
+ },
+ "responses": {
+ "204": {}
+ }
+}
diff --git a/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/stable/2020-10-31/examples/SendTelemetryFromComponent.json b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/stable/2020-10-31/examples/SendTelemetryFromComponent.json
new file mode 100644
index 000000000000..25841e14c07f
--- /dev/null
+++ b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/stable/2020-10-31/examples/SendTelemetryFromComponent.json
@@ -0,0 +1,15 @@
+{
+ "parameters": {
+ "api-version": "2020-10-31",
+ "id": "myTwinId",
+ "componentPath": "myComponent",
+ "Message-Id": "e5ca50dd-ca31-4fae-8d84-3af5a72b10c5",
+ "Telemetry-Source-Time": "1985-04-12T23:20:50.52Z",
+ "telemetry": {
+ "temperature": 1
+ }
+ },
+ "responses": {
+ "204": {}
+ }
+}
diff --git a/specification/digitaltwins/data-plane/readme.md b/specification/digitaltwins/data-plane/readme.md
index c5a96a455705..31d00fb429ad 100644
--- a/specification/digitaltwins/data-plane/readme.md
+++ b/specification/digitaltwins/data-plane/readme.md
@@ -26,7 +26,16 @@ These are the global settings for Azure Digital Twins.
```yaml
openapi-type: data-plane
-tag: package-2020-05-31-preview
+tag: package-2020-10-31
+```
+
+### Tag: package-2020-10-31
+
+These settings apply only when `--tag=package-2020-10-31` is specified on the command line.
+
+```yaml $(tag) == 'package-2020-10-31'
+input-file:
+ - Microsoft.DigitalTwins/stable/2020-10-31/digitaltwins.json
```
### Tag: package-2020-05-31-preview
diff --git a/specification/digitaltwins/resource-manager/Microsoft.DigitalTwins/stable/2020-10-31/digitaltwins.json b/specification/digitaltwins/resource-manager/Microsoft.DigitalTwins/stable/2020-10-31/digitaltwins.json
index a649d243d702..c6720605f460 100644
--- a/specification/digitaltwins/resource-manager/Microsoft.DigitalTwins/stable/2020-10-31/digitaltwins.json
+++ b/specification/digitaltwins/resource-manager/Microsoft.DigitalTwins/stable/2020-10-31/digitaltwins.json
@@ -137,7 +137,6 @@
],
"description": "Update metadata of DigitalTwinsInstance.",
"operationId": "DigitalTwins_Update",
- "x-ms-long-running-operation": true,
"x-ms-examples": {
"Patch a DigitalTwinsInstance resource": {
"$ref": "./examples/DigitalTwinsPatch_example.json"
@@ -895,6 +894,7 @@
"ExternalResource": {
"description": "Definition of a resource.",
"type": "object",
+ "x-ms-azure-resource": true,
"properties": {
"id": {
"readOnly": true,
@@ -916,7 +916,6 @@
},
"DigitalTwinsEndpointResource": {
"description": "DigitalTwinsInstance endpoint resource.",
- "x-ms-azure-resource": true,
"allOf": [
{
"$ref": "#/definitions/ExternalResource"
@@ -927,7 +926,10 @@
"description": "DigitalTwinsInstance endpoint resource properties.",
"$ref": "#/definitions/DigitalTwinsEndpointResourceProperties"
}
- }
+ },
+ "required": [
+ "properties"
+ ]
},
"DigitalTwinsEndpointResourceProperties": {
"description": "Properties related to Digital Twins Endpoint",
diff --git a/specification/digitaltwins/resource-manager/Microsoft.DigitalTwins/stable/2020-10-31/examples/DigitalTwinsCheckNameAvailability_example.json b/specification/digitaltwins/resource-manager/Microsoft.DigitalTwins/stable/2020-10-31/examples/DigitalTwinsCheckNameAvailability_example.json
index 0df8dfcc15b9..380d459cd796 100644
--- a/specification/digitaltwins/resource-manager/Microsoft.DigitalTwins/stable/2020-10-31/examples/DigitalTwinsCheckNameAvailability_example.json
+++ b/specification/digitaltwins/resource-manager/Microsoft.DigitalTwins/stable/2020-10-31/examples/DigitalTwinsCheckNameAvailability_example.json
@@ -1,7 +1,7 @@
{
"parameters": {
"subscriptionId": "50016170-c839-41ba-a724-51e9df440b9e",
- "location": "WestUS",
+ "location": "WestUS2",
"api-version": "2020-10-31",
"digitalTwinsInstanceCheckName": {
"name": "myadtinstance",
diff --git a/specification/digitaltwins/resource-manager/Microsoft.DigitalTwins/stable/2020-10-31/examples/DigitalTwinsDelete_example.json b/specification/digitaltwins/resource-manager/Microsoft.DigitalTwins/stable/2020-10-31/examples/DigitalTwinsDelete_example.json
index bc330601fb42..82ea13bb729a 100644
--- a/specification/digitaltwins/resource-manager/Microsoft.DigitalTwins/stable/2020-10-31/examples/DigitalTwinsDelete_example.json
+++ b/specification/digitaltwins/resource-manager/Microsoft.DigitalTwins/stable/2020-10-31/examples/DigitalTwinsDelete_example.json
@@ -8,8 +8,8 @@
"responses": {
"200": {
"body": {
- "id": "/subscriptions/50016170-c839-41ba-a724-51e9df440b9e/resourcegroups/resRg/providers/Microsoft.DigitalTwins/DigitalTwinsInstance/myDigitalTwinsService",
- "location": "westus",
+ "id": "/subscriptions/50016170-c839-41ba-a724-51e9df440b9e/resourcegroups/resRg/providers/Microsoft.DigitalTwins/digitalTwinsInstances/myDigitalTwinsService",
+ "location": "westus2",
"type": "Microsoft.DigitalTwins/digitalTwinsInstances",
"name": "myDigitalTwinsService",
"properties": {
@@ -22,8 +22,8 @@
},
"202": {
"body": {
- "id": "/subscriptions/50016170-c839-41ba-a724-51e9df440b9e/resourcegroups/resRg/providers/Microsoft.DigitalTwins/DigitalTwinsInstance/myDigitalTwinsService",
- "location": "westus",
+ "id": "/subscriptions/50016170-c839-41ba-a724-51e9df440b9e/resourcegroups/resRg/providers/Microsoft.DigitalTwins/digitalTwinsInstances/myDigitalTwinsService",
+ "location": "westus2",
"type": "Microsoft.DigitalTwins/digitalTwinsInstances",
"name": "myDigitalTwinsService",
"properties": {
diff --git a/specification/digitaltwins/resource-manager/Microsoft.DigitalTwins/stable/2020-10-31/examples/DigitalTwinsEndpointDelete_example.json b/specification/digitaltwins/resource-manager/Microsoft.DigitalTwins/stable/2020-10-31/examples/DigitalTwinsEndpointDelete_example.json
index 55c92b479c41..207df5683382 100644
--- a/specification/digitaltwins/resource-manager/Microsoft.DigitalTwins/stable/2020-10-31/examples/DigitalTwinsEndpointDelete_example.json
+++ b/specification/digitaltwins/resource-manager/Microsoft.DigitalTwins/stable/2020-10-31/examples/DigitalTwinsEndpointDelete_example.json
@@ -9,28 +9,28 @@
"responses": {
"200": {
"body": {
- "id": "/subscriptions/50016170-c839-41ba-a724-51e9df440b9e/resourcegroups/resRg/providers/Microsoft.DigitalTwins/DigitalTwinsInstance/myDigitalTwinsService/endpoints/myServiceBus",
+ "id": "/subscriptions/50016170-c839-41ba-a724-51e9df440b9e/resourcegroups/resRg/providers/Microsoft.DigitalTwins/digitalTwinsInstances/myDigitalTwinsService/endpoints/myServiceBus",
"type": "Microsoft.DigitalTwins/digitalTwinsInstances/endpoints",
"name": "myendpoint",
"properties": {
"endpointType": "ServiceBus",
"provisioningState": "Failed",
- "primaryConnectionString": "Endpoint=sb://mysb.servicebus.windows.net/;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=***",
- "secondaryConnectionString": "Endpoint=sb://mysb.servicebus.windows.net/;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=***",
+ "primaryConnectionString": "Endpoint=sb://***/;SharedAccessKeyName=***;SharedAccessKey=***;EntityPath=***",
+ "secondaryConnectionString": "Endpoint=sb://***/;SharedAccessKeyName=***;SharedAccessKey=***;EntityPath=***",
"createdTime": "2019-11-19T01:10:34.350Z"
}
}
},
"202": {
"body": {
- "id": "/subscriptions/50016170-c839-41ba-a724-51e9df440b9e/resourcegroups/resRg/providers/Microsoft.DigitalTwins/DigitalTwinsInstance/myDigitalTwinsService/endpoints/myServiceBus",
+ "id": "/subscriptions/50016170-c839-41ba-a724-51e9df440b9e/resourcegroups/resRg/providers/Microsoft.DigitalTwins/digitalTwinsInstances/myDigitalTwinsService/endpoints/myServiceBus",
"type": "Microsoft.DigitalTwins/digitalTwinsInstances/endpoints",
"name": "myendpoint",
"properties": {
"endpointType": "ServiceBus",
"provisioningState": "Deleting",
- "primaryConnectionString": "Endpoint=sb://mysb.servicebus.windows.net/;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=***",
- "secondaryConnectionString": "Endpoint=sb://mysb.servicebus.windows.net/;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=***",
+ "primaryConnectionString": "Endpoint=sb://***/;SharedAccessKeyName=***;SharedAccessKey=***;EntityPath=***",
+ "secondaryConnectionString": "Endpoint=sb://***/;SharedAccessKeyName=***;SharedAccessKey=***;EntityPath=***",
"createdTime": "2019-11-19T01:10:34.350Z"
}
}
diff --git a/specification/digitaltwins/resource-manager/Microsoft.DigitalTwins/stable/2020-10-31/examples/DigitalTwinsEndpointGet_example.json b/specification/digitaltwins/resource-manager/Microsoft.DigitalTwins/stable/2020-10-31/examples/DigitalTwinsEndpointGet_example.json
index 800b1d510614..2a6a1d3fa6dc 100644
--- a/specification/digitaltwins/resource-manager/Microsoft.DigitalTwins/stable/2020-10-31/examples/DigitalTwinsEndpointGet_example.json
+++ b/specification/digitaltwins/resource-manager/Microsoft.DigitalTwins/stable/2020-10-31/examples/DigitalTwinsEndpointGet_example.json
@@ -9,14 +9,14 @@
"responses": {
"200": {
"body": {
- "id": "/subscriptions/50016170-c839-41ba-a724-51e9df440b9e/resourcegroups/resRg/providers/Microsoft.DigitalTwins/DigitalTwinsInstance/myDigitalTwinsService/endpoints/myServiceBus",
+ "id": "/subscriptions/50016170-c839-41ba-a724-51e9df440b9e/resourcegroups/resRg/providers/Microsoft.DigitalTwins/digitalTwinsInstances/myDigitalTwinsService/endpoints/myServiceBus",
"type": "Microsoft.DigitalTwins/digitalTwinsInstances/endpoints",
- "name": "myendpoint",
+ "name": "myServiceBus",
"properties": {
"endpointType": "ServiceBus",
"provisioningState": "Succeeded",
- "primaryConnectionString": "Endpoint=sb://mysb.servicebus.windows.net/;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=***",
- "secondaryConnectionString": "Endpoint=sb://mysb.servicebus.windows.net/;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=***",
+ "primaryConnectionString": "Endpoint=sb://***/;SharedAccessKeyName=***;SharedAccessKey=***;EntityPath=***",
+ "secondaryConnectionString": "Endpoint=sb://***/;SharedAccessKeyName=***;SharedAccessKey=***;EntityPath=***",
"createdTime": "2019-11-19T01:10:34.350Z"
}
}
diff --git a/specification/digitaltwins/resource-manager/Microsoft.DigitalTwins/stable/2020-10-31/examples/DigitalTwinsEndpointPut_example.json b/specification/digitaltwins/resource-manager/Microsoft.DigitalTwins/stable/2020-10-31/examples/DigitalTwinsEndpointPut_example.json
index 4745faf5479b..fb7750a888bb 100644
--- a/specification/digitaltwins/resource-manager/Microsoft.DigitalTwins/stable/2020-10-31/examples/DigitalTwinsEndpointPut_example.json
+++ b/specification/digitaltwins/resource-manager/Microsoft.DigitalTwins/stable/2020-10-31/examples/DigitalTwinsEndpointPut_example.json
@@ -8,36 +8,36 @@
"endpointDescription": {
"properties": {
"endpointType": "ServiceBus",
- "primaryConnectionString": "Endpoint=sb://mysb.servicebus.windows.net/;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=xyzxyzoX4=",
- "secondaryConnectionString": "Endpoint=sb://mysb.servicebus.windows.net/;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=xyzxyzoX4="
+ "primaryConnectionString": "Endpoint=sb://mysb.servicebus.windows.net/;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=xyzxyzoX4=;EntityPath=abcabc",
+ "secondaryConnectionString": "Endpoint=sb://mysb.servicebus.windows.net/;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=xyzxyzoX4=;EntityPath=abcabc"
}
}
},
"responses": {
"200": {
"body": {
- "id": "/subscriptions/50016170-c839-41ba-a724-51e9df440b9e/resourcegroups/resRg/providers/Microsoft.DigitalTwins/DigitalTwinsInstance/myDigitalTwinsService/endpoints/myServiceBus",
+ "id": "/subscriptions/50016170-c839-41ba-a724-51e9df440b9e/resourcegroups/resRg/providers/Microsoft.DigitalTwins/digitalTwinsInstances/myDigitalTwinsService/endpoints/myServiceBus",
"type": "Microsoft.DigitalTwins/digitalTwinsInstances/endpoints",
"name": "myServiceBus",
"properties": {
"endpointType": "ServiceBus",
"provisioningState": "Succeeded",
- "primaryConnectionString": "Endpoint=sb://mysb.servicebus.windows.net/;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=***",
- "secondaryConnectionString": "Endpoint=sb://mysb.servicebus.windows.net/;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=***",
+ "primaryConnectionString": "Endpoint=sb://***/;SharedAccessKeyName=***;SharedAccessKey=***;EntityPath=***",
+ "secondaryConnectionString": "Endpoint=sb://***/;SharedAccessKeyName=***;SharedAccessKey=***;EntityPath=***",
"createdTime": "2019-11-19T01:10:34.350Z"
}
}
},
"201": {
"body": {
- "id": "/subscriptions/50016170-c839-41ba-a724-51e9df440b9e/resourcegroups/resRg/providers/Microsoft.DigitalTwins/DigitalTwinsInstance/myDigitalTwinsService/endpoints/myServiceBus",
+ "id": "/subscriptions/50016170-c839-41ba-a724-51e9df440b9e/resourcegroups/resRg/providers/Microsoft.DigitalTwins/digitalTwinsInstances/myDigitalTwinsService/endpoints/myServiceBus",
"type": "Microsoft.DigitalTwins/digitalTwinsInstances/endpoints",
"name": "myServiceBus",
"properties": {
"endpointType": "ServiceBus",
"provisioningState": "Provisioning",
- "primaryConnectionString": "Endpoint=sb://mysb.servicebus.windows.net/;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=***",
- "secondaryConnectionString": "Endpoint=sb://mysb.servicebus.windows.net/;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=***",
+ "primaryConnectionString": "",
+ "secondaryConnectionString": "",
"createdTime": "2019-11-19T01:10:34.350Z"
}
}
diff --git a/specification/digitaltwins/resource-manager/Microsoft.DigitalTwins/stable/2020-10-31/examples/DigitalTwinsEndpointsGet_example.json b/specification/digitaltwins/resource-manager/Microsoft.DigitalTwins/stable/2020-10-31/examples/DigitalTwinsEndpointsGet_example.json
index a7525b702cd6..1a89b39dc2f4 100644
--- a/specification/digitaltwins/resource-manager/Microsoft.DigitalTwins/stable/2020-10-31/examples/DigitalTwinsEndpointsGet_example.json
+++ b/specification/digitaltwins/resource-manager/Microsoft.DigitalTwins/stable/2020-10-31/examples/DigitalTwinsEndpointsGet_example.json
@@ -10,19 +10,19 @@
"body": {
"value": [
{
- "id": "/subscriptions/50016170-c839-41ba-a724-51e9df440b9e/resourcegroups/resRg/providers/Microsoft.DigitalTwins/DigitalTwinsInstance/myDigitalTwinsService/endpoints/myServiceBus",
+ "id": "/subscriptions/50016170-c839-41ba-a724-51e9df440b9e/resourcegroups/resRg/providers/Microsoft.DigitalTwins/digitalTwinsInstances/myDigitalTwinsService/endpoints/myendpoint1",
"type": "Microsoft.DigitalTwins/digitalTwinsInstances/endpoints",
"name": "myendpoint1",
"properties": {
"endpointType": "ServiceBus",
- "primaryConnectionString": "Endpoint=sb://mysb.servicebus.windows.net/;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=***",
- "secondaryConnectionString": "Endpoint=sb://mysb.servicebus.windows.net/;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=***",
+ "primaryConnectionString": "Endpoint=sb://***/;SharedAccessKeyName=***;SharedAccessKey=***;EntityPath=***",
+ "secondaryConnectionString": "Endpoint=sb://***/;SharedAccessKeyName=***;SharedAccessKey=***;EntityPath=***",
"provisioningState": "Succeeded",
"createdTime": "2019-11-19T01:10:34.350Z"
}
},
{
- "id": "/subscriptions/50016170-c839-41ba-a724-51e9df440b9e/resourcegroups/resRg/providers/Microsoft.DigitalTwins/DigitalTwinsInstance/myDigitalTwinsService/endpoints/myServiceBus",
+ "id": "/subscriptions/50016170-c839-41ba-a724-51e9df440b9e/resourcegroups/resRg/providers/Microsoft.DigitalTwins/digitalTwinsInstances/myDigitalTwinsService/endpoints/myendpoint2",
"type": "Microsoft.DigitalTwins/digitalTwinsInstances/endpoints",
"name": "myendpoint2",
"properties": {
diff --git a/specification/digitaltwins/resource-manager/Microsoft.DigitalTwins/stable/2020-10-31/examples/DigitalTwinsGet_example.json b/specification/digitaltwins/resource-manager/Microsoft.DigitalTwins/stable/2020-10-31/examples/DigitalTwinsGet_example.json
index 3296834f087a..7da93e05e211 100644
--- a/specification/digitaltwins/resource-manager/Microsoft.DigitalTwins/stable/2020-10-31/examples/DigitalTwinsGet_example.json
+++ b/specification/digitaltwins/resource-manager/Microsoft.DigitalTwins/stable/2020-10-31/examples/DigitalTwinsGet_example.json
@@ -8,8 +8,8 @@
"responses": {
"200": {
"body": {
- "id": "/subscriptions/50016170-c839-41ba-a724-51e9df440b9e/resourcegroups/resRg/providers/Microsoft.DigitalTwins/DigitalTwinsInstance/myDigitalTwinsService",
- "location": "westus",
+ "id": "/subscriptions/50016170-c839-41ba-a724-51e9df440b9e/resourcegroups/resRg/providers/Microsoft.DigitalTwins/digitalTwinsInstances/myDigitalTwinsService",
+ "location": "westus2",
"type": "Microsoft.DigitalTwins/digitalTwinsInstances",
"name": "myDigitalTwinsService",
"properties": {
diff --git a/specification/digitaltwins/resource-manager/Microsoft.DigitalTwins/stable/2020-10-31/examples/DigitalTwinsListByResourceGroup_example.json b/specification/digitaltwins/resource-manager/Microsoft.DigitalTwins/stable/2020-10-31/examples/DigitalTwinsListByResourceGroup_example.json
index e1d83d0ee610..6a0bbb883a57 100644
--- a/specification/digitaltwins/resource-manager/Microsoft.DigitalTwins/stable/2020-10-31/examples/DigitalTwinsListByResourceGroup_example.json
+++ b/specification/digitaltwins/resource-manager/Microsoft.DigitalTwins/stable/2020-10-31/examples/DigitalTwinsListByResourceGroup_example.json
@@ -10,8 +10,8 @@
"body": {
"value": [
{
- "id": "/subscriptions/50016170-c839-41ba-a724-51e9df440b9e/resourcegroups/resRg/providers/Microsoft.DigitalTwins/DigitalTwinsInstance/myDigitalTwinsService",
- "location": "westus",
+ "id": "/subscriptions/50016170-c839-41ba-a724-51e9df440b9e/resourcegroups/resRg/providers/Microsoft.DigitalTwins/digitalTwinsInstances/myDigitalTwinsService",
+ "location": "westus2",
"type": "Microsoft.DigitalTwins/digitalTwinsInstances",
"name": "myDigitalTwinsService",
"properties": {
@@ -22,8 +22,8 @@
}
},
{
- "id": "/subscriptions/50016170-c839-41ba-a724-51e9df440b9e/resourcegroups/resRg/providers/Microsoft.DigitalTwins/DigitalTwinsInstance/myDigitalTwinsService2",
- "location": "westus",
+ "id": "/subscriptions/50016170-c839-41ba-a724-51e9df440b9e/resourcegroups/resRg/providers/Microsoft.DigitalTwins/digitalTwinsInstances/myDigitalTwinsService2",
+ "location": "westus2",
"type": "Microsoft.DigitalTwins/digitalTwinsInstances",
"name": "myDigitalTwinsService2",
"properties": {
diff --git a/specification/digitaltwins/resource-manager/Microsoft.DigitalTwins/stable/2020-10-31/examples/DigitalTwinsList_example.json b/specification/digitaltwins/resource-manager/Microsoft.DigitalTwins/stable/2020-10-31/examples/DigitalTwinsList_example.json
index 782077a67cea..0965ef7a7c93 100644
--- a/specification/digitaltwins/resource-manager/Microsoft.DigitalTwins/stable/2020-10-31/examples/DigitalTwinsList_example.json
+++ b/specification/digitaltwins/resource-manager/Microsoft.DigitalTwins/stable/2020-10-31/examples/DigitalTwinsList_example.json
@@ -9,8 +9,8 @@
"body": {
"value": [
{
- "id": "/subscriptions/50016170-c839-41ba-a724-51e9df440b9e/resourcegroups/resRg/providers/Microsoft.DigitalTwins/DigitalTwinsInstance/myDigitalTwinsService",
- "location": "westus",
+ "id": "/subscriptions/50016170-c839-41ba-a724-51e9df440b9e/resourcegroups/resRg/providers/Microsoft.DigitalTwins/digitalTwinsInstances/myDigitalTwinsService",
+ "location": "westus2",
"type": "Microsoft.DigitalTwins/digitalTwinsInstances",
"name": "myDigitalTwinsService",
"properties": {
@@ -21,8 +21,8 @@
}
},
{
- "id": "/subscriptions/50016170-c839-41ba-a724-51e9df440b9e/resourcegroups/resRg2/providers/Microsoft.DigitalTwins/DigitalTwinsInstance/myDigitalTwinsService2",
- "location": "westus",
+ "id": "/subscriptions/50016170-c839-41ba-a724-51e9df440b9e/resourcegroups/resRg2/providers/Microsoft.DigitalTwins/digitalTwinsInstances/myDigitalTwinsService2",
+ "location": "westus2",
"type": "Microsoft.DigitalTwins/digitalTwinsInstances",
"name": "myDigitalTwinsService2",
"properties": {
diff --git a/specification/digitaltwins/resource-manager/Microsoft.DigitalTwins/stable/2020-10-31/examples/DigitalTwinsPatch_example.json b/specification/digitaltwins/resource-manager/Microsoft.DigitalTwins/stable/2020-10-31/examples/DigitalTwinsPatch_example.json
index 98fe3253c706..23043e7dd1c2 100644
--- a/specification/digitaltwins/resource-manager/Microsoft.DigitalTwins/stable/2020-10-31/examples/DigitalTwinsPatch_example.json
+++ b/specification/digitaltwins/resource-manager/Microsoft.DigitalTwins/stable/2020-10-31/examples/DigitalTwinsPatch_example.json
@@ -13,8 +13,8 @@
"responses": {
"200": {
"body": {
- "id": "/subscriptions/50016170-c839-41ba-a724-51e9df440b9e/resourcegroups/resRg/providers/Microsoft.DigitalTwins/DigitalTwinsInstance/myDigitalTwinsService",
- "location": "westus",
+ "id": "/subscriptions/50016170-c839-41ba-a724-51e9df440b9e/resourcegroups/resRg/providers/Microsoft.DigitalTwins/digitalTwinsInstances/myDigitalTwinsService",
+ "location": "westus2",
"type": "Microsoft.DigitalTwins/digitalTwinsInstances",
"name": "myDigitalTwinsService",
"tags": {
diff --git a/specification/digitaltwins/resource-manager/Microsoft.DigitalTwins/stable/2020-10-31/examples/DigitalTwinsPut_example.json b/specification/digitaltwins/resource-manager/Microsoft.DigitalTwins/stable/2020-10-31/examples/DigitalTwinsPut_example.json
index 560c09c1abcf..023047b38cfe 100644
--- a/specification/digitaltwins/resource-manager/Microsoft.DigitalTwins/stable/2020-10-31/examples/DigitalTwinsPut_example.json
+++ b/specification/digitaltwins/resource-manager/Microsoft.DigitalTwins/stable/2020-10-31/examples/DigitalTwinsPut_example.json
@@ -5,14 +5,14 @@
"resourceName": "myDigitalTwinsService",
"api-version": "2020-10-31",
"digitalTwinsCreate": {
- "location": "WestUS"
+ "location": "WestUS2"
}
},
"responses": {
"200": {
"body": {
- "id": "/subscriptions/50016170-c839-41ba-a724-51e9df440b9e/resourcegroups/resRg/providers/Microsoft.DigitalTwins/DigitalTwinsInstance/myDigitalTwinsService",
- "location": "westus",
+ "id": "/subscriptions/50016170-c839-41ba-a724-51e9df440b9e/resourcegroups/resRg/providers/Microsoft.DigitalTwins/digitalTwinsInstances/myDigitalTwinsService",
+ "location": "westus2",
"type": "Microsoft.DigitalTwins/digitalTwinsInstances",
"name": "myDigitalTwinsService",
"tags": {
@@ -28,8 +28,8 @@
},
"201": {
"body": {
- "id": "/subscriptions/50016170-c839-41ba-a724-51e9df440b9e/resourcegroups/resRg/providers/Microsoft.DigitalTwins/DigitalTwinsInstance/myDigitalTwinsService",
- "location": "westus",
+ "id": "/subscriptions/50016170-c839-41ba-a724-51e9df440b9e/resourcegroups/resRg/providers/Microsoft.DigitalTwins/digitalTwinsInstances/myDigitalTwinsService",
+ "location": "westus2",
"type": "Microsoft.DigitalTwins/digitalTwinsInstances",
"name": "myDigitalTwinsService",
"properties": {
diff --git a/specification/digitaltwins/resource-manager/readme.python.md b/specification/digitaltwins/resource-manager/readme.python.md
index b6ac8b85de37..1cb571183572 100644
--- a/specification/digitaltwins/resource-manager/readme.python.md
+++ b/specification/digitaltwins/resource-manager/readme.python.md
@@ -11,12 +11,7 @@ python:
namespace: azure.mgmt.digitaltwins
package-name: azure-mgmt-digitaltwins
clear-output-folder: true
-```
-
-```yaml $(python)
-python:
no-namespace-folders: true
- output-folder: $(python-sdks-folder)/digitaltwins/azure-mgmt-digitaltwins/azure/mgmt/digitaltwins
```
### Python multi-api
@@ -37,7 +32,7 @@ Please also specify `--python-sdks-folder=`.
``` yaml $(tag) == 'package-2018-06-preview' && $(go)
-output-folder: $(go-sdk-folder)/services/preview/$(namespace)/mgmt/2018-06-01-preview/$(namespace)
+output-folder: $(go-sdk-folder)/services/$(namespace)/mgmt/2018-06-01/$(namespace)
```
### Tag: package-2015-03-preview and go
diff --git a/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2020-03-30/examples/CheckNameAvailabilityPost.json b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2020-03-30/examples/CheckNameAvailabilityPost.json
new file mode 100644
index 000000000000..561363fae203
--- /dev/null
+++ b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2020-03-30/examples/CheckNameAvailabilityPost.json
@@ -0,0 +1,19 @@
+{
+ "parameters": {
+ "api-version": "2020-03-30",
+ "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/stable/2020-03-30/examples/OperationResultsGet.json b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2020-03-30/examples/OperationResultsGet.json
new file mode 100644
index 000000000000..fde20004ec95
--- /dev/null
+++ b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2020-03-30/examples/OperationResultsGet.json
@@ -0,0 +1,27 @@
+{
+ "parameters": {
+ "api-version": "2020-03-30",
+ "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": {}
+ }
+ },
+ "404": {
+ "body": {
+ "error": {
+ "code": "OperationResultNotFound",
+ "message": "The operation result was not found."
+ }
+ }
+ }
+ }
+}
diff --git a/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2020-03-30/examples/OperationsList.json b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2020-03-30/examples/OperationsList.json
new file mode 100644
index 000000000000..847340234e90
--- /dev/null
+++ b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2020-03-30/examples/OperationsList.json
@@ -0,0 +1,53 @@
+{
+ "parameters": {
+ "api-version": "2020-03-30"
+ },
+ "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/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/stable/2020-03-30/examples/PrivateLinkResourceGet.json b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2020-03-30/examples/PrivateLinkResourceGet.json
new file mode 100644
index 000000000000..c06414badc55
--- /dev/null
+++ b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2020-03-30/examples/PrivateLinkResourceGet.json
@@ -0,0 +1,27 @@
+{
+ "parameters": {
+ "api-version": "2020-03-30",
+ "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/stable/2020-03-30/examples/PrivateLinkResourcesListByService.json b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2020-03-30/examples/PrivateLinkResourcesListByService.json
new file mode 100644
index 000000000000..f9af43fdaa2d
--- /dev/null
+++ b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2020-03-30/examples/PrivateLinkResourcesListByService.json
@@ -0,0 +1,30 @@
+{
+ "parameters": {
+ "api-version": "2020-03-30",
+ "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/stable/2020-03-30/examples/ServiceCreate.json b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2020-03-30/examples/ServiceCreate.json
new file mode 100644
index 000000000000..947de55f47aa
--- /dev/null
+++ b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2020-03-30/examples/ServiceCreate.json
@@ -0,0 +1,177 @@
+{
+ "parameters": {
+ "resourceName": "service1",
+ "resourceGroupName": "rg1",
+ "api-version": "2020-03-30",
+ "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/stable/2020-03-30/examples/ServiceCreateMinimum.json b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2020-03-30/examples/ServiceCreateMinimum.json
new file mode 100644
index 000000000000..a1b076318036
--- /dev/null
+++ b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2020-03-30/examples/ServiceCreateMinimum.json
@@ -0,0 +1,95 @@
+{
+ "parameters": {
+ "resourceName": "service2",
+ "resourceGroupName": "rg1",
+ "api-version": "2020-03-30",
+ "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/stable/2020-03-30/examples/ServiceCreatePrivateEndpointConnection.json b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2020-03-30/examples/ServiceCreatePrivateEndpointConnection.json
new file mode 100644
index 000000000000..f86c1550025b
--- /dev/null
+++ b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2020-03-30/examples/ServiceCreatePrivateEndpointConnection.json
@@ -0,0 +1,37 @@
+{
+ "parameters": {
+ "api-version": "2020-03-30",
+ "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/stable/2020-03-30/examples/ServiceDelete.json b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2020-03-30/examples/ServiceDelete.json
new file mode 100644
index 000000000000..1e3a79bfe57c
--- /dev/null
+++ b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2020-03-30/examples/ServiceDelete.json
@@ -0,0 +1,12 @@
+{
+ "parameters": {
+ "resourceName": "service1",
+ "resourceGroupName": "rg1",
+ "api-version": "2020-03-30",
+ "subscriptionId": "subid"
+ },
+ "responses": {
+ "202": {},
+ "204": {}
+ }
+}
diff --git a/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2020-03-30/examples/ServiceDeletePrivateEndpointConnection.json b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2020-03-30/examples/ServiceDeletePrivateEndpointConnection.json
new file mode 100644
index 000000000000..3b52695a9063
--- /dev/null
+++ b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2020-03-30/examples/ServiceDeletePrivateEndpointConnection.json
@@ -0,0 +1,14 @@
+{
+ "parameters": {
+ "api-version": "2020-03-30",
+ "subscriptionId": "subid",
+ "resourceGroupName": "rgname",
+ "resourceName": "service1",
+ "privateEndpointConnectionName": "myConnection"
+ },
+ "responses": {
+ "200": {},
+ "202": {},
+ "204": {}
+ }
+}
diff --git a/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2020-03-30/examples/ServiceGet.json b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2020-03-30/examples/ServiceGet.json
new file mode 100644
index 000000000000..2e7effa38f29
--- /dev/null
+++ b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2020-03-30/examples/ServiceGet.json
@@ -0,0 +1,61 @@
+{
+ "parameters": {
+ "resourceName": "service1",
+ "resourceGroupName": "rg1",
+ "api-version": "2020-03-30",
+ "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/stable/2020-03-30/examples/ServiceGetPrivateEndpointConnection.json b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2020-03-30/examples/ServiceGetPrivateEndpointConnection.json
new file mode 100644
index 000000000000..7d0c7462c1b5
--- /dev/null
+++ b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2020-03-30/examples/ServiceGetPrivateEndpointConnection.json
@@ -0,0 +1,28 @@
+{
+ "parameters": {
+ "api-version": "2020-03-30",
+ "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/stable/2020-03-30/examples/ServiceList.json b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2020-03-30/examples/ServiceList.json
new file mode 100644
index 000000000000..847c27e5da81
--- /dev/null
+++ b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2020-03-30/examples/ServiceList.json
@@ -0,0 +1,64 @@
+{
+ "parameters": {
+ "api-version": "2020-03-30",
+ "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/stable/2020-03-30/examples/ServiceListByResourceGroup.json b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2020-03-30/examples/ServiceListByResourceGroup.json
new file mode 100644
index 000000000000..8f4b65f563ed
--- /dev/null
+++ b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2020-03-30/examples/ServiceListByResourceGroup.json
@@ -0,0 +1,65 @@
+{
+ "parameters": {
+ "api-version": "2020-03-30",
+ "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/stable/2020-03-30/examples/ServiceListPrivateEndpointConnections.json b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2020-03-30/examples/ServiceListPrivateEndpointConnections.json
new file mode 100644
index 000000000000..601c08a753e4
--- /dev/null
+++ b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2020-03-30/examples/ServiceListPrivateEndpointConnections.json
@@ -0,0 +1,31 @@
+{
+ "parameters": {
+ "api-version": "2020-03-30",
+ "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/stable/2020-03-30/examples/ServicePatch.json b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2020-03-30/examples/ServicePatch.json
new file mode 100644
index 000000000000..20295986af0a
--- /dev/null
+++ b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2020-03-30/examples/ServicePatch.json
@@ -0,0 +1,70 @@
+{
+ "parameters": {
+ "resourceName": "service1",
+ "resourceGroupName": "rg1",
+ "api-version": "2020-03-30",
+ "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/stable/2020-03-30/healthcare-apis.json b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2020-03-30/healthcare-apis.json
new file mode 100644
index 000000000000..2159e88dfc50
--- /dev/null
+++ b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2020-03-30/healthcare-apis.json
@@ -0,0 +1,1312 @@
+{
+ "swagger": "2.0",
+ "info": {
+ "version": "2020-03-30",
+ "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/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"
+ }
+ }
+ },
+ "deprecated": false
+ },
+ "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/ServiceCreate.json"
+ },
+ "Create or Update a service with minimum parameters": {
+ "$ref": "./examples/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"
+ }
+ }
+ },
+ "deprecated": false
+ },
+ "patch": {
+ "tags": [
+ "Resource"
+ ],
+ "description": "Update the metadata of a service instance.",
+ "operationId": "Services_Update",
+ "x-ms-examples": {
+ "Patch service": {
+ "$ref": "./examples/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"
+ }
+ }
+ },
+ "deprecated": false
+ },
+ "delete": {
+ "tags": [
+ "Resource"
+ ],
+ "description": "Delete a service instance.",
+ "operationId": "Services_Delete",
+ "x-ms-examples": {
+ "Delete service": {
+ "$ref": "./examples/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/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"
+ }
+ }
+ },
+ "deprecated": false
+ }
+ },
+ "/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/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"
+ }
+ }
+ },
+ "deprecated": false
+ }
+ },
+ "/providers/Microsoft.HealthcareApis/operations": {
+ "get": {
+ "tags": [
+ "Proxy"
+ ],
+ "description": "Lists all of the available Healthcare service REST API operations.",
+ "operationId": "Operations_List",
+ "x-ms-examples": {
+ "List operations": {
+ "$ref": "./examples/OperationsList.json"
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "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.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"
+ }
+ }
+ },
+ "deprecated": false
+ }
+ },
+ "/subscriptions/{subscriptionId}/providers/Microsoft.HealthcareApis/locations/{locationName}/operationresults/{operationResultId}": {
+ "get": {
+ "tags": [
+ "Resource"
+ ],
+ "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/ApiVersionParameter"
+ },
+ {
+ "$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"
+ }
+ },
+ "404": {
+ "description": "No operation result was found matching operationResultId.",
+ "schema": {
+ "$ref": "#/definitions/ErrorDetails"
+ }
+ },
+ "default": {
+ "description": "Default error response",
+ "schema": {
+ "$ref": "#/definitions/ErrorDetails"
+ }
+ }
+ },
+ "deprecated": false
+ }
+ },
+ "/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": "../../../../../common-types/resource-management/v1/privatelinks.json#/definitions/PrivateEndpointConnectionListResult"
+ }
+ },
+ "default": {
+ "description": "DefaultErrorResponse",
+ "schema": {
+ "$ref": "#/definitions/ErrorDetails"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "PrivateEndpointConnection_List": {
+ "$ref": "./examples/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": "../../../../../common-types/resource-management/v1/privatelinks.json#/definitions/PrivateEndpointConnection"
+ }
+ },
+ "default": {
+ "description": "DefaultErrorResponse",
+ "schema": {
+ "$ref": "#/definitions/ErrorDetails"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "PrivateEndpointConnection_GetConnection": {
+ "$ref": "./examples/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": "../../../../../common-types/resource-management/v1/privatelinks.json#/definitions/PrivateEndpointConnection"
+ }
+ },
+ "default": {
+ "description": "DefaultErrorResponse",
+ "schema": {
+ "$ref": "#/definitions/ErrorDetails"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "PrivateEndpointConnection_CreateOrUpdate": {
+ "$ref": "./examples/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/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": "../../../../../common-types/resource-management/v1/privatelinks.json#/definitions/PrivateLinkResourceListResult"
+ }
+ },
+ "default": {
+ "description": "DefaultErrorResponse",
+ "schema": {
+ "$ref": "#/definitions/ErrorDetails"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "PrivateLinkResources_ListGroupIds": {
+ "$ref": "./examples/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": "../../../../../common-types/resource-management/v1/privatelinks.json#/definitions/PrivateLinkResource"
+ }
+ },
+ "default": {
+ "description": "DefaultErrorResponse",
+ "schema": {
+ "$ref": "#/definitions/ErrorDetails"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "PrivateLinkResources_Get": {
+ "$ref": "./examples/PrivateLinkResourceGet.json"
+ }
+ }
+ }
+ }
+ },
+ "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
+ }
+ }
+ }
+ },
+ "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
+ }
+ }
+ },
+ "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"
+ }
+ },
+ "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"
+ ]
+ },
+ "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
+ }
+ }
+ },
+ "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"
+ }
+ }
+ }
+ },
+ "OperationListResult": {
+ "description": "A list of 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 service description objects.",
+ "type": "string"
+ },
+ "value": {
+ "description": "A list of service operations supported by the Microsoft.HealthcareApis resource provider.",
+ "type": "array",
+ "readOnly": true,
+ "items": {
+ "$ref": "#/definitions/Operation"
+ }
+ }
+ }
+ },
+ "Operation": {
+ "description": "Service REST API operation.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "readOnly": true,
+ "type": "string",
+ "description": "Operation name: {provider}/{resource}/{read | write | action | delete}"
+ },
+ "origin": {
+ "readOnly": true,
+ "type": "string",
+ "description": "Default value is 'user,system'."
+ },
+ "display": {
+ "description": "The information displayed about the operation.",
+ "$ref": "#/definitions/OperationDisplay"
+ }
+ }
+ },
+ "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,"
+ }
+ }
+ },
+ "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"
+ }
+ }
+ },
+ "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."
+ }
+ }
+ }
+ },
+ "parameters": {
+ "subscriptionId": {
+ "name": "subscriptionId",
+ "in": "path",
+ "description": "The subscription identifier.",
+ "required": true,
+ "type": "string"
+ },
+ "ApiVersionParameter": {
+ "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
+ },
+ "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
+ },
+ "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"
+ }
+ }
+}
diff --git a/specification/healthcareapis/resource-manager/readme.go.md b/specification/healthcareapis/resource-manager/readme.go.md
index 8d7829b97159..ddffe9a42ed7 100644
--- a/specification/healthcareapis/resource-manager/readme.go.md
+++ b/specification/healthcareapis/resource-manager/readme.go.md
@@ -13,9 +13,20 @@ go:
``` yaml $(go) && $(multiapi)
batch:
+ - tag: package-2020-03
- tag: package-2019-09
- tag: package-2018-08-preview
```
+
+### Tag: package-2020-03 and go
+
+These settings apply only when `--tag=package-2020-03 --go` is specified on the command line.
+Please also specify `--go-sdk-folder=`.
+
+``` yaml $(tag) == 'package-2020-03' && $(go)
+output-folder: $(go-sdk-folder)/services/$(namespace)/mgmt/2020-03-15/$(namespace)
+```
+
### Tag: package-2019-09 and go
These settings apply only when `--tag=package-2019-09 --go` is specified on the command line.
diff --git a/specification/healthcareapis/resource-manager/readme.java.md b/specification/healthcareapis/resource-manager/readme.java.md
new file mode 100644
index 000000000000..eab1f83bc940
--- /dev/null
+++ b/specification/healthcareapis/resource-manager/readme.java.md
@@ -0,0 +1,61 @@
+## 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.healthcareapis
+license-header: MICROSOFT_MIT_NO_CODEGEN
+payload-flattening-threshold: 1
+output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-healthcareapis
+```
+
+### Java multi-api
+
+``` yaml $(java) && $(multiapi)
+batch:
+ - tag: package-2020-03
+ - tag: package-2019-09
+ - tag: package-2018-08-preview
+```
+
+### Tag: package-2020-03 and java
+
+These settings apply only when `--tag=package-2020-03 --java` is specified on the command line.
+Please also specify `--azure-libraries-for-java=`.
+
+``` yaml $(tag) == 'package-2020-03' && $(java) && $(multiapi)
+java:
+ namespace: com.microsoft.azure.management.healthcareapis.v2020_03_15
+ output-folder: $(azure-libraries-for-java-folder)/sdk/healthcareapis/mgmt-v2020_03_15
+regenerate-manager: true
+generate-interface: true
+```
+
+### Tag: package-2019-09 and java
+
+These settings apply only when `--tag=package-2019-09 --java` is specified on the command line.
+Please also specify `--azure-libraries-for-java=`.
+
+``` yaml $(tag) == 'package-2019-09' && $(java) && $(multiapi)
+java:
+ namespace: com.microsoft.azure.management.healthcareapis.v2019_09_16
+ output-folder: $(azure-libraries-for-java-folder)/sdk/healthcareapis/mgmt-v2019_09_16
+regenerate-manager: true
+generate-interface: true
+```
+
+### Tag: package-2018-08-preview and java
+
+These settings apply only when `--tag=package-2018-08-preview --java` is specified on the command line.
+Please also specify `--azure-libraries-for-java=`.
+
+``` yaml $(tag) == 'package-2018-08-preview' && $(java) && $(multiapi)
+java:
+ namespace: com.microsoft.azure.management.healthcareapis.v2018_08_20_preview
+ output-folder: $(azure-libraries-for-java-folder)/sdk/healthcareapis/mgmt-v2018_08_20_preview
+regenerate-manager: true
+generate-interface: true
+```
\ No newline at end of file
diff --git a/specification/healthcareapis/resource-manager/readme.md b/specification/healthcareapis/resource-manager/readme.md
index 43f34c10e10f..5e7ac7bf9142 100644
--- a/specification/healthcareapis/resource-manager/readme.md
+++ b/specification/healthcareapis/resource-manager/readme.md
@@ -28,10 +28,18 @@ These are the global settings for HealthcareApis service.
title: HealthcareApisManagementClient
description: Azure Healthcare APIs Client
openapi-type: arm
-tag: package-2020-03
+tag: package-2020-03-30
azure-arm: true
```
+### Tag: package-2020-03-30
+
+These settings apply only when `--tag=package-2020-03-30` is specified on the command line.
+
+```yaml $(tag) == 'package-2020-03-30'
+input-file:
+ - Microsoft.HealthcareApis/stable/2020-03-30/healthcare-apis.json
+```
### Tag: package-2020-03
@@ -107,53 +115,7 @@ 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.healthcareapis
-license-header: MICROSOFT_MIT_NO_CODEGEN
-payload-flattening-threshold: 1
-output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-healthcareapis
-```
-
-### Java multi-api
-
-``` yaml $(java) && $(multiapi)
-batch:
- - tag: package-2019-09
- - tag: package-2018-08-preview
-```
-
-### Tag: package-2019-09 and java
-
-These settings apply only when `--tag=package-2019-09 --java` is specified on the command line.
-Please also specify `--azure-libraries-for-java=`.
-
-``` yaml $(tag) == 'package-2019-09' && $(java) && $(multiapi)
-java:
- namespace: com.microsoft.azure.management.healthcareapis.v2019-09-16
- output-folder: $(azure-libraries-for-java-folder)/sdk/healthcareapis/mgmt-v2019-09-16
-regenerate-manager: true
-generate-interface: true
-```
-
-### Tag: package-2018-08-preview and java
-
-These settings apply only when `--tag=package-2018-08-preview --java` is specified on the command line.
-Please also specify `--azure-libraries-for-java=`.
-
-``` yaml $(tag) == 'package-2018-08-preview' && $(java) && $(multiapi)
-java:
- namespace: com.microsoft.azure.management.healthcareapis.v2018_08_20_preview
- output-folder: $(azure-libraries-for-java-folder)/sdk/healthcareapis/mgmt-v2018_08_20_preview
-regenerate-manager: true
-generate-interface: true
-```
-
-
+See configuration in [readme.java.md](./readme.java.md)
## AzureResourceSchema
diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/stable/2020-08-02/HybridCompute.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/stable/2020-08-02/HybridCompute.json
index f316157c55eb..3b8a59c50a8a 100644
--- a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/stable/2020-08-02/HybridCompute.json
+++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/stable/2020-08-02/HybridCompute.json
@@ -266,7 +266,7 @@
"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.",
+ "description": "Lists all the hybrid machines in the specified resource group.",
"parameters": [
{
"$ref": "#/parameters/ApiVersionParameter"
@@ -312,7 +312,7 @@
"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.",
+ "description": "Lists all the hybrid machines in the specified subscription.",
"parameters": [
{
"$ref": "#/parameters/ApiVersionParameter"
@@ -413,7 +413,7 @@
"MachineExtensions"
],
"operationId": "MachineExtensions_Update",
- "description": "The operation to create or update the extension.",
+ "description": "The operation to update the extension.",
"parameters": [
{
"name": "resourceGroupName",
@@ -567,7 +567,7 @@
}
},
"x-ms-examples": {
- "GET Machine Extension": {
+ "Get Machine Extension": {
"$ref": "./examples/GETExtension.json"
}
}
@@ -621,7 +621,7 @@
"nextLinkName": "nextLink"
},
"x-ms-examples": {
- "GET all Machine Extensions": {
+ "Get all Machine Extensions": {
"$ref": "./examples/LISTExtension.json"
}
}
diff --git a/specification/hybridcompute/resource-manager/readme.cli.md b/specification/hybridcompute/resource-manager/readme.cli.md
index 061e2aadbb38..5a59b0080270 100644
--- a/specification/hybridcompute/resource-manager/readme.cli.md
+++ b/specification/hybridcompute/resource-manager/readme.cli.md
@@ -21,4 +21,11 @@ cli:
param: 'autoUpgradeMinorVersion'
alias:
- auto_upgrade_minor
+ - where:
+ operationGroup: 'machineExtensions'
+ param: 'extensionName'
+ alias:
+ - n
+ - extension_name
+ - name
```
diff --git a/specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2020-01-01-preview/connectedClusters.json b/specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2020-01-01-preview/connectedClusters.json
index ef6bfc6f5488..b3526469df07 100644
--- a/specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2020-01-01-preview/connectedClusters.json
+++ b/specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2020-01-01-preview/connectedClusters.json
@@ -46,13 +46,13 @@
},
"parameters": [
{
- "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter"
+ "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter"
},
{
- "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter"
+ "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter"
},
{
- "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter"
+ "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter"
},
{
"$ref": "#/parameters/ClusterNamePathParam"
@@ -83,7 +83,7 @@
"default": {
"description": "Resource Provider error response describing why the operation failed.",
"schema": {
- "$ref": "#/definitions/ErrorResponse"
+ "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse"
}
}
},
@@ -109,13 +109,13 @@
},
"parameters": [
{
- "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter"
+ "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter"
},
{
- "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter"
+ "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter"
},
{
- "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter"
+ "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter"
},
{
"$ref": "#/parameters/ClusterNamePathParam"
@@ -140,7 +140,7 @@
"default": {
"description": "Resource Provider error response describing why the operation failed.",
"schema": {
- "$ref": "#/definitions/ErrorResponse"
+ "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse"
}
}
}
@@ -159,13 +159,13 @@
},
"parameters": [
{
- "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter"
+ "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter"
},
{
- "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter"
+ "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter"
},
{
- "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter"
+ "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter"
},
{
"$ref": "#/parameters/ClusterNamePathParam"
@@ -181,7 +181,7 @@
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
- "$ref": "#/definitions/ErrorResponse"
+ "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse"
}
}
}
@@ -200,13 +200,13 @@
},
"parameters": [
{
- "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter"
+ "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter"
},
{
- "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter"
+ "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter"
},
{
- "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter"
+ "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter"
},
{
"$ref": "#/parameters/ClusterNamePathParam"
@@ -225,7 +225,7 @@
"default": {
"description": "Resource Provider error response describing why the operation failed.",
"schema": {
- "$ref": "#/definitions/ErrorResponse"
+ "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse"
}
}
},
@@ -253,13 +253,13 @@
},
"parameters": [
{
- "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter"
+ "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter"
},
{
- "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter"
+ "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter"
},
{
- "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter"
+ "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter"
},
{
"$ref": "#/parameters/ClusterNamePathParam"
@@ -284,7 +284,7 @@
"default": {
"description": "Resource Provider error response describing why the operation failed.",
"schema": {
- "$ref": "#/definitions/ErrorResponse"
+ "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse"
}
}
}
@@ -305,13 +305,13 @@
},
"parameters": [
{
- "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter"
+ "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter"
},
{
- "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter"
+ "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter"
},
{
- "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter"
+ "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter"
}
],
"responses": {
@@ -324,7 +324,7 @@
"default": {
"description": "Resource Provider error response describing why the operation failed.",
"schema": {
- "$ref": "#/definitions/ErrorResponse"
+ "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse"
}
}
},
@@ -348,10 +348,10 @@
},
"parameters": [
{
- "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter"
+ "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter"
},
{
- "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter"
+ "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter"
}
],
"responses": {
@@ -364,7 +364,7 @@
"default": {
"description": "Resource Provider error response describing why the operation failed.",
"schema": {
- "$ref": "#/definitions/ErrorResponse"
+ "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse"
}
}
},
@@ -382,7 +382,7 @@
],
"parameters": [
{
- "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter"
+ "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter"
}
],
"responses": {
@@ -395,7 +395,7 @@
"default": {
"description": "Resource Provider error response describing why the operation failed.",
"schema": {
- "$ref": "#/definitions/ErrorResponse"
+ "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse"
}
}
},
@@ -497,7 +497,7 @@
},
"allOf": [
{
- "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/TrackedResource"
+ "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/TrackedResource"
}
],
"description": "Represents a connected cluster."
@@ -545,7 +545,8 @@
"description": "Base64 encoded public certificate used by the agent to do the initial handshake to the backend services in Azure."
},
"aadProfile": {
- "$ref": "#/definitions/ConnectedClusterAADProfile"
+ "$ref": "#/definitions/ConnectedClusterAADProfile",
+ "description": "AAD profile of the connected cluster."
},
"kubernetesVersion": {
"readOnly": true,
@@ -563,9 +564,11 @@
"description": "Version of the agent running on the connected cluster resource"
},
"provisioningState": {
- "$ref": "#/definitions/ConnectedClusterProvisioningState"
+ "$ref": "#/definitions/ConnectedClusterProvisioningState",
+ "description": "Provisioning state of the connected cluster resource."
}
- }
+ },
+ "description": "Properties of the connected cluster."
},
"CredentialResults": {
"properties": {
@@ -617,7 +620,8 @@
"type": "string",
"description": "The server app id to access AD server"
}
- }
+ },
+ "description": "AAD profile of the connected cluster"
},
"AuthenticationDetails": {
"type": "object",
@@ -644,9 +648,11 @@
"type": "string",
"description": "Authentication token."
}
- }
+ },
+ "description": "Authentication token value."
}
- }
+ },
+ "description": "Authentication details of the user"
},
"ConnectedClusterProvisioningState": {
"type": "string",
@@ -690,32 +696,8 @@
"type": "string",
"description": "Base64 encoded public certificate used by the agent to do the initial handshake to the backend services in Azure."
}
- }
- },
- "ErrorResponse": {
- "description": "The error response that indicates why an operation has failed.",
- "type": "object",
- "properties": {
- "error": {
- "$ref": "#/definitions/ErrorDetails"
- }
- }
- },
- "ErrorDetails": {
- "description": "The error response details containing error code and error message",
- "type": "object",
- "properties": {
- "code": {
- "description": "The error code.",
- "type": "string",
- "readOnly": true
- },
- "message": {
- "description": "The error message.",
- "type": "string",
- "readOnly": true
- }
- }
+ },
+ "description": "Properties which can be patched on the connected cluster resource."
}
},
"parameters": {
diff --git a/specification/imagebuilder/resource-manager/Microsoft.VirtualMachineImages/stable/2020-02-14/examples/CreateImageTemplateWindows.json b/specification/imagebuilder/resource-manager/Microsoft.VirtualMachineImages/stable/2020-02-14/examples/CreateImageTemplateWindows.json
index d3ca6b409151..fb451bc3e018 100644
--- a/specification/imagebuilder/resource-manager/Microsoft.VirtualMachineImages/stable/2020-02-14/examples/CreateImageTemplateWindows.json
+++ b/specification/imagebuilder/resource-manager/Microsoft.VirtualMachineImages/stable/2020-02-14/examples/CreateImageTemplateWindows.json
@@ -31,6 +31,27 @@
"Powershell command-3"
]
},
+ {
+ "type": "PowerShell",
+ "name": "PowerShell (inline) Customizer Elevated user Example",
+ "inline": [
+ "Powershell command-1",
+ "Powershell command-2",
+ "Powershell command-3"
+ ],
+ "runElevated": true
+ },
+ {
+ "type": "PowerShell",
+ "name": "PowerShell (inline) Customizer Elevated Local System user Example",
+ "inline": [
+ "Powershell command-1",
+ "Powershell command-2",
+ "Powershell command-3"
+ ],
+ "runElevated": true,
+ "runAsSystem": true
+ },
{
"type": "PowerShell",
"name": "PowerShell (script) Customizer Example",
@@ -40,6 +61,27 @@
1
]
},
+ {
+ "type": "PowerShell",
+ "name": "PowerShell (script) Customizer Elevated Local System user Example",
+ "scriptUri": "https://example.com/path/to/script.ps1",
+ "runElevated": true,
+ "validExitCodes": [
+ 0,
+ 1
+ ]
+ },
+ {
+ "type": "PowerShell",
+ "name": "PowerShell (script) Customizer Elevated Local System user Example",
+ "scriptUri": "https://example.com/path/to/script.ps1",
+ "runElevated": true,
+ "runAsSystem": true,
+ "validExitCodes": [
+ 0,
+ 1
+ ]
+ },
{
"type": "WindowsRestart",
"name": "Restart Customizer Example",
@@ -101,9 +143,86 @@
},
"customize": [
{
- "type": "Shell",
- "name": "Shell Customizer Example",
- "scriptUri": "https://example.com/path/to/script.sh"
+ "type": "PowerShell",
+ "name": "PowerShell (inline) Customizer Example",
+ "inline": [
+ "Powershell command-1",
+ "Powershell command-2",
+ "Powershell command-3"
+ ],
+ "runElevated": false,
+ "runAsSystem": false
+ },
+ {
+ "type": "PowerShell",
+ "name": "PowerShell (inline) Customizer Elevated user Example",
+ "inline": [
+ "Powershell command-1",
+ "Powershell command-2",
+ "Powershell command-3"
+ ],
+ "runElevated": true,
+ "runAsSystem": false
+ },
+ {
+ "type": "PowerShell",
+ "name": "PowerShell (inline) Customizer Elevated Local System user Example",
+ "inline": [
+ "Powershell command-1",
+ "Powershell command-2",
+ "Powershell command-3"
+ ],
+ "runElevated": true,
+ "runAsSystem": true
+ },
+ {
+ "type": "PowerShell",
+ "name": "PowerShell (script) Customizer Example",
+ "scriptUri": "https://example.com/path/to/script.ps1",
+ "validExitCodes": [
+ 0,
+ 1
+ ],
+ "runElevated": false,
+ "runAsSystem": false
+ },
+ {
+ "type": "PowerShell",
+ "name": "PowerShell (script) Customizer Elevated Local System user Example",
+ "scriptUri": "https://example.com/path/to/script.ps1",
+ "runElevated": true,
+ "runAsSystem": false,
+ "validExitCodes": [
+ 0,
+ 1
+ ]
+ },
+ {
+ "type": "PowerShell",
+ "name": "PowerShell (script) Customizer Elevated Local System user Example",
+ "scriptUri": "https://example.com/path/to/script.ps1",
+ "runElevated": true,
+ "runAsSystem": true,
+ "validExitCodes": [
+ 0,
+ 1
+ ]
+ },
+ {
+ "type": "WindowsRestart",
+ "name": "Restart Customizer Example",
+ "restartCommand": "shutdown /f /r /t 0 /c \"packer restart\"",
+ "restartCheckCommand": "powershell -command \"& {Write-Output 'restarted.'}\"",
+ "restartTimeout": "10m"
+ },
+ {
+ "type": "WindowsUpdate",
+ "name": "Windows Update Customizer Example",
+ "searchCriteria": "BrowseOnly=0 and IsInstalled=0",
+ "filters": [
+ "$_.BrowseOnly"
+ ],
+ "updateLimit": 100
}
],
"distribute": [
@@ -149,9 +268,86 @@
},
"customize": [
{
- "type": "Shell",
- "name": "Shell Customizer Example",
- "scriptUri": "https://example.com/path/to/script.sh"
+ "type": "PowerShell",
+ "name": "PowerShell (inline) Customizer Example",
+ "inline": [
+ "Powershell command-1",
+ "Powershell command-2",
+ "Powershell command-3"
+ ],
+ "runElevated": false,
+ "runAsSystem": false
+ },
+ {
+ "type": "PowerShell",
+ "name": "PowerShell (inline) Customizer Elevated user Example",
+ "inline": [
+ "Powershell command-1",
+ "Powershell command-2",
+ "Powershell command-3"
+ ],
+ "runElevated": true,
+ "runAsSystem": false
+ },
+ {
+ "type": "PowerShell",
+ "name": "PowerShell (inline) Customizer Elevated Local System user Example",
+ "inline": [
+ "Powershell command-1",
+ "Powershell command-2",
+ "Powershell command-3"
+ ],
+ "runElevated": true,
+ "runAsSystem": true
+ },
+ {
+ "type": "PowerShell",
+ "name": "PowerShell (script) Customizer Example",
+ "scriptUri": "https://example.com/path/to/script.ps1",
+ "validExitCodes": [
+ 0,
+ 1
+ ],
+ "runElevated": false,
+ "runAsSystem": false
+ },
+ {
+ "type": "PowerShell",
+ "name": "PowerShell (script) Customizer Elevated Local System user Example",
+ "scriptUri": "https://example.com/path/to/script.ps1",
+ "runElevated": true,
+ "runAsSystem": false,
+ "validExitCodes": [
+ 0,
+ 1
+ ]
+ },
+ {
+ "type": "PowerShell",
+ "name": "PowerShell (script) Customizer Elevated Local System user Example",
+ "scriptUri": "https://example.com/path/to/script.ps1",
+ "runElevated": true,
+ "runAsSystem": true,
+ "validExitCodes": [
+ 0,
+ 1
+ ]
+ },
+ {
+ "type": "WindowsRestart",
+ "name": "Restart Customizer Example",
+ "restartCommand": "shutdown /f /r /t 0 /c \"packer restart\"",
+ "restartCheckCommand": "powershell -command \"& {Write-Output 'restarted.'}\"",
+ "restartTimeout": "10m"
+ },
+ {
+ "type": "WindowsUpdate",
+ "name": "Windows Update Customizer Example",
+ "searchCriteria": "BrowseOnly=0 and IsInstalled=0",
+ "filters": [
+ "$_.BrowseOnly"
+ ],
+ "updateLimit": 100
}
],
"distribute": [
diff --git a/specification/imagebuilder/resource-manager/Microsoft.VirtualMachineImages/stable/2020-02-14/imagebuilder.json b/specification/imagebuilder/resource-manager/Microsoft.VirtualMachineImages/stable/2020-02-14/imagebuilder.json
index bf5741fa8dd5..b194603bd8f6 100644
--- a/specification/imagebuilder/resource-manager/Microsoft.VirtualMachineImages/stable/2020-02-14/imagebuilder.json
+++ b/specification/imagebuilder/resource-manager/Microsoft.VirtualMachineImages/stable/2020-02-14/imagebuilder.json
@@ -763,6 +763,10 @@
"type": "boolean",
"description": "If specified, the PowerShell script will be run with elevated privileges"
},
+ "runAsSystem": {
+ "type": "boolean",
+ "description": "If specified, the PowerShell script will be run with elevated privileges using the Local System user. Can only be true when the runElevated field above is set to true."
+ },
"validExitCodes": {
"type": "array",
"description": "Valid exit codes for the PowerShell script. [Default: 0]",
diff --git a/specification/keyvault/data-plane/readme.go.md b/specification/keyvault/data-plane/readme.go.md
index 4da1caa5e2cb..051165621376 100644
--- a/specification/keyvault/data-plane/readme.go.md
+++ b/specification/keyvault/data-plane/readme.go.md
@@ -35,7 +35,7 @@ These settings apply only when `--tag=package-7.1 --go` is specified on the comm
Please also specify `--go-sdk-folder=`.
``` yaml $(tag) == 'package-7.1' && $(go)
-output-folder: $(go-sdk-folder)/services/preview/$(namespace)/v7.1/$(namespace)
+output-folder: $(go-sdk-folder)/services/$(namespace)/v7.1/$(namespace)
```
### Tag: package-7.0 and go
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 a2fe7f795cae..415914cd9053 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
@@ -983,6 +983,7 @@
"items": {
"type": "string",
"enum": [
+ "all",
"encrypt",
"decrypt",
"wrapKey",
@@ -1012,6 +1013,7 @@
"items": {
"type": "string",
"enum": [
+ "all",
"get",
"list",
"set",
@@ -1033,6 +1035,7 @@
"items": {
"type": "string",
"enum": [
+ "all",
"get",
"list",
"delete",
@@ -1062,6 +1065,7 @@
"items": {
"type": "string",
"enum": [
+ "all",
"get",
"list",
"delete",
diff --git a/specification/keyvault/resource-manager/readme.go.md b/specification/keyvault/resource-manager/readme.go.md
index 18186ff695aa..3bb372ff5eee 100644
--- a/specification/keyvault/resource-manager/readme.go.md
+++ b/specification/keyvault/resource-manager/readme.go.md
@@ -13,11 +13,20 @@ go:
``` yaml $(go) && $(multiapi)
batch:
+ - tag: package-preview-2020-04
- tag: package-2019-09
- tag: package-2018-02
- tag: package-2016-10
- tag: package-2015-06
```
+### Tag: package-preview-2020-04 and go
+
+These settings apply only when `--tag=package-preview-2020-04 --go` is specified on the command line.
+Please also specify `--go-sdk-folder=`.
+
+``` yaml $(tag) == 'package-preview-2020-04' && $(go)
+output-folder: $(go-sdk-folder)/services/preview/$(namespace)/mgmt/2020-04-01-preview/$(namespace)
+```
### Tag: package-2019-09 and go
diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-09-01-preview/machineLearningServices.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-09-01-preview/machineLearningServices.json
index dc61a4cb656b..3c283424747c 100644
--- a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-09-01-preview/machineLearningServices.json
+++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-09-01-preview/machineLearningServices.json
@@ -2249,6 +2249,11 @@
"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",
@@ -2524,6 +2529,10 @@
"items": {
"$ref": "#/definitions/QuotaBaseProperties"
}
+ },
+ "location": {
+ "description": "Region of workspace quota to be updated.",
+ "type": "string"
}
},
"description": "Quota update parameters."
@@ -2621,6 +2630,11 @@
"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",
diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-08-01/examples/ListSkus.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-08-01/examples/ListSkus.json
new file mode 100644
index 000000000000..68c9bc406ba0
--- /dev/null
+++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-08-01/examples/ListSkus.json
@@ -0,0 +1,47 @@
+{
+ "parameters": {
+ "api-version": "2020-08-01",
+ "subscriptionId": "{subscription-id}"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "resourceType": "workspaces",
+ "skus": [
+ {
+ "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": []
+ }
+ ]
+ }
+ ],
+ "nextLink": null
+ }
+ }
+ }
+}
diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-08-01/examples/ListUsages.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-08-01/examples/ListUsages.json
new file mode 100644
index 000000000000..d80eb7c6976f
--- /dev/null
+++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-08-01/examples/ListUsages.json
@@ -0,0 +1,400 @@
+{
+ "parameters": {
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "location": "eastus",
+ "api-version": "2020-08-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000",
+ "type": "Microsoft.MachineLearningServices/totalCores/usages",
+ "currentValue": 7,
+ "limit": 100,
+ "name": {
+ "localizedValue": "Total Cluster vCPUs",
+ "value": "TotalCores"
+ },
+ "unit": "Count"
+ },
+ {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000",
+ "type": "Microsoft.MachineLearningServices/totalDedicatedCores/usages",
+ "currentValue": 14,
+ "limit": 24,
+ "name": {
+ "localizedValue": "Total Cluster Dedicated Regional vCPUs",
+ "value": "TotalDedicatedCores"
+ },
+ "unit": "Count"
+ },
+ {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/usages/StandardDFamily",
+ "type": "Microsoft.MachineLearningServices/vmFamily/dedicatedCores/usages",
+ "currentValue": 0,
+ "limit": 48,
+ "name": {
+ "localizedValue": "Standard D Family Cluster Dedicated vCPUs",
+ "value": "StandardDFamily"
+ },
+ "unit": "Count"
+ },
+ {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/usages/StandardDSv2Family",
+ "type": "Microsoft.MachineLearningServices/vmFamily/dedicatedCores/usages",
+ "currentValue": 2,
+ "limit": 24,
+ "name": {
+ "value": "StandardDSv2Family",
+ "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/StandardDSv2Family",
+ "type": "Microsoft.MachineLearningServices/workspaces/dedicatedCores/usages",
+ "currentValue": 2,
+ "limit": 24,
+ "name": {
+ "value": "StandardDSv2Family",
+ "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/StandardDSv2Family",
+ "type": "Microsoft.MachineLearningServices/workspaces/computes/dedicatedCores/usages",
+ "currentValue": 2,
+ "limit": 24,
+ "name": {
+ "value": "StandardDSv2Family",
+ "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/StandardDSv2Family",
+ "type": "Microsoft.MachineLearningServices/workspaces/computes/dedicatedCores/usages",
+ "currentValue": 0,
+ "limit": 24,
+ "name": {
+ "value": "StandardDSv2Family",
+ "localizedValue": "Standard DSv2 Family Cluster Dedicated vCPUs"
+ },
+ "unit": "Count"
+ },
+ {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/usages/StandardDv2Family",
+ "type": "Microsoft.MachineLearningServices/vmFamily/dedicatedCores/usages",
+ "currentValue": 0,
+ "limit": 24,
+ "name": {
+ "localizedValue": "Standard Dv2 Family Cluster Dedicated vCPUs",
+ "value": "StandardDv2Family"
+ },
+ "unit": "Count"
+ },
+ {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/usages/StandardFSv2Family",
+ "type": "Microsoft.MachineLearningServices/vmFamily/dedicatedCores/usages",
+ "currentValue": 0,
+ "limit": 24,
+ "name": {
+ "value": "StandardFSv2Family",
+ "localizedValue": "Standard FSv2 Family Cluster Dedicated vCPUs"
+ },
+ "unit": "Count"
+ },
+ {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/usages/StandardNCFamily",
+ "type": "Microsoft.MachineLearningServices/vmFamily/dedicatedCores/usages",
+ "currentValue": 12,
+ "limit": 24,
+ "name": {
+ "localizedValue": "Standard NC Family Cluster Dedicated vCPUs",
+ "value": "StandardNCFamily"
+ },
+ "unit": "Count"
+ },
+ {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace1/usages/StandardNCFamily",
+ "type": "Microsoft.MachineLearningServices/workspace/dedicatedCores/usages",
+ "currentValue": 6,
+ "limit": 24,
+ "name": {
+ "localizedValue": "Standard NC Family Cluster Dedicated vCPUs",
+ "value": "StandardNCFamily"
+ },
+ "unit": "Count"
+ },
+ {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace1/computes/demo_cluster1_nc/usages/StandardNCFamily",
+ "type": "Microsoft.MachineLearningServices/workspace/computes/dedicatedCores/usages",
+ "currentValue": 6,
+ "limit": 24,
+ "name": {
+ "localizedValue": "Standard NC Family Cluster Dedicated vCPUs",
+ "value": "StandardNCFamily"
+ },
+ "unit": "Count"
+ },
+ {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace2/usages/StandardNCFamily",
+ "type": "Microsoft.MachineLearningServices/workspaces/dedicatedCores/usages",
+ "currentValue": 6,
+ "limit": 24,
+ "name": {
+ "value": "StandardNCFamily",
+ "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/StandardNCFamily",
+ "type": "Microsoft.MachineLearningServices/workspaces/computes/dedicatedCores/usages",
+ "currentValue": 6,
+ "limit": 24,
+ "name": {
+ "value": "StandardNCFamily",
+ "localizedValue": "Standard NC Family Cluster Dedicated vCPUs"
+ },
+ "unit": "Count"
+ },
+ {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/usages/StandardNCv2Family",
+ "type": "Microsoft.MachineLearningServices/vmFamily/dedicatedCores/usages",
+ "currentValue": 0,
+ "limit": 0,
+ "name": {
+ "localizedValue": "Standard NCv2 Family Cluster Dedicated vCPUs",
+ "value": "StandardNCv2Family"
+ },
+ "unit": "Count"
+ },
+ {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/usages/StandardNCv3Family",
+ "type": "Microsoft.MachineLearningServices/vmFamily/dedicatedCores/usages",
+ "currentValue": 0,
+ "limit": 0,
+ "name": {
+ "localizedValue": "Standard NCv3 Family Cluster Dedicated vCPUs",
+ "value": "StandardNCv3Family"
+ },
+ "unit": "Count"
+ },
+ {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/usages/StandardNDFamily",
+ "type": "Microsoft.MachineLearningServices/vmFamily/dedicatedCores/usages",
+ "currentValue": 0,
+ "limit": 0,
+ "name": {
+ "localizedValue": "Standard ND Family Cluster Dedicated vCPUs",
+ "value": "StandardNDFamily"
+ },
+ "unit": "Count"
+ },
+ {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/usages/StandardNDv2Family",
+ "type": "Microsoft.MachineLearningServices/vmFamily/dedicatedCores/usages",
+ "currentValue": 0,
+ "limit": 0,
+ "name": {
+ "value": "StandardNDv2Family",
+ "localizedValue": "Standard NDv2 Family Cluster Dedicated vCPUs"
+ },
+ "unit": "Count"
+ },
+ {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/usages/StandardNVFamily",
+ "type": "Microsoft.MachineLearningServices/vmFamily/dedicatedCores/usages",
+ "currentValue": 0,
+ "limit": 24,
+ "name": {
+ "localizedValue": "Standard NV Family Cluster Dedicated vCPUs",
+ "value": "StandardNVFamily"
+ },
+ "unit": "Count"
+ },
+ {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000",
+ "type": "Microsoft.MachineLearningServices/totalLowPriorityCores/usages",
+ "currentValue": 18,
+ "limit": 50,
+ "name": {
+ "localizedValue": "Total Cluster LowPriority Regional vCPUs",
+ "value": "TotalLowPriorityCores"
+ },
+ "unit": "Count"
+ },
+ {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/usages/StandardDFamily",
+ "type": "Microsoft.MachineLearningServices/vmFamily/lowPriorityCores/usages",
+ "currentValue": 0,
+ "limit": -1,
+ "name": {
+ "value": "StandardDFamily",
+ "localizedValue": "Standard D Family Cluster LowPriority vCPUs"
+ },
+ "unit": "Count"
+ },
+ {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/usages/StandardDSv2Family",
+ "type": "Microsoft.MachineLearningServices/vmFamily/lowPriorityCores/usages",
+ "currentValue": 0,
+ "limit": -1,
+ "name": {
+ "localizedValue": "Standard DSv2 Family Cluster LowPriority vCPUs",
+ "value": "StandardDSv2Family"
+ },
+ "unit": "Count"
+ },
+ {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/usages/StandardDv2Family",
+ "type": "Microsoft.MachineLearningServices/vmFamily/lowPriorityCores/usages",
+ "currentValue": 0,
+ "limit": -1,
+ "name": {
+ "localizedValue": "Standard Dv2 Family Cluster LowPriority vCPUs",
+ "value": "StandardDv2Family"
+ },
+ "unit": "Count"
+ },
+ {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/usages/StandardFSv2Family",
+ "type": "Microsoft.MachineLearningServices/vmFamily/lowPriorityCores/usages",
+ "currentValue": 0,
+ "limit": -1,
+ "name": {
+ "localizedValue": "Standard FSv2 Family Cluster LowPriority vCPUs",
+ "value": "StandardFSv2Family"
+ },
+ "unit": "Count"
+ },
+ {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/usages/StandardNCFamily",
+ "type": "Microsoft.MachineLearningServices/vmFamily/lowPriorityCores/usages",
+ "currentValue": 18,
+ "limit": -1,
+ "name": {
+ "localizedValue": "Standard NC Family Cluster LowPriority vCPUs",
+ "value": "StandardNCFamily"
+ },
+ "unit": "Count"
+ },
+ {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace1/usages/StandardNCFamily",
+ "type": "Microsoft.MachineLearningServices/workspace/lowPriorityCores/usages",
+ "currentValue": 6,
+ "limit": -1,
+ "name": {
+ "localizedValue": "Standard NC Family Cluster LowPriority vCPUs",
+ "value": "StandardNCFamily"
+ },
+ "unit": "Count"
+ },
+ {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace1/computes/demo_cluster1_lowPriority_nc/usages/StandardNCFamily",
+ "type": "Microsoft.MachineLearningServices/workspace/computes/lowPriorityCores/usages",
+ "currentValue": 6,
+ "limit": -1,
+ "name": {
+ "localizedValue": "Standard NC Family Cluster LowPriority vCPUs",
+ "value": "StandardNCFamily"
+ },
+ "unit": "Count"
+ },
+ {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace2/usages/StandardNCFamily",
+ "type": "Microsoft.MachineLearningServices/workspace/lowPriorityCores/usages",
+ "currentValue": 12,
+ "limit": -1,
+ "name": {
+ "localizedValue": "Standard NC Family Cluster LowPriority vCPUs",
+ "value": "StandardNCFamily"
+ },
+ "unit": "Count"
+ },
+ {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace2/computes/demo_cluster2_lowPriority_nc/usages/StandardNCFamily",
+ "type": "Microsoft.MachineLearningServices/workspace/computes/lowPriorityCores/usages",
+ "currentValue": 6,
+ "limit": -1,
+ "name": {
+ "localizedValue": "Standard NC Family Cluster LowPriority vCPUs",
+ "value": "StandardNCFamily"
+ },
+ "unit": "Count"
+ },
+ {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace2/computes/demo_cluster3_lowPriority_nc/usages/StandardNCFamily",
+ "type": "Microsoft.MachineLearningServices/workspace/computes/lowPriorityCores/usages",
+ "currentValue": 6,
+ "limit": -1,
+ "name": {
+ "localizedValue": "Standard NC Family Cluster LowPriority vCPUs",
+ "value": "StandardNCFamily"
+ },
+ "unit": "Count"
+ },
+ {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/usages/StandardNCv2Family",
+ "type": "Microsoft.MachineLearningServices/vmFamily/lowPriorityCores/usages",
+ "currentValue": 0,
+ "limit": -1,
+ "name": {
+ "localizedValue": "Standard NCv2 Family Cluster LowPriority vCPUs",
+ "value": "StandardNCv2Family"
+ },
+ "unit": "Count"
+ },
+ {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/usages/StandardNCv3Family",
+ "type": "Microsoft.MachineLearningServices/vmFamily/lowPriorityCores/usages",
+ "currentValue": 0,
+ "limit": -1,
+ "name": {
+ "localizedValue": "Standard NCv3 Family Cluster LowPriority vCPUs",
+ "value": "StandardNCv3Family"
+ },
+ "unit": "Count"
+ },
+ {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/usages/StandardNDFamily",
+ "type": "Microsoft.MachineLearningServices/vmFamily/lowPriorityCores/usages",
+ "currentValue": 0,
+ "limit": -1,
+ "name": {
+ "localizedValue": "Standard ND Family Cluster LowPriority vCPUs",
+ "value": "StandardNDFamily"
+ },
+ "unit": "Count"
+ },
+ {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/usages/StandardNDv2Family",
+ "type": "Microsoft.MachineLearningServices/vmFamily/lowPriorityCores/usages",
+ "currentValue": 0,
+ "limit": -1,
+ "name": {
+ "localizedValue": "Standard NDv2 Family Cluster LowPriority vCPUs",
+ "value": "StandardNDv2Family"
+ },
+ "unit": "Count"
+ },
+ {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/usages/StandardNVFamily",
+ "type": "Microsoft.MachineLearningServices/vmFamily/lowPriorityCores/usages",
+ "currentValue": 0,
+ "limit": -1,
+ "name": {
+ "localizedValue": "Standard NV Family Cluster LowPriority vCPUs",
+ "value": "StandardNVFamily"
+ },
+ "unit": "Count"
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-08-01/examples/ListVMSizesResult.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-08-01/examples/ListVMSizesResult.json
new file mode 100644
index 000000000000..5f75351b5b27
--- /dev/null
+++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-08-01/examples/ListVMSizesResult.json
@@ -0,0 +1,2967 @@
+{
+ "parameters": {
+ "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345",
+ "api-version": "2020-08-01",
+ "location": "eastus",
+ "computeType": "AmlCompute",
+ "recommended": false
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "amlCompute": [
+ {
+ "name": "Standard_D1_v2",
+ "family": "standardDv2Family",
+ "vCPUs": 1,
+ "gpus": 0,
+ "osVhdSizeMB": 1047552,
+ "maxResourceVolumeMB": 51200,
+ "memoryGB": 3.5,
+ "lowPriorityCapable": true,
+ "premiumIO": false,
+ "estimatedVMPrices": {
+ "billingCurrency": "USD",
+ "unitOfMeasure": "OneHour",
+ "values": [
+ {
+ "retailPrice": 0.01,
+ "osType": "Linux",
+ "vmTier": "LowPriority"
+ },
+ {
+ "retailPrice": 0.05,
+ "osType": "Windows",
+ "vmTier": "LowPriority"
+ },
+ {
+ "retailPrice": 0.06,
+ "osType": "Linux",
+ "vmTier": "Standard"
+ },
+ {
+ "retailPrice": 0.12,
+ "osType": "Windows",
+ "vmTier": "Standard"
+ }
+ ]
+ },
+ "supportedComputeTypes": [
+ "AmlCompute"
+ ]
+ },
+ {
+ "name": "Standard_D2_v2",
+ "family": "standardDv2Family",
+ "vCPUs": 2,
+ "gpus": 0,
+ "osVhdSizeMB": 1047552,
+ "maxResourceVolumeMB": 102400,
+ "memoryGB": 7,
+ "lowPriorityCapable": true,
+ "premiumIO": false,
+ "estimatedVMPrices": {
+ "billingCurrency": "USD",
+ "unitOfMeasure": "OneHour",
+ "values": [
+ {
+ "retailPrice": 0.11,
+ "osType": "Linux",
+ "vmTier": "Standard"
+ },
+ {
+ "retailPrice": 0.23,
+ "osType": "Windows",
+ "vmTier": "Standard"
+ },
+ {
+ "retailPrice": 0.02,
+ "osType": "Linux",
+ "vmTier": "LowPriority"
+ },
+ {
+ "retailPrice": 0.09,
+ "osType": "Windows",
+ "vmTier": "LowPriority"
+ }
+ ]
+ },
+ "supportedComputeTypes": [
+ "AmlCompute",
+ "ComputeInstance"
+ ]
+ },
+ {
+ "name": "Standard_D3_v2",
+ "family": "standardDv2Family",
+ "vCPUs": 4,
+ "gpus": 0,
+ "osVhdSizeMB": 1047552,
+ "maxResourceVolumeMB": 204800,
+ "memoryGB": 14,
+ "lowPriorityCapable": true,
+ "premiumIO": false,
+ "estimatedVMPrices": {
+ "billingCurrency": "USD",
+ "unitOfMeasure": "OneHour",
+ "values": [
+ {
+ "retailPrice": 0.05,
+ "osType": "Linux",
+ "vmTier": "LowPriority"
+ },
+ {
+ "retailPrice": 0.47,
+ "osType": "Windows",
+ "vmTier": "Standard"
+ },
+ {
+ "retailPrice": 0.23,
+ "osType": "Linux",
+ "vmTier": "Standard"
+ },
+ {
+ "retailPrice": 0.19,
+ "osType": "Windows",
+ "vmTier": "LowPriority"
+ }
+ ]
+ },
+ "supportedComputeTypes": [
+ "AmlCompute",
+ "ComputeInstance"
+ ]
+ },
+ {
+ "name": "Standard_D4_v2",
+ "family": "standardDv2Family",
+ "vCPUs": 8,
+ "gpus": 0,
+ "osVhdSizeMB": 1047552,
+ "maxResourceVolumeMB": 409600,
+ "memoryGB": 28,
+ "lowPriorityCapable": true,
+ "premiumIO": false,
+ "estimatedVMPrices": {
+ "billingCurrency": "USD",
+ "unitOfMeasure": "OneHour",
+ "values": [
+ {
+ "retailPrice": 0.94,
+ "osType": "Windows",
+ "vmTier": "Standard"
+ },
+ {
+ "retailPrice": 0.46,
+ "osType": "Linux",
+ "vmTier": "Standard"
+ },
+ {
+ "retailPrice": 0.09,
+ "osType": "Linux",
+ "vmTier": "LowPriority"
+ },
+ {
+ "retailPrice": 0.37,
+ "osType": "Windows",
+ "vmTier": "LowPriority"
+ }
+ ]
+ },
+ "supportedComputeTypes": [
+ "AmlCompute",
+ "ComputeInstance"
+ ]
+ },
+ {
+ "name": "Standard_D11_v2",
+ "family": "standardDv2Family",
+ "vCPUs": 2,
+ "gpus": 0,
+ "osVhdSizeMB": 1047552,
+ "maxResourceVolumeMB": 102400,
+ "memoryGB": 14,
+ "lowPriorityCapable": true,
+ "premiumIO": false,
+ "estimatedVMPrices": {
+ "billingCurrency": "USD",
+ "unitOfMeasure": "OneHour",
+ "values": [
+ {
+ "retailPrice": 0.24,
+ "osType": "Windows",
+ "vmTier": "Standard"
+ },
+ {
+ "retailPrice": 0.03,
+ "osType": "Linux",
+ "vmTier": "LowPriority"
+ },
+ {
+ "retailPrice": 0.1,
+ "osType": "Windows",
+ "vmTier": "LowPriority"
+ },
+ {
+ "retailPrice": 0.15,
+ "osType": "Linux",
+ "vmTier": "Standard"
+ }
+ ]
+ },
+ "supportedComputeTypes": [
+ "AmlCompute",
+ "ComputeInstance"
+ ]
+ },
+ {
+ "name": "Standard_D12_v2",
+ "family": "standardDv2Family",
+ "vCPUs": 4,
+ "gpus": 0,
+ "osVhdSizeMB": 1047552,
+ "maxResourceVolumeMB": 204800,
+ "memoryGB": 28,
+ "lowPriorityCapable": true,
+ "premiumIO": false,
+ "estimatedVMPrices": {
+ "billingCurrency": "USD",
+ "unitOfMeasure": "OneHour",
+ "values": [
+ {
+ "retailPrice": 0.19,
+ "osType": "Windows",
+ "vmTier": "LowPriority"
+ },
+ {
+ "retailPrice": 0.06,
+ "osType": "Linux",
+ "vmTier": "LowPriority"
+ },
+ {
+ "retailPrice": 0.49,
+ "osType": "Windows",
+ "vmTier": "Standard"
+ },
+ {
+ "retailPrice": 0.3,
+ "osType": "Linux",
+ "vmTier": "Standard"
+ }
+ ]
+ },
+ "supportedComputeTypes": [
+ "AmlCompute",
+ "ComputeInstance"
+ ]
+ },
+ {
+ "name": "Standard_D13_v2",
+ "family": "standardDv2Family",
+ "vCPUs": 8,
+ "gpus": 0,
+ "osVhdSizeMB": 1047552,
+ "maxResourceVolumeMB": 409600,
+ "memoryGB": 56,
+ "lowPriorityCapable": true,
+ "premiumIO": false,
+ "estimatedVMPrices": {
+ "billingCurrency": "USD",
+ "unitOfMeasure": "OneHour",
+ "values": [
+ {
+ "retailPrice": 0.6,
+ "osType": "Linux",
+ "vmTier": "Standard"
+ },
+ {
+ "retailPrice": 0.97,
+ "osType": "Windows",
+ "vmTier": "Standard"
+ },
+ {
+ "retailPrice": 0.39,
+ "osType": "Windows",
+ "vmTier": "LowPriority"
+ },
+ {
+ "retailPrice": 0.12,
+ "osType": "Linux",
+ "vmTier": "LowPriority"
+ }
+ ]
+ },
+ "supportedComputeTypes": [
+ "AmlCompute",
+ "ComputeInstance"
+ ]
+ },
+ {
+ "name": "Standard_D14_v2",
+ "family": "standardDv2Family",
+ "vCPUs": 16,
+ "gpus": 0,
+ "osVhdSizeMB": 1047552,
+ "maxResourceVolumeMB": 819200,
+ "memoryGB": 112,
+ "lowPriorityCapable": true,
+ "premiumIO": false,
+ "estimatedVMPrices": {
+ "billingCurrency": "USD",
+ "unitOfMeasure": "OneHour",
+ "values": [
+ {
+ "retailPrice": 1.94,
+ "osType": "Windows",
+ "vmTier": "Standard"
+ },
+ {
+ "retailPrice": 1.2,
+ "osType": "Linux",
+ "vmTier": "Standard"
+ },
+ {
+ "retailPrice": 0.78,
+ "osType": "Windows",
+ "vmTier": "LowPriority"
+ },
+ {
+ "retailPrice": 0.24,
+ "osType": "Linux",
+ "vmTier": "LowPriority"
+ }
+ ]
+ },
+ "supportedComputeTypes": [
+ "AmlCompute",
+ "ComputeInstance"
+ ]
+ },
+ {
+ "name": "Standard_D15_v2",
+ "family": "standardDv2Family",
+ "vCPUs": 20,
+ "gpus": 0,
+ "osVhdSizeMB": 1047552,
+ "maxResourceVolumeMB": 1024000,
+ "memoryGB": 140,
+ "lowPriorityCapable": true,
+ "premiumIO": false,
+ "estimatedVMPrices": {
+ "billingCurrency": "USD",
+ "unitOfMeasure": "OneHour",
+ "values": [
+ {
+ "retailPrice": 0.97,
+ "osType": "Windows",
+ "vmTier": "LowPriority"
+ },
+ {
+ "retailPrice": 2.43,
+ "osType": "Windows",
+ "vmTier": "Standard"
+ },
+ {
+ "retailPrice": 1.5,
+ "osType": "Linux",
+ "vmTier": "Standard"
+ },
+ {
+ "retailPrice": 0.3,
+ "osType": "Linux",
+ "vmTier": "LowPriority"
+ }
+ ]
+ },
+ "supportedComputeTypes": [
+ "AmlCompute",
+ "ComputeInstance"
+ ]
+ },
+ {
+ "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.01,
+ "osType": "Linux",
+ "vmTier": "LowPriority"
+ },
+ {
+ "retailPrice": 0.05,
+ "osType": "Windows",
+ "vmTier": "LowPriority"
+ },
+ {
+ "retailPrice": 0.06,
+ "osType": "Linux",
+ "vmTier": "Standard"
+ },
+ {
+ "retailPrice": 0.12,
+ "osType": "Windows",
+ "vmTier": "Standard"
+ }
+ ]
+ },
+ "supportedComputeTypes": [
+ "AmlCompute",
+ "ComputeInstance"
+ ]
+ },
+ {
+ "name": "Standard_DS2_v2",
+ "family": "standardDSv2Family",
+ "vCPUs": 2,
+ "gpus": 0,
+ "osVhdSizeMB": 1047552,
+ "maxResourceVolumeMB": 14336,
+ "memoryGB": 7,
+ "lowPriorityCapable": true,
+ "premiumIO": true,
+ "estimatedVMPrices": {
+ "billingCurrency": "USD",
+ "unitOfMeasure": "OneHour",
+ "values": [
+ {
+ "retailPrice": 0.11,
+ "osType": "Linux",
+ "vmTier": "Standard"
+ },
+ {
+ "retailPrice": 0.23,
+ "osType": "Windows",
+ "vmTier": "Standard"
+ },
+ {
+ "retailPrice": 0.02,
+ "osType": "Linux",
+ "vmTier": "LowPriority"
+ },
+ {
+ "retailPrice": 0.09,
+ "osType": "Windows",
+ "vmTier": "LowPriority"
+ }
+ ]
+ },
+ "supportedComputeTypes": [
+ "AmlCompute",
+ "ComputeInstance"
+ ]
+ },
+ {
+ "name": "Standard_DS3_v2",
+ "family": "standardDSv2Family",
+ "vCPUs": 4,
+ "gpus": 0,
+ "osVhdSizeMB": 1047552,
+ "maxResourceVolumeMB": 28672,
+ "memoryGB": 14,
+ "lowPriorityCapable": true,
+ "premiumIO": true,
+ "estimatedVMPrices": {
+ "billingCurrency": "USD",
+ "unitOfMeasure": "OneHour",
+ "values": [
+ {
+ "retailPrice": 0.05,
+ "osType": "Linux",
+ "vmTier": "LowPriority"
+ },
+ {
+ "retailPrice": 0.47,
+ "osType": "Windows",
+ "vmTier": "Standard"
+ },
+ {
+ "retailPrice": 0.23,
+ "osType": "Linux",
+ "vmTier": "Standard"
+ },
+ {
+ "retailPrice": 0.19,
+ "osType": "Windows",
+ "vmTier": "LowPriority"
+ }
+ ]
+ },
+ "supportedComputeTypes": [
+ "AmlCompute",
+ "ComputeInstance"
+ ]
+ },
+ {
+ "name": "Standard_DS4_v2",
+ "family": "standardDSv2Family",
+ "vCPUs": 8,
+ "gpus": 0,
+ "osVhdSizeMB": 1047552,
+ "maxResourceVolumeMB": 57344,
+ "memoryGB": 28,
+ "lowPriorityCapable": true,
+ "premiumIO": true,
+ "estimatedVMPrices": {
+ "billingCurrency": "USD",
+ "unitOfMeasure": "OneHour",
+ "values": [
+ {
+ "retailPrice": 0.94,
+ "osType": "Windows",
+ "vmTier": "Standard"
+ },
+ {
+ "retailPrice": 0.46,
+ "osType": "Linux",
+ "vmTier": "Standard"
+ },
+ {
+ "retailPrice": 0.09,
+ "osType": "Linux",
+ "vmTier": "LowPriority"
+ },
+ {
+ "retailPrice": 0.37,
+ "osType": "Windows",
+ "vmTier": "LowPriority"
+ }
+ ]
+ },
+ "supportedComputeTypes": [
+ "AmlCompute",
+ "ComputeInstance"
+ ]
+ },
+ {
+ "name": "Standard_DS5_v2",
+ "family": "standardDSv2Family",
+ "vCPUs": 16,
+ "gpus": 0,
+ "osVhdSizeMB": 1047552,
+ "maxResourceVolumeMB": 114688,
+ "memoryGB": 56,
+ "lowPriorityCapable": true,
+ "premiumIO": true,
+ "estimatedVMPrices": {
+ "billingCurrency": "USD",
+ "unitOfMeasure": "OneHour",
+ "values": [
+ {
+ "retailPrice": 0.75,
+ "osType": "Windows",
+ "vmTier": "LowPriority"
+ },
+ {
+ "retailPrice": 0.92,
+ "osType": "Linux",
+ "vmTier": "Standard"
+ },
+ {
+ "retailPrice": 1.87,
+ "osType": "Windows",
+ "vmTier": "Standard"
+ },
+ {
+ "retailPrice": 0.18,
+ "osType": "Linux",
+ "vmTier": "LowPriority"
+ }
+ ]
+ },
+ "supportedComputeTypes": [
+ "AmlCompute",
+ "ComputeInstance"
+ ]
+ },
+ {
+ "name": "Standard_DS11_v2",
+ "family": "standardDSv2Family",
+ "vCPUs": 2,
+ "gpus": 0,
+ "osVhdSizeMB": 1047552,
+ "maxResourceVolumeMB": 28672,
+ "memoryGB": 14,
+ "lowPriorityCapable": true,
+ "premiumIO": true,
+ "estimatedVMPrices": {
+ "billingCurrency": "USD",
+ "unitOfMeasure": "OneHour",
+ "values": [
+ {
+ "retailPrice": 0.24,
+ "osType": "Windows",
+ "vmTier": "Standard"
+ },
+ {
+ "retailPrice": 0.03,
+ "osType": "Linux",
+ "vmTier": "LowPriority"
+ },
+ {
+ "retailPrice": 0.1,
+ "osType": "Windows",
+ "vmTier": "LowPriority"
+ },
+ {
+ "retailPrice": 0.15,
+ "osType": "Linux",
+ "vmTier": "Standard"
+ }
+ ]
+ },
+ "supportedComputeTypes": [
+ "AmlCompute",
+ "ComputeInstance"
+ ]
+ },
+ {
+ "name": "Standard_DS12_v2",
+ "family": "standardDSv2Family",
+ "vCPUs": 4,
+ "gpus": 0,
+ "osVhdSizeMB": 1047552,
+ "maxResourceVolumeMB": 57344,
+ "memoryGB": 28,
+ "lowPriorityCapable": true,
+ "premiumIO": true,
+ "estimatedVMPrices": {
+ "billingCurrency": "USD",
+ "unitOfMeasure": "OneHour",
+ "values": [
+ {
+ "retailPrice": 0.19,
+ "osType": "Windows",
+ "vmTier": "LowPriority"
+ },
+ {
+ "retailPrice": 0.06,
+ "osType": "Linux",
+ "vmTier": "LowPriority"
+ },
+ {
+ "retailPrice": 0.49,
+ "osType": "Windows",
+ "vmTier": "Standard"
+ },
+ {
+ "retailPrice": 0.3,
+ "osType": "Linux",
+ "vmTier": "Standard"
+ }
+ ]
+ },
+ "supportedComputeTypes": [
+ "AmlCompute",
+ "ComputeInstance"
+ ]
+ },
+ {
+ "name": "Standard_DS13_v2",
+ "family": "standardDSv2Family",
+ "vCPUs": 8,
+ "gpus": 0,
+ "osVhdSizeMB": 1047552,
+ "maxResourceVolumeMB": 114688,
+ "memoryGB": 56,
+ "lowPriorityCapable": true,
+ "premiumIO": true,
+ "estimatedVMPrices": {
+ "billingCurrency": "USD",
+ "unitOfMeasure": "OneHour",
+ "values": [
+ {
+ "retailPrice": 0.6,
+ "osType": "Linux",
+ "vmTier": "Standard"
+ },
+ {
+ "retailPrice": 0.97,
+ "osType": "Windows",
+ "vmTier": "Standard"
+ },
+ {
+ "retailPrice": 0.39,
+ "osType": "Windows",
+ "vmTier": "LowPriority"
+ },
+ {
+ "retailPrice": 0.12,
+ "osType": "Linux",
+ "vmTier": "LowPriority"
+ }
+ ]
+ },
+ "supportedComputeTypes": [
+ "AmlCompute",
+ "ComputeInstance"
+ ]
+ },
+ {
+ "name": "Standard_DS14_v2",
+ "family": "standardDSv2Family",
+ "vCPUs": 16,
+ "gpus": 0,
+ "osVhdSizeMB": 1047552,
+ "maxResourceVolumeMB": 229376,
+ "memoryGB": 112,
+ "lowPriorityCapable": true,
+ "premiumIO": true,
+ "estimatedVMPrices": {
+ "billingCurrency": "USD",
+ "unitOfMeasure": "OneHour",
+ "values": [
+ {
+ "retailPrice": 1.94,
+ "osType": "Windows",
+ "vmTier": "Standard"
+ },
+ {
+ "retailPrice": 1.2,
+ "osType": "Linux",
+ "vmTier": "Standard"
+ },
+ {
+ "retailPrice": 0.78,
+ "osType": "Windows",
+ "vmTier": "LowPriority"
+ },
+ {
+ "retailPrice": 0.24,
+ "osType": "Linux",
+ "vmTier": "LowPriority"
+ }
+ ]
+ },
+ "supportedComputeTypes": [
+ "AmlCompute",
+ "ComputeInstance"
+ ]
+ },
+ {
+ "name": "Standard_DS15_v2",
+ "family": "standardDSv2Family",
+ "vCPUs": 20,
+ "gpus": 0,
+ "osVhdSizeMB": 1047552,
+ "maxResourceVolumeMB": 286720,
+ "memoryGB": 140,
+ "lowPriorityCapable": true,
+ "premiumIO": true,
+ "estimatedVMPrices": {
+ "billingCurrency": "USD",
+ "unitOfMeasure": "OneHour",
+ "values": [
+ {
+ "retailPrice": 0.97,
+ "osType": "Windows",
+ "vmTier": "LowPriority"
+ },
+ {
+ "retailPrice": 2.43,
+ "osType": "Windows",
+ "vmTier": "Standard"
+ },
+ {
+ "retailPrice": 1.5,
+ "osType": "Linux",
+ "vmTier": "Standard"
+ },
+ {
+ "retailPrice": 0.3,
+ "osType": "Linux",
+ "vmTier": "LowPriority"
+ }
+ ]
+ },
+ "supportedComputeTypes": [
+ "AmlCompute",
+ "ComputeInstance"
+ ]
+ },
+ {
+ "name": "Standard_F2s_v2",
+ "family": "standardFSv2Family",
+ "vCPUs": 2,
+ "gpus": 0,
+ "osVhdSizeMB": 1047552,
+ "maxResourceVolumeMB": 16384,
+ "memoryGB": 4,
+ "lowPriorityCapable": true,
+ "premiumIO": true,
+ "estimatedVMPrices": {
+ "billingCurrency": "USD",
+ "unitOfMeasure": "OneHour",
+ "values": [
+ {
+ "retailPrice": 0.16,
+ "osType": "Windows",
+ "vmTier": "Standard"
+ },
+ {
+ "retailPrice": 0.02,
+ "osType": "Linux",
+ "vmTier": "LowPriority"
+ },
+ {
+ "retailPrice": 0.08,
+ "osType": "Linux",
+ "vmTier": "Standard"
+ },
+ {
+ "retailPrice": 0.06,
+ "osType": "Windows",
+ "vmTier": "LowPriority"
+ }
+ ]
+ },
+ "supportedComputeTypes": [
+ "AmlCompute",
+ "ComputeInstance"
+ ]
+ },
+ {
+ "name": "Standard_F4s_v2",
+ "family": "standardFSv2Family",
+ "vCPUs": 4,
+ "gpus": 0,
+ "osVhdSizeMB": 1047552,
+ "maxResourceVolumeMB": 32768,
+ "memoryGB": 8,
+ "lowPriorityCapable": true,
+ "premiumIO": true,
+ "estimatedVMPrices": {
+ "billingCurrency": "USD",
+ "unitOfMeasure": "OneHour",
+ "values": [
+ {
+ "retailPrice": 0.13,
+ "osType": "Windows",
+ "vmTier": "LowPriority"
+ },
+ {
+ "retailPrice": 0.33,
+ "osType": "Windows",
+ "vmTier": "Standard"
+ },
+ {
+ "retailPrice": 0.17,
+ "osType": "Linux",
+ "vmTier": "Standard"
+ },
+ {
+ "retailPrice": 0.03,
+ "osType": "Linux",
+ "vmTier": "LowPriority"
+ }
+ ]
+ },
+ "supportedComputeTypes": [
+ "AmlCompute",
+ "ComputeInstance"
+ ]
+ },
+ {
+ "name": "Standard_F8s_v2",
+ "family": "standardFSv2Family",
+ "vCPUs": 8,
+ "gpus": 0,
+ "osVhdSizeMB": 1047552,
+ "maxResourceVolumeMB": 65536,
+ "memoryGB": 16,
+ "lowPriorityCapable": true,
+ "premiumIO": true,
+ "estimatedVMPrices": {
+ "billingCurrency": "USD",
+ "unitOfMeasure": "OneHour",
+ "values": [
+ {
+ "retailPrice": 0.07,
+ "osType": "Linux",
+ "vmTier": "LowPriority"
+ },
+ {
+ "retailPrice": 0.65,
+ "osType": "Windows",
+ "vmTier": "Standard"
+ },
+ {
+ "retailPrice": 0.26,
+ "osType": "Windows",
+ "vmTier": "LowPriority"
+ },
+ {
+ "retailPrice": 0.34,
+ "osType": "Linux",
+ "vmTier": "Standard"
+ }
+ ]
+ },
+ "supportedComputeTypes": [
+ "AmlCompute",
+ "ComputeInstance"
+ ]
+ },
+ {
+ "name": "Standard_F16s_v2",
+ "family": "standardFSv2Family",
+ "vCPUs": 16,
+ "gpus": 0,
+ "osVhdSizeMB": 1047552,
+ "maxResourceVolumeMB": 131072,
+ "memoryGB": 32,
+ "lowPriorityCapable": true,
+ "premiumIO": true,
+ "estimatedVMPrices": {
+ "billingCurrency": "USD",
+ "unitOfMeasure": "OneHour",
+ "values": [
+ {
+ "retailPrice": 0.52,
+ "osType": "Windows",
+ "vmTier": "LowPriority"
+ },
+ {
+ "retailPrice": 0.68,
+ "osType": "Linux",
+ "vmTier": "Standard"
+ },
+ {
+ "retailPrice": 1.3,
+ "osType": "Windows",
+ "vmTier": "Standard"
+ },
+ {
+ "retailPrice": 0.14,
+ "osType": "Linux",
+ "vmTier": "LowPriority"
+ }
+ ]
+ },
+ "supportedComputeTypes": [
+ "AmlCompute",
+ "ComputeInstance"
+ ]
+ },
+ {
+ "name": "Standard_F32s_v2",
+ "family": "standardFSv2Family",
+ "vCPUs": 32,
+ "gpus": 0,
+ "osVhdSizeMB": 1047552,
+ "maxResourceVolumeMB": 262144,
+ "memoryGB": 64,
+ "lowPriorityCapable": true,
+ "premiumIO": true,
+ "estimatedVMPrices": {
+ "billingCurrency": "USD",
+ "unitOfMeasure": "OneHour",
+ "values": [
+ {
+ "retailPrice": 1.35,
+ "osType": "Linux",
+ "vmTier": "Standard"
+ },
+ {
+ "retailPrice": 1.04,
+ "osType": "Windows",
+ "vmTier": "LowPriority"
+ },
+ {
+ "retailPrice": 2.6,
+ "osType": "Windows",
+ "vmTier": "Standard"
+ },
+ {
+ "retailPrice": 0.27,
+ "osType": "Linux",
+ "vmTier": "LowPriority"
+ }
+ ]
+ },
+ "supportedComputeTypes": [
+ "AmlCompute",
+ "ComputeInstance"
+ ]
+ },
+ {
+ "name": "Standard_F64s_v2",
+ "family": "standardFSv2Family",
+ "vCPUs": 64,
+ "gpus": 0,
+ "osVhdSizeMB": 1047552,
+ "maxResourceVolumeMB": 524288,
+ "memoryGB": 128,
+ "lowPriorityCapable": true,
+ "premiumIO": true,
+ "estimatedVMPrices": {
+ "billingCurrency": "USD",
+ "unitOfMeasure": "OneHour",
+ "values": [
+ {
+ "retailPrice": 5.21,
+ "osType": "Windows",
+ "vmTier": "Standard"
+ },
+ {
+ "retailPrice": 2.71,
+ "osType": "Linux",
+ "vmTier": "Standard"
+ },
+ {
+ "retailPrice": 2.08,
+ "osType": "Windows",
+ "vmTier": "LowPriority"
+ },
+ {
+ "retailPrice": 0.54,
+ "osType": "Linux",
+ "vmTier": "LowPriority"
+ }
+ ]
+ },
+ "supportedComputeTypes": [
+ "AmlCompute",
+ "ComputeInstance"
+ ]
+ },
+ {
+ "name": "Standard_F72s_v2",
+ "family": "standardFSv2Family",
+ "vCPUs": 72,
+ "gpus": 0,
+ "osVhdSizeMB": 1047552,
+ "maxResourceVolumeMB": 589824,
+ "memoryGB": 144,
+ "lowPriorityCapable": true,
+ "premiumIO": true,
+ "estimatedVMPrices": {
+ "billingCurrency": "USD",
+ "unitOfMeasure": "OneHour",
+ "values": [
+ {
+ "retailPrice": 5.86,
+ "osType": "Windows",
+ "vmTier": "Standard"
+ },
+ {
+ "retailPrice": 3.04,
+ "osType": "Linux",
+ "vmTier": "Standard"
+ },
+ {
+ "retailPrice": 0.61,
+ "osType": "Linux",
+ "vmTier": "LowPriority"
+ },
+ {
+ "retailPrice": 2.34,
+ "osType": "Windows",
+ "vmTier": "LowPriority"
+ }
+ ]
+ },
+ "supportedComputeTypes": [
+ "AmlCompute",
+ "ComputeInstance"
+ ]
+ },
+ {
+ "name": "Standard_NC6s_v3",
+ "family": "standardNCSv3Family",
+ "vCPUs": 6,
+ "gpus": 1,
+ "osVhdSizeMB": 1047552,
+ "maxResourceVolumeMB": 344064,
+ "memoryGB": 112,
+ "lowPriorityCapable": true,
+ "premiumIO": true,
+ "estimatedVMPrices": {
+ "billingCurrency": "USD",
+ "unitOfMeasure": "OneHour",
+ "values": [
+ {
+ "retailPrice": 0.61,
+ "osType": "Linux",
+ "vmTier": "LowPriority"
+ },
+ {
+ "retailPrice": 1.34,
+ "osType": "Windows",
+ "vmTier": "LowPriority"
+ },
+ {
+ "retailPrice": 3.06,
+ "osType": "Linux",
+ "vmTier": "Standard"
+ },
+ {
+ "retailPrice": 3.34,
+ "osType": "Windows",
+ "vmTier": "Standard"
+ }
+ ]
+ },
+ "supportedComputeTypes": [
+ "AmlCompute",
+ "ComputeInstance"
+ ]
+ },
+ {
+ "name": "Standard_NC12s_v3",
+ "family": "standardNCSv3Family",
+ "vCPUs": 12,
+ "gpus": 2,
+ "osVhdSizeMB": 1047552,
+ "maxResourceVolumeMB": 688128,
+ "memoryGB": 224,
+ "lowPriorityCapable": true,
+ "premiumIO": true,
+ "estimatedVMPrices": {
+ "billingCurrency": "USD",
+ "unitOfMeasure": "OneHour",
+ "values": [
+ {
+ "retailPrice": 2.67,
+ "osType": "Windows",
+ "vmTier": "LowPriority"
+ },
+ {
+ "retailPrice": 1.22,
+ "osType": "Linux",
+ "vmTier": "LowPriority"
+ },
+ {
+ "retailPrice": 6.68,
+ "osType": "Windows",
+ "vmTier": "Standard"
+ },
+ {
+ "retailPrice": 6.12,
+ "osType": "Linux",
+ "vmTier": "Standard"
+ }
+ ]
+ },
+ "supportedComputeTypes": [
+ "AmlCompute",
+ "ComputeInstance"
+ ]
+ },
+ {
+ "name": "Standard_NC24rs_v3",
+ "family": "standardNCSv3Family",
+ "vCPUs": 24,
+ "gpus": 4,
+ "osVhdSizeMB": 1047552,
+ "maxResourceVolumeMB": 1376256,
+ "memoryGB": 448,
+ "lowPriorityCapable": true,
+ "premiumIO": true,
+ "estimatedVMPrices": {
+ "billingCurrency": "USD",
+ "unitOfMeasure": "OneHour",
+ "values": [
+ {
+ "retailPrice": 5.83,
+ "osType": "Windows",
+ "vmTier": "LowPriority"
+ },
+ {
+ "retailPrice": 2.69,
+ "osType": "Linux",
+ "vmTier": "LowPriority"
+ },
+ {
+ "retailPrice": 14.59,
+ "osType": "Windows",
+ "vmTier": "Standard"
+ },
+ {
+ "retailPrice": 13.46,
+ "osType": "Linux",
+ "vmTier": "Standard"
+ }
+ ]
+ },
+ "supportedComputeTypes": [
+ "AmlCompute",
+ "ComputeInstance"
+ ]
+ },
+ {
+ "name": "Standard_NC24s_v3",
+ "family": "standardNCSv3Family",
+ "vCPUs": 24,
+ "gpus": 4,
+ "osVhdSizeMB": 1047552,
+ "maxResourceVolumeMB": 1376256,
+ "memoryGB": 448,
+ "lowPriorityCapable": true,
+ "premiumIO": true,
+ "estimatedVMPrices": {
+ "billingCurrency": "USD",
+ "unitOfMeasure": "OneHour",
+ "values": [
+ {
+ "retailPrice": 13.36,
+ "osType": "Windows",
+ "vmTier": "Standard"
+ },
+ {
+ "retailPrice": 5.35,
+ "osType": "Windows",
+ "vmTier": "LowPriority"
+ },
+ {
+ "retailPrice": 2.45,
+ "osType": "Linux",
+ "vmTier": "LowPriority"
+ },
+ {
+ "retailPrice": 12.24,
+ "osType": "Linux",
+ "vmTier": "Standard"
+ }
+ ]
+ },
+ "supportedComputeTypes": [
+ "AmlCompute",
+ "ComputeInstance"
+ ]
+ },
+ {
+ "name": "Standard_D1",
+ "family": "standardDFamily",
+ "vCPUs": 1,
+ "gpus": 0,
+ "osVhdSizeMB": 1047552,
+ "maxResourceVolumeMB": 51200,
+ "memoryGB": 3.5,
+ "lowPriorityCapable": true,
+ "premiumIO": false,
+ "estimatedVMPrices": {
+ "billingCurrency": "USD",
+ "unitOfMeasure": "OneHour",
+ "values": [
+ {
+ "retailPrice": 0.01,
+ "osType": "Linux",
+ "vmTier": "LowPriority"
+ },
+ {
+ "retailPrice": 0.05,
+ "osType": "Windows",
+ "vmTier": "LowPriority"
+ },
+ {
+ "retailPrice": 0.13,
+ "osType": "Windows",
+ "vmTier": "Standard"
+ },
+ {
+ "retailPrice": 0.07,
+ "osType": "Linux",
+ "vmTier": "Standard"
+ }
+ ]
+ },
+ "supportedComputeTypes": [
+ "AmlCompute"
+ ]
+ },
+ {
+ "name": "Standard_D2",
+ "family": "standardDFamily",
+ "vCPUs": 2,
+ "gpus": 0,
+ "osVhdSizeMB": 1047552,
+ "maxResourceVolumeMB": 102400,
+ "memoryGB": 7,
+ "lowPriorityCapable": true,
+ "premiumIO": false,
+ "estimatedVMPrices": {
+ "billingCurrency": "USD",
+ "unitOfMeasure": "OneHour",
+ "values": [
+ {
+ "retailPrice": 0.13,
+ "osType": "Linux",
+ "vmTier": "Standard"
+ },
+ {
+ "retailPrice": 0.1,
+ "osType": "Windows",
+ "vmTier": "LowPriority"
+ },
+ {
+ "retailPrice": 0.03,
+ "osType": "Linux",
+ "vmTier": "LowPriority"
+ },
+ {
+ "retailPrice": 0.26,
+ "osType": "Windows",
+ "vmTier": "Standard"
+ }
+ ]
+ },
+ "supportedComputeTypes": [
+ "AmlCompute",
+ "ComputeInstance"
+ ]
+ },
+ {
+ "name": "Standard_D3",
+ "family": "standardDFamily",
+ "vCPUs": 4,
+ "gpus": 0,
+ "osVhdSizeMB": 1047552,
+ "maxResourceVolumeMB": 204800,
+ "memoryGB": 14,
+ "lowPriorityCapable": true,
+ "premiumIO": false,
+ "estimatedVMPrices": {
+ "billingCurrency": "USD",
+ "unitOfMeasure": "OneHour",
+ "values": [
+ {
+ "retailPrice": 0.05,
+ "osType": "Linux",
+ "vmTier": "LowPriority"
+ },
+ {
+ "retailPrice": 0.52,
+ "osType": "Windows",
+ "vmTier": "Standard"
+ },
+ {
+ "retailPrice": 0.27,
+ "osType": "Linux",
+ "vmTier": "Standard"
+ },
+ {
+ "retailPrice": 0.21,
+ "osType": "Windows",
+ "vmTier": "LowPriority"
+ }
+ ]
+ },
+ "supportedComputeTypes": [
+ "AmlCompute",
+ "ComputeInstance"
+ ]
+ },
+ {
+ "name": "Standard_D4",
+ "family": "standardDFamily",
+ "vCPUs": 8,
+ "gpus": 0,
+ "osVhdSizeMB": 1047552,
+ "maxResourceVolumeMB": 409600,
+ "memoryGB": 28,
+ "lowPriorityCapable": true,
+ "premiumIO": false,
+ "estimatedVMPrices": {
+ "billingCurrency": "USD",
+ "unitOfMeasure": "OneHour",
+ "values": [
+ {
+ "retailPrice": 0.42,
+ "osType": "Windows",
+ "vmTier": "LowPriority"
+ },
+ {
+ "retailPrice": 0.54,
+ "osType": "Linux",
+ "vmTier": "Standard"
+ },
+ {
+ "retailPrice": 0.11,
+ "osType": "Linux",
+ "vmTier": "LowPriority"
+ },
+ {
+ "retailPrice": 1.04,
+ "osType": "Windows",
+ "vmTier": "Standard"
+ }
+ ]
+ },
+ "supportedComputeTypes": [
+ "AmlCompute",
+ "ComputeInstance"
+ ]
+ },
+ {
+ "name": "Standard_D11",
+ "family": "standardDFamily",
+ "vCPUs": 2,
+ "gpus": 0,
+ "osVhdSizeMB": 1047552,
+ "maxResourceVolumeMB": 102400,
+ "memoryGB": 14,
+ "lowPriorityCapable": true,
+ "premiumIO": false,
+ "estimatedVMPrices": {
+ "billingCurrency": "USD",
+ "unitOfMeasure": "OneHour",
+ "values": [
+ {
+ "retailPrice": 0.1,
+ "osType": "Windows",
+ "vmTier": "LowPriority"
+ },
+ {
+ "retailPrice": 0.03,
+ "osType": "Linux",
+ "vmTier": "LowPriority"
+ },
+ {
+ "retailPrice": 0.17,
+ "osType": "Linux",
+ "vmTier": "Standard"
+ },
+ {
+ "retailPrice": 0.24,
+ "osType": "Windows",
+ "vmTier": "Standard"
+ }
+ ]
+ },
+ "supportedComputeTypes": [
+ "AmlCompute",
+ "ComputeInstance"
+ ]
+ },
+ {
+ "name": "Standard_D12",
+ "family": "standardDFamily",
+ "vCPUs": 4,
+ "gpus": 0,
+ "osVhdSizeMB": 1047552,
+ "maxResourceVolumeMB": 204800,
+ "memoryGB": 28,
+ "lowPriorityCapable": true,
+ "premiumIO": false,
+ "estimatedVMPrices": {
+ "billingCurrency": "USD",
+ "unitOfMeasure": "OneHour",
+ "values": [
+ {
+ "retailPrice": 0.35,
+ "osType": "Linux",
+ "vmTier": "Standard"
+ },
+ {
+ "retailPrice": 0.49,
+ "osType": "Windows",
+ "vmTier": "Standard"
+ },
+ {
+ "retailPrice": 0.19,
+ "osType": "Windows",
+ "vmTier": "LowPriority"
+ },
+ {
+ "retailPrice": 0.07,
+ "osType": "Linux",
+ "vmTier": "LowPriority"
+ }
+ ]
+ },
+ "supportedComputeTypes": [
+ "AmlCompute",
+ "ComputeInstance"
+ ]
+ },
+ {
+ "name": "Standard_D13",
+ "family": "standardDFamily",
+ "vCPUs": 8,
+ "gpus": 0,
+ "osVhdSizeMB": 1047552,
+ "maxResourceVolumeMB": 409600,
+ "memoryGB": 56,
+ "lowPriorityCapable": true,
+ "premiumIO": false,
+ "estimatedVMPrices": {
+ "billingCurrency": "USD",
+ "unitOfMeasure": "OneHour",
+ "values": [
+ {
+ "retailPrice": 0.97,
+ "osType": "Windows",
+ "vmTier": "Standard"
+ },
+ {
+ "retailPrice": 0.39,
+ "osType": "Windows",
+ "vmTier": "LowPriority"
+ },
+ {
+ "retailPrice": 0.69,
+ "osType": "Linux",
+ "vmTier": "Standard"
+ },
+ {
+ "retailPrice": 0.14,
+ "osType": "Linux",
+ "vmTier": "LowPriority"
+ }
+ ]
+ },
+ "supportedComputeTypes": [
+ "AmlCompute",
+ "ComputeInstance"
+ ]
+ },
+ {
+ "name": "Standard_D14",
+ "family": "standardDFamily",
+ "vCPUs": 16,
+ "gpus": 0,
+ "osVhdSizeMB": 1047552,
+ "maxResourceVolumeMB": 819200,
+ "memoryGB": 112,
+ "lowPriorityCapable": true,
+ "premiumIO": false,
+ "estimatedVMPrices": {
+ "billingCurrency": "USD",
+ "unitOfMeasure": "OneHour",
+ "values": [
+ {
+ "retailPrice": 1.94,
+ "osType": "Windows",
+ "vmTier": "Standard"
+ },
+ {
+ "retailPrice": 0.78,
+ "osType": "Windows",
+ "vmTier": "LowPriority"
+ },
+ {
+ "retailPrice": 0.28,
+ "osType": "Linux",
+ "vmTier": "LowPriority"
+ },
+ {
+ "retailPrice": 1.39,
+ "osType": "Linux",
+ "vmTier": "Standard"
+ }
+ ]
+ },
+ "supportedComputeTypes": [
+ "AmlCompute",
+ "ComputeInstance"
+ ]
+ },
+ {
+ "name": "Standard_NV6",
+ "family": "standardNVFamily",
+ "vCPUs": 6,
+ "gpus": 1,
+ "osVhdSizeMB": 1047552,
+ "maxResourceVolumeMB": 389120,
+ "memoryGB": 56,
+ "lowPriorityCapable": true,
+ "premiumIO": false,
+ "estimatedVMPrices": {
+ "billingCurrency": "USD",
+ "unitOfMeasure": "OneHour",
+ "values": [
+ {
+ "retailPrice": 1.41,
+ "osType": "Windows",
+ "vmTier": "Standard"
+ },
+ {
+ "retailPrice": 0.24,
+ "osType": "Linux",
+ "vmTier": "LowPriority"
+ },
+ {
+ "retailPrice": 1.2,
+ "osType": "Linux",
+ "vmTier": "Standard"
+ },
+ {
+ "retailPrice": 0.56,
+ "osType": "Windows",
+ "vmTier": "LowPriority"
+ }
+ ]
+ },
+ "supportedComputeTypes": [
+ "AmlCompute",
+ "ComputeInstance"
+ ]
+ },
+ {
+ "name": "Standard_NV12",
+ "family": "standardNVFamily",
+ "vCPUs": 12,
+ "gpus": 2,
+ "osVhdSizeMB": 1047552,
+ "maxResourceVolumeMB": 696320,
+ "memoryGB": 112,
+ "lowPriorityCapable": true,
+ "premiumIO": false,
+ "estimatedVMPrices": {
+ "billingCurrency": "USD",
+ "unitOfMeasure": "OneHour",
+ "values": [
+ {
+ "retailPrice": 2.82,
+ "osType": "Windows",
+ "vmTier": "Standard"
+ },
+ {
+ "retailPrice": 1.13,
+ "osType": "Windows",
+ "vmTier": "LowPriority"
+ },
+ {
+ "retailPrice": 0.48,
+ "osType": "Linux",
+ "vmTier": "LowPriority"
+ },
+ {
+ "retailPrice": 2.4,
+ "osType": "Linux",
+ "vmTier": "Standard"
+ }
+ ]
+ },
+ "supportedComputeTypes": [
+ "AmlCompute",
+ "ComputeInstance"
+ ]
+ },
+ {
+ "name": "Standard_NV24",
+ "family": "standardNVFamily",
+ "vCPUs": 24,
+ "gpus": 4,
+ "osVhdSizeMB": 1047552,
+ "maxResourceVolumeMB": 1474560,
+ "memoryGB": 224,
+ "lowPriorityCapable": true,
+ "premiumIO": false,
+ "estimatedVMPrices": {
+ "billingCurrency": "USD",
+ "unitOfMeasure": "OneHour",
+ "values": [
+ {
+ "retailPrice": 5.64,
+ "osType": "Windows",
+ "vmTier": "Standard"
+ },
+ {
+ "retailPrice": 2.26,
+ "osType": "Windows",
+ "vmTier": "LowPriority"
+ },
+ {
+ "retailPrice": 4.81,
+ "osType": "Linux",
+ "vmTier": "Standard"
+ },
+ {
+ "retailPrice": 0.96,
+ "osType": "Linux",
+ "vmTier": "LowPriority"
+ }
+ ]
+ },
+ "supportedComputeTypes": [
+ "AmlCompute",
+ "ComputeInstance"
+ ]
+ },
+ {
+ "name": "Standard_NC6",
+ "family": "standardNCFamily",
+ "vCPUs": 6,
+ "gpus": 1,
+ "osVhdSizeMB": 1047552,
+ "maxResourceVolumeMB": 389120,
+ "memoryGB": 56,
+ "lowPriorityCapable": true,
+ "premiumIO": false,
+ "estimatedVMPrices": {
+ "billingCurrency": "USD",
+ "unitOfMeasure": "OneHour",
+ "values": [
+ {
+ "retailPrice": 0.9,
+ "osType": "Linux",
+ "vmTier": "Standard"
+ },
+ {
+ "retailPrice": 0.43,
+ "osType": "Windows",
+ "vmTier": "LowPriority"
+ },
+ {
+ "retailPrice": 1.08,
+ "osType": "Windows",
+ "vmTier": "Standard"
+ },
+ {
+ "retailPrice": 0.18,
+ "osType": "Linux",
+ "vmTier": "LowPriority"
+ }
+ ]
+ },
+ "supportedComputeTypes": [
+ "AmlCompute",
+ "ComputeInstance"
+ ]
+ },
+ {
+ "name": "Standard_NC12",
+ "family": "standardNCFamily",
+ "vCPUs": 12,
+ "gpus": 2,
+ "osVhdSizeMB": 1047552,
+ "maxResourceVolumeMB": 696320,
+ "memoryGB": 112,
+ "lowPriorityCapable": true,
+ "premiumIO": false,
+ "estimatedVMPrices": {
+ "billingCurrency": "USD",
+ "unitOfMeasure": "OneHour",
+ "values": [
+ {
+ "retailPrice": 0.36,
+ "osType": "Linux",
+ "vmTier": "LowPriority"
+ },
+ {
+ "retailPrice": 0.87,
+ "osType": "Windows",
+ "vmTier": "LowPriority"
+ },
+ {
+ "retailPrice": 1.8,
+ "osType": "Linux",
+ "vmTier": "Standard"
+ },
+ {
+ "retailPrice": 2.17,
+ "osType": "Windows",
+ "vmTier": "Standard"
+ }
+ ]
+ },
+ "supportedComputeTypes": [
+ "AmlCompute",
+ "ComputeInstance"
+ ]
+ },
+ {
+ "name": "Standard_NC24",
+ "family": "standardNCFamily",
+ "vCPUs": 24,
+ "gpus": 4,
+ "osVhdSizeMB": 1047552,
+ "maxResourceVolumeMB": 1474560,
+ "memoryGB": 224,
+ "lowPriorityCapable": true,
+ "premiumIO": false,
+ "estimatedVMPrices": {
+ "billingCurrency": "USD",
+ "unitOfMeasure": "OneHour",
+ "values": [
+ {
+ "retailPrice": 4.34,
+ "osType": "Windows",
+ "vmTier": "Standard"
+ },
+ {
+ "retailPrice": 0.72,
+ "osType": "Linux",
+ "vmTier": "LowPriority"
+ },
+ {
+ "retailPrice": 3.6,
+ "osType": "Linux",
+ "vmTier": "Standard"
+ },
+ {
+ "retailPrice": 1.73,
+ "osType": "Windows",
+ "vmTier": "LowPriority"
+ }
+ ]
+ },
+ "supportedComputeTypes": [
+ "AmlCompute",
+ "ComputeInstance"
+ ]
+ },
+ {
+ "name": "Standard_NC24r",
+ "family": "standardNCFamily",
+ "vCPUs": 24,
+ "gpus": 4,
+ "osVhdSizeMB": 1047552,
+ "maxResourceVolumeMB": 1474560,
+ "memoryGB": 224,
+ "lowPriorityCapable": true,
+ "premiumIO": false,
+ "estimatedVMPrices": {
+ "billingCurrency": "USD",
+ "unitOfMeasure": "OneHour",
+ "values": [
+ {
+ "retailPrice": 3.96,
+ "osType": "Linux",
+ "vmTier": "Standard"
+ },
+ {
+ "retailPrice": 0.79,
+ "osType": "Linux",
+ "vmTier": "LowPriority"
+ },
+ {
+ "retailPrice": 4.77,
+ "osType": "Windows",
+ "vmTier": "Standard"
+ },
+ {
+ "retailPrice": 1.91,
+ "osType": "Windows",
+ "vmTier": "LowPriority"
+ }
+ ]
+ },
+ "supportedComputeTypes": [
+ "AmlCompute",
+ "ComputeInstance"
+ ]
+ },
+ {
+ "name": "Standard_M8-2ms",
+ "family": "standardMSFamily",
+ "vCPUs": 8,
+ "gpus": 0,
+ "osVhdSizeMB": 1047552,
+ "maxResourceVolumeMB": 256000,
+ "memoryGB": 218.75,
+ "lowPriorityCapable": true,
+ "premiumIO": true,
+ "estimatedVMPrices": {
+ "billingCurrency": "USD",
+ "unitOfMeasure": "OneHour",
+ "values": [
+ {
+ "retailPrice": 2.11,
+ "osType": "Windows",
+ "vmTier": "Standard"
+ },
+ {
+ "retailPrice": 0.31,
+ "osType": "Linux",
+ "vmTier": "LowPriority"
+ },
+ {
+ "retailPrice": 1.54,
+ "osType": "Linux",
+ "vmTier": "Standard"
+ },
+ {
+ "retailPrice": 0.84,
+ "osType": "Windows",
+ "vmTier": "LowPriority"
+ }
+ ]
+ },
+ "supportedComputeTypes": [
+ "AmlCompute",
+ "ComputeInstance"
+ ]
+ },
+ {
+ "name": "Standard_M8-4ms",
+ "family": "standardMSFamily",
+ "vCPUs": 8,
+ "gpus": 0,
+ "osVhdSizeMB": 1047552,
+ "maxResourceVolumeMB": 256000,
+ "memoryGB": 218.75,
+ "lowPriorityCapable": true,
+ "premiumIO": true,
+ "estimatedVMPrices": {
+ "billingCurrency": "USD",
+ "unitOfMeasure": "OneHour",
+ "values": [
+ {
+ "retailPrice": 2.11,
+ "osType": "Windows",
+ "vmTier": "Standard"
+ },
+ {
+ "retailPrice": 0.31,
+ "osType": "Linux",
+ "vmTier": "LowPriority"
+ },
+ {
+ "retailPrice": 1.54,
+ "osType": "Linux",
+ "vmTier": "Standard"
+ },
+ {
+ "retailPrice": 0.84,
+ "osType": "Windows",
+ "vmTier": "LowPriority"
+ }
+ ]
+ },
+ "supportedComputeTypes": [
+ "AmlCompute",
+ "ComputeInstance"
+ ]
+ },
+ {
+ "name": "Standard_M8ms",
+ "family": "standardMSFamily",
+ "vCPUs": 8,
+ "gpus": 0,
+ "osVhdSizeMB": 1047552,
+ "maxResourceVolumeMB": 256000,
+ "memoryGB": 218.75,
+ "lowPriorityCapable": true,
+ "premiumIO": true,
+ "estimatedVMPrices": {
+ "billingCurrency": "USD",
+ "unitOfMeasure": "OneHour",
+ "values": [
+ {
+ "retailPrice": 2.11,
+ "osType": "Windows",
+ "vmTier": "Standard"
+ },
+ {
+ "retailPrice": 0.31,
+ "osType": "Linux",
+ "vmTier": "LowPriority"
+ },
+ {
+ "retailPrice": 1.54,
+ "osType": "Linux",
+ "vmTier": "Standard"
+ },
+ {
+ "retailPrice": 0.84,
+ "osType": "Windows",
+ "vmTier": "LowPriority"
+ }
+ ]
+ },
+ "supportedComputeTypes": [
+ "AmlCompute",
+ "ComputeInstance"
+ ]
+ },
+ {
+ "name": "Standard_M16-4ms",
+ "family": "standardMSFamily",
+ "vCPUs": 16,
+ "gpus": 0,
+ "osVhdSizeMB": 1047552,
+ "maxResourceVolumeMB": 512000,
+ "memoryGB": 437.5,
+ "lowPriorityCapable": true,
+ "premiumIO": true,
+ "estimatedVMPrices": {
+ "billingCurrency": "USD",
+ "unitOfMeasure": "OneHour",
+ "values": [
+ {
+ "retailPrice": 4.21,
+ "osType": "Windows",
+ "vmTier": "Standard"
+ },
+ {
+ "retailPrice": 1.69,
+ "osType": "Windows",
+ "vmTier": "LowPriority"
+ },
+ {
+ "retailPrice": 0.61,
+ "osType": "Linux",
+ "vmTier": "LowPriority"
+ },
+ {
+ "retailPrice": 3.07,
+ "osType": "Linux",
+ "vmTier": "Standard"
+ }
+ ]
+ },
+ "supportedComputeTypes": [
+ "AmlCompute",
+ "ComputeInstance"
+ ]
+ },
+ {
+ "name": "Standard_M16-8ms",
+ "family": "standardMSFamily",
+ "vCPUs": 16,
+ "gpus": 0,
+ "osVhdSizeMB": 1047552,
+ "maxResourceVolumeMB": 512000,
+ "memoryGB": 437.5,
+ "lowPriorityCapable": true,
+ "premiumIO": true,
+ "estimatedVMPrices": {
+ "billingCurrency": "USD",
+ "unitOfMeasure": "OneHour",
+ "values": [
+ {
+ "retailPrice": 4.21,
+ "osType": "Windows",
+ "vmTier": "Standard"
+ },
+ {
+ "retailPrice": 1.69,
+ "osType": "Windows",
+ "vmTier": "LowPriority"
+ },
+ {
+ "retailPrice": 0.61,
+ "osType": "Linux",
+ "vmTier": "LowPriority"
+ },
+ {
+ "retailPrice": 3.07,
+ "osType": "Linux",
+ "vmTier": "Standard"
+ }
+ ]
+ },
+ "supportedComputeTypes": [
+ "AmlCompute",
+ "ComputeInstance"
+ ]
+ },
+ {
+ "name": "Standard_M16ms",
+ "family": "standardMSFamily",
+ "vCPUs": 16,
+ "gpus": 0,
+ "osVhdSizeMB": 1047552,
+ "maxResourceVolumeMB": 512000,
+ "memoryGB": 437.5,
+ "lowPriorityCapable": true,
+ "premiumIO": true,
+ "estimatedVMPrices": {
+ "billingCurrency": "USD",
+ "unitOfMeasure": "OneHour",
+ "values": [
+ {
+ "retailPrice": 4.21,
+ "osType": "Windows",
+ "vmTier": "Standard"
+ },
+ {
+ "retailPrice": 1.69,
+ "osType": "Windows",
+ "vmTier": "LowPriority"
+ },
+ {
+ "retailPrice": 0.61,
+ "osType": "Linux",
+ "vmTier": "LowPriority"
+ },
+ {
+ "retailPrice": 3.07,
+ "osType": "Linux",
+ "vmTier": "Standard"
+ }
+ ]
+ },
+ "supportedComputeTypes": [
+ "AmlCompute",
+ "ComputeInstance"
+ ]
+ },
+ {
+ "name": "Standard_M32-8ms",
+ "family": "standardMSFamily",
+ "vCPUs": 32,
+ "gpus": 0,
+ "osVhdSizeMB": 1047552,
+ "maxResourceVolumeMB": 1024000,
+ "memoryGB": 875,
+ "lowPriorityCapable": true,
+ "premiumIO": true,
+ "estimatedVMPrices": {
+ "billingCurrency": "USD",
+ "unitOfMeasure": "OneHour",
+ "values": [
+ {
+ "retailPrice": 3.37,
+ "osType": "Windows",
+ "vmTier": "LowPriority"
+ },
+ {
+ "retailPrice": 8.43,
+ "osType": "Windows",
+ "vmTier": "Standard"
+ },
+ {
+ "retailPrice": 6.15,
+ "osType": "Linux",
+ "vmTier": "Standard"
+ },
+ {
+ "retailPrice": 1.23,
+ "osType": "Linux",
+ "vmTier": "LowPriority"
+ }
+ ]
+ },
+ "supportedComputeTypes": [
+ "AmlCompute",
+ "ComputeInstance"
+ ]
+ },
+ {
+ "name": "Standard_M32-16ms",
+ "family": "standardMSFamily",
+ "vCPUs": 32,
+ "gpus": 0,
+ "osVhdSizeMB": 1047552,
+ "maxResourceVolumeMB": 1024000,
+ "memoryGB": 875,
+ "lowPriorityCapable": true,
+ "premiumIO": true,
+ "estimatedVMPrices": {
+ "billingCurrency": "USD",
+ "unitOfMeasure": "OneHour",
+ "values": [
+ {
+ "retailPrice": 3.37,
+ "osType": "Windows",
+ "vmTier": "LowPriority"
+ },
+ {
+ "retailPrice": 8.43,
+ "osType": "Windows",
+ "vmTier": "Standard"
+ },
+ {
+ "retailPrice": 6.15,
+ "osType": "Linux",
+ "vmTier": "Standard"
+ },
+ {
+ "retailPrice": 1.23,
+ "osType": "Linux",
+ "vmTier": "LowPriority"
+ }
+ ]
+ },
+ "supportedComputeTypes": [
+ "AmlCompute",
+ "ComputeInstance"
+ ]
+ },
+ {
+ "name": "Standard_M32ls",
+ "family": "standardMSFamily",
+ "vCPUs": 32,
+ "gpus": 0,
+ "osVhdSizeMB": 1047552,
+ "maxResourceVolumeMB": 1024000,
+ "memoryGB": 256,
+ "lowPriorityCapable": true,
+ "premiumIO": true,
+ "estimatedVMPrices": {
+ "billingCurrency": "USD",
+ "unitOfMeasure": "OneHour",
+ "values": [
+ {
+ "retailPrice": 2.87,
+ "osType": "Linux",
+ "vmTier": "Standard"
+ },
+ {
+ "retailPrice": 1.16,
+ "osType": "Windows",
+ "vmTier": "LowPriority"
+ },
+ {
+ "retailPrice": 0.57,
+ "osType": "Linux",
+ "vmTier": "LowPriority"
+ },
+ {
+ "retailPrice": 4.34,
+ "osType": "Windows",
+ "vmTier": "Standard"
+ }
+ ]
+ },
+ "supportedComputeTypes": [
+ "AmlCompute",
+ "ComputeInstance"
+ ]
+ },
+ {
+ "name": "Standard_M32ms",
+ "family": "standardMSFamily",
+ "vCPUs": 32,
+ "gpus": 0,
+ "osVhdSizeMB": 1047552,
+ "maxResourceVolumeMB": 1024000,
+ "memoryGB": 875,
+ "lowPriorityCapable": true,
+ "premiumIO": true,
+ "estimatedVMPrices": {
+ "billingCurrency": "USD",
+ "unitOfMeasure": "OneHour",
+ "values": [
+ {
+ "retailPrice": 3.37,
+ "osType": "Windows",
+ "vmTier": "LowPriority"
+ },
+ {
+ "retailPrice": 8.43,
+ "osType": "Windows",
+ "vmTier": "Standard"
+ },
+ {
+ "retailPrice": 6.15,
+ "osType": "Linux",
+ "vmTier": "Standard"
+ },
+ {
+ "retailPrice": 1.23,
+ "osType": "Linux",
+ "vmTier": "LowPriority"
+ }
+ ]
+ },
+ "supportedComputeTypes": [
+ "AmlCompute",
+ "ComputeInstance"
+ ]
+ },
+ {
+ "name": "Standard_M32ts",
+ "family": "standardMSFamily",
+ "vCPUs": 32,
+ "gpus": 0,
+ "osVhdSizeMB": 1047552,
+ "maxResourceVolumeMB": 1024000,
+ "memoryGB": 192,
+ "lowPriorityCapable": true,
+ "premiumIO": true,
+ "estimatedVMPrices": {
+ "billingCurrency": "USD",
+ "unitOfMeasure": "OneHour",
+ "values": [
+ {
+ "retailPrice": 0.54,
+ "osType": "Linux",
+ "vmTier": "LowPriority"
+ },
+ {
+ "retailPrice": 2.71,
+ "osType": "Linux",
+ "vmTier": "Standard"
+ },
+ {
+ "retailPrice": 4.18,
+ "osType": "Windows",
+ "vmTier": "Standard"
+ },
+ {
+ "retailPrice": 1.13,
+ "osType": "Windows",
+ "vmTier": "LowPriority"
+ }
+ ]
+ },
+ "supportedComputeTypes": [
+ "AmlCompute",
+ "ComputeInstance"
+ ]
+ },
+ {
+ "name": "Standard_M64-16ms",
+ "family": "standardMSFamily",
+ "vCPUs": 64,
+ "gpus": 0,
+ "osVhdSizeMB": 1047552,
+ "maxResourceVolumeMB": 2048000,
+ "memoryGB": 1750,
+ "lowPriorityCapable": true,
+ "premiumIO": true,
+ "estimatedVMPrices": {
+ "billingCurrency": "USD",
+ "unitOfMeasure": "OneHour",
+ "values": [
+ {
+ "retailPrice": 10.34,
+ "osType": "Linux",
+ "vmTier": "Standard"
+ },
+ {
+ "retailPrice": 14.64,
+ "osType": "Windows",
+ "vmTier": "Standard"
+ },
+ {
+ "retailPrice": 2.07,
+ "osType": "Linux",
+ "vmTier": "LowPriority"
+ },
+ {
+ "retailPrice": 5.86,
+ "osType": "Windows",
+ "vmTier": "LowPriority"
+ }
+ ]
+ },
+ "supportedComputeTypes": [
+ "AmlCompute",
+ "ComputeInstance"
+ ]
+ },
+ {
+ "name": "Standard_M64-32ms",
+ "family": "standardMSFamily",
+ "vCPUs": 64,
+ "gpus": 0,
+ "osVhdSizeMB": 1047552,
+ "maxResourceVolumeMB": 2048000,
+ "memoryGB": 1750,
+ "lowPriorityCapable": true,
+ "premiumIO": true,
+ "estimatedVMPrices": {
+ "billingCurrency": "USD",
+ "unitOfMeasure": "OneHour",
+ "values": [
+ {
+ "retailPrice": 10.34,
+ "osType": "Linux",
+ "vmTier": "Standard"
+ },
+ {
+ "retailPrice": 14.64,
+ "osType": "Windows",
+ "vmTier": "Standard"
+ },
+ {
+ "retailPrice": 2.07,
+ "osType": "Linux",
+ "vmTier": "LowPriority"
+ },
+ {
+ "retailPrice": 5.86,
+ "osType": "Windows",
+ "vmTier": "LowPriority"
+ }
+ ]
+ },
+ "supportedComputeTypes": [
+ "AmlCompute",
+ "ComputeInstance"
+ ]
+ },
+ {
+ "name": "Standard_M64ls",
+ "family": "standardMSFamily",
+ "vCPUs": 64,
+ "gpus": 0,
+ "osVhdSizeMB": 1047552,
+ "maxResourceVolumeMB": 2048000,
+ "memoryGB": 512,
+ "lowPriorityCapable": true,
+ "premiumIO": true,
+ "estimatedVMPrices": {
+ "billingCurrency": "USD",
+ "unitOfMeasure": "OneHour",
+ "values": [
+ {
+ "retailPrice": 5.42,
+ "osType": "Linux",
+ "vmTier": "Standard"
+ },
+ {
+ "retailPrice": 8.36,
+ "osType": "Windows",
+ "vmTier": "Standard"
+ },
+ {
+ "retailPrice": 1.08,
+ "osType": "Linux",
+ "vmTier": "LowPriority"
+ },
+ {
+ "retailPrice": 2.26,
+ "osType": "Windows",
+ "vmTier": "LowPriority"
+ }
+ ]
+ },
+ "supportedComputeTypes": [
+ "AmlCompute",
+ "ComputeInstance"
+ ]
+ },
+ {
+ "name": "Standard_M64ms",
+ "family": "standardMSFamily",
+ "vCPUs": 64,
+ "gpus": 0,
+ "osVhdSizeMB": 1047552,
+ "maxResourceVolumeMB": 2048000,
+ "memoryGB": 1750,
+ "lowPriorityCapable": true,
+ "premiumIO": true,
+ "estimatedVMPrices": {
+ "billingCurrency": "USD",
+ "unitOfMeasure": "OneHour",
+ "values": [
+ {
+ "retailPrice": 10.34,
+ "osType": "Linux",
+ "vmTier": "Standard"
+ },
+ {
+ "retailPrice": 14.64,
+ "osType": "Windows",
+ "vmTier": "Standard"
+ },
+ {
+ "retailPrice": 2.07,
+ "osType": "Linux",
+ "vmTier": "LowPriority"
+ },
+ {
+ "retailPrice": 5.86,
+ "osType": "Windows",
+ "vmTier": "LowPriority"
+ }
+ ]
+ },
+ "supportedComputeTypes": [
+ "AmlCompute",
+ "ComputeInstance"
+ ]
+ },
+ {
+ "name": "Standard_M64s",
+ "family": "standardMSFamily",
+ "vCPUs": 64,
+ "gpus": 0,
+ "osVhdSizeMB": 1047552,
+ "maxResourceVolumeMB": 2048000,
+ "memoryGB": 1000,
+ "lowPriorityCapable": true,
+ "premiumIO": true,
+ "estimatedVMPrices": {
+ "billingCurrency": "USD",
+ "unitOfMeasure": "OneHour",
+ "values": [
+ {
+ "retailPrice": 9.61,
+ "osType": "Windows",
+ "vmTier": "Standard"
+ },
+ {
+ "retailPrice": 1.33,
+ "osType": "Linux",
+ "vmTier": "LowPriority"
+ },
+ {
+ "retailPrice": 3.84,
+ "osType": "Windows",
+ "vmTier": "LowPriority"
+ },
+ {
+ "retailPrice": 6.67,
+ "osType": "Linux",
+ "vmTier": "Standard"
+ }
+ ]
+ },
+ "supportedComputeTypes": [
+ "AmlCompute",
+ "ComputeInstance"
+ ]
+ },
+ {
+ "name": "Standard_M128-32ms",
+ "family": "standardMSFamily",
+ "vCPUs": 128,
+ "gpus": 0,
+ "osVhdSizeMB": 1047552,
+ "maxResourceVolumeMB": 4096000,
+ "memoryGB": 3800,
+ "lowPriorityCapable": true,
+ "premiumIO": true,
+ "estimatedVMPrices": {
+ "billingCurrency": "USD",
+ "unitOfMeasure": "OneHour",
+ "values": [
+ {
+ "retailPrice": 35.81,
+ "osType": "Windows",
+ "vmTier": "Standard"
+ },
+ {
+ "retailPrice": 14.33,
+ "osType": "Windows",
+ "vmTier": "LowPriority"
+ },
+ {
+ "retailPrice": 5.34,
+ "osType": "Linux",
+ "vmTier": "LowPriority"
+ },
+ {
+ "retailPrice": 26.69,
+ "osType": "Linux",
+ "vmTier": "Standard"
+ }
+ ]
+ },
+ "supportedComputeTypes": [
+ "AmlCompute",
+ "ComputeInstance"
+ ]
+ },
+ {
+ "name": "Standard_M128-64ms",
+ "family": "standardMSFamily",
+ "vCPUs": 128,
+ "gpus": 0,
+ "osVhdSizeMB": 1047552,
+ "maxResourceVolumeMB": 4096000,
+ "memoryGB": 3800,
+ "lowPriorityCapable": true,
+ "premiumIO": true,
+ "estimatedVMPrices": {
+ "billingCurrency": "USD",
+ "unitOfMeasure": "OneHour",
+ "values": [
+ {
+ "retailPrice": 35.81,
+ "osType": "Windows",
+ "vmTier": "Standard"
+ },
+ {
+ "retailPrice": 14.33,
+ "osType": "Windows",
+ "vmTier": "LowPriority"
+ },
+ {
+ "retailPrice": 5.34,
+ "osType": "Linux",
+ "vmTier": "LowPriority"
+ },
+ {
+ "retailPrice": 26.69,
+ "osType": "Linux",
+ "vmTier": "Standard"
+ }
+ ]
+ },
+ "supportedComputeTypes": [
+ "AmlCompute",
+ "ComputeInstance"
+ ]
+ },
+ {
+ "name": "Standard_M128ms",
+ "family": "standardMSFamily",
+ "vCPUs": 128,
+ "gpus": 0,
+ "osVhdSizeMB": 1047552,
+ "maxResourceVolumeMB": 4096000,
+ "memoryGB": 3800,
+ "lowPriorityCapable": true,
+ "premiumIO": true,
+ "estimatedVMPrices": {
+ "billingCurrency": "USD",
+ "unitOfMeasure": "OneHour",
+ "values": [
+ {
+ "retailPrice": 35.81,
+ "osType": "Windows",
+ "vmTier": "Standard"
+ },
+ {
+ "retailPrice": 14.33,
+ "osType": "Windows",
+ "vmTier": "LowPriority"
+ },
+ {
+ "retailPrice": 5.34,
+ "osType": "Linux",
+ "vmTier": "LowPriority"
+ },
+ {
+ "retailPrice": 26.69,
+ "osType": "Linux",
+ "vmTier": "Standard"
+ }
+ ]
+ },
+ "supportedComputeTypes": [
+ "AmlCompute",
+ "ComputeInstance"
+ ]
+ },
+ {
+ "name": "Standard_M128s",
+ "family": "standardMSFamily",
+ "vCPUs": 128,
+ "gpus": 0,
+ "osVhdSizeMB": 1047552,
+ "maxResourceVolumeMB": 4096000,
+ "memoryGB": 2000,
+ "lowPriorityCapable": true,
+ "premiumIO": true,
+ "estimatedVMPrices": {
+ "billingCurrency": "USD",
+ "unitOfMeasure": "OneHour",
+ "values": [
+ {
+ "retailPrice": 13.34,
+ "osType": "Linux",
+ "vmTier": "Standard"
+ },
+ {
+ "retailPrice": 7.69,
+ "osType": "Windows",
+ "vmTier": "LowPriority"
+ },
+ {
+ "retailPrice": 19.23,
+ "osType": "Windows",
+ "vmTier": "Standard"
+ },
+ {
+ "retailPrice": 2.67,
+ "osType": "Linux",
+ "vmTier": "LowPriority"
+ }
+ ]
+ },
+ "supportedComputeTypes": [
+ "AmlCompute",
+ "ComputeInstance"
+ ]
+ },
+ {
+ "name": "Standard_M64",
+ "family": "standardMSFamily",
+ "vCPUs": 64,
+ "gpus": 0,
+ "osVhdSizeMB": 1047552,
+ "maxResourceVolumeMB": 8192000,
+ "memoryGB": 1000,
+ "lowPriorityCapable": true,
+ "premiumIO": true,
+ "estimatedVMPrices": {
+ "billingCurrency": "USD",
+ "unitOfMeasure": "OneHour",
+ "values": [
+ {
+ "retailPrice": 9.61,
+ "osType": "Windows",
+ "vmTier": "Standard"
+ },
+ {
+ "retailPrice": 1.33,
+ "osType": "Linux",
+ "vmTier": "LowPriority"
+ },
+ {
+ "retailPrice": 3.84,
+ "osType": "Windows",
+ "vmTier": "LowPriority"
+ },
+ {
+ "retailPrice": 6.67,
+ "osType": "Linux",
+ "vmTier": "Standard"
+ }
+ ]
+ },
+ "supportedComputeTypes": [
+ "AmlCompute",
+ "ComputeInstance"
+ ]
+ },
+ {
+ "name": "Standard_M64m",
+ "family": "standardMSFamily",
+ "vCPUs": 64,
+ "gpus": 0,
+ "osVhdSizeMB": 1047552,
+ "maxResourceVolumeMB": 8192000,
+ "memoryGB": 1750,
+ "lowPriorityCapable": true,
+ "premiumIO": true,
+ "estimatedVMPrices": {
+ "billingCurrency": "USD",
+ "unitOfMeasure": "OneHour",
+ "values": [
+ {
+ "retailPrice": 10.34,
+ "osType": "Linux",
+ "vmTier": "Standard"
+ },
+ {
+ "retailPrice": 14.64,
+ "osType": "Windows",
+ "vmTier": "Standard"
+ },
+ {
+ "retailPrice": 2.07,
+ "osType": "Linux",
+ "vmTier": "LowPriority"
+ },
+ {
+ "retailPrice": 5.86,
+ "osType": "Windows",
+ "vmTier": "LowPriority"
+ }
+ ]
+ },
+ "supportedComputeTypes": [
+ "AmlCompute",
+ "ComputeInstance"
+ ]
+ },
+ {
+ "name": "Standard_M128",
+ "family": "standardMSFamily",
+ "vCPUs": 128,
+ "gpus": 0,
+ "osVhdSizeMB": 1047552,
+ "maxResourceVolumeMB": 16384000,
+ "memoryGB": 2000,
+ "lowPriorityCapable": true,
+ "premiumIO": true,
+ "estimatedVMPrices": {
+ "billingCurrency": "USD",
+ "unitOfMeasure": "OneHour",
+ "values": [
+ {
+ "retailPrice": 13.34,
+ "osType": "Linux",
+ "vmTier": "Standard"
+ },
+ {
+ "retailPrice": 7.69,
+ "osType": "Windows",
+ "vmTier": "LowPriority"
+ },
+ {
+ "retailPrice": 19.23,
+ "osType": "Windows",
+ "vmTier": "Standard"
+ },
+ {
+ "retailPrice": 2.67,
+ "osType": "Linux",
+ "vmTier": "LowPriority"
+ }
+ ]
+ },
+ "supportedComputeTypes": [
+ "AmlCompute",
+ "ComputeInstance"
+ ]
+ },
+ {
+ "name": "Standard_M128m",
+ "family": "standardMSFamily",
+ "vCPUs": 128,
+ "gpus": 0,
+ "osVhdSizeMB": 1047552,
+ "maxResourceVolumeMB": 16384000,
+ "memoryGB": 3800,
+ "lowPriorityCapable": true,
+ "premiumIO": true,
+ "estimatedVMPrices": {
+ "billingCurrency": "USD",
+ "unitOfMeasure": "OneHour",
+ "values": [
+ {
+ "retailPrice": 35.81,
+ "osType": "Windows",
+ "vmTier": "Standard"
+ },
+ {
+ "retailPrice": 14.33,
+ "osType": "Windows",
+ "vmTier": "LowPriority"
+ },
+ {
+ "retailPrice": 5.34,
+ "osType": "Linux",
+ "vmTier": "LowPriority"
+ },
+ {
+ "retailPrice": 26.69,
+ "osType": "Linux",
+ "vmTier": "Standard"
+ }
+ ]
+ },
+ "supportedComputeTypes": [
+ "AmlCompute",
+ "ComputeInstance"
+ ]
+ },
+ {
+ "name": "Standard_NV12s_v3",
+ "family": "standardNVSv3Family",
+ "vCPUs": 12,
+ "gpus": 1,
+ "osVhdSizeMB": 1047552,
+ "maxResourceVolumeMB": 344064,
+ "memoryGB": 112,
+ "lowPriorityCapable": true,
+ "premiumIO": true,
+ "estimatedVMPrices": {
+ "billingCurrency": "USD",
+ "unitOfMeasure": "OneHour",
+ "values": [
+ {
+ "retailPrice": 0.23,
+ "osType": "Linux",
+ "vmTier": "LowPriority"
+ },
+ {
+ "retailPrice": 0.68,
+ "osType": "Windows",
+ "vmTier": "LowPriority"
+ },
+ {
+ "retailPrice": 1.69,
+ "osType": "Windows",
+ "vmTier": "Standard"
+ },
+ {
+ "retailPrice": 1.14,
+ "osType": "Linux",
+ "vmTier": "Standard"
+ }
+ ]
+ },
+ "supportedComputeTypes": [
+ "AmlCompute",
+ "ComputeInstance"
+ ]
+ },
+ {
+ "name": "Standard_NV24s_v3",
+ "family": "standardNVSv3Family",
+ "vCPUs": 24,
+ "gpus": 2,
+ "osVhdSizeMB": 1047552,
+ "maxResourceVolumeMB": 688128,
+ "memoryGB": 224,
+ "lowPriorityCapable": true,
+ "premiumIO": true,
+ "estimatedVMPrices": {
+ "billingCurrency": "USD",
+ "unitOfMeasure": "OneHour",
+ "values": [
+ {
+ "retailPrice": 3.38,
+ "osType": "Windows",
+ "vmTier": "Standard"
+ },
+ {
+ "retailPrice": 1.35,
+ "osType": "Windows",
+ "vmTier": "LowPriority"
+ },
+ {
+ "retailPrice": 0.46,
+ "osType": "Linux",
+ "vmTier": "LowPriority"
+ },
+ {
+ "retailPrice": 2.28,
+ "osType": "Linux",
+ "vmTier": "Standard"
+ }
+ ]
+ },
+ "supportedComputeTypes": [
+ "AmlCompute",
+ "ComputeInstance"
+ ]
+ },
+ {
+ "name": "Standard_NV48s_v3",
+ "family": "standardNVSv3Family",
+ "vCPUs": 48,
+ "gpus": 4,
+ "osVhdSizeMB": 1047552,
+ "maxResourceVolumeMB": 1376256,
+ "memoryGB": 448,
+ "lowPriorityCapable": true,
+ "premiumIO": true,
+ "estimatedVMPrices": {
+ "billingCurrency": "USD",
+ "unitOfMeasure": "OneHour",
+ "values": [
+ {
+ "retailPrice": 2.71,
+ "osType": "Windows",
+ "vmTier": "LowPriority"
+ },
+ {
+ "retailPrice": 4.56,
+ "osType": "Linux",
+ "vmTier": "Standard"
+ },
+ {
+ "retailPrice": 6.77,
+ "osType": "Windows",
+ "vmTier": "Standard"
+ },
+ {
+ "retailPrice": 0.91,
+ "osType": "Linux",
+ "vmTier": "LowPriority"
+ }
+ ]
+ },
+ "supportedComputeTypes": [
+ "AmlCompute",
+ "ComputeInstance"
+ ]
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-08-01/examples/ListWorkspaceFeatures.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-08-01/examples/ListWorkspaceFeatures.json
new file mode 100644
index 000000000000..3bfa574c5d31
--- /dev/null
+++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-08-01/examples/ListWorkspaceFeatures.json
@@ -0,0 +1,26 @@
+{
+ "parameters": {
+ "api-version": "2020-08-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/2020-08-01/examples/ListWorkspaceQuotasByVMFamily.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-08-01/examples/ListWorkspaceQuotasByVMFamily.json
new file mode 100644
index 000000000000..65dfe2971854
--- /dev/null
+++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-08-01/examples/ListWorkspaceQuotasByVMFamily.json
@@ -0,0 +1,415 @@
+{
+ "parameters": {
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "location": "eastus",
+ "api-version": "2020-08-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/quotas/StandardDFamily",
+ "type": "Microsoft.MachineLearningServices/vmFamily/dedicatedCores/quotas",
+ "limit": 48,
+ "name": {
+ "localizedValue": "Standard D Family Cluster Dedicated vCPUs",
+ "value": "StandardDFamily"
+ },
+ "unit": "Count"
+ },
+ {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace1/quotas/StandardDFamily",
+ "type": "Microsoft.MachineLearningServices/workspaces/dedicatedCores/quotas",
+ "limit": 12,
+ "name": {
+ "value": "StandardDFamily",
+ "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/StandardDFamily",
+ "type": "Microsoft.MachineLearningServices/workspaces/dedicatedCores/quotas",
+ "limit": 12,
+ "name": {
+ "value": "StandardDFamily",
+ "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/StandardDFamily",
+ "type": "Microsoft.MachineLearningServices/workspaces/dedicatedCores/quotas",
+ "limit": 24,
+ "name": {
+ "value": "StandardDFamily",
+ "localizedValue": "Standard D Family Cluster Dedicated vCPUs"
+ },
+ "unit": "Count"
+ },
+ {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/quotas/StandardDSv2Family",
+ "type": "Microsoft.MachineLearningServices/vmFamily/dedicatedCores/quotas",
+ "limit": 24,
+ "name": {
+ "value": "StandardDSv2Family",
+ "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/StandardDSv2Family",
+ "type": "Microsoft.MachineLearningServices/workspaces/dedicatedCores/quotas",
+ "limit": 24,
+ "name": {
+ "value": "StandardDSv2Family",
+ "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/StandardDSv2Family",
+ "type": "Microsoft.MachineLearningServices/workspaces/dedicatedCores/quotas",
+ "limit": 12,
+ "name": {
+ "value": "StandardDSv2Family",
+ "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/StandardDSv2Family",
+ "type": "Microsoft.MachineLearningServices/workspaces/dedicatedCores/quotas",
+ "limit": 12,
+ "name": {
+ "value": "StandardDSv2Family",
+ "localizedValue": "Standard DSv2 Family Cluster Dedicated vCPUs"
+ },
+ "unit": "Count"
+ },
+ {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/quotas/StandardDv2Family",
+ "type": "Microsoft.MachineLearningServices/vmFamily/dedicatedCores/quotas",
+ "limit": 24,
+ "name": {
+ "localizedValue": "Standard Dv2 Family Cluster Dedicated vCPUs",
+ "value": "StandardDv2Family"
+ },
+ "unit": "Count"
+ },
+ {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace1/quotas/StandardDv2Family",
+ "type": "Microsoft.MachineLearningServices/workspaces/dedicatedCores/quotas",
+ "limit": 0,
+ "name": {
+ "value": "StandardDv2Family",
+ "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/StandardDv2Family",
+ "type": "Microsoft.MachineLearningServices/workspaces/dedicatedCores/quotas",
+ "limit": 24,
+ "name": {
+ "value": "StandardDv2Family",
+ "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/StandardDv2Family",
+ "type": "Microsoft.MachineLearningServices/workspaces/dedicatedCores/quotas",
+ "limit": 0,
+ "name": {
+ "value": "StandardDv2Family",
+ "localizedValue": "Standard Dv2 Family Cluster Dedicated vCPUs"
+ },
+ "unit": "Count"
+ },
+ {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/quotas/StandardFSv2Family",
+ "type": "Microsoft.MachineLearningServices/vmFamily/dedicatedCores/quotas",
+ "limit": 24,
+ "name": {
+ "value": "StandardFSv2Family",
+ "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/StandardFSv2Family",
+ "type": "Microsoft.MachineLearningServices/workspaces/dedicatedCores/quotas",
+ "limit": 0,
+ "name": {
+ "value": "StandardFSv2Family",
+ "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/StandardFSv2Family",
+ "type": "Microsoft.MachineLearningServices/workspaces/dedicatedCores/quotas",
+ "limit": 24,
+ "name": {
+ "value": "StandardFSv2Family",
+ "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/StandardFSv2Family",
+ "type": "Microsoft.MachineLearningServices/workspaces/dedicatedCores/quotas",
+ "limit": 12,
+ "name": {
+ "value": "StandardFSv2Family",
+ "localizedValue": "Standard FSv2 Family Cluster Dedicated vCPUs"
+ },
+ "unit": "Count"
+ },
+ {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/quotas/StandardNCFamily",
+ "type": "Microsoft.MachineLearningServices/vmFamily/dedicatedCores/quotas",
+ "limit": 24,
+ "name": {
+ "localizedValue": "Standard NC Family Cluster Dedicated vCPUs",
+ "value": "StandardNCFamily"
+ },
+ "unit": "Count"
+ },
+ {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace1/quotas/StandardNCFamily",
+ "type": "Microsoft.MachineLearningServices/workspaces/dedicatedCores/quotas",
+ "limit": 24,
+ "name": {
+ "value": "StandardNCFamily",
+ "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/StandardNCFamily",
+ "type": "Microsoft.MachineLearningServices/workspaces/dedicatedCores/quotas",
+ "limit": 24,
+ "name": {
+ "value": "StandardNCFamily",
+ "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/StandardNCFamily",
+ "type": "Microsoft.MachineLearningServices/workspaces/dedicatedCores/quotas",
+ "limit": 24,
+ "name": {
+ "value": "StandardNCFamily",
+ "localizedValue": "Standard NC Family Cluster Dedicated vCPUs"
+ },
+ "unit": "Count"
+ },
+ {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/quotas/StandardNCv2Family",
+ "type": "Microsoft.MachineLearningServices/vmFamily/dedicatedCores/quotas",
+ "limit": 0,
+ "name": {
+ "localizedValue": "Standard NCv2 Family Cluster Dedicated vCPUs",
+ "value": "StandardNCv2Family"
+ },
+ "unit": "Count"
+ },
+ {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace1/quotas/StandardNCv2Family",
+ "type": "Microsoft.MachineLearningServices/workspaces/dedicatedCores/quotas",
+ "limit": 0,
+ "name": {
+ "value": "StandardNCv2Family",
+ "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/StandardNCv2Family",
+ "type": "Microsoft.MachineLearningServices/workspaces/dedicatedCores/quotas",
+ "limit": 0,
+ "name": {
+ "value": "StandardNCv2Family",
+ "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/StandardNCv2Family",
+ "type": "Microsoft.MachineLearningServices/workspaces/dedicatedCores/quotas",
+ "limit": 0,
+ "name": {
+ "value": "StandardNCv2Family",
+ "localizedValue": "Standard NCv2 Family Cluster Dedicated vCPUs"
+ },
+ "unit": "Count"
+ },
+ {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/quotas/StandardNCv3Family",
+ "type": "Microsoft.MachineLearningServices/vmFamily/dedicatedCores/quotas",
+ "limit": 0,
+ "name": {
+ "localizedValue": "Standard NCv3 Family Cluster Dedicated vCPUs",
+ "value": "StandardNCv3Family"
+ },
+ "unit": "Count"
+ },
+ {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace1/quotas/StandardNCv3Family",
+ "type": "Microsoft.MachineLearningServices/workspaces/dedicatedCores/quotas",
+ "limit": 0,
+ "name": {
+ "value": "StandardNCv3Family",
+ "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/StandardNCv3Family",
+ "type": "Microsoft.MachineLearningServices/workspaces/dedicatedCores/quotas",
+ "limit": 0,
+ "name": {
+ "value": "StandardNCv3Family",
+ "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/StandardNCv3Family",
+ "type": "Microsoft.MachineLearningServices/workspaces/dedicatedCores/quotas",
+ "limit": 0,
+ "name": {
+ "value": "StandardNCv3Family",
+ "localizedValue": "Standard NCv3 Family Cluster Dedicated vCPUs"
+ },
+ "unit": "Count"
+ },
+ {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/quotas/StandardNDFamily",
+ "type": "Microsoft.MachineLearningServices/vmFamily/dedicatedCores/quotas",
+ "limit": 0,
+ "name": {
+ "localizedValue": "Standard ND Family Cluster Dedicated vCPUs",
+ "value": "StandardNDFamily"
+ },
+ "unit": "Count"
+ },
+ {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace1/quotas/StandardNDFamily",
+ "type": "Microsoft.MachineLearningServices/workspaces/dedicatedCores/quotas",
+ "limit": 0,
+ "name": {
+ "value": "StandardNDFamily",
+ "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/StandardNDFamily",
+ "type": "Microsoft.MachineLearningServices/workspaces/dedicatedCores/quotas",
+ "limit": 0,
+ "name": {
+ "value": "StandardNDFamily",
+ "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/StandardNDFamily",
+ "type": "Microsoft.MachineLearningServices/workspaces/dedicatedCores/quotas",
+ "limit": 0,
+ "name": {
+ "value": "StandardNDFamily",
+ "localizedValue": "Standard ND Family Cluster Dedicated vCPUs"
+ },
+ "unit": "Count"
+ },
+ {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/quotas/StandardNDv2Family",
+ "type": "Microsoft.MachineLearningServices/vmFamily/dedicatedCores/quotas",
+ "limit": 0,
+ "name": {
+ "value": "StandardNDv2Family",
+ "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/StandardNDv2Family",
+ "type": "Microsoft.MachineLearningServices/workspaces/dedicatedCores/quotas",
+ "limit": 0,
+ "name": {
+ "value": "StandardNDv2Family",
+ "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/StandardNDv2Family",
+ "type": "Microsoft.MachineLearningServices/workspaces/dedicatedCores/quotas",
+ "limit": 0,
+ "name": {
+ "value": "StandardNDv2Family",
+ "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/StandardNDv2Family",
+ "type": "Microsoft.MachineLearningServices/workspaces/dedicatedCores/quotas",
+ "limit": 0,
+ "name": {
+ "value": "StandardNDv2Family",
+ "localizedValue": "Standard NDv2 Family Cluster Dedicated vCPUs"
+ },
+ "unit": "Count"
+ },
+ {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/quotas/StandardNVFamily",
+ "type": "Microsoft.MachineLearningServices/vmFamily/dedicatedCores/quotas",
+ "limit": 24,
+ "name": {
+ "localizedValue": "Standard NV Family Cluster Dedicated vCPUs",
+ "value": "StandardNVFamily"
+ },
+ "unit": "Count"
+ },
+ {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace1/quotas/StandardNVFamily",
+ "type": "Microsoft.MachineLearningServices/workspaces/dedicatedCores/quotas",
+ "limit": 24,
+ "name": {
+ "value": "StandardNVFamily",
+ "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/StandardNVFamily",
+ "type": "Microsoft.MachineLearningServices/workspaces/dedicatedCores/quotas",
+ "limit": 24,
+ "name": {
+ "value": "StandardNVFamily",
+ "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/StandardNVFamily",
+ "type": "Microsoft.MachineLearningServices/workspaces/dedicatedCores/quotas",
+ "limit": 24,
+ "name": {
+ "value": "StandardNVFamily",
+ "localizedValue": "Standard NV Family Cluster Dedicated vCPUs"
+ },
+ "unit": "Count"
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-08-01/examples/amlComputeListNodes.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-08-01/examples/amlComputeListNodes.json
new file mode 100644
index 000000000000..f374bc7d54d1
--- /dev/null
+++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-08-01/examples/amlComputeListNodes.json
@@ -0,0 +1,34 @@
+{
+ "parameters": {
+ "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345",
+ "resourceGroupName": "testrg123",
+ "workspaceName": "workspaces123",
+ "computeName": "compute123",
+ "api-version": "2020-08-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "computeType": "AmlCompute",
+ "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/2020-08-01/examples/createBasicAKSCompute.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-08-01/examples/createBasicAKSCompute.json
new file mode 100644
index 000000000000..02d29ca9db8d
--- /dev/null
+++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-08-01/examples/createBasicAKSCompute.json
@@ -0,0 +1,44 @@
+{
+ "parameters": {
+ "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345",
+ "resourceGroupName": "testrg123",
+ "workspaceName": "workspaces123",
+ "computeName": "compute123",
+ "api-version": "2020-08-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/2020-08-01/examples/createBasicAmlCompute.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-08-01/examples/createBasicAmlCompute.json
new file mode 100644
index 000000000000..0991c02b03cc
--- /dev/null
+++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-08-01/examples/createBasicAmlCompute.json
@@ -0,0 +1,60 @@
+{
+ "parameters": {
+ "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345",
+ "resourceGroupName": "testrg123",
+ "workspaceName": "workspaces123",
+ "computeName": "compute123",
+ "api-version": "2020-08-01",
+ "parameters": {
+ "location": "eastus",
+ "properties": {
+ "computeType": "AmlCompute",
+ "properties": {
+ "vmSize": "STANDARD_NC6",
+ "vmPriority": "Dedicated",
+ "scaleSettings": {
+ "maxNodeCount": 1,
+ "minNodeCount": 0,
+ "nodeIdleTimeBeforeScaleDown": "PT5M"
+ },
+ "remoteLoginPortPublicAccess": "NotSpecified"
+ }
+ },
+ "identity": {
+ "type": "SystemAssigned,UserAssigned",
+ "userAssignedIdentities": {
+ "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity-name": {}
+ }
+ }
+ }
+ },
+ "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/2020-08-01/examples/createBasicDataFactoryCompute.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-08-01/examples/createBasicDataFactoryCompute.json
new file mode 100644
index 000000000000..9f5f2ad84111
--- /dev/null
+++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-08-01/examples/createBasicDataFactoryCompute.json
@@ -0,0 +1,44 @@
+{
+ "parameters": {
+ "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345",
+ "resourceGroupName": "testrg123",
+ "workspaceName": "workspaces123",
+ "computeName": "compute123",
+ "api-version": "2020-08-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/2020-08-01/examples/createComputeInstance.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-08-01/examples/createComputeInstance.json
new file mode 100644
index 000000000000..d9cfe507570c
--- /dev/null
+++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-08-01/examples/createComputeInstance.json
@@ -0,0 +1,52 @@
+{
+ "parameters": {
+ "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345",
+ "resourceGroupName": "testrg123",
+ "workspaceName": "workspaces123",
+ "computeName": "compute123",
+ "api-version": "2020-08-01",
+ "parameters": {
+ "location": "eastus",
+ "properties": {
+ "computeType": "ComputeInstance",
+ "properties": {
+ "vmSize": "STANDARD_NC6",
+ "subnet": "test-subnet-resource-id",
+ "applicationSharingPolicy": "Personal",
+ "sshSettings": {
+ "sshPublicAccess": "Disabled"
+ }
+ }
+ }
+ }
+ },
+ "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/2020-08-01/examples/createComputeInstanceMinimal.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-08-01/examples/createComputeInstanceMinimal.json
new file mode 100644
index 000000000000..233290e1fc86
--- /dev/null
+++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-08-01/examples/createComputeInstanceMinimal.json
@@ -0,0 +1,47 @@
+{
+ "parameters": {
+ "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345",
+ "resourceGroupName": "testrg123",
+ "workspaceName": "workspaces123",
+ "computeName": "compute123",
+ "api-version": "2020-08-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/2020-08-01/examples/createWorkspace.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-08-01/examples/createWorkspace.json
new file mode 100644
index 000000000000..d2d30a73a0c7
--- /dev/null
+++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-08-01/examples/createWorkspace.json
@@ -0,0 +1,148 @@
+{
+ "parameters": {
+ "subscriptionId": "00000000-1111-2222-3333-444444444444",
+ "resourceGroupName": "workspace-1234",
+ "workspaceName": "testworkspace",
+ "api-version": "2020-08-01",
+ "parameters": {
+ "location": "eastus2euap",
+ "sku": {
+ "name": "Basic",
+ "tier": "Basic"
+ },
+ "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",
+ "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",
+ "sku": {
+ "name": "Basic",
+ "tier": "Basic"
+ },
+ "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",
+ "creationTime": "2017-03-01T23:14:37.0707808Z",
+ "friendlyName": "HelloName",
+ "description": "test description",
+ "encryption": {
+ "status": "Enabled",
+ "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,
+ "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"
+ }
+ }
+ ],
+ "notebookInfo": {
+ "resourceId": "aabbccddee112233445566778899",
+ "fqdn": "testnotebook.notebooks.azure.com",
+ "notebookPreparationError": {
+ "statusCode": 500,
+ "errorMessage": "general error"
+ }
+ }
+ }
+ }
+ },
+ "201": {
+ "body": {
+ "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.MachineLearningServices/workspaces/testworkspace",
+ "name": "testworkspace",
+ "type": "Microsoft.MachineLearningServices/workspaces",
+ "location": "eastus2euap",
+ "sku": {
+ "name": "Basic",
+ "tier": "Basic"
+ },
+ "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",
+ "creationTime": "2017-03-01T23:14:37.0707808Z",
+ "friendlyName": "HelloName",
+ "description": "test description",
+ "encryption": {
+ "status": "Enabled",
+ "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,
+ "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"
+ }
+ }
+ ],
+ "notebookInfo": {
+ "resourceId": "aabbccddee112233445566778899",
+ "fqdn": "testnotebook.notebooks.azure.com",
+ "notebookPreparationError": {
+ "statusCode": 500,
+ "errorMessage": "general error"
+ }
+ }
+ }
+ }
+ },
+ "202": {}
+ }
+}
diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-08-01/examples/createWorkspaceConnection.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-08-01/examples/createWorkspaceConnection.json
new file mode 100644
index 000000000000..c8bf904f1972
--- /dev/null
+++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-08-01/examples/createWorkspaceConnection.json
@@ -0,0 +1,33 @@
+{
+ "parameters": {
+ "subscriptionId": "00000000-1111-2222-3333-444444444444",
+ "resourceGroupName": "resourceGroup-1",
+ "workspaceName": "workspace-1",
+ "connectionName": "connection-1",
+ "api-version": "2020-08-01",
+ "parameters": {
+ "name": "connection-1",
+ "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/2020-08-01/examples/deleteCompute.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-08-01/examples/deleteCompute.json
new file mode 100644
index 000000000000..5a481990bf03
--- /dev/null
+++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-08-01/examples/deleteCompute.json
@@ -0,0 +1,19 @@
+{
+ "parameters": {
+ "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345",
+ "resourceGroupName": "testrg123",
+ "workspaceName": "workspaces123",
+ "computeName": "compute123",
+ "api-version": "2020-08-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/2020-08-01/examples/deleteWorkspace.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-08-01/examples/deleteWorkspace.json
new file mode 100644
index 000000000000..505f38872657
--- /dev/null
+++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-08-01/examples/deleteWorkspace.json
@@ -0,0 +1,13 @@
+{
+ "parameters": {
+ "subscriptionId": "00000000-1111-2222-3333-444444444444",
+ "resourceGroupName": "workspace-1234",
+ "workspaceName": "testworkspace",
+ "api-version": "2020-08-01"
+ },
+ "responses": {
+ "200": {},
+ "202": {},
+ "204": {}
+ }
+}
diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-08-01/examples/deleteWorkspaceConnection.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-08-01/examples/deleteWorkspaceConnection.json
new file mode 100644
index 000000000000..05f9fbc2129e
--- /dev/null
+++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-08-01/examples/deleteWorkspaceConnection.json
@@ -0,0 +1,13 @@
+{
+ "parameters": {
+ "subscriptionId": "00000000-1111-2222-3333-444444444444",
+ "resourceGroupName": "resourceGroup-1",
+ "workspaceName": "workspace-1",
+ "connectionName": "connection-1",
+ "api-version": "2020-08-01"
+ },
+ "responses": {
+ "200": {},
+ "204": {}
+ }
+}
diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-08-01/examples/getAKSCompute.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-08-01/examples/getAKSCompute.json
new file mode 100644
index 000000000000..8a71fe8b46ed
--- /dev/null
+++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-08-01/examples/getAKSCompute.json
@@ -0,0 +1,25 @@
+{
+ "parameters": {
+ "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345",
+ "resourceGroupName": "testrg123",
+ "workspaceName": "workspaces123",
+ "computeName": "compute123",
+ "api-version": "2020-08-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": {
+ "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/2020-08-01/examples/getAmlCompute.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-08-01/examples/getAmlCompute.json
new file mode 100644
index 000000000000..f13d21320db8
--- /dev/null
+++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-08-01/examples/getAmlCompute.json
@@ -0,0 +1,60 @@
+{
+ "parameters": {
+ "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345",
+ "resourceGroupName": "testrg123",
+ "workspaceName": "workspaces123",
+ "computeName": "compute123",
+ "api-version": "2020-08-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",
+ "computeType": "AmlCompute",
+ "createdOn": "2017-09-26T22:28:08.327Z",
+ "provisioningState": "Succeeded",
+ "properties": {
+ "vmSize": "STANDARD_NC6",
+ "vmPriority": "Dedicated",
+ "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
+ }
+ }
+ },
+ "identity": {
+ "principalId": "00000000-0000-0000-0000-000000000000",
+ "tenantId": "00000000-0000-0000-0000-000000000000",
+ "type": "SystemAssigned,UserAssigned",
+ "userAssignedIdentities": {
+ "/subscriptions/f9d7ebed-adbd-4cb4-b973-aaf82c136138/resourcegroups/myResourceGroup1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity2": {
+ "clientId": "00000000-0000-0000-0000-000000000000",
+ "principalId": "00000000-0000-0000-0000-000000000000"
+ }
+ }
+ }
+ }
+ }
+ }
+}
diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-08-01/examples/getComputeInstance.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-08-01/examples/getComputeInstance.json
new file mode 100644
index 000000000000..fbefecae9dbe
--- /dev/null
+++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-08-01/examples/getComputeInstance.json
@@ -0,0 +1,57 @@
+{
+ "parameters": {
+ "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345",
+ "resourceGroupName": "testrg123",
+ "workspaceName": "workspaces123",
+ "computeName": "compute123",
+ "api-version": "2020-08-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",
+ "computeType": "ComputeInstance",
+ "createdOn": "2017-09-26T22:28:08.327Z",
+ "provisioningState": "Succeeded",
+ "properties": {
+ "vmSize": "STANDARD_NC6",
+ "subnet": "test-subnet-resource-id",
+ "applicationSharingPolicy": "Shared",
+ "sshSettings": {
+ "sshPublicAccess": "Enabled",
+ "adminUserName": "azureuser",
+ "sshPort": 22
+ },
+ "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",
+ "lastOperation": {
+ "operationName": "Start",
+ "operationTime": "2020-06-30T19:35:52.548+00:00",
+ "operationStatus": "Succeeded"
+ }
+ }
+ }
+ }
+ }
+ }
+}
diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-08-01/examples/getComputes.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-08-01/examples/getComputes.json
new file mode 100644
index 000000000000..e9276c17109a
--- /dev/null
+++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-08-01/examples/getComputes.json
@@ -0,0 +1,41 @@
+{
+ "parameters": {
+ "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345",
+ "resourceGroupName": "testrg123",
+ "workspaceName": "workspaces123",
+ "api-version": "2020-08-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",
+ "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",
+ "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/2020-08-01/examples/getWorkspace.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-08-01/examples/getWorkspace.json
new file mode 100644
index 000000000000..9c7e73d54ecd
--- /dev/null
+++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-08-01/examples/getWorkspace.json
@@ -0,0 +1,82 @@
+{
+ "parameters": {
+ "subscriptionId": "00000000-1111-2222-3333-444444444444",
+ "resourceGroupName": "workspace-1234",
+ "workspaceName": "testworkspace",
+ "api-version": "2020-08-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",
+ "sku": {
+ "name": "Enterprise",
+ "tier": "Enterprise"
+ },
+ "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",
+ "creationTime": "2017-03-01T23:14:37.0707808Z",
+ "friendlyName": "HelloName",
+ "description": "test description",
+ "encryption": {
+ "status": "Enabled",
+ "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,
+ "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"
+ }
+ }
+ ],
+ "notebookInfo": {
+ "resourceId": "aabbccddee112233445566778899",
+ "fqdn": "testnotebook.notebooks.azure.com",
+ "notebookPreparationError": {
+ "statusCode": 500,
+ "errorMessage": "general error"
+ }
+ }
+ }
+ }
+ }
+ }
+}
diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-08-01/examples/getWorkspaceConnection.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-08-01/examples/getWorkspaceConnection.json
new file mode 100644
index 000000000000..48e5b84194c1
--- /dev/null
+++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-08-01/examples/getWorkspaceConnection.json
@@ -0,0 +1,24 @@
+{
+ "parameters": {
+ "subscriptionId": "00000000-1111-2222-3333-444444444444",
+ "resourceGroupName": "resourceGroup-1",
+ "workspaceName": "workspace-1",
+ "connectionName": "connection-1",
+ "api-version": "2020-08-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/2020-08-01/examples/getWorkspacesByResourceGroup.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-08-01/examples/getWorkspacesByResourceGroup.json
new file mode 100644
index 000000000000..af19522dabf7
--- /dev/null
+++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-08-01/examples/getWorkspacesByResourceGroup.json
@@ -0,0 +1,56 @@
+{
+ "parameters": {
+ "subscriptionId": "00000000-1111-2222-3333-444444444444",
+ "resourceGroupName": "workspace-1234",
+ "api-version": "2020-08-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",
+ "sku": {
+ "name": "Basic",
+ "tier": "Basic"
+ },
+ "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",
+ "creationTime": "2017-03-01T23:14:37.0707808Z",
+ "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",
+ "sku": {
+ "name": "Basic",
+ "tier": "Basic"
+ },
+ "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",
+ "creationTime": "2017-03-01T23:14:37.0707808Z",
+ "friendlyName": "HelloName 1",
+ "description": "test description"
+ }
+ }
+ ],
+ "nextLink": "nextLink"
+ }
+ }
+ }
+}
diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-08-01/examples/getWorkspacesBySubscription.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-08-01/examples/getWorkspacesBySubscription.json
new file mode 100644
index 000000000000..5e55843647c0
--- /dev/null
+++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-08-01/examples/getWorkspacesBySubscription.json
@@ -0,0 +1,55 @@
+{
+ "parameters": {
+ "subscriptionId": "00000000-1111-2222-3333-444444444444",
+ "api-version": "2020-08-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",
+ "sku": {
+ "name": "Enterprise",
+ "tier": "Enterprise"
+ },
+ "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",
+ "creationTime": "2017-03-01T23:14:37.0707808Z",
+ "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",
+ "sku": {
+ "name": "Enterprise",
+ "tier": "Enterprise"
+ },
+ "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",
+ "creationTime": "2017-03-01T23:14:37.0707808Z",
+ "friendlyName": "HelloName",
+ "description": "test description"
+ }
+ }
+ ],
+ "nextLink": "nextLink"
+ }
+ }
+ }
+}
diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-08-01/examples/listKeysAKSCompute.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-08-01/examples/listKeysAKSCompute.json
new file mode 100644
index 000000000000..42b2d8c921fd
--- /dev/null
+++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-08-01/examples/listKeysAKSCompute.json
@@ -0,0 +1,19 @@
+{
+ "parameters": {
+ "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345",
+ "resourceGroupName": "testrg123",
+ "workspaceName": "workspaces123",
+ "computeName": "compute123",
+ "api-version": "2020-08-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/2020-08-01/examples/listWorkspaceConnections.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-08-01/examples/listWorkspaceConnections.json
new file mode 100644
index 000000000000..1a060568ec01
--- /dev/null
+++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-08-01/examples/listWorkspaceConnections.json
@@ -0,0 +1,40 @@
+{
+ "parameters": {
+ "subscriptionId": "00000000-1111-2222-3333-444444444444",
+ "resourceGroupName": "resourceGroup-1",
+ "workspaceName": "workspace-1",
+ "api-version": "2020-08-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/2020-08-01/examples/listWorkspaceKeys.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-08-01/examples/listWorkspaceKeys.json
new file mode 100644
index 000000000000..df2129dfc2d4
--- /dev/null
+++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-08-01/examples/listWorkspaceKeys.json
@@ -0,0 +1,35 @@
+{
+ "parameters": {
+ "subscriptionId": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
+ "resourceGroupName": "testrg123",
+ "workspaceName": "workspaces123",
+ "api-version": "2020-08-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "userStorageKey": "r5rKCJ018TLk+bdAi/9YaVzgcQ0nkLsUqGyUN03KsdCFtqG0SjFGPV8+vT1frWqkvBL0bGoPpLc1BlZSSaZmOA==",
+ "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": "vBvVhYgAGtUSewVCUv3w95p4/q5Yrsnw"
+ },
+ {
+ "name": "password2",
+ "value": "0KARRQoQHSUq1yViPWg7YFernOS=Ic/t"
+ }
+ ]
+ },
+ "notebookAccessKeys": {
+ "primaryAccessKey": "vBvVhYgAGtUSewVCUv3w95p4/q5Yrsnw",
+ "secondaryAccessKey": "0KARRQoQHSUq1yViPWg7YFernOS"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-08-01/examples/patchAmlCompute.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-08-01/examples/patchAmlCompute.json
new file mode 100644
index 000000000000..08bed85226c5
--- /dev/null
+++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-08-01/examples/patchAmlCompute.json
@@ -0,0 +1,36 @@
+{
+ "parameters": {
+ "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345",
+ "resourceGroupName": "testrg123",
+ "workspaceName": "workspaces123",
+ "computeName": "compute123",
+ "api-version": "2020-08-01",
+ "parameters": {
+ "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/2020-08-01/examples/restartComputeInstance.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-08-01/examples/restartComputeInstance.json
new file mode 100644
index 000000000000..ab010e7ea19a
--- /dev/null
+++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-08-01/examples/restartComputeInstance.json
@@ -0,0 +1,12 @@
+{
+ "parameters": {
+ "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345",
+ "resourceGroupName": "testrg123",
+ "workspaceName": "workspaces123",
+ "computeName": "compute123",
+ "api-version": "2020-08-01"
+ },
+ "responses": {
+ "200": {}
+ }
+}
diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-08-01/examples/resyncWorkspaceKeys.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-08-01/examples/resyncWorkspaceKeys.json
new file mode 100644
index 000000000000..779ba3892481
--- /dev/null
+++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-08-01/examples/resyncWorkspaceKeys.json
@@ -0,0 +1,11 @@
+{
+ "parameters": {
+ "subscriptionId": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
+ "resourceGroupName": "testrg123",
+ "workspaceName": "workspaces123",
+ "api-version": "2020-08-01"
+ },
+ "responses": {
+ "200": {}
+ }
+}
diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-08-01/examples/startComputeInstance.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-08-01/examples/startComputeInstance.json
new file mode 100644
index 000000000000..ab010e7ea19a
--- /dev/null
+++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-08-01/examples/startComputeInstance.json
@@ -0,0 +1,12 @@
+{
+ "parameters": {
+ "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345",
+ "resourceGroupName": "testrg123",
+ "workspaceName": "workspaces123",
+ "computeName": "compute123",
+ "api-version": "2020-08-01"
+ },
+ "responses": {
+ "200": {}
+ }
+}
diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-08-01/examples/stopComputeInstance.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-08-01/examples/stopComputeInstance.json
new file mode 100644
index 000000000000..ab010e7ea19a
--- /dev/null
+++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-08-01/examples/stopComputeInstance.json
@@ -0,0 +1,12 @@
+{
+ "parameters": {
+ "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345",
+ "resourceGroupName": "testrg123",
+ "workspaceName": "workspaces123",
+ "computeName": "compute123",
+ "api-version": "2020-08-01"
+ },
+ "responses": {
+ "200": {}
+ }
+}
diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-08-01/examples/updateAKSCompute.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-08-01/examples/updateAKSCompute.json
new file mode 100644
index 000000000000..37f50e1e99df
--- /dev/null
+++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-08-01/examples/updateAKSCompute.json
@@ -0,0 +1,53 @@
+{
+ "parameters": {
+ "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345",
+ "resourceGroupName": "testrg123",
+ "workspaceName": "workspaces123",
+ "computeName": "compute123",
+ "api-version": "2020-08-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": "Updating"
+ }
+ }
+ },
+ "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/2020-08-01/examples/updateAmlCompute.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-08-01/examples/updateAmlCompute.json
new file mode 100644
index 000000000000..602a15002225
--- /dev/null
+++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-08-01/examples/updateAmlCompute.json
@@ -0,0 +1,59 @@
+{
+ "parameters": {
+ "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345",
+ "resourceGroupName": "testrg123",
+ "workspaceName": "workspaces123",
+ "computeName": "compute123",
+ "api-version": "2020-08-01",
+ "parameters": {
+ "location": "eastus",
+ "properties": {
+ "computeType": "AmlCompute",
+ "properties": {
+ "scaleSettings": {
+ "maxNodeCount": 1,
+ "minNodeCount": 0,
+ "nodeIdleTimeBeforeScaleDown": "PT5M"
+ }
+ }
+ },
+ "identity": {
+ "type": "SystemAssigned,UserAssigned",
+ "userAssignedIdentities": {
+ "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity-name": {}
+ }
+ }
+ }
+ },
+ "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"
+ }
+ }
+ },
+ "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/2020-08-01/examples/updateQuota.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-08-01/examples/updateQuota.json
new file mode 100644
index 000000000000..9ea10592ce67
--- /dev/null
+++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-08-01/examples/updateQuota.json
@@ -0,0 +1,45 @@
+{
+ "parameters": {
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "location": "eastus",
+ "api-version": "2020-08-01",
+ "parameters": {
+ "value": [
+ {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace1/quotas/StandardDSv2Family",
+ "type": "Microsoft.MachineLearningServices/workspaces/dedicatedCores/quotas",
+ "limit": 100,
+ "unit": "Count"
+ },
+ {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace2/quotas/StandardDSv2Family",
+ "type": "Microsoft.MachineLearningServices/workspaces/dedicatedCores/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/StandardDSv2Family",
+ "type": "Microsoft.MachineLearningServices/workspaces/dedicatedCores/quotas",
+ "limit": 100,
+ "unit": "Count",
+ "status": "Success"
+ },
+ {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace2/quotas/StandardDSv2Family",
+ "type": "Microsoft.MachineLearningServices/workspaces/dedicatedCores/quotas",
+ "limit": 200,
+ "unit": "Count",
+ "status": "Success"
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-08-01/examples/updateWorkspace.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-08-01/examples/updateWorkspace.json
new file mode 100644
index 000000000000..092a4e0a43ad
--- /dev/null
+++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-08-01/examples/updateWorkspace.json
@@ -0,0 +1,42 @@
+{
+ "parameters": {
+ "subscriptionId": "00000000-1111-2222-3333-444444444444",
+ "resourceGroupName": "workspace-1234",
+ "workspaceName": "testworkspace",
+ "api-version": "2020-08-01",
+ "parameters": {
+ "sku": {
+ "name": "Enterprise",
+ "tier": "Enterprise"
+ },
+ "properties": {
+ "friendlyName": "New friendly name",
+ "description": "new description"
+ }
+ }
+ },
+ "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",
+ "sku": {
+ "name": "Enterprise",
+ "tier": "Enterprise"
+ },
+ "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",
+ "creationTime": "2017-03-01T23:14:37.0707808Z",
+ "friendlyName": "New friendly name",
+ "description": "new description"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-08-01/examples/workspaceDeletePrivateEndpointConnection.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-08-01/examples/workspaceDeletePrivateEndpointConnection.json
new file mode 100644
index 000000000000..fe4f5097e5cc
--- /dev/null
+++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-08-01/examples/workspaceDeletePrivateEndpointConnection.json
@@ -0,0 +1,15 @@
+{
+ "parameters": {
+ "subscriptionId": "00000000-1111-2222-3333-444444444444",
+ "resourceGroupName": "rg-1234",
+ "workspaceName": "testworkspace",
+ "privateEndpointConnectionName": "{privateEndpointConnectionName}",
+ "api-version": "2020-08-01",
+ "monitor": "true"
+ },
+ "responses": {
+ "200": {},
+ "202": {},
+ "204": {}
+ }
+}
diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-08-01/examples/workspaceGetPrivateEndpointConnection.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-08-01/examples/workspaceGetPrivateEndpointConnection.json
new file mode 100644
index 000000000000..043658626c5c
--- /dev/null
+++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-08-01/examples/workspaceGetPrivateEndpointConnection.json
@@ -0,0 +1,30 @@
+{
+ "parameters": {
+ "subscriptionId": "00000000-1111-2222-3333-444444444444",
+ "resourceGroupName": "rg-1234",
+ "workspaceName": "testworkspace",
+ "privateEndpointConnectionName": "{privateEndpointConnectionName}",
+ "api-version": "2020-08-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/2020-08-01/examples/workspaceListPrivateLinkResources.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-08-01/examples/workspaceListPrivateLinkResources.json
new file mode 100644
index 000000000000..9ddb75df7ac7
--- /dev/null
+++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-08-01/examples/workspaceListPrivateLinkResources.json
@@ -0,0 +1,28 @@
+{
+ "parameters": {
+ "subscriptionId": "00000000-1111-2222-3333-444444444444",
+ "resourceGroupName": "rg-1234",
+ "workspaceName": "testworkspace",
+ "api-version": "2020-08-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.Storage/workspaces/privateLinkResources",
+ "properties": {
+ "groupId": "amlworkspace",
+ "requiredMembers": [
+ "default"
+ ]
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-08-01/examples/workspacePrepareNotebook.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-08-01/examples/workspacePrepareNotebook.json
new file mode 100644
index 000000000000..e84272ff58ee
--- /dev/null
+++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-08-01/examples/workspacePrepareNotebook.json
@@ -0,0 +1,21 @@
+{
+ "parameters": {
+ "subscriptionId": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
+ "resourceGroupName": "testrg123",
+ "workspaceName": "workspaces123",
+ "api-version": "2020-08-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/2020-08-01/examples/workspacePutPrivateEndpointConnection.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-08-01/examples/workspacePutPrivateEndpointConnection.json
new file mode 100644
index 000000000000..7f8c6715d47c
--- /dev/null
+++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-08-01/examples/workspacePutPrivateEndpointConnection.json
@@ -0,0 +1,38 @@
+{
+ "parameters": {
+ "subscriptionId": "00000000-1111-2222-3333-444444444444",
+ "resourceGroupName": "rg-1234",
+ "workspaceName": "testworkspace",
+ "privateEndpointConnectionName": "{privateEndpointConnectionName}",
+ "api-version": "2020-08-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/2020-08-01/machineLearningServices.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-08-01/machineLearningServices.json
new file mode 100644
index 000000000000..8e05c90bac12
--- /dev/null
+++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-08-01/machineLearningServices.json
@@ -0,0 +1,4265 @@
+{
+ "swagger": "2.0",
+ "info": {
+ "title": "Azure Machine Learning Workspaces",
+ "description": "These APIs allow end users to operate on Azure Machine Learning Workspace resources.",
+ "version": "2020-08-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": "#/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": "#/definitions/MachineLearningServiceError"
+ }
+ }
+ },
+ "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/getWorkspace.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/APIVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/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": "#/definitions/MachineLearningServiceError"
+ }
+ }
+ }
+ },
+ "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/createWorkspace.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/APIVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/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"
+ }
+ },
+ "201": {
+ "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": "#/definitions/MachineLearningServiceError"
+ }
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "Workspaces"
+ ],
+ "description": "Deletes a machine learning workspace.",
+ "operationId": "Workspaces_Delete",
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "Delete Workspace": {
+ "$ref": "./examples/deleteWorkspace.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/APIVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/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 successful; 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": "#/definitions/MachineLearningServiceError"
+ }
+ }
+ }
+ },
+ "patch": {
+ "tags": [
+ "Workspaces"
+ ],
+ "description": "Updates a machine learning workspace with the specified parameters.",
+ "operationId": "Workspaces_Update",
+ "x-ms-examples": {
+ "Update Workspace": {
+ "$ref": "./examples/updateWorkspace.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/APIVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/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": "#/definitions/MachineLearningServiceError"
+ }
+ }
+ }
+ }
+ },
+ "/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/ListWorkspaceFeatures.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/APIVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/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": "#/definitions/MachineLearningServiceError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/prepareNotebook": {
+ "post": {
+ "tags": [
+ "ProxyOperations"
+ ],
+ "operationId": "Notebooks_Prepare",
+ "x-ms-long-running-operation": true,
+ "x-ms-long-running-operation-options": {
+ "final-state-via": "location"
+ },
+ "x-ms-examples": {
+ "Prepare Notebook": {
+ "$ref": "./examples/workspacePrepareNotebook.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/APIVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/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": "#/definitions/MachineLearningServiceError"
+ }
+ }
+ }
+ }
+ },
+ "/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/getWorkspacesByResourceGroup.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/APIVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/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": "#/definitions/MachineLearningServiceError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/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/listWorkspaceKeys.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/APIVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/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": "#/definitions/MachineLearningServiceError"
+ }
+ }
+ }
+ }
+ },
+ "/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-examples": {
+ "Resync Workspace Keys": {
+ "$ref": "./examples/resyncWorkspaceKeys.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/APIVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/WorkspaceNameParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The request was successful; the request was well-formed and received properly."
+ },
+ "default": {
+ "description": "Error response describing why the operation failed",
+ "schema": {
+ "$ref": "#/definitions/MachineLearningServiceError"
+ }
+ }
+ }
+ }
+ },
+ "/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": "#/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": {
+ "List Usages": {
+ "$ref": "./examples/ListUsages.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": "#/parameters/APIVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/ComputeTypeParameter"
+ },
+ {
+ "$ref": "#/parameters/RecommendedParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/VirtualMachineSizeListResult"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "List VM Sizes": {
+ "$ref": "./examples/ListVMSizesResult.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": "#/parameters/APIVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The operation was successful.",
+ "schema": {
+ "$ref": "#/definitions/UpdateWorkspaceQuotasResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/MachineLearningServiceError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "update quotas": {
+ "$ref": "./examples/updateQuota.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": "#/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/ListWorkspaceQuotas"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-examples": {
+ "List workspace quotas by VMFamily": {
+ "$ref": "./examples/ListWorkspaceQuotasByVMFamily.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/getWorkspacesBySubscription.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/APIVersionParameter"
+ },
+ {
+ "$ref": "#/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": "#/definitions/MachineLearningServiceError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/connections": {
+ "get": {
+ "tags": [
+ "WorkspaceConnections"
+ ],
+ "x-ms-pageable": {
+ "nextLinkName": null
+ },
+ "x-ms-examples": {
+ "ListWorkspaceConnections": {
+ "$ref": "./examples/listWorkspaceConnections.json"
+ }
+ },
+ "operationId": "WorkspaceConnections_List",
+ "description": "List all connections under a AML workspace.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/WorkspaceNameParameter"
+ },
+ {
+ "$ref": "#/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": "#/definitions/MachineLearningServiceError"
+ }
+ }
+ }
+ }
+ },
+ "/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/createWorkspaceConnection.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/WorkspaceNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ConnectionName"
+ },
+ {
+ "$ref": "#/parameters/APIVersionParameter"
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "description": "The object for creating or updating a new workspace connection",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/WorkspaceConnectionDto"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successfully created the workspace connection.",
+ "schema": {
+ "$ref": "#/definitions/WorkspaceConnection"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed",
+ "schema": {
+ "$ref": "#/definitions/MachineLearningServiceError"
+ }
+ }
+ }
+ },
+ "get": {
+ "tags": [
+ "WorkspaceConnections"
+ ],
+ "operationId": "WorkspaceConnections_Get",
+ "description": "Get the detail of a workspace connection.",
+ "x-ms-examples": {
+ "GetWorkspaceConnection": {
+ "$ref": "./examples/getWorkspaceConnection.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/WorkspaceNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ConnectionName"
+ },
+ {
+ "$ref": "#/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": "#/definitions/MachineLearningServiceError"
+ }
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "WorkspaceConnections"
+ ],
+ "operationId": "WorkspaceConnections_Delete",
+ "description": "Delete a workspace connection.",
+ "x-ms-examples": {
+ "DeleteWorkspaceConnection": {
+ "$ref": "./examples/deleteWorkspaceConnection.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/WorkspaceNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ConnectionName"
+ },
+ {
+ "$ref": "#/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": "#/definitions/MachineLearningServiceError"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/computes": {
+ "get": {
+ "tags": [
+ "OperationalizationClusters",
+ "MachineLearningComputes"
+ ],
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "operationId": "MachineLearningCompute_ListByWorkspace",
+ "description": "Gets computes in specified workspace.",
+ "x-ms-examples": {
+ "Get Computes": {
+ "$ref": "./examples/getComputes.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/WorkspaceNameParameter"
+ },
+ {
+ "$ref": "#/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": "#/definitions/MachineLearningServiceError"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/computes/{computeName}": {
+ "get": {
+ "tags": [
+ "OperationalizationClusters",
+ "MachineLearningComputes"
+ ],
+ "operationId": "MachineLearningCompute_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/getAKSCompute.json"
+ },
+ "Get a AML Compute": {
+ "$ref": "./examples/getAmlCompute.json"
+ },
+ "Get a ComputeInstance": {
+ "$ref": "./examples/getComputeInstance.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/WorkspaceNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ComputeNameParameter"
+ },
+ {
+ "$ref": "#/parameters/APIVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success.",
+ "schema": {
+ "$ref": "#/definitions/ComputeResource"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the request failed.",
+ "schema": {
+ "$ref": "#/definitions/MachineLearningServiceError"
+ }
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "OperationalizationClusters",
+ "MachineLearningComputes"
+ ],
+ "operationId": "MachineLearningCompute_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/createBasicAmlCompute.json"
+ },
+ "Create a ComputeInstance Compute with minimal inputs": {
+ "$ref": "./examples/createComputeInstanceMinimal.json"
+ },
+ "Create a ComputeInstance Compute": {
+ "$ref": "./examples/createComputeInstance.json"
+ },
+ "Create AKS Compute": {
+ "$ref": "./examples/createBasicAKSCompute.json"
+ },
+ "Create a DataFactory Compute": {
+ "$ref": "./examples/createBasicDataFactoryCompute.json"
+ },
+ "Update a AML Compute": {
+ "$ref": "./examples/updateAmlCompute.json"
+ },
+ "Update a AKS Compute": {
+ "$ref": "./examples/updateAKSCompute.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/WorkspaceNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ComputeNameParameter"
+ },
+ {
+ "$ref": "#/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": "#/definitions/MachineLearningServiceError"
+ }
+ }
+ }
+ },
+ "patch": {
+ "tags": [
+ "OperationalizationClusters",
+ "MachineLearningComputes"
+ ],
+ "operationId": "MachineLearningCompute_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/patchAmlCompute.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/WorkspaceNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ComputeNameParameter"
+ },
+ {
+ "$ref": "#/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": "#/definitions/MachineLearningServiceError"
+ }
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "OperationalizationClusters",
+ "MachineLearningComputes"
+ ],
+ "operationId": "MachineLearningCompute_Delete",
+ "description": "Deletes specified Machine Learning compute.",
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "Delete Compute": {
+ "$ref": "./examples/deleteCompute.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/WorkspaceNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ComputeNameParameter"
+ },
+ {
+ "$ref": "#/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": "#/definitions/MachineLearningServiceError"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/computes/{computeName}/listNodes": {
+ "post": {
+ "tags": [
+ "MachineLearningComputes"
+ ],
+ "operationId": "MachineLearningCompute_ListNodes",
+ "description": "Get the details (e.g IP address, port etc) of all the compute nodes in the compute.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/WorkspaceNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ComputeNameParameter"
+ },
+ {
+ "$ref": "#/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": "#/definitions/MachineLearningServiceError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Get compute nodes information for a compute": {
+ "$ref": "./examples/amlComputeListNodes.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/computes/{computeName}/listKeys": {
+ "post": {
+ "tags": [
+ "OperationalizationClusters",
+ "MachineLearningComputes"
+ ],
+ "operationId": "MachineLearningCompute_ListKeys",
+ "description": "Gets secrets related to Machine Learning compute (storage keys, service credentials, etc).",
+ "x-ms-examples": {
+ "List AKS Compute Keys": {
+ "$ref": "./examples/listKeysAKSCompute.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/WorkspaceNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ComputeNameParameter"
+ },
+ {
+ "$ref": "#/parameters/APIVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success.",
+ "schema": {
+ "$ref": "#/definitions/ComputeSecrets"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/MachineLearningServiceError"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/providers/Microsoft.MachineLearningServices/workspaces/skus": {
+ "get": {
+ "tags": [
+ "WorkspaceSkus"
+ ],
+ "description": "Lists all skus with associated features",
+ "operationId": "ListSkus",
+ "x-ms-examples": {
+ "List Skus": {
+ "$ref": "./examples/ListSkus.json"
+ }
+ },
+ "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/SkuListResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/MachineLearningServiceError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/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/workspaceGetPrivateEndpointConnection.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/WorkspaceNameParameter"
+ },
+ {
+ "$ref": "#/parameters/PrivateEndpointConnectionName"
+ },
+ {
+ "$ref": "#/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": "#/definitions/MachineLearningServiceError"
+ }
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "WorkspacePrivateEndpointConnections"
+ ],
+ "operationId": "PrivateEndpointConnections_Put",
+ "description": "Update the state of specified private endpoint connection associated with the workspace.",
+ "x-ms-examples": {
+ "WorkspacePutPrivateEndpointConnection": {
+ "$ref": "./examples/workspacePutPrivateEndpointConnection.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/WorkspaceNameParameter"
+ },
+ {
+ "$ref": "#/parameters/PrivateEndpointConnectionName"
+ },
+ {
+ "$ref": "#/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": "#/definitions/MachineLearningServiceError"
+ }
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "WorkspacePrivateEndpointConnections"
+ ],
+ "operationId": "PrivateEndpointConnections_Delete",
+ "description": "Deletes the specified private endpoint connection associated with the workspace.",
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "WorkspaceDeletePrivateEndpointConnection": {
+ "$ref": "./examples/workspaceDeletePrivateEndpointConnection.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/WorkspaceNameParameter"
+ },
+ {
+ "$ref": "#/parameters/PrivateEndpointConnectionName"
+ },
+ {
+ "$ref": "#/parameters/APIVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK -- Delete the private endpoint connection successfully."
+ },
+ "202": {
+ "description": "The request was successful; the request was well-formed and received properly."
+ },
+ "204": {
+ "description": "No Content -- The private endpoint connection does not exist."
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/MachineLearningServiceError"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/privateLinkResources": {
+ "get": {
+ "tags": [
+ "WorkspacePrivateLinkResources"
+ ],
+ "operationId": "PrivateLinkResources_ListByWorkspace",
+ "description": "Gets the private link resources that need to be created for a workspace.",
+ "x-ms-examples": {
+ "WorkspaceListPrivateLinkResources": {
+ "$ref": "./examples/workspaceListPrivateLinkResources.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/WorkspaceNameParameter"
+ },
+ {
+ "$ref": "#/parameters/APIVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successfully retrieved private link resources.",
+ "schema": {
+ "$ref": "#/definitions/PrivateLinkResourceListResult"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/computes/{computeName}/start": {
+ "post": {
+ "tags": [
+ "OperationalizationClusters",
+ "MachineLearningComputes"
+ ],
+ "operationId": "MachineLearningCompute_Start",
+ "description": "Posts a start action to a compute instance",
+ "x-ms-examples": {
+ "Start ComputeInstance Compute": {
+ "$ref": "./examples/startComputeInstance.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/WorkspaceNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ComputeNameParameter"
+ },
+ {
+ "$ref": "#/parameters/APIVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success."
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/MachineLearningServiceError"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/computes/{computeName}/stop": {
+ "post": {
+ "tags": [
+ "OperationalizationClusters",
+ "MachineLearningComputes"
+ ],
+ "operationId": "MachineLearningCompute_Stop",
+ "description": "Posts a stop action to a compute instance",
+ "x-ms-examples": {
+ "Stop ComputeInstance Compute": {
+ "$ref": "./examples/stopComputeInstance.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/WorkspaceNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ComputeNameParameter"
+ },
+ {
+ "$ref": "#/parameters/APIVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success."
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/MachineLearningServiceError"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/computes/{computeName}/restart": {
+ "post": {
+ "tags": [
+ "OperationalizationClusters",
+ "MachineLearningComputes"
+ ],
+ "operationId": "MachineLearningCompute_Restart",
+ "description": "Posts a restart action to a compute instance",
+ "x-ms-examples": {
+ "Restart ComputeInstance Compute": {
+ "$ref": "./examples/restartComputeInstance.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/WorkspaceNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ComputeNameParameter"
+ },
+ {
+ "$ref": "#/parameters/APIVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success."
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/MachineLearningServiceError"
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": {
+ "SubscriptionIdParameter": {
+ "name": "subscriptionId",
+ "description": "Azure subscription identifier.",
+ "in": "path",
+ "type": "string",
+ "required": true
+ },
+ "ResourceGroupNameParameter": {
+ "name": "resourceGroupName",
+ "description": "Name of the resource group in which workspace is located.",
+ "in": "path",
+ "type": "string",
+ "required": true,
+ "x-ms-parameter-location": "method"
+ },
+ "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"
+ },
+ "APIVersionParameter": {
+ "in": "query",
+ "name": "api-version",
+ "type": "string",
+ "description": "Version of Azure Machine Learning resource provider API.",
+ "required": true
+ },
+ "PaginationParameter": {
+ "in": "query",
+ "name": "$skiptoken",
+ "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"
+ },
+ "RecommendedParameter": {
+ "in": "query",
+ "name": "recommended",
+ "type": "boolean",
+ "description": "Specifies whether to return recommended vm sizes or all vm sizes",
+ "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"
+ }
+ }
+ }
+ }
+ },
+ "NotebookListCredentialsResult": {
+ "type": "object",
+ "properties": {
+ "primaryAccessKey": {
+ "type": "string"
+ },
+ "secondaryAccessKey": {
+ "type": "string"
+ }
+ }
+ },
+ "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."
+ }
+ }
+ },
+ "NotebookPreparationError": {
+ "type": "object",
+ "properties": {
+ "errorMessage": {
+ "type": "string"
+ },
+ "statusCode": {
+ "format": "int32",
+ "type": "integer"
+ }
+ }
+ },
+ "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": "#/definitions/Resource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/WorkspaceProperties",
+ "description": "The properties of the machine learning workspace.",
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "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"
+ },
+ "creationTime": {
+ "format": "date-time",
+ "description": "The creation time of the machine learning workspace in ISO8601 format.",
+ "type": "string",
+ "readOnly": true
+ },
+ "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"
+ },
+ "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
+ },
+ "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."
+ }
+ }
+ },
+ "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."
+ },
+ "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"
+ }
+ }
+ },
+ "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."
+ },
+ "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."
+ },
+ "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": {
+ "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": {
+ "amlCompute": {
+ "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"
+ }
+ }
+ },
+ "description": "Quota update parameters."
+ },
+ "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."
+ },
+ "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",
+ "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.",
+ "required": [
+ "type"
+ ]
+ },
+ "Resource": {
+ "description": "Azure Resource Manager resource envelope.",
+ "x-ms-azure-resource": true,
+ "properties": {
+ "id": {
+ "description": "Specifies the resource ID.",
+ "type": "string",
+ "readOnly": true
+ },
+ "name": {
+ "description": "Specifies the name of the resource.",
+ "type": "string",
+ "readOnly": true
+ },
+ "identity": {
+ "$ref": "#/definitions/Identity",
+ "description": "The identity of the resource."
+ },
+ "location": {
+ "description": "Specifies the location of the resource.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Specifies the type of the resource.",
+ "type": "string",
+ "readOnly": true
+ },
+ "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."
+ }
+ }
+ },
+ "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"
+ },
+ "userStorageResourceId": {
+ "readOnly": true,
+ "type": "string"
+ },
+ "appInsightsInstrumentationKey": {
+ "readOnly": true,
+ "type": "string"
+ },
+ "containerRegistryCredentials": {
+ "readOnly": true,
+ "$ref": "#/definitions/RegistryListCredentialsResult"
+ },
+ "notebookAccessKeys": {
+ "$ref": "#/definitions/NotebookListCredentialsResult"
+ }
+ }
+ },
+ "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": "#/definitions/Resource"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "properties": {
+ "description": "Compute properties",
+ "$ref": "#/definitions/Compute"
+ }
+ }
+ }
+ ]
+ },
+ "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",
+ "description": "The date and time when the compute was created.",
+ "format": "date-time",
+ "readOnly": true
+ },
+ "modifiedOn": {
+ "type": "string",
+ "description": "The date and time when the compute was last modified.",
+ "format": "date-time",
+ "readOnly": true
+ },
+ "resourceId": {
+ "type": "string",
+ "description": "ARM resource id of the underlying compute"
+ },
+ "provisioningErrors": {
+ "type": "array",
+ "description": "Errors during provisioning",
+ "items": {
+ "$ref": "#/definitions/MachineLearningServiceError"
+ },
+ "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
+ }
+ },
+ "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",
+ "minimum": 1
+ },
+ "agentVMSize": {
+ "description": "Agent virtual machine size",
+ "type": "string"
+ },
+ "sslConfiguration": {
+ "description": "SSL configuration",
+ "$ref": "#/definitions/SslConfiguration"
+ },
+ "aksNetworkingConfiguration": {
+ "description": "AKS networking configuration for vnet",
+ "$ref": "#/definitions/AksNetworkingConfiguration"
+ }
+ }
+ }
+ }
+ }
+ ],
+ "x-ms-discriminator-value": "AKS"
+ },
+ "AmlCompute": {
+ "description": "An Azure Machine Learning compute.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/Compute"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "properties": {
+ "description": "AML Compute properties",
+ "type": "object",
+ "properties": {
+ "vmSize": {
+ "description": "Virtual Machine Size",
+ "type": "string"
+ },
+ "vmPriority": {
+ "description": "Virtual Machine priority",
+ "type": "string",
+ "enum": [
+ "Dedicated",
+ "LowPriority"
+ ],
+ "x-ms-enum": {
+ "name": "VmPriority",
+ "modelAsString": true
+ }
+ },
+ "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": "#/definitions/MachineLearningServiceError"
+ }
+ },
+ "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"
+ }
+ }
+ }
+ }
+ }
+ ],
+ "x-ms-discriminator-value": "AmlCompute"
+ },
+ "ComputeInstance": {
+ "description": "An Azure Machine Learning compute instance.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/Compute"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "properties": {
+ "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": "#/definitions/MachineLearningServiceError"
+ }
+ },
+ "state": {
+ "description": "The current state of this ComputeInstance.",
+ "$ref": "#/definitions/ComputeInstanceState",
+ "readOnly": true
+ },
+ "lastOperation": {
+ "description": "The last operation on ComputeInstance.",
+ "$ref": "#/definitions/ComputeInstanceLastOperation",
+ "readOnly": true
+ }
+ }
+ }
+ }
+ }
+ ],
+ "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"
+ },
+ "address": {
+ "description": "Public IP address of the virtual machine.",
+ "type": "string"
+ },
+ "administratorAccount": {
+ "description": "Admin credentials for virtual machine",
+ "$ref": "#/definitions/VirtualMachineSshCredentials"
+ }
+ }
+ }
+ }
+ }
+ ],
+ "x-ms-discriminator-value": "VirtualMachine"
+ },
+ "HDInsight": {
+ "description": "A HDInsight compute.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/Compute"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "properties": {
+ "type": "object",
+ "properties": {
+ "sshPort": {
+ "description": "Port open for ssh connections on the master node of the cluster.",
+ "type": "integer"
+ },
+ "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"
+ }
+ }
+ }
+ }
+ }
+ ],
+ "x-ms-discriminator-value": "HDInsight"
+ },
+ "DataFactory": {
+ "description": "A DataFactory compute.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/Compute"
+ }
+ ],
+ "x-ms-discriminator-value": "DataFactory"
+ },
+ "Databricks": {
+ "description": "A DataFactory compute.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/Compute"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "properties": {
+ "type": "object",
+ "properties": {
+ "databricksAccessToken": {
+ "description": "Databricks access token",
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ ],
+ "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"
+ },
+ "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"
+ ]
+ },
+ "cert": {
+ "description": "Cert data",
+ "type": "string"
+ },
+ "key": {
+ "description": "Key data",
+ "type": "string"
+ },
+ "cname": {
+ "description": "CNAME of the cert",
+ "type": "string"
+ }
+ }
+ },
+ "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"
+ },
+ "minNodeCount": {
+ "description": "Min number of nodes to use",
+ "type": "integer",
+ "default": 0
+ },
+ "nodeIdleTimeBeforeScaleDown": {
+ "type": "string",
+ "format": "duration",
+ "description": "Node Idle Time before scaling down amlCompute"
+ }
+ },
+ "required": [
+ "maxNodeCount"
+ ]
+ },
+ "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."
+ },
+ "ClusterUpdateProperties": {
+ "properties": {
+ "scaleSettings": {
+ "$ref": "#/definitions/ScaleSettings",
+ "title": "Scale settings.",
+ "description": "Desired scale settings for the amlCompute."
+ }
+ },
+ "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."
+ },
+ "ComputeNodesInformation": {
+ "type": "object",
+ "description": "Compute nodes information 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"
+ },
+ "nextLink": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The continuation token."
+ }
+ },
+ "required": [
+ "computeType"
+ ]
+ },
+ "AmlComputeNodesInformation": {
+ "description": "Compute node information related to a AmlCompute.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ComputeNodesInformation"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "nodes": {
+ "readOnly": true,
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/AmlComputeNodeInformation"
+ },
+ "description": "The collection of returned AmlCompute nodes details."
+ }
+ }
+ }
+ ],
+ "x-ms-discriminator-value": "AmlCompute"
+ },
+ "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."
+ }
+ },
+ "x-ms-discriminator-value": "AmlCompute"
+ },
+ "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"
+ ]
+ },
+ "AksComputeSecrets": {
+ "description": "Secrets related to a Machine Learning compute based on AKS.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ComputeSecrets"
+ },
+ {
+ "type": "object",
+ "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."
+ }
+ }
+ }
+ ],
+ "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"
+ },
+ "DatabricksComputeSecrets": {
+ "description": "Secrets related to a Machine Learning compute based on Databricks.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ComputeSecrets"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "databricksAccessToken": {
+ "description": "access token for databricks account.",
+ "type": "string"
+ }
+ }
+ }
+ ],
+ "x-ms-discriminator-value": "Databricks"
+ },
+ "ComputeType": {
+ "type": "string",
+ "description": "The type of compute",
+ "enum": [
+ "AKS",
+ "AmlCompute",
+ "ComputeInstance",
+ "DataFactory",
+ "VirtualMachine",
+ "HDInsight",
+ "Databricks",
+ "DataLakeAnalytics"
+ ],
+ "x-ms-enum": {
+ "name": "ComputeType",
+ "modelAsString": true
+ }
+ },
+ "MachineLearningServiceError": {
+ "type": "object",
+ "description": "Wrapper for error response to follow ARM guidelines.",
+ "properties": {
+ "error": {
+ "description": "The error response.",
+ "$ref": "#/definitions/ErrorResponse",
+ "readOnly": true
+ }
+ }
+ },
+ "ErrorResponse": {
+ "type": "object",
+ "description": "Error response information.",
+ "properties": {
+ "code": {
+ "type": "string",
+ "description": "Error code.",
+ "readOnly": true
+ },
+ "message": {
+ "type": "string",
+ "description": "Error message.",
+ "readOnly": true
+ },
+ "details": {
+ "type": "array",
+ "description": "An array of error detail objects.",
+ "items": {
+ "$ref": "#/definitions/ErrorDetail"
+ },
+ "readOnly": true
+ }
+ }
+ },
+ "ErrorDetail": {
+ "type": "object",
+ "description": "Error detail information.",
+ "properties": {
+ "code": {
+ "type": "string",
+ "description": "Error code."
+ },
+ "message": {
+ "type": "string",
+ "description": "Error message."
+ }
+ },
+ "required": [
+ "code",
+ "message"
+ ]
+ },
+ "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"
+ }
+ }
+ },
+ "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": {
+ "type": "object",
+ "description": "AML workspace sku information",
+ "properties": {
+ "resourceType": {
+ "readOnly": true,
+ "type": "string"
+ },
+ "skus": {
+ "readOnly": true,
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/SkuSettings"
+ },
+ "description": "The list of workspace sku settings"
+ }
+ }
+ },
+ "SkuSettings": {
+ "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."
+ }
+ }
+ },
+ "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."
+ },
+ "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"
+ }
+ }
+ },
+ "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"
+ }
+ }
+ },
+ "PrivateEndpointConnection": {
+ "x-ms-azure-resource": true,
+ "description": "The Private Endpoint Connection resource.",
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "ResourceId of the private endpoint connection.",
+ "readOnly": true
+ },
+ "name": {
+ "type": "string",
+ "description": "Friendly name of the private endpoint connection.",
+ "readOnly": true
+ },
+ "type": {
+ "type": "string",
+ "description": "Resource type of private endpoint connection.",
+ "readOnly": true
+ },
+ "properties": {
+ "$ref": "#/definitions/PrivateEndpointConnectionProperties",
+ "x-ms-client-flatten": true,
+ "description": "Resource properties."
+ }
+ }
+ },
+ "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"
+ }
+ },
+ "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
+ }
+ },
+ "allOf": [
+ {
+ "$ref": "#/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
+ }
+ },
+ "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"
+ },
+ "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
+ }
+ }
+ },
+ "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.",
+ "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"
+ }
+ }
+ },
+ "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 a 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 a 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."
+ }
+ }
+ }
+ }
+}
diff --git a/specification/machinelearningservices/resource-manager/readme.md b/specification/machinelearningservices/resource-manager/readme.md
index af746a0266f1..4870058be3a7 100644
--- a/specification/machinelearningservices/resource-manager/readme.md
+++ b/specification/machinelearningservices/resource-manager/readme.md
@@ -26,7 +26,16 @@ These are the global settings for the Machine Learning Services API.
``` yaml
openapi-type: arm
-tag: package-2020-06-01
+tag: package-2020-08-01
+```
+
+### Tag: package-2020-08-01
+
+These settings apply only when `--tag=package-2020-08` is specified on the command line.
+
+```yaml $(tag) == 'package-2020-08-01'
+input-file:
+ - Microsoft.MachineLearningServices/stable/2020-08-01/machineLearningServices.json
```
### Tag: package-2020-06-01
@@ -213,6 +222,7 @@ output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-machinelearning/ser
``` yaml $(java) && $(multiapi)
batch:
+ - tag: package-2020-08-01
- tag: package-2020-06-01
- tag: package-2020-04-01
- tag: package-2020-03-01
@@ -227,6 +237,19 @@ batch:
- tag: package-2020-02-18-preview
- tag: package-2018-03-preview
```
+### Tag: package-2020-08-01 and java
+
+These settings apply only when `--tag=package-2020-08-01 --java` is specified on the command line.
+Please also specify `--azure-libraries-for-java=`.
+
+``` yaml $(tag) == 'package-2020-08-01' && $(java) && $(multiapi)
+java:
+ namespace: com.microsoft.azure.management.machinelearningservices.v2020_08_01
+ output-folder: $(azure-libraries-for-java-folder)/sdk/machinelearningservices/mgmt-v2020_08_01
+regenerate-manager: true
+generate-interface: true
+```
+
### Tag: package-2020-06-01 and java
These settings apply only when `--tag=package-2020-06-01 --java` is specified on the command line.
diff --git a/specification/maps/data-plane/Microsoft.Maps/Mobility/preview/1.0/examples/GetMetroAreaInfo.json b/specification/maps/data-plane/Microsoft.Maps/Mobility/preview/1.0/examples/GetMetroAreaInfo.json
index 5105fdde77ed..34064024fa0d 100644
--- a/specification/maps/data-plane/Microsoft.Maps/Mobility/preview/1.0/examples/GetMetroAreaInfo.json
+++ b/specification/maps/data-plane/Microsoft.Maps/Mobility/preview/1.0/examples/GetMetroAreaInfo.json
@@ -307,7 +307,8 @@
"captionOverride": "Bus"
}
}
- ]
+ ],
+ "isFaresSupported": "true"
}
},
"400": {
diff --git a/specification/maps/data-plane/Microsoft.Maps/Mobility/preview/1.0/examples/GetTransitItinerary.json b/specification/maps/data-plane/Microsoft.Maps/Mobility/preview/1.0/examples/GetTransitItinerary.json
index 02fc587bd829..91f2c104f189 100644
--- a/specification/maps/data-plane/Microsoft.Maps/Mobility/preview/1.0/examples/GetTransitItinerary.json
+++ b/specification/maps/data-plane/Microsoft.Maps/Mobility/preview/1.0/examples/GetTransitItinerary.json
@@ -2,7 +2,7 @@
"parameters": {
"api-version": "1.0",
"format": "json",
- "query": "68fa6e31-d1a4-4457-a15b-8f5036a76a78---201909167EB6D19458C443BFAD897246FD28DAD4:0---121",
+ "query": "6f1eb44e-255f-4d06-9491-a35ee7864e19---20200929FF43D18907D24B35A1A7454DE7231C89:0---81",
"detailType": [
"geometry"
]
@@ -10,148 +10,198 @@
"responses": {
"200": {
"body": {
- "departureTime": "2019-09-16T18:04:53Z",
- "arrivalTime": "2019-09-16T18:08:07Z",
+ "departureTime": "2020-09-29T20:48:05Z",
+ "arrivalTime": "2020-09-29T20:53:25Z",
"legs": [
{
- "legType": "Bicycle",
- "legStartTime": "2019-09-16T18:04:53Z",
- "legEndTime": "2019-09-16T18:08:07Z",
- "steps": [
+ "legType": "Wait",
+ "legStartTime": "2020-09-29T20:48:05Z",
+ "legEndTime": "2020-09-29T20:48:05Z",
+ "lineGroup": {
+ "lineGroupId": "0---211457",
+ "agencyId": "0---321",
+ "agencyName": "CTA",
+ "lineNumber": "22",
+ "caption1": "Clark",
+ "caption2": "22 Clark",
+ "color": "565A5C",
+ "transitType": "Bus"
+ },
+ "line": {
+ "lineId": "0---1151684",
+ "lineGroupId": "0---211457",
+ "direction": "forward",
+ "agencyId": "0---321",
+ "lineNumber": "22",
+ "lineDestination": "Southbound - Harrison"
+ },
+ "stops": [
+ {
+ "stopId": "0---161771",
+ "stopKey": "1853",
+ "stopName": "Clark & Oak (South)",
+ "stopCode": "1853",
+ "position": {
+ "latitude": 41.900657,
+ "longitude": -87.631426
+ },
+ "mainTransitType": "Bus",
+ "mainAgencyId": "0---321",
+ "mainAgencyName": "CTA"
+ },
+ {
+ "stopId": "0---33004397",
+ "stopKey": "18255",
+ "stopName": "Clark & Huron (South)",
+ "stopCode": "18255",
+ "position": {
+ "latitude": 41.894729,
+ "longitude": -87.631288
+ },
+ "mainTransitType": "Bus",
+ "mainAgencyId": "0---321",
+ "mainAgencyName": "CTA"
+ }
+ ],
+ "waitOnVehicle": "false"
+ },
+ {
+ "legType": "Bus",
+ "legStartTime": "2020-09-29T20:48:05Z",
+ "legEndTime": "2020-09-29T20:51:15Z",
+ "lineGroup": {
+ "lineGroupId": "81---211457",
+ "agencyId": "81---321",
+ "agencyName": "CTA",
+ "lineNumber": "22",
+ "caption1": "Clark",
+ "caption2": "22 Clark",
+ "color": "565A5C",
+ "transitType": "Bus"
+ },
+ "line": {
+ "lineId": "81---1151684",
+ "lineGroupId": "81---211457",
+ "direction": "forward",
+ "agencyId": "81---321",
+ "lineNumber": "22",
+ "lineDestination": "Southbound - Harrison"
+ },
+ "stops": [
{
- "direction": {
- "relativeDirection": "depart"
+ "stopId": "81---161771",
+ "stopKey": "1853",
+ "stopName": "Clark & Oak (South)",
+ "stopCode": "1853",
+ "position": {
+ "latitude": 41.900657,
+ "longitude": -87.631426
},
- "streetName": "3rd Avenue"
+ "mainTransitType": "Bus",
+ "mainAgencyId": "81---321",
+ "mainAgencyName": "CTA"
},
{
- "direction": {
- "relativeDirection": "right"
+ "stopId": "81---161772",
+ "stopKey": "1854",
+ "stopName": "Clark & Delaware (South)",
+ "stopCode": "1854",
+ "position": {
+ "latitude": 41.899361,
+ "longitude": -87.631386
},
- "streetName": "Dean Street"
+ "mainTransitType": "Bus",
+ "mainAgencyId": "81---321",
+ "mainAgencyName": "CTA"
},
{
- "direction": {
- "relativeDirection": "right"
+ "stopId": "81---33004397",
+ "stopKey": "18255",
+ "stopName": "Clark & Huron (South)",
+ "stopCode": "18255",
+ "position": {
+ "latitude": 41.894729,
+ "longitude": -87.631288
},
- "streetName": "5th Avenue"
+ "mainTransitType": "Bus",
+ "mainAgencyId": "81---321",
+ "mainAgencyName": "CTA"
}
],
- "origin": {
- "position": {
- "latitude": 40.680903,
- "longitude": -73.983723
- }
- },
- "destination": {
- "position": {
- "latitude": 40.682051,
- "longitude": -73.976702
- }
- },
"geometry": {
"type": "LineString",
"coordinates": [
[
- -73.98373,
- 40.6809
- ],
- [
- -73.98371,
- 40.68089
- ],
- [
- -73.98328,
- 40.68152
- ],
- [
- -73.9831,
- 40.68179
- ],
- [
- -73.98303,
- 40.68189
- ],
- [
- -73.98302,
- 40.68191
- ],
- [
- -73.9829,
- 40.68208
- ],
- [
- -73.98286,
- 40.68214
- ],
- [
- -73.9828,
- 40.68223
+ -87.63157,
+ 41.90064
],
[
- -73.98243,
- 40.68278
+ -87.63156,
+ 41.90057
],
[
- -73.98199,
- 40.68342
+ -87.63153,
+ 41.90045
],
[
- -73.98161,
- 40.68398
+ -87.6315,
+ 41.90029
],
[
- -73.98157,
- 40.68405
+ -87.63121,
+ 41.89508
],
[
- -73.9812,
- 40.6839
+ -87.63121,
+ 41.89498
],
[
- -73.97984,
- 40.68338
+ -87.63121,
+ 41.89487
],
[
- -73.9794,
- 40.6832
+ -87.63121,
+ 41.89481
],
[
- -73.97924,
- 40.68314
+ -87.6312,
+ 41.89476
],
[
- -73.97912,
- 40.68309
+ -87.6312,
+ 41.89473
],
[
- -73.97899,
- 40.68304
- ],
- [
- -73.97675,
- 40.68217
- ],
- [
- -73.97659,
- 40.68211
- ],
- [
- -73.97665,
- 40.68203
- ],
- [
- -73.97665,
- 40.68203
- ],
- [
- -73.97671,
- 40.68205
+ -87.6312,
+ 41.89472
]
]
+ },
+ "legFare": {
+ "fares": [
+ {
+ "price": {
+ "amount": 225,
+ "currencyCode": "USD"
+ },
+ "usage": "pay"
+ }
+ ]
}
}
- ]
+ ],
+ "itineraryFare": {
+ "price": {
+ "amount": 225,
+ "currencyCode": "USD"
+ },
+ "tickets": [
+ {
+ "amount": 225,
+ "currencyCode": "USD"
+ }
+ ]
+ }
}
},
"400": {
diff --git a/specification/maps/data-plane/Microsoft.Maps/Mobility/preview/1.0/examples/GetTransitRoute.json b/specification/maps/data-plane/Microsoft.Maps/Mobility/preview/1.0/examples/GetTransitRoute.json
index 9074ad95aaef..280920327153 100644
--- a/specification/maps/data-plane/Microsoft.Maps/Mobility/preview/1.0/examples/GetTransitRoute.json
+++ b/specification/maps/data-plane/Microsoft.Maps/Mobility/preview/1.0/examples/GetTransitRoute.json
@@ -2,181 +2,219 @@
"parameters": {
"api-version": "1.0",
"format": "json",
- "origin": "40.680903,-73.983723",
+ "origin": "41.948437, -87.655334",
"originType": "position",
- "destination": "40.682051,-73.976702",
- "destinationType": "position"
+ "destination": "41.878876, -87.635918",
+ "destinationType": "position",
+ "modeType": "publicTransit",
+ "transitType": "bus"
},
"responses": {
"200": {
"body": {
"results": [
{
- "itineraryId": "68fa6e31-d1a4-4457-a15b-8f5036a76a78---201909167EB6D19458C443BFAD897246FD28DAD4:0---121",
- "departureTime": "2019-09-16T18:04:53Z",
- "arrivalTime": "2019-09-16T18:08:07Z",
- "travelTimeInSeconds": 194,
- "numberOfLegs": 1,
- "legs": [
- {
- "legType": "Bicycle",
- "legStartTime": "2019-09-16T18:04:53Z",
- "legEndTime": "2019-09-16T18:08:07Z",
- "lengthInMeters": 877
- }
- ]
- },
- {
- "itineraryId": "68fa6e31-d1a4-4457-a15b-8f5036a76a78---20190916E4C79AA6602341F0973B94A3A79D9D36:0---121",
- "departureTime": "2019-09-16T18:04:53Z",
- "arrivalTime": "2019-09-16T18:07:57Z",
- "travelTimeInSeconds": 184,
- "numberOfLegs": 1,
- "legs": [
- {
- "legType": "Bicycle",
- "legStartTime": "2019-09-16T18:04:53Z",
- "legEndTime": "2019-09-16T18:07:57Z",
- "lengthInMeters": 851
- }
- ]
- },
- {
- "itineraryId": "68fa6e31-d1a4-4457-a15b-8f5036a76a78---201909168C38C8E44DEC41B7B6B7DB3ADE640722:0---121",
- "departureTime": "2019-09-16T18:04:53Z",
- "arrivalTime": "2019-09-16T18:13:33Z",
- "travelTimeInSeconds": 520,
- "numberOfLegs": 3,
+ "itineraryId": "41372ab5-8577-481a-ab24-e84572fe69a5---2020092910DC67FA27034F15A29F4AE5415ADAF2:0---81",
+ "departureTime": "2020-09-30T00:30:29Z",
+ "arrivalTime": "2020-09-30T01:18:16Z",
+ "travelTimeInSeconds": 2867,
+ "numberOfLegs": 4,
"legs": [
{
"legType": "Walk",
- "legStartTime": "2019-09-16T18:04:53Z",
- "legEndTime": "2019-09-16T18:07:12Z",
- "caption": "Douglass Street",
- "lengthInMeters": 93
+ "legStartTime": "2020-09-30T00:30:29Z",
+ "legEndTime": "2020-09-30T00:34:01Z",
+ "caption": "North Clark Street",
+ "lengthInMeters": 196
},
{
- "legType": "Bicycle",
- "legStartTime": "2019-09-16T18:07:12Z",
- "legEndTime": "2019-09-16T18:10:22Z",
- "caption": "Dean Street",
- "lengthInMeters": 734
+ "legType": "Wait",
+ "legStartTime": "2020-09-30T00:34:01Z",
+ "legEndTime": "2020-09-30T00:35:02Z",
+ "caption": "22"
+ },
+ {
+ "legType": "Bus",
+ "legStartTime": "2020-09-30T00:35:02Z",
+ "legEndTime": "2020-09-30T01:12:52Z",
+ "caption": "22",
+ "lengthInMeters": 8463,
+ "legFare": {
+ "fares": [
+ {
+ "price": {
+ "amount": 225,
+ "currencyCode": "USD"
+ },
+ "usage": "pay"
+ }
+ ]
+ }
},
{
"legType": "Walk",
- "legStartTime": "2019-09-16T18:10:22Z",
- "legEndTime": "2019-09-16T18:13:33Z",
- "lengthInMeters": 212
+ "legStartTime": "2020-09-30T01:12:53Z",
+ "legEndTime": "2020-09-30T01:18:16Z",
+ "lengthInMeters": 421
}
- ]
+ ],
+ "itineraryFare": {
+ "price": {
+ "amount": 225,
+ "currencyCode": "USD"
+ },
+ "tickets": [
+ {
+ "amount": 225,
+ "currencyCode": "USD"
+ }
+ ]
+ }
},
{
- "itineraryId": "68fa6e31-d1a4-4457-a15b-8f5036a76a78---201909168960D307482847EF9E0A2A59D22A5D2F:0---121",
- "departureTime": "2019-09-16T18:04:53Z",
- "arrivalTime": "2019-09-16T18:14:00Z",
- "travelTimeInSeconds": 547,
+ "itineraryId": "41372ab5-8577-481a-ab24-e84572fe69a5---2020092910DC67FA27034F15A29F4AE5415ADAF2:1---81",
+ "departureTime": "2020-09-30T00:32:42Z",
+ "arrivalTime": "2020-09-30T01:26:29Z",
+ "travelTimeInSeconds": 3227,
"numberOfLegs": 3,
"legs": [
{
"legType": "Walk",
- "legStartTime": "2019-09-16T18:04:53Z",
- "legEndTime": "2019-09-16T18:07:12Z",
- "caption": "Douglass Street",
- "lengthInMeters": 93
+ "legStartTime": "2020-09-30T00:32:42Z",
+ "legEndTime": "2020-09-30T00:39:40Z",
+ "caption": "West Sheridan Road",
+ "lengthInMeters": 480
},
{
- "legType": "Bicycle",
- "legStartTime": "2019-09-16T18:07:12Z",
- "legEndTime": "2019-09-16T18:10:22Z",
- "caption": "Dean Street",
- "lengthInMeters": 734
+ "legType": "Wait",
+ "legStartTime": "2020-09-30T00:39:40Z",
+ "legEndTime": "2020-09-30T00:40:41Z",
+ "caption": "151"
},
{
- "legType": "Walk",
- "legStartTime": "2019-09-16T18:10:22Z",
- "legEndTime": "2019-09-16T18:14:00Z",
- "lengthInMeters": 237
+ "legType": "Bus",
+ "legStartTime": "2020-09-30T00:40:41Z",
+ "legEndTime": "2020-09-30T01:26:29Z",
+ "caption": "151",
+ "lengthInMeters": 10539,
+ "legFare": {
+ "fares": [
+ {
+ "price": {
+ "amount": 225,
+ "currencyCode": "USD"
+ },
+ "usage": "pay"
+ }
+ ]
+ }
}
- ]
+ ],
+ "itineraryFare": {
+ "price": {
+ "amount": 225,
+ "currencyCode": "USD"
+ },
+ "tickets": [
+ {
+ "amount": 225,
+ "currencyCode": "USD"
+ }
+ ]
+ }
},
{
- "itineraryId": "68fa6e31-d1a4-4457-a15b-8f5036a76a78---2019091632031DBD314545E19C0CD726BCE4BCD8:0---121",
- "departureTime": "2019-09-16T18:06:17Z",
- "arrivalTime": "2019-09-16T18:16:00Z",
- "travelTimeInSeconds": 583,
- "numberOfLegs": 3,
+ "itineraryId": "41372ab5-8577-481a-ab24-e84572fe69a5---2020092910DC67FA27034F15A29F4AE5415ADAF2:2---81",
+ "departureTime": "2020-09-30T00:28:04Z",
+ "arrivalTime": "2020-09-30T01:24:46Z",
+ "travelTimeInSeconds": 3402,
+ "numberOfLegs": 7,
"legs": [
{
"legType": "Walk",
- "legStartTime": "2019-09-16T18:06:17Z",
- "legEndTime": "2019-09-16T18:11:56Z",
- "caption": "Dean Street",
- "lengthInMeters": 429
+ "legStartTime": "2020-09-30T00:28:04Z",
+ "legEndTime": "2020-09-30T00:35:40Z",
+ "caption": "West Waveland Avenue",
+ "lengthInMeters": 522
},
{
"legType": "Wait",
- "legStartTime": "2019-09-16T18:11:56Z",
- "legEndTime": "2019-09-16T18:12:57Z",
- "caption": "B65"
+ "legStartTime": "2020-09-30T00:35:40Z",
+ "legEndTime": "2020-09-30T00:36:41Z",
+ "caption": "8"
},
{
"legType": "Bus",
- "legStartTime": "2019-09-16T18:12:57Z",
- "legEndTime": "2019-09-16T18:16:00Z",
- "caption": "B65",
- "lengthInMeters": 422
- }
- ]
- },
- {
- "itineraryId": "68fa6e31-d1a4-4457-a15b-8f5036a76a78---2019091632031DBD314545E19C0CD726BCE4BCD8:1---121",
- "departureTime": "2019-09-16T18:15:04Z",
- "arrivalTime": "2019-09-16T18:24:36Z",
- "travelTimeInSeconds": 572,
- "numberOfLegs": 4,
- "legs": [
+ "legStartTime": "2020-09-30T00:36:41Z",
+ "legEndTime": "2020-09-30T01:09:41Z",
+ "caption": "8",
+ "lengthInMeters": 8059,
+ "legFare": {
+ "fares": [
+ {
+ "price": {
+ "amount": 225,
+ "currencyCode": "USD"
+ },
+ "usage": "pay"
+ }
+ ]
+ }
+ },
{
"legType": "Walk",
- "legStartTime": "2019-09-16T18:15:04Z",
- "legEndTime": "2019-09-16T18:15:50Z",
- "caption": "3rd Avenue",
- "lengthInMeters": 51
+ "legStartTime": "2020-09-30T01:09:42Z",
+ "legEndTime": "2020-09-30T01:11:59Z",
+ "caption": "West Van Buren Street",
+ "lengthInMeters": 174
},
{
"legType": "Wait",
- "legStartTime": "2019-09-16T18:15:50Z",
- "legEndTime": "2019-09-16T18:16:51Z",
- "caption": "B37"
+ "legStartTime": "2020-09-30T01:11:59Z",
+ "legEndTime": "2020-09-30T01:18:43Z",
+ "caption": "126"
},
{
"legType": "Bus",
- "legStartTime": "2019-09-16T18:16:51Z",
- "legEndTime": "2019-09-16T18:21:00Z",
- "caption": "B37",
- "lengthInMeters": 942
+ "legStartTime": "2020-09-30T01:18:43Z",
+ "legEndTime": "2020-09-30T01:22:45Z",
+ "caption": "126",
+ "lengthInMeters": 1092,
+ "legFare": {
+ "fares": [
+ {
+ "price": {
+ "amount": 25,
+ "currencyCode": "USD"
+ },
+ "usage": "pay"
+ }
+ ]
+ }
},
{
"legType": "Walk",
- "legStartTime": "2019-09-16T18:21:01Z",
- "legEndTime": "2019-09-16T18:24:36Z",
- "lengthInMeters": 278
- }
- ]
- },
- {
- "itineraryId": "68fa6e31-d1a4-4457-a15b-8f5036a76a78---2019091632031DBD314545E19C0CD726BCE4BCD8:2---121",
- "departureTime": "2019-09-16T18:04:53Z",
- "arrivalTime": "2019-09-16T18:15:38Z",
- "travelTimeInSeconds": 645,
- "numberOfLegs": 1,
- "legs": [
- {
- "legType": "Walk",
- "legStartTime": "2019-09-16T18:04:53Z",
- "legEndTime": "2019-09-16T18:15:38Z",
- "lengthInMeters": 829
+ "legStartTime": "2020-09-30T01:22:46Z",
+ "legEndTime": "2020-09-30T01:24:46Z",
+ "lengthInMeters": 102
}
- ]
+ ],
+ "itineraryFare": {
+ "price": {
+ "amount": 250,
+ "currencyCode": "USD"
+ },
+ "tickets": [
+ {
+ "amount": 225,
+ "currencyCode": "USD"
+ },
+ {
+ "amount": 25,
+ "currencyCode": "USD"
+ }
+ ]
+ }
}
]
}
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 afeb93435bcf..3af3f353c1f6 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
@@ -126,6 +126,7 @@
"name": "metroId",
"description": "The unique id of the metro area. Can be retrieved via [Get Metro Area API](https://aka.ms/AzureMapsMobilityMetro).",
"type": "integer",
+ "format": "int32",
"in": "query",
"required": false,
"x-ms-parameter-location": "method"
@@ -144,7 +145,7 @@
"get": {
"x-publish": true,
"operationId": "Mobility_GetMetroAreaPreview",
- "description": "**Metro Area API**\n\n**Applies to**: S1 pricing tier.\n\nService allows 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": "**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"
@@ -230,7 +231,7 @@
"get": {
"x-publish": true,
"operationId": "Mobility_GetMetroAreaInfoPreview",
- "description": "**Metro Area Info API**\n\n**Applies to**: S1 pricing tier.\n\nService allows to request additional information for metro areas in which the Azure Maps Mobility Service is available. Information such as supported transit types, transit agencies and active alerts is available, depending on the options selected.",
+ "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.",
"x-ms-examples": {
"MetroAreaInfo": {
"$ref": "./examples/GetMetroAreaInfo.json"
@@ -254,7 +255,8 @@
"description": "metroId. The unique id of the metro area. Required parameter specifying the required metro area to search in. Can be retrieved via [Get Metro Area API](https://aka.ms/AzureMapsMobilityTransitRoute).",
"in": "query",
"required": true,
- "type": "integer"
+ "type": "integer",
+ "format": "int32"
},
{
"name": "detailType",
@@ -362,14 +364,16 @@
"description": "Maximum number of responses that will be returned. Default is 3, minimum 1 and maximum 100. Sort order is based on distance from input location.",
"in": "query",
"required": false,
- "type": "integer"
+ "type": "integer",
+ "format": "int32"
},
{
"name": "radius",
"description": "Specifies the search area to constrain a search. The radius in meters to for the results to be constrained to the defined area. Default value is 30 meters, minimum 1 meter and maximum 5000 meters (5km).",
"in": "query",
"required": false,
- "type": "integer"
+ "type": "integer",
+ "format": "int32"
},
{
"name": "objectType",
@@ -649,7 +653,7 @@
"get": {
"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 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": "**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"
@@ -994,7 +998,7 @@
"get": {
"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. User 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": "**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"
@@ -1180,13 +1184,15 @@
"description": "The maximum arrivals to return. If not specified, the system default will be used. For stops max number of arrivals per stop. For lines max arrivals per stop on the line. For everything else max arrivals overall.",
"in": "query",
"required": false,
- "type": "integer"
+ "type": "integer",
+ "format": "int32"
},
{
"name": "maxMinutesInFuture",
"description": "The maximum time (in minutes) in the future to return arrivals for. If not specified, the system default (30 minutes) will be used. The minimum value is 0 and maximum value is 60 minutes.",
"required": false,
"type": "integer",
+ "format": "int32",
"in": "query"
},
{
@@ -1295,7 +1301,8 @@
"description": "Time in seconds within which if the provider doesn’t respond, end point will return static data.",
"in": "query",
"required": false,
- "type": "integer"
+ "type": "integer",
+ "format": "int32"
},
{
"$ref": "#/parameters/MobilityLanguage"
@@ -1521,14 +1528,19 @@
}
},
"MetroAreaInfoResponse": {
- "description": "This object is returned from a successful Metro Area call.",
+ "description": "This object is returned from a successful Metro Area Info call.",
"type": "object",
"properties": {
"metroName": {
"type": "string",
"description": "The name of the metro area."
},
+ "isFaresSupported": {
+ "type": "string",
+ "description": "Indicates if public transit fares information is available in the metro area. Fare information is available through [Get Transit Route API](https://aka.ms/AzureMapsMobilityTransitRoute) and [Get Transit Itinerary APIs](https://aka.ms/AzureMapsMobilityTransitItinerary)."
+ },
"transitTypes": {
+ "description": "Supported transit types in the metro area. Returned if specified in the request.",
"type": "array",
"items": {
"$ref": "#/definitions/TransitTypeResult"
@@ -1604,6 +1616,10 @@
},
"legs": {
"$ref": "#/definitions/ItinerarySummary"
+ },
+ "itineraryFare": {
+ "description": "Itinerary level transit fare information. Returned only if fare information is available for the entire itinerary. [Get Metro Area Info API](https://aka.ms/AzureMapsMobilityMetroAreaInfo) can be requested to confirm if fare information is available in the metro area.",
+ "$ref": "#/definitions/ItineraryFare"
}
}
},
@@ -1658,7 +1674,8 @@
"properties": {
"metroId": {
"description": "The metro area's Id for use with other API calls.",
- "type": "integer"
+ "type": "integer",
+ "format": "int32"
},
"metroName": {
"description": "The main display name of the metro.",
@@ -1852,7 +1869,7 @@
}
},
"Alert": {
- "description": "Basic information associated with the active alert.",
+ "description": "Basic information associated with the active alert. Returned if specified in the request and there is an active alert in the metro area.",
"type": "object",
"properties": {
"alertSummary": {
@@ -1932,15 +1949,21 @@
},
"travelTimeInSeconds": {
"description": "Estimated travel time in seconds.",
- "type": "integer"
+ "type": "integer",
+ "format": "int32"
},
"numberOfLegs": {
"description": "Number of legs.",
- "type": "integer"
+ "type": "integer",
+ "format": "int32"
},
"legs": {
"description": "An array summarizing the legs of this itinerary.",
"$ref": "#/definitions/RouteItinerarySummary"
+ },
+ "itineraryFare": {
+ "description": "Itinerary level transit fare information. Returned only if fare information is available for the entire itinerary. [Get Metro Area Info API](https://aka.ms/AzureMapsMobilityMetroAreaInfo) can be requested to confirm if fare information is available in the metro area.",
+ "$ref": "#/definitions/ItineraryFare"
}
}
},
@@ -1957,6 +1980,10 @@
"description": "The travel mode of the leg.",
"$ref": "#/definitions/LegType"
},
+ "legFare": {
+ "description": "Leg level public transit fare information. Returned only if fare information is available for the entire itinerary.",
+ "$ref": "#/definitions/LegFare"
+ },
"legStartTime": {
"description": "Start time for the leg in ISO 8601 format, e.g. 1996-12-19T19:39:57-08:00.",
"type": "string"
@@ -1971,7 +1998,8 @@
},
"lengthInMeters": {
"description": "The total distance of the leg in meters.",
- "type": "integer"
+ "type": "integer",
+ "format": "int32"
}
}
},
@@ -2031,6 +2059,10 @@
"description": "Relevant for Public Transit and Wait legs only",
"$ref": "#/definitions/Departures"
},
+ "legFare": {
+ "description": "Leg level public transit fare information. Returned only if fare information is available for the entire itinerary.",
+ "$ref": "#/definitions/LegFare"
+ },
"waitOnVehicle": {
"description": "Indicates whether it’s necessary to wait for the next leg on the same vehicle (i.e. the bus will only change its line number).",
"type": "string"
@@ -2113,6 +2145,78 @@
]
}
},
+ "ItineraryFare": {
+ "description": "Itinerary level transit fare information.",
+ "type": "object",
+ "properties": {
+ "price": {
+ "description": "The total price for all tickets a user is expected to purchase in order to complete this itinerary.",
+ "$ref": "#/definitions/Price"
+ },
+ "tickets": {
+ "description": "An array describing the individual prices of each of the tickets that the user is expected to purchase throughout this itinerary. The list isn’t ordered.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/Tickets"
+ }
+ }
+ }
+ },
+ "Tickets": {
+ "description": "An array describing the individual prices of each of the tickets that the user is expected to purchase throughout this itinerary. The list isn’t ordered.",
+ "type": "object",
+ "properties": {
+ "amount": {
+ "description": "Price of the ticket in cents. For example, $5.00 is returned as ‘500’.",
+ "type": "integer",
+ "format": "int32"
+ },
+ "currencyCode": {
+ "description": "Currency code, for example for US dollars “USD”.",
+ "type": "string"
+ }
+ }
+ },
+ "LegFare": {
+ "description": "Leg level public transit fare information. Returned only if fare information is available for the entire itinerary level and supported by the local transit agency.",
+ "type": "object",
+ "properties": {
+ "fares": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/Fares"
+ }
+ }
+ }
+ },
+ "Fares": {
+ "description": "Detailed fare information for the leg.",
+ "type": "object",
+ "properties": {
+ "price": {
+ "description": "The price of the ticket when purchased for the individual leg, not for the entire route at once.",
+ "$ref": "#/definitions/Price"
+ },
+ "usage": {
+ "description": "Supported values are:\n\n * pay – user is expected to pay for this ticket in order to consume the current leg\n * transfer – user can use a ticket purchased in a previous leg in order to consume the current leg. In general, when transfer is specified, the number of transfers is counted, and has a limit.\n * continue – user can use a ticket purchased in a previous leg in order to consume the current leg. In general, when continue is specified, the number of transfers isn’t incremented for this leg.\n * upgrade – user is expected to upgrade a ticket purchased in a previous leg in order to consume the current leg.",
+ "type": "string"
+ }
+ }
+ },
+ "Price": {
+ "type": "object",
+ "properties": {
+ "amount": {
+ "description": "Price of the ticket in cents. For example, $5.00 is returned as ‘500’.",
+ "type": "integer",
+ "format": "int32"
+ },
+ "currencyCode": {
+ "description": "Currency code, for example for US dollars “USD”.",
+ "type": "string"
+ }
+ }
+ },
"LegPoint": {
"type": "object",
"properties": {
@@ -2332,7 +2436,7 @@
"type": "object",
"properties": {
"transitType": {
- "description": "Supported public transit type.",
+ "description": "Supported public transit type. Returned if specified in the request.",
"$ref": "#/definitions/TransitType"
},
"captionOverride": {
@@ -2343,7 +2447,7 @@
},
"Agency": {
"type": "object",
- "description": "Details of the agency.",
+ "description": "Details of the agency. Returned if specified in the request.",
"properties": {
"agencyId": {
"description": "The Id of the relevant transit agency, for example, '5872'",
@@ -2437,7 +2541,8 @@
"properties": {
"arrivalMinutes": {
"description": "The estimated time of arrival in minutes.",
- "type": "integer"
+ "type": "integer",
+ "format": "int32"
},
"scheduleType": {
"description": "Whether the result is based on real-time or static data.",
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 91719c1102f1..3b9a123fb0a5 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
@@ -165,6 +165,7 @@
"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": {
@@ -174,6 +175,7 @@
"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"
},
"TextFormat": {
@@ -208,6 +210,7 @@
"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": {
@@ -216,6 +219,7 @@
"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": {
@@ -224,6 +228,7 @@
"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": {
@@ -232,6 +237,7 @@
"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"
},
"Text": {
@@ -344,6 +350,7 @@
"required": false,
"default": 12,
"type": "integer",
+ "format": "int32",
"minimum": 0,
"maximum": 20
},
@@ -367,6 +374,7 @@
"description": "Height of the resulting image in pixels. Range is 1 to 8192. Default\nis 512. It shouldn’t be used with bbox.",
"required": false,
"type": "integer",
+ "format": "int32",
"minimum": 1,
"maximum": 8192,
"default": 512
@@ -377,6 +385,7 @@
"description": "Width of the resulting image in pixels. Range is 1 to 8192. Default is 512. It shouldn’t be used with bbox.",
"required": false,
"type": "integer",
+ "format": "int32",
"minimum": 1,
"maximum": 8192,
"default": 512
diff --git a/specification/maps/data-plane/Microsoft.Maps/Render/preview/2.0/examples/GetMapTileV2.json b/specification/maps/data-plane/Microsoft.Maps/Render/preview/2.0/examples/GetMapTileV2.json
new file mode 100644
index 000000000000..a7f739006589
--- /dev/null
+++ b/specification/maps/data-plane/Microsoft.Maps/Render/preview/2.0/examples/GetMapTileV2.json
@@ -0,0 +1,61 @@
+{
+ "parameters": {
+ "api-version": "2.0",
+ "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.0/render.json b/specification/maps/data-plane/Microsoft.Maps/Render/preview/2.0/render.json
new file mode 100644
index 000000000000..3c5065885532
--- /dev/null
+++ b/specification/maps/data-plane/Microsoft.Maps/Render/preview/2.0/render.json
@@ -0,0 +1,382 @@
+{
+ "swagger": "2.0",
+ "info": {
+ "title": "Azure Maps Render Service",
+ "version": "2.0",
+ "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.0",
+ "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"
+ ],
+ "x-ms-enum": {
+ "name": "TilesetID",
+ "modelAsString": false,
+ "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 18. Format: raster (png)."
+ },
+ {
+ "value": "microsoft.base.darkgrey",
+ "description": "All layers with our dark grey style. \n\nSupports zoom levels 0 through 18. Format: raster (png)."
+ },
+ {
+ "value": "microsoft.base.labels.road",
+ "description": "Label data in our main style. \n\nSupports zoom levels 0 through 18. Format: raster (png)."
+ },
+ {
+ "value": "microsoft.base.hybrid.road",
+ "description": "Road, boundary and label data in our main style. \n\nSupports zoom levels 0 through 18. 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)."
+ }
+ ]
+ },
+ "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": {
+ "x-publish": true,
+ "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": "#/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": false,
+ "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"
+ }
+ ]
+ }
+ },
+ {
+ "$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"
+ }
+ }
+ }
+ }
+ },
+ "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
+ }
+ }
+}
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 5bf252cbddc8..ad56b8206ba0 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
@@ -212,6 +212,7 @@
"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": {
@@ -220,6 +221,7 @@
"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"
},
"xTileIndex": {
@@ -229,6 +231,7 @@
"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": {
@@ -238,6 +241,7 @@
"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"
}
},
@@ -315,6 +319,7 @@
"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.",
"required": false,
"type": "integer",
+ "format": "int32",
"minimum": 1,
"maximum": 20,
"default": 10
@@ -429,6 +434,7 @@
"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.",
"required": false,
"type": "integer",
+ "format": "int32",
"default": 10,
"minimum": 1,
"maximum": 20
@@ -643,6 +649,7 @@
"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
},
@@ -774,6 +781,7 @@
"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
},
@@ -790,6 +798,7 @@
"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
},
@@ -906,21 +915,25 @@
"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": {
@@ -1022,11 +1035,13 @@
"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": {
@@ -1066,11 +1081,13 @@
"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": {
@@ -1081,6 +1098,7 @@
"dl": {
"description": "Delay caused by the incident in seconds (except in road closures)",
"type": "integer",
+ "format": "int32",
"readOnly": true
},
"t": {
@@ -1122,6 +1140,7 @@
"@trafficAge": {
"description": "@Traffic Age property",
"type": "integer",
+ "format": "int32",
"readOnly": true
},
"@trafficModelId": {
diff --git a/specification/maps/data-plane/readme.md b/specification/maps/data-plane/readme.md
index b31946f65218..aba744cd6897 100644
--- a/specification/maps/data-plane/readme.md
+++ b/specification/maps/data-plane/readme.md
@@ -52,6 +52,7 @@ input-file:
- Microsoft.Maps/Geolocation/preview/1.0/geolocation.json
- Microsoft.Maps/Mobility/preview/1.0/mobility.json
- Microsoft.Maps/Render/preview/1.0/render.json
+ - Microsoft.Maps/Render/preview/2.0/render.json
- Microsoft.Maps/Route/preview/1.0/route.json
- Microsoft.Maps/Search/preview/1.0/search.json
- Microsoft.Maps/Spatial/preview/1.0/spatial.json
diff --git a/specification/mariadb/resource-manager/readme.go.md b/specification/mariadb/resource-manager/readme.go.md
index 5655a69784ad..787e63c11c97 100644
--- a/specification/mariadb/resource-manager/readme.go.md
+++ b/specification/mariadb/resource-manager/readme.go.md
@@ -13,9 +13,19 @@ go:
``` yaml $(go) && $(multiapi)
batch:
+ - tag: package-2020-01-01
- tag: package-2018-06-01
```
+### Tag: package-2020-01-01 and go
+
+These settings apply only when `--tag=package-2020-01-01 --go` is specified on the command line.
+Please also specify `--go-sdk-folder=`.
+
+``` yaml $(tag) == 'package-2020-01-01' && $(go)
+output-folder: $(go-sdk-folder)/services/$(namespace)/mgmt/2020-01-01/$(namespace)
+```
+
### Tag: package-2018-06-01 and go
These settings apply only when `--tag=package-2018-06-01 --go` is specified on the command line.
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 4db62eed41a1..af4d8bb66ac6 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
@@ -69,6 +69,12 @@
"schema": {
"$ref": "#/definitions/AgreementTerms"
}
+ },
+ "default": {
+ "description": "Microsoft.MarketplaceOrdering error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
}
}
},
@@ -272,6 +278,12 @@
"schema": {
"$ref": "#/definitions/AgreementTerms"
}
+ },
+ "default": {
+ "description": "Microsoft.MarketplaceOrdering error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
}
}
}
@@ -302,6 +314,12 @@
"$ref": "#/definitions/AgreementTerms"
}
}
+ },
+ "default": {
+ "description": "Microsoft.MarketplaceOrdering error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
}
}
}
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 29c533b6d7bd..cc1cbbdbb02e 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
@@ -7,9 +7,6 @@
"offerId": "offid",
"planId": "planid",
"parameters": {
- "id": "id",
- "name": "planid",
- "type": "Microsoft.MarketplaceOrdering/offertypes",
"properties": {
"publisher": "pubid",
"product": "offid",
diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/AccountFilters.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/AccountFilters.json
index af15b438982e..8a440c25b9d8 100644
--- a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/AccountFilters.json
+++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/AccountFilters.json
@@ -508,7 +508,7 @@
"in": "query",
"required": true,
"type": "string",
- "description": "The Version of the API to be used with the client request."
+ "description": "The version of the API to be used with the client request."
}
}
}
diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/Accounts.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/Accounts.json
index 97965f6cbc65..766cf0d5c3b8 100644
--- a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/Accounts.json
+++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/Accounts.json
@@ -1404,7 +1404,7 @@
"in": "query",
"required": true,
"type": "string",
- "description": "The Version of the API to be used with the client request."
+ "description": "The version of the API to be used with the client request."
}
}
}
diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/AssetsAndAssetFilters.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/AssetsAndAssetFilters.json
index 434cb58d9fe2..54de287e110e 100644
--- a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/AssetsAndAssetFilters.json
+++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/AssetsAndAssetFilters.json
@@ -1232,7 +1232,7 @@
"in": "query",
"required": true,
"type": "string",
- "description": "The Version of the API to be used with the client request."
+ "description": "The version of the API to be used with the client request."
}
}
}
diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/ContentKeyPolicies.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/ContentKeyPolicies.json
index 806e5ed64f1d..e735b23cf7b5 100644
--- a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/ContentKeyPolicies.json
+++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/ContentKeyPolicies.json
@@ -1163,7 +1163,7 @@
"in": "query",
"required": true,
"type": "string",
- "description": "The Version of the API to be used with the client request."
+ "description": "The version of the API to be used with the client request."
}
}
}
diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/Encoding.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/Encoding.json
index 57052bf2fe4d..bccc2485e9a3 100644
--- a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/Encoding.json
+++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/Encoding.json
@@ -125,6 +125,108 @@
"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."
+ },
+ "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."
+ },
"FaceDetectorPreset": {
"x-ms-discriminator-value": "#Microsoft.Media.FaceDetectorPreset",
"allOf": [
@@ -174,7 +276,29 @@
"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. 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"
+ "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",
@@ -201,12 +325,12 @@
"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 in to the input video. If not specified the overlay starts from the beginning of the input video."
+ "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 position in the input video at which the overlay ends. The value should be in ISO 8601 duration format. For example, PT30S to end the overlay at 30 seconds in to the input video. If not specified the overlay will be applied until the end of the input video if inputLoop is true. Else, if inputLoop is false, then overlay will last as long as the duration of the overlay media."
+ "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",
@@ -253,82 +377,6 @@
"type": "object",
"description": "A codec flag, which tells the encoder to copy the input video bitstream without re-encoding."
},
- "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."
- },
"Image": {
"x-ms-discriminator-value": "#Microsoft.Media.Image",
"allOf": [
@@ -339,15 +387,15 @@
"properties": {
"start": {
"type": "string",
- "description": "The position in the input video from where to start generating thumbnails. The value can be in absolute timestamp (ISO 8601, e.g: PT05S), or a frame count (For example, 10 for the 10th frame), or a relative value (For example, 1%). Also supports a macro {Best}, which tells the encoder to select the best thumbnail from the first few seconds of the video."
+ "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 absolute timestamp (ISO 8601, e.g: PT05S for one image every 5 seconds), or a frame count (For example, 30 for every 30 frames), or a relative value (For example, 1%)."
+ "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 in the input video at which to stop generating thumbnails. The value can be in absolute timestamp (ISO 8601, e.g: PT5M30S to stop at 5 minutes and 30 seconds), or a frame count (For example, 300 to stop at the 300th frame), or a relative value (For example, 100%)."
+ "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",
@@ -365,7 +413,7 @@
},
"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} - The base name of the input video {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. Any unsubstituted macros will be collapsed and removed from the filename."
+ "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. Any unsubstituted macros will be collapsed and removed from the filename."
}
},
"type": "object",
@@ -559,32 +607,6 @@
"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."
},
- "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."
- },
"VideoLayer": {
"x-ms-discriminator-value": "#Microsoft.Media.VideoLayer",
"allOf": [
@@ -782,6 +804,11 @@
"$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",
@@ -898,6 +925,7 @@
"AACGoodQualityAudio",
"ContentAwareEncodingExperimental",
"ContentAwareEncoding",
+ "CopyAllBitrateNonInterleaved",
"H264MultipleBitrate1080p",
"H264MultipleBitrate720p",
"H264MultipleBitrateSD"
@@ -919,7 +947,7 @@
},
{
"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 and bitrate. The auto-generated preset will never exceed the input resolution and bitrate. For example, if the input is 720p at 3 Mbps, output will remain 720p at best, and will start at rates lower than 3 Mbps. The output will have video and audio in separate MP4 files, which is optimal for adaptive streaming."
+ "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",
@@ -933,6 +961,10 @@
"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."
@@ -1257,6 +1289,26 @@
],
"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": [
@@ -1585,7 +1637,7 @@
"created": {
"type": "string",
"format": "date-time",
- "description": "The UTC date and time when the Job was created, in 'YYYY-MM-DDThh:mm:ssZ' format.",
+ "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
},
@@ -1649,7 +1701,7 @@
"lastModified": {
"type": "string",
"format": "date-time",
- "description": "The UTC date and time when the Job was last updated, in 'YYYY-MM-DDThh:mm:ssZ' format.",
+ "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
},
@@ -2439,7 +2491,7 @@
"in": "query",
"required": true,
"type": "string",
- "description": "The Version of the API to be used with the client request."
+ "description": "The version of the API to be used with the client request."
}
}
}
diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/StreamingPoliciesAndStreamingLocators.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/StreamingPoliciesAndStreamingLocators.json
index 37e7bd9ee454..31a2ad942e37 100644
--- a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/StreamingPoliciesAndStreamingLocators.json
+++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/StreamingPoliciesAndStreamingLocators.json
@@ -1248,7 +1248,7 @@
"in": "query",
"required": true,
"type": "string",
- "description": "The Version of the API to be used with the client request."
+ "description": "The version of the API to be used with the client request."
}
}
}
diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/jobs-create.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/jobs-create.json
index 13195c89754a..e1fad016f8a1 100644
--- a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/jobs-create.json
+++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/jobs-create.json
@@ -32,14 +32,14 @@
"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": "2019-10-10T22:38:03.4426085Z",
+ "created": "2020-09-25T03:52:07.7751982Z",
"state": "Queued",
"input": {
"@odata.type": "#Microsoft.Media.JobInputAsset",
"files": [],
"assetName": "job1-InputAsset"
},
- "lastModified": "2019-10-10T22:38:03.4426085Z",
+ "lastModified": "2020-09-25T03:52:07.7751982Z",
"outputs": [
{
"@odata.type": "#Microsoft.Media.JobOutputAsset",
diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/jobs-get-by-name.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/jobs-get-by-name.json
index b15e14539dbf..78cb152f29d0 100644
--- a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/jobs-get-by-name.json
+++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/jobs-get-by-name.json
@@ -23,7 +23,7 @@
{
"@odata.type": "#Microsoft.Media.JobInputAsset",
"files": [],
- "assetName": "job1 input"
+ "assetName": "job1-InputAsset"
}
]
},
@@ -34,7 +34,7 @@
"state": "Queued",
"progress": 0,
"label": "example-custom-label",
- "assetName": "job1 output"
+ "assetName": "job1-OutputAsset"
}
],
"priority": "Low",
diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/jobs-list-all-filter-by-created.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/jobs-list-all-filter-by-created.json
index ab38522ad492..12f494e9c2d3 100644
--- a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/jobs-list-all-filter-by-created.json
+++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/jobs-list-all-filter-by-created.json
@@ -5,7 +5,7 @@
"resourceGroupName": "contosoresources",
"accountName": "contosomedia",
"transformName": "exampleTransform",
- "$filter": "properties/created ge 2019-10-10T22:38:13.1259050Z and properties/created le 2019-10-10T22:38:23.1259050Z",
+ "$filter": "properties/created ge 2020-09-25T03:52:17.4802005Z and properties/created le 2020-09-25T03:52:27.4802005Z",
"$orderby": "properties/created"
},
"responses": {
@@ -17,7 +17,7 @@
"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": "2019-10-10T22:38:13.125905Z",
+ "created": "2020-09-25T03:52:17.4802005Z",
"state": "Processing",
"input": {
"@odata.type": "#Microsoft.Media.JobInputs",
@@ -25,24 +25,24 @@
{
"@odata.type": "#Microsoft.Media.JobInputAsset",
"files": [],
- "assetName": "job2 input"
+ "assetName": "job2-InputAsset"
}
]
},
- "lastModified": "2019-10-10T22:38:13.125905Z",
+ "lastModified": "2020-09-25T03:52:17.4802005Z",
"outputs": [
{
"@odata.type": "#Microsoft.Media.JobOutputAsset",
"state": "Processing",
"progress": 50,
"label": "example-custom-label",
- "startTime": "2019-10-10T22:28:03.125905Z",
- "assetName": "job2 output"
+ "startTime": "2020-09-25T03:42:07.4802005Z",
+ "assetName": "job2-OutputAsset"
}
],
"priority": "Low",
"correlationData": {},
- "startTime": "2019-10-10T22:28:03.125905Z"
+ "startTime": "2020-09-25T03:42:07.4802005Z"
}
},
{
@@ -50,7 +50,7 @@
"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": "2019-10-10T22:38:23.125905Z",
+ "created": "2020-09-25T03:52:27.4802005Z",
"state": "Finished",
"input": {
"@odata.type": "#Microsoft.Media.JobInputs",
@@ -58,26 +58,26 @@
{
"@odata.type": "#Microsoft.Media.JobInputAsset",
"files": [],
- "assetName": "job3 input"
+ "assetName": "job3-InputAsset"
}
]
},
- "lastModified": "2019-10-10T22:38:23.125905Z",
+ "lastModified": "2020-09-25T03:52:27.4802005Z",
"outputs": [
{
"@odata.type": "#Microsoft.Media.JobOutputAsset",
"state": "Finished",
"progress": 100,
"label": "example-custom-label",
- "startTime": "2019-10-10T22:28:03.125905Z",
- "endTime": "2019-10-10T22:38:03.125905Z",
- "assetName": "job3 output"
+ "startTime": "2020-09-25T03:42:07.4802005Z",
+ "endTime": "2020-09-25T03:52:07.4802005Z",
+ "assetName": "job3-OutputAsset"
}
],
"priority": "Low",
"correlationData": {},
- "startTime": "2019-10-10T22:28:03.125905Z",
- "endTime": "2019-10-10T22:38:03.125905Z"
+ "startTime": "2020-09-25T03:42:07.4802005Z",
+ "endTime": "2020-09-25T03:52:07.4802005Z"
}
}
]
diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/jobs-list-all-filter-by-lastmodified.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/jobs-list-all-filter-by-lastmodified.json
index 6933bae85fdc..c0e94c828c39 100644
--- a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/jobs-list-all-filter-by-lastmodified.json
+++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/jobs-list-all-filter-by-lastmodified.json
@@ -5,7 +5,7 @@
"resourceGroupName": "contosoresources",
"accountName": "contosomedia",
"transformName": "exampleTransform",
- "$filter": "properties/lastmodified ge 2019-10-10T22:38:13.1931019Z and properties/lastmodified le 2019-10-10T22:38:23.1931019Z",
+ "$filter": "properties/lastmodified ge 2020-09-25T03:52:17.5701994Z and properties/lastmodified le 2020-09-25T03:52:27.5701994Z",
"$orderby": "properties/lastmodified desc"
},
"responses": {
@@ -17,7 +17,7 @@
"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": "2019-10-10T22:38:23.1931019Z",
+ "created": "2020-09-25T03:52:27.5701994Z",
"state": "Finished",
"input": {
"@odata.type": "#Microsoft.Media.JobInputs",
@@ -25,26 +25,26 @@
{
"@odata.type": "#Microsoft.Media.JobInputAsset",
"files": [],
- "assetName": "job3 input"
+ "assetName": "job3-InputAsset"
}
]
},
- "lastModified": "2019-10-10T22:38:23.1931019Z",
+ "lastModified": "2020-09-25T03:52:27.5701994Z",
"outputs": [
{
"@odata.type": "#Microsoft.Media.JobOutputAsset",
"state": "Finished",
"progress": 100,
"label": "example-custom-label",
- "startTime": "2019-10-10T22:28:03.1931019Z",
- "endTime": "2019-10-10T22:38:03.1931019Z",
- "assetName": "job3 output"
+ "startTime": "2020-09-25T03:42:07.5701994Z",
+ "endTime": "2020-09-25T03:52:07.5701994Z",
+ "assetName": "job3-OutputAsset"
}
],
"priority": "Low",
"correlationData": {},
- "startTime": "2019-10-10T22:28:03.1931019Z",
- "endTime": "2019-10-10T22:38:03.1931019Z"
+ "startTime": "2020-09-25T03:42:07.5701994Z",
+ "endTime": "2020-09-25T03:52:07.5701994Z"
}
},
{
@@ -52,7 +52,7 @@
"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": "2019-10-10T22:38:13.1931019Z",
+ "created": "2020-09-25T03:52:17.5701994Z",
"state": "Processing",
"input": {
"@odata.type": "#Microsoft.Media.JobInputs",
@@ -60,24 +60,24 @@
{
"@odata.type": "#Microsoft.Media.JobInputAsset",
"files": [],
- "assetName": "job2 input"
+ "assetName": "job2-InputAsset"
}
]
},
- "lastModified": "2019-10-10T22:38:13.1931019Z",
+ "lastModified": "2020-09-25T03:52:17.5701994Z",
"outputs": [
{
"@odata.type": "#Microsoft.Media.JobOutputAsset",
"state": "Processing",
"progress": 50,
"label": "example-custom-label",
- "startTime": "2019-10-10T22:28:03.1931019Z",
- "assetName": "job2 output"
+ "startTime": "2020-09-25T03:42:07.5701994Z",
+ "assetName": "job2-OutputAsset"
}
],
"priority": "Low",
"correlationData": {},
- "startTime": "2019-10-10T22:28:03.1931019Z"
+ "startTime": "2020-09-25T03:42:07.5701994Z"
}
}
]
diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/jobs-list-all-filter-by-name-and-state.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/jobs-list-all-filter-by-name-and-state.json
index 201428425920..61f6f223a7db 100644
--- a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/jobs-list-all-filter-by-name-and-state.json
+++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/jobs-list-all-filter-by-name-and-state.json
@@ -24,7 +24,7 @@
{
"@odata.type": "#Microsoft.Media.JobInputAsset",
"files": [],
- "assetName": "job3 input"
+ "assetName": "job3-InputAsset"
}
]
},
@@ -35,15 +35,15 @@
"state": "Finished",
"progress": 100,
"label": "example-custom-label",
- "startTime": "2019-10-10T22:28:03.0624915Z",
- "endTime": "2019-10-10T22:38:03.0624915Z",
- "assetName": "job3 output"
+ "startTime": "2020-09-25T03:42:07.4002063Z",
+ "endTime": "2020-09-25T03:52:07.4002063Z",
+ "assetName": "job3-OutputAsset"
}
],
"priority": "Low",
"correlationData": {},
- "startTime": "2019-10-10T22:28:03.0624915Z",
- "endTime": "2019-10-10T22:38:03.0624915Z"
+ "startTime": "2020-09-25T03:42:07.4002063Z",
+ "endTime": "2020-09-25T03:52:07.4002063Z"
}
}
]
diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/jobs-list-all-filter-by-name.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/jobs-list-all-filter-by-name.json
index 2328cdd0e27d..7ae4888c8640 100644
--- a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/jobs-list-all-filter-by-name.json
+++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/jobs-list-all-filter-by-name.json
@@ -25,7 +25,7 @@
{
"@odata.type": "#Microsoft.Media.JobInputAsset",
"files": [],
- "assetName": "job1 input"
+ "assetName": "job1-InputAsset"
}
]
},
@@ -36,7 +36,7 @@
"state": "Queued",
"progress": 0,
"label": "example-custom-label",
- "assetName": "job1 output"
+ "assetName": "job1-OutputAsset"
}
],
"priority": "Low",
@@ -56,7 +56,7 @@
{
"@odata.type": "#Microsoft.Media.JobInputAsset",
"files": [],
- "assetName": "job2 input"
+ "assetName": "job2-InputAsset"
}
]
},
@@ -67,13 +67,13 @@
"state": "Processing",
"progress": 50,
"label": "example-custom-label",
- "startTime": "2019-10-10T22:28:02.7835215Z",
- "assetName": "job2 output"
+ "startTime": "2020-09-25T03:42:07.1140078Z",
+ "assetName": "job2-OutputAsset"
}
],
"priority": "Low",
"correlationData": {},
- "startTime": "2019-10-10T22:28:02.7835215Z"
+ "startTime": "2020-09-25T03:42:07.1140078Z"
}
}
]
diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/jobs-list-all-filter-by-state-eq.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/jobs-list-all-filter-by-state-eq.json
index c8bdd90a1084..983bcb4d00a4 100644
--- a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/jobs-list-all-filter-by-state-eq.json
+++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/jobs-list-all-filter-by-state-eq.json
@@ -24,7 +24,7 @@
{
"@odata.type": "#Microsoft.Media.JobInputAsset",
"files": [],
- "assetName": "job2 input"
+ "assetName": "job2-InputAsset"
}
]
},
@@ -35,13 +35,13 @@
"state": "Processing",
"progress": 50,
"label": "example-custom-label",
- "startTime": "2019-10-10T22:28:02.8754914Z",
- "assetName": "job2 output"
+ "startTime": "2020-09-25T03:42:07.1901996Z",
+ "assetName": "job2-OutputAsset"
}
],
"priority": "Low",
"correlationData": {},
- "startTime": "2019-10-10T22:28:02.8754914Z"
+ "startTime": "2020-09-25T03:42:07.1901996Z"
}
},
{
@@ -57,7 +57,7 @@
{
"@odata.type": "#Microsoft.Media.JobInputAsset",
"files": [],
- "assetName": "job3 input"
+ "assetName": "job3-InputAsset"
}
]
},
@@ -68,13 +68,13 @@
"state": "Processing",
"progress": 50,
"label": "example-custom-label",
- "startTime": "2019-10-10T22:28:02.8754914Z",
- "assetName": "job3 output"
+ "startTime": "2020-09-25T03:42:07.1901996Z",
+ "assetName": "job3-OutputAsset"
}
],
"priority": "Low",
"correlationData": {},
- "startTime": "2019-10-10T22:28:02.8754914Z"
+ "startTime": "2020-09-25T03:42:07.1901996Z"
}
}
]
diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/jobs-list-all-filter-by-state-ne.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/jobs-list-all-filter-by-state-ne.json
index 8271f7e9f526..cc5b998b4666 100644
--- a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/jobs-list-all-filter-by-state-ne.json
+++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/jobs-list-all-filter-by-state-ne.json
@@ -24,7 +24,7 @@
{
"@odata.type": "#Microsoft.Media.JobInputAsset",
"files": [],
- "assetName": "job1 input"
+ "assetName": "job1-InputAsset"
}
]
},
@@ -35,7 +35,7 @@
"state": "Queued",
"progress": 0,
"label": "example-custom-label",
- "assetName": "job1 output"
+ "assetName": "job1-OutputAsset"
}
],
"priority": "Low",
@@ -55,7 +55,7 @@
{
"@odata.type": "#Microsoft.Media.JobInputAsset",
"files": [],
- "assetName": "job4 input"
+ "assetName": "job4-InputAsset"
}
]
},
@@ -66,15 +66,15 @@
"state": "Finished",
"progress": 100,
"label": "example-custom-label",
- "startTime": "2019-10-10T22:28:02.9885137Z",
- "endTime": "2019-10-10T22:38:02.9885137Z",
- "assetName": "job4 output"
+ "startTime": "2020-09-25T03:42:07.3301954Z",
+ "endTime": "2020-09-25T03:52:07.3301954Z",
+ "assetName": "job4-OutputAsset"
}
],
"priority": "Low",
"correlationData": {},
- "startTime": "2019-10-10T22:28:02.9885137Z",
- "endTime": "2019-10-10T22:38:02.9885137Z"
+ "startTime": "2020-09-25T03:42:07.3301954Z",
+ "endTime": "2020-09-25T03:52:07.3301954Z"
}
}
]
diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/jobs-list-all.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/jobs-list-all.json
index 3ecc50aca0cc..5a33f882c066 100644
--- a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/jobs-list-all.json
+++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/jobs-list-all.json
@@ -23,7 +23,7 @@
{
"@odata.type": "#Microsoft.Media.JobInputAsset",
"files": [],
- "assetName": "job1 input"
+ "assetName": "job1-InputAsset"
}
]
},
@@ -34,7 +34,7 @@
"state": "Queued",
"progress": 0,
"label": "example-custom-label",
- "assetName": "job1 output"
+ "assetName": "job1-OutputAsset"
}
],
"priority": "Low",
@@ -54,7 +54,7 @@
{
"@odata.type": "#Microsoft.Media.JobInputAsset",
"files": [],
- "assetName": "job2 input"
+ "assetName": "job2-InputAsset"
}
]
},
@@ -65,13 +65,13 @@
"state": "Processing",
"progress": 50,
"label": "example-custom-label",
- "startTime": "2019-10-10T22:28:02.6465994Z",
- "assetName": "job2 output"
+ "startTime": "2020-09-25T03:42:06.7140175Z",
+ "assetName": "job2-OutputAsset"
}
],
"priority": "Low",
"correlationData": {},
- "startTime": "2019-10-10T22:28:02.6465994Z"
+ "startTime": "2020-09-25T03:42:06.7140175Z"
}
},
{
@@ -87,7 +87,7 @@
{
"@odata.type": "#Microsoft.Media.JobInputAsset",
"files": [],
- "assetName": "job3 input"
+ "assetName": "job3-InputAsset"
}
]
},
@@ -98,15 +98,15 @@
"state": "Finished",
"progress": 100,
"label": "example-custom-label",
- "startTime": "2019-10-10T22:28:02.6465994Z",
- "endTime": "2019-10-10T22:38:02.6465994Z",
- "assetName": "job3 output"
+ "startTime": "2020-09-25T03:42:06.7140175Z",
+ "endTime": "2020-09-25T03:52:06.7140175Z",
+ "assetName": "job3-OutputAsset"
}
],
"priority": "Low",
"correlationData": {},
- "startTime": "2019-10-10T22:28:02.6465994Z",
- "endTime": "2019-10-10T22:38:02.6465994Z"
+ "startTime": "2020-09-25T03:42:06.7140175Z",
+ "endTime": "2020-09-25T03:52:06.7140175Z"
}
}
]
diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/jobs-update.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/jobs-update.json
index e4cb0593537c..4e87729c196f 100644
--- a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/jobs-update.json
+++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/jobs-update.json
@@ -9,24 +9,17 @@
"parameters": {
"properties": {
"description": "Example job to illustrate update.",
- "priority": "High",
"input": {
- "@odata.type": "#Microsoft.Media.JobInputs",
- "inputs": [
- {
- "@odata.type": "#Microsoft.Media.JobInputAsset",
- "files": [],
- "assetName": "job1 input"
- }
- ]
+ "@odata.type": "#Microsoft.Media.JobInputAsset",
+ "assetName": "job1-InputAsset"
},
"outputs": [
{
"@odata.type": "#Microsoft.Media.JobOutputAsset",
- "label": "example-custom-label",
- "assetName": "job1 output"
+ "assetName": "job1-OutputAsset"
}
- ]
+ ],
+ "priority": "High"
}
}
},
@@ -46,18 +39,18 @@
{
"@odata.type": "#Microsoft.Media.JobInputAsset",
"files": [],
- "assetName": "job1 input"
+ "assetName": "job1-InputAsset"
}
]
},
- "lastModified": "2019-10-10T22:38:03.737608Z",
+ "lastModified": "2020-09-25T03:52:08.0551986Z",
"outputs": [
{
"@odata.type": "#Microsoft.Media.JobOutputAsset",
"state": "Queued",
"progress": 0,
"label": "example-custom-label",
- "assetName": "job1 output"
+ "assetName": "job1-OutputAsset"
}
],
"priority": "High",
diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/liveevent-allocate.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/liveevent-allocate.json
new file mode 100644
index 000000000000..95fd7e6461e1
--- /dev/null
+++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/liveevent-allocate.json
@@ -0,0 +1,13 @@
+{
+ "parameters": {
+ "subscriptionId": "0a6ec948-5a62-437d-b9df-934dc7c1b722",
+ "resourceGroupName": "mediaresources",
+ "accountName": "slitestmedia10",
+ "liveEventName": "myLiveEvent1",
+ "api-version": "2020-05-01"
+ },
+ "responses": {
+ "202": {},
+ "200": {}
+ }
+}
diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/liveevent-create.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/liveevent-create.json
index a87311c83976..463115e35652 100644
--- a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/liveevent-create.json
+++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/liveevent-create.json
@@ -34,7 +34,7 @@
}
},
"responses": {
- "202": {
+ "201": {
"body": {
"name": "myLiveEvent1",
"id": "/subscriptions/0a6ec948-5a62-437d-b9df-934dc7c1b722/resourceGroups/mediaresources/providers/Microsoft.Media/mediaservices/slitestmedia10/liveevents/myLiveEvent1",
@@ -46,7 +46,7 @@
},
"properties": {
"description": "test event 1",
- "resourceState": "Stopped",
+ "resourceState": "Creating",
"provisioningState": "InProgress",
"created": "2018-03-03T02:25:06.0982751Z",
"lastModified": "2018-03-03T02:25:06.0982751Z",
@@ -98,7 +98,7 @@
"properties": {
"description": "test event 1",
"resourceState": "Stopped",
- "provisioningState": "InProgress",
+ "provisioningState": "Succeeded",
"created": "2018-03-03T02:25:06.0982751Z",
"lastModified": "2018-03-03T02:25:06.0982751Z",
"useStaticHostname": false,
diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/liveevent-delete.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/liveevent-delete.json
index ffcbac281305..eddcf4c8ed4b 100644
--- a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/liveevent-delete.json
+++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/liveevent-delete.json
@@ -7,50 +7,50 @@
"api-version": "2020-05-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": {
+ "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
+ "description": "test event updated",
+ "input": {
+ "streamingProtocol": "FragmentedMP4",
+ "keyFrameIntervalDuration": "PT6S",
+ "endpoints": [],
+ "accessToken": null
},
- "Preview": {
- "Endpoints": [],
- "AccessControl": {
- "IP": {
- "Allow": [
+ "preview": {
+ "endpoints": [],
+ "accessControl": {
+ "iP": {
+ "allow": [
{
- "Name": "AllowOne",
- "Address": "192.1.1.0",
- "SubnetPrefixLength": null
+ "nName": "AllowOne",
+ "address": "192.1.1.0",
+ "subnetPrefixLength": null
}
]
}
},
- "PreviewLocator": null,
+ "previewLocator": null,
"streamingPolicyName": null
},
- "Encoding": {
- "EncodingType": "None",
- "PresetName": null
+ "encoding": {
+ "encodingType": "None",
+ "presetName": null
},
- "ProvisioningState": null,
- "ResourceState": "Stopped",
- "CrossSiteAccessPolicies": 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"
+ "streamOptions": [],
+ "created": "2018-03-02T18:25:07.5748853-08:00",
+ "lastModified": "2018-03-02T18:25:07.5748853-08:00"
}
}
},
diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/liveoutput-create.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/liveoutput-create.json
index 0289f1207488..8f737778b732 100644
--- a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/liveoutput-create.json
+++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/liveoutput-create.json
@@ -30,7 +30,7 @@
"archiveWindowLength": "PT5M",
"manifestName": "testmanifest",
"outputSnapTime": 0,
- "resourceState": "Creating",
+ "resourceState": "Stopped",
"provisioningState": "Succeeded",
"created": "2018-03-03T02:25:09.9431835Z",
"lastModified": "2018-03-03T02:25:09.9431835Z",
@@ -40,7 +40,7 @@
}
}
},
- "202": {
+ "201": {
"body": {
"name": "myLiveOutput1",
"id": "/subscriptions/0a6ec948-5a62-437d-b9df-934dc7c1b722/resourceGroups/mediaresources/providers/Microsoft.Media/mediaservices/slitestmedia10/liveevents/myLiveEvent1/liveoutputs/myLiveOutput1",
@@ -52,7 +52,7 @@
"manifestName": "testmanifest",
"outputSnapTime": 0,
"resourceState": "Creating",
- "provisioningState": "Succeeded",
+ "provisioningState": "InProgress",
"created": "2018-03-03T02:25:09.9431835Z",
"lastModified": "2018-03-03T02:25:09.9431835Z",
"hls": {
diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/streamingendpoint-create.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/streamingendpoint-create.json
index 8394c166bc54..ca9c03071647 100644
--- a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/streamingendpoint-create.json
+++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/streamingendpoint-create.json
@@ -6,7 +6,6 @@
"streamingEndpointName": "myStreamingEndpoint1",
"api-version": "2020-05-01",
"parameters": {
- "id": null,
"location": "West US",
"tags": {
"tag1": "value1",
@@ -45,7 +44,7 @@
}
},
"responses": {
- "202": {
+ "201": {
"body": {
"name": "myStreamingEndpoint1",
"id": "/subscriptions/0a6ec948-5a62-437d-b9df-934dc7c1b722/resourceGroups/mediaresources/providers/Microsoft.Media/mediaservices/slitestmedia10/streamingendpoints/myStreamingEndpoint1",
@@ -92,7 +91,7 @@
"hostName": "mystreamingendpoint1-slitestmedia10.streaming.mediaservices.windows.net",
"freeTrialEndTime": "0001-01-01T00:00:00-08:00",
"provisioningState": "InProgress",
- "resourceState": "Stopped",
+ "resourceState": "Creating",
"created": "2018-03-03T02:25:09.7561389Z",
"lastModified": "2018-03-03T02:25:09.7561389Z"
}
@@ -144,7 +143,7 @@
"maxCacheAge": null,
"hostName": "mystreamingendpoint1-slitestmedia10.streaming.mediaservices.windows.net",
"freeTrialEndTime": "0001-01-01T00:00:00-08:00",
- "provisioningState": "InProgress",
+ "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/2020-05-01/examples/streamingendpoint-delete.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/streamingendpoint-delete.json
index eebd53df788c..03b31961247c 100644
--- a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/streamingendpoint-delete.json
+++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/streamingendpoint-delete.json
@@ -7,32 +7,32 @@
"api-version": "2020-05-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": {
+ "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"
+ "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"
}
}
},
diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/streamingendpoint-update.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/streamingendpoint-update.json
index 8633a2681e19..c8d0d6afd6e6 100644
--- a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/streamingendpoint-update.json
+++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/streamingendpoint-update.json
@@ -6,7 +6,6 @@
"streamingEndpointName": "myStreamingEndpoint1",
"api-version": "2020-05-01",
"parameters": {
- "id": null,
"location": "West US",
"tags": {
"tag3": "value3",
diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/transforms-create.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/transforms-create.json
index 3dd7b2c06dfd..6c34df764080 100644
--- a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/transforms-create.json
+++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/transforms-create.json
@@ -26,9 +26,9 @@
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Media/mediaservices/contosomedia/transforms/createdTransform",
"type": "Microsoft.Media/mediaservices/transforms",
"properties": {
- "created": "2019-10-10T22:38:02.2021719-07:00",
+ "created": "2020-09-25T03:52:06.5178506-07:00",
"description": "Example Transform to illustrate create and update.",
- "lastModified": "2019-10-10T22:38:02.2021719-07:00",
+ "lastModified": "2020-09-25T03:52:06.5178506-07:00",
"outputs": [
{
"onError": "StopProcessingJob",
@@ -48,9 +48,9 @@
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Media/mediaservices/contosomedia/transforms/createdTransform",
"type": "Microsoft.Media/mediaservices/transforms",
"properties": {
- "created": "2019-10-10T22:38:02.2021719-07:00",
+ "created": "2020-09-25T03:52:06.5178506-07:00",
"description": "Example Transform to illustrate create and update.",
- "lastModified": "2019-10-10T22:38:02.2021719-07:00",
+ "lastModified": "2020-09-25T03:52:06.5178506-07:00",
"outputs": [
{
"onError": "StopProcessingJob",
diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/transforms-get-by-name.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/transforms-get-by-name.json
index 6e165e7b5b43..8b23bfdffbb5 100644
--- a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/transforms-get-by-name.json
+++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/transforms-get-by-name.json
@@ -14,9 +14,9 @@
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Media/mediaservices/contosomedia/transforms/sampleTransform",
"type": "Microsoft.Media/mediaservices/transforms",
"properties": {
- "created": "2019-10-10T22:38:01.9599144-07:00",
+ "created": "2020-09-25T03:52:06.2378492-07:00",
"description": "A sample Transform using the Standard Encoder with a built in preset.",
- "lastModified": "2019-10-10T22:38:01.9599144-07:00",
+ "lastModified": "2020-09-25T03:52:06.2378492-07:00",
"outputs": [
{
"onError": "StopProcessingJob",
diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/transforms-list-all-filter-by-created.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/transforms-list-all-filter-by-created.json
index 257c637422cb..061561e39a57 100644
--- a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/transforms-list-all-filter-by-created.json
+++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/transforms-list-all-filter-by-created.json
@@ -4,7 +4,7 @@
"subscriptionId": "00000000-0000-0000-0000-000000000000",
"resourceGroupName": "contosoresources",
"accountName": "contosomedia",
- "$filter": "properties/created gt 2019-10-10T22:38:01.7859346Z and properties/created le 2019-10-10T22:38:11.7859346Z",
+ "$filter": "properties/created gt 2020-09-25T03:52:06.1628567Z and properties/created le 2020-09-25T03:52:16.1628567Z",
"$orderby": "properties/created"
},
"responses": {
@@ -16,15 +16,16 @@
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Media/mediaservices/contosomedia/transforms/sampleEncodeAndVideoIndex",
"type": "Microsoft.Media/mediaservices/transforms",
"properties": {
- "created": "2019-10-10T22:38:11.7859346-07:00",
+ "created": "2020-09-25T03:52:16.1628567-07:00",
"description": "A sample Transform using the Video Analyzer.",
- "lastModified": "2019-10-10T22:38:11.7859346-07:00",
+ "lastModified": "2020-09-25T03:52:16.1628567-07:00",
"outputs": [
{
"onError": "StopProcessingJob",
"relativePriority": "Normal",
"preset": {
"@odata.type": "#Microsoft.Media.VideoAnalyzerPreset",
+ "mode": "Standard",
"insightsToExtract": "AllInsights"
}
}
diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/transforms-list-all-filter-by-lastmodified.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/transforms-list-all-filter-by-lastmodified.json
index cb97582fae9c..46cc43ff742a 100644
--- a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/transforms-list-all-filter-by-lastmodified.json
+++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/transforms-list-all-filter-by-lastmodified.json
@@ -4,7 +4,7 @@
"subscriptionId": "00000000-0000-0000-0000-000000000000",
"resourceGroupName": "contosoresources",
"accountName": "contosomedia",
- "$filter": "properties/lastmodified gt 2019-10-10T22:38:01.8751625Z and properties/lastmodified le 2019-10-10T22:38:11.8751625Z",
+ "$filter": "properties/lastmodified gt 2020-09-25T03:52:06.2028435Z and properties/lastmodified le 2020-09-25T03:52:16.2028435Z",
"$orderby": "properties/lastmodified desc"
},
"responses": {
@@ -16,15 +16,16 @@
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Media/mediaservices/contosomedia/transforms/sampleEncodeAndVideoIndex",
"type": "Microsoft.Media/mediaservices/transforms",
"properties": {
- "created": "2019-10-10T22:38:11.8751625-07:00",
+ "created": "2020-09-25T03:52:16.2028435-07:00",
"description": "A sample Transform using the Video Analyzer.",
- "lastModified": "2019-10-10T22:38:11.8751625-07:00",
+ "lastModified": "2020-09-25T03:52:16.2028435-07:00",
"outputs": [
{
"onError": "StopProcessingJob",
"relativePriority": "Normal",
"preset": {
"@odata.type": "#Microsoft.Media.VideoAnalyzerPreset",
+ "mode": "Standard",
"insightsToExtract": "AllInsights"
}
}
diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/transforms-list-all-filter-by-name.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/transforms-list-all-filter-by-name.json
index 75a08549f9fa..901610760eee 100644
--- a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/transforms-list-all-filter-by-name.json
+++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/transforms-list-all-filter-by-name.json
@@ -16,9 +16,9 @@
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Media/mediaservices/contosomedia/transforms/sampleEncodeAndVideoIndex",
"type": "Microsoft.Media/mediaservices/transforms",
"properties": {
- "created": "2019-10-10T22:38:01.5489351-07:00",
+ "created": "2020-09-25T03:52:05.9576676-07:00",
"description": "A sample Transform using the Standard Encoder with a built-in preset, as well as the Video Analyzer.",
- "lastModified": "2019-10-10T22:38:01.5489351-07:00",
+ "lastModified": "2020-09-25T03:52:05.9576676-07:00",
"outputs": [
{
"onError": "StopProcessingJob",
@@ -33,6 +33,7 @@
"relativePriority": "Normal",
"preset": {
"@odata.type": "#Microsoft.Media.VideoAnalyzerPreset",
+ "mode": "Standard",
"insightsToExtract": "AllInsights"
}
}
@@ -44,9 +45,9 @@
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Media/mediaservices/contosomedia/transforms/sampleEncode",
"type": "Microsoft.Media/mediaservices/transforms",
"properties": {
- "created": "2019-10-10T22:38:01.5489351-07:00",
+ "created": "2020-09-25T03:52:05.9576676-07:00",
"description": "A sample Transform using the Standard Encoder with a built in preset.",
- "lastModified": "2019-10-10T22:38:01.5489351-07:00",
+ "lastModified": "2020-09-25T03:52:05.9576676-07:00",
"outputs": [
{
"onError": "StopProcessingJob",
diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/transforms-list-all.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/transforms-list-all.json
index 7552799d9b22..7de974e9d589 100644
--- a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/transforms-list-all.json
+++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/transforms-list-all.json
@@ -14,9 +14,9 @@
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Media/mediaservices/contosomedia/transforms/sampleEncode",
"type": "Microsoft.Media/mediaservices/transforms",
"properties": {
- "created": "2019-10-10T22:38:01.0599386-07:00",
+ "created": "2020-09-25T03:52:05.0764655-07:00",
"description": "A sample Transform using the Standard Encoder with a built in preset.",
- "lastModified": "2019-10-10T22:38:01.0599386-07:00",
+ "lastModified": "2020-09-25T03:52:05.0764655-07:00",
"outputs": [
{
"onError": "StopProcessingJob",
@@ -34,9 +34,9 @@
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Media/mediaservices/contosomedia/transforms/sampleEncodeAndVideoIndex",
"type": "Microsoft.Media/mediaservices/transforms",
"properties": {
- "created": "2019-10-10T22:38:01.0649389-07:00",
+ "created": "2020-09-25T03:52:05.2126661-07:00",
"description": "A sample Transform using the Standard Encoder with a built-in preset, as well as the Video Analyzer.",
- "lastModified": "2019-10-10T22:38:01.0649389-07:00",
+ "lastModified": "2020-09-25T03:52:05.2126661-07:00",
"outputs": [
{
"onError": "StopProcessingJob",
@@ -51,6 +51,7 @@
"relativePriority": "Normal",
"preset": {
"@odata.type": "#Microsoft.Media.VideoAnalyzerPreset",
+ "mode": "Standard",
"insightsToExtract": "AllInsights"
}
}
diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/transforms-update.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/transforms-update.json
index 5a9a2096bae5..54ad41ca08d5 100644
--- a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/transforms-update.json
+++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/transforms-update.json
@@ -27,9 +27,9 @@
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Media/mediaservices/contosomedia/transforms/transformToUpdate",
"type": "Microsoft.Media/mediaservices/transforms",
"properties": {
- "created": "2019-10-10T22:38:02.3591446-07:00",
+ "created": "2020-09-25T03:52:06.6478518-07:00",
"description": "Example transform to illustrate update.",
- "lastModified": "2019-10-10T22:38:02.4291412-07:00",
+ "lastModified": "2020-09-25T03:52:06.6728521-07:00",
"outputs": [
{
"onError": "StopProcessingJob",
diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/streamingservice.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/streamingservice.json
index 3c7352ccae25..82f96aa41696 100644
--- a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/streamingservice.json
+++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/streamingservice.json
@@ -5,7 +5,7 @@
"swagger": "2.0",
"info": {
"title": "Azure Media Services",
- "description": "Streaming resource management client for Azure Media Services",
+ "description": "Live event and streaming endpoint management APIs",
"version": "2020-05-01"
},
"host": "management.azure.com",
@@ -32,8 +32,8 @@
"tags": [
"LiveEvents"
],
- "summary": "List Live Events",
- "description": "Lists the Live Events in the account.",
+ "summary": "List live events",
+ "description": "Lists all the live events in the account.",
"operationId": "LiveEvents_List",
"parameters": [
{
@@ -79,7 +79,7 @@
"LiveEvents"
],
"summary": "Get Live Event",
- "description": "Gets a Live Event.",
+ "description": "Gets properties of a live event.",
"operationId": "LiveEvents_Get",
"parameters": [
{
@@ -126,7 +126,7 @@
"LiveEvents"
],
"summary": "Create Live Event",
- "description": "Creates a Live Event.",
+ "description": "Creates a new live event.",
"operationId": "LiveEvents_Create",
"parameters": [
{
@@ -149,7 +149,7 @@
},
{
"name": "parameters",
- "description": "Live Event properties needed for creation.",
+ "description": "Live event properties needed for creation.",
"in": "body",
"required": true,
"schema": {
@@ -164,8 +164,8 @@
"$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.",
+ "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"
}
@@ -188,7 +188,7 @@
"tags": [
"LiveEvents"
],
- "description": "Updates a existing Live Event.",
+ "description": "Updates settings on an existing live event.",
"operationId": "LiveEvents_Update",
"parameters": [
{
@@ -208,7 +208,7 @@
},
{
"name": "parameters",
- "description": "Live Event properties needed for creation.",
+ "description": "Live event properties needed for patch.",
"in": "body",
"required": true,
"schema": {
@@ -248,7 +248,7 @@
"LiveEvents"
],
"summary": "Delete Live Event",
- "description": "Deletes a Live Event.",
+ "description": "Deletes a live event.",
"operationId": "LiveEvents_Delete",
"parameters": [
{
@@ -275,7 +275,7 @@
"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."
+ "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.",
@@ -292,13 +292,60 @@
}
}
},
+ "/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.json#/definitions/ApiError"
+ }
+ }
+ },
+ "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": "Starts an existing 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": [
{
@@ -345,7 +392,7 @@
"LiveEvents"
],
"summary": "Stop Live Event",
- "description": "Stops an existing Live Event.",
+ "description": "Stops a running live event.",
"operationId": "LiveEvents_Stop",
"parameters": [
{
@@ -401,7 +448,7 @@
"LiveEvents"
],
"summary": "Reset Live Event",
- "description": "Resets an existing 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": [
{
@@ -448,7 +495,7 @@
"LiveOutputs"
],
"summary": "List Live Outputs",
- "description": "Lists the Live Outputs in the Live Event.",
+ "description": "Lists the live outputs of a live event.",
"operationId": "LiveOutputs_List",
"parameters": [
{
@@ -497,7 +544,7 @@
"LiveOutputs"
],
"summary": "Get Live Output",
- "description": "Gets a Live Output.",
+ "description": "Gets a live output.",
"operationId": "LiveOutputs_Get",
"parameters": [
{
@@ -547,7 +594,7 @@
"LiveOutputs"
],
"summary": "Create Live Output",
- "description": "Creates a Live Output.",
+ "description": "Creates a new live output.",
"operationId": "LiveOutputs_Create",
"parameters": [
{
@@ -585,8 +632,8 @@
"$ref": "#/definitions/LiveOutput"
}
},
- "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.",
+ "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"
}
@@ -610,7 +657,7 @@
"LiveOutputs"
],
"summary": "Delete Live Output",
- "description": "Deletes a 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": [
{
@@ -640,7 +687,7 @@
"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."
+ "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.",
@@ -663,7 +710,7 @@
"StreamingEndpoints"
],
"summary": "List StreamingEndpoints",
- "description": "Lists the StreamingEndpoints in the account.",
+ "description": "Lists the streaming endpoints in the account.",
"operationId": "StreamingEndpoints_List",
"parameters": [
{
@@ -697,7 +744,7 @@
"nextLinkName": "@odata.nextLink"
},
"x-ms-examples": {
- "List all StreamingEndpoints": {
+ "List all streaming endpoints": {
"$ref": "examples/streamingendpoint-list-all.json"
}
}
@@ -709,7 +756,7 @@
"StreamingEndpoints"
],
"summary": "Get StreamingEndpoint",
- "description": "Gets a StreamingEndpoint.",
+ "description": "Gets a streaming endpoint.",
"operationId": "StreamingEndpoints_Get",
"parameters": [
{
@@ -746,7 +793,7 @@
}
},
"x-ms-examples": {
- "Get a StreamingEndpoint by name": {
+ "Get a streaming endpoint by name": {
"$ref": "examples/streamingendpoint-list-by-name.json"
}
}
@@ -756,7 +803,7 @@
"StreamingEndpoints"
],
"summary": "Create StreamingEndpoint",
- "description": "Creates a StreamingEndpoint.",
+ "description": "Creates a streaming endpoint.",
"operationId": "StreamingEndpoints_Create",
"parameters": [
{
@@ -779,7 +826,7 @@
},
{
"name": "parameters",
- "description": "StreamingEndpoint properties needed for creation.",
+ "description": "Streaming endpoint properties needed for creation.",
"in": "body",
"required": true,
"schema": {
@@ -794,8 +841,8 @@
"$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.",
+ "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"
}
@@ -809,7 +856,7 @@
},
"x-ms-long-running-operation": true,
"x-ms-examples": {
- "Create a StreamingEndpoint": {
+ "Create a streaming endpoint": {
"$ref": "examples/streamingendpoint-create.json"
}
}
@@ -819,7 +866,7 @@
"StreamingEndpoint"
],
"summary": "Update StreamingEndpoint",
- "description": "Updates a existing StreamingEndpoint.",
+ "description": "Updates a existing streaming endpoint.",
"operationId": "StreamingEndpoints_Update",
"parameters": [
{
@@ -839,7 +886,7 @@
},
{
"name": "parameters",
- "description": "StreamingEndpoint properties needed for creation.",
+ "description": "Streaming endpoint properties needed for creation.",
"in": "body",
"required": true,
"schema": {
@@ -869,7 +916,7 @@
},
"x-ms-long-running-operation": true,
"x-ms-examples": {
- "Update a StreamingEndpoint": {
+ "Update a streaming endpoint": {
"$ref": "examples/streamingendpoint-update.json"
}
}
@@ -879,7 +926,7 @@
"StreamingEndpoints"
],
"summary": "Delete StreamingEndpoint",
- "description": "Deletes a StreamingEndpoint.",
+ "description": "Deletes a streaming endpoint.",
"operationId": "StreamingEndpoints_Delete",
"parameters": [
{
@@ -917,7 +964,7 @@
},
"x-ms-long-running-operation": true,
"x-ms-examples": {
- "Delete a StreamingEndpoint": {
+ "Delete a streaming endpoint": {
"$ref": "examples/streamingendpoint-delete.json"
}
}
@@ -929,7 +976,7 @@
"StreamingEndpoints"
],
"summary": "Start StreamingEndpoint",
- "description": "Starts an existing StreamingEndpoint.",
+ "description": "Starts an existing streaming endpoint.",
"operationId": "StreamingEndpoints_Start",
"parameters": [
{
@@ -964,7 +1011,7 @@
},
"x-ms-long-running-operation": true,
"x-ms-examples": {
- "Start a StreamingEndpoint": {
+ "Start a streaming endpoint": {
"$ref": "examples/streamingendpoint-start.json"
}
}
@@ -976,7 +1023,7 @@
"StreamingEndpoints"
],
"summary": "Stop StreamingEndpoint",
- "description": "Stops an existing StreamingEndpoint.",
+ "description": "Stops an existing streaming endpoint.",
"operationId": "StreamingEndpoints_Stop",
"parameters": [
{
@@ -1011,7 +1058,7 @@
},
"x-ms-long-running-operation": true,
"x-ms-examples": {
- "Stop a StreamingEndpoint": {
+ "Stop a streaming endpoint": {
"$ref": "examples/streamingendpoint-stop.json"
}
}
@@ -1023,7 +1070,7 @@
"StreamingEndpoints"
],
"summary": "Scale StreamingEndpoint",
- "description": "Scales an existing StreamingEndpoint.",
+ "description": "Scales an existing streaming endpoint.",
"operationId": "StreamingEndpoints_Scale",
"parameters": [
{
@@ -1043,7 +1090,7 @@
},
{
"name": "parameters",
- "description": "StreamingEndpoint scale parameters",
+ "description": "Streaming endpoint scale parameters",
"in": "body",
"required": true,
"schema": {
@@ -1080,10 +1127,10 @@
"fragmentsPerTsSegment": {
"format": "int32",
"type": "integer",
- "description": "The amount of fragments per HTTP Live Streaming (HLS) segment."
+ "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": "The HLS configuration."
+ "description": "HTTP Live Streaming (HLS) packing setting for the live output."
},
"LiveOutputProperties": {
"required": [
@@ -1093,50 +1140,50 @@
"properties": {
"description": {
"type": "string",
- "description": "The description of the Live Output."
+ "description": "The description of the live output."
},
"assetName": {
"type": "string",
- "description": "The asset name."
+ "description": "The asset that the live output will write to."
},
"archiveWindowLength": {
"format": "duration",
"type": "string",
- "description": "ISO 8601 timespan duration of the archive window length. This is duration that customer want to retain the recorded content."
+ "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."
+ "description": "The manifest file name. If not provided, the service will generate one automatically."
},
"hls": {
"type": "object",
"$ref": "#/definitions/Hls",
- "description": "The HLS configuration."
+ "description": "HTTP Live Streaming (HLS) packing setting for the live output."
},
"outputSnapTime": {
"type": "integer",
"format": "int64",
- "description": "The output snapshot time."
+ "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 exact time the Live Output was created."
+ "description": "The creation time the live output."
},
"lastModified": {
"readOnly": true,
"format": "date-time",
"type": "string",
- "description": "The exact time the Live Output was last modified."
+ "description": "The time the live output was last modified."
},
"provisioningState": {
"readOnly": true,
"type": "string",
- "description": "The provisioning state of the Live Output."
+ "description": "The provisioning state of the live output."
},
"resourceState": {
- "description": "The resource state of the Live Output.",
+ "description": "The resource state of the live output.",
"readOnly": true,
"type": "string",
"enum": [
@@ -1146,18 +1193,32 @@
],
"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."
+ "description": "The JSON object that contains the properties required to create a live output."
},
"LiveOutput": {
"properties": {
"properties": {
"x-ms-client-flatten": true,
"$ref": "#/definitions/LiveOutputProperties",
- "description": "The Live Output properties."
+ "description": "Live output properties."
}
},
"allOf": [
@@ -1174,7 +1235,7 @@
"items": {
"$ref": "#/definitions/LiveOutput"
},
- "description": "The result of the List Live Output operation."
+ "description": "The result of the List LiveOutput operation."
},
"@odata.count": {
"type": "integer",
@@ -1183,7 +1244,7 @@
},
"@odata.nextLink": {
"type": "string",
- "description": "Th link to the next set of results. Not empty if value contains incomplete list of Live Outputs."
+ "description": "The link to the next set of results. Not empty if value contains incomplete list of live outputs."
}
},
"description": "The LiveOutput list result.",
@@ -1200,7 +1261,7 @@
"description": "The endpoint URL."
}
},
- "description": "The Live Event endpoint."
+ "description": "The live event endpoint."
},
"LiveEventInputAccessControl": {
"properties": {
@@ -1210,7 +1271,7 @@
"description": "The IP access control properties."
}
},
- "description": "The IP access control for Live Event Input."
+ "description": "The IP access control for live event input."
},
"LiveEventInput": {
"required": [
@@ -1219,38 +1280,48 @@
"properties": {
"streamingProtocol": {
"type": "string",
- "description": "The streaming protocol for the Live Event. This is specified at creation time and cannot be updated.",
+ "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": "The access control for LiveEvent Input."
+ "description": "Access control for live event input."
},
"keyFrameIntervalDuration": {
"type": "string",
- "description": "ISO 8601 timespan duration of the key frame interval duration."
+ "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."
+ "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 input endpoints for the live event."
}
},
- "description": "The Live Event input."
+ "description": "The live event input."
},
"IPRange": {
"properties": {
@@ -1290,7 +1361,7 @@
"description": "The IP access control properties."
}
},
- "description": "The IP access control for Live Event preview."
+ "description": "The IP access control for the live event preview endpoint."
},
"LiveEventPreview": {
"properties": {
@@ -1299,50 +1370,145 @@
"items": {
"$ref": "#/definitions/LiveEventEndpoint"
},
- "description": "The endpoints for preview."
+ "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 LiveEvent preview."
+ "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."
+ "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 LiveEvent preview. This value is specified at creation time and cannot be updated."
+ "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 StreamingLocator 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": "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": "The Live Event preview."
+ "description": "Live event preview settings."
},
"LiveEventEncoding": {
"properties": {
"encodingType": {
"type": "string",
- "description": "The encoding type for Live Event. This value is specified at creation time and cannot be updated. When encodingType is set to None, 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 bit rates or layers. See https://go.microsoft.com/fwlink/?linkid=2095101 for more information. The encodingType of Basic is obsolete – if specified, the service will treat this as a Standard Live Event.",
+ "description": "Live event type. When encodingType is set to None, 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",
- "Basic",
"Standard",
"Premium1080p"
],
"x-ms-enum": {
"name": "LiveEventEncodingType",
+ "values": [
+ {
+ "value": "None",
+ "description": "A contribution live encoder sends a multiple bitrate stream. The ingested stream passes through the live event without any further processing. It is also called the pass-through mode."
+ },
+ {
+ "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."
+ }
+ ],
"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": "The Live Event encoding."
+ "description": "Specifies the live event type and optional encoding settings for encoding live events."
+ },
+ "LiveEventInputTrackSelection": {
+ "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": {
+ "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": {
+ "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": {
"properties": {
@@ -1361,7 +1527,7 @@
"properties": {
"removeOutputsOnStop": {
"type": "boolean",
- "description": "The flag indicates if remove LiveOutputs on Stop."
+ "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."
@@ -1373,34 +1539,43 @@
"properties": {
"description": {
"type": "string",
- "description": "The Live Event description."
+ "description": "A description for the live event."
},
"input": {
"type": "object",
"$ref": "#/definitions/LiveEventInput",
- "description": "The Live Event input."
+ "description": "Live event input settings. It defines how the live event receives input from a contribution encoder."
},
"preview": {
"type": "object",
"$ref": "#/definitions/LiveEventPreview",
- "description": "The Live Event preview."
+ "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": "The Live Event encoding."
+ "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."
+ "description": "The provisioning state of the live event."
},
"resourceState": {
"readOnly": true,
"type": "string",
- "description": "The resource state of the Live Event.",
+ "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",
@@ -1408,17 +1583,51 @@
],
"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": "The Live Event access policies."
+ "description": "Live event cross site access policies."
},
"useStaticHostname": {
"type": "boolean",
- "description": "Specifies whether to use a vanity url with the Live Event. This value is specified at creation time and cannot be updated."
+ "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",
@@ -1430,32 +1639,42 @@
],
"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'."
+ "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 exact time the Live Event was created."
+ "description": "The creation time for the live event"
},
"lastModified": {
"readOnly": true,
"format": "date-time",
"type": "string",
- "description": "The exact time the Live Event was last modified."
+ "description": "The last modified time of the live event."
}
},
- "description": "The Live Event properties."
+ "description": "The live event properties."
},
"LiveEvent": {
"properties": {
"properties": {
"x-ms-client-flatten": true,
"$ref": "#/definitions/LiveEventProperties",
- "description": "The Live Event properties."
+ "description": "The live event properties."
}
},
"allOf": [
@@ -1463,7 +1682,7 @@
"$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/TrackedResource"
}
],
- "description": "The Live Event."
+ "description": "The live event."
},
"LiveEventListResult": {
"properties": {
@@ -1481,7 +1700,7 @@
},
"@odata.nextLink": {
"type": "string",
- "description": "Th link to the next set of results. Not empty if value contains incomplete list of Live Outputs."
+ "description": "The link to the next set of results. Not empty if value contains incomplete list of live outputs."
}
},
"description": "The LiveEvent list result.",
@@ -1527,17 +1746,17 @@
"ip": {
"type": "object",
"$ref": "#/definitions/IPAccessControl",
- "description": "The IP access control of the StreamingEndpoint."
+ "description": "The IP access control of the streaming endpoint."
}
},
- "description": "StreamingEndpoint access control definition."
+ "description": "Streaming endpoint access control definition."
},
"StreamingEntityScaleUnit": {
"properties": {
"scaleUnit": {
"type": "integer",
"format": "int32",
- "description": "The scale unit number of the StreamingEndpoint."
+ "description": "The scale unit number of the streaming endpoint."
}
},
"description": "scale units definition"
@@ -1549,21 +1768,21 @@
"properties": {
"description": {
"type": "string",
- "description": "The StreamingEndpoint description."
+ "description": "The streaming endpoint description."
},
"scaleUnits": {
"type": "integer",
"format": "int32",
- "description": "The number of scale units. Use the Scale operation to adjust this value."
+ "description": "The number of scale units. Use the Scale operation to adjust this value."
},
"availabilitySetName": {
"type": "string",
- "description": "The name of the AvailabilitySet used with this StreamingEndpoint for high availability streaming. This value can only be set at creation time."
+ "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 StreamingEndpoint."
+ "description": "The access control definition of the streaming endpoint."
},
"maxCacheAge": {
"type": "integer",
@@ -1576,12 +1795,12 @@
"type": "string",
"description": "custom host name"
},
- "description": "The custom host names of the StreamingEndpoint"
+ "description": "The custom host names of the streaming endpoint"
},
"hostName": {
"readOnly": true,
"type": "string",
- "description": "The StreamingEndpoint host name."
+ "description": "The streaming endpoint host name."
},
"cdnEnabled": {
"type": "boolean",
@@ -1598,12 +1817,12 @@
"provisioningState": {
"readOnly": true,
"type": "string",
- "description": "The provisioning state of the StreamingEndpoint."
+ "description": "The provisioning state of the streaming endpoint."
},
"resourceState": {
"readOnly": true,
"type": "string",
- "description": "The resource state of the StreamingEndpoint.",
+ "description": "The resource state of the streaming endpoint.",
"enum": [
"Stopped",
"Starting",
@@ -1614,13 +1833,39 @@
],
"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 StreamingEndpoint access policies."
+ "description": "The streaming endpoint access policies."
},
"freeTrialEndTime": {
"readOnly": true,
@@ -1632,23 +1877,23 @@
"readOnly": true,
"format": "date-time",
"type": "string",
- "description": "The exact time the StreamingEndpoint was created."
+ "description": "The exact time the streaming endpoint was created."
},
"lastModified": {
"readOnly": true,
"format": "date-time",
"type": "string",
- "description": "The exact time the StreamingEndpoint was last modified."
+ "description": "The exact time the streaming endpoint was last modified."
}
},
- "description": "The StreamingEndpoint properties."
+ "description": "The streaming endpoint properties."
},
"StreamingEndpoint": {
"properties": {
"properties": {
"x-ms-client-flatten": true,
"$ref": "#/definitions/StreamingEndpointProperties",
- "description": "The StreamingEndpoint properties."
+ "description": "The streaming endpoint properties."
}
},
"allOf": [
@@ -1656,7 +1901,7 @@
"$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/TrackedResource"
}
],
- "description": "The StreamingEndpoint."
+ "description": "The streaming endpoint."
},
"StreamingEndpointListResult": {
"properties": {
@@ -1674,10 +1919,10 @@
},
"@odata.nextLink": {
"type": "string",
- "description": "Th link to the next set of results. Not empty if value contains incomplete list of StreamingEndpoints."
+ "description": "The link to the next set of results. Not empty if value contains incomplete list of streaming endpoints."
}
},
- "description": "The StreamingEndpoint list result.",
+ "description": "The streaming endpoint list result.",
"title": "StreamingEndpointListResult"
}
},
@@ -1691,7 +1936,7 @@
},
"ApiVersion": {
"name": "api-version",
- "description": "The Version of the API to be used with the client request.",
+ "description": "The version of the API to be used with the client request.",
"in": "query",
"required": true,
"type": "string"
@@ -1714,7 +1959,7 @@
},
"LiveEventName": {
"name": "liveEventName",
- "description": "The name of the Live Event.",
+ "description": "The name of the live event, maximum length is 32.",
"in": "path",
"required": true,
"type": "string",
@@ -1733,7 +1978,7 @@
},
"LiveOutputName": {
"name": "liveOutputName",
- "description": "The name of the Live Output.",
+ "description": "The name of the live output.",
"in": "path",
"required": true,
"type": "string",
@@ -1744,7 +1989,7 @@
},
"StreamingEndpointName": {
"name": "streamingEndpointName",
- "description": "The name of the StreamingEndpoint.",
+ "description": "The name of the streaming endpoint, maximum length is 24.",
"in": "path",
"required": true,
"type": "string",
diff --git a/specification/monitor/resource-manager/Microsoft.Insights/preview/2020-05-01-preview/scheduledQueryRule_API.json b/specification/monitor/resource-manager/Microsoft.Insights/preview/2020-05-01-preview/scheduledQueryRule_API.json
index 278a0a1a97ce..6d30d3fa0ac5 100644
--- a/specification/monitor/resource-manager/Microsoft.Insights/preview/2020-05-01-preview/scheduledQueryRule_API.json
+++ b/specification/monitor/resource-manager/Microsoft.Insights/preview/2020-05-01-preview/scheduledQueryRule_API.json
@@ -511,7 +511,7 @@
"LessThanOrEqual"
],
"x-ms-enum": {
- "name": "Operator",
+ "name": "conditionOperator",
"modelAsString": true
},
"description": "The criteria operator."
@@ -526,11 +526,15 @@
"description": "The minimum number of violations required within the selected lookback time window required to raise an alert.",
"properties": {
"numberOfEvaluationPeriods": {
- "type": "number",
+ "type": "integer",
+ "format": "int64",
+ "default": 1,
"description": "The number of aggregated lookback points. The lookback time window is calculated based on the aggregation granularity (windowSize) and the selected number of aggregated points. Default value is 1"
},
"minFailingPeriodsToAlert": {
- "type": "number",
+ "type": "integer",
+ "format": "int64",
+ "default": 1,
"description": "The number of violations to trigger an alert. Should be smaller or equal to numberOfEvaluationPeriods. Default value is 1"
}
}
@@ -558,7 +562,7 @@
"Exclude"
],
"x-ms-enum": {
- "name": "operator",
+ "name": "dimensionOperator",
"modelAsString": true
}
},
diff --git a/specification/monitor/resource-manager/readme.python.md b/specification/monitor/resource-manager/readme.python.md
index 8d483156a925..92a777c5f250 100644
--- a/specification/monitor/resource-manager/readme.python.md
+++ b/specification/monitor/resource-manager/readme.python.md
@@ -30,6 +30,7 @@ Generate all API versions currently shipped for this package
```yaml $(multiapi) && !$(track2)
batch:
+ - tag: package-2020-05-preview
- tag: package-2020-01-01-preview-only
- tag: package-2019-10-17-preview-only
- tag: package-2019-06-01-only
@@ -54,6 +55,7 @@ batch:
```yaml $(multiapi) && $(track2)
clear-output-folder: true
batch:
+ - tag: package-2020-05-preview
- tag: package-2020-01-01-preview-only
- tag: package-2019-10-17-preview-only
- tag: package-2019-06-01-only
@@ -82,6 +84,19 @@ clear-output-folder: false
perform-load: false
```
+### Tag: package-2020-05-preview and python
+
+These settings apply only when `--tag=package-2020-05-preview --python` is specified on the command line.
+Please also specify `--python-sdks-folder=`.
+
+``` yaml $(tag) == 'package-2020-05-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-2020-01-01-preview-only and python
These settings apply only when `--tag=package-2020-01-01-preview-only --python` is specified on the command line.
diff --git a/specification/mysql/resource-manager/readme.md b/specification/mysql/resource-manager/readme.md
index f9385b4bab5a..db837a0271c1 100644
--- a/specification/mysql/resource-manager/readme.md
+++ b/specification/mysql/resource-manager/readme.md
@@ -161,7 +161,7 @@ csharp:
azure-arm: true
license-header: MICROSOFT_MIT_NO_VERSION
namespace: Microsoft.Azure.Management.MySQL
- output-folder: $(csharp-sdks-folder)/mysql/Microsoft.Azure.Management.MySQL/src/Generated
+ output-folder: $(csharp-sdks-folder)/mysql/Microsoft.Azure.Management.MySQL/src/mysql/Generated
clear-output-folder: true
```
diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-03-01/examples/Accounts_CreateOrUpdate.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-03-01/examples/Accounts_CreateOrUpdate.json
new file mode 100644
index 000000000000..65750af77fd9
--- /dev/null
+++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-03-01/examples/Accounts_CreateOrUpdate.json
@@ -0,0 +1,37 @@
+{
+ "parameters": {
+ "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9",
+ "resourceGroupName": "myRG",
+ "accountName": "account1",
+ "api-version": "2020-03-01",
+ "body": {
+ "location": "eastus",
+ "properties": {}
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1",
+ "name": "account1",
+ "type": "Microsoft.NetApp/netAppAccounts",
+ "location": "eastus",
+ "properties": {
+ "provisioningState": "Succeeded"
+ }
+ }
+ },
+ "201": {
+ "body": {
+ "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1",
+ "name": "account1",
+ "type": "Microsoft.NetApp/netAppAccounts",
+ "location": "eastus",
+ "properties": {
+ "provisioningState": "Succeeded"
+ }
+ }
+ },
+ "202": {}
+ }
+}
diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-03-01/examples/Accounts_Delete.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-03-01/examples/Accounts_Delete.json
new file mode 100644
index 000000000000..d3ed922d7abe
--- /dev/null
+++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-03-01/examples/Accounts_Delete.json
@@ -0,0 +1,12 @@
+{
+ "parameters": {
+ "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9",
+ "resourceGroupName": "myRG",
+ "accountName": "account1",
+ "api-version": "2020-03-01"
+ },
+ "responses": {
+ "202": {},
+ "204": {}
+ }
+}
diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-03-01/examples/Accounts_Get.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-03-01/examples/Accounts_Get.json
new file mode 100644
index 000000000000..fc3ad657110a
--- /dev/null
+++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-03-01/examples/Accounts_Get.json
@@ -0,0 +1,21 @@
+{
+ "parameters": {
+ "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9",
+ "resourceGroupName": "myRG",
+ "accountName": "account1",
+ "api-version": "2020-03-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1",
+ "name": "account1",
+ "type": "Microsoft.NetApp/netAppAccounts",
+ "location": "eastus",
+ "properties": {
+ "provisioningState": "Succeeded"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-03-01/examples/Accounts_List.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-03-01/examples/Accounts_List.json
new file mode 100644
index 000000000000..1372ddea5371
--- /dev/null
+++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-03-01/examples/Accounts_List.json
@@ -0,0 +1,24 @@
+{
+ "parameters": {
+ "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9",
+ "resourceGroupName": "myRG",
+ "api-version": "2020-03-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1",
+ "name": "account1",
+ "type": "Microsoft.NetApp/netAppAccounts",
+ "location": "eastus",
+ "properties": {
+ "provisioningState": "Succeeded"
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-03-01/examples/Accounts_Update.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-03-01/examples/Accounts_Update.json
new file mode 100644
index 000000000000..3425567d9702
--- /dev/null
+++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-03-01/examples/Accounts_Update.json
@@ -0,0 +1,34 @@
+{
+ "parameters": {
+ "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9",
+ "resourceGroupName": "myRG",
+ "accountName": "account1",
+ "api-version": "2020-03-01",
+ "body": {}
+ },
+ "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"
+ }
+ }
+ },
+ "202": {}
+ }
+}
diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-03-01/examples/CheckFilePathAvailability.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-03-01/examples/CheckFilePathAvailability.json
new file mode 100644
index 000000000000..dfb2fe1bdb44
--- /dev/null
+++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-03-01/examples/CheckFilePathAvailability.json
@@ -0,0 +1,19 @@
+{
+ "parameters": {
+ "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9",
+ "location": "eastus",
+ "api-version": "2020-03-01",
+ "body": {
+ "name": "my-exact-filepth",
+ "type": "netAppAccount/capacityPools/volume",
+ "resourceGroup": "myRG"
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "isAvailable": true
+ }
+ }
+ }
+}
diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-03-01/examples/CheckNameAvailability.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-03-01/examples/CheckNameAvailability.json
new file mode 100644
index 000000000000..f90726b03ed6
--- /dev/null
+++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-03-01/examples/CheckNameAvailability.json
@@ -0,0 +1,19 @@
+{
+ "parameters": {
+ "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9",
+ "location": "eastus",
+ "api-version": "2020-03-01",
+ "body": {
+ "name": "accName",
+ "type": "netAppAccount",
+ "resourceGroup": "myRG"
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "isAvailable": true
+ }
+ }
+ }
+}
diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-03-01/examples/Pools_CreateOrUpdate.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-03-01/examples/Pools_CreateOrUpdate.json
new file mode 100644
index 000000000000..11f8b0d4f6f0
--- /dev/null
+++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-03-01/examples/Pools_CreateOrUpdate.json
@@ -0,0 +1,47 @@
+{
+ "parameters": {
+ "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9",
+ "resourceGroupName": "myRG",
+ "accountName": "account1",
+ "poolName": "pool1",
+ "api-version": "2020-03-01",
+ "body": {
+ "location": "eastus",
+ "properties": {
+ "size": 4398046511104,
+ "serviceLevel": "Premium"
+ }
+ }
+ },
+ "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
+ }
+ }
+ },
+ "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
+ }
+ }
+ },
+ "202": {}
+ }
+}
diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-03-01/examples/Pools_Delete.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-03-01/examples/Pools_Delete.json
new file mode 100644
index 000000000000..6b576a1e9041
--- /dev/null
+++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-03-01/examples/Pools_Delete.json
@@ -0,0 +1,13 @@
+{
+ "parameters": {
+ "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9",
+ "resourceGroupName": "myRG",
+ "accountName": "account1",
+ "poolName": "pool1",
+ "api-version": "2020-03-01"
+ },
+ "responses": {
+ "204": {},
+ "202": {}
+ }
+}
diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-03-01/examples/Pools_Get.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-03-01/examples/Pools_Get.json
new file mode 100644
index 000000000000..dd356116356b
--- /dev/null
+++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-03-01/examples/Pools_Get.json
@@ -0,0 +1,25 @@
+{
+ "parameters": {
+ "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9",
+ "resourceGroupName": "myRG",
+ "accountName": "account1",
+ "poolName": "pool1",
+ "api-version": "2020-03-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1",
+ "name": "account1/pool1",
+ "type": "Microsoft.NetApp/netAppAccounts/capacityPools",
+ "location": "eastus",
+ "properties": {
+ "provisioningState": "Succeeded",
+ "poolId": "9760acf5-4638-11e7-9bdb-020073ca7778",
+ "serviceLevel": "Premium",
+ "size": 4398046511104
+ }
+ }
+ }
+ }
+}
diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-03-01/examples/Pools_List.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-03-01/examples/Pools_List.json
new file mode 100644
index 000000000000..d205131151e3
--- /dev/null
+++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-03-01/examples/Pools_List.json
@@ -0,0 +1,28 @@
+{
+ "parameters": {
+ "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9",
+ "resourceGroupName": "myRG",
+ "accountName": "account1",
+ "api-version": "2020-03-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1",
+ "name": "account1/pool1",
+ "type": "Microsoft.NetApp/netAppAccounts/capacityPools",
+ "location": "eastus",
+ "properties": {
+ "provisioningState": "Succeeded",
+ "poolId": "9760acf5-4638-11e7-9bdb-020073ca7778",
+ "serviceLevel": "Premium",
+ "size": 4398046511104
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-03-01/examples/Pools_Update.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-03-01/examples/Pools_Update.json
new file mode 100644
index 000000000000..4e1548ccde9d
--- /dev/null
+++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-03-01/examples/Pools_Update.json
@@ -0,0 +1,27 @@
+{
+ "parameters": {
+ "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9",
+ "resourceGroupName": "myRG",
+ "accountName": "account1",
+ "poolName": "pool1",
+ "api-version": "2020-03-01",
+ "body": {}
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1",
+ "name": "account1/pool1",
+ "type": "Microsoft.NetApp/netAppAccounts/capacityPools",
+ "location": "eastus",
+ "properties": {
+ "provisioningState": "Succeeded",
+ "poolId": "9760acf5-4638-11e7-9bdb-020073ca7778",
+ "serviceLevel": "Premium",
+ "size": 4398046511104
+ }
+ }
+ },
+ "202": {}
+ }
+}
diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-03-01/examples/Snapshots_Create.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-03-01/examples/Snapshots_Create.json
new file mode 100644
index 000000000000..065697aabeb0
--- /dev/null
+++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-03-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": "2020-03-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/2020-03-01/examples/Snapshots_Delete.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-03-01/examples/Snapshots_Delete.json
new file mode 100644
index 000000000000..8b92e2c7729e
--- /dev/null
+++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-03-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": "2020-03-01"
+ },
+ "responses": {
+ "204": {},
+ "202": {},
+ "200": {}
+ }
+}
diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-03-01/examples/Snapshots_Get.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-03-01/examples/Snapshots_Get.json
new file mode 100644
index 000000000000..dbb0546ddd94
--- /dev/null
+++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-03-01/examples/Snapshots_Get.json
@@ -0,0 +1,26 @@
+{
+ "parameters": {
+ "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9",
+ "resourceGroupName": "myRG",
+ "accountName": "account1",
+ "poolName": "pool1",
+ "volumeName": "volume1",
+ "snapshotName": "snapshot1",
+ "api-version": "2020-03-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1/snapshots/snapshot1",
+ "name": "account1/pool1/volume1/snapshot1",
+ "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/snapshots",
+ "location": "eastus",
+ "properties": {
+ "snapshotId": "9760acf5-4638-11e7-9bdb-020073ca3333",
+ "created": "2017-08-15T13:23:33Z",
+ "provisioningState": "Succeeded"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-03-01/examples/Snapshots_List.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-03-01/examples/Snapshots_List.json
new file mode 100644
index 000000000000..925b7d0ee759
--- /dev/null
+++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-03-01/examples/Snapshots_List.json
@@ -0,0 +1,29 @@
+{
+ "parameters": {
+ "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9",
+ "resourceGroupName": "myRG",
+ "accountName": "account1",
+ "poolName": "pool1",
+ "volumeName": "volume1",
+ "api-version": "2020-03-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1/snapshots/snapshot1",
+ "name": "account1/pool1/volume1/snapshot1",
+ "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/snapshots",
+ "location": "eastus",
+ "properties": {
+ "snapshotId": "9760acf5-4638-11e7-9bdb-020073ca3333",
+ "created": "2017-08-15T13:23:33Z",
+ "provisioningState": "Succeeded"
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-03-01/examples/Snapshots_Update.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-03-01/examples/Snapshots_Update.json
new file mode 100644
index 000000000000..a024ae1332e3
--- /dev/null
+++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-03-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": "2020-03-01",
+ "body": {}
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1/snapshots/snapshot1",
+ "name": "account1/pool1/volume1/snapshot1",
+ "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/snapshots",
+ "location": "eastus",
+ "properties": {
+ "snapshotId": "9760acf5-4638-11e7-9bdb-020073ca3333",
+ "created": "2017-08-15T13:23:33Z",
+ "provisioningState": "Succeeded"
+ }
+ }
+ },
+ "202": {}
+ }
+}
diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-03-01/examples/Volumes_AuthorizeReplication.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-03-01/examples/Volumes_AuthorizeReplication.json
new file mode 100644
index 000000000000..81f39323b64d
--- /dev/null
+++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-03-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": "2020-03-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/2020-03-01/examples/Volumes_BreakReplication.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-03-01/examples/Volumes_BreakReplication.json
new file mode 100644
index 000000000000..f3c0d9297ee2
--- /dev/null
+++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-03-01/examples/Volumes_BreakReplication.json
@@ -0,0 +1,18 @@
+{
+ "parameters": {
+ "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9",
+ "resourceGroupName": "myRG",
+ "accountName": "account1",
+ "poolName": "pool1",
+ "volumeName": "volume1",
+ "api-version": "2020-03-01",
+ "body": {
+ "location": "eastus",
+ "properties": {}
+ }
+ },
+ "responses": {
+ "200": {},
+ "202": {}
+ }
+}
diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-03-01/examples/Volumes_CreateOrUpdate.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-03-01/examples/Volumes_CreateOrUpdate.json
new file mode 100644
index 000000000000..1ca0f55adb33
--- /dev/null
+++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-03-01/examples/Volumes_CreateOrUpdate.json
@@ -0,0 +1,54 @@
+{
+ "parameters": {
+ "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9",
+ "resourceGroupName": "myRG",
+ "accountName": "account1",
+ "poolName": "pool1",
+ "volumeName": "volume1",
+ "api-version": "2020-03-01",
+ "body": {
+ "location": "eastus",
+ "properties": {
+ "creationToken": "my-unique-file-path",
+ "serviceLevel": "Premium",
+ "subnetId": "/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3",
+ "usageThreshold": 107374182400
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1",
+ "location": "eastus",
+ "name": "account1/pool1/volume1",
+ "properties": {
+ "fileSystemId": "9760acf5-4638-11e7-9bdb-020073ca7778",
+ "creationToken": "some-amazing-filepath",
+ "usageThreshold": 107374182400,
+ "serviceLevel": "Premium",
+ "provisioningState": "Succeeded",
+ "subnetId": "/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3"
+ },
+ "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",
+ "subnetId": "/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3"
+ },
+ "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes"
+ }
+ },
+ "202": {}
+ }
+}
diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-03-01/examples/Volumes_Delete.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-03-01/examples/Volumes_Delete.json
new file mode 100644
index 000000000000..28ba77ea3065
--- /dev/null
+++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-03-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": "2020-03-01"
+ },
+ "responses": {
+ "204": {},
+ "202": {}
+ }
+}
diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-03-01/examples/Volumes_DeleteReplication.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-03-01/examples/Volumes_DeleteReplication.json
new file mode 100644
index 000000000000..f3c0d9297ee2
--- /dev/null
+++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-03-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": "2020-03-01",
+ "body": {
+ "location": "eastus",
+ "properties": {}
+ }
+ },
+ "responses": {
+ "200": {},
+ "202": {}
+ }
+}
diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-03-01/examples/Volumes_Get.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-03-01/examples/Volumes_Get.json
new file mode 100644
index 000000000000..a4fbb40951f2
--- /dev/null
+++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-03-01/examples/Volumes_Get.json
@@ -0,0 +1,28 @@
+{
+ "parameters": {
+ "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9",
+ "resourceGroupName": "myRG",
+ "accountName": "account1",
+ "poolName": "pool1",
+ "volumeName": "volume1",
+ "api-version": "2020-03-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1",
+ "name": "account1/pool1/volume1",
+ "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes",
+ "location": "eastus",
+ "properties": {
+ "fileSystemId": "9760acf5-4638-11e7-9bdb-020073ca7778",
+ "creationToken": "some-amazing-filepath",
+ "usageThreshold": 107374182400,
+ "serviceLevel": "Premium",
+ "provisioningState": "Succeeded",
+ "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/2020-03-01/examples/Volumes_List.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-03-01/examples/Volumes_List.json
new file mode 100644
index 000000000000..073f568a4839
--- /dev/null
+++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-03-01/examples/Volumes_List.json
@@ -0,0 +1,31 @@
+{
+ "parameters": {
+ "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9",
+ "resourceGroupName": "myRG",
+ "accountName": "account1",
+ "poolName": "pool1",
+ "api-version": "2020-03-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1",
+ "name": "account1/pool1/volume1",
+ "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes",
+ "location": "eastus",
+ "properties": {
+ "fileSystemId": "9760acf5-4638-11e7-9bdb-020073ca7778",
+ "creationToken": "some-amazing-filepath",
+ "usageThreshold": 107374182400,
+ "serviceLevel": "Premium",
+ "provisioningState": "Succeeded",
+ "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/2020-03-01/examples/Volumes_ReplicationStatus.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-03-01/examples/Volumes_ReplicationStatus.json
new file mode 100644
index 000000000000..f6daa33d4f98
--- /dev/null
+++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-03-01/examples/Volumes_ReplicationStatus.json
@@ -0,0 +1,25 @@
+{
+ "parameters": {
+ "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9",
+ "resourceGroupName": "myRG",
+ "accountName": "account1",
+ "poolName": "pool1",
+ "volumeName": "volume1",
+ "api-version": "2020-03-01",
+ "body": {
+ "location": "eastus",
+ "properties": {}
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "healthy": true,
+ "relationshipStatus": "Idle",
+ "mirrorState": "Mirrored",
+ "totalProgress": "1048576",
+ "errorMessage": ""
+ }
+ }
+ }
+}
diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-03-01/examples/Volumes_ResyncReplication.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-03-01/examples/Volumes_ResyncReplication.json
new file mode 100644
index 000000000000..f3c0d9297ee2
--- /dev/null
+++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-03-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": "2020-03-01",
+ "body": {
+ "location": "eastus",
+ "properties": {}
+ }
+ },
+ "responses": {
+ "200": {},
+ "202": {}
+ }
+}
diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-03-01/examples/Volumes_Revert.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-03-01/examples/Volumes_Revert.json
new file mode 100644
index 000000000000..e42678bb908d
--- /dev/null
+++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-03-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": "2020-03-01",
+ "body": {
+ "snapshotId": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1/snapshots/snapshot1"
+ }
+ },
+ "responses": {
+ "200": {},
+ "202": {}
+ }
+}
diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-03-01/examples/Volumes_Update.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-03-01/examples/Volumes_Update.json
new file mode 100644
index 000000000000..9d563fb4c690
--- /dev/null
+++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-03-01/examples/Volumes_Update.json
@@ -0,0 +1,30 @@
+{
+ "parameters": {
+ "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9",
+ "resourceGroupName": "myRG",
+ "accountName": "account1",
+ "poolName": "pool1",
+ "volumeName": "volume1",
+ "api-version": "2020-03-01",
+ "body": {}
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroup/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1",
+ "name": "account1/pool1/volume1",
+ "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes",
+ "location": "eastus",
+ "properties": {
+ "fileSystemId": "9760acf5-4638-11e7-9bdb-020073ca7778",
+ "creationToken": "some-amazing-filepath",
+ "usageThreshold": 107374182400,
+ "serviceLevel": "Premium",
+ "provisioningState": "Succeeded",
+ "subnetId": "/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3"
+ }
+ }
+ },
+ "202": {}
+ }
+}
diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-03-01/netapp.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-03-01/netapp.json
new file mode 100644
index 000000000000..8836d436d991
--- /dev/null
+++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-03-01/netapp.json
@@ -0,0 +1,2771 @@
+{
+ "swagger": "2.0",
+ "info": {
+ "title": "Microsoft NetApp",
+ "description": "Microsoft NetApp Azure Resource Provider specification",
+ "version": "2020-03-01",
+ "x-ms-code-generation-settings": {
+ "name": "AzureNetAppFilesManagementClient"
+ }
+ },
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "schemes": [
+ "https"
+ ],
+ "host": "management.azure.com",
+ "security": [
+ {
+ "azure_auth": [
+ "user_impersonation"
+ ]
+ }
+ ],
+ "securityDefinitions": {
+ "azure_auth": {
+ "type": "oauth2",
+ "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize",
+ "flow": "implicit",
+ "description": "Azure Active Directory OAuth2 Flow",
+ "scopes": {
+ "user_impersonation": "impersonate your user account"
+ }
+ }
+ },
+ "paths": {
+ "/providers/Microsoft.NetApp/operations": {
+ "get": {
+ "tags": [
+ "Operations"
+ ],
+ "summary": "Describes the Resource Provider",
+ "description": "Lists all of the available Microsoft.NetApp Rest API operations",
+ "operationId": "Operations_List",
+ "parameters": [
+ {
+ "$ref": "#/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": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/ResourceNameAvailability"
+ }
+ },
+ "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/ResourceNameAvailabilityRequest"
+ },
+ "x-ms-client-flatten": true
+ },
+ {
+ "$ref": "#/parameters/SubscriptionId"
+ },
+ {
+ "$ref": "#/parameters/location"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/ResourceNameAvailability"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed."
+ }
+ },
+ "x-ms-examples": {
+ "CheckFilePathAvailability": {
+ "$ref": "examples/CheckFilePathAvailability.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": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "x-ms-pageable": {
+ "nextLinkName": null
+ },
+ "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": "#/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": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - account updated",
+ "schema": {
+ "$ref": "#/definitions/netAppAccount"
+ }
+ },
+ "201": {
+ "description": "Account created",
+ "schema": {
+ "$ref": "#/definitions/netAppAccount"
+ }
+ },
+ "202": {
+ "description": "Accepted -- Create, update or delete request accepted; operation will complete asynchronously"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed."
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "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": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "description": "Delete the specified NetApp account",
+ "responses": {
+ "202": {
+ "description": "Accepted -- Create, update or delete request accepted; operation will complete asynchronously"
+ },
+ "204": {
+ "description": "NoContent -- Resource does not exist."
+ },
+ "default": {
+ "description": "Error response describing why the operation failed."
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "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": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - account updated",
+ "schema": {
+ "$ref": "#/definitions/netAppAccount"
+ }
+ },
+ "201": {
+ "description": "OK - account created",
+ "schema": {
+ "$ref": "#/definitions/netAppAccount"
+ }
+ },
+ "202": {
+ "description": "Accepted -- Create, update or delete request accepted; operation will complete asynchronously"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed."
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "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": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "x-ms-pageable": {
+ "nextLinkName": null
+ },
+ "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": "#/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": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - pool updated",
+ "schema": {
+ "$ref": "#/definitions/capacityPool"
+ }
+ },
+ "201": {
+ "description": "Pool created",
+ "schema": {
+ "$ref": "#/definitions/capacityPool"
+ }
+ },
+ "202": {
+ "description": "Accepted -- Create, update or delete request accepted; operation will complete asynchronously"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed."
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "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": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/capacityPool"
+ }
+ },
+ "202": {
+ "description": "Accepted -- Create, update or delete request accepted; operation will complete asynchronously"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed."
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "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": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "202": {
+ "description": "Accepted -- Create, update or delete request accepted; operation will complete asynchronously"
+ },
+ "204": {
+ "description": "NoContent -- Resource does not exist."
+ },
+ "default": {
+ "description": "Error response describing why the operation failed."
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "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": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "tags": [
+ "Volumes"
+ ],
+ "operationId": "Volumes_List",
+ "x-ms-pageable": {
+ "nextLinkName": null
+ },
+ "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": "#/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": "#/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-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": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/volume"
+ }
+ },
+ "202": {
+ "description": "Accepted -- Create, update or delete request accepted; operation will complete asynchronously"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed."
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "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": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "202": {
+ "description": "Accepted -- Create, update or delete request accepted; operation will complete asynchronously"
+ },
+ "204": {
+ "description": "NoContent -- Resource does not exist."
+ },
+ "default": {
+ "description": "Error response describing why the operation failed."
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "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": "#/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-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": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - terminal state"
+ },
+ "202": {
+ "description": "Accepted"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed."
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "Volumes_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": "#/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 source to destination.",
+ "operationId": "Volumes_ResyncReplication",
+ "parameters": [
+ {
+ "$ref": "#/parameters/SubscriptionId"
+ },
+ {
+ "$ref": "#/parameters/ResourceGroup"
+ },
+ {
+ "$ref": "#/parameters/AccountName"
+ },
+ {
+ "$ref": "#/parameters/PoolName"
+ },
+ {
+ "$ref": "#/parameters/VolumeName"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - terminal state"
+ },
+ "202": {
+ "description": "Accepted"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed."
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "Volumes_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": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - terminal state"
+ },
+ "202": {
+ "description": "Accepted"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed."
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "Volumes_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": "#/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-examples": {
+ "Volumes_AuthorizeReplication": {
+ "$ref": "examples/Volumes_AuthorizeReplication.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": "#/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": "#/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": "#/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-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": "#/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-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": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK"
+ },
+ "202": {
+ "description": "Accepted -- Create, update or delete request accepted; operation will complete asynchronously"
+ },
+ "204": {
+ "description": "NoContent -- Resource does not exist."
+ },
+ "default": {
+ "description": "Error response describing why the operation failed."
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "Snapshots_Delete": {
+ "$ref": "examples/Snapshots_Delete.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."
+ }
+ }
+ },
+ "ResourceNameAvailability": {
+ "description": "Information regarding availability of a resource name.",
+ "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"
+ }
+ }
+ },
+ "netAppAccountList": {
+ "description": "List of NetApp account resources",
+ "type": "object",
+ "properties": {
+ "value": {
+ "type": "array",
+ "description": "Multiple NetApp accounts",
+ "items": {
+ "$ref": "#/definitions/netAppAccount"
+ }
+ }
+ }
+ },
+ "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
+ }
+ }
+ },
+ "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"
+ }
+ }
+ }
+ },
+ "activeDirectory": {
+ "description": "Active Directory",
+ "type": "object",
+ "properties": {
+ "activeDirectoryId": {
+ "type": "string",
+ "description": "Id of the Active Directory"
+ },
+ "username": {
+ "type": "string",
+ "description": "Username of Active Directory domain administrator"
+ },
+ "password": {
+ "type": "string",
+ "description": "Plain text password of Active Directory domain administrator"
+ },
+ "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"
+ },
+ "status": {
+ "type": "string",
+ "description": "Status of the Active Directory"
+ },
+ "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",
+ "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"
+ ]
+ }
+ }
+ }
+ },
+ "capacityPoolList": {
+ "description": "List of capacity pool resources",
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "List of Capacity pools",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/capacityPool"
+ }
+ }
+ }
+ },
+ "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"
+ }
+ }
+ },
+ "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
+ },
+ "serviceLevel": {
+ "title": "serviceLevel",
+ "type": "string",
+ "description": "The service level of the file system",
+ "enum": [
+ "Standard",
+ "Premium",
+ "Ultra"
+ ],
+ "x-ms-enum": {
+ "name": "PatchServiceLevel",
+ "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"
+ }
+ }
+ },
+ "volumeList": {
+ "description": "List of volume resources",
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "List of volumes",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/volume"
+ }
+ }
+ }
+ },
+ "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
+ }
+ }
+ },
+ "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",
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "example": [
+ "NFSv4.1"
+ ]
+ },
+ "provisioningState": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Azure lifecycle management"
+ },
+ "snapshotId": {
+ "title": "Snapshot ID",
+ "type": "string",
+ "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"
+ },
+ "baremetalTenantId": {
+ "title": "Baremetal Tenant ID",
+ "type": "string",
+ "readOnly": true,
+ "description": "Unique Baremetal Tenant 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": "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",
+ "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": {
+ "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",
+ "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)."
+ }
+ }
+ },
+ "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"
+ },
+ "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"
+ }
+ }
+ },
+ "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",
+ "weekly",
+ "monthly"
+ ],
+ "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"
+ }
+ }
+ }
+ }
+ }
+ },
+ "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"
+ },
+ "subnet": {
+ "title": "subnet",
+ "type": "string",
+ "description": "The subnet",
+ "example": "1.2.3.4"
+ },
+ "startIp": {
+ "title": "startIp",
+ "description": "The start of IPv4 address range to use when creating a new mount target",
+ "type": "string",
+ "example": "1.2.3.4"
+ },
+ "endIp": {
+ "title": "endIp",
+ "description": "The end of IPv4 address range to use when creating a new mount target",
+ "type": "string",
+ "example": "1.2.3.4"
+ },
+ "gateway": {
+ "title": "gateway",
+ "description": "The gateway of the IPv4 address range to use when creating a new mount target",
+ "type": "string",
+ "example": "1.2.3.4"
+ },
+ "netmask": {
+ "title": "netmask",
+ "description": "The netmask of the IPv4 address range to use when creating a new mount target",
+ "type": "string",
+ "example": "255.255.255.0"
+ },
+ "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"
+ }
+ }
+ },
+ "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"
+ }
+ }
+ }
+ },
+ "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"
+ },
+ "ApiVersionParameter": {
+ "name": "api-version",
+ "description": "Version of the API to be used with the client request.",
+ "in": "query",
+ "type": "string",
+ "required": true,
+ "default": "2020-03-01"
+ }
+ }
+}
diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-06-01/netapp.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-06-01/netapp.json
index f177ba0e6d73..ba1124809de5 100644
--- a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-06-01/netapp.json
+++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-06-01/netapp.json
@@ -4373,6 +4373,16 @@
"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",
diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-07-01/examples/Accounts_CreateOrUpdate.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-07-01/examples/Accounts_CreateOrUpdate.json
new file mode 100644
index 000000000000..8ab6f15abfd8
--- /dev/null
+++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-07-01/examples/Accounts_CreateOrUpdate.json
@@ -0,0 +1,51 @@
+{
+ "parameters": {
+ "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9",
+ "resourceGroupName": "myRG",
+ "accountName": "account1",
+ "api-version": "2020-07-01",
+ "body": {
+ "location": "eastus",
+ "properties": {
+ "activeDirectories": [
+ {
+ "site": "SiteName",
+ "username": "ad_user_name",
+ "password": "ad_password",
+ "domain": "10.10.10.3",
+ "dns": "10.10.10.3, 10.10.10.4",
+ "smbServerName": "SMBServer",
+ "organizationalUnit": "Engineering",
+ "aesEncryption": true,
+ "ldapSigning": 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"
+ }
+ }
+ },
+ "202": {}
+ }
+}
diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-07-01/examples/Accounts_Delete.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-07-01/examples/Accounts_Delete.json
new file mode 100644
index 000000000000..46ebb2a9fa02
--- /dev/null
+++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-07-01/examples/Accounts_Delete.json
@@ -0,0 +1,12 @@
+{
+ "parameters": {
+ "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9",
+ "resourceGroupName": "myRG",
+ "accountName": "account1",
+ "api-version": "2020-07-01"
+ },
+ "responses": {
+ "202": {},
+ "204": {}
+ }
+}
diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-07-01/examples/Accounts_Get.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-07-01/examples/Accounts_Get.json
new file mode 100644
index 000000000000..9dd366d4f0db
--- /dev/null
+++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-07-01/examples/Accounts_Get.json
@@ -0,0 +1,37 @@
+{
+ "parameters": {
+ "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9",
+ "resourceGroupName": "myRG",
+ "accountName": "account1",
+ "api-version": "2020-07-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1",
+ "name": "account1",
+ "type": "Microsoft.NetApp/netAppAccounts",
+ "location": "eastus",
+ "properties": {
+ "provisioningState": "Succeeded",
+ "activeDirectories": [
+ {
+ "site": "SiteName",
+ "activeDirectoryId": "02da3711-6c58-2d64-098a-e3af7afaf936",
+ "username": "ad_user_name",
+ "password": "****************",
+ "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/2020-07-01/examples/Accounts_List.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-07-01/examples/Accounts_List.json
new file mode 100644
index 000000000000..65d3123cde84
--- /dev/null
+++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-07-01/examples/Accounts_List.json
@@ -0,0 +1,24 @@
+{
+ "parameters": {
+ "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9",
+ "resourceGroupName": "myRG",
+ "api-version": "2020-07-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1",
+ "name": "account1",
+ "type": "Microsoft.NetApp/netAppAccounts",
+ "location": "eastus",
+ "properties": {
+ "provisioningState": "Succeeded"
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-07-01/examples/Accounts_Update.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-07-01/examples/Accounts_Update.json
new file mode 100644
index 000000000000..dab4940dc786
--- /dev/null
+++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-07-01/examples/Accounts_Update.json
@@ -0,0 +1,34 @@
+{
+ "parameters": {
+ "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9",
+ "resourceGroupName": "myRG",
+ "accountName": "account1",
+ "api-version": "2020-07-01",
+ "body": {}
+ },
+ "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"
+ }
+ }
+ },
+ "202": {}
+ }
+}
diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-07-01/examples/BackupPolicies_Create.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-07-01/examples/BackupPolicies_Create.json
new file mode 100644
index 000000000000..26494faa0055
--- /dev/null
+++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-07-01/examples/BackupPolicies_Create.json
@@ -0,0 +1,51 @@
+{
+ "parameters": {
+ "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9",
+ "resourceGroupName": "myRG",
+ "accountName": "account1",
+ "backupPolicyName": "backupPolicyName",
+ "api-version": "2020-07-01",
+ "body": {
+ "location": "westus",
+ "properties": {
+ "dailyBackupsToKeep": 10,
+ "weeklyBackupsToKeep": 10,
+ "monthlyBackupsToKeep": 10,
+ "enabled": true
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/backupPolocies/backupPolicyName",
+ "name": "account1/backupPolicyName",
+ "type": "Microsoft.NetApp/netAppAccounts/backupPolicies",
+ "location": "westus",
+ "properties": {
+ "dailyBackupsToKeep": 10,
+ "weeklyBackupsToKeep": 10,
+ "monthlyBackupsToKeep": 10,
+ "enabled": true,
+ "provisioningState": "creating"
+ }
+ }
+ },
+ "201": {
+ "body": {
+ "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/backupPolocies/backupPolicyName",
+ "name": "account1/backupPolicyName",
+ "type": "Microsoft.NetApp/netAppAccounts/backupPolicies",
+ "location": "westus",
+ "properties": {
+ "dailyBackupsToKeep": 10,
+ "weeklyBackupsToKeep": 10,
+ "monthlyBackupsToKeep": 10,
+ "enabled": true,
+ "provisioningState": "creating"
+ }
+ }
+ },
+ "202": {}
+ }
+}
diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-07-01/examples/BackupPolicies_Delete.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-07-01/examples/BackupPolicies_Delete.json
new file mode 100644
index 000000000000..30f7901d9a6f
--- /dev/null
+++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-07-01/examples/BackupPolicies_Delete.json
@@ -0,0 +1,14 @@
+{
+ "parameters": {
+ "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9",
+ "resourceGroupName": "resourceGroup",
+ "accountName": "accountName",
+ "backupPolicyName": "backupPolicyName",
+ "api-version": "2020-07-01"
+ },
+ "responses": {
+ "204": {},
+ "202": {},
+ "200": {}
+ }
+}
diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-07-01/examples/BackupPolicies_Get.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-07-01/examples/BackupPolicies_Get.json
new file mode 100644
index 000000000000..37d9ed7be02e
--- /dev/null
+++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-07-01/examples/BackupPolicies_Get.json
@@ -0,0 +1,35 @@
+{
+ "parameters": {
+ "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9",
+ "resourceGroupName": "myRG",
+ "accountName": "account1",
+ "backupPolicyName": "backupPolicyName",
+ "api-version": "2020-07-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/backupPolocies/backupPolicyName",
+ "name": "account1/backupPolicyName",
+ "type": "Microsoft.NetApp/netAppAccounts/backupPolicies",
+ "location": "eastus",
+ "properties": {
+ "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/2020-07-01/examples/BackupPolicies_List.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-07-01/examples/BackupPolicies_List.json
new file mode 100644
index 000000000000..580a578f324b
--- /dev/null
+++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-07-01/examples/BackupPolicies_List.json
@@ -0,0 +1,31 @@
+{
+ "parameters": {
+ "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9",
+ "resourceGroupName": "myRG",
+ "accountName": "account1",
+ "api-version": "2020-07-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/backupPolocies/backupPolicy1",
+ "name": "account1/backupPolicy1",
+ "type": "Microsoft.NetApp/netAppAccounts/backupPolicies",
+ "location": "eastus",
+ "properties": {
+ "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/2020-07-01/examples/BackupPolicies_Update.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-07-01/examples/BackupPolicies_Update.json
new file mode 100644
index 000000000000..1aa5aa449955
--- /dev/null
+++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-07-01/examples/BackupPolicies_Update.json
@@ -0,0 +1,44 @@
+{
+ "parameters": {
+ "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9",
+ "resourceGroupName": "myRG",
+ "accountName": "account1",
+ "backupPolicyName": "backupPolicyName",
+ "api-version": "2020-07-01",
+ "body": {
+ "location": "westus",
+ "properties": {
+ "dailyBackupsToKeep": 5,
+ "weeklyBackupsToKeep": 10,
+ "monthlyBackupsToKeep": 10,
+ "enabled": false
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/backupPolocies/backupPolicyName",
+ "name": "account1/backupPolicyName",
+ "type": "Microsoft.NetApp/netAppAccounts/backupPolicies",
+ "location": "westus",
+ "properties": {
+ "provisioningState": "Succeeded",
+ "dailyBackupsToKeep": 5,
+ "weeklyBackupsToKeep": 10,
+ "monthlyBackupsToKeep": 10,
+ "yearlyBackupsToKeep": 0,
+ "volumesAssigned": 1,
+ "enabled": false,
+ "volumeBackups": [
+ {
+ "volumeName": "volume 1",
+ "backupsCount": 5,
+ "policyEnabled": true
+ }
+ ]
+ }
+ }
+ }
+ }
+}
diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-07-01/examples/Backups_Account_Delete.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-07-01/examples/Backups_Account_Delete.json
new file mode 100644
index 000000000000..e0db24d96c3c
--- /dev/null
+++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-07-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": "2020-07-01"
+ },
+ "responses": {
+ "204": {},
+ "202": {},
+ "200": {}
+ }
+}
diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-07-01/examples/Backups_Account_Get.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-07-01/examples/Backups_Account_Get.json
new file mode 100644
index 000000000000..bd4a0ae81d1a
--- /dev/null
+++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-07-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": "2020-07-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": "adhoc"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-07-01/examples/Backups_Account_List.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-07-01/examples/Backups_Account_List.json
new file mode 100644
index 000000000000..350fdb5cbe21
--- /dev/null
+++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-07-01/examples/Backups_Account_List.json
@@ -0,0 +1,29 @@
+{
+ "parameters": {
+ "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9",
+ "resourceGroupName": "myRG",
+ "accountName": "account1",
+ "api-version": "2020-07-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": "adhoc"
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-07-01/examples/Backups_Create.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-07-01/examples/Backups_Create.json
new file mode 100644
index 000000000000..79ebda912e3d
--- /dev/null
+++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-07-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": "2020-07-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": "adhoc"
+ }
+ }
+ },
+ "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": "adhoc"
+ }
+ }
+ },
+ "202": {}
+ }
+}
diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-07-01/examples/Backups_Delete.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-07-01/examples/Backups_Delete.json
new file mode 100644
index 000000000000..7c72de17fb06
--- /dev/null
+++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-07-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": "2020-07-01"
+ },
+ "responses": {
+ "204": {},
+ "202": {},
+ "200": {}
+ }
+}
diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-07-01/examples/Backups_Get.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-07-01/examples/Backups_Get.json
new file mode 100644
index 000000000000..73d6e3b5793c
--- /dev/null
+++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-07-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": "2020-07-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": "adhoc"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-07-01/examples/Backups_List.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-07-01/examples/Backups_List.json
new file mode 100644
index 000000000000..715084e053f5
--- /dev/null
+++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-07-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": "2020-07-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": "adhoc"
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-07-01/examples/Backups_Update.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-07-01/examples/Backups_Update.json
new file mode 100644
index 000000000000..d8eb8c1701a3
--- /dev/null
+++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-07-01/examples/Backups_Update.json
@@ -0,0 +1,29 @@
+{
+ "parameters": {
+ "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9",
+ "resourceGroupName": "myRG",
+ "accountName": "account1",
+ "poolName": "pool1",
+ "volumeName": "volume1",
+ "backupName": "backup1",
+ "api-version": "2020-07-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": "adhoc"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-07-01/examples/CheckFilePathAvailability.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-07-01/examples/CheckFilePathAvailability.json
new file mode 100644
index 000000000000..a64beb2fb14e
--- /dev/null
+++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-07-01/examples/CheckFilePathAvailability.json
@@ -0,0 +1,19 @@
+{
+ "parameters": {
+ "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9",
+ "location": "eastus",
+ "api-version": "2020-07-01",
+ "body": {
+ "name": "my-exact-filepth",
+ "type": "netAppAccount/capacityPools/volume",
+ "resourceGroup": "myRG"
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "isAvailable": true
+ }
+ }
+ }
+}
diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-07-01/examples/CheckNameAvailability.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-07-01/examples/CheckNameAvailability.json
new file mode 100644
index 000000000000..ada44af04be2
--- /dev/null
+++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-07-01/examples/CheckNameAvailability.json
@@ -0,0 +1,19 @@
+{
+ "parameters": {
+ "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9",
+ "location": "eastus",
+ "api-version": "2020-07-01",
+ "body": {
+ "name": "accName",
+ "type": "netAppAccount",
+ "resourceGroup": "myRG"
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "isAvailable": true
+ }
+ }
+ }
+}
diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-07-01/examples/CheckQuotaAvailability.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-07-01/examples/CheckQuotaAvailability.json
new file mode 100644
index 000000000000..18bb30338cc5
--- /dev/null
+++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-07-01/examples/CheckQuotaAvailability.json
@@ -0,0 +1,19 @@
+{
+ "parameters": {
+ "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9",
+ "location": "eastus",
+ "api-version": "2020-07-01",
+ "body": {
+ "name": "resource1",
+ "type": "Microsoft.NetApp/netAppAccounts",
+ "resourceGroup": "myRG"
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "isAvailable": true
+ }
+ }
+ }
+}
diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-07-01/examples/Pools_CreateOrUpdate.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-07-01/examples/Pools_CreateOrUpdate.json
new file mode 100644
index 000000000000..df4f0db01352
--- /dev/null
+++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-07-01/examples/Pools_CreateOrUpdate.json
@@ -0,0 +1,52 @@
+{
+ "parameters": {
+ "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9",
+ "resourceGroupName": "myRG",
+ "accountName": "account1",
+ "poolName": "pool1",
+ "api-version": "2020-07-01",
+ "body": {
+ "location": "eastus",
+ "properties": {
+ "size": 4398046511104,
+ "serviceLevel": "Premium",
+ "qosType": "Auto"
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1",
+ "name": "account1/pool1",
+ "type": "Microsoft.NetApp/netAppAccounts/capacityPools",
+ "location": "eastus",
+ "properties": {
+ "provisioningState": "Succeeded",
+ "poolId": "9760acf5-4638-11e7-9bdb-020073ca7778",
+ "serviceLevel": "Premium",
+ "size": 4398046511104,
+ "qosType": "Auto",
+ "totalThroughputMibps": 281.474
+ }
+ }
+ },
+ "201": {
+ "body": {
+ "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1",
+ "name": "account1/pool1",
+ "type": "Microsoft.NetApp/netAppAccounts/capacityPools",
+ "location": "eastus",
+ "properties": {
+ "provisioningState": "Succeeded",
+ "poolId": "9760acf5-4638-11e7-9bdb-020073ca7778",
+ "serviceLevel": "Premium",
+ "size": 4398046511104,
+ "qosType": "Auto",
+ "totalThroughputMibps": 281.474
+ }
+ }
+ },
+ "202": {}
+ }
+}
diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-07-01/examples/Pools_Delete.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-07-01/examples/Pools_Delete.json
new file mode 100644
index 000000000000..6f5570783402
--- /dev/null
+++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-07-01/examples/Pools_Delete.json
@@ -0,0 +1,13 @@
+{
+ "parameters": {
+ "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9",
+ "resourceGroupName": "myRG",
+ "accountName": "account1",
+ "poolName": "pool1",
+ "api-version": "2020-07-01"
+ },
+ "responses": {
+ "204": {},
+ "202": {}
+ }
+}
diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-07-01/examples/Pools_Get.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-07-01/examples/Pools_Get.json
new file mode 100644
index 000000000000..ce0bf1b111ab
--- /dev/null
+++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-07-01/examples/Pools_Get.json
@@ -0,0 +1,28 @@
+{
+ "parameters": {
+ "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9",
+ "resourceGroupName": "myRG",
+ "accountName": "account1",
+ "poolName": "pool1",
+ "api-version": "2020-07-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1",
+ "name": "account1/pool1",
+ "type": "Microsoft.NetApp/netAppAccounts/capacityPools",
+ "location": "eastus",
+ "properties": {
+ "provisioningState": "Succeeded",
+ "poolId": "9760acf5-4638-11e7-9bdb-020073ca7778",
+ "serviceLevel": "Premium",
+ "size": 4398046511104,
+ "qosType": "Manual",
+ "totalThroughputMibps": 281.474,
+ "utilizedThroughputMibps": 100.47
+ }
+ }
+ }
+ }
+}
diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-07-01/examples/Pools_List.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-07-01/examples/Pools_List.json
new file mode 100644
index 000000000000..ef6111ad37ed
--- /dev/null
+++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-07-01/examples/Pools_List.json
@@ -0,0 +1,30 @@
+{
+ "parameters": {
+ "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9",
+ "resourceGroupName": "myRG",
+ "accountName": "account1",
+ "api-version": "2020-07-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1",
+ "name": "account1/pool1",
+ "type": "Microsoft.NetApp/netAppAccounts/capacityPools",
+ "location": "eastus",
+ "properties": {
+ "provisioningState": "Succeeded",
+ "poolId": "9760acf5-4638-11e7-9bdb-020073ca7778",
+ "serviceLevel": "Premium",
+ "size": 4398046511104,
+ "qosType": "Auto",
+ "totalThroughputMibps": 281.474
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-07-01/examples/Pools_Update.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-07-01/examples/Pools_Update.json
new file mode 100644
index 000000000000..a830254d3831
--- /dev/null
+++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-07-01/examples/Pools_Update.json
@@ -0,0 +1,30 @@
+{
+ "parameters": {
+ "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9",
+ "resourceGroupName": "myRG",
+ "accountName": "account1",
+ "poolName": "pool1",
+ "api-version": "2020-07-01",
+ "body": {}
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1",
+ "name": "account1/pool1",
+ "type": "Microsoft.NetApp/netAppAccounts/capacityPools",
+ "location": "eastus",
+ "properties": {
+ "provisioningState": "Succeeded",
+ "poolId": "9760acf5-4638-11e7-9bdb-020073ca7778",
+ "serviceLevel": "Premium",
+ "size": 4398046511104,
+ "qosType": "Manual",
+ "totalThroughputMibps": 281.474,
+ "utilizedThroughputMibps": 100.47
+ }
+ }
+ },
+ "202": {}
+ }
+}
diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-07-01/examples/SnapshotPolicies_Create.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-07-01/examples/SnapshotPolicies_Create.json
new file mode 100644
index 000000000000..2deb179e6823
--- /dev/null
+++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-07-01/examples/SnapshotPolicies_Create.json
@@ -0,0 +1,105 @@
+{
+ "parameters": {
+ "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9",
+ "resourceGroupName": "myRG",
+ "accountName": "account1",
+ "snapshotPolicyName": "snapshotPolicyName",
+ "api-version": "2020-07-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": {
+ "name": "sdk-net-tests-snapshotPolicy-1",
+ "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": {
+ "name": "sdk-net-tests-snapshotPolicy-1",
+ "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/2020-07-01/examples/SnapshotPolicies_Delete.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-07-01/examples/SnapshotPolicies_Delete.json
new file mode 100644
index 000000000000..129587be3f2f
--- /dev/null
+++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-07-01/examples/SnapshotPolicies_Delete.json
@@ -0,0 +1,14 @@
+{
+ "parameters": {
+ "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9",
+ "resourceGroupName": "resourceGroup",
+ "accountName": "accountName",
+ "snapshotPolicyName": "snapshotPolicyName",
+ "api-version": "2020-07-01"
+ },
+ "responses": {
+ "204": {},
+ "202": {},
+ "200": {}
+ }
+}
diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-07-01/examples/SnapshotPolicies_Get.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-07-01/examples/SnapshotPolicies_Get.json
new file mode 100644
index 000000000000..b3b124f91a1c
--- /dev/null
+++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-07-01/examples/SnapshotPolicies_Get.json
@@ -0,0 +1,45 @@
+{
+ "parameters": {
+ "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9",
+ "resourceGroupName": "myRG",
+ "accountName": "account1",
+ "snapshotPolicyName": "snapshotPolicyName",
+ "api-version": "2020-07-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/snapshotPolicies/snapshotPolicy1",
+ "name": "account1/snapshotPolicy1",
+ "type": "Microsoft.NetApp/netAppAccounts/snapshotPolicies",
+ "location": "eastus",
+ "properties": {
+ "name": "sdk-net-tests-snapshotPolicy-1",
+ "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/2020-07-01/examples/SnapshotPolicies_List.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-07-01/examples/SnapshotPolicies_List.json
new file mode 100644
index 000000000000..b72951f45bb3
--- /dev/null
+++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-07-01/examples/SnapshotPolicies_List.json
@@ -0,0 +1,48 @@
+{
+ "parameters": {
+ "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9",
+ "resourceGroupName": "myRG",
+ "accountName": "account1",
+ "api-version": "2020-07-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/snapshotPolicies/snapshotPolicy1",
+ "name": "account1/snapshotPolicy1",
+ "location": "eastus",
+ "type": "Microsoft.NetApp/netAppAccounts/snapshotPolicies",
+ "properties": {
+ "name": "sdk-net-tests-snapshotPolicy-1",
+ "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/2020-07-01/examples/SnapshotPolicies_ListVolumes.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-07-01/examples/SnapshotPolicies_ListVolumes.json
new file mode 100644
index 000000000000..554ff92c4a4c
--- /dev/null
+++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-07-01/examples/SnapshotPolicies_ListVolumes.json
@@ -0,0 +1,24 @@
+{
+ "parameters": {
+ "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9",
+ "resourceGroupName": "myRG",
+ "accountName": "account1",
+ "snapshotPolicyName": "snapshotPolicyName",
+ "api-version": "2020-07-01",
+ "body": {
+ "location": "eastus",
+ "properties": {}
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1"
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-07-01/examples/SnapshotPolicies_Update.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-07-01/examples/SnapshotPolicies_Update.json
new file mode 100644
index 000000000000..960d2e0c8fb3
--- /dev/null
+++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-07-01/examples/SnapshotPolicies_Update.json
@@ -0,0 +1,72 @@
+{
+ "parameters": {
+ "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9",
+ "resourceGroupName": "myRG",
+ "accountName": "account1",
+ "snapshotPolicyName": "snapshotPolicyName",
+ "api-version": "2020-07-01",
+ "body": {
+ "location": "eastus",
+ "properties": {
+ "enabled": true,
+ "hourlySchedule": {
+ "snapshotsToKeep": 2,
+ "minute": 50
+ },
+ "dailySchedule": {
+ "snapshotsToKeep": 4,
+ "hour": 14,
+ "minute": 30
+ },
+ "weeklySchedule": {
+ "snapshotsToKeep": 3,
+ "day": "Wednesday",
+ "hour": 14,
+ "minute": 45
+ },
+ "monthlySchedule": {
+ "snapshotsToKeep": 5,
+ "daysOfMonth": "10,11,12",
+ "hour": 14,
+ "minute": 15
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/snapshotPolicies/snapshotPolicy1",
+ "name": "account1/snapshotPolicy1",
+ "type": "Microsoft.NetApp/netAppAccounts/snapshotPolicies",
+ "location": "eastus",
+ "properties": {
+ "name": "sdk-net-tests-snapshotPolicy-1",
+ "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/2020-07-01/examples/Snapshots_Create.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-07-01/examples/Snapshots_Create.json
new file mode 100644
index 000000000000..61dce860e7dc
--- /dev/null
+++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-07-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": "2020-07-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/2020-07-01/examples/Snapshots_Delete.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-07-01/examples/Snapshots_Delete.json
new file mode 100644
index 000000000000..25ef8abc8a81
--- /dev/null
+++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-07-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": "2020-07-01"
+ },
+ "responses": {
+ "204": {},
+ "202": {},
+ "200": {}
+ }
+}
diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-07-01/examples/Snapshots_Get.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-07-01/examples/Snapshots_Get.json
new file mode 100644
index 000000000000..3e2d9a4a613e
--- /dev/null
+++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-07-01/examples/Snapshots_Get.json
@@ -0,0 +1,26 @@
+{
+ "parameters": {
+ "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9",
+ "resourceGroupName": "myRG",
+ "accountName": "account1",
+ "poolName": "pool1",
+ "volumeName": "volume1",
+ "snapshotName": "snapshot1",
+ "api-version": "2020-07-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1/snapshots/snapshot1",
+ "name": "account1/pool1/volume1/snapshot1",
+ "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/snapshots",
+ "location": "eastus",
+ "properties": {
+ "snapshotId": "9760acf5-4638-11e7-9bdb-020073ca3333",
+ "created": "2017-08-15T13:23:33Z",
+ "provisioningState": "Succeeded"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-07-01/examples/Snapshots_List.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-07-01/examples/Snapshots_List.json
new file mode 100644
index 000000000000..15c333a1e07a
--- /dev/null
+++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-07-01/examples/Snapshots_List.json
@@ -0,0 +1,29 @@
+{
+ "parameters": {
+ "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9",
+ "resourceGroupName": "myRG",
+ "accountName": "account1",
+ "poolName": "pool1",
+ "volumeName": "volume1",
+ "api-version": "2020-07-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1/snapshots/snapshot1",
+ "name": "account1/pool1/volume1/snapshot1",
+ "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/snapshots",
+ "location": "eastus",
+ "properties": {
+ "snapshotId": "9760acf5-4638-11e7-9bdb-020073ca3333",
+ "created": "2017-08-15T13:23:33Z",
+ "provisioningState": "Succeeded"
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-07-01/examples/Snapshots_Update.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-07-01/examples/Snapshots_Update.json
new file mode 100644
index 000000000000..9f6e9b52fc6b
--- /dev/null
+++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-07-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": "2020-07-01",
+ "body": {}
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1/snapshots/snapshot1",
+ "name": "account1/pool1/volume1/snapshot1",
+ "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/snapshots",
+ "location": "eastus",
+ "properties": {
+ "snapshotId": "9760acf5-4638-11e7-9bdb-020073ca3333",
+ "created": "2017-08-15T13:23:33Z",
+ "provisioningState": "Succeeded"
+ }
+ }
+ },
+ "202": {}
+ }
+}
diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-07-01/examples/Vaults_List.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-07-01/examples/Vaults_List.json
new file mode 100644
index 000000000000..626baa820efe
--- /dev/null
+++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-07-01/examples/Vaults_List.json
@@ -0,0 +1,25 @@
+{
+ "parameters": {
+ "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9",
+ "resourceGroupName": "myRG",
+ "accountName": "account1",
+ "api-version": "2020-07-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/2020-07-01/examples/Volumes_AuthorizeReplication.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-07-01/examples/Volumes_AuthorizeReplication.json
new file mode 100644
index 000000000000..7ab437c49d4f
--- /dev/null
+++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-07-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": "2020-07-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/2020-07-01/examples/Volumes_BreakReplication.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-07-01/examples/Volumes_BreakReplication.json
new file mode 100644
index 000000000000..41063e18e1b4
--- /dev/null
+++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-07-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": "2020-07-01",
+ "body": {
+ "forceBreakReplication": false
+ }
+ },
+ "responses": {
+ "200": {},
+ "202": {}
+ }
+}
diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-07-01/examples/Volumes_CreateOrUpdate.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-07-01/examples/Volumes_CreateOrUpdate.json
new file mode 100644
index 000000000000..6d9a5fb096d7
--- /dev/null
+++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-07-01/examples/Volumes_CreateOrUpdate.json
@@ -0,0 +1,57 @@
+{
+ "parameters": {
+ "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9",
+ "resourceGroupName": "myRG",
+ "accountName": "account1",
+ "poolName": "pool1",
+ "volumeName": "volume1",
+ "api-version": "2020-07-01",
+ "body": {
+ "location": "eastus",
+ "properties": {
+ "creationToken": "my-unique-file-path",
+ "serviceLevel": "Premium",
+ "subnetId": "/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3",
+ "usageThreshold": 107374182400,
+ "throughputMibps": 128.0
+ }
+ }
+ },
+ "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.0,
+ "subnetId": "/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3"
+ },
+ "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.0,
+ "subnetId": "/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3"
+ },
+ "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes"
+ }
+ },
+ "202": {}
+ }
+}
diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-07-01/examples/Volumes_Delete.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-07-01/examples/Volumes_Delete.json
new file mode 100644
index 000000000000..7bfa9748ebf4
--- /dev/null
+++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-07-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": "2020-07-01"
+ },
+ "responses": {
+ "204": {},
+ "202": {}
+ }
+}
diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-07-01/examples/Volumes_DeleteReplication.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-07-01/examples/Volumes_DeleteReplication.json
new file mode 100644
index 000000000000..0f375e24142b
--- /dev/null
+++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-07-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": "2020-07-01",
+ "body": {
+ "location": "eastus",
+ "properties": {}
+ }
+ },
+ "responses": {
+ "200": {},
+ "202": {}
+ }
+}
diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-07-01/examples/Volumes_Get.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-07-01/examples/Volumes_Get.json
new file mode 100644
index 000000000000..97524115fbd8
--- /dev/null
+++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-07-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": "2020-07-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1",
+ "name": "account1/pool1/volume1",
+ "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes",
+ "location": "eastus",
+ "properties": {
+ "fileSystemId": "9760acf5-4638-11e7-9bdb-020073ca7778",
+ "creationToken": "some-amazing-filepath",
+ "usageThreshold": 107374182400,
+ "serviceLevel": "Premium",
+ "provisioningState": "Succeeded",
+ "throughputMibps": 128.0,
+ "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/2020-07-01/examples/Volumes_List.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-07-01/examples/Volumes_List.json
new file mode 100644
index 000000000000..307f96de4634
--- /dev/null
+++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-07-01/examples/Volumes_List.json
@@ -0,0 +1,32 @@
+{
+ "parameters": {
+ "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9",
+ "resourceGroupName": "myRG",
+ "accountName": "account1",
+ "poolName": "pool1",
+ "api-version": "2020-07-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1",
+ "name": "account1/pool1/volume1",
+ "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes",
+ "location": "eastus",
+ "properties": {
+ "fileSystemId": "9760acf5-4638-11e7-9bdb-020073ca7778",
+ "creationToken": "some-amazing-filepath",
+ "usageThreshold": 107374182400,
+ "serviceLevel": "Premium",
+ "provisioningState": "Succeeded",
+ "throughputMibps": 128.0,
+ "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/2020-07-01/examples/Volumes_PoolChange.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-07-01/examples/Volumes_PoolChange.json
new file mode 100644
index 000000000000..3cde97294056
--- /dev/null
+++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-07-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": "2020-07-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/2020-07-01/examples/Volumes_ReInitializeReplication.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-07-01/examples/Volumes_ReInitializeReplication.json
new file mode 100644
index 000000000000..0f375e24142b
--- /dev/null
+++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-07-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": "2020-07-01",
+ "body": {
+ "location": "eastus",
+ "properties": {}
+ }
+ },
+ "responses": {
+ "200": {},
+ "202": {}
+ }
+}
diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-07-01/examples/Volumes_ReplicationStatus.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-07-01/examples/Volumes_ReplicationStatus.json
new file mode 100644
index 000000000000..9f4d8f6b3d9a
--- /dev/null
+++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-07-01/examples/Volumes_ReplicationStatus.json
@@ -0,0 +1,25 @@
+{
+ "parameters": {
+ "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9",
+ "resourceGroupName": "myRG",
+ "accountName": "account1",
+ "poolName": "pool1",
+ "volumeName": "volume1",
+ "api-version": "2020-07-01",
+ "body": {
+ "location": "eastus",
+ "properties": {}
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "healthy": true,
+ "relationshipStatus": "Idle",
+ "mirrorState": "Mirrored",
+ "totalProgress": "1048576",
+ "errorMessage": ""
+ }
+ }
+ }
+}
diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-07-01/examples/Volumes_ResyncReplication.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-07-01/examples/Volumes_ResyncReplication.json
new file mode 100644
index 000000000000..0f375e24142b
--- /dev/null
+++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-07-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": "2020-07-01",
+ "body": {
+ "location": "eastus",
+ "properties": {}
+ }
+ },
+ "responses": {
+ "200": {},
+ "202": {}
+ }
+}
diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-07-01/examples/Volumes_Revert.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-07-01/examples/Volumes_Revert.json
new file mode 100644
index 000000000000..70bdff55b81f
--- /dev/null
+++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-07-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": "2020-07-01",
+ "body": {
+ "snapshotId": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1/snapshots/snapshot1"
+ }
+ },
+ "responses": {
+ "200": {},
+ "202": {}
+ }
+}
diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-07-01/examples/Volumes_Update.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-07-01/examples/Volumes_Update.json
new file mode 100644
index 000000000000..b48d51ea2cb6
--- /dev/null
+++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-07-01/examples/Volumes_Update.json
@@ -0,0 +1,31 @@
+{
+ "parameters": {
+ "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9",
+ "resourceGroupName": "myRG",
+ "accountName": "account1",
+ "poolName": "pool1",
+ "volumeName": "volume1",
+ "api-version": "2020-07-01",
+ "body": {}
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroup/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1",
+ "name": "account1/pool1/volume1",
+ "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes",
+ "location": "eastus",
+ "properties": {
+ "fileSystemId": "9760acf5-4638-11e7-9bdb-020073ca7778",
+ "creationToken": "some-amazing-filepath",
+ "usageThreshold": 107374182400,
+ "serviceLevel": "Premium",
+ "provisioningState": "Succeeded",
+ "throughputMibps": 128.0,
+ "subnetId": "/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3"
+ }
+ }
+ },
+ "202": {}
+ }
+}
diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-07-01/netapp.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-07-01/netapp.json
new file mode 100644
index 000000000000..8db29d7474b3
--- /dev/null
+++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-07-01/netapp.json
@@ -0,0 +1,4796 @@
+{
+ "swagger": "2.0",
+ "info": {
+ "title": "Microsoft NetApp",
+ "description": "Microsoft NetApp Azure Resource Provider specification",
+ "version": "2020-07-01",
+ "x-ms-code-generation-settings": {
+ "name": "AzureNetAppFilesManagementClient"
+ }
+ },
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "schemes": [
+ "https"
+ ],
+ "host": "management.azure.com",
+ "security": [
+ {
+ "azure_auth": [
+ "user_impersonation"
+ ]
+ }
+ ],
+ "securityDefinitions": {
+ "azure_auth": {
+ "type": "oauth2",
+ "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize",
+ "flow": "implicit",
+ "description": "Azure Active Directory OAuth2 Flow",
+ "scopes": {
+ "user_impersonation": "impersonate your user account"
+ }
+ }
+ },
+ "paths": {
+ "/providers/Microsoft.NetApp/operations": {
+ "get": {
+ "tags": [
+ "Operations"
+ ],
+ "summary": "Describes the Resource Provider",
+ "description": "Lists all of the available Microsoft.NetApp Rest API operations",
+ "operationId": "Operations_List",
+ "parameters": [
+ {
+ "$ref": "#/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": "#/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/ResourceNameAvailabilityRequest"
+ },
+ "x-ms-client-flatten": true
+ },
+ {
+ "$ref": "#/parameters/SubscriptionId"
+ },
+ {
+ "$ref": "#/parameters/location"
+ },
+ {
+ "$ref": "#/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": "#/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": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "x-ms-pageable": {
+ "nextLinkName": null
+ },
+ "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": "#/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": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - account updated",
+ "schema": {
+ "$ref": "#/definitions/netAppAccount"
+ }
+ },
+ "201": {
+ "description": "Account created",
+ "schema": {
+ "$ref": "#/definitions/netAppAccount"
+ }
+ },
+ "202": {
+ "description": "Accepted -- Create, update or delete request accepted; operation will complete asynchronously"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed."
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "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": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "description": "Delete the specified NetApp account",
+ "responses": {
+ "202": {
+ "description": "Accepted -- Create, update or delete request accepted; operation will complete asynchronously"
+ },
+ "204": {
+ "description": "NoContent -- Resource does not exist."
+ },
+ "default": {
+ "description": "Error response describing why the operation failed."
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "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": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - account updated",
+ "schema": {
+ "$ref": "#/definitions/netAppAccount"
+ }
+ },
+ "201": {
+ "description": "OK - account created",
+ "schema": {
+ "$ref": "#/definitions/netAppAccount"
+ }
+ },
+ "202": {
+ "description": "Accepted -- Create, update or delete request accepted; operation will complete asynchronously"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed."
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "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": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "x-ms-pageable": {
+ "nextLinkName": null
+ },
+ "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": "#/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": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - pool updated",
+ "schema": {
+ "$ref": "#/definitions/capacityPool"
+ }
+ },
+ "201": {
+ "description": "Pool created",
+ "schema": {
+ "$ref": "#/definitions/capacityPool"
+ }
+ },
+ "202": {
+ "description": "Accepted -- Create, update or delete request accepted; operation will complete asynchronously"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed."
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "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": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/capacityPool"
+ }
+ },
+ "202": {
+ "description": "Accepted -- Create, update or delete request accepted; operation will complete asynchronously"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed."
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "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": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "202": {
+ "description": "Accepted -- Create, update or delete request accepted; operation will complete asynchronously"
+ },
+ "204": {
+ "description": "NoContent -- Resource does not exist."
+ },
+ "default": {
+ "description": "Error response describing why the operation failed."
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "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": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "tags": [
+ "Volumes"
+ ],
+ "operationId": "Volumes_List",
+ "x-ms-pageable": {
+ "nextLinkName": null
+ },
+ "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": "#/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": "#/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-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": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/volume"
+ }
+ },
+ "202": {
+ "description": "Accepted -- Create, update or delete request accepted; operation will complete asynchronously"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed."
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "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": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "202": {
+ "description": "Accepted -- Create, update or delete request accepted; operation will complete asynchronously"
+ },
+ "204": {
+ "description": "NoContent -- Resource does not exist."
+ },
+ "default": {
+ "description": "Error response describing why the operation failed."
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "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": "#/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-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": "#/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-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": "#/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 source to destination.",
+ "operationId": "Volumes_ResyncReplication",
+ "parameters": [
+ {
+ "$ref": "#/parameters/SubscriptionId"
+ },
+ {
+ "$ref": "#/parameters/ResourceGroup"
+ },
+ {
+ "$ref": "#/parameters/AccountName"
+ },
+ {
+ "$ref": "#/parameters/PoolName"
+ },
+ {
+ "$ref": "#/parameters/VolumeName"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - terminal state"
+ },
+ "202": {
+ "description": "Accepted"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed."
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "Volumes_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": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - terminal state"
+ },
+ "202": {
+ "description": "Accepted"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed."
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "Volumes_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": "#/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-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": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - terminal state"
+ },
+ "202": {
+ "description": "Accepted"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed."
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "Volumes_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": "#/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-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": "#/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": "#/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": "#/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-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": "#/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-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": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK"
+ },
+ "202": {
+ "description": "Accepted -- Create, update or delete request accepted; operation will complete asynchronously"
+ },
+ "204": {
+ "description": "NoContent -- Resource does not exist."
+ },
+ "default": {
+ "description": "Error response describing why the operation failed."
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "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": "#/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": "#/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"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed."
+ }
+ },
+ "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-examples": {
+ "SnapshotPolicies_Delete": {
+ "$ref": "examples/SnapshotPolicies_Delete.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/snapshotPolicies/{snapshotPolicyName}/listVolumes": {
+ "get": {
+ "tags": [
+ "Snapshot Policy List Volumes"
+ ],
+ "summary": "Get volumes associated with 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": "#/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}/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": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "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": "Get Backup for a Netapp Account",
+ "operationId": "AccountBackups_Get",
+ "parameters": [
+ {
+ "$ref": "#/parameters/SubscriptionId"
+ },
+ {
+ "$ref": "#/parameters/ResourceGroup"
+ },
+ {
+ "$ref": "#/parameters/AccountName"
+ },
+ {
+ "$ref": "#/parameters/BackupName"
+ },
+ {
+ "$ref": "#/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 Backup for a Netapp Account",
+ "operationId": "AccountBackups_Delete",
+ "parameters": [
+ {
+ "$ref": "#/parameters/SubscriptionId"
+ },
+ {
+ "$ref": "#/parameters/ResourceGroup"
+ },
+ {
+ "$ref": "#/parameters/AccountName"
+ },
+ {
+ "$ref": "#/parameters/BackupName"
+ },
+ {
+ "$ref": "#/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-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": "#/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": "Get a particular 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": "#/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": "#/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-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": "#/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"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed."
+ }
+ },
+ "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": "#/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-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": "#/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": "#/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": "#/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-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": "#/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"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed."
+ }
+ },
+ "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": "#/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-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": "#/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"
+ }
+ }
+ },
+ "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"
+ }
+ }
+ }
+ },
+ "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
+ }
+ }
+ },
+ "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"
+ }
+ }
+ }
+ },
+ "activeDirectory": {
+ "description": "Active Directory",
+ "type": "object",
+ "properties": {
+ "activeDirectoryId": {
+ "type": "string",
+ "description": "Id of the Active Directory"
+ },
+ "username": {
+ "type": "string",
+ "description": "Username of Active Directory domain administrator"
+ },
+ "password": {
+ "type": "string",
+ "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",
+ "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"
+ ]
+ }
+ },
+ "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.",
+ "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."
+ }
+ }
+ },
+ "capacityPoolList": {
+ "description": "List of capacity pool resources",
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "List of Capacity pools",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/capacityPool"
+ }
+ }
+ }
+ },
+ "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"
+ }
+ }
+ },
+ "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"
+ }
+ }
+ }
+ },
+ "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
+ }
+ }
+ },
+ "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",
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "example": [
+ "NFSv4.1"
+ ]
+ },
+ "provisioningState": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Azure lifecycle management"
+ },
+ "snapshotId": {
+ "title": "Snapshot ID",
+ "type": "string",
+ "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",
+ "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",
+ "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",
+ "enum": [
+ "ntfs",
+ "unix"
+ ],
+ "x-ms-enum": {
+ "name": "SecurityStyle",
+ "modelAsString": true
+ }
+ },
+ "throughputMibps": {
+ "title": "Maximum throughput in Mibps that can be achieved by this volume",
+ "type": "number",
+ "example": "128.22",
+ "maximum": 4500,
+ "minimum": 1,
+ "multipleOf": 0.001
+ }
+ }
+ },
+ "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
+ }
+ }
+ },
+ "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,
+ "multipleOf": 0.001
+ },
+ "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"
+ }
+ }
+ }
+ }
+ },
+ "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": {
+ "name": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Snapshot policy name"
+ },
+ "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": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Type of backup adhoc or scheduled"
+ }
+ }
+ },
+ "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"
+ }
+ }
+ }
+ },
+ "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"
+ },
+ "ApiVersionParameter": {
+ "name": "api-version",
+ "description": "Version of the API to be used with the client request.",
+ "in": "query",
+ "type": "string",
+ "required": true,
+ "default": "2020-07-01"
+ }
+ }
+}
diff --git a/specification/netapp/resource-manager/readme.go.md b/specification/netapp/resource-manager/readme.go.md
index 6eaaa9b10164..721ff76fb2f9 100644
--- a/specification/netapp/resource-manager/readme.go.md
+++ b/specification/netapp/resource-manager/readme.go.md
@@ -13,7 +13,9 @@ go:
``` yaml $(go) && $(multiapi)
batch:
+ - tag: package-netapp-2020-07-01
- tag: package-netapp-2020-06-01
+ - tag: package-netapp-2020-03-01
- tag: package-netapp-2020-02-01
- tag: package-netapp-2019-11-01
- tag: package-netapp-2019-10-01
@@ -23,6 +25,14 @@ batch:
- tag: package-netapp-2019-05-01
- tag: package-2017-08-15
```
+### Tag: package-netapp-2020-07-01 and go
+
+These settings apply only when `--tag=package-netapp-2020-07-01 --go` is specified on the command line.
+Please also specify `--go-sdk-folder=`.
+
+``` yaml $(tag) == 'package-netapp-2020-07-01' && $(go)
+output-folder: $(go-sdk-folder)/services/$(namespace)/mgmt/2020-07-01/$(namespace)
+```
### Tag: package-netapp-2020-06-01 and go
These settings apply only when `--tag=package-netapp-2020-06-01 --go` is specified on the command line.
@@ -31,6 +41,14 @@ Please also specify `--go-sdk-folder=`.
+
+``` yaml $(tag) == 'package-netapp-2020-03-01' && $(go)
+output-folder: $(go-sdk-folder)/services/$(namespace)/mgmt/2020-03-01/$(namespace)
+```
### Tag: package-netapp-2020-02-01 and go
These settings apply only when `--tag=package-netapp-2020-02-01 --go` is specified on the command line.
@@ -40,6 +58,7 @@ Please also specify `--go-sdk-folder=`.
+
+``` yaml $(tag) == 'package-netapp-2020-06-01' && $(java) && $(multiapi)
+java:
+ namespace: com.microsoft.azure.management.netapp.v2020_07_01
+ output-folder: $(azure-libraries-for-java-folder)/sdk/netapp/mgmt-v2020_07_01
+regenerate-manager: true
+generate-interface: true
+```
+
### Tag: package-netapp-2020-06-01 and java
These settings apply only when `--tag=package-netapp-2020-06-01 --java` is specified on the command line.
@@ -38,7 +53,20 @@ java:
regenerate-manager: true
generate-interface: true
```
-
+
+### Tag: package-netapp-2020-03-01 and java
+
+These settings apply only when `--tag=package-netapp-2020-03-01 --java` is specified on the command line.
+Please also specify the `--azure-libraries-for-java-folder=`.
+
+``` yaml $(tag) == 'package-netapp-2020-03-01' && $(java) && $(multiapi)
+java:
+ namespace: com.microsoft.azure.management.netapp.v2020_03_01
+ output-folder: $(azure-libraries-for-java-folder)/sdk/netapp/mgmt-v2020_03_01
+regenerate-manager: true
+generate-interface: true
+```
+
### Tag: package-netapp-2020-02-01 and java
These settings apply only when `--tag=package-netapp-2020-02-01 --java` is specified on the command line.
diff --git a/specification/netapp/resource-manager/readme.md b/specification/netapp/resource-manager/readme.md
index 86dd674a8790..624ea4d36f22 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 Azure Resource Provider specification
openapi-type: arm
-tag: package-netapp-2020-06-01
+tag: package-netapp-2020-07-01
+```
+
+### Tag: package-netapp-2020-07-01
+
+These settings apply only when `--tag=package-netapp-2020-07-01` is specified on the command line.
+
+``` yaml $(tag) == 'package-netapp-2020-07-01'
+input-file:
+- Microsoft.NetApp/stable/2020-07-01/netapp.json
```
### Tag: package-netapp-2020-06-01
@@ -39,6 +48,14 @@ These settings apply only when `--tag=package-netapp-2020-06-01` is specified on
input-file:
- Microsoft.NetApp/stable/2020-06-01/netapp.json
```
+### Tag: package-netapp-2020-03-01
+
+These settings apply only when `--tag=package-netapp-2020-03-01` is specified on the command line.
+
+``` yaml $(tag) == 'package-netapp-2020-03-01'
+input-file:
+- Microsoft.NetApp/stable/2020-03-01/netapp.json
+```
### Tag: package-netapp-2020-02-01
diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-06-01/virtualWan.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-06-01/virtualWan.json
index e995b7ddf3da..76d491707723 100644
--- a/specification/network/resource-manager/Microsoft.Network/stable/2020-06-01/virtualWan.json
+++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-06-01/virtualWan.json
@@ -6121,7 +6121,7 @@
"description": "List of all connections associated with this route table.",
"readOnly": true,
"items": {
- "$ref": "./network.json#/definitions/SubResource"
+ "type": "string"
}
},
"propagatingConnections": {
@@ -6129,7 +6129,7 @@
"description": "List of all connections that advertise to this route table.",
"readOnly": true,
"items": {
- "$ref": "./network.json#/definitions/SubResource"
+ "type": "string"
}
},
"provisioningState": {
@@ -7200,7 +7200,7 @@
}
}
},
- "VirtualHubEffectiveRouteEffectiveRouteList": {
+ "VirtualHubEffectiveRouteList": {
"description": "EffectiveRoutes List.",
"properties": {
"value": {
@@ -7247,7 +7247,7 @@
"description": "The parameters specifying the resource whose effective routes are being requested.",
"properties": {
"resourceId": {
- "$ref": "./network.json#/definitions/Resource",
+ "type": "string",
"description": "The resource whose effective routes are being requested."
},
"virtualWanResourceType": {
diff --git a/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/preview/2019-08-01-preview/examples/DataExportCreateOrUpdate.json b/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/preview/2019-08-01-preview/examples/DataExportCreateOrUpdate.json
index f738632a370c..00e71ce6ab28 100644
--- a/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/preview/2019-08-01-preview/examples/DataExportCreateOrUpdate.json
+++ b/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/preview/2019-08-01-preview/examples/DataExportCreateOrUpdate.json
@@ -25,7 +25,6 @@
"resourceId": "/subscriptions/192b9f85-a39a-4276-b96d-d5cd351703f9/resourceGroups/OIAutoRest1234/providers/Microsoft.EventHub/namespaces/test",
"type": "EventHub"
},
- "allTables": false,
"tableNames": [
"Heartbeat"
],
diff --git a/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/preview/2019-08-01-preview/examples/DataExportGet.json b/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/preview/2019-08-01-preview/examples/DataExportGet.json
index aee7dba8ecfb..472297024e2b 100644
--- a/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/preview/2019-08-01-preview/examples/DataExportGet.json
+++ b/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/preview/2019-08-01-preview/examples/DataExportGet.json
@@ -15,7 +15,6 @@
"resourceId": "/subscriptions/192b9f85-a39a-4276-b96d-d5cd351703f9/resourceGroups/OIAutoRest1234/providers/Microsoft.EventHub/namespaces/test",
"type": "EventHub"
},
- "allTables": false,
"tableNames": [
"Heartbeat"
],
diff --git a/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/preview/2019-08-01-preview/examples/DataExportListByWorkspace.json b/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/preview/2019-08-01-preview/examples/DataExportListByWorkspace.json
index 4d0a89e0b861..0d01e4a909c9 100644
--- a/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/preview/2019-08-01-preview/examples/DataExportListByWorkspace.json
+++ b/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/preview/2019-08-01-preview/examples/DataExportListByWorkspace.json
@@ -15,7 +15,6 @@
"resourceId": "/subscriptions/192b9f85-a39a-4276-b96d-d5cd351703f9/resourceGroups/OIAutoRest1234/providers/Microsoft.EventHub/namespaces/test",
"type": "EventHub"
},
- "allTables": false,
"tableNames": [
"Heartbeat"
],
diff --git a/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/preview/2020-03-01-preview/DataExports.json b/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/preview/2020-03-01-preview/DataExports.json
index d776e4a1ff24..4ca8b68ce1a2 100644
--- a/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/preview/2020-03-01-preview/DataExports.json
+++ b/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/preview/2020-03-01-preview/DataExports.json
@@ -276,10 +276,6 @@
"type": "string",
"description": "The data export rule ID."
},
- "allTables": {
- "type": "boolean",
- "description": "When ‘true’, all workspace's tables are exported."
- },
"tableNames": {
"type": "array",
"items": {
diff --git a/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/preview/2020-03-01-preview/examples/DataExportCreateOrUpdate.json b/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/preview/2020-03-01-preview/examples/DataExportCreateOrUpdate.json
index 413c8a0480bf..02b00dbe7a71 100644
--- a/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/preview/2020-03-01-preview/examples/DataExportCreateOrUpdate.json
+++ b/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/preview/2020-03-01-preview/examples/DataExportCreateOrUpdate.json
@@ -25,7 +25,6 @@
"resourceId": "/subscriptions/192b9f85-a39a-4276-b96d-d5cd351703f9/resourceGroups/OIAutoRest1234/providers/Microsoft.EventHub/namespaces/test",
"type": "EventHub"
},
- "allTables": false,
"tableNames": [
"Heartbeat"
],
@@ -46,7 +45,6 @@
"resourceId": "/subscriptions/192b9f85-a39a-4276-b96d-d5cd351703f9/resourceGroups/OIAutoRest1234/providers/Microsoft.EventHub/namespaces/test",
"type": "EventHub"
},
- "allTables": false,
"tableNames": [
"Heartbeat"
],
diff --git a/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/preview/2020-03-01-preview/examples/DataExportGet.json b/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/preview/2020-03-01-preview/examples/DataExportGet.json
index 0bb0b00f44b5..1be2c0459fea 100644
--- a/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/preview/2020-03-01-preview/examples/DataExportGet.json
+++ b/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/preview/2020-03-01-preview/examples/DataExportGet.json
@@ -15,7 +15,6 @@
"resourceId": "/subscriptions/192b9f85-a39a-4276-b96d-d5cd351703f9/resourceGroups/OIAutoRest1234/providers/Microsoft.EventHub/namespaces/test",
"type": "EventHub"
},
- "allTables": false,
"tableNames": [
"Heartbeat"
],
diff --git a/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/preview/2020-03-01-preview/examples/DataExportListByWorkspace.json b/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/preview/2020-03-01-preview/examples/DataExportListByWorkspace.json
index acec03e93f8a..df13cd8a8444 100644
--- a/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/preview/2020-03-01-preview/examples/DataExportListByWorkspace.json
+++ b/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/preview/2020-03-01-preview/examples/DataExportListByWorkspace.json
@@ -16,7 +16,6 @@
"resourceId": "/subscriptions/192b9f85-a39a-4276-b96d-d5cd351703f9/resourceGroups/OIAutoRest1234/providers/Microsoft.EventHub/namespaces/test",
"type": "EventHub"
},
- "allTables": false,
"tableNames": [
"Heartbeat"
],
diff --git a/specification/operationalinsights/resource-manager/readme.go.md b/specification/operationalinsights/resource-manager/readme.go.md
index 94ee9c7a62d1..e1fe11bf0104 100644
--- a/specification/operationalinsights/resource-manager/readme.go.md
+++ b/specification/operationalinsights/resource-manager/readme.go.md
@@ -52,5 +52,5 @@ These settings apply only when `--tag=package-2020-08 --go` is specified on the
Please also specify `--go-sdk-folder=`.
``` yaml $(tag) == 'package-2020-08' && $(go)
-output-folder: $(go-sdk-folder)/services/preview/$(namespace)/mgmt/2020-08-01/$(namespace)
+output-folder: $(go-sdk-folder)/services/$(namespace)/mgmt/2020-08-01/$(namespace)
```
diff --git a/specification/peering/resource-manager/Microsoft.Peering/stable/2020-10-01/examples/CheckServiceProviderAvailability.json b/specification/peering/resource-manager/Microsoft.Peering/stable/2020-10-01/examples/CheckServiceProviderAvailability.json
new file mode 100644
index 000000000000..aa52f4d1ec70
--- /dev/null
+++ b/specification/peering/resource-manager/Microsoft.Peering/stable/2020-10-01/examples/CheckServiceProviderAvailability.json
@@ -0,0 +1,15 @@
+{
+ "parameters": {
+ "subscriptionId": "subId",
+ "api-version": "2020-10-01",
+ "checkServiceProviderAvailabilityInput": {
+ "peeringServiceLocation": "peeringServiceLocation1",
+ "peeringServiceProvider": "peeringServiceProvider1"
+ }
+ },
+ "responses": {
+ "200": {
+ "body": "Available"
+ }
+ }
+}
diff --git a/specification/peering/resource-manager/Microsoft.Peering/stable/2020-10-01/examples/CreateDirectPeering.json b/specification/peering/resource-manager/Microsoft.Peering/stable/2020-10-01/examples/CreateDirectPeering.json
new file mode 100644
index 000000000000..db79990fd974
--- /dev/null
+++ b/specification/peering/resource-manager/Microsoft.Peering/stable/2020-10-01/examples/CreateDirectPeering.json
@@ -0,0 +1,173 @@
+{
+ "parameters": {
+ "subscriptionId": "subId",
+ "resourceGroupName": "rgName",
+ "peeringName": "peeringName",
+ "api-version": "2020-10-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/2020-10-01/examples/CreateExchangePeering.json b/specification/peering/resource-manager/Microsoft.Peering/stable/2020-10-01/examples/CreateExchangePeering.json
new file mode 100644
index 000000000000..f247cd9f0e28
--- /dev/null
+++ b/specification/peering/resource-manager/Microsoft.Peering/stable/2020-10-01/examples/CreateExchangePeering.json
@@ -0,0 +1,166 @@
+{
+ "parameters": {
+ "subscriptionId": "subId",
+ "resourceGroupName": "rgName",
+ "peeringName": "peeringName",
+ "api-version": "2020-10-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/2020-10-01/examples/CreatePeerAsn.json b/specification/peering/resource-manager/Microsoft.Peering/stable/2020-10-01/examples/CreatePeerAsn.json
new file mode 100644
index 000000000000..2955a915ca22
--- /dev/null
+++ b/specification/peering/resource-manager/Microsoft.Peering/stable/2020-10-01/examples/CreatePeerAsn.json
@@ -0,0 +1,90 @@
+{
+ "parameters": {
+ "subscriptionId": "subId",
+ "peerAsnName": "peerAsnName",
+ "api-version": "2020-10-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/2020-10-01/examples/CreatePeeringService.json b/specification/peering/resource-manager/Microsoft.Peering/stable/2020-10-01/examples/CreatePeeringService.json
new file mode 100644
index 000000000000..967f989c5e27
--- /dev/null
+++ b/specification/peering/resource-manager/Microsoft.Peering/stable/2020-10-01/examples/CreatePeeringService.json
@@ -0,0 +1,43 @@
+{
+ "parameters": {
+ "subscriptionId": "subId",
+ "resourceGroupName": "rgName",
+ "peeringServiceName": "peeringServiceName",
+ "api-version": "2020-10-01",
+ "peeringService": {
+ "properties": {
+ "peeringServiceLocation": "state1",
+ "peeringServiceProvider": "serviceProvider1"
+ },
+ "location": "eastus"
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "properties": {
+ "peeringServiceLocation": "state1",
+ "peeringServiceProvider": "serviceProvider1",
+ "provisioningState": "Succeeded"
+ },
+ "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"
+ },
+ "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/2020-10-01/examples/CreatePeeringServicePrefix.json b/specification/peering/resource-manager/Microsoft.Peering/stable/2020-10-01/examples/CreatePeeringServicePrefix.json
new file mode 100644
index 000000000000..7dc5e8cf0811
--- /dev/null
+++ b/specification/peering/resource-manager/Microsoft.Peering/stable/2020-10-01/examples/CreatePeeringServicePrefix.json
@@ -0,0 +1,45 @@
+{
+ "parameters": {
+ "subscriptionId": "subId",
+ "resourceGroupName": "rgName",
+ "peeringServiceName": "peeringServiceName",
+ "prefixName": "peeringServicePrefixName",
+ "api-version": "2020-10-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/2020-10-01/examples/CreatePeeringWithExchangeRouteServer.json b/specification/peering/resource-manager/Microsoft.Peering/stable/2020-10-01/examples/CreatePeeringWithExchangeRouteServer.json
new file mode 100644
index 000000000000..e8075ecb979a
--- /dev/null
+++ b/specification/peering/resource-manager/Microsoft.Peering/stable/2020-10-01/examples/CreatePeeringWithExchangeRouteServer.json
@@ -0,0 +1,134 @@
+{
+ "parameters": {
+ "subscriptionId": "subId",
+ "resourceGroupName": "rgName",
+ "peeringName": "peeringName",
+ "api-version": "2020-10-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/2020-10-01/examples/CreateRegisteredAsn.json b/specification/peering/resource-manager/Microsoft.Peering/stable/2020-10-01/examples/CreateRegisteredAsn.json
new file mode 100644
index 000000000000..993072a62208
--- /dev/null
+++ b/specification/peering/resource-manager/Microsoft.Peering/stable/2020-10-01/examples/CreateRegisteredAsn.json
@@ -0,0 +1,40 @@
+{
+ "parameters": {
+ "subscriptionId": "subId",
+ "resourceGroupName": "rgName",
+ "peeringName": "peeringName",
+ "api-version": "2020-10-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/2020-10-01/examples/CreateRegisteredPrefix.json b/specification/peering/resource-manager/Microsoft.Peering/stable/2020-10-01/examples/CreateRegisteredPrefix.json
new file mode 100644
index 000000000000..f2c1b73fc436
--- /dev/null
+++ b/specification/peering/resource-manager/Microsoft.Peering/stable/2020-10-01/examples/CreateRegisteredPrefix.json
@@ -0,0 +1,41 @@
+{
+ "parameters": {
+ "subscriptionId": "subId",
+ "resourceGroupName": "rgName",
+ "peeringName": "peeringName",
+ "api-version": "2020-10-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/2020-10-01/examples/DeletePeerAsn.json b/specification/peering/resource-manager/Microsoft.Peering/stable/2020-10-01/examples/DeletePeerAsn.json
new file mode 100644
index 000000000000..add7bedb0630
--- /dev/null
+++ b/specification/peering/resource-manager/Microsoft.Peering/stable/2020-10-01/examples/DeletePeerAsn.json
@@ -0,0 +1,11 @@
+{
+ "parameters": {
+ "subscriptionId": "subId",
+ "peerAsnName": "peerAsnName",
+ "api-version": "2020-10-01"
+ },
+ "responses": {
+ "200": {},
+ "204": {}
+ }
+}
diff --git a/specification/peering/resource-manager/Microsoft.Peering/stable/2020-10-01/examples/DeletePeering.json b/specification/peering/resource-manager/Microsoft.Peering/stable/2020-10-01/examples/DeletePeering.json
new file mode 100644
index 000000000000..9d2f1250a881
--- /dev/null
+++ b/specification/peering/resource-manager/Microsoft.Peering/stable/2020-10-01/examples/DeletePeering.json
@@ -0,0 +1,12 @@
+{
+ "parameters": {
+ "subscriptionId": "subId",
+ "resourceGroupName": "rgName",
+ "peeringName": "peeringName",
+ "api-version": "2020-10-01"
+ },
+ "responses": {
+ "200": {},
+ "204": {}
+ }
+}
diff --git a/specification/peering/resource-manager/Microsoft.Peering/stable/2020-10-01/examples/DeletePeeringService.json b/specification/peering/resource-manager/Microsoft.Peering/stable/2020-10-01/examples/DeletePeeringService.json
new file mode 100644
index 000000000000..a22934f7346f
--- /dev/null
+++ b/specification/peering/resource-manager/Microsoft.Peering/stable/2020-10-01/examples/DeletePeeringService.json
@@ -0,0 +1,12 @@
+{
+ "parameters": {
+ "subscriptionId": "subId",
+ "resourceGroupName": "rgName",
+ "peeringServiceName": "peeringServiceName",
+ "api-version": "2020-10-01"
+ },
+ "responses": {
+ "200": {},
+ "204": {}
+ }
+}
diff --git a/specification/peering/resource-manager/Microsoft.Peering/stable/2020-10-01/examples/DeletePeeringServicePrefix.json b/specification/peering/resource-manager/Microsoft.Peering/stable/2020-10-01/examples/DeletePeeringServicePrefix.json
new file mode 100644
index 000000000000..1c1e136b943e
--- /dev/null
+++ b/specification/peering/resource-manager/Microsoft.Peering/stable/2020-10-01/examples/DeletePeeringServicePrefix.json
@@ -0,0 +1,13 @@
+{
+ "parameters": {
+ "subscriptionId": "subId",
+ "resourceGroupName": "rgName",
+ "peeringServiceName": "peeringServiceName",
+ "prefixName": "peeringServicePrefixName",
+ "api-version": "2020-10-01"
+ },
+ "responses": {
+ "200": {},
+ "204": {}
+ }
+}
diff --git a/specification/peering/resource-manager/Microsoft.Peering/stable/2020-10-01/examples/DeleteRegisteredAsn.json b/specification/peering/resource-manager/Microsoft.Peering/stable/2020-10-01/examples/DeleteRegisteredAsn.json
new file mode 100644
index 000000000000..d4c5bf8ad0bf
--- /dev/null
+++ b/specification/peering/resource-manager/Microsoft.Peering/stable/2020-10-01/examples/DeleteRegisteredAsn.json
@@ -0,0 +1,13 @@
+{
+ "parameters": {
+ "subscriptionId": "subId",
+ "resourceGroupName": "rgName",
+ "peeringName": "peeringName",
+ "api-version": "2020-10-01",
+ "registeredAsnName": "registeredAsnName"
+ },
+ "responses": {
+ "200": {},
+ "204": {}
+ }
+}
diff --git a/specification/peering/resource-manager/Microsoft.Peering/stable/2020-10-01/examples/DeleteRegisteredPrefix.json b/specification/peering/resource-manager/Microsoft.Peering/stable/2020-10-01/examples/DeleteRegisteredPrefix.json
new file mode 100644
index 000000000000..2af34531c655
--- /dev/null
+++ b/specification/peering/resource-manager/Microsoft.Peering/stable/2020-10-01/examples/DeleteRegisteredPrefix.json
@@ -0,0 +1,13 @@
+{
+ "parameters": {
+ "subscriptionId": "subId",
+ "resourceGroupName": "rgName",
+ "peeringName": "peeringName",
+ "api-version": "2020-10-01",
+ "registeredPrefixName": "registeredPrefixName"
+ },
+ "responses": {
+ "200": {},
+ "204": {}
+ }
+}
diff --git a/specification/peering/resource-manager/Microsoft.Peering/stable/2020-10-01/examples/GetPeerAsn.json b/specification/peering/resource-manager/Microsoft.Peering/stable/2020-10-01/examples/GetPeerAsn.json
new file mode 100644
index 000000000000..07fc9d864f7f
--- /dev/null
+++ b/specification/peering/resource-manager/Microsoft.Peering/stable/2020-10-01/examples/GetPeerAsn.json
@@ -0,0 +1,38 @@
+{
+ "parameters": {
+ "subscriptionId": "subId",
+ "peerAsnName": "peerAsnName",
+ "api-version": "2020-10-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/2020-10-01/examples/GetPeering.json b/specification/peering/resource-manager/Microsoft.Peering/stable/2020-10-01/examples/GetPeering.json
new file mode 100644
index 000000000000..145fae966991
--- /dev/null
+++ b/specification/peering/resource-manager/Microsoft.Peering/stable/2020-10-01/examples/GetPeering.json
@@ -0,0 +1,68 @@
+{
+ "parameters": {
+ "subscriptionId": "subId",
+ "resourceGroupName": "rgName",
+ "peeringName": "peeringName",
+ "api-version": "2020-10-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/2020-10-01/examples/GetPeeringReceivedRoutes.json b/specification/peering/resource-manager/Microsoft.Peering/stable/2020-10-01/examples/GetPeeringReceivedRoutes.json
new file mode 100644
index 000000000000..db1073c351ec
--- /dev/null
+++ b/specification/peering/resource-manager/Microsoft.Peering/stable/2020-10-01/examples/GetPeeringReceivedRoutes.json
@@ -0,0 +1,29 @@
+{
+ "parameters": {
+ "subscriptionId": "subId",
+ "resourceGroupName": "rgName",
+ "peeringName": "peeringName",
+ "api-version": "2020-10-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/2020-10-01/examples/GetPeeringService.json b/specification/peering/resource-manager/Microsoft.Peering/stable/2020-10-01/examples/GetPeeringService.json
new file mode 100644
index 000000000000..c9a14dca4eaf
--- /dev/null
+++ b/specification/peering/resource-manager/Microsoft.Peering/stable/2020-10-01/examples/GetPeeringService.json
@@ -0,0 +1,23 @@
+{
+ "parameters": {
+ "subscriptionId": "subId",
+ "resourceGroupName": "rgName",
+ "peeringServiceName": "peeringServiceName",
+ "api-version": "2020-10-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "properties": {
+ "peeringServiceLocation": "state1",
+ "peeringServiceProvider": "serviceProvider1",
+ "provisioningState": "Succeeded"
+ },
+ "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/2020-10-01/examples/GetPeeringServicePrefix.json b/specification/peering/resource-manager/Microsoft.Peering/stable/2020-10-01/examples/GetPeeringServicePrefix.json
new file mode 100644
index 000000000000..996ef49c7ef0
--- /dev/null
+++ b/specification/peering/resource-manager/Microsoft.Peering/stable/2020-10-01/examples/GetPeeringServicePrefix.json
@@ -0,0 +1,24 @@
+{
+ "parameters": {
+ "subscriptionId": "subId",
+ "resourceGroupName": "rgName",
+ "peeringServiceName": "peeringServiceName",
+ "prefixName": "peeringServicePrefixName",
+ "api-version": "2020-10-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/2020-10-01/examples/GetRegisteredAsn.json b/specification/peering/resource-manager/Microsoft.Peering/stable/2020-10-01/examples/GetRegisteredAsn.json
new file mode 100644
index 000000000000..0cbfd3588513
--- /dev/null
+++ b/specification/peering/resource-manager/Microsoft.Peering/stable/2020-10-01/examples/GetRegisteredAsn.json
@@ -0,0 +1,23 @@
+{
+ "parameters": {
+ "subscriptionId": "subId",
+ "resourceGroupName": "rgName",
+ "peeringName": "peeringName",
+ "api-version": "2020-10-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/2020-10-01/examples/GetRegisteredPrefix.json b/specification/peering/resource-manager/Microsoft.Peering/stable/2020-10-01/examples/GetRegisteredPrefix.json
new file mode 100644
index 000000000000..48eeab804efb
--- /dev/null
+++ b/specification/peering/resource-manager/Microsoft.Peering/stable/2020-10-01/examples/GetRegisteredPrefix.json
@@ -0,0 +1,24 @@
+{
+ "parameters": {
+ "subscriptionId": "subId",
+ "resourceGroupName": "rgName",
+ "peeringName": "peeringName",
+ "api-version": "2020-10-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/2020-10-01/examples/ListCdnPeeringPrefixes.json b/specification/peering/resource-manager/Microsoft.Peering/stable/2020-10-01/examples/ListCdnPeeringPrefixes.json
new file mode 100644
index 000000000000..62029c161d0c
--- /dev/null
+++ b/specification/peering/resource-manager/Microsoft.Peering/stable/2020-10-01/examples/ListCdnPeeringPrefixes.json
@@ -0,0 +1,27 @@
+{
+ "parameters": {
+ "subscriptionId": "subId",
+ "api-version": "2020-10-01",
+ "peeringLocation": "peeringLocation0"
+ },
+ "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/2020-10-01/examples/ListDirectPeeringLocations.json b/specification/peering/resource-manager/Microsoft.Peering/stable/2020-10-01/examples/ListDirectPeeringLocations.json
new file mode 100644
index 000000000000..8ee2b0b60037
--- /dev/null
+++ b/specification/peering/resource-manager/Microsoft.Peering/stable/2020-10-01/examples/ListDirectPeeringLocations.json
@@ -0,0 +1,81 @@
+{
+ "parameters": {
+ "subscriptionId": "subId",
+ "kind": "Direct",
+ "api-version": "2020-10-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/2020-10-01/examples/ListExchangePeeringLocations.json b/specification/peering/resource-manager/Microsoft.Peering/stable/2020-10-01/examples/ListExchangePeeringLocations.json
new file mode 100644
index 000000000000..ac8c6c47173c
--- /dev/null
+++ b/specification/peering/resource-manager/Microsoft.Peering/stable/2020-10-01/examples/ListExchangePeeringLocations.json
@@ -0,0 +1,73 @@
+{
+ "parameters": {
+ "subscriptionId": "subId",
+ "kind": "Exchange",
+ "api-version": "2020-10-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/2020-10-01/examples/ListLegacyPeerings.json b/specification/peering/resource-manager/Microsoft.Peering/stable/2020-10-01/examples/ListLegacyPeerings.json
new file mode 100644
index 000000000000..66cb8747fff1
--- /dev/null
+++ b/specification/peering/resource-manager/Microsoft.Peering/stable/2020-10-01/examples/ListLegacyPeerings.json
@@ -0,0 +1,72 @@
+{
+ "parameters": {
+ "subscriptionId": "subId",
+ "kind": "Exchange",
+ "peeringLocation": "peeringLocation0",
+ "api-version": "2020-10-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/2020-10-01/examples/ListPeerAsnsBySubscription.json b/specification/peering/resource-manager/Microsoft.Peering/stable/2020-10-01/examples/ListPeerAsnsBySubscription.json
new file mode 100644
index 000000000000..7afe7db051c8
--- /dev/null
+++ b/specification/peering/resource-manager/Microsoft.Peering/stable/2020-10-01/examples/ListPeerAsnsBySubscription.json
@@ -0,0 +1,41 @@
+{
+ "parameters": {
+ "subscriptionId": "subId",
+ "api-version": "2020-10-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/2020-10-01/examples/ListPeeringOperations.json b/specification/peering/resource-manager/Microsoft.Peering/stable/2020-10-01/examples/ListPeeringOperations.json
new file mode 100644
index 000000000000..39c812acaa4b
--- /dev/null
+++ b/specification/peering/resource-manager/Microsoft.Peering/stable/2020-10-01/examples/ListPeeringOperations.json
@@ -0,0 +1,253 @@
+{
+ "parameters": {
+ "api-version": "2020-10-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
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/peering/resource-manager/Microsoft.Peering/stable/2020-10-01/examples/ListPeeringServiceCountriesBySubscription.json b/specification/peering/resource-manager/Microsoft.Peering/stable/2020-10-01/examples/ListPeeringServiceCountriesBySubscription.json
new file mode 100644
index 000000000000..a16d341b7ed2
--- /dev/null
+++ b/specification/peering/resource-manager/Microsoft.Peering/stable/2020-10-01/examples/ListPeeringServiceCountriesBySubscription.json
@@ -0,0 +1,24 @@
+{
+ "parameters": {
+ "subscriptionId": "subId",
+ "api-version": "2020-10-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/2020-10-01/examples/ListPeeringServiceLocationsBySubscription.json b/specification/peering/resource-manager/Microsoft.Peering/stable/2020-10-01/examples/ListPeeringServiceLocationsBySubscription.json
new file mode 100644
index 000000000000..7d8abce45a3d
--- /dev/null
+++ b/specification/peering/resource-manager/Microsoft.Peering/stable/2020-10-01/examples/ListPeeringServiceLocationsBySubscription.json
@@ -0,0 +1,32 @@
+{
+ "parameters": {
+ "subscriptionId": "subId",
+ "api-version": "2020-10-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/2020-10-01/examples/ListPeeringServiceProviders.json b/specification/peering/resource-manager/Microsoft.Peering/stable/2020-10-01/examples/ListPeeringServiceProviders.json
new file mode 100644
index 000000000000..9ba2d5ab6253
--- /dev/null
+++ b/specification/peering/resource-manager/Microsoft.Peering/stable/2020-10-01/examples/ListPeeringServiceProviders.json
@@ -0,0 +1,30 @@
+{
+ "parameters": {
+ "subscriptionId": "subId",
+ "api-version": "2020-10-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "properties": {
+ "serviceProviderName": "peeringServiceProvider1"
+ },
+ "name": "peeringServiceProvider1",
+ "id": "/subscriptions/subId/providers/Microsoft.Peering/peeringServiceProviders/peeringServiceProvider1",
+ "type": "Microsoft.Peering/peeringServiceProviders"
+ },
+ {
+ "properties": {
+ "serviceProviderName": "peeringServiceProvider2"
+ },
+ "name": "peeringServiceProvider2",
+ "id": "/subscriptions/subId/providers/Microsoft.Peering/peeringServiceProviders/peeringServiceProvider2",
+ "type": "Microsoft.Peering/peeringServiceProviders"
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/peering/resource-manager/Microsoft.Peering/stable/2020-10-01/examples/ListPeeringServicesByResourceGroup.json b/specification/peering/resource-manager/Microsoft.Peering/stable/2020-10-01/examples/ListPeeringServicesByResourceGroup.json
new file mode 100644
index 000000000000..cc2d62d9fa73
--- /dev/null
+++ b/specification/peering/resource-manager/Microsoft.Peering/stable/2020-10-01/examples/ListPeeringServicesByResourceGroup.json
@@ -0,0 +1,26 @@
+{
+ "parameters": {
+ "subscriptionId": "subId",
+ "resourceGroupName": "rgName",
+ "api-version": "2020-10-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "properties": {
+ "peeringServiceLocation": "state1",
+ "peeringServiceProvider": "serviceProvider1",
+ "provisioningState": "Succeeded"
+ },
+ "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/2020-10-01/examples/ListPeeringServicesBySubscription.json b/specification/peering/resource-manager/Microsoft.Peering/stable/2020-10-01/examples/ListPeeringServicesBySubscription.json
new file mode 100644
index 000000000000..2f9a62b6b7d8
--- /dev/null
+++ b/specification/peering/resource-manager/Microsoft.Peering/stable/2020-10-01/examples/ListPeeringServicesBySubscription.json
@@ -0,0 +1,25 @@
+{
+ "parameters": {
+ "subscriptionId": "subId",
+ "api-version": "2020-10-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "properties": {
+ "peeringServiceLocation": "state1",
+ "peeringServiceProvider": "serviceProvider1",
+ "provisioningState": "Succeeded"
+ },
+ "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/2020-10-01/examples/ListPeeringsByResourceGroup.json b/specification/peering/resource-manager/Microsoft.Peering/stable/2020-10-01/examples/ListPeeringsByResourceGroup.json
new file mode 100644
index 000000000000..c51728cf87ef
--- /dev/null
+++ b/specification/peering/resource-manager/Microsoft.Peering/stable/2020-10-01/examples/ListPeeringsByResourceGroup.json
@@ -0,0 +1,71 @@
+{
+ "parameters": {
+ "subscriptionId": "subId",
+ "resourceGroupName": "rgName",
+ "api-version": "2020-10-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/2020-10-01/examples/ListPeeringsBySubscription.json b/specification/peering/resource-manager/Microsoft.Peering/stable/2020-10-01/examples/ListPeeringsBySubscription.json
new file mode 100644
index 000000000000..963e825c79fb
--- /dev/null
+++ b/specification/peering/resource-manager/Microsoft.Peering/stable/2020-10-01/examples/ListPeeringsBySubscription.json
@@ -0,0 +1,70 @@
+{
+ "parameters": {
+ "subscriptionId": "subId",
+ "api-version": "2020-10-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/2020-10-01/examples/ListPrefixesByPeeringService.json b/specification/peering/resource-manager/Microsoft.Peering/stable/2020-10-01/examples/ListPrefixesByPeeringService.json
new file mode 100644
index 000000000000..350c2f15f0b3
--- /dev/null
+++ b/specification/peering/resource-manager/Microsoft.Peering/stable/2020-10-01/examples/ListPrefixesByPeeringService.json
@@ -0,0 +1,38 @@
+{
+ "parameters": {
+ "subscriptionId": "subId",
+ "resourceGroupName": "rgName",
+ "peeringServiceName": "peeringServiceName",
+ "api-version": "2020-10-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/2020-10-01/examples/ListRegisteredAsnsByPeering.json b/specification/peering/resource-manager/Microsoft.Peering/stable/2020-10-01/examples/ListRegisteredAsnsByPeering.json
new file mode 100644
index 000000000000..67ec5f7ce66a
--- /dev/null
+++ b/specification/peering/resource-manager/Microsoft.Peering/stable/2020-10-01/examples/ListRegisteredAsnsByPeering.json
@@ -0,0 +1,45 @@
+{
+ "parameters": {
+ "subscriptionId": "subId",
+ "resourceGroupName": "rgName",
+ "peeringName": "peeringName",
+ "api-version": "2020-10-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/2020-10-01/examples/ListRegisteredPrefixesByPeering.json b/specification/peering/resource-manager/Microsoft.Peering/stable/2020-10-01/examples/ListRegisteredPrefixesByPeering.json
new file mode 100644
index 000000000000..0aced0d9d1f8
--- /dev/null
+++ b/specification/peering/resource-manager/Microsoft.Peering/stable/2020-10-01/examples/ListRegisteredPrefixesByPeering.json
@@ -0,0 +1,48 @@
+{
+ "parameters": {
+ "subscriptionId": "subId",
+ "resourceGroupName": "rgName",
+ "peeringName": "peeringName",
+ "api-version": "2020-10-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/2020-10-01/examples/UpdatePeeringServiceTags.json b/specification/peering/resource-manager/Microsoft.Peering/stable/2020-10-01/examples/UpdatePeeringServiceTags.json
new file mode 100644
index 000000000000..ef65c82b1add
--- /dev/null
+++ b/specification/peering/resource-manager/Microsoft.Peering/stable/2020-10-01/examples/UpdatePeeringServiceTags.json
@@ -0,0 +1,33 @@
+{
+ "parameters": {
+ "subscriptionId": "subId",
+ "resourceGroupName": "rgName",
+ "peeringServiceName": "peeringServiceName",
+ "api-version": "2020-10-01",
+ "tags": {
+ "tags": {
+ "tag0": "value0",
+ "tag1": "value1"
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "properties": {
+ "peeringServiceLocation": "state1",
+ "peeringServiceProvider": "serviceProvider1",
+ "provisioningState": "Succeeded"
+ },
+ "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/2020-10-01/examples/UpdatePeeringTags.json b/specification/peering/resource-manager/Microsoft.Peering/stable/2020-10-01/examples/UpdatePeeringTags.json
new file mode 100644
index 000000000000..0de6a3f0de59
--- /dev/null
+++ b/specification/peering/resource-manager/Microsoft.Peering/stable/2020-10-01/examples/UpdatePeeringTags.json
@@ -0,0 +1,78 @@
+{
+ "parameters": {
+ "subscriptionId": "subId",
+ "resourceGroupName": "rgName",
+ "peeringName": "peeringName",
+ "api-version": "2020-10-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/2020-10-01/peering.json b/specification/peering/resource-manager/Microsoft.Peering/stable/2020-10-01/peering.json
new file mode 100644
index 000000000000..f860849ea800
--- /dev/null
+++ b/specification/peering/resource-manager/Microsoft.Peering/stable/2020-10-01/peering.json
@@ -0,0 +1,3525 @@
+{
+ "swagger": "2.0",
+ "info": {
+ "version": "2020-10-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"
+ }
+ }
+ },
+ "/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"
+ ]
+ },
+ {
+ "$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}/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"
+ }
+ }
+ }
+ },
+ "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",
+ "x-ms-enum": {
+ "name": "tier",
+ "modelAsString": true
+ }
+ },
+ "family": {
+ "description": "The family of the peering SKU.",
+ "enum": [
+ "Direct",
+ "Exchange"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "family",
+ "modelAsString": true
+ }
+ },
+ "size": {
+ "description": "The size of the peering SKU.",
+ "enum": [
+ "Free",
+ "Metered",
+ "Unlimited"
+ ],
+ "type": "string",
+ "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"
+ ],
+ "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"
+ }
+ }
+ },
+ "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
+ }
+ }
+ },
+ "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
+ }
+ }
+ },
+ "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",
+ "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"
+ ],
+ "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
+ }
+ }
+ },
+ "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"
+ }
+ }
+ },
+ "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 PeeringServiceLocation of the Customer.",
+ "type": "string"
+ },
+ "peeringServiceProvider": {
+ "description": "The MAPS Provider Name.",
+ "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
+ }
+ }
+ }
+ },
+ "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.azureresourceschema.md b/specification/peering/resource-manager/readme.azureresourceschema.md
index a9bc36228266..92cf3226da03 100644
--- a/specification/peering/resource-manager/readme.azureresourceschema.md
+++ b/specification/peering/resource-manager/readme.azureresourceschema.md
@@ -6,6 +6,7 @@ These settings apply only when `--azureresourceschema` is specified on the comma
``` yaml $(azureresourceschema) && $(multiapi)
batch:
+ - tag: schema-peering-2020-10-01
- tag: schema-peering-2020-04-01
- tag: schema-peering-2020-01-01-preview
- tag: schema-peering-2019-09-01-preview
@@ -15,6 +16,17 @@ batch:
Please also specify `--azureresourceschema-folder=`.
+### Tag: schema-peering-2020-10-01 and azureresourceschema
+
+``` yaml $(tag) == 'schema-peering-2020-10-01' && $(azureresourceschema)
+output-folder: $(azureresourceschema-folder)/schemas
+
+# all the input files in this apiVersion
+input-file:
+ - Microsoft.Peering/stable/2020-10-01/peering.json
+
+```
+
### Tag: schema-peering-2020-04-01 and azureresourceschema
``` yaml $(tag) == 'schema-peering-2020-04-01' && $(azureresourceschema)
diff --git a/specification/peering/resource-manager/readme.go.md b/specification/peering/resource-manager/readme.go.md
index 27337b355f40..9ec673b54fe6 100644
--- a/specification/peering/resource-manager/readme.go.md
+++ b/specification/peering/resource-manager/readme.go.md
@@ -11,7 +11,11 @@ go:
```
### Go multi-api
-
+``` yaml $(go) && $(multiapi)
+batch:
+ - tag: package-2020-10-01
+```
+or
``` yaml $(go) && $(multiapi)
batch:
- tag: package-2020-04-01
@@ -32,6 +36,15 @@ batch:
- tag: package-2019-08-01-preview
```
+### Tag: package-2020-10-01 and go
+
+These settings apply only when `--tag=package-2020-10-01 --go` is specified on the command line.
+Please also specify `--go-sdk-folder=`.
+
+``` yaml $(tag) == 'package-2020-10-01' && $(go)
+output-folder: $(go-sdk-folder)/services/$(namespace)/mgmt/2020-10-01/$(namespace)
+```
+
### Tag: package-2020-04-01 and go
These settings apply only when `--tag=package-2020-04-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 41cb57f82562..a25716a4e548 100644
--- a/specification/peering/resource-manager/readme.java.md
+++ b/specification/peering/resource-manager/readme.java.md
@@ -13,8 +13,11 @@ output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-peering
```
### Java multi-api
-
-
+``` yaml $(java) && $(multiapi)
+batch:
+ - tag: package-2020-10-01
+```
+or
``` yaml $(java) && $(multiapi)
batch:
- tag: package-2020-04-01
@@ -35,6 +38,19 @@ batch:
- tag: package-2019-08-01-preview
```
+### Tag: package-2020-10-01 and java
+
+These settings apply only when `--tag=package-2020-10-01 --java` is specified on the command line.
+Please also specify `--azure-libraries-for-java=`.
+
+``` yaml $(tag) == 'package-2020-10-01' && $(java) && $(multiapi)
+java:
+ namespace: com.microsoft.azure.management.peering.v2020_10_01
+ output-folder: $(azure-libraries-for-java-folder)/sdk/peering/mgmt-v2020_10_01
+regenerate-manager: true
+generate-interface: true
+```
+
### Tag: package-2020-04-01 and java
These settings apply only when `--tag=package-2020-04-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 6b7fc65c805f..fbbe96e7a7ae 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-2020-10-01
+```
+or
+
``` yaml
title: PeeringManagementClient
description: Peering Client
@@ -49,6 +57,14 @@ description: Peering Client
openapi-type: arm
tag: package-2019-08-01-preview
```
+### Tag: package-2020-10-01
+
+These settings apply only when `--tag=package-2020-10-01` is specified on the command line.
+
+``` yaml $(tag) == 'package-2020-10-01'
+input-file:
+- Microsoft.Peering/stable/2020-10-01/peering.json
+```
### Tag: package-2020-04-01
diff --git a/specification/peering/resource-manager/readme.ruby.md b/specification/peering/resource-manager/readme.ruby.md
index e62dc7a47c9e..58da419f7340 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: "2020-10-01"
+azure-arm: true
+```
+or
``` yaml
package-name: azure_mgmt_peering
package-version: "2020-04-01"
@@ -28,6 +34,11 @@ azure-arm: true
### Ruby multi-api
+``` yaml $(ruby) && $(multiapi)
+batch:
+ - tag: package-2020-10-01
+```
+or
``` yaml $(ruby) && $(multiapi)
batch:
- tag: package-2020-04-01
@@ -48,6 +59,16 @@ batch:
- tag: package-2019-08-01-preview
```
+### Tag: package-2020-10-01 and ruby
+
+These settings apply only when `--tag=package-2020-10-01 --ruby` is specified on the command line.
+Please also specify `--ruby-sdks-folder=`.
+
+``` yaml $(tag) == 'package-2020-10-01' && $(ruby)
+namespace: "Azure::Peering::Mgmt::V2020_10_01"
+output-folder: $(ruby-sdks-folder)/management/azure_mgmt_peering/lib
+```
+
### Tag: package-2020-04-01 and ruby
These settings apply only when `--tag=package-2020-04-01 --ruby` is specified on the command line.
diff --git a/specification/policyinsights/resource-manager/readme.go.md b/specification/policyinsights/resource-manager/readme.go.md
index fa3fa5126749..249c80b4f08a 100644
--- a/specification/policyinsights/resource-manager/readme.go.md
+++ b/specification/policyinsights/resource-manager/readme.go.md
@@ -23,7 +23,7 @@ These settings apply only when `--tag=package-2019-10 --go` is specified on the
Please also specify `--go-sdk-folder=`.
``` yaml $(tag) == 'package-2019-10' && $(go)
-output-folder: $(go-sdk-folder)/services//$(namespace)/mgmt/2019-10-01/$(namespace)
+output-folder: $(go-sdk-folder)/services/preview/$(namespace)/mgmt/2019-10-01-preview/$(namespace)
```
### Tag: package-2018-07 and go
diff --git a/specification/portal/resource-manager/Microsoft.Portal/preview/2019-01-01-preview/tenantConfiguration.json b/specification/portal/resource-manager/Microsoft.Portal/preview/2019-01-01-preview/tenantConfiguration.json
index a7ff3f47c85a..1895a45a5f2f 100644
--- a/specification/portal/resource-manager/Microsoft.Portal/preview/2019-01-01-preview/tenantConfiguration.json
+++ b/specification/portal/resource-manager/Microsoft.Portal/preview/2019-01-01-preview/tenantConfiguration.json
@@ -205,7 +205,7 @@
"items": {
"$ref": "#/definitions/Configuration"
},
- "description": "The array of custom resource provider manifests."
+ "description": "The array of tenant configurations."
},
"nextLink": {
"type": "string",
diff --git a/specification/portal/resource-manager/Microsoft.Portal/preview/2020-09-01-preview/examples/TenantConfiguration/CreateOrUpdateTenantConfiguration.json b/specification/portal/resource-manager/Microsoft.Portal/preview/2020-09-01-preview/examples/TenantConfiguration/CreateOrUpdateTenantConfiguration.json
index 804d967b678c..452a679c3340 100644
--- a/specification/portal/resource-manager/Microsoft.Portal/preview/2020-09-01-preview/examples/TenantConfiguration/CreateOrUpdateTenantConfiguration.json
+++ b/specification/portal/resource-manager/Microsoft.Portal/preview/2020-09-01-preview/examples/TenantConfiguration/CreateOrUpdateTenantConfiguration.json
@@ -1,7 +1,7 @@
{
"parameters": {
"configurationName": "default",
- "api-version": "2019-01-01-preview",
+ "api-version": "2020-09-01-preview",
"tenantConfiguration": {
"properties": {
"enforcePrivateMarkdownStorage": true
diff --git a/specification/portal/resource-manager/Microsoft.Portal/preview/2020-09-01-preview/examples/TenantConfiguration/DeleteTenantConfiguration.json b/specification/portal/resource-manager/Microsoft.Portal/preview/2020-09-01-preview/examples/TenantConfiguration/DeleteTenantConfiguration.json
index 640025727bc7..ab65bfbf4885 100644
--- a/specification/portal/resource-manager/Microsoft.Portal/preview/2020-09-01-preview/examples/TenantConfiguration/DeleteTenantConfiguration.json
+++ b/specification/portal/resource-manager/Microsoft.Portal/preview/2020-09-01-preview/examples/TenantConfiguration/DeleteTenantConfiguration.json
@@ -1,7 +1,7 @@
{
"parameters": {
"configurationName": "default",
- "api-version": "2019-01-01-preview"
+ "api-version": "2020-09-01-preview"
},
"responses": {
"200": {},
diff --git a/specification/portal/resource-manager/Microsoft.Portal/preview/2020-09-01-preview/examples/TenantConfiguration/GetListOfTenantConfigurationViolations.json b/specification/portal/resource-manager/Microsoft.Portal/preview/2020-09-01-preview/examples/TenantConfiguration/GetListOfTenantConfigurationViolations.json
new file mode 100644
index 000000000000..6a05668145d4
--- /dev/null
+++ b/specification/portal/resource-manager/Microsoft.Portal/preview/2020-09-01-preview/examples/TenantConfiguration/GetListOfTenantConfigurationViolations.json
@@ -0,0 +1,18 @@
+{
+ "parameters": {
+ "api-version": "2020-09-01-preview"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "private/5f4ff99a-efa9-40f9-9c04-6b5716828c0e",
+ "userId": "",
+ "errorMessage": "Tenant is configured to allow only URI configuration for the Markdown tiles on dashboards."
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/portal/resource-manager/Microsoft.Portal/preview/2020-09-01-preview/examples/TenantConfiguration/GetListOfTenantConfigurations.json b/specification/portal/resource-manager/Microsoft.Portal/preview/2020-09-01-preview/examples/TenantConfiguration/GetListOfTenantConfigurations.json
index bbb7cfefdb1f..6707113b27a2 100644
--- a/specification/portal/resource-manager/Microsoft.Portal/preview/2020-09-01-preview/examples/TenantConfiguration/GetListOfTenantConfigurations.json
+++ b/specification/portal/resource-manager/Microsoft.Portal/preview/2020-09-01-preview/examples/TenantConfiguration/GetListOfTenantConfigurations.json
@@ -1,6 +1,6 @@
{
"parameters": {
- "api-version": "2019-01-01-preview"
+ "api-version": "2020-09-01-preview"
},
"responses": {
"200": {
diff --git a/specification/portal/resource-manager/Microsoft.Portal/preview/2020-09-01-preview/examples/TenantConfiguration/GetTenantConfiguration.json b/specification/portal/resource-manager/Microsoft.Portal/preview/2020-09-01-preview/examples/TenantConfiguration/GetTenantConfiguration.json
index b945a54fcc08..acdef20dfe34 100644
--- a/specification/portal/resource-manager/Microsoft.Portal/preview/2020-09-01-preview/examples/TenantConfiguration/GetTenantConfiguration.json
+++ b/specification/portal/resource-manager/Microsoft.Portal/preview/2020-09-01-preview/examples/TenantConfiguration/GetTenantConfiguration.json
@@ -1,7 +1,7 @@
{
"parameters": {
"configurationName": "default",
- "api-version": "2019-01-01-preview"
+ "api-version": "2020-09-01-preview"
},
"responses": {
"200": {
diff --git a/specification/portal/resource-manager/Microsoft.Portal/preview/2020-09-01-preview/portal.json b/specification/portal/resource-manager/Microsoft.Portal/preview/2020-09-01-preview/portal.json
index c2531031f2bb..2ebeb8c17ede 100644
--- a/specification/portal/resource-manager/Microsoft.Portal/preview/2020-09-01-preview/portal.json
+++ b/specification/portal/resource-manager/Microsoft.Portal/preview/2020-09-01-preview/portal.json
@@ -500,7 +500,8 @@
"description": "The subtitle of the markdown part."
},
"markdownSource": {
- "type": "object",
+ "type": "integer",
+ "format": "int32",
"description": "The source of the content of the markdown part."
},
"markdownUri": {
@@ -530,11 +531,8 @@
"parts": {
"type": "array",
"description": "The dashboard parts.",
- "additionalProperties": {
- "$ref": "#/definitions/DashboardParts"
- },
"items": {
- "type": "object"
+ "$ref": "#/definitions/DashboardParts"
}
},
"metadata": {
@@ -553,11 +551,8 @@
"lenses": {
"type": "array",
"description": "The dashboard lenses.",
- "additionalProperties": {
- "$ref": "#/definitions/DashboardLens"
- },
"items": {
- "type": "object"
+ "$ref": "#/definitions/DashboardLens"
}
},
"metadata": {
diff --git a/specification/portal/resource-manager/Microsoft.Portal/preview/2020-09-01-preview/tenantConfiguration.json b/specification/portal/resource-manager/Microsoft.Portal/preview/2020-09-01-preview/tenantConfiguration.json
index c9acf88d1a48..31ea569ca460 100644
--- a/specification/portal/resource-manager/Microsoft.Portal/preview/2020-09-01-preview/tenantConfiguration.json
+++ b/specification/portal/resource-manager/Microsoft.Portal/preview/2020-09-01-preview/tenantConfiguration.json
@@ -52,6 +52,9 @@
}
}
},
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
"x-ms-examples": {
"Get list of Tenant configurations": {
"$ref": "examples/TenantConfiguration/GetListOfTenantConfigurations.json"
@@ -177,6 +180,42 @@
}
}
}
+ },
+ "/providers/Microsoft.Portal/listTenantConfigurationViolations": {
+ "post": {
+ "tags": [
+ "listTenantConfigurationViolations"
+ ],
+ "operationId": "ListTenantConfigurationViolations_List",
+ "description": "Gets list of items that violate tenant's configuration.",
+ "parameters": [
+ {
+ "$ref": "portal.json#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK. Returns the list of items that violate tenant's configuration.",
+ "schema": {
+ "$ref": "#/definitions/ViolationsList"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "portal.json#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-examples": {
+ "Get list of of items that violate tenant's configuration": {
+ "$ref": "examples/TenantConfiguration/GetListOfTenantConfigurationViolations.json"
+ }
+ }
+ }
}
},
"parameters": {
@@ -205,7 +244,7 @@
"items": {
"$ref": "#/definitions/Configuration"
},
- "description": "The array of custom resource provider manifests."
+ "description": "The array of tenant configurations."
},
"nextLink": {
"type": "string",
@@ -240,6 +279,44 @@
"description": "When flag is set to true Markdown tile will require external storage configuration (URI). The inline content configuration will be prohibited."
}
}
+ },
+ "ViolationsList": {
+ "type": "object",
+ "properties": {
+ "value": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/Violation"
+ },
+ "description": "The array of violations."
+ },
+ "nextLink": {
+ "type": "string",
+ "description": "The URL to use for getting the next set of results."
+ }
+ },
+ "description": "List of list of items that violate tenant's configuration."
+ },
+ "Violation": {
+ "type": "object",
+ "description": "Violation information.",
+ "properties": {
+ "id": {
+ "description": "Id of the item that violates tenant configuration.",
+ "type": "string",
+ "readOnly": true
+ },
+ "userId": {
+ "description": "Id of the user who owns violated item.",
+ "type": "string",
+ "readOnly": true
+ },
+ "errorMessage": {
+ "description": "Error message.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
}
},
"securityDefinitions": {
diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/CapabilitiesByLocation.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/CapabilitiesByLocation.json
new file mode 100644
index 000000000000..53ba1079a3a2
--- /dev/null
+++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/CapabilitiesByLocation.json
@@ -0,0 +1,180 @@
+{
+ "parameters": {
+ "api-version": "2020-02-14-preview",
+ "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff",
+ "locationName": "WestUS"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "zone": "none",
+ "supportedFlexibleServerEditions": [
+ {
+ "name": "Burstable",
+ "supportedStorageEditions": [
+ {
+ "name": "ManagedDisk",
+ "supportedStorageMB": [
+ {
+ "name": "32768",
+ "supportedIops": 120,
+ "storageSizeMB": 32768
+ },
+ {
+ "name": "65536",
+ "supportedIops": 240,
+ "storageSizeMB": 65536
+ },
+ {
+ "name": "131072",
+ "supportedIops": 500,
+ "storageSizeMB": 131072
+ }
+ ]
+ }
+ ],
+ "supportedServerVersions": [
+ {
+ "name": "12",
+ "supportedVcores": [
+ {
+ "name": "Standard_B1s",
+ "vCores": 1,
+ "supportedIops": 320,
+ "supportedMemoryPerVcoreMB": 1024
+ },
+ {
+ "name": "Standard_B1ms",
+ "vCores": 1,
+ "supportedIops": 640,
+ "supportedMemoryPerVcoreMB": 2048
+ },
+ {
+ "name": "Standard_B2s",
+ "vCores": 2,
+ "supportedIops": 1280,
+ "supportedMemoryPerVcoreMB": 2048
+ }
+ ]
+ }
+ ]
+ }
+ ]
+ },
+ {
+ "zone": "1",
+ "supportedFlexibleServerEditions": [
+ {
+ "name": "Burstable",
+ "supportedStorageEditions": [
+ {
+ "name": "ManagedDisk",
+ "supportedStorageMB": [
+ {
+ "name": "32768",
+ "supportedIops": 120,
+ "storageSizeMB": 32768
+ },
+ {
+ "name": "65536",
+ "supportedIops": 240,
+ "storageSizeMB": 65536
+ },
+ {
+ "name": "131072",
+ "supportedIops": 500,
+ "storageSizeMB": 131072
+ }
+ ]
+ }
+ ],
+ "supportedServerVersions": [
+ {
+ "name": "12",
+ "supportedVcores": [
+ {
+ "name": "Standard_B1s",
+ "vCores": 1,
+ "supportedIops": 320,
+ "supportedMemoryPerVcoreMB": 1024
+ },
+ {
+ "name": "Standard_B1ms",
+ "vCores": 1,
+ "supportedIops": 640,
+ "supportedMemoryPerVcoreMB": 2048
+ },
+ {
+ "name": "Standard_B2s",
+ "vCores": 2,
+ "supportedIops": 1280,
+ "supportedMemoryPerVcoreMB": 2048
+ }
+ ]
+ }
+ ]
+ }
+ ]
+ },
+ {
+ "zone": "2",
+ "supportedFlexibleServerEditions": [
+ {
+ "name": "Burstable",
+ "supportedStorageEditions": [
+ {
+ "name": "ManagedDisk",
+ "supportedStorageMB": [
+ {
+ "name": "32768",
+ "supportedIops": 120,
+ "storageSizeMB": 32768
+ },
+ {
+ "name": "65536",
+ "supportedIops": 240,
+ "storageSizeMB": 65536
+ },
+ {
+ "name": "131072",
+ "supportedIops": 500,
+ "storageSizeMB": 131072
+ }
+ ]
+ }
+ ],
+ "supportedServerVersions": [
+ {
+ "name": "12",
+ "supportedVcores": [
+ {
+ "name": "Standard_B1s",
+ "vCores": 1,
+ "supportedIops": 320,
+ "supportedMemoryPerVcoreMB": 1024
+ },
+ {
+ "name": "Standard_B1ms",
+ "vCores": 1,
+ "supportedIops": 640,
+ "supportedMemoryPerVcoreMB": 2048
+ },
+ {
+ "name": "Standard_B2s",
+ "vCores": 2,
+ "supportedIops": 1280,
+ "supportedMemoryPerVcoreMB": 2048
+ }
+ ]
+ }
+ ]
+ }
+ ]
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/CheckNameAvailability.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/CheckNameAvailability.json
new file mode 100644
index 000000000000..2f20c8dbd88f
--- /dev/null
+++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/CheckNameAvailability.json
@@ -0,0 +1,20 @@
+{
+ "parameters": {
+ "api-version": "2020-02-14-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/2020-02-14-preview/examples/ConfigurationGet.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/ConfigurationGet.json
new file mode 100644
index 000000000000..af66828533e3
--- /dev/null
+++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/ConfigurationGet.json
@@ -0,0 +1,26 @@
+{
+ "parameters": {
+ "configurationName": "array_nulls",
+ "serverName": "testserver",
+ "resourceGroupName": "TestGroup",
+ "api-version": "2020-02-14-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/TestGroup/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/2020-02-14-preview/examples/ConfigurationListByServer.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/ConfigurationListByServer.json
new file mode 100644
index 000000000000..f91e08d1bc30
--- /dev/null
+++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/ConfigurationListByServer.json
@@ -0,0 +1,1902 @@
+{
+ "parameters": {
+ "serverName": "testserver",
+ "resourceGroupName": "TestGroup",
+ "api-version": "2020-02-14-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=2020-02-14-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/TestGroup/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/TestGroup/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/TestGroup/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/TestGroup/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/TestGroup/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/TestGroup/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/TestGroup/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/TestGroup/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/TestGroup/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/TestGroup/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/TestGroup/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/TestGroup/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/TestGroup/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/TestGroup/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/TestGroup/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/TestGroup/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/TestGroup/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/TestGroup/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/TestGroup/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/TestGroup/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/TestGroup/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/TestGroup/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/TestGroup/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/TestGroup/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/TestGroup/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/TestGroup/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/TestGroup/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/TestGroup/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/TestGroup/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/TestGroup/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/TestGroup/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/TestGroup/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/TestGroup/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/TestGroup/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/TestGroup/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/TestGroup/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/TestGroup/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/TestGroup/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/TestGroup/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/TestGroup/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/TestGroup/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/TestGroup/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/TestGroup/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/TestGroup/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/TestGroup/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/TestGroup/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/TestGroup/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/TestGroup/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/TestGroup/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/TestGroup/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/TestGroup/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/TestGroup/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/TestGroup/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/TestGroup/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/TestGroup/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/TestGroup/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/TestGroup/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/TestGroup/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/TestGroup/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/TestGroup/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/TestGroup/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/TestGroup/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/TestGroup/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/TestGroup/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/TestGroup/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/TestGroup/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/TestGroup/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/TestGroup/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/TestGroup/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/TestGroup/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/TestGroup/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/TestGroup/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/TestGroup/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/TestGroup/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/TestGroup/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/TestGroup/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/TestGroup/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/TestGroup/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/TestGroup/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/TestGroup/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/TestGroup/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/TestGroup/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/TestGroup/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/TestGroup/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/TestGroup/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/TestGroup/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/TestGroup/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/TestGroup/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/TestGroup/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/TestGroup/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/TestGroup/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/TestGroup/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/TestGroup/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/TestGroup/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/TestGroup/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/TestGroup/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/TestGroup/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/TestGroup/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/TestGroup/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/TestGroup/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/TestGroup/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/TestGroup/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/TestGroup/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/TestGroup/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/TestGroup/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/TestGroup/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/TestGroup/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/TestGroup/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/TestGroup/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/TestGroup/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/TestGroup/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/TestGroup/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/TestGroup/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/TestGroup/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/TestGroup/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/TestGroup/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/TestGroup/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/TestGroup/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/TestGroup/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/TestGroup/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/TestGroup/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/TestGroup/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/TestGroup/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/TestGroup/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/TestGroup/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/TestGroup/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/TestGroup/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/TestGroup/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/TestGroup/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/TestGroup/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/TestGroup/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/TestGroup/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/TestGroup/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/TestGroup/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/TestGroup/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/TestGroup/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/TestGroup/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/TestGroup/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/TestGroup/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/TestGroup/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/TestGroup/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/TestGroup/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/TestGroup/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/TestGroup/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/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/xmloption",
+ "name": "xmloption",
+ "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations"
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/ConfigurationUpdate.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/ConfigurationUpdate.json
new file mode 100644
index 000000000000..fe1ffbb8c42a
--- /dev/null
+++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/ConfigurationUpdate.json
@@ -0,0 +1,33 @@
+{
+ "parameters": {
+ "serverName": "testserver",
+ "configurationName": "event_scheduler",
+ "resourceGroupName": "testrg",
+ "api-version": "2020-02-14-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/2020-02-14-preview/examples/FirewallRuleCreate.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/FirewallRuleCreate.json
new file mode 100644
index 000000000000..6cb0471d8f0c
--- /dev/null
+++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/FirewallRuleCreate.json
@@ -0,0 +1,40 @@
+{
+ "parameters": {
+ "firewallRuleName": "rule1",
+ "serverName": "testserver",
+ "resourceGroupName": "TestGroup",
+ "api-version": "2020-02-14-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.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/TestGroup/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/2020-02-14-preview/examples/FirewallRuleDelete.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/FirewallRuleDelete.json
new file mode 100644
index 000000000000..37cdd35b0e54
--- /dev/null
+++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/FirewallRuleDelete.json
@@ -0,0 +1,14 @@
+{
+ "parameters": {
+ "firewallRuleName": "rule1",
+ "serverName": "testserver",
+ "resourceGroupName": "TestGroup",
+ "api-version": "2020-02-14-preview",
+ "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff"
+ },
+ "responses": {
+ "200": {},
+ "202": {},
+ "204": {}
+ }
+}
diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/FirewallRuleGet.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/FirewallRuleGet.json
new file mode 100644
index 000000000000..afbe99290ead
--- /dev/null
+++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/FirewallRuleGet.json
@@ -0,0 +1,22 @@
+{
+ "parameters": {
+ "firewallRuleName": "rule1",
+ "serverName": "testserver",
+ "resourceGroupName": "TestGroup",
+ "api-version": "2020-02-14-preview",
+ "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/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/2020-02-14-preview/examples/FirewallRuleListByServer.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/FirewallRuleListByServer.json
new file mode 100644
index 000000000000..53acea0b30a1
--- /dev/null
+++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/FirewallRuleListByServer.json
@@ -0,0 +1,35 @@
+{
+ "parameters": {
+ "serverName": "testserver",
+ "resourceGroupName": "TestGroup",
+ "api-version": "2020-02-14-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=2020-02-14-privatepreview&$top=2&$skiptoken=skiptoken",
+ "value": [
+ {
+ "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/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/TestGroup/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/2020-02-14-preview/examples/OperationList.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/OperationList.json
new file mode 100644
index 000000000000..034fdc616edd
--- /dev/null
+++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/OperationList.json
@@ -0,0 +1,176 @@
+{
+ "parameters": {
+ "api-version": "2020-02-14-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/2020-02-14-preview/examples/ServerCreate.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/ServerCreate.json
new file mode 100644
index 000000000000..6f8e66d7030e
--- /dev/null
+++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/ServerCreate.json
@@ -0,0 +1,115 @@
+{
+ "parameters": {
+ "serverName": "pgtestsvc4",
+ "resourceGroupName": "testrg",
+ "api-version": "2020-02-14-preview",
+ "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff",
+ "parameters": {
+ "location": "westus",
+ "sku": {
+ "tier": "GeneralPurpose",
+ "name": "Standard_D4s_v3"
+ },
+ "properties": {
+ "administratorLogin": "cloudsa",
+ "administratorLoginPassword": "password",
+ "version": "12",
+ "haEnabled": "Enabled",
+ "delegatedSubnetArguments": {
+ "subnetArmResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-vnet-subnet"
+ },
+ "storageProfile": {
+ "storageMB": 524288,
+ "backupRetentionDays": 7
+ },
+ "availabilityZone": "1"
+ },
+ "tags": {
+ "ElasticServer": "1"
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "body": {
+ "sku": {
+ "tier": "GeneralPurpose",
+ "name": "Standard_D4s_v3"
+ },
+ "properties": {
+ "administratorLogin": "cloudsa",
+ "version": "12",
+ "state": "Ready",
+ "haState": "NotEnabled",
+ "fullyQualifiedDomainName": "pgtestsvc4.postgres.database.azure.com",
+ "displayName": "demosingleserver",
+ "publicNetworkAccess": "Enabled",
+ "haEnabled": "Enabled",
+ "delegatedSubnetArguments": {
+ "subnetArmResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-vnet-subnet"
+ },
+ "storageProfile": {
+ "storageMB": 524288,
+ "backupRetentionDays": 7
+ },
+ "availabilityZone": "1",
+ "standbyAvailabilityZone": "2",
+ "maintenanceWindow": {
+ "dayOfWeek": 0,
+ "startHour": 0,
+ "startMinute": 0,
+ "customWindow": "Disabled"
+ }
+ },
+ "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": {
+ "tier": "GeneralPurpose",
+ "name": "Standard_D4s_v3"
+ },
+ "properties": {
+ "administratorLogin": "cloudsa",
+ "version": "12",
+ "state": "Ready",
+ "haState": "NotEnabled",
+ "fullyQualifiedDomainName": "pgtestsvc4.postgres.database.azure.com",
+ "displayName": "demosingleserver",
+ "publicNetworkAccess": "Enabled",
+ "haEnabled": "Enabled",
+ "delegatedSubnetArguments": {
+ "subnetArmResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-vnet-subnet"
+ },
+ "storageProfile": {
+ "storageMB": 524288,
+ "backupRetentionDays": 7
+ },
+ "availabilityZone": "1",
+ "standbyAvailabilityZone": "2",
+ "maintenanceWindow": {
+ "dayOfWeek": 0,
+ "startHour": 0,
+ "startMinute": 0,
+ "customWindow": "Disabled"
+ }
+ },
+ "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/2020-02-14-preview/examples/ServerCreatePointInTimeRestore.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/ServerCreatePointInTimeRestore.json
new file mode 100644
index 000000000000..bb1f9c485e7d
--- /dev/null
+++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/ServerCreatePointInTimeRestore.json
@@ -0,0 +1,81 @@
+{
+ "parameters": {
+ "serverName": "pgtestsvc4",
+ "resourceGroupName": "TestGroup",
+ "api-version": "2020-02-14-preview",
+ "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff",
+ "parameters": {
+ "location": "westus",
+ "properties": {
+ "createMode": "PointInTimeRestore",
+ "sourceServerName": "sourcePgServerName",
+ "pointInTimeUTC": "2020-06-30T23:41:49.000Z"
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "body": {
+ "sku": {
+ "tier": "GeneralPurpose",
+ "name": "Standard_D4s_v3"
+ },
+ "properties": {
+ "administratorLogin": "cloudsa",
+ "version": "12",
+ "state": "Ready",
+ "haState": "NotEnabled",
+ "fullyQualifiedDomainName": "pgtestsvc4.postgres.database.azure.com",
+ "displayName": "demosingleserver",
+ "publicNetworkAccess": "Enabled",
+ "haEnabled": "Disabled",
+ "delegatedSubnetArguments": {},
+ "storageProfile": {
+ "storageMB": 524288,
+ "backupRetentionDays": 7
+ },
+ "availabilityZone": "1"
+ },
+ "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": {
+ "tier": "GeneralPurpose",
+ "name": "Standard_D4s_v3"
+ },
+ "properties": {
+ "administratorLogin": "cloudsa",
+ "version": "12",
+ "state": "Ready",
+ "haState": "NotEnabled",
+ "fullyQualifiedDomainName": "pgtestsvc4.postgres.database.azure.com",
+ "displayName": "demosingleserver",
+ "publicNetworkAccess": "Enabled",
+ "haEnabled": "Disabled",
+ "delegatedSubnetArguments": {},
+ "storageProfile": {
+ "storageMB": 524288,
+ "backupRetentionDays": 7
+ },
+ "availabilityZone": "1"
+ },
+ "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/2020-02-14-preview/examples/ServerDelete.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/ServerDelete.json
new file mode 100644
index 000000000000..5ccafe7a9954
--- /dev/null
+++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/ServerDelete.json
@@ -0,0 +1,13 @@
+{
+ "parameters": {
+ "serverName": "testserver",
+ "resourceGroupName": "TestGroup",
+ "api-version": "2020-02-14-preview",
+ "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff"
+ },
+ "responses": {
+ "200": {},
+ "202": {},
+ "204": {}
+ }
+}
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
new file mode 100644
index 000000000000..b28535f615a1
--- /dev/null
+++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/ServerGet.json
@@ -0,0 +1,47 @@
+{
+ "parameters": {
+ "serverName": "pgtestsvc1",
+ "resourceGroupName": "testrg",
+ "api-version": "2020-02-14-preview",
+ "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "sku": {
+ "tier": "GeneralPurpose",
+ "name": "Standard_D4s_v3"
+ },
+ "properties": {
+ "administratorLogin": "cloudsa",
+ "version": "12",
+ "state": "Ready",
+ "haState": "NotEnabled",
+ "fullyQualifiedDomainName": "pgtestsvc4.postgres.database.azure.com",
+ "displayName": "demosingleserver",
+ "publicNetworkAccess": "Enabled",
+ "storageProfile": {
+ "storageMB": 524288,
+ "backupRetentionDays": 7
+ },
+ "haEnabled": "Enabled",
+ "availabilityZone": "1",
+ "standbyAvailabilityZone": "2",
+ "maintenanceWindow": {
+ "dayOfWeek": 0,
+ "startHour": 0,
+ "startMinute": 0,
+ "customWindow": "Disabled"
+ }
+ },
+ "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/2020-02-14-preview/examples/ServerGetWithVnet.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/ServerGetWithVnet.json
new file mode 100644
index 000000000000..9c8216593f4c
--- /dev/null
+++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/ServerGetWithVnet.json
@@ -0,0 +1,42 @@
+{
+ "parameters": {
+ "serverName": "pgtestsvc1",
+ "resourceGroupName": "testrg",
+ "api-version": "2020-02-14-preview",
+ "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "sku": {
+ "tier": "GeneralPurpose",
+ "name": "Standard_D4s_v3"
+ },
+ "properties": {
+ "administratorLogin": "cloudsa",
+ "version": "12",
+ "state": "Ready",
+ "haState": "NotEnabled",
+ "fullyQualifiedDomainName": "pgtestsvc4.postgres.database.azure.com",
+ "displayName": "demosingleserver",
+ "publicNetworkAccess": "Disabled",
+ "delegatedSubnetArguments": {
+ "subnetArmResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-vnet-subnet"
+ },
+ "storageProfile": {
+ "storageMB": 524288,
+ "backupRetentionDays": 7
+ },
+ "availabilityZone": "1"
+ },
+ "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/2020-02-14-preview/examples/ServerList.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/ServerList.json
new file mode 100644
index 000000000000..d8917699f069
--- /dev/null
+++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/ServerList.json
@@ -0,0 +1,153 @@
+{
+ "parameters": {
+ "api-version": "2020-02-14-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=2020-02-14-privatepreview&$top=3&$skiptoken=skiptoken",
+ "value": [
+ {
+ "sku": {
+ "tier": "GeneralPurpose",
+ "name": "Standard_D4s_v3"
+ },
+ "properties": {
+ "administratorLogin": "cloudsa",
+ "version": "12",
+ "state": "Ready",
+ "haState": "NotEnabled",
+ "fullyQualifiedDomainName": "pgtestsvc1.postgres.database.azure.com",
+ "displayName": "demosingleserver",
+ "publicNetworkAccess": "Enabled",
+ "storageProfile": {
+ "storageMB": 524288,
+ "backupRetentionDays": 7
+ },
+ "haEnabled": "Enabled",
+ "availabilityZone": "1",
+ "standbyAvailabilityZone": "2",
+ "maintenanceWindow": {
+ "dayOfWeek": 0,
+ "startHour": 0,
+ "startMinute": 0,
+ "customWindow": "Disabled"
+ }
+ },
+ "location": "westus",
+ "tags": {
+ "Server": "1"
+ },
+ "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc1",
+ "name": "pgtestsvc1",
+ "type": "Microsoft.DBforPostgreSQL/flexibleServers"
+ },
+ {
+ "sku": {
+ "tier": "GeneralPurpose",
+ "name": "Standard_D4s_v3"
+ },
+ "properties": {
+ "administratorLogin": "cloudsa",
+ "version": "12",
+ "state": "Ready",
+ "haState": "Healthy",
+ "fullyQualifiedDomainName": "pgtestsvc2.postgres.database.azure.com",
+ "displayName": "demosingleserver",
+ "publicNetworkAccess": "Enabled",
+ "storageProfile": {
+ "storageMB": 524288,
+ "backupRetentionDays": 7
+ },
+ "haEnabled": "Disabled",
+ "availabilityZone": "2",
+ "maintenanceWindow": {
+ "dayOfWeek": 0,
+ "startHour": 10,
+ "startMinute": 30,
+ "customWindow": "Enabled"
+ }
+ },
+ "location": "westus",
+ "tags": {
+ "Server": "2"
+ },
+ "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc2",
+ "name": "pgtestsvc2",
+ "type": "Microsoft.DBforPostgreSQL/flexibleServers"
+ },
+ {
+ "sku": {
+ "tier": "GeneralPurpose",
+ "name": "Standard_D4s_v3"
+ },
+ "properties": {
+ "administratorLogin": "cloudsa",
+ "version": "12",
+ "state": "Ready",
+ "haState": "FailingOver",
+ "fullyQualifiedDomainName": "pgtestsvc3.postgres.database.azure.com",
+ "displayName": "demosingleserver",
+ "publicNetworkAccess": "Enabled",
+ "storageProfile": {
+ "storageMB": 524288,
+ "backupRetentionDays": 7
+ },
+ "haEnabled": "Disabled",
+ "availabilityZone": "3",
+ "maintenanceWindow": {
+ "dayOfWeek": 0,
+ "startHour": 0,
+ "startMinute": 0,
+ "customWindow": "Disabled"
+ }
+ },
+ "location": "westus",
+ "tags": {
+ "Server": "3"
+ },
+ "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc3",
+ "name": "pgtestsvc3",
+ "type": "Microsoft.DBforPostgreSQL/flexibleServers"
+ },
+ {
+ "sku": {
+ "tier": "GeneralPurpose",
+ "name": "Standard_D4s_v3"
+ },
+ "properties": {
+ "administratorLogin": "cloudsa",
+ "version": "12",
+ "state": "Ready",
+ "haState": "ReplicatingData",
+ "fullyQualifiedDomainName": "pgtestsvc4.postgres.database.azure.com",
+ "displayName": "demosingleserver",
+ "publicNetworkAccess": "Enabled",
+ "storageProfile": {
+ "storageMB": 524288,
+ "backupRetentionDays": 7
+ },
+ "haEnabled": "Enabled",
+ "availabilityZone": "1",
+ "standbyAvailabilityZone": "2",
+ "maintenanceWindow": {
+ "dayOfWeek": 0,
+ "startHour": 0,
+ "startMinute": 0,
+ "customWindow": "Disabled"
+ }
+ },
+ "location": "westus",
+ "tags": {
+ "Server": "4"
+ },
+ "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/2020-02-14-preview/examples/ServerListByResourceGroup.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/ServerListByResourceGroup.json
new file mode 100644
index 000000000000..276e20cb04d8
--- /dev/null
+++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/ServerListByResourceGroup.json
@@ -0,0 +1,113 @@
+{
+ "parameters": {
+ "resourceGroupName": "testrg",
+ "api-version": "2020-02-14-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=2020-02-14-privatepreview&$top=3&$skiptoken=skiptoken",
+ "value": [
+ {
+ "sku": {
+ "tier": "GeneralPurpose",
+ "name": "Standard_D4s_v3"
+ },
+ "properties": {
+ "administratorLogin": "testuser",
+ "version": "12",
+ "state": "Ready",
+ "haState": "NotEnabled",
+ "fullyQualifiedDomainName": "pgtestsvc4.postgres.database.azure.com",
+ "displayName": "demosingleserver",
+ "publicNetworkAccess": "Enabled",
+ "storageProfile": {
+ "storageMB": 524288,
+ "backupRetentionDays": 7
+ },
+ "haEnabled": "Enabled",
+ "availabilityZone": "1",
+ "standbyAvailabilityZone": "2",
+ "maintenanceWindow": {
+ "dayOfWeek": 0,
+ "startHour": 10,
+ "startMinute": 30,
+ "customWindow": "Enabled"
+ }
+ },
+ "location": "westus",
+ "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/servers/pgtestsvc1",
+ "name": "pgtestsvc1",
+ "type": "Microsoft.DBforPostgreSQL/flexibleServers"
+ },
+ {
+ "sku": {
+ "tier": "GeneralPurpose",
+ "name": "Standard_D4s_v3"
+ },
+ "properties": {
+ "administratorLogin": "testuser",
+ "version": "12",
+ "state": "Ready",
+ "haState": "Healthy",
+ "fullyQualifiedDomainName": "pgtestsvc4.postgres.database.azure.com",
+ "displayName": "demosingleserver",
+ "publicNetworkAccess": "Enabled",
+ "storageProfile": {
+ "storageMB": 524288,
+ "backupRetentionDays": 7
+ },
+ "haEnabled": "Disabled",
+ "availabilityZone": "2",
+ "maintenanceWindow": {
+ "dayOfWeek": 0,
+ "startHour": 0,
+ "startMinute": 0,
+ "customWindow": "Disabled"
+ }
+ },
+ "location": "westus",
+ "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc2",
+ "name": "pgtestsvc2",
+ "type": "Microsoft.DBforPostgreSQL/flexibleServers"
+ },
+ {
+ "sku": {
+ "tier": "GeneralPurpose",
+ "name": "Standard_D4s_v3"
+ },
+ "properties": {
+ "administratorLogin": "testuser",
+ "version": "12",
+ "state": "Ready",
+ "haState": "Healthy",
+ "fullyQualifiedDomainName": "pgtestsvc4.postgres.database.azure.com",
+ "displayName": "demosingleserver",
+ "publicNetworkAccess": "Enabled",
+ "storageProfile": {
+ "storageMB": 524288,
+ "backupRetentionDays": 7
+ },
+ "haEnabled": "Disabled",
+ "availabilityZone": "3",
+ "maintenanceWindow": {
+ "dayOfWeek": 0,
+ "startHour": 10,
+ "startMinute": 30,
+ "customWindow": "Enabled"
+ }
+ },
+ "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/2020-02-14-preview/examples/ServerRestart.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/ServerRestart.json
new file mode 100644
index 000000000000..3b73691fcba8
--- /dev/null
+++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/ServerRestart.json
@@ -0,0 +1,12 @@
+{
+ "parameters": {
+ "serverName": "testserver",
+ "resourceGroupName": "TestGroup",
+ "api-version": "2020-02-14-preview",
+ "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff"
+ },
+ "responses": {
+ "200": {},
+ "202": {}
+ }
+}
diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/ServerStart.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/ServerStart.json
new file mode 100644
index 000000000000..3b73691fcba8
--- /dev/null
+++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/ServerStart.json
@@ -0,0 +1,12 @@
+{
+ "parameters": {
+ "serverName": "testserver",
+ "resourceGroupName": "TestGroup",
+ "api-version": "2020-02-14-preview",
+ "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff"
+ },
+ "responses": {
+ "200": {},
+ "202": {}
+ }
+}
diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/ServerStop.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/ServerStop.json
new file mode 100644
index 000000000000..3b73691fcba8
--- /dev/null
+++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/ServerStop.json
@@ -0,0 +1,12 @@
+{
+ "parameters": {
+ "serverName": "testserver",
+ "resourceGroupName": "TestGroup",
+ "api-version": "2020-02-14-preview",
+ "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff"
+ },
+ "responses": {
+ "200": {},
+ "202": {}
+ }
+}
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
new file mode 100644
index 000000000000..08994e49f0ba
--- /dev/null
+++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/ServerUpdate.json
@@ -0,0 +1,56 @@
+{
+ "parameters": {
+ "serverName": "pgtestsvc4",
+ "resourceGroupName": "TestGroup",
+ "api-version": "2020-02-14-preview",
+ "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff",
+ "parameters": {
+ "location": "westus",
+ "sku": {
+ "tier": "GeneralPurpose",
+ "name": "Standard_D4s_v3"
+ },
+ "properties": {
+ "administratorLoginPassword": "newpassword",
+ "storageProfile": {
+ "storageMB": 524288,
+ "backupRetentionDays": 20
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "sku": {
+ "tier": "GeneralPurpose",
+ "name": "Standard_D4s_v3"
+ },
+ "properties": {
+ "administratorLogin": "cloudsa",
+ "version": "12",
+ "state": "Ready",
+ "haState": "NotEnabled",
+ "fullyQualifiedDomainName": "pgtestsvc4.postgres.database.azure.com",
+ "displayName": "demosingleserver",
+ "publicNetworkAccess": "Enabled",
+ "storageProfile": {
+ "storageMB": 524288,
+ "backupRetentionDays": 20
+ },
+ "delegatedSubnetArguments": {},
+ "haEnabled": "Disabled",
+ "availabilityZone": "1"
+ },
+ "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/2020-02-14-preview/examples/ServerUpdateWithCustomerMaintenanceWindow.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/ServerUpdateWithCustomerMaintenanceWindow.json
new file mode 100644
index 000000000000..bcd94b4eeae5
--- /dev/null
+++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/ServerUpdateWithCustomerMaintenanceWindow.json
@@ -0,0 +1,59 @@
+{
+ "parameters": {
+ "serverName": "pgtestsvc4",
+ "resourceGroupName": "testrg",
+ "api-version": "2020-02-14-preview",
+ "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff",
+ "parameters": {
+ "location": "westus",
+ "properties": {
+ "maintenanceWindow": {
+ "dayOfWeek": 0,
+ "startHour": 8,
+ "startMinute": 0,
+ "customWindow": "Enabled"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "sku": {
+ "tier": "GeneralPurpose",
+ "name": "Standard_D4s_v3"
+ },
+ "properties": {
+ "administratorLogin": "cloudsa",
+ "version": "12",
+ "state": "Ready",
+ "haState": "NotEnabled",
+ "fullyQualifiedDomainName": "pgtestsvc4.postgres.database.azure.com",
+ "displayName": "demosingleserver",
+ "publicNetworkAccess": "Enabled",
+ "storageProfile": {
+ "storageMB": 524288,
+ "backupRetentionDays": 20
+ },
+ "delegatedSubnetArguments": {},
+ "haEnabled": "Disabled",
+ "availabilityZone": "1",
+ "maintenanceWindow": {
+ "dayOfWeek": 0,
+ "startHour": 8,
+ "startMinute": 0,
+ "customWindow": "Enabled"
+ }
+ },
+ "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/2020-02-14-preview/examples/VirtualNetworkSubnetUsage.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/VirtualNetworkSubnetUsage.json
new file mode 100644
index 000000000000..c35f70ea13f8
--- /dev/null
+++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/VirtualNetworkSubnetUsage.json
@@ -0,0 +1,26 @@
+{
+ "parameters": {
+ "api-version": "2020-02-14-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/2020-02-14-preview/postgresql.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/postgresql.json
new file mode 100644
index 000000000000..689e6b053dd1
--- /dev/null
+++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/postgresql.json
@@ -0,0 +1,1788 @@
+{
+ "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": "2020-02-14-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"
+ }
+ },
+ "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"
+ }
+ ],
+ "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
+ }
+ },
+ "/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
+ }
+ },
+ "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
+ }
+ },
+ "description": "Vcores capability"
+ },
+ "ServerVersionCapability": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "server version",
+ "readOnly": true
+ },
+ "supportedVcores": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/VcoreCapability"
+ },
+ "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
+ }
+ },
+ "description": "storage edition capability"
+ },
+ "ServerEditionCapability": {
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "Server edition name",
+ "readOnly": true
+ },
+ "supportedStorageEditions": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/StorageEditionCapability"
+ },
+ "readOnly": true
+ },
+ "supportedServerVersions": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ServerVersionCapability"
+ },
+ "readOnly": true
+ }
+ },
+ "description": "Server edition capabilities."
+ },
+ "CapabilityProperties": {
+ "properties": {
+ "zone": {
+ "type": "string",
+ "description": "zone name",
+ "readOnly": true
+ },
+ "supportedFlexibleServerEditions": {
+ "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"
+ },
+ "ServerVersion": {
+ "type": "string",
+ "description": "The version of a server.",
+ "enum": [
+ "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."
+ },
+ "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
+ }
+ },
+ "haState": {
+ "type": "string",
+ "description": "A state of a HA server that is visible to user.",
+ "enum": [
+ "NotEnabled",
+ "CreatingStandby",
+ "ReplicatingData",
+ "FailingOver",
+ "Healthy",
+ "RemovingStandby"
+ ],
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "ServerHAState",
+ "modelAsString": true
+ }
+ },
+ "fullyQualifiedDomainName": {
+ "type": "string",
+ "description": "The fully qualified domain name of a server.",
+ "readOnly": true
+ },
+ "displayName": {
+ "type": "string",
+ "description": "The display name of a server."
+ },
+ "storageProfile": {
+ "$ref": "#/definitions/StorageProfile",
+ "description": "Storage profile of a server."
+ },
+ "publicNetworkAccess": {
+ "type": "string",
+ "description": "public network access is enabled or not",
+ "enum": [
+ "Enabled",
+ "Disabled"
+ ],
+ "x-ms-enum": {
+ "name": "ServerPublicNetworkAccessState",
+ "modelAsString": true
+ },
+ "readOnly": true
+ },
+ "maintenanceWindow": {
+ "$ref": "#/definitions/MaintenanceWindow",
+ "description": "Maintenance window of a server."
+ },
+ "haEnabled": {
+ "type": "string",
+ "description": "stand by count value can be either enabled or disabled",
+ "enum": [
+ "Enabled",
+ "Disabled"
+ ],
+ "x-ms-enum": {
+ "name": "HAEnabledEnum",
+ "modelAsString": false
+ }
+ },
+ "sourceServerName": {
+ "type": "string",
+ "description": "The source PostgreSQL server name to restore from."
+ },
+ "pointInTimeUTC": {
+ "type": "string",
+ "format": "date-time",
+ "description": "Restore point creation time (ISO8601 format), specifying the time to restore from."
+ },
+ "availabilityZone": {
+ "type": "string",
+ "description": "availability Zone information of the server."
+ },
+ "standbyAvailabilityZone": {
+ "type": "string",
+ "description": "availability Zone information of the server.",
+ "readOnly": true
+ },
+ "byokEnforcement": {
+ "type": "string",
+ "description": "Status showing whether the data encryption is enabled with customer-managed keys.",
+ "readOnly": true
+ },
+ "delegatedSubnetArguments": {
+ "properties": {
+ "subnetArmResourceId": {
+ "type": "string",
+ "description": "delegated subnet arm resource id."
+ }
+ }
+ },
+ "createMode": {
+ "type": "string",
+ "description": "The mode to create a new PostgreSQL server.",
+ "enum": [
+ "Default",
+ "PointInTimeRestore"
+ ],
+ "x-ms-enum": {
+ "name": "CreateMode",
+ "modelAsString": true
+ },
+ "x-ms-mutability": [
+ "create"
+ ]
+ },
+ "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": {
+ "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."
+ }
+ },
+ "allOf": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/TrackedResource"
+ }
+ ],
+ "description": "Represents a server."
+ },
+ "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"
+ }
+ }
+ },
+ "ServerPropertiesForUpdate": {
+ "properties": {
+ "administratorLoginPassword": {
+ "type": "string",
+ "format": "password",
+ "description": "The password of the administrator login."
+ },
+ "storageProfile": {
+ "$ref": "#/definitions/StorageProfile",
+ "description": "Storage profile of a server."
+ },
+ "haEnabled": {
+ "type": "string",
+ "description": "stand by count value can be either enabled or disabled",
+ "enum": [
+ "Enabled",
+ "Disabled"
+ ],
+ "x-ms-enum": {
+ "name": "HAEnabledEnum",
+ "modelAsString": false
+ }
+ },
+ "maintenanceWindow": {
+ "$ref": "#/definitions/MaintenanceWindow",
+ "description": "Maintenance window of a server."
+ }
+ }
+ },
+ "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."
+ },
+ "StorageProfile": {
+ "properties": {
+ "backupRetentionDays": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Backup retention days for the server."
+ },
+ "storageMB": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Max storage allowed for a server."
+ }
+ },
+ "description": "Storage Profile properties of a server"
+ },
+ "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."
+ },
+ "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."
+ }
+ },
+ "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."
+ }
+ },
+ "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."
+ },
+ "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 76ec7d9c39f1..371cc48113e3 100644
--- a/specification/postgresql/resource-manager/readme.go.md
+++ b/specification/postgresql/resource-manager/readme.go.md
@@ -12,7 +12,7 @@ go:
``` yaml $(go) && $(multiapi)
batch:
- - tag: package-2020-02-14-privatepreview
+ - tag: package-2020-02-14-preview
- tag: package-2020-01-01
- tag: package-2017-12-01-preview
- tag: package-2017-12-01
@@ -20,10 +20,10 @@ batch:
### Tag: package-2020-02-14 and go
-These settings apply only when `--tag=package-2020-02-14-privatepreview --go` is specified on the command line.
+These settings apply only when `--tag=package-2020-02-14-preview --go` is specified on the command line.
Please also specify `--go-sdk-folder=`.
-``` yaml $(tag) == 'package-2020-02-14-privatepreview' && $(go)
+``` yaml $(tag) == 'package-2020-02-14-preview' && $(go)
rpname: postgresql
namespace: postgresqlflexibleservers
output-folder: $(go-sdk-folder)/services/preview/$(rpname)/mgmt/2020-02-14-preview/$(namespace)
diff --git a/specification/postgresql/resource-manager/readme.md b/specification/postgresql/resource-manager/readme.md
index 583f1c230d97..9ec87bd2f7a0 100644
--- a/specification/postgresql/resource-manager/readme.md
+++ b/specification/postgresql/resource-manager/readme.md
@@ -30,6 +30,16 @@ description: The Microsoft Azure management API provides create, read, update, a
openapi-type: arm
tag: package-2020-01-01
```
+### Tag: package-2020-02-14-preview
+
+These settings apply only when `--tag=package-2020-02-14-preview` is specified on the command line.
+
+
+``` yaml $(tag) == 'package-2020-02-14-preview'
+input-file:
+- Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/postgresql.json
+```
+
### Tag: package-2020-02-14-privatepreview
@@ -154,7 +164,7 @@ csharp:
azure-arm: true
license-header: MICROSOFT_MIT_NO_VERSION
namespace: Microsoft.Azure.Management.PostgreSQL
- output-folder: $(csharp-sdks-folder)/postgresql/Microsoft.Azure.Management.PostgreSQL/src/Generated
+ output-folder: $(csharp-sdks-folder)/postgresql/Microsoft.Azure.Management.PostgreSQL/src/postgresql/Generated
clear-output-folder: true
```
@@ -174,3 +184,36 @@ See configuration in [readme.java.md](./readme.java.md)
See configuration in [readme.azureresourceschema.md](./readme.azureresourceschema.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.DBforPostgreSQL/preview/2020-02-14-preview/postgresql.json
+ - $(this-folder)/Microsoft.DBforPostgreSQL/preview/2020-02-14-privatepreview/postgresql.json
+ - $(this-folder)/Microsoft.DBforPostgreSQL/preview/2020-01-01-privatepreview/DataEncryptionKeys.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
+ - $(this-folder)/Microsoft.DBforPostgreSQL/stable/2018-06-01/PrivateLinkResources.json
+ - $(this-folder)/Microsoft.DBforPostgreSQL/stable/2020-01-01/DataEncryptionKeys.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
+
+```
+
+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/postgresql/resource-manager/readme.python.md b/specification/postgresql/resource-manager/readme.python.md
index 29ba59d0973c..a0c7fe2f1884 100644
--- a/specification/postgresql/resource-manager/readme.python.md
+++ b/specification/postgresql/resource-manager/readme.python.md
@@ -30,14 +30,14 @@ Generate all API versions currently shipped for this package
```yaml !$(track2)
batch:
- tag: package-2020-01-01
- - tag: package-2020-02-14-privatepreview
+ - tag: package-2020-02-14-preview
```
```yaml $(track2)
clear-output-folder: true
batch:
- tag: package-2020-01-01
- - tag: package-2020-02-14-privatepreview
+ - tag: package-2020-02-14-preview
```
### Tag: package-2020-01-01 and python
@@ -53,12 +53,12 @@ python:
output-folder: $(python-sdks-folder)/rdbms/azure-mgmt-rdbms/azure/mgmt/rdbms/postgresql
```
-### Tag: package-2020-02-14-privatepreview and python
+### Tag: package-2020-02-14-preview and python
-These settings apply only when `--tag=package-2020-02-14-privatepreview --python` is specified on the command line.
+These settings apply only when `--tag=package-2020-02-14-preview --python` is specified on the command line.
Please also specify `--python-sdks-folder=`.
-``` yaml $(tag) == 'package-2020-02-14-privatepreview' && $(python)
+``` yaml $(tag) == 'package-2020-02-14-preview' && $(python)
namespace: azure.mgmt.rdbms.postgresql_flexibleservers
output-folder: $(python-sdks-folder)/rdbms/azure-mgmt-rdbms/azure/mgmt/rdbms/postgresql_flexibleservers
python:
diff --git a/specification/redis/resource-manager/Microsoft.Cache/stable/2020-06-01/examples/RedisCacheCheckNameAvailability.json b/specification/redis/resource-manager/Microsoft.Cache/stable/2020-06-01/examples/RedisCacheCheckNameAvailability.json
new file mode 100644
index 000000000000..e6f25307359b
--- /dev/null
+++ b/specification/redis/resource-manager/Microsoft.Cache/stable/2020-06-01/examples/RedisCacheCheckNameAvailability.json
@@ -0,0 +1,13 @@
+{
+ "parameters": {
+ "api-version": "2020-06-01",
+ "subscriptionId": "subid",
+ "parameters": {
+ "type": "Microsoft.Cache/Redis",
+ "name": "cacheName"
+ }
+ },
+ "responses": {
+ "200": {}
+ }
+}
diff --git a/specification/redis/resource-manager/Microsoft.Cache/stable/2020-06-01/examples/RedisCacheCreate.json b/specification/redis/resource-manager/Microsoft.Cache/stable/2020-06-01/examples/RedisCacheCreate.json
new file mode 100644
index 000000000000..4cd765b2b990
--- /dev/null
+++ b/specification/redis/resource-manager/Microsoft.Cache/stable/2020-06-01/examples/RedisCacheCreate.json
@@ -0,0 +1,178 @@
+{
+ "parameters": {
+ "name": "cache1",
+ "resourceGroupName": "rg1",
+ "api-version": "2020-06-01",
+ "subscriptionId": "subid",
+ "parameters": {
+ "location": "West US",
+ "zones": [
+ "1"
+ ],
+ "properties": {
+ "sku": {
+ "name": "Premium",
+ "family": "P",
+ "capacity": 1
+ },
+ "enableNonSslPort": true,
+ "shardCount": 2,
+ "replicasPerMaster": 2,
+ "redisConfiguration": {
+ "maxmemory-policy": "allkeys-lru"
+ },
+ "subnetId": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/virtualNetworks/network1/subnets/subnet1",
+ "staticIP": "192.168.0.5",
+ "minimumTlsVersion": "1.2"
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "body": {
+ "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/Redis/cache1",
+ "location": "West US",
+ "zones": [
+ "1"
+ ],
+ "name": "cache1",
+ "type": "Microsoft.Cache/Redis",
+ "tags": {},
+ "properties": {
+ "accessKeys": {
+ "primaryKey": "secretkey1",
+ "secondaryKey": "secretKey2"
+ },
+ "provisioningState": "Succeeded",
+ "redisVersion": "3.0",
+ "sku": {
+ "name": "Premium",
+ "family": "P",
+ "capacity": 1
+ },
+ "enableNonSslPort": false,
+ "replicasPerMaster": 2,
+ "redisConfiguration": {
+ "maxmemory-policy": "allkeys-lru"
+ },
+ "hostName": "cache1.redis.cache.windows.net",
+ "port": 6379,
+ "sslPort": 6380,
+ "minimumTlsVersion": "1.2",
+ "instances": [
+ {
+ "sslPort": 15000,
+ "nonSslPort": 13000,
+ "zone": "1",
+ "shardId": 0
+ },
+ {
+ "sslPort": 15001,
+ "nonSslPort": 13001,
+ "zone": "1",
+ "shardId": 0
+ },
+ {
+ "sslPort": 15002,
+ "nonSslPort": 13002,
+ "zone": "1",
+ "shardId": 0
+ },
+ {
+ "sslPort": 15003,
+ "nonSslPort": 13003,
+ "zone": "1",
+ "shardId": 1
+ },
+ {
+ "sslPort": 15004,
+ "nonSslPort": 13004,
+ "zone": "1",
+ "shardId": 1
+ },
+ {
+ "sslPort": 15005,
+ "nonSslPort": 13005,
+ "zone": "1",
+ "shardId": 1
+ }
+ ]
+ }
+ }
+ },
+ "200": {
+ "body": {
+ "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/Redis/cache1",
+ "location": "West US",
+ "zones": [
+ "1"
+ ],
+ "name": "cache1",
+ "type": "Microsoft.Cache/Redis",
+ "tags": {},
+ "properties": {
+ "accessKeys": {
+ "primaryKey": "secretkey1",
+ "secondaryKey": "secretKey2"
+ },
+ "provisioningState": "Succeeded",
+ "redisVersion": "3.0",
+ "sku": {
+ "name": "Premium",
+ "family": "P",
+ "capacity": 1
+ },
+ "enableNonSslPort": false,
+ "replicasPerMaster": 2,
+ "redisConfiguration": {
+ "maxclients": "1000",
+ "maxmemory-reserved": "50",
+ "maxmemory-delta": "50"
+ },
+ "hostName": "cache1.redis.cache.windows.net",
+ "port": 6379,
+ "sslPort": 6380,
+ "minimumTlsVersion": "1.2",
+ "instances": [
+ {
+ "sslPort": 15000,
+ "nonSslPort": 13000,
+ "zone": "1",
+ "shardId": 0
+ },
+ {
+ "sslPort": 15001,
+ "nonSslPort": 13001,
+ "zone": "1",
+ "shardId": 0
+ },
+ {
+ "sslPort": 15002,
+ "nonSslPort": 13002,
+ "zone": "1",
+ "shardId": 0
+ },
+ {
+ "sslPort": 15003,
+ "nonSslPort": 13003,
+ "zone": "1",
+ "shardId": 1
+ },
+ {
+ "sslPort": 15004,
+ "nonSslPort": 13004,
+ "zone": "1",
+ "shardId": 1
+ },
+ {
+ "sslPort": 15005,
+ "nonSslPort": 13005,
+ "zone": "1",
+ "shardId": 1
+ }
+ ]
+ }
+ }
+ }
+ }
+}
diff --git a/specification/redis/resource-manager/Microsoft.Cache/stable/2020-06-01/examples/RedisCacheDelete.json b/specification/redis/resource-manager/Microsoft.Cache/stable/2020-06-01/examples/RedisCacheDelete.json
new file mode 100644
index 000000000000..772e625cb7d8
--- /dev/null
+++ b/specification/redis/resource-manager/Microsoft.Cache/stable/2020-06-01/examples/RedisCacheDelete.json
@@ -0,0 +1,17 @@
+{
+ "parameters": {
+ "name": "cache1",
+ "resourceGroupName": "rg1",
+ "api-version": "2020-06-01",
+ "subscriptionId": "subid"
+ },
+ "responses": {
+ "200": {},
+ "202": {
+ "headers": {
+ "location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.Cache/...pathToOperationResult..."
+ }
+ },
+ "204": {}
+ }
+}
diff --git a/specification/redis/resource-manager/Microsoft.Cache/stable/2020-06-01/examples/RedisCacheDeletePrivateEndpointConnection.json b/specification/redis/resource-manager/Microsoft.Cache/stable/2020-06-01/examples/RedisCacheDeletePrivateEndpointConnection.json
new file mode 100644
index 000000000000..8550a0e766a7
--- /dev/null
+++ b/specification/redis/resource-manager/Microsoft.Cache/stable/2020-06-01/examples/RedisCacheDeletePrivateEndpointConnection.json
@@ -0,0 +1,13 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscriptionId}",
+ "resourceGroupName": "rgtest01",
+ "cacheName": "cachetest01",
+ "privateEndpointConnectionName": "pectest01",
+ "api-version": "2020-06-01"
+ },
+ "responses": {
+ "200": {},
+ "204": {}
+ }
+}
diff --git a/specification/redis/resource-manager/Microsoft.Cache/stable/2020-06-01/examples/RedisCacheExport.json b/specification/redis/resource-manager/Microsoft.Cache/stable/2020-06-01/examples/RedisCacheExport.json
new file mode 100644
index 000000000000..59f3ff4b6ba3
--- /dev/null
+++ b/specification/redis/resource-manager/Microsoft.Cache/stable/2020-06-01/examples/RedisCacheExport.json
@@ -0,0 +1,22 @@
+{
+ "parameters": {
+ "name": "cache1",
+ "resourceGroupName": "rg1",
+ "api-version": "2020-06-01",
+ "subscriptionId": "subid",
+ "parameters": {
+ "format": "RDB",
+ "prefix": "datadump1",
+ "container": "https://contosostorage.blob.core.window.net/urltoBlobContainer?sasKeyParameters"
+ }
+ },
+ "responses": {
+ "200": {},
+ "202": {
+ "headers": {
+ "location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.Cache/...pathToOperationResult..."
+ }
+ },
+ "204": {}
+ }
+}
diff --git a/specification/redis/resource-manager/Microsoft.Cache/stable/2020-06-01/examples/RedisCacheFirewallRuleCreate.json b/specification/redis/resource-manager/Microsoft.Cache/stable/2020-06-01/examples/RedisCacheFirewallRuleCreate.json
new file mode 100644
index 000000000000..fdc3193084ee
--- /dev/null
+++ b/specification/redis/resource-manager/Microsoft.Cache/stable/2020-06-01/examples/RedisCacheFirewallRuleCreate.json
@@ -0,0 +1,39 @@
+{
+ "parameters": {
+ "ruleName": "rule1",
+ "cacheName": "cache1",
+ "resourceGroupName": "rg1",
+ "api-version": "2020-06-01",
+ "subscriptionId": "subid",
+ "parameters": {
+ "properties": {
+ "startIP": "192.168.1.1",
+ "endIP": "192.168.1.4"
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/Redis/cache1/firewallRules/rule1",
+ "name": "cache1/rule1",
+ "type": "Microsoft.Cache/Redis/firewallRules",
+ "properties": {
+ "startIP": "192.168.1.1",
+ "endIP": "192.168.1.4"
+ }
+ }
+ },
+ "201": {
+ "body": {
+ "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/Redis/cache1/firewallRules/rule1",
+ "name": "cache1/rule1",
+ "type": "Microsoft.Cache/Redis/firewallRules",
+ "properties": {
+ "startIP": "192.168.1.1",
+ "endIP": "192.168.1.4"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/redis/resource-manager/Microsoft.Cache/stable/2020-06-01/examples/RedisCacheFirewallRuleDelete.json b/specification/redis/resource-manager/Microsoft.Cache/stable/2020-06-01/examples/RedisCacheFirewallRuleDelete.json
new file mode 100644
index 000000000000..89a3ff527edb
--- /dev/null
+++ b/specification/redis/resource-manager/Microsoft.Cache/stable/2020-06-01/examples/RedisCacheFirewallRuleDelete.json
@@ -0,0 +1,13 @@
+{
+ "parameters": {
+ "ruleName": "rule1",
+ "cacheName": "cache1",
+ "resourceGroupName": "rg1",
+ "api-version": "2020-06-01",
+ "subscriptionId": "subid"
+ },
+ "responses": {
+ "200": {},
+ "204": {}
+ }
+}
diff --git a/specification/redis/resource-manager/Microsoft.Cache/stable/2020-06-01/examples/RedisCacheFirewallRuleGet.json b/specification/redis/resource-manager/Microsoft.Cache/stable/2020-06-01/examples/RedisCacheFirewallRuleGet.json
new file mode 100644
index 000000000000..9f64e5eb3782
--- /dev/null
+++ b/specification/redis/resource-manager/Microsoft.Cache/stable/2020-06-01/examples/RedisCacheFirewallRuleGet.json
@@ -0,0 +1,22 @@
+{
+ "parameters": {
+ "ruleName": "rule1",
+ "cacheName": "cache1",
+ "resourceGroupName": "rg1",
+ "api-version": "2020-06-01",
+ "subscriptionId": "subid"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/Redis/cache1/firewallRules/rule1",
+ "name": "cache1/rule1",
+ "type": "Microsoft.Cache/Redis/firewallRules",
+ "properties": {
+ "startIP": "192.168.1.1",
+ "endIP": "192.168.1.4"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/redis/resource-manager/Microsoft.Cache/stable/2020-06-01/examples/RedisCacheFirewallRulesList.json b/specification/redis/resource-manager/Microsoft.Cache/stable/2020-06-01/examples/RedisCacheFirewallRulesList.json
new file mode 100644
index 000000000000..630aea0c69eb
--- /dev/null
+++ b/specification/redis/resource-manager/Microsoft.Cache/stable/2020-06-01/examples/RedisCacheFirewallRulesList.json
@@ -0,0 +1,34 @@
+{
+ "parameters": {
+ "cacheName": "cache1",
+ "resourceGroupName": "rg1",
+ "api-version": "2020-06-01",
+ "subscriptionId": "subid"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/Redis/cache1/firewallRules/rule1",
+ "name": "rule1",
+ "type": "Microsoft.Cache/Redis/firewallRules",
+ "properties": {
+ "startIP": "192.168.1.1",
+ "endIP": "192.168.1.4"
+ }
+ },
+ {
+ "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/Redis/cache1/firewallRules/rule2",
+ "name": "rule2",
+ "type": "Microsoft.Cache/Redis/firewallRules",
+ "properties": {
+ "startIP": "192.169.1.0",
+ "endIP": "192.169.1.255"
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/redis/resource-manager/Microsoft.Cache/stable/2020-06-01/examples/RedisCacheForceReboot.json b/specification/redis/resource-manager/Microsoft.Cache/stable/2020-06-01/examples/RedisCacheForceReboot.json
new file mode 100644
index 000000000000..4b4bfbe9e185
--- /dev/null
+++ b/specification/redis/resource-manager/Microsoft.Cache/stable/2020-06-01/examples/RedisCacheForceReboot.json
@@ -0,0 +1,23 @@
+{
+ "parameters": {
+ "name": "cache1",
+ "resourceGroupName": "rg1",
+ "api-version": "2020-06-01",
+ "subscriptionId": "subid",
+ "parameters": {
+ "shardId": 0,
+ "rebootType": "AllNodes",
+ "ports": [
+ 13000,
+ 15001
+ ]
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "message": "reboot operation enqueued"
+ }
+ }
+ }
+}
diff --git a/specification/redis/resource-manager/Microsoft.Cache/stable/2020-06-01/examples/RedisCacheGet.json b/specification/redis/resource-manager/Microsoft.Cache/stable/2020-06-01/examples/RedisCacheGet.json
new file mode 100644
index 000000000000..906710ad24c9
--- /dev/null
+++ b/specification/redis/resource-manager/Microsoft.Cache/stable/2020-06-01/examples/RedisCacheGet.json
@@ -0,0 +1,72 @@
+{
+ "parameters": {
+ "name": "cache1",
+ "resourceGroupName": "rg1",
+ "api-version": "2020-06-01",
+ "subscriptionId": "subid"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/Redis/cache1",
+ "location": "West US",
+ "name": "cache1",
+ "type": "Microsoft.Cache/Redis",
+ "tags": {},
+ "properties": {
+ "provisioningState": "Creating",
+ "redisVersion": "3.2",
+ "sku": {
+ "name": "Premium",
+ "family": "P",
+ "capacity": 3
+ },
+ "enableNonSslPort": true,
+ "replicasPerMaster": 2,
+ "redisConfiguration": {},
+ "hostName": "cache1.redis.cache.windows.net",
+ "port": 6379,
+ "sslPort": 6380,
+ "linkedServers": [
+ {
+ "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/Redis/cache1/linkedServers/cache2"
+ }
+ ],
+ "instances": [
+ {
+ "sslPort": 15000,
+ "nonSslPort": 13000,
+ "isMaster": true
+ },
+ {
+ "sslPort": 15001,
+ "nonSslPort": 13001,
+ "isMaster": false
+ },
+ {
+ "sslPort": 15002,
+ "nonSslPort": 13002,
+ "isMaster": false
+ }
+ ],
+ "publicNetworkAccess": "Enabled",
+ "privateEndpointConnections": [
+ {
+ "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/Redis/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/redis/resource-manager/Microsoft.Cache/stable/2020-06-01/examples/RedisCacheGetPrivateEndpointConnection.json b/specification/redis/resource-manager/Microsoft.Cache/stable/2020-06-01/examples/RedisCacheGetPrivateEndpointConnection.json
new file mode 100644
index 000000000000..d97ba6f5960b
--- /dev/null
+++ b/specification/redis/resource-manager/Microsoft.Cache/stable/2020-06-01/examples/RedisCacheGetPrivateEndpointConnection.json
@@ -0,0 +1,29 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscriptionId}",
+ "resourceGroupName": "rgtest01",
+ "cacheName": "cachetest01",
+ "privateEndpointConnectionName": "pectest01",
+ "api-version": "2020-06-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/rgtest01/providers/Microsoft.Cache/Redis/cachetest01/privateEndpointConnections/pectest01",
+ "name": "pectest01",
+ "type": "Microsoft.Cache/Redis/privateEndpointConnections",
+ "properties": {
+ "provisioningState": "Succeeded",
+ "privateEndpoint": {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/rgtest01/providers/Microsoft.Network/privateEndpoints/petest01"
+ },
+ "privateLinkServiceConnectionState": {
+ "status": "Approved",
+ "description": "Auto-Approved",
+ "actionsRequired": "None"
+ }
+ }
+ }
+ }
+ }
+}
diff --git a/specification/redis/resource-manager/Microsoft.Cache/stable/2020-06-01/examples/RedisCacheImport.json b/specification/redis/resource-manager/Microsoft.Cache/stable/2020-06-01/examples/RedisCacheImport.json
new file mode 100644
index 000000000000..964daacb5ea2
--- /dev/null
+++ b/specification/redis/resource-manager/Microsoft.Cache/stable/2020-06-01/examples/RedisCacheImport.json
@@ -0,0 +1,23 @@
+{
+ "parameters": {
+ "name": "cache1",
+ "resourceGroupName": "rg1",
+ "api-version": "2020-06-01",
+ "subscriptionId": "subid",
+ "parameters": {
+ "format": "RDB",
+ "files": [
+ "http://fileuris.contoso.com/pathtofile1"
+ ]
+ }
+ },
+ "responses": {
+ "200": {},
+ "202": {
+ "headers": {
+ "location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.Cache/...pathToOperationResult..."
+ }
+ },
+ "204": {}
+ }
+}
diff --git a/specification/redis/resource-manager/Microsoft.Cache/stable/2020-06-01/examples/RedisCacheLinkedServer_Create.json b/specification/redis/resource-manager/Microsoft.Cache/stable/2020-06-01/examples/RedisCacheLinkedServer_Create.json
new file mode 100644
index 000000000000..3810c6535fec
--- /dev/null
+++ b/specification/redis/resource-manager/Microsoft.Cache/stable/2020-06-01/examples/RedisCacheLinkedServer_Create.json
@@ -0,0 +1,44 @@
+{
+ "parameters": {
+ "name": "cache1",
+ "resourceGroupName": "rg1",
+ "linkedServerName": "cache2",
+ "api-version": "2020-06-01",
+ "subscriptionId": "subid",
+ "parameters": {
+ "properties": {
+ "linkedRedisCacheId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/Redis/cache2",
+ "linkedRedisCacheLocation": "West US",
+ "serverRole": "Secondary"
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "body": {
+ "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/Redis/cache1/linkedServers/cache2",
+ "name": "cache2",
+ "type": "Microsoft.Cache/Redis/linkedServers",
+ "properties": {
+ "linkedRedisCacheId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/Redis/cache2",
+ "linkedRedisCacheLocation": "West US",
+ "provisioningState": "Creating",
+ "serverRole": "Secondary"
+ }
+ }
+ },
+ "200": {
+ "body": {
+ "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/Redis/cache1/linkedServers/cache2",
+ "name": "cache2",
+ "type": "Microsoft.Cache/Redis/linkedServers",
+ "properties": {
+ "linkedRedisCacheId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/Redis/cache2",
+ "linkedRedisCacheLocation": "West US",
+ "provisioningState": "Creating",
+ "serverRole": "Secondary"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/redis/resource-manager/Microsoft.Cache/stable/2020-06-01/examples/RedisCacheLinkedServer_Delete.json b/specification/redis/resource-manager/Microsoft.Cache/stable/2020-06-01/examples/RedisCacheLinkedServer_Delete.json
new file mode 100644
index 000000000000..269b476352a5
--- /dev/null
+++ b/specification/redis/resource-manager/Microsoft.Cache/stable/2020-06-01/examples/RedisCacheLinkedServer_Delete.json
@@ -0,0 +1,13 @@
+{
+ "parameters": {
+ "name": "cache1",
+ "resourceGroupName": "rg1",
+ "linkedServerName": "cache2",
+ "api-version": "2020-06-01",
+ "subscriptionId": "subid"
+ },
+ "responses": {
+ "200": {},
+ "204": {}
+ }
+}
diff --git a/specification/redis/resource-manager/Microsoft.Cache/stable/2020-06-01/examples/RedisCacheLinkedServer_Get.json b/specification/redis/resource-manager/Microsoft.Cache/stable/2020-06-01/examples/RedisCacheLinkedServer_Get.json
new file mode 100644
index 000000000000..3a51ea5a4e3a
--- /dev/null
+++ b/specification/redis/resource-manager/Microsoft.Cache/stable/2020-06-01/examples/RedisCacheLinkedServer_Get.json
@@ -0,0 +1,24 @@
+{
+ "parameters": {
+ "name": "cache1",
+ "resourceGroupName": "rg1",
+ "api-version": "2020-06-01",
+ "subscriptionId": "subid",
+ "linkedServerName": "cache2"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/Redis/cache1/linkedServers/cache2",
+ "name": "cache2",
+ "type": "Microsoft.Cache/Redis/linkedServers",
+ "properties": {
+ "linkedRedisCacheId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/Redis/cache2",
+ "linkedRedisCacheLocation": "West US",
+ "provisioningState": "Succeeded",
+ "serverRole": "Secondary"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/redis/resource-manager/Microsoft.Cache/stable/2020-06-01/examples/RedisCacheLinkedServer_List.json b/specification/redis/resource-manager/Microsoft.Cache/stable/2020-06-01/examples/RedisCacheLinkedServer_List.json
new file mode 100644
index 000000000000..dff906689b0b
--- /dev/null
+++ b/specification/redis/resource-manager/Microsoft.Cache/stable/2020-06-01/examples/RedisCacheLinkedServer_List.json
@@ -0,0 +1,36 @@
+{
+ "parameters": {
+ "name": "cache1",
+ "resourceGroupName": "rg1",
+ "api-version": "2020-06-01",
+ "subscriptionId": "subid"
+ },
+ "responses": {
+ "200": {
+ "body": [
+ {
+ "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/Redis/cache1/linkedServers/cache2",
+ "name": "cache2",
+ "type": "Microsoft.Cache/Redis/linkedServers",
+ "properties": {
+ "linkedRedisCacheId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/Redis/cache2",
+ "linkedRedisCacheLocation": "West US",
+ "provisioningState": "Succeeded",
+ "serverRole": "Secondary"
+ }
+ },
+ {
+ "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/Redis/cache1/linkedServers/cache3",
+ "name": "cache3",
+ "type": "Microsoft.Cache/Redis/linkedServers",
+ "properties": {
+ "linkedRedisCacheId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/Redis/cache3",
+ "linkedRedisCacheLocation": "West US",
+ "provisioningState": "Succeeded",
+ "serverRole": "Secondary"
+ }
+ }
+ ]
+ }
+ }
+}
diff --git a/specification/redis/resource-manager/Microsoft.Cache/stable/2020-06-01/examples/RedisCacheList.json b/specification/redis/resource-manager/Microsoft.Cache/stable/2020-06-01/examples/RedisCacheList.json
new file mode 100644
index 000000000000..311c3fb70507
--- /dev/null
+++ b/specification/redis/resource-manager/Microsoft.Cache/stable/2020-06-01/examples/RedisCacheList.json
@@ -0,0 +1,35 @@
+{
+ "parameters": {
+ "api-version": "2020-06-01",
+ "subscriptionId": "subid"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/Redis/cache1",
+ "location": "West US",
+ "name": "cache1",
+ "type": "Microsoft.Cache/Redis",
+ "tags": {},
+ "properties": {
+ "provisioningState": "Creating",
+ "redisVersion": "3.2",
+ "sku": {
+ "name": "Standard",
+ "family": "C",
+ "capacity": 6
+ },
+ "enableNonSslPort": true,
+ "redisConfiguration": {},
+ "hostName": "cache1.redis.cache.windows.net",
+ "port": 6379,
+ "sslPort": 6380
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/redis/resource-manager/Microsoft.Cache/stable/2020-06-01/examples/RedisCacheListByResourceGroup.json b/specification/redis/resource-manager/Microsoft.Cache/stable/2020-06-01/examples/RedisCacheListByResourceGroup.json
new file mode 100644
index 000000000000..67a9411f39ea
--- /dev/null
+++ b/specification/redis/resource-manager/Microsoft.Cache/stable/2020-06-01/examples/RedisCacheListByResourceGroup.json
@@ -0,0 +1,36 @@
+{
+ "parameters": {
+ "api-version": "2020-06-01",
+ "resourceGroupName": "rg1",
+ "subscriptionId": "subid"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/Redis/cache1",
+ "location": "West US",
+ "name": "cache1",
+ "type": "Microsoft.Cache/Redis",
+ "tags": {},
+ "properties": {
+ "provisioningState": "Creating",
+ "redisVersion": "3.2",
+ "sku": {
+ "name": "Standard",
+ "family": "C",
+ "capacity": 6
+ },
+ "enableNonSslPort": true,
+ "redisConfiguration": {},
+ "hostName": "cache1.redis.cache.windows.net",
+ "port": 6379,
+ "sslPort": 6380
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/redis/resource-manager/Microsoft.Cache/stable/2020-06-01/examples/RedisCacheListKeys.json b/specification/redis/resource-manager/Microsoft.Cache/stable/2020-06-01/examples/RedisCacheListKeys.json
new file mode 100644
index 000000000000..59fea2eb161c
--- /dev/null
+++ b/specification/redis/resource-manager/Microsoft.Cache/stable/2020-06-01/examples/RedisCacheListKeys.json
@@ -0,0 +1,16 @@
+{
+ "parameters": {
+ "name": "cache1",
+ "resourceGroupName": "rg1",
+ "api-version": "2020-06-01",
+ "subscriptionId": "subid"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "primaryKey": "secretkey1",
+ "secondaryKey": "secretKey2"
+ }
+ }
+ }
+}
diff --git a/specification/redis/resource-manager/Microsoft.Cache/stable/2020-06-01/examples/RedisCacheListPrivateEndpointConnections.json b/specification/redis/resource-manager/Microsoft.Cache/stable/2020-06-01/examples/RedisCacheListPrivateEndpointConnections.json
new file mode 100644
index 000000000000..1ee3609a3509
--- /dev/null
+++ b/specification/redis/resource-manager/Microsoft.Cache/stable/2020-06-01/examples/RedisCacheListPrivateEndpointConnections.json
@@ -0,0 +1,47 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscriptionId}",
+ "resourceGroupName": "rgtest01",
+ "cacheName": "cachetest01",
+ "privateEndpointConnectionName": "pectest01",
+ "api-version": "2020-06-01"
+ },
+ "responses": {
+ "200": {
+ "body": [
+ {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/rgtest01/providers/Microsoft.Cache/Redis/cachetest01/privateEndpointConnections/pectest01",
+ "name": "pectest01",
+ "type": "Microsoft.Cache/Redis/privateEndpointConnections",
+ "properties": {
+ "provisioningState": "Succeeded",
+ "privateEndpoint": {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/rgtest01/providers/Microsoft.Network/privateEndpoints/petest01"
+ },
+ "privateLinkServiceConnectionState": {
+ "status": "Approved",
+ "description": "Auto-Approved",
+ "actionsRequired": "None"
+ }
+ }
+ },
+ {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/rgtest01/providers/Microsoft.Cache/Redis/cachetest01/privateEndpointConnections/pectest01",
+ "name": "pectest01",
+ "type": "Microsoft.Cache/Redis/privateEndpointConnections",
+ "properties": {
+ "provisioningState": "Succeeded",
+ "privateEndpoint": {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/rgtest01/providers/Microsoft.Network/privateEndpoints/petest01"
+ },
+ "privateLinkServiceConnectionState": {
+ "status": "Approved",
+ "description": "Auto-Approved",
+ "actionsRequired": "None"
+ }
+ }
+ }
+ ]
+ }
+ }
+}
diff --git a/specification/redis/resource-manager/Microsoft.Cache/stable/2020-06-01/examples/RedisCacheListPrivateLinkResources.json b/specification/redis/resource-manager/Microsoft.Cache/stable/2020-06-01/examples/RedisCacheListPrivateLinkResources.json
new file mode 100644
index 000000000000..198e5d423d43
--- /dev/null
+++ b/specification/redis/resource-manager/Microsoft.Cache/stable/2020-06-01/examples/RedisCacheListPrivateLinkResources.json
@@ -0,0 +1,30 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "rgtest01",
+ "cacheName": "cacheTest01",
+ "api-version": "2020-06-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/rgtest01/providers/Microsoft.Cache/Redis/cacheTest01/privateLinkResources/redisCache",
+ "name": "redisCache",
+ "type": "Microsoft.Cache/Redis/privateLinkResources",
+ "properties": {
+ "groupId": "redisCache",
+ "requiredMembers": [
+ "redisCache"
+ ],
+ "requiredZoneNames": [
+ "privatelink.redis.cache.windows.net"
+ ]
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/redis/resource-manager/Microsoft.Cache/stable/2020-06-01/examples/RedisCacheListUpgradeNotifications.json b/specification/redis/resource-manager/Microsoft.Cache/stable/2020-06-01/examples/RedisCacheListUpgradeNotifications.json
new file mode 100644
index 000000000000..7abee77c2fee
--- /dev/null
+++ b/specification/redis/resource-manager/Microsoft.Cache/stable/2020-06-01/examples/RedisCacheListUpgradeNotifications.json
@@ -0,0 +1,22 @@
+{
+ "parameters": {
+ "name": "cache1",
+ "resourceGroupName": "rg1",
+ "api-version": "2020-06-01",
+ "subscriptionId": "subid",
+ "history": "5000"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "name": "notification1",
+ "timestamp": "2017-02-16T23:20:50.52Z",
+ "upsellNotification": {}
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/redis/resource-manager/Microsoft.Cache/stable/2020-06-01/examples/RedisCachePatchSchedulesCreateOrUpdate.json b/specification/redis/resource-manager/Microsoft.Cache/stable/2020-06-01/examples/RedisCachePatchSchedulesCreateOrUpdate.json
new file mode 100644
index 000000000000..9896b07a4c65
--- /dev/null
+++ b/specification/redis/resource-manager/Microsoft.Cache/stable/2020-06-01/examples/RedisCachePatchSchedulesCreateOrUpdate.json
@@ -0,0 +1,66 @@
+{
+ "parameters": {
+ "name": "cache1",
+ "resourceGroupName": "rg1",
+ "default": "default",
+ "api-version": "2020-06-01",
+ "subscriptionId": "subid",
+ "parameters": {
+ "properties": {
+ "scheduleEntries": [
+ {
+ "dayOfWeek": "Monday",
+ "startHourUtc": 12,
+ "maintenanceWindow": "PT5H"
+ },
+ {
+ "dayOfWeek": "Tuesday",
+ "startHourUtc": 12
+ }
+ ]
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "body": {
+ "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/Redis/cache1/patchSchedules/default",
+ "name": "default",
+ "type": "Microsoft.Cache/Redis/patchSchedules",
+ "properties": {
+ "scheduleEntries": [
+ {
+ "dayOfWeek": "Monday",
+ "startHourUtc": 12,
+ "maintenanceWindow": "PT5H"
+ },
+ {
+ "dayOfWeek": "Tuesday",
+ "startHourUtc": 12
+ }
+ ]
+ }
+ }
+ },
+ "200": {
+ "body": {
+ "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/Redis/cache1/patchSchedules/default",
+ "name": "default",
+ "type": "Microsoft.Cache/Redis/patchSchedules",
+ "properties": {
+ "scheduleEntries": [
+ {
+ "dayOfWeek": "Monday",
+ "startHourUtc": 12,
+ "maintenanceWindow": "PT5H"
+ },
+ {
+ "dayOfWeek": "Tuesday",
+ "startHourUtc": 12
+ }
+ ]
+ }
+ }
+ }
+ }
+}
diff --git a/specification/redis/resource-manager/Microsoft.Cache/stable/2020-06-01/examples/RedisCachePatchSchedulesDelete.json b/specification/redis/resource-manager/Microsoft.Cache/stable/2020-06-01/examples/RedisCachePatchSchedulesDelete.json
new file mode 100644
index 000000000000..073449a4d2bd
--- /dev/null
+++ b/specification/redis/resource-manager/Microsoft.Cache/stable/2020-06-01/examples/RedisCachePatchSchedulesDelete.json
@@ -0,0 +1,13 @@
+{
+ "parameters": {
+ "name": "cache1",
+ "resourceGroupName": "rg1",
+ "default": "default",
+ "api-version": "2020-06-01",
+ "subscriptionId": "subid"
+ },
+ "responses": {
+ "200": {},
+ "204": {}
+ }
+}
diff --git a/specification/redis/resource-manager/Microsoft.Cache/stable/2020-06-01/examples/RedisCachePatchSchedulesGet.json b/specification/redis/resource-manager/Microsoft.Cache/stable/2020-06-01/examples/RedisCachePatchSchedulesGet.json
new file mode 100644
index 000000000000..523cccc0f805
--- /dev/null
+++ b/specification/redis/resource-manager/Microsoft.Cache/stable/2020-06-01/examples/RedisCachePatchSchedulesGet.json
@@ -0,0 +1,31 @@
+{
+ "parameters": {
+ "name": "cache1",
+ "resourceGroupName": "rg1",
+ "default": "default",
+ "api-version": "2020-06-01",
+ "subscriptionId": "subid"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/Redis/cache1/patchSchedules/default",
+ "name": "default",
+ "type": "Microsoft.Cache/Redis/patchSchedules",
+ "properties": {
+ "scheduleEntries": [
+ {
+ "dayOfWeek": "Monday",
+ "startHourUtc": 12,
+ "maintenanceWindow": "PT5H"
+ },
+ {
+ "dayOfWeek": "Tuesday",
+ "startHourUtc": 12
+ }
+ ]
+ }
+ }
+ }
+ }
+}
diff --git a/specification/redis/resource-manager/Microsoft.Cache/stable/2020-06-01/examples/RedisCachePatchSchedulesList.json b/specification/redis/resource-manager/Microsoft.Cache/stable/2020-06-01/examples/RedisCachePatchSchedulesList.json
new file mode 100644
index 000000000000..cfb3e6a6ca20
--- /dev/null
+++ b/specification/redis/resource-manager/Microsoft.Cache/stable/2020-06-01/examples/RedisCachePatchSchedulesList.json
@@ -0,0 +1,34 @@
+{
+ "parameters": {
+ "cacheName": "cache1",
+ "resourceGroupName": "rg1",
+ "api-version": "2020-06-01",
+ "subscriptionId": "subid"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/Redis/cache1/patchSchedules/default",
+ "name": "default",
+ "type": "Microsoft.Cache/Redis/patchSchedules",
+ "properties": {
+ "scheduleEntries": [
+ {
+ "dayOfWeek": "Monday",
+ "startHourUtc": 12,
+ "maintenanceWindow": "PT5H"
+ },
+ {
+ "dayOfWeek": "Tuesday",
+ "startHourUtc": 12
+ }
+ ]
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/redis/resource-manager/Microsoft.Cache/stable/2020-06-01/examples/RedisCachePutPrivateEndpointConnection.json b/specification/redis/resource-manager/Microsoft.Cache/stable/2020-06-01/examples/RedisCachePutPrivateEndpointConnection.json
new file mode 100644
index 000000000000..8a57daafd48d
--- /dev/null
+++ b/specification/redis/resource-manager/Microsoft.Cache/stable/2020-06-01/examples/RedisCachePutPrivateEndpointConnection.json
@@ -0,0 +1,37 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscriptionId}",
+ "resourceGroupName": "rgtest01",
+ "cacheName": "cachetest01",
+ "privateEndpointConnectionName": "pectest01",
+ "api-version": "2020-06-01",
+ "properties": {
+ "properties": {
+ "privateLinkServiceConnectionState": {
+ "status": "Approved",
+ "description": "Auto-Approved"
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "body": {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/rgtest01/providers/Microsoft.Cache/Redis/cachetest01/privateEndpointConnections/pectest01",
+ "name": "pectest01",
+ "type": "Microsoft.Cache/Redis/privateEndpointConnections",
+ "properties": {
+ "provisioningState": "Succeeded",
+ "privateEndpoint": {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/rgtest01/providers/Microsoft.Network/privateEndpoints/petest01"
+ },
+ "privateLinkServiceConnectionState": {
+ "status": "Approved",
+ "description": "Auto-Approved",
+ "actionsRequired": "None"
+ }
+ }
+ }
+ }
+ }
+}
diff --git a/specification/redis/resource-manager/Microsoft.Cache/stable/2020-06-01/examples/RedisCacheRegenerateKey.json b/specification/redis/resource-manager/Microsoft.Cache/stable/2020-06-01/examples/RedisCacheRegenerateKey.json
new file mode 100644
index 000000000000..990c8884a390
--- /dev/null
+++ b/specification/redis/resource-manager/Microsoft.Cache/stable/2020-06-01/examples/RedisCacheRegenerateKey.json
@@ -0,0 +1,19 @@
+{
+ "parameters": {
+ "name": "cache1",
+ "resourceGroupName": "rg1",
+ "api-version": "2020-06-01",
+ "subscriptionId": "subid",
+ "parameters": {
+ "keyType": "Primary"
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "primaryKey": "secretkey1",
+ "secondaryKey": "secretKey2"
+ }
+ }
+ }
+}
diff --git a/specification/redis/resource-manager/Microsoft.Cache/stable/2020-06-01/examples/RedisCacheUpdate.json b/specification/redis/resource-manager/Microsoft.Cache/stable/2020-06-01/examples/RedisCacheUpdate.json
new file mode 100644
index 000000000000..a8e1d91820ba
--- /dev/null
+++ b/specification/redis/resource-manager/Microsoft.Cache/stable/2020-06-01/examples/RedisCacheUpdate.json
@@ -0,0 +1,56 @@
+{
+ "parameters": {
+ "name": "cache1",
+ "resourceGroupName": "rg1",
+ "api-version": "2020-06-01",
+ "subscriptionId": "subid",
+ "parameters": {
+ "properties": {
+ "enableNonSslPort": true
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/Redis/cache1",
+ "location": "West US",
+ "name": "cache1",
+ "type": "Microsoft.Cache/Redis",
+ "tags": {},
+ "properties": {
+ "accessKeys": {
+ "primaryKey": "secretkey1",
+ "secondaryKey": "secretKey2"
+ },
+ "provisioningState": "Succeeded",
+ "redisVersion": "3.0",
+ "sku": {
+ "name": "Premium",
+ "family": "P",
+ "capacity": 1
+ },
+ "enableNonSslPort": true,
+ "redisConfiguration": {
+ "maxclients": "1000",
+ "maxmemory-reserved": "50",
+ "maxmemory-delta": "50"
+ },
+ "hostName": "cache1.redis.cache.windows.net",
+ "port": 6379,
+ "sslPort": 6380,
+ "instances": [
+ {
+ "sslPort": 15000,
+ "nonSslPort": 13000
+ },
+ {
+ "sslPort": 15001,
+ "nonSslPort": 13001
+ }
+ ]
+ }
+ }
+ }
+ }
+}
diff --git a/specification/redis/resource-manager/Microsoft.Cache/stable/2020-06-01/redis.json b/specification/redis/resource-manager/Microsoft.Cache/stable/2020-06-01/redis.json
new file mode 100644
index 000000000000..313b19151c13
--- /dev/null
+++ b/specification/redis/resource-manager/Microsoft.Cache/stable/2020-06-01/redis.json
@@ -0,0 +1,2687 @@
+{
+ "swagger": "2.0",
+ "info": {
+ "title": "RedisManagementClient",
+ "description": "REST API for Azure Redis Cache Service.",
+ "version": "2020-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.Cache/operations": {
+ "get": {
+ "tags": [
+ "Operations"
+ ],
+ "description": "Lists all of the available REST API operations of the Microsoft.Cache 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": "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/CheckNameAvailability": {
+ "post": {
+ "tags": [
+ "Redis"
+ ],
+ "operationId": "Redis_CheckNameAvailability",
+ "x-ms-examples": {
+ "RedisCacheList": {
+ "$ref": "./examples/RedisCacheCheckNameAvailability.json"
+ }
+ },
+ "description": "Checks that the redis cache name is valid and is not already in use.",
+ "parameters": [
+ {
+ "name": "parameters",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/CheckNameAvailabilityParameters"
+ },
+ "description": "Parameters supplied to the CheckNameAvailability Redis operation. The only supported resource type is 'Microsoft.Cache/redis'"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Name is available"
+ },
+ "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/redis/{name}/listUpgradeNotifications": {
+ "get": {
+ "tags": [
+ "Redis"
+ ],
+ "operationId": "Redis_ListUpgradeNotifications",
+ "x-ms-examples": {
+ "RedisCacheGet": {
+ "$ref": "./examples/RedisCacheListUpgradeNotifications.json"
+ }
+ },
+ "description": "Gets any upgrade notifications for a Redis cache.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group."
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the Redis cache."
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "name": "history",
+ "in": "query",
+ "required": true,
+ "type": "number",
+ "format": "double",
+ "description": "how many minutes in past to look for upgrade notifications"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "All upgrade notifications in given time range",
+ "schema": {
+ "$ref": "#/definitions/NotificationListResponse"
+ }
+ },
+ "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/redis/{name}": {
+ "put": {
+ "tags": [
+ "Redis"
+ ],
+ "operationId": "Redis_Create",
+ "x-ms-examples": {
+ "RedisCacheCreate": {
+ "$ref": "./examples/RedisCacheCreate.json"
+ }
+ },
+ "description": "Create or replace (overwrite/recreate, with potential downtime) an existing Redis cache.",
+ "x-ms-long-running-operation": true,
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group."
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the Redis cache."
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/RedisCreateParameters"
+ },
+ "description": "Parameters supplied to the Create Redis operation."
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "201": {
+ "description": "The new redis cache was successfully created. Check provisioningState to see detailed status.",
+ "schema": {
+ "$ref": "#/definitions/RedisResource"
+ }
+ },
+ "200": {
+ "description": "The existing redis cache was successfully updated. Check provisioningState to see detailed status.",
+ "schema": {
+ "$ref": "#/definitions/RedisResource"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse"
+ }
+ }
+ }
+ },
+ "patch": {
+ "tags": [
+ "Redis"
+ ],
+ "operationId": "Redis_Update",
+ "x-ms-examples": {
+ "RedisCacheUpdate": {
+ "$ref": "./examples/RedisCacheUpdate.json"
+ }
+ },
+ "description": "Update an existing Redis cache.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group."
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the Redis cache."
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/RedisUpdateParameters"
+ },
+ "description": "Parameters supplied to the Update Redis operation."
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The existing redis cache was successfully updated. Check provisioningState to see detailed status.",
+ "schema": {
+ "$ref": "#/definitions/RedisResource"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse"
+ }
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "Redis"
+ ],
+ "operationId": "Redis_Delete",
+ "x-ms-examples": {
+ "RedisCacheDelete": {
+ "$ref": "./examples/RedisCacheDelete.json"
+ }
+ },
+ "description": "Deletes a Redis cache.",
+ "x-ms-long-running-operation": true,
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group."
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the Redis cache."
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The redis cache was successfully deleted."
+ },
+ "202": {
+ "description": "The redis cache 'delete' operation was successfully enqueued; follow the Location header to poll for final outcome."
+ },
+ "204": {
+ "description": "The redis cache 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": [
+ "Redis"
+ ],
+ "operationId": "Redis_Get",
+ "x-ms-examples": {
+ "RedisCacheGet": {
+ "$ref": "./examples/RedisCacheGet.json"
+ }
+ },
+ "description": "Gets a Redis cache (resource description).",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group."
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the Redis cache."
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The redis cache was successfully found.",
+ "schema": {
+ "$ref": "#/definitions/RedisResource"
+ }
+ },
+ "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/redis": {
+ "get": {
+ "tags": [
+ "Redis"
+ ],
+ "operationId": "Redis_ListByResourceGroup",
+ "x-ms-examples": {
+ "RedisCacheListByResourceGroup": {
+ "$ref": "./examples/RedisCacheListByResourceGroup.json"
+ }
+ },
+ "description": "Lists all Redis caches 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": "",
+ "schema": {
+ "$ref": "#/definitions/RedisListResult"
+ }
+ },
+ "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/redis": {
+ "get": {
+ "tags": [
+ "Redis"
+ ],
+ "operationId": "Redis_ListBySubscription",
+ "x-ms-examples": {
+ "RedisCacheList": {
+ "$ref": "./examples/RedisCacheList.json"
+ }
+ },
+ "description": "Gets all Redis caches in the specified subscription.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "",
+ "schema": {
+ "$ref": "#/definitions/RedisListResult"
+ }
+ },
+ "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/redis/{name}/listKeys": {
+ "post": {
+ "tags": [
+ "Redis"
+ ],
+ "operationId": "Redis_ListKeys",
+ "x-ms-examples": {
+ "RedisCacheListKeys": {
+ "$ref": "./examples/RedisCacheListKeys.json"
+ }
+ },
+ "description": "Retrieve a Redis cache's access keys. This operation requires write permission to the cache resource.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group."
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the Redis cache."
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Lists the keys for the specified Redis cache.",
+ "schema": {
+ "$ref": "#/definitions/RedisAccessKeys"
+ }
+ },
+ "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/redis/{name}/regenerateKey": {
+ "post": {
+ "tags": [
+ "Redis"
+ ],
+ "operationId": "Redis_RegenerateKey",
+ "x-ms-examples": {
+ "RedisCacheRegenerateKey": {
+ "$ref": "./examples/RedisCacheRegenerateKey.json"
+ }
+ },
+ "description": "Regenerate Redis cache's access keys. This operation requires write permission to the cache resource.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group."
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the Redis cache."
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/RedisRegenerateKeyParameters"
+ },
+ "description": "Specifies which key to regenerate."
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Lists the regenerated keys for Redis Cache",
+ "schema": {
+ "$ref": "#/definitions/RedisAccessKeys"
+ }
+ },
+ "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/redis/{name}/forceReboot": {
+ "post": {
+ "tags": [
+ "Redis"
+ ],
+ "operationId": "Redis_ForceReboot",
+ "x-ms-examples": {
+ "RedisCacheForceReboot": {
+ "$ref": "./examples/RedisCacheForceReboot.json"
+ }
+ },
+ "description": "Reboot specified Redis node(s). This operation requires write permission to the cache resource. There can be potential data loss.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group."
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the Redis cache."
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/RedisRebootParameters"
+ },
+ "description": "Specifies which Redis node(s) to reboot."
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Reboot operation successfully enqueued",
+ "schema": {
+ "$ref": "#/definitions/RedisForceRebootResponse"
+ }
+ },
+ "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/redis/{name}/import": {
+ "post": {
+ "tags": [
+ "Redis"
+ ],
+ "operationId": "Redis_ImportData",
+ "x-ms-examples": {
+ "RedisCacheImport": {
+ "$ref": "./examples/RedisCacheImport.json"
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "description": "Import data into Redis cache.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group."
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the Redis cache."
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/ImportRDBParameters"
+ },
+ "description": "Parameters for Redis import operation."
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "202": {
+ "description": "Import operation successfully enqueued; follow the Location header to poll for final outcome."
+ },
+ "200": {
+ "description": "Import operation succeeded."
+ },
+ "204": {
+ "description": "Import operation succeeded."
+ },
+ "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/redis/{name}/export": {
+ "post": {
+ "tags": [
+ "Redis"
+ ],
+ "operationId": "Redis_ExportData",
+ "x-ms-examples": {
+ "RedisCacheExport": {
+ "$ref": "./examples/RedisCacheExport.json"
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "description": "Export data from the redis cache to blobs in a container.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group."
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the Redis cache."
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/ExportRDBParameters"
+ },
+ "description": "Parameters for Redis export operation."
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "202": {
+ "description": "Export operation successfully enqueued; follow the Location header to poll for final outcome."
+ },
+ "200": {
+ "description": "Export operation succeeded."
+ },
+ "204": {
+ "description": "Export operation succeeded."
+ },
+ "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/redis/{cacheName}/firewallRules": {
+ "get": {
+ "tags": [
+ "Redis",
+ "FirewallRules"
+ ],
+ "operationId": "FirewallRules_List",
+ "description": "Gets all firewall rules in the specified redis cache.",
+ "x-ms-examples": {
+ "RedisCacheFirewallRulesList": {
+ "$ref": "./examples/RedisCacheFirewallRulesList.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group."
+ },
+ {
+ "name": "cacheName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the Redis cache."
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successfully got the current rules",
+ "schema": {
+ "$ref": "#/definitions/RedisFirewallRuleListResult"
+ }
+ },
+ "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/redis/{cacheName}/firewallRules/{ruleName}": {
+ "put": {
+ "tags": [
+ "Redis",
+ "FirewallRules"
+ ],
+ "operationId": "FirewallRules_CreateOrUpdate",
+ "description": "Create or update a redis cache firewall rule",
+ "x-ms-examples": {
+ "RedisCacheFirewallRuleCreate": {
+ "$ref": "./examples/RedisCacheFirewallRuleCreate.json"
+ }
+ },
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group."
+ },
+ {
+ "name": "cacheName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the Redis cache."
+ },
+ {
+ "name": "ruleName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the firewall rule."
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/RedisFirewallRuleCreateParameters"
+ },
+ "description": "Parameters supplied to the create or update redis firewall rule operation."
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Resource was successfully updated",
+ "schema": {
+ "$ref": "#/definitions/RedisFirewallRule"
+ }
+ },
+ "201": {
+ "description": "Resource was successfully created",
+ "schema": {
+ "$ref": "#/definitions/RedisFirewallRule"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse"
+ }
+ }
+ }
+ },
+ "get": {
+ "tags": [
+ "Redis",
+ "FirewallRules"
+ ],
+ "operationId": "FirewallRules_Get",
+ "description": "Gets a single firewall rule in a specified redis cache.",
+ "x-ms-examples": {
+ "RedisCacheFirewallRuleGet": {
+ "$ref": "./examples/RedisCacheFirewallRuleGet.json"
+ }
+ },
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group."
+ },
+ {
+ "name": "cacheName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the Redis cache."
+ },
+ {
+ "name": "ruleName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the firewall rule."
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successfully found the rule",
+ "schema": {
+ "$ref": "#/definitions/RedisFirewallRule"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse"
+ }
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "Redis",
+ "FirewallRules"
+ ],
+ "operationId": "FirewallRules_Delete",
+ "description": "Deletes a single firewall rule in a specified redis cache.",
+ "x-ms-examples": {
+ "RedisCacheFirewallRuleDelete": {
+ "$ref": "./examples/RedisCacheFirewallRuleDelete.json"
+ }
+ },
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group."
+ },
+ {
+ "name": "cacheName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the Redis cache."
+ },
+ {
+ "name": "ruleName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the firewall rule."
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successfully deleted the rule"
+ },
+ "204": {
+ "description": "Successfully deleted the rule"
+ },
+ "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/redis/{cacheName}/patchSchedules": {
+ "get": {
+ "tags": [
+ "Redis",
+ "PatchSchedules"
+ ],
+ "operationId": "PatchSchedules_ListByRedisResource",
+ "description": "Gets all patch schedules in the specified redis cache (there is only one).",
+ "x-ms-examples": {
+ "RedisCachePatchSchedulesList": {
+ "$ref": "./examples/RedisCachePatchSchedulesList.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group."
+ },
+ {
+ "name": "cacheName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the Redis cache."
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successfully got the current patch schedules",
+ "schema": {
+ "$ref": "#/definitions/RedisPatchScheduleListResult"
+ }
+ },
+ "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/redis/{name}/patchSchedules/{default}": {
+ "put": {
+ "tags": [
+ "Redis",
+ "PatchSchedules"
+ ],
+ "operationId": "PatchSchedules_CreateOrUpdate",
+ "x-ms-examples": {
+ "RedisCachePatchSchedulesCreateOrUpdate": {
+ "$ref": "./examples/RedisCachePatchSchedulesCreateOrUpdate.json"
+ }
+ },
+ "description": "Create or replace the patching schedule for Redis cache (requires Premium SKU).",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group."
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the Redis cache."
+ },
+ {
+ "name": "default",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "Default string modeled as parameter for auto generation to work correctly.",
+ "enum": [
+ "default"
+ ],
+ "x-ms-enum": {
+ "name": "defaultName",
+ "modelAsString": true
+ }
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/RedisPatchSchedule"
+ },
+ "description": "Parameters to set the patching schedule for Redis cache."
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The patch schedule was successfully updated.",
+ "schema": {
+ "$ref": "#/definitions/RedisPatchSchedule"
+ }
+ },
+ "201": {
+ "description": "The patch schedule was successfully created.",
+ "schema": {
+ "$ref": "#/definitions/RedisPatchSchedule"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse"
+ }
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "Redis",
+ "PatchSchedules"
+ ],
+ "operationId": "PatchSchedules_Delete",
+ "x-ms-examples": {
+ "RedisCachePatchSchedulesDelete": {
+ "$ref": "./examples/RedisCachePatchSchedulesDelete.json"
+ }
+ },
+ "description": "Deletes the patching schedule of a redis cache (requires Premium SKU).",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group."
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the redis cache."
+ },
+ {
+ "name": "default",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "Default string modeled as parameter for auto generation to work correctly.",
+ "enum": [
+ "default"
+ ],
+ "x-ms-enum": {
+ "name": "defaultName",
+ "modelAsString": true
+ }
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success."
+ },
+ "204": {
+ "description": "Success."
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse"
+ }
+ }
+ }
+ },
+ "get": {
+ "tags": [
+ "Redis",
+ "PatchSchedules"
+ ],
+ "operationId": "PatchSchedules_Get",
+ "x-ms-examples": {
+ "RedisCachePatchSchedulesGet": {
+ "$ref": "./examples/RedisCachePatchSchedulesGet.json"
+ }
+ },
+ "description": "Gets the patching schedule of a redis cache (requires Premium SKU).",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group."
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the redis cache."
+ },
+ {
+ "name": "default",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "Default string modeled as parameter for auto generation to work correctly.",
+ "enum": [
+ "default"
+ ],
+ "x-ms-enum": {
+ "name": "defaultName",
+ "modelAsString": true
+ }
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response of get patch schedules.",
+ "schema": {
+ "$ref": "#/definitions/RedisPatchSchedule"
+ }
+ },
+ "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/redis/{name}/linkedServers/{linkedServerName}": {
+ "put": {
+ "tags": [
+ "Redis"
+ ],
+ "operationId": "LinkedServer_Create",
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "LinkedServer_Create": {
+ "$ref": "./examples/RedisCacheLinkedServer_Create.json"
+ }
+ },
+ "description": "Adds a linked server to the Redis cache (requires Premium SKU).",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group."
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the Redis cache."
+ },
+ {
+ "name": "linkedServerName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the linked server that is being added to the Redis cache."
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/RedisLinkedServerCreateParameters"
+ },
+ "description": "Parameters supplied to the Create Linked server operation."
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The linked server was successfully added.",
+ "schema": {
+ "$ref": "#/definitions/RedisLinkedServerWithProperties"
+ }
+ },
+ "201": {
+ "description": "The linked server was successfully added.",
+ "schema": {
+ "$ref": "#/definitions/RedisLinkedServerWithProperties"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse"
+ }
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "Redis"
+ ],
+ "operationId": "LinkedServer_Delete",
+ "x-ms-examples": {
+ "LinkedServerDelete": {
+ "$ref": "./examples/RedisCacheLinkedServer_Delete.json"
+ }
+ },
+ "description": "Deletes the linked server from a redis cache (requires Premium SKU).",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group."
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the redis cache."
+ },
+ {
+ "name": "linkedServerName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the linked server that is being added to the Redis cache."
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The redis cache was successfully deleted."
+ },
+ "204": {
+ "description": "Linked server 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": [
+ "Redis"
+ ],
+ "operationId": "LinkedServer_Get",
+ "x-ms-examples": {
+ "LinkedServer_Get": {
+ "$ref": "./examples/RedisCacheLinkedServer_Get.json"
+ }
+ },
+ "description": "Gets the detailed information about a linked server of a redis cache (requires Premium SKU).",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group."
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the redis cache."
+ },
+ {
+ "name": "linkedServerName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the linked server."
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response of get linked server.",
+ "schema": {
+ "$ref": "#/definitions/RedisLinkedServerWithProperties"
+ }
+ },
+ "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/redis/{name}/linkedServers": {
+ "get": {
+ "tags": [
+ "Redis"
+ ],
+ "operationId": "LinkedServer_List",
+ "x-ms-examples": {
+ "LinkedServer_List": {
+ "$ref": "./examples/RedisCacheLinkedServer_List.json"
+ }
+ },
+ "description": "Gets the list of linked servers associated with this redis cache (requires Premium SKU).",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group."
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the redis cache."
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response of get linked servers.",
+ "schema": {
+ "$ref": "#/definitions/RedisLinkedServerWithPropertiesList"
+ }
+ },
+ "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/redis/{cacheName}/privateEndpointConnections": {
+ "get": {
+ "tags": [
+ "PrivateEndpointConnections"
+ ],
+ "operationId": "PrivateEndpointConnections_List",
+ "description": "List all the private endpoint connections associated with the redis cache.",
+ "x-ms-examples": {
+ "RedisCacheGetPrivateEndpointConnection": {
+ "$ref": "./examples/RedisCacheListPrivateEndpointConnections.json"
+ }
+ },
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group."
+ },
+ {
+ "name": "cacheName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the Redis cache."
+ },
+ {
+ "$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/v1/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/redis/{cacheName}/privateEndpointConnections/{privateEndpointConnectionName}": {
+ "get": {
+ "tags": [
+ "PrivateEndpointConnections"
+ ],
+ "operationId": "PrivateEndpointConnections_Get",
+ "description": "Gets the specified private endpoint connection associated with the redis cache.",
+ "x-ms-examples": {
+ "RedisCacheGetPrivateEndpointConnection": {
+ "$ref": "./examples/RedisCacheGetPrivateEndpointConnection.json"
+ }
+ },
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group."
+ },
+ {
+ "name": "cacheName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the Redis cache."
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v1/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/v1/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": "Update the state of specified private endpoint connection associated with the redis cache.",
+ "x-ms-examples": {
+ "RedisCachePutPrivateEndpointConnection": {
+ "$ref": "./examples/RedisCachePutPrivateEndpointConnection.json"
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group."
+ },
+ {
+ "name": "cacheName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the Redis cache."
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$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": {
+ "201": {
+ "description": "OK -- Update the private endpoint connection properties successfully.",
+ "schema": {
+ "$ref": "../../../../../common-types/resource-management/v1/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 redis cache.",
+ "x-ms-examples": {
+ "RedisCacheDeletePrivateEndpointConnection": {
+ "$ref": "./examples/RedisCacheDeletePrivateEndpointConnection.json"
+ }
+ },
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group."
+ },
+ {
+ "name": "cacheName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the Redis cache."
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v1/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/redis/{cacheName}/privateLinkResources": {
+ "get": {
+ "tags": [
+ "PrivateLinkResources"
+ ],
+ "operationId": "PrivateLinkResources_ListByRedisCache",
+ "description": "Gets the private link resources that need to be created for a redis cache.",
+ "x-ms-examples": {
+ "StorageAccountListPrivateLinkResources": {
+ "$ref": "./examples/RedisCacheListPrivateLinkResources.json"
+ }
+ },
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group."
+ },
+ {
+ "name": "cacheName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the Redis cache."
+ },
+ {
+ "$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/v1/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": {
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "The type of Redis cache to deploy. Valid values: (Basic, Standard, Premium)",
+ "enum": [
+ "Basic",
+ "Standard",
+ "Premium"
+ ],
+ "x-ms-enum": {
+ "name": "SkuName",
+ "modelAsString": true
+ }
+ },
+ "family": {
+ "type": "string",
+ "description": "The SKU family to use. Valid values: (C, P). (C = Basic/Standard, P = Premium).",
+ "enum": [
+ "C",
+ "P"
+ ],
+ "x-ms-enum": {
+ "name": "SkuFamily",
+ "modelAsString": true
+ }
+ },
+ "capacity": {
+ "type": "integer",
+ "format": "int32",
+ "description": "The size of the Redis cache to deploy. Valid values: for C (Basic/Standard) family (0, 1, 2, 3, 4, 5, 6), for P (Premium) family (1, 2, 3, 4)."
+ }
+ },
+ "required": [
+ "name",
+ "family",
+ "capacity"
+ ],
+ "description": "SKU parameters supplied to the create Redis operation."
+ },
+ "RedisCommonProperties": {
+ "properties": {
+ "redisConfiguration": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "All Redis Settings. Few possible keys: rdb-backup-enabled,rdb-storage-connection-string,rdb-backup-frequency,maxmemory-delta,maxmemory-policy,notify-keyspace-events,maxmemory-samples,slowlog-log-slower-than,slowlog-max-len,list-max-ziplist-entries,list-max-ziplist-value,hash-max-ziplist-entries,hash-max-ziplist-value,set-max-intset-entries,zset-max-ziplist-entries,zset-max-ziplist-value etc."
+ },
+ "enableNonSslPort": {
+ "type": "boolean",
+ "description": "Specifies whether the non-ssl Redis server port (6379) is enabled."
+ },
+ "replicasPerMaster": {
+ "type": "integer",
+ "format": "int32",
+ "description": "The number of replicas to be created per master."
+ },
+ "tenantSettings": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "A dictionary of tenant settings"
+ },
+ "shardCount": {
+ "type": "integer",
+ "format": "int32",
+ "description": "The number of shards to be created on a Premium Cluster Cache."
+ },
+ "minimumTlsVersion": {
+ "type": "string",
+ "description": "Optional: requires clients to use a specified TLS version (or higher) to connect (e,g, '1.0', '1.1', '1.2')",
+ "enum": [
+ "1.0",
+ "1.1",
+ "1.2"
+ ],
+ "x-ms-enum": {
+ "name": "TlsVersion",
+ "modelAsString": true
+ }
+ },
+ "publicNetworkAccess": {
+ "description": "Whether or not public endpoint access is allowed for this cache. Value is optional but if passed in, must be 'Enabled' or 'Disabled'. If 'Disabled', private endpoints are the exclusive access method. Default value is 'Enabled'",
+ "enum": [
+ "Enabled",
+ "Disabled"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "PublicNetworkAccess",
+ "modelAsString": true
+ }
+ }
+ },
+ "description": "Create/Update/Get common properties of the redis cache.",
+ "x-ms-external": true
+ },
+ "RedisCreateProperties": {
+ "properties": {
+ "sku": {
+ "$ref": "#/definitions/Sku",
+ "description": "The SKU of the Redis cache to deploy."
+ },
+ "subnetId": {
+ "type": "string",
+ "pattern": "^/subscriptions/[^/]*/resourceGroups/[^/]*/providers/Microsoft.(ClassicNetwork|Network)/virtualNetworks/[^/]*/subnets/[^/]*$",
+ "description": "The full resource ID of a subnet in a virtual network to deploy the Redis cache in. Example format: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/Microsoft.{Network|ClassicNetwork}/VirtualNetworks/vnet1/subnets/subnet1"
+ },
+ "staticIP": {
+ "type": "string",
+ "pattern": "^\\d+\\.\\d+\\.\\d+\\.\\d+$",
+ "description": "Static IP address. Required when deploying a Redis cache inside an existing Azure Virtual Network."
+ }
+ },
+ "required": [
+ "sku"
+ ],
+ "allOf": [
+ {
+ "$ref": "#/definitions/RedisCommonProperties"
+ }
+ ],
+ "description": "Properties supplied to Create Redis operation.",
+ "x-ms-external": true
+ },
+ "RedisUpdateProperties": {
+ "properties": {
+ "sku": {
+ "$ref": "#/definitions/Sku",
+ "description": "The SKU of the Redis cache to deploy."
+ }
+ },
+ "allOf": [
+ {
+ "$ref": "#/definitions/RedisCommonProperties"
+ }
+ ],
+ "description": "Patchable properties of the redis cache.",
+ "x-ms-external": true
+ },
+ "RedisProperties": {
+ "properties": {
+ "redisVersion": {
+ "readOnly": true,
+ "type": "string",
+ "description": "Redis version."
+ },
+ "provisioningState": {
+ "readOnly": true,
+ "type": "string",
+ "description": "Redis instance provisioning status.",
+ "enum": [
+ "Creating",
+ "Deleting",
+ "Disabled",
+ "Failed",
+ "Linking",
+ "Provisioning",
+ "RecoveringScaleFailure",
+ "Scaling",
+ "Succeeded",
+ "Unlinking",
+ "Unprovisioning",
+ "Updating"
+ ],
+ "x-ms-enum": {
+ "name": "ProvisioningState",
+ "modelAsString": true
+ }
+ },
+ "hostName": {
+ "readOnly": true,
+ "type": "string",
+ "description": "Redis host name."
+ },
+ "port": {
+ "readOnly": true,
+ "type": "integer",
+ "format": "int32",
+ "description": "Redis non-SSL port."
+ },
+ "sslPort": {
+ "readOnly": true,
+ "type": "integer",
+ "format": "int32",
+ "description": "Redis SSL port."
+ },
+ "accessKeys": {
+ "readOnly": true,
+ "$ref": "#/definitions/RedisAccessKeys",
+ "description": "The keys of the Redis cache - not set if this object is not the response to Create or Update redis cache"
+ },
+ "linkedServers": {
+ "readOnly": true,
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/RedisLinkedServer"
+ },
+ "description": "List of the linked servers associated with the cache"
+ },
+ "instances": {
+ "readOnly": true,
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/RedisInstanceDetails"
+ },
+ "description": "List of the Redis instances associated with the cache"
+ },
+ "privateEndpointConnections": {
+ "readOnly": true,
+ "type": "array",
+ "items": {
+ "$ref": "../../../../../common-types/resource-management/v1/privatelinks.json#/definitions/PrivateEndpointConnection"
+ },
+ "description": "List of private endpoint connection associated with the specified redis cache"
+ }
+ },
+ "allOf": [
+ {
+ "$ref": "#/definitions/RedisCreateProperties"
+ }
+ ],
+ "description": "Properties of the redis cache.",
+ "x-ms-external": true
+ },
+ "Resource": {
+ "description": "The Resource 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."
+ }
+ },
+ "x-ms-azure-resource": true
+ },
+ "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"
+ }
+ ]
+ },
+ "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"
+ }
+ ]
+ },
+ "RedisCreateParameters": {
+ "properties": {
+ "properties": {
+ "x-ms-client-flatten": true,
+ "$ref": "#/definitions/RedisCreateProperties",
+ "description": "Redis cache properties."
+ },
+ "zones": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "A list of availability zones denoting where the resource needs to come from."
+ },
+ "location": {
+ "type": "string",
+ "x-ms-mutability": [
+ "read",
+ "create"
+ ],
+ "description": "The geo-location where the resource lives"
+ },
+ "tags": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Resource tags."
+ }
+ },
+ "required": [
+ "properties",
+ "location"
+ ],
+ "description": "Parameters supplied to the Create Redis operation."
+ },
+ "RedisUpdateParameters": {
+ "properties": {
+ "properties": {
+ "x-ms-client-flatten": true,
+ "$ref": "#/definitions/RedisUpdateProperties",
+ "description": "Redis cache properties."
+ },
+ "tags": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Resource tags."
+ }
+ },
+ "description": "Parameters supplied to the Update Redis operation."
+ },
+ "RedisAccessKeys": {
+ "properties": {
+ "primaryKey": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The current primary key that clients can use to authenticate with Redis cache."
+ },
+ "secondaryKey": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The current secondary key that clients can use to authenticate with Redis cache."
+ }
+ },
+ "description": "Redis cache access keys."
+ },
+ "RedisFirewallRule": {
+ "description": "A firewall rule on a redis cache has a name, and describes a contiguous range of IP addresses permitted to connect",
+ "properties": {
+ "properties": {
+ "x-ms-client-flatten": true,
+ "$ref": "#/definitions/RedisFirewallRuleProperties",
+ "description": "redis cache firewall rule properties"
+ }
+ },
+ "required": [
+ "properties"
+ ],
+ "allOf": [
+ {
+ "$ref": "#/definitions/ProxyResource"
+ }
+ ]
+ },
+ "RedisFirewallRuleCreateParameters": {
+ "properties": {
+ "properties": {
+ "x-ms-client-flatten": true,
+ "$ref": "#/definitions/RedisFirewallRuleProperties",
+ "description": "Properties required to create a firewall rule ."
+ }
+ },
+ "required": [
+ "properties"
+ ],
+ "description": "Parameters required for creating a firewall rule on redis cache."
+ },
+ "RedisFirewallRuleProperties": {
+ "description": "Specifies a range of IP addresses permitted to connect to the cache",
+ "properties": {
+ "startIP": {
+ "type": "string",
+ "description": "lowest IP address included in the range"
+ },
+ "endIP": {
+ "type": "string",
+ "description": "highest IP address included in the range"
+ }
+ },
+ "required": [
+ "startIP",
+ "endIP"
+ ]
+ },
+ "RedisFirewallRuleListResult": {
+ "properties": {
+ "value": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/RedisFirewallRule"
+ },
+ "description": "Results of the list firewall rules operation."
+ },
+ "nextLink": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Link for next page of results."
+ }
+ },
+ "description": "The response of list firewall rules Redis operation."
+ },
+ "RedisResource": {
+ "properties": {
+ "properties": {
+ "x-ms-client-flatten": true,
+ "$ref": "#/definitions/RedisProperties",
+ "description": "Redis cache properties."
+ },
+ "zones": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "A list of availability zones denoting where the resource needs to come from."
+ }
+ },
+ "required": [
+ "properties"
+ ],
+ "allOf": [
+ {
+ "$ref": "#/definitions/TrackedResource"
+ }
+ ],
+ "description": "A single Redis item in List or Get Operation."
+ },
+ "RedisInstanceDetails": {
+ "properties": {
+ "sslPort": {
+ "readOnly": true,
+ "type": "integer",
+ "format": "int32",
+ "description": "Redis instance SSL port."
+ },
+ "nonSslPort": {
+ "readOnly": true,
+ "type": "integer",
+ "format": "int32",
+ "description": "If enableNonSslPort is true, provides Redis instance Non-SSL port."
+ },
+ "zone": {
+ "readOnly": true,
+ "type": "string",
+ "description": "If the Cache uses availability zones, specifies availability zone where this instance is located."
+ },
+ "shardId": {
+ "readOnly": true,
+ "type": "integer",
+ "format": "int32",
+ "description": "If clustering is enabled, the Shard ID of Redis Instance"
+ },
+ "isMaster": {
+ "readOnly": true,
+ "type": "boolean",
+ "description": "Specifies whether the instance is a master node."
+ }
+ },
+ "description": "Details of single instance of redis."
+ },
+ "RedisListResult": {
+ "properties": {
+ "value": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/RedisResource"
+ },
+ "description": "List of Redis cache instances."
+ },
+ "nextLink": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Link for next page of results."
+ }
+ },
+ "description": "The response of list Redis operation."
+ },
+ "RedisRegenerateKeyParameters": {
+ "properties": {
+ "keyType": {
+ "type": "string",
+ "description": "The Redis access key to regenerate.",
+ "enum": [
+ "Primary",
+ "Secondary"
+ ],
+ "x-ms-enum": {
+ "name": "RedisKeyType",
+ "modelAsString": false
+ }
+ }
+ },
+ "required": [
+ "keyType"
+ ],
+ "description": "Specifies which Redis access keys to reset."
+ },
+ "RedisRebootParameters": {
+ "properties": {
+ "rebootType": {
+ "type": "string",
+ "description": "Which Redis node(s) to reboot. Depending on this value data loss is possible.",
+ "enum": [
+ "PrimaryNode",
+ "SecondaryNode",
+ "AllNodes"
+ ],
+ "x-ms-enum": {
+ "name": "RebootType",
+ "modelAsString": true
+ }
+ },
+ "shardId": {
+ "type": "integer",
+ "format": "int32",
+ "description": "If clustering is enabled, the ID of the shard to be rebooted."
+ },
+ "ports": {
+ "type": "array",
+ "items": {
+ "type": "integer"
+ },
+ "description": "A list of redis instances to reboot, specified by per-instance SSL ports or non-SSL ports."
+ }
+ },
+ "description": "Specifies which Redis node(s) to reboot."
+ },
+ "ExportRDBParameters": {
+ "properties": {
+ "format": {
+ "type": "string",
+ "description": "File format."
+ },
+ "prefix": {
+ "type": "string",
+ "description": "Prefix to use for exported files."
+ },
+ "container": {
+ "type": "string",
+ "description": "Container name to export to."
+ }
+ },
+ "required": [
+ "container",
+ "prefix"
+ ],
+ "description": "Parameters for Redis export operation."
+ },
+ "ImportRDBParameters": {
+ "properties": {
+ "format": {
+ "type": "string",
+ "description": "File format."
+ },
+ "files": {
+ "type": "array",
+ "description": "files to import.",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "required": [
+ "files"
+ ],
+ "description": "Parameters for Redis import operation."
+ },
+ "ScheduleEntry": {
+ "properties": {
+ "dayOfWeek": {
+ "type": "string",
+ "description": "Day of the week when a cache can be patched.",
+ "enum": [
+ "Monday",
+ "Tuesday",
+ "Wednesday",
+ "Thursday",
+ "Friday",
+ "Saturday",
+ "Sunday",
+ "Everyday",
+ "Weekend"
+ ],
+ "x-ms-enum": {
+ "name": "DayOfWeek",
+ "modelAsString": false
+ }
+ },
+ "startHourUtc": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Start hour after which cache patching can start."
+ },
+ "maintenanceWindow": {
+ "type": "string",
+ "format": "duration",
+ "description": "ISO8601 timespan specifying how much time cache patching can take. "
+ }
+ },
+ "required": [
+ "dayOfWeek",
+ "startHourUtc"
+ ],
+ "description": "Patch schedule entry for a Premium Redis Cache."
+ },
+ "ScheduleEntries": {
+ "properties": {
+ "scheduleEntries": {
+ "x-ms-client-name": "ScheduleEntries",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ScheduleEntry"
+ },
+ "description": "List of patch schedules for a Redis cache."
+ }
+ },
+ "required": [
+ "scheduleEntries"
+ ],
+ "description": "List of patch schedules for a Redis cache."
+ },
+ "RedisPatchSchedule": {
+ "properties": {
+ "properties": {
+ "x-ms-client-flatten": true,
+ "$ref": "#/definitions/ScheduleEntries",
+ "description": "List of patch schedules for a Redis cache."
+ }
+ },
+ "required": [
+ "properties"
+ ],
+ "allOf": [
+ {
+ "$ref": "#/definitions/ProxyResource"
+ }
+ ],
+ "description": "Response to put/get patch schedules for Redis cache."
+ },
+ "RedisPatchScheduleListResult": {
+ "properties": {
+ "value": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/RedisPatchSchedule"
+ },
+ "description": "Results of the list patch schedules operation."
+ },
+ "nextLink": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Link for next page of results."
+ }
+ },
+ "description": "The response of list patch schedules Redis operation."
+ },
+ "RedisForceRebootResponse": {
+ "properties": {
+ "message": {
+ "readOnly": true,
+ "type": "string",
+ "description": "Status message"
+ }
+ },
+ "description": "Response to force reboot for Redis cache."
+ },
+ "RedisLinkedServer": {
+ "description": "Linked server Id",
+ "properties": {
+ "id": {
+ "readOnly": true,
+ "type": "string",
+ "description": "Linked server Id."
+ }
+ }
+ },
+ "RedisLinkedServerWithProperties": {
+ "description": "Response to put/get linked server (with properties) for Redis cache.",
+ "properties": {
+ "properties": {
+ "x-ms-client-flatten": true,
+ "$ref": "#/definitions/RedisLinkedServerProperties",
+ "description": "Properties of the linked server."
+ }
+ },
+ "allOf": [
+ {
+ "$ref": "#/definitions/ProxyResource"
+ }
+ ]
+ },
+ "RedisLinkedServerProperties": {
+ "description": "Properties of a linked server to be returned in get/put response",
+ "properties": {
+ "provisioningState": {
+ "readOnly": true,
+ "type": "string",
+ "description": "Terminal state of the link between primary and secondary redis cache."
+ }
+ },
+ "allOf": [
+ {
+ "$ref": "#/definitions/RedisLinkedServerCreateProperties"
+ }
+ ]
+ },
+ "RedisLinkedServerWithPropertiesList": {
+ "properties": {
+ "value": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/RedisLinkedServerWithProperties"
+ },
+ "description": "List of linked servers (with properties) of a Redis cache."
+ },
+ "nextLink": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Link for next set."
+ }
+ },
+ "description": "List of linked servers (with properties) of a Redis cache."
+ },
+ "RedisLinkedServerCreateProperties": {
+ "description": "Create properties for a linked server",
+ "properties": {
+ "linkedRedisCacheId": {
+ "type": "string",
+ "description": "Fully qualified resourceId of the linked redis cache."
+ },
+ "linkedRedisCacheLocation": {
+ "type": "string",
+ "description": "Location of the linked redis cache."
+ },
+ "serverRole": {
+ "type": "string",
+ "description": "Role of the linked server.",
+ "enum": [
+ "Primary",
+ "Secondary"
+ ],
+ "x-ms-enum": {
+ "name": "ReplicationRole",
+ "modelAsString": false
+ }
+ }
+ },
+ "required": [
+ "linkedRedisCacheId",
+ "linkedRedisCacheLocation",
+ "serverRole"
+ ]
+ },
+ "RedisLinkedServerCreateParameters": {
+ "properties": {
+ "properties": {
+ "x-ms-client-flatten": true,
+ "$ref": "#/definitions/RedisLinkedServerCreateProperties",
+ "description": "Properties required to create a linked server."
+ }
+ },
+ "required": [
+ "properties"
+ ],
+ "description": "Parameter required for creating a linked server to redis cache."
+ },
+ "Operation": {
+ "description": "REST API operation",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "Operation name: {provider}/{resource}/{operation}",
+ "type": "string"
+ },
+ "display": {
+ "description": "The object that describes the operation.",
+ "properties": {
+ "provider": {
+ "description": "Friendly name of the resource provider",
+ "type": "string"
+ },
+ "operation": {
+ "description": "Operation type: read, write, delete, listKeys/action, etc.",
+ "type": "string"
+ },
+ "resource": {
+ "description": "Resource type on which the operation is performed.",
+ "type": "string"
+ },
+ "description": {
+ "description": "Friendly name of the operation",
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "OperationListResult": {
+ "description": "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.",
+ "properties": {
+ "value": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/Operation"
+ },
+ "description": "List of operations supported by the resource provider."
+ },
+ "nextLink": {
+ "type": "string",
+ "readOnly": true,
+ "description": "URL to get the next set of operation list results if there are any."
+ }
+ }
+ },
+ "CheckNameAvailabilityParameters": {
+ "description": "Parameters body to pass for resource name availability check.",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "Resource name."
+ },
+ "type": {
+ "type": "string",
+ "description": "Resource type. The only legal value of this property for checking redis cache name availability is 'Microsoft.Cache/redis'."
+ }
+ },
+ "required": [
+ "name",
+ "type"
+ ]
+ },
+ "UpgradeNotification": {
+ "properties": {
+ "name": {
+ "readOnly": true,
+ "type": "string",
+ "description": "Name of upgrade notification."
+ },
+ "timestamp": {
+ "readOnly": true,
+ "type": "string",
+ "format": "date-time",
+ "description": "Timestamp when upgrade notification occurred."
+ },
+ "upsellNotification": {
+ "readOnly": true,
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Details about this upgrade notification"
+ }
+ },
+ "description": "Properties of upgrade notification."
+ },
+ "NotificationListResponse": {
+ "properties": {
+ "value": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/UpgradeNotification"
+ },
+ "description": "List of all notifications."
+ },
+ "nextLink": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Link for next set of notifications."
+ }
+ },
+ "description": "The response of listUpgradeNotifications."
+ }
+ },
+ "parameters": {
+ "SubscriptionIdParameter": {
+ "name": "subscriptionId",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "Gets 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."
+ }
+ }
+}
diff --git a/specification/redis/resource-manager/readme.md b/specification/redis/resource-manager/readme.md
index 305b826967ce..5427745f14b1 100644
--- a/specification/redis/resource-manager/readme.md
+++ b/specification/redis/resource-manager/readme.md
@@ -26,10 +26,18 @@ These are the global settings for the Redis API.
``` yaml
openapi-type: arm
-tag: package-2019-07-preview
+tag: package-2020-06
```
+### Tag: package-2020-06
+
+These settings apply only when `--tag=package-2020-06` is specified on the command line.
+
+```yaml $(tag) == 'package-2020-06'
+input-file:
+ - Microsoft.Cache/stable/2020-06-01/redis.json
+```
### Tag: package-2019-07-preview
These settings apply only when `--tag=package-2019-07-preview` is specified on the command line.
diff --git a/specification/regionmove/resource-manager/Microsoft.Migrate/preview/2019-10-01-preview/examples/MoveCollections_BulkRemove.json b/specification/regionmove/resource-manager/Microsoft.Migrate/preview/2019-10-01-preview/examples/MoveCollections_BulkRemove.json
new file mode 100644
index 000000000000..03877882ade2
--- /dev/null
+++ b/specification/regionmove/resource-manager/Microsoft.Migrate/preview/2019-10-01-preview/examples/MoveCollections_BulkRemove.json
@@ -0,0 +1,26 @@
+{
+ "parameters": {
+ "moveCollectionName": "movecollection1",
+ "subscriptionId": "subid",
+ "resourceGroupName": "rg1",
+ "api-version": "2019-10-01-preview",
+ "validateOnly": false,
+ "moveResources": [
+ "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Migrate/MoveCollections/movecollection1/MoveResources/moveresource1"
+ ]
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/e80eb9fa-c996-4435-aa32-5af6f3d3077c/resourceGroups/RegionMoveRG-southcentralus-southeastasia/providers/Microsoft.Migrate/MoveCollections/MoveCollection-southcentralus-southeastasia/operations/1e4193c3-206e-4916-b124-1da16175eb0e",
+ "name": "1e4193c3-206e-4916-b124-1da16175eb0e",
+ "status": "Succeeded",
+ "startTime": "6/17/2020 6:45:55 AM",
+ "endTime": "6/17/2020 6:45:56 AM",
+ "error": null,
+ "properties": {}
+ }
+ },
+ "202": {}
+ }
+}
diff --git a/specification/regionmove/resource-manager/Microsoft.Migrate/preview/2019-10-01-preview/regionmovecollection.json b/specification/regionmove/resource-manager/Microsoft.Migrate/preview/2019-10-01-preview/regionmovecollection.json
index 2917019b763d..380c436e6d19 100644
--- a/specification/regionmove/resource-manager/Microsoft.Migrate/preview/2019-10-01-preview/regionmovecollection.json
+++ b/specification/regionmove/resource-manager/Microsoft.Migrate/preview/2019-10-01-preview/regionmovecollection.json
@@ -612,6 +612,71 @@
}
}
},
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/moveCollections/{moveCollectionName}/bulkRemove": {
+ "post": {
+ "tags": [
+ "MoveCollections"
+ ],
+ "operationId": "MoveCollections_BulkRemove",
+ "description": "Removes the set of move resources included in the request body from move collection. The orchestration is done by service. To aid the user to prerequisite the operation the client can call operation with validateOnly property set to true.",
+ "x-ms-long-running-operation": true,
+ "x-ms-long-running-operation-options": {
+ "final-state-via": "azure-async-operation"
+ },
+ "consumes": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/subscriptionId"
+ },
+ {
+ "in": "path",
+ "name": "resourceGroupName",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "in": "path",
+ "name": "moveCollectionName",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/api-version"
+ },
+ {
+ "in": "body",
+ "name": "body",
+ "schema": {
+ "$ref": "#/definitions/BulkRemoveRequest"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/OperationStatus"
+ }
+ },
+ "202": {
+ "description": "Accepted"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "MoveCollections_BulkRemove": {
+ "$ref": "./examples/MoveCollections_BulkRemove.json"
+ }
+ }
+ }
+ },
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/moveCollections/{moveCollectionName}/moveResources/{moveResourceName}": {
"put": {
"tags": [
@@ -1210,6 +1275,21 @@
}
}
},
+ "SummaryItem": {
+ "description": "Summary item.",
+ "type": "object",
+ "properties": {
+ "count": {
+ "format": "int32",
+ "description": "Gets the count.",
+ "type": "integer"
+ },
+ "item": {
+ "description": "Gets the item.",
+ "type": "string"
+ }
+ }
+ },
"MoveCollectionProperties": {
"description": "Defines the move collection properties.",
"type": "object",
@@ -1387,6 +1467,26 @@
}
}
},
+ "BulkRemoveRequest": {
+ "description": "Defines the request body for bulk remove of move resources operation.",
+ "type": "object",
+ "properties": {
+ "validateOnly": {
+ "description": "Gets or sets a value indicating whether the operation needs to only run pre-requisite.",
+ "type": "boolean"
+ },
+ "moveResources": {
+ "description": "Gets or sets the list of resource Id's, by default it accepts move resource id's unless the input type is switched via moveResourceInputType property.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "moveResourceInputType": {
+ "$ref": "#/definitions/MoveResourceInputType"
+ }
+ }
+ },
"MoveResourceFilter": {
"description": "Move resource filter.",
"properties": {
@@ -1417,6 +1517,13 @@
"nextLink": {
"description": "Gets the value of next link.",
"type": "string"
+ },
+ "summary": {
+ "description": "Gets or the list of summary items.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/SummaryItem"
+ }
}
}
},
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 671bd631410f..daabe2fe08bd 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
@@ -1372,14 +1372,16 @@
"in": "path",
"required": true,
"type": "string",
- "description": "EventId for the Service health event"
+ "description": "EventId for the Service health event",
+ "x-ms-parameter-location": "method"
},
"ViewParameter": {
"name": "view",
"in": "query",
"required": false,
"type": "string",
- "description": "setting view=full expands the article parameters"
+ "description": "setting view=full expands the article parameters",
+ "x-ms-parameter-location": "method"
}
}
}
diff --git a/specification/resources/resource-manager/Microsoft.Resources/preview/2019-10-01-preview/deploymentScripts.json b/specification/resources/resource-manager/Microsoft.Resources/preview/2019-10-01-preview/deploymentScripts.json
index 1a8320f05151..5353e011b425 100644
--- a/specification/resources/resource-manager/Microsoft.Resources/preview/2019-10-01-preview/deploymentScripts.json
+++ b/specification/resources/resource-manager/Microsoft.Resources/preview/2019-10-01-preview/deploymentScripts.json
@@ -752,6 +752,10 @@
"modelAsString": true
}
},
+ "tenantId": {
+ "type": "string",
+ "description": "ID of the Azure Active Directory."
+ },
"userAssignedIdentities": {
"type": "object",
"description": "The list of user-assigned managed identities associated with the resource. Key is the Azure resource Id of the managed identity.",
diff --git a/specification/resources/resource-manager/Microsoft.Resources/preview/2020-10-01-preview/examples/TemplateSpecVersionsCreate.json b/specification/resources/resource-manager/Microsoft.Resources/preview/2020-10-01-preview/examples/TemplateSpecVersionsCreate.json
new file mode 100644
index 000000000000..8871f54c9fc0
--- /dev/null
+++ b/specification/resources/resource-manager/Microsoft.Resources/preview/2020-10-01-preview/examples/TemplateSpecVersionsCreate.json
@@ -0,0 +1,73 @@
+{
+ "parameters": {
+ "api-version": "2020-10-01-preview",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "templateSpecRG",
+ "templateSpecName": "simpleTemplateSpec",
+ "templateSpecVersion": "v1.0",
+ "templateSpecVersionModel": {
+ "location": "eastus",
+ "properties": {
+ "description": "This is version v1.0 of our template content",
+ "template": {
+ "$schema": "http://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#",
+ "contentVersion": "1.0.0.0",
+ "parameters": {},
+ "resources": []
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/templateSpecRG/providers/Microsoft.Resources/templateSpecs/simpleTemplateSpec/versions/v1.0",
+ "type": "Microsoft.Resources/templateSpecs/versions",
+ "name": "v1.0",
+ "location": "eastus",
+ "systemData": {
+ "createdBy": "string",
+ "createdByType": "Application",
+ "createdAt": "2020-02-01T01:01:01.1075056Z",
+ "lastModifiedBy": "string",
+ "lastModifiedByType": "Application",
+ "lastModifiedAt": "2020-02-02T02:03:01.1974346Z"
+ },
+ "properties": {
+ "description": "This is version v1.0 of our template content",
+ "template": {
+ "$schema": "http://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#",
+ "contentVersion": "1.0.0.0",
+ "parameters": {},
+ "resources": []
+ }
+ }
+ }
+ },
+ "201": {
+ "body": {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/templateSpecRG/providers/Microsoft.Resources/templateSpecs/simpleTemplateSpec/versions/v1.0",
+ "type": "Microsoft.Resources/templateSpecs/versions",
+ "name": "v1.0",
+ "location": "eastus",
+ "systemData": {
+ "createdBy": "string",
+ "createdByType": "Application",
+ "createdAt": "2020-02-01T01:01:01.1075056Z",
+ "lastModifiedBy": "string",
+ "lastModifiedByType": "Application",
+ "lastModifiedAt": "2020-02-01T01:01:01.1075056Z"
+ },
+ "properties": {
+ "description": "This is version v1.0 of our template content",
+ "template": {
+ "$schema": "http://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#",
+ "contentVersion": "1.0.0.0",
+ "parameters": {},
+ "resources": []
+ }
+ }
+ }
+ }
+ }
+}
diff --git a/specification/resources/resource-manager/Microsoft.Resources/preview/2020-10-01-preview/examples/TemplateSpecVersionsDelete.json b/specification/resources/resource-manager/Microsoft.Resources/preview/2020-10-01-preview/examples/TemplateSpecVersionsDelete.json
new file mode 100644
index 000000000000..944606a6e958
--- /dev/null
+++ b/specification/resources/resource-manager/Microsoft.Resources/preview/2020-10-01-preview/examples/TemplateSpecVersionsDelete.json
@@ -0,0 +1,13 @@
+{
+ "parameters": {
+ "api-version": "2020-10-01-preview",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "templateSpecRG",
+ "templateSpecName": "simpleTemplateSpec",
+ "templateSpecVersion": "v1.0"
+ },
+ "responses": {
+ "200": {},
+ "204": {}
+ }
+}
diff --git a/specification/resources/resource-manager/Microsoft.Resources/preview/2020-10-01-preview/examples/TemplateSpecVersionsGet.json b/specification/resources/resource-manager/Microsoft.Resources/preview/2020-10-01-preview/examples/TemplateSpecVersionsGet.json
new file mode 100644
index 000000000000..358d16cbb79e
--- /dev/null
+++ b/specification/resources/resource-manager/Microsoft.Resources/preview/2020-10-01-preview/examples/TemplateSpecVersionsGet.json
@@ -0,0 +1,36 @@
+{
+ "parameters": {
+ "api-version": "2020-10-01-preview",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "templateSpecRG",
+ "templateSpecName": "simpleTemplateSpec",
+ "templateSpecVersion": "v1.0"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/templateSpecRG/providers/Microsoft.Resources/templateSpecs/simpleTemplateSpec/versions/v1.0",
+ "type": "Microsoft.Resources/templateSpecs/versions",
+ "name": "v1.0",
+ "location": "eastus",
+ "systemData": {
+ "createdBy": "string",
+ "createdByType": "Application",
+ "createdAt": "2020-02-01T01:01:01.1075056Z",
+ "lastModifiedBy": "string",
+ "lastModifiedByType": "Application",
+ "lastModifiedAt": "2020-02-02T02:03:01.1974346Z"
+ },
+ "properties": {
+ "description": "This is version v1.0 of our template content",
+ "template": {
+ "$schema": "http://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#",
+ "contentVersion": "1.0.0.0",
+ "parameters": {},
+ "resources": []
+ }
+ }
+ }
+ }
+ }
+}
diff --git a/specification/resources/resource-manager/Microsoft.Resources/preview/2020-10-01-preview/examples/TemplateSpecVersionsList.json b/specification/resources/resource-manager/Microsoft.Resources/preview/2020-10-01-preview/examples/TemplateSpecVersionsList.json
new file mode 100644
index 000000000000..78a7dfff1101
--- /dev/null
+++ b/specification/resources/resource-manager/Microsoft.Resources/preview/2020-10-01-preview/examples/TemplateSpecVersionsList.json
@@ -0,0 +1,50 @@
+{
+ "parameters": {
+ "api-version": "2020-10-01-preview",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "templateSpecRG",
+ "templateSpecName": "simpleTemplateSpec"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/templateSpecRG/providers/Microsoft.Resources/templateSpecs/simpleTemplateSpec/versions/v1.0",
+ "type": "Microsoft.Resources/templateSpecs/versions",
+ "name": "v1.0",
+ "location": "eastus",
+ "systemData": {
+ "createdBy": "string",
+ "createdByType": "Application",
+ "createdAt": "2020-02-01T01:01:01.1075056Z",
+ "lastModifiedBy": "string",
+ "lastModifiedByType": "Application",
+ "lastModifiedAt": "2020-02-02T02:03:01.1974346Z"
+ },
+ "properties": {
+ "description": "This is version v1.0"
+ }
+ },
+ {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/templateSpecRG/providers/Microsoft.Resources/templateSpecs/simpleTemplateSpec/versions/v2.0",
+ "type": "Microsoft.Resources/templateSpecs/versions",
+ "name": "v2.0",
+ "location": "eastus",
+ "systemData": {
+ "createdBy": "string",
+ "createdByType": "Application",
+ "createdAt": "2020-02-03T01:01:01.1075056Z",
+ "lastModifiedBy": "string",
+ "lastModifiedByType": "Application",
+ "lastModifiedAt": "2020-02-04T02:03:01.1974346Z"
+ },
+ "properties": {
+ "description": "This is another version (v2.0)"
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/resources/resource-manager/Microsoft.Resources/preview/2020-10-01-preview/examples/TemplateSpecVersionsPatch.json b/specification/resources/resource-manager/Microsoft.Resources/preview/2020-10-01-preview/examples/TemplateSpecVersionsPatch.json
new file mode 100644
index 000000000000..2da272aeb19c
--- /dev/null
+++ b/specification/resources/resource-manager/Microsoft.Resources/preview/2020-10-01-preview/examples/TemplateSpecVersionsPatch.json
@@ -0,0 +1,44 @@
+{
+ "parameters": {
+ "api-version": "2020-10-01-preview",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "templateSpecRG",
+ "templateSpecName": "simpleTemplateSpec",
+ "templateSpecVersion": "v1.0",
+ "templateSpecVersionUpdateModel": {
+ "tags": {
+ "myTag": "My Value"
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/templateSpecRG/providers/Microsoft.Resources/templateSpecs/simpleTemplateSpec/versions/v1.0",
+ "type": "Microsoft.Resources/templateSpecs/versions",
+ "name": "v1.0",
+ "location": "eastus",
+ "systemData": {
+ "createdBy": "string",
+ "createdByType": "Application",
+ "createdAt": "2020-02-01T01:01:01.1075056Z",
+ "lastModifiedBy": "string",
+ "lastModifiedByType": "Application",
+ "lastModifiedAt": "2020-02-02T02:03:01.1974346Z"
+ },
+ "properties": {
+ "description": "This is version v1.0 of our template content",
+ "template": {
+ "$schema": "http://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#",
+ "contentVersion": "1.0.0.0",
+ "parameters": {},
+ "resources": []
+ }
+ },
+ "tags": {
+ "myTag": "My Value"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/resources/resource-manager/Microsoft.Resources/preview/2020-10-01-preview/examples/TemplateSpecsCreate.json b/specification/resources/resource-manager/Microsoft.Resources/preview/2020-10-01-preview/examples/TemplateSpecsCreate.json
new file mode 100644
index 000000000000..c08c0ac3d1d6
--- /dev/null
+++ b/specification/resources/resource-manager/Microsoft.Resources/preview/2020-10-01-preview/examples/TemplateSpecsCreate.json
@@ -0,0 +1,54 @@
+{
+ "parameters": {
+ "api-version": "2020-10-01-preview",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "templateSpecRG",
+ "templateSpecName": "simpleTemplateSpec",
+ "templateSpec": {
+ "location": "eastus",
+ "properties": {
+ "description": "A very simple Template Spec"
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/templateSpecRG/providers/Microsoft.Resources/templateSpecs/simpleTemplateSpec",
+ "type": "Microsoft.Resources/templateSpecs",
+ "name": "simpleTemplateSpec",
+ "location": "eastus",
+ "systemData": {
+ "createdBy": "string",
+ "createdByType": "Application",
+ "createdAt": "2020-02-01T01:01:01.1075056Z",
+ "lastModifiedBy": "string",
+ "lastModifiedByType": "Application",
+ "lastModifiedAt": "2020-02-01T01:01:01.1075056Z"
+ },
+ "properties": {
+ "description": "A very simple Template Spec"
+ }
+ }
+ },
+ "201": {
+ "body": {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/templateSpecRG/providers/Microsoft.Resources/templateSpecs/simpleTemplateSpec",
+ "type": "Microsoft.Resources/templateSpecs",
+ "name": "simpleTemplateSpec",
+ "location": "eastus",
+ "systemData": {
+ "createdBy": "string",
+ "createdByType": "Application",
+ "createdAt": "2020-02-01T01:01:01.1075056Z",
+ "lastModifiedBy": "string",
+ "lastModifiedByType": "Application",
+ "lastModifiedAt": "2020-02-02T02:03:01.1974346Z"
+ },
+ "properties": {
+ "description": "A very simple Template Spec"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/resources/resource-manager/Microsoft.Resources/preview/2020-10-01-preview/examples/TemplateSpecsDelete.json b/specification/resources/resource-manager/Microsoft.Resources/preview/2020-10-01-preview/examples/TemplateSpecsDelete.json
new file mode 100644
index 000000000000..d8bbbb09f471
--- /dev/null
+++ b/specification/resources/resource-manager/Microsoft.Resources/preview/2020-10-01-preview/examples/TemplateSpecsDelete.json
@@ -0,0 +1,12 @@
+{
+ "parameters": {
+ "api-version": "2020-10-01-preview",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "templateSpecRG",
+ "templateSpecName": "simpleTemplateSpec"
+ },
+ "responses": {
+ "200": {},
+ "204": {}
+ }
+}
diff --git a/specification/resources/resource-manager/Microsoft.Resources/preview/2020-10-01-preview/examples/TemplateSpecsGet.json b/specification/resources/resource-manager/Microsoft.Resources/preview/2020-10-01-preview/examples/TemplateSpecsGet.json
new file mode 100644
index 000000000000..4a712621bde8
--- /dev/null
+++ b/specification/resources/resource-manager/Microsoft.Resources/preview/2020-10-01-preview/examples/TemplateSpecsGet.json
@@ -0,0 +1,29 @@
+{
+ "parameters": {
+ "api-version": "2020-10-01-preview",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "templateSpecRG",
+ "templateSpecName": "simpleTemplateSpec"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/templateSpecRG/providers/Microsoft.Resources/templateSpecs/simpleTemplateSpec",
+ "type": "Microsoft.Resources/templateSpecs",
+ "name": "simpleTemplateSpec",
+ "location": "eastus",
+ "systemData": {
+ "createdBy": "string",
+ "createdByType": "Application",
+ "createdAt": "2020-02-01T01:01:01.1075056Z",
+ "lastModifiedBy": "string",
+ "lastModifiedByType": "Application",
+ "lastModifiedAt": "2020-02-02T02:03:01.1974346Z"
+ },
+ "properties": {
+ "description": "A very simple Template Spec"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/resources/resource-manager/Microsoft.Resources/preview/2020-10-01-preview/examples/TemplateSpecsListByResourceGroup.json b/specification/resources/resource-manager/Microsoft.Resources/preview/2020-10-01-preview/examples/TemplateSpecsListByResourceGroup.json
new file mode 100644
index 000000000000..0c700fbcf888
--- /dev/null
+++ b/specification/resources/resource-manager/Microsoft.Resources/preview/2020-10-01-preview/examples/TemplateSpecsListByResourceGroup.json
@@ -0,0 +1,49 @@
+{
+ "parameters": {
+ "api-version": "2020-10-01-preview",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "templateSpecRG"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/templateSpecRG/providers/Microsoft.Resources/templateSpecs/simpleTemplateSpec",
+ "type": "Microsoft.Resources/templateSpecs",
+ "name": "simpleTemplateSpec",
+ "location": "eastus",
+ "systemData": {
+ "createdBy": "string",
+ "createdByType": "Application",
+ "createdAt": "2020-02-01T01:01:01.1075056Z",
+ "lastModifiedBy": "string",
+ "lastModifiedByType": "Application",
+ "lastModifiedAt": "2020-02-02T02:03:01.1974346Z"
+ },
+ "properties": {
+ "description": "A very simple Template Spec"
+ }
+ },
+ {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/templateSpecRG/providers/Microsoft.Resources/templateSpecs/anotherSimpleTemplateSpec",
+ "type": "Microsoft.Resources/templateSpecs",
+ "name": "anotherSimpleTemplateSpec",
+ "location": "westus",
+ "systemData": {
+ "createdBy": "string",
+ "createdByType": "Application",
+ "createdAt": "2020-02-02T01:01:01.1075056Z",
+ "lastModifiedBy": "string",
+ "lastModifiedByType": "Application",
+ "lastModifiedAt": "2020-02-03T02:03:01.1974346Z"
+ },
+ "properties": {
+ "description": "Another very simple Template Spec"
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/resources/resource-manager/Microsoft.Resources/preview/2020-10-01-preview/examples/TemplateSpecsListBySubscription.json b/specification/resources/resource-manager/Microsoft.Resources/preview/2020-10-01-preview/examples/TemplateSpecsListBySubscription.json
new file mode 100644
index 000000000000..7509ac9c90fc
--- /dev/null
+++ b/specification/resources/resource-manager/Microsoft.Resources/preview/2020-10-01-preview/examples/TemplateSpecsListBySubscription.json
@@ -0,0 +1,48 @@
+{
+ "parameters": {
+ "api-version": "2020-10-01-preview",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/templateSpecRG/providers/Microsoft.Resources/templateSpecs/simpleTemplateSpec",
+ "type": "Microsoft.Resources/templateSpecs",
+ "name": "simpleTemplateSpec",
+ "location": "eastus",
+ "systemData": {
+ "createdBy": "string",
+ "createdByType": "Application",
+ "createdAt": "2020-02-01T01:01:01.1075056Z",
+ "lastModifiedBy": "string",
+ "lastModifiedByType": "Application",
+ "lastModifiedAt": "2020-02-02T02:03:01.1974346Z"
+ },
+ "properties": {
+ "description": "A very simple Template Spec"
+ }
+ },
+ {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/templateSpecRG2/providers/Microsoft.Resources/templateSpecs/anotherSimpleTemplateSpec",
+ "type": "Microsoft.Resources/templateSpecs",
+ "name": "anotherSimpleTemplateSpec",
+ "location": "westus",
+ "systemData": {
+ "createdBy": "string",
+ "createdByType": "Application",
+ "createdAt": "2020-02-02T01:01:01.1075056Z",
+ "lastModifiedBy": "string",
+ "lastModifiedByType": "Application",
+ "lastModifiedAt": "2020-02-03T02:03:01.1974346Z"
+ },
+ "properties": {
+ "description": "Another very simple Template Spec"
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/resources/resource-manager/Microsoft.Resources/preview/2020-10-01-preview/examples/TemplateSpecsPatch.json b/specification/resources/resource-manager/Microsoft.Resources/preview/2020-10-01-preview/examples/TemplateSpecsPatch.json
new file mode 100644
index 000000000000..94593a2913d3
--- /dev/null
+++ b/specification/resources/resource-manager/Microsoft.Resources/preview/2020-10-01-preview/examples/TemplateSpecsPatch.json
@@ -0,0 +1,37 @@
+{
+ "parameters": {
+ "api-version": "2020-10-01-preview",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "templateSpecRG",
+ "templateSpecName": "simpleTemplateSpec",
+ "templateSpec": {
+ "tags": {
+ "myTag": "My Value"
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/templateSpecRG/providers/Microsoft.Resources/templateSpecs/simpleTemplateSpec",
+ "type": "Microsoft.Resources/templateSpecs",
+ "name": "simpleTemplateSpec",
+ "location": "eastus",
+ "systemData": {
+ "createdBy": "string",
+ "createdByType": "Application",
+ "createdAt": "2020-02-01T01:01:01.1075056Z",
+ "lastModifiedBy": "string",
+ "lastModifiedByType": "Application",
+ "lastModifiedAt": "2020-02-02T02:03:01.1974346Z"
+ },
+ "properties": {
+ "description": "A very simple Template Spec"
+ },
+ "tags": {
+ "myTag": "My Value"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/resources/resource-manager/Microsoft.Resources/preview/2020-10-01-preview/templateSpecs.json b/specification/resources/resource-manager/Microsoft.Resources/preview/2020-10-01-preview/templateSpecs.json
new file mode 100644
index 000000000000..ae2b1b39d302
--- /dev/null
+++ b/specification/resources/resource-manager/Microsoft.Resources/preview/2020-10-01-preview/templateSpecs.json
@@ -0,0 +1,867 @@
+{
+ "swagger": "2.0",
+ "info": {
+ "title": "TemplateSpecsClient",
+ "description": "The APIs listed in this specification can be used to manage Template Spec resources through the Azure Resource Manager.",
+ "version": "2020-10-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.Resources/templateSpecs/{templateSpecName}": {
+ "put": {
+ "tags": [
+ "TemplateSpecs"
+ ],
+ "operationId": "TemplateSpecs_CreateOrUpdate",
+ "description": "Creates or updates a Template Spec.",
+ "x-ms-examples": {
+ "TemplateSpecsCreateUpdate": {
+ "$ref": "./examples/TemplateSpecsCreate.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/TemplateSpecNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "name": "templateSpec",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/TemplateSpec"
+ },
+ "description": "Template Spec supplied to the operation."
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - The Template Spec update request has succeeded.",
+ "schema": {
+ "$ref": "#/definitions/TemplateSpec"
+ }
+ },
+ "201": {
+ "description": "Template Spec created.",
+ "schema": {
+ "$ref": "#/definitions/TemplateSpec"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/TemplateSpecsError"
+ }
+ }
+ }
+ },
+ "patch": {
+ "tags": [
+ "TemplateSpecs"
+ ],
+ "operationId": "TemplateSpecs_Update",
+ "description": "Updates Template Spec tags with specified values.",
+ "x-ms-examples": {
+ "TemplateSpecsPatch": {
+ "$ref": "./examples/TemplateSpecsPatch.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/TemplateSpecNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "name": "templateSpec",
+ "in": "body",
+ "schema": {
+ "$ref": "#/definitions/TemplateSpecUpdateModel"
+ },
+ "description": "Template Spec resource with the tags to be updated."
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK -- Template Spec tags are updated.",
+ "schema": {
+ "$ref": "#/definitions/TemplateSpec"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/TemplateSpecsError"
+ }
+ }
+ }
+ },
+ "get": {
+ "tags": [
+ "TemplateSpecs"
+ ],
+ "operationId": "TemplateSpecs_Get",
+ "description": "Gets a Template Spec with a given name.",
+ "x-ms-examples": {
+ "TemplateSpecsGet": {
+ "$ref": "./examples/TemplateSpecsGet.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/TemplateSpecNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - Returns information about the Template Spec.",
+ "schema": {
+ "$ref": "#/definitions/TemplateSpec"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/TemplateSpecsError"
+ }
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "TemplateSpecs"
+ ],
+ "operationId": "TemplateSpecs_Delete",
+ "description": "Deletes a Template Spec by name. When operation completes, status code 200 returned without content.",
+ "x-ms-examples": {
+ "TemplateSpecsDelete": {
+ "$ref": "./examples/TemplateSpecsDelete.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/TemplateSpecNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - Template Spec deleted."
+ },
+ "204": {
+ "description": "Template Spec does not exist."
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/TemplateSpecsError"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/providers/Microsoft.Resources/templateSpecs/": {
+ "get": {
+ "tags": [
+ "TemplateSpecs"
+ ],
+ "operationId": "TemplateSpecs_ListBySubscription",
+ "description": "Lists all the Template Specs within the specified subscriptions.",
+ "x-ms-examples": {
+ "TemplatesSpecsListBySubscription": {
+ "$ref": "./examples/TemplateSpecsListBySubscription.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - Returns an array of Template Specs.",
+ "schema": {
+ "$ref": "#/definitions/TemplateSpecsListResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/TemplateSpecsError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Resources/templateSpecs/": {
+ "get": {
+ "tags": [
+ "TemplateSpecs"
+ ],
+ "operationId": "TemplateSpecs_ListByResourceGroup",
+ "description": "Lists all the Template Specs within the specified resource group.",
+ "x-ms-examples": {
+ "TemplateSpecsListByResourceGroup": {
+ "$ref": "./examples/TemplateSpecsListByResourceGroup.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - Returns an array of Template Specs.",
+ "schema": {
+ "$ref": "#/definitions/TemplateSpecsListResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/TemplateSpecsError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Resources/templateSpecs/{templateSpecName}/versions/{templateSpecVersion}": {
+ "put": {
+ "tags": [
+ "TemplateSpecVersions"
+ ],
+ "operationId": "TemplateSpecVersions_CreateOrUpdate",
+ "description": "Creates or updates a Template Spec version.",
+ "x-ms-examples": {
+ "TemplateSpecVersionsCreateUpdate": {
+ "$ref": "./examples/TemplateSpecVersionsCreate.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/TemplateSpecNameParameter"
+ },
+ {
+ "$ref": "#/parameters/TemplateSpecVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "name": "templateSpecVersionModel",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/TemplateSpecVersion"
+ },
+ "description": "Template Spec Version supplied to the operation."
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - The Template Spec Version has been successfully updated.",
+ "schema": {
+ "$ref": "#/definitions/TemplateSpecVersion"
+ }
+ },
+ "201": {
+ "description": "Template Spec Version created.",
+ "schema": {
+ "$ref": "#/definitions/TemplateSpecVersion"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/TemplateSpecsError"
+ }
+ }
+ }
+ },
+ "patch": {
+ "tags": [
+ "TemplateSpecVersions"
+ ],
+ "operationId": "TemplateSpecVersions_Update",
+ "description": "Updates Template Spec Version tags with specified values.",
+ "x-ms-examples": {
+ "TemplateSpecsPatch": {
+ "$ref": "./examples/TemplateSpecVersionsPatch.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/TemplateSpecNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/TemplateSpecVersionParameter"
+ },
+ {
+ "name": "templateSpecVersionUpdateModel",
+ "in": "body",
+ "schema": {
+ "$ref": "#/definitions/TemplateSpecVersionUpdateModel"
+ },
+ "description": "Template Spec Version resource with the tags to be updated."
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK -- Template Spec Version tags are updated.",
+ "schema": {
+ "$ref": "#/definitions/TemplateSpecVersion"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/TemplateSpecsError"
+ }
+ }
+ }
+ },
+ "get": {
+ "tags": [
+ "TemplateSpecVersions"
+ ],
+ "operationId": "TemplateSpecVersions_Get",
+ "description": "Gets a Template Spec version from a specific Template Spec.",
+ "x-ms-examples": {
+ "TemplateSpecVersionsGet": {
+ "$ref": "./examples/TemplateSpecVersionsGet.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/TemplateSpecNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/TemplateSpecVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - Returns information about the Template Spec version.",
+ "schema": {
+ "$ref": "#/definitions/TemplateSpecVersion"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/TemplateSpecsError"
+ }
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "TemplateSpecVersions"
+ ],
+ "operationId": "TemplateSpecVersions_Delete",
+ "description": "Deletes a specific version from a Template Spec. When operation completes, status code 200 returned without content.",
+ "x-ms-examples": {
+ "TemplateSpecVersionsDelete": {
+ "$ref": "./examples/TemplateSpecVersionsDelete.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/TemplateSpecNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/TemplateSpecVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - Template Spec Version deleted."
+ },
+ "204": {
+ "description": "Template Spec Version does not exist."
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/TemplateSpecsError"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Resources/templateSpecs/{templateSpecName}/versions": {
+ "get": {
+ "tags": [
+ "TemplateSpecVersions"
+ ],
+ "operationId": "TemplateSpecVersions_List",
+ "description": "Lists all the Template Spec versions in the specified Template Spec.",
+ "x-ms-examples": {
+ "TemplateSpecVersions_List": {
+ "$ref": "./examples/TemplateSpecVersionsList.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/TemplateSpecNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - Returns an array of Template Spec versions.",
+ "schema": {
+ "$ref": "#/definitions/TemplateSpecVersionsListResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/TemplateSpecsError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ }
+ },
+ "definitions": {
+ "TemplateSpec": {
+ "required": [
+ "location"
+ ],
+ "type": "object",
+ "description": "Template Spec object.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/AzureResourceBase"
+ }
+ ],
+ "properties": {
+ "location": {
+ "type": "string",
+ "x-ms-mutability": [
+ "read",
+ "create"
+ ],
+ "description": "The location of the Template Spec. It cannot be changed after Template Spec creation. It must be one of the supported Azure locations."
+ },
+ "properties": {
+ "description": "Template Spec properties.",
+ "x-ms-client-flatten": true,
+ "$ref": "#/definitions/TemplateSpecProperties"
+ },
+ "tags": {
+ "type": "object",
+ "description": "Resource tags.",
+ "additionalProperties": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "TemplateSpecProperties": {
+ "type": "object",
+ "description": "Template Spec properties.",
+ "properties": {
+ "description": {
+ "type": "string",
+ "maxLength": 4096,
+ "description": "Template Spec description."
+ },
+ "displayName": {
+ "type": "string",
+ "maxLength": 64,
+ "description": "Template Spec display name."
+ }
+ }
+ },
+ "TemplateSpecsListResult": {
+ "description": "List of Template Specs.",
+ "properties": {
+ "value": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/TemplateSpec"
+ },
+ "description": "An array of Template Specs."
+ },
+ "nextLink": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The URL to use for getting the next set of results."
+ }
+ }
+ },
+ "TemplateSpecUpdateModel": {
+ "type": "object",
+ "description": "Template Spec properties to be updated (only tags are currently supported).",
+ "properties": {
+ "tags": {
+ "type": "object",
+ "description": "Resource tags.",
+ "additionalProperties": {
+ "type": "string"
+ }
+ }
+ },
+ "allOf": [
+ {
+ "$ref": "#/definitions/AzureResourceBase"
+ }
+ ]
+ },
+ "TemplateSpecVersionUpdateModel": {
+ "type": "object",
+ "description": "Template Spec Version properties to be updated (only tags are currently supported).",
+ "properties": {
+ "tags": {
+ "type": "object",
+ "description": "Resource tags.",
+ "additionalProperties": {
+ "type": "string"
+ }
+ }
+ },
+ "allOf": [
+ {
+ "$ref": "#/definitions/AzureResourceBase"
+ }
+ ]
+ },
+ "AzureResourceBase": {
+ "x-ms-azure-resource": true,
+ "type": "object",
+ "description": "Common properties for all Azure resources.",
+ "properties": {
+ "id": {
+ "readOnly": true,
+ "type": "string",
+ "description": "String Id used to locate any resource on Azure."
+ },
+ "name": {
+ "readOnly": true,
+ "type": "string",
+ "description": "Name of this resource."
+ },
+ "type": {
+ "readOnly": true,
+ "type": "string",
+ "description": "Type of this resource."
+ },
+ "systemData": {
+ "readOnly": true,
+ "type": "object",
+ "description": "Azure Resource Manager metadata containing createdBy and modifiedBy information.",
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/systemData"
+ }
+ }
+ },
+ "TemplateSpecVersion": {
+ "required": [
+ "properties",
+ "location"
+ ],
+ "type": "object",
+ "description": "Template Spec Version object.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/AzureResourceBase"
+ }
+ ],
+ "properties": {
+ "location": {
+ "type": "string",
+ "x-ms-mutability": [
+ "read",
+ "create"
+ ],
+ "description": "The location of the Template Spec Version. It must match the location of the parent Template Spec."
+ },
+ "properties": {
+ "description": "Template Spec Version properties.",
+ "x-ms-client-flatten": true,
+ "$ref": "#/definitions/TemplateSpecVersionProperties"
+ },
+ "tags": {
+ "type": "object",
+ "description": "Resource tags.",
+ "additionalProperties": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "TemplateSpecVersionProperties": {
+ "type": "object",
+ "description": "Template Spec Version properties.",
+ "properties": {
+ "artifacts": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/TemplateSpecArtifact"
+ },
+ "description": "An array of Template Spec artifacts."
+ },
+ "description": {
+ "type": "string",
+ "maxLength": 4096,
+ "description": "Template Spec version description."
+ },
+ "template": {
+ "type": "object",
+ "description": "The Azure Resource Manager template content."
+ },
+ "uiDefinition": {
+ "type": "object",
+ "description": "The Azure Resource Manager template UI definition content"
+ }
+ }
+ },
+ "TemplateSpecVersionsListResult": {
+ "description": "List of Template Specs versions",
+ "properties": {
+ "value": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/TemplateSpecVersion"
+ },
+ "description": "An array of Template Spec versions."
+ },
+ "nextLink": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The URL to use for getting the next set of results."
+ }
+ }
+ },
+ "TemplateSpecArtifact": {
+ "type": "object",
+ "discriminator": "kind",
+ "description": "Represents a Template Spec artifact.",
+ "properties": {
+ "path": {
+ "type": "string",
+ "description": "A filesystem safe relative path of the artifact."
+ },
+ "kind": {
+ "type": "string",
+ "description": "The kind of artifact.",
+ "enum": [
+ "template"
+ ],
+ "x-ms-enum": {
+ "name": "TemplateSpecArtifactKind",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "template",
+ "description": "The artifact represents an embedded Azure Resource Manager template."
+ }
+ ]
+ }
+ }
+ },
+ "required": [
+ "kind",
+ "path"
+ ]
+ },
+ "TemplateSpecTemplateArtifact": {
+ "type": "object",
+ "x-ms-discriminator-value": "template",
+ "description": "Represents a Template Spec artifact containing an embedded Azure Resource Manager template.",
+ "properties": {
+ "template": {
+ "type": "object",
+ "description": "The Azure Resource Manager template."
+ }
+ },
+ "required": [
+ "template"
+ ],
+ "allOf": [
+ {
+ "$ref": "#/definitions/TemplateSpecArtifact"
+ }
+ ]
+ },
+ "TemplateSpecsError": {
+ "properties": {
+ "error": {
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ErrorResponse"
+ }
+ },
+ "description": "Template Specs error response."
+ }
+ },
+ "parameters": {
+ "SubscriptionIdParameter": {
+ "name": "subscriptionId",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "x-ms-parameter-location": "client",
+ "description": "Subscription Id which forms part of the URI for every service call."
+ },
+ "ResourceGroupNameParameter": {
+ "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"
+ },
+ "TemplateSpecNameParameter": {
+ "name": "templateSpecName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "pattern": "^[-\\w\\._\\(\\)]+$",
+ "description": "Name of the Template Spec.",
+ "minLength": 1,
+ "maxLength": 90,
+ "x-ms-parameter-location": "method"
+ },
+ "TemplateSpecVersionParameter": {
+ "name": "templateSpecVersion",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "pattern": "^[-\\w\\._\\(\\)]+$",
+ "description": "The version of the Template Spec.",
+ "minLength": 1,
+ "maxLength": 90,
+ "x-ms-parameter-location": "method"
+ },
+ "ApiVersionParameter": {
+ "name": "api-version",
+ "in": "query",
+ "required": true,
+ "type": "string",
+ "x-ms-parameter-location": "client",
+ "description": "Client Api version."
+ }
+ }
+}
diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2020-06-01/resources.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2020-06-01/resources.json
index cb91fbec0f89..988e044bbe05 100644
--- a/specification/resources/resource-manager/Microsoft.Resources/stable/2020-06-01/resources.json
+++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2020-06-01/resources.json
@@ -2047,6 +2047,41 @@
}
}
},
+ "/providers/Microsoft.Management/managementGroups/{groupId}/providers/{resourceProviderNamespace}/register": {
+ "post": {
+ "tags": [
+ "Providers"
+ ],
+ "operationId": "Providers_RegisterAtManagementGroupScope",
+ "description": "Registers a management group with a resource provider.",
+ "parameters": [
+ {
+ "name": "resourceProviderNamespace",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The namespace of the resource provider to register."
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/GroupIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - Returns information about the resource provider."
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ }
+ }
+ },
"/subscriptions/{subscriptionId}/providers/{resourceProviderNamespace}/register": {
"post": {
"tags": [
diff --git a/specification/resources/resource-manager/readme.go.md b/specification/resources/resource-manager/readme.go.md
index a2ed83ef017e..5071a4316899 100644
--- a/specification/resources/resource-manager/readme.go.md
+++ b/specification/resources/resource-manager/readme.go.md
@@ -25,6 +25,7 @@ batch:
- tag: package-features-2015-12
- tag: package-locks-2016-09
- tag: package-locks-2015-01
+ - tag: package-policy-2020-03
- tag: package-policy-2019-09
- tag: package-policy-2019-06
- tag: package-policy-2019-01
@@ -108,6 +109,16 @@ namespace: policy
output-folder: $(go-sdk-folder)/services/resources/mgmt/2019-09-01/policy
```
+### Tag: package-policy-2020-03 and go
+
+These settings apply only when `--tag=package-policy-2020-03 --go` is specified on the command line.
+Please also specify `--go-sdk-folder=`.
+
+``` yaml $(tag) == 'package-policy-2020-03' && $(go)
+namespace: policy
+output-folder: $(go-sdk-folder)/services/preview/resources/mgmt/2020-03-01-preview/policy
+```
+
### Tag: package-policy-2019-06 and go
These settings apply only when `--tag=package-policy-2019-06 --go` is specified on the command line.
diff --git a/specification/resources/resource-manager/readme.md b/specification/resources/resource-manager/readme.md
index 4a866de90b49..7bbe66ddb62a 100644
--- a/specification/resources/resource-manager/readme.md
+++ b/specification/resources/resource-manager/readme.md
@@ -265,6 +265,15 @@ input-file:
- Microsoft.Resources/preview/2019-06-01-preview/templateSpecs.json
```
+### Tag: package-templatespecs-2020-10-preview
+
+These settings apply only when `--tag=package-templatespecs-2020-10-preview` is specified on the command line.
+
+``` yaml $(tag) == 'package-templatespecs-2020-10-preview'
+input-file:
+- Microsoft.Resources/preview/2020-10-01-preview/templateSpecs.json
+```
+
### Tag: package-policy-2016-12
These settings apply only when `--tag=package-policy-2016-12` is specified on the command line.
diff --git a/specification/resources/resource-manager/readme.python.md b/specification/resources/resource-manager/readme.python.md
index fc83b036dc42..3d6c205a40fb 100644
--- a/specification/resources/resource-manager/readme.python.md
+++ b/specification/resources/resource-manager/readme.python.md
@@ -60,6 +60,7 @@ batch:
- tag: package-deploymentscripts-2020-10
- tag: package-deploymentscripts-2019-10-preview
- tag: package-templatespecs-2019-06-preview
+ - tag: package-templatespecs-2020-10-preview
```
```yaml $(multiapi) && $(track2)
@@ -105,6 +106,7 @@ batch:
- tag: package-deploymentscripts-2019-10-preview
- multiapiscript-deploymentscripts: true
- tag: package-templatespecs-2019-06-preview
+ - tag: package-templatespecs-2020-10-preview
- multiapiscript-templatespecs: true
```
@@ -594,3 +596,16 @@ python:
namespace: azure.mgmt.resource.templatespecs.v2019_06_01_preview
output-folder: $(python-sdks-folder)/resources/azure-mgmt-resource/azure/mgmt/resource/templatespecs/v2019_06_01_preview
```
+
+### Tag: package-templatespecs-2020-10-preview and python
+
+These settings apply only when `--tag=package-templatespecs-2020-10-preview` is specified on the command line.
+Please also specify `--python-sdks-folder=`.
+
+``` yaml $(tag) == 'package-templatespecs-2020-10-preview'
+namespace: azure.mgmt.resource.templatespecs.v2020_10_01_preview
+output-folder: $(python-sdks-folder)/resources/azure-mgmt-resource/azure/mgmt/resource/templatespecs/v2020_10_01_preview
+python:
+ namespace: azure.mgmt.resource.templatespecs.v2020_10_01_preview
+ output-folder: $(python-sdks-folder)/resources/azure-mgmt-resource/azure/mgmt/resource/templatespecs/v2020_10_01_preview
+```
diff --git a/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchServiceCreateDataSource.json b/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchServiceCreateDataSource.json
index a0bc601ee5ea..c0d726305984 100644
--- a/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchServiceCreateDataSource.json
+++ b/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchServiceCreateDataSource.json
@@ -21,6 +21,15 @@
"@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": "myapplicationsecret"
+ }
}
}
},
@@ -45,6 +54,15 @@
"@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/2020-06-30-Preview/examples/SearchServiceCreateIndexer.json b/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchServiceCreateIndexer.json
index b1f9576ade36..291cef4b0e2f 100644
--- a/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchServiceCreateIndexer.json
+++ b/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchServiceCreateIndexer.json
@@ -14,6 +14,15 @@
"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": "myapplicationsecret"
+ }
}
}
},
@@ -33,7 +42,16 @@
"maxFailedItemsPerBatch": 5
},
"fieldMappings": [],
- "disabled": false
+ "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/2020-06-30-Preview/examples/SearchServiceCreateOrUpdateDataSource.json b/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchServiceCreateOrUpdateDataSource.json
index 7e2302b90da9..6f4b6c2a1187 100644
--- a/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchServiceCreateOrUpdateDataSource.json
+++ b/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchServiceCreateOrUpdateDataSource.json
@@ -23,6 +23,12 @@
"@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
}
}
},
@@ -47,6 +53,12 @@
"@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
}
}
},
@@ -70,6 +82,12 @@
"@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/2020-06-30-Preview/examples/SearchServiceCreateOrUpdateIndexer.json b/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchServiceCreateOrUpdateIndexer.json
index 4b83952c88db..5998c24569ac 100644
--- a/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchServiceCreateOrUpdateIndexer.json
+++ b/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchServiceCreateOrUpdateIndexer.json
@@ -16,6 +16,12 @@
"parameters": {
"maxFailedItems": 10,
"maxFailedItemsPerBatch": 5
+ },
+ "encryptionKey": {
+ "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
+ "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
+ "keyVaultUri": "https://myKeyVault.vault.azure.net",
+ "accessCredentials": null
}
}
},
@@ -35,7 +41,13 @@
"maxFailedItemsPerBatch": 5
},
"fieldMappings": [],
- "disabled": false
+ "disabled": false,
+ "encryptionKey": {
+ "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
+ "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
+ "keyVaultUri": "https://myKeyVault.vault.azure.net",
+ "accessCredentials": null
+ }
}
},
"201": {
@@ -53,7 +65,13 @@
"maxFailedItemsPerBatch": 5
},
"fieldMappings": [],
- "disabled": false
+ "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/2020-06-30-Preview/examples/SearchServiceCreateOrUpdateSkillset.json b/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchServiceCreateOrUpdateSkillset.json
index 8357e13c597c..15352647647d 100644
--- a/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchServiceCreateOrUpdateSkillset.json
+++ b/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchServiceCreateOrUpdateSkillset.json
@@ -109,7 +109,13 @@
],
"httpHeaders": {}
}
- ]
+ ],
+ "encryptionKey": {
+ "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
+ "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
+ "keyVaultUri": "https://myKeyVault.vault.azure.net",
+ "accessCredentials": null
+ }
}
},
"responses": {
@@ -236,7 +242,13 @@
],
"httpHeaders": {}
}
- ]
+ ],
+ "encryptionKey": {
+ "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
+ "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
+ "keyVaultUri": "https://myKeyVault.vault.azure.net",
+ "accessCredentials": null
+ }
}
},
"201": {
@@ -362,7 +374,13 @@
],
"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/2020-06-30-Preview/examples/SearchServiceCreateSkillset.json b/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchServiceCreateSkillset.json
index 5264ef96e53c..2380e1d3c9d0 100644
--- a/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchServiceCreateSkillset.json
+++ b/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchServiceCreateSkillset.json
@@ -109,7 +109,16 @@
],
"httpHeaders": {}
}
- ]
+ ],
+ "encryptionKey": {
+ "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
+ "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
+ "keyVaultUri": "https://myKeyVault.vault.azure.net",
+ "accessCredentials": {
+ "applicationId": "00000000-0000-0000-0000-000000000000",
+ "applicationSecret": "myapplicationsecret"
+ }
+ }
}
},
"responses": {
@@ -236,7 +245,16 @@
],
"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/2020-06-30-Preview/examples/SearchServiceGetDataSource.json b/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchServiceGetDataSource.json
index 4fd21c6cd58d..3fafafb07985 100644
--- a/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchServiceGetDataSource.json
+++ b/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchServiceGetDataSource.json
@@ -25,6 +25,15 @@
"@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/2020-06-30-Preview/examples/SearchServiceGetIndexer.json b/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchServiceGetIndexer.json
index 70d220b9442b..898a7db0e17d 100644
--- a/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchServiceGetIndexer.json
+++ b/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchServiceGetIndexer.json
@@ -20,7 +20,16 @@
"maxFailedItemsPerBatch": 5
},
"fieldMappings": [],
- "disabled": false
+ "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/2020-06-30-Preview/examples/SearchServiceGetSkillset.json b/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchServiceGetSkillset.json
index bd6392af7e5e..b83367e017e6 100644
--- a/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchServiceGetSkillset.json
+++ b/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchServiceGetSkillset.json
@@ -128,7 +128,16 @@
],
"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/2020-06-30-Preview/examples/SearchServiceListDataSources.json b/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchServiceListDataSources.json
index 3730022b8d14..87f3c9bdc657 100644
--- a/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchServiceListDataSources.json
+++ b/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchServiceListDataSources.json
@@ -27,6 +27,15 @@
"@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/2020-06-30-Preview/examples/SearchServiceListIndexers.json b/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchServiceListIndexers.json
index b3831b233a9a..72b8f9ccbef6 100644
--- a/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchServiceListIndexers.json
+++ b/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchServiceListIndexers.json
@@ -58,7 +58,16 @@
}
}
],
- "disabled": false
+ "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/2020-06-30-Preview/examples/SearchServiceListSkillsets.json b/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchServiceListSkillsets.json
index 01e212f5eac4..e10b715ef9d0 100644
--- a/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchServiceListSkillsets.json
+++ b/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchServiceListSkillsets.json
@@ -130,7 +130,16 @@
],
"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/2020-06-30-Preview/searchservice.json b/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/searchservice.json
index ff607b71c3b9..8ce6bde3f9a1 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
@@ -5711,6 +5711,14 @@
"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": [
@@ -5779,14 +5787,253 @@
"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": {
- "type": "object",
- "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."
+ "$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\"."
}
},
- "description": "Represents parameters for indexer execution."
+ "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": {
@@ -5900,6 +6147,14 @@
"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
}
},
"required": [
@@ -6844,6 +7099,14 @@
"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": [
diff --git a/specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchServiceCreateDataSource.json b/specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchServiceCreateDataSource.json
index 75a03fd6a8a2..6cf602cc81c2 100644
--- a/specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchServiceCreateDataSource.json
+++ b/specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchServiceCreateDataSource.json
@@ -21,6 +21,15 @@
"@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": "myapplicationsecret"
+ }
}
}
},
@@ -45,6 +54,15 @@
"@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/2020-06-30/examples/SearchServiceCreateIndexer.json b/specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchServiceCreateIndexer.json
index bc6890a484b7..dde141752872 100644
--- a/specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchServiceCreateIndexer.json
+++ b/specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchServiceCreateIndexer.json
@@ -4,7 +4,7 @@
"api-version": "2020-06-30",
"indexer": {
"name": "myindexer",
- "description": "a cool indexer",
+ "description": "an indexer",
"dataSourceName": "mydatasource",
"targetIndexName": "orders",
"schedule": {
@@ -14,6 +14,15 @@
"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": "myapplicationsecret"
+ }
}
}
},
@@ -21,7 +30,7 @@
"201": {
"body": {
"name": "myindexer",
- "description": "a cool indexer",
+ "description": "an indexer",
"dataSourceName": "mydatasource",
"targetIndexName": "orders",
"schedule": {
@@ -33,7 +42,16 @@
"maxFailedItemsPerBatch": 5
},
"fieldMappings": [],
- "disabled": false
+ "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/2020-06-30/examples/SearchServiceCreateOrUpdateDataSource.json b/specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchServiceCreateOrUpdateDataSource.json
index cdb3ff9e4ff1..2fdaf34dd629 100644
--- a/specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchServiceCreateOrUpdateDataSource.json
+++ b/specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchServiceCreateOrUpdateDataSource.json
@@ -23,6 +23,12 @@
"@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
}
}
},
@@ -47,6 +53,12 @@
"@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
}
}
},
@@ -70,6 +82,12 @@
"@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/2020-06-30/examples/SearchServiceCreateOrUpdateIndexer.json b/specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchServiceCreateOrUpdateIndexer.json
index b880163531f0..1edaeb8d1e3c 100644
--- a/specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchServiceCreateOrUpdateIndexer.json
+++ b/specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchServiceCreateOrUpdateIndexer.json
@@ -16,6 +16,12 @@
"parameters": {
"maxFailedItems": 10,
"maxFailedItemsPerBatch": 5
+ },
+ "encryptionKey": {
+ "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
+ "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
+ "keyVaultUri": "https://myKeyVault.vault.azure.net",
+ "accessCredentials": null
}
}
},
@@ -35,7 +41,13 @@
"maxFailedItemsPerBatch": 5
},
"fieldMappings": [],
- "disabled": false
+ "disabled": false,
+ "encryptionKey": {
+ "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
+ "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
+ "keyVaultUri": "https://myKeyVault.vault.azure.net",
+ "accessCredentials": null
+ }
}
},
"201": {
@@ -53,7 +65,13 @@
"maxFailedItemsPerBatch": 5
},
"fieldMappings": [],
- "disabled": false
+ "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/2020-06-30/examples/SearchServiceCreateOrUpdateSkillset.json b/specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchServiceCreateOrUpdateSkillset.json
index 6878a7d28b76..3df98f280f43 100644
--- a/specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchServiceCreateOrUpdateSkillset.json
+++ b/specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchServiceCreateOrUpdateSkillset.json
@@ -109,7 +109,13 @@
],
"httpHeaders": {}
}
- ]
+ ],
+ "encryptionKey": {
+ "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
+ "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
+ "keyVaultUri": "https://myKeyVault.vault.azure.net",
+ "accessCredentials": null
+ }
}
},
"responses": {
@@ -236,7 +242,13 @@
],
"httpHeaders": {}
}
- ]
+ ],
+ "encryptionKey": {
+ "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
+ "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
+ "keyVaultUri": "https://myKeyVault.vault.azure.net",
+ "accessCredentials": null
+ }
}
},
"201": {
@@ -362,7 +374,13 @@
],
"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/2020-06-30/examples/SearchServiceCreateSkillset.json b/specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchServiceCreateSkillset.json
index e94fdced936e..0508a00df3f7 100644
--- a/specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchServiceCreateSkillset.json
+++ b/specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchServiceCreateSkillset.json
@@ -109,7 +109,16 @@
],
"httpHeaders": {}
}
- ]
+ ],
+ "encryptionKey": {
+ "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
+ "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
+ "keyVaultUri": "https://myKeyVault.vault.azure.net",
+ "accessCredentials": {
+ "applicationId": "00000000-0000-0000-0000-000000000000",
+ "applicationSecret": "myapplicationsecret"
+ }
+ }
}
},
"responses": {
@@ -236,7 +245,16 @@
],
"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/2020-06-30/examples/SearchServiceGetDataSource.json b/specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchServiceGetDataSource.json
index 73b5e16e2c41..74d91858b762 100644
--- a/specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchServiceGetDataSource.json
+++ b/specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchServiceGetDataSource.json
@@ -25,6 +25,15 @@
"@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/2020-06-30/examples/SearchServiceGetIndexer.json b/specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchServiceGetIndexer.json
index 687f23d7fb70..1f74129f1d48 100644
--- a/specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchServiceGetIndexer.json
+++ b/specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchServiceGetIndexer.json
@@ -20,7 +20,16 @@
"maxFailedItemsPerBatch": 5
},
"fieldMappings": [],
- "disabled": false
+ "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/2020-06-30/examples/SearchServiceGetSkillset.json b/specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchServiceGetSkillset.json
index f09a426ffbc4..4747247dcb24 100644
--- a/specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchServiceGetSkillset.json
+++ b/specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchServiceGetSkillset.json
@@ -128,7 +128,16 @@
],
"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/2020-06-30/examples/SearchServiceListDataSources.json b/specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchServiceListDataSources.json
index 51e07eeb9750..2f9638ef6f29 100644
--- a/specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchServiceListDataSources.json
+++ b/specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchServiceListDataSources.json
@@ -27,6 +27,15 @@
"@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/2020-06-30/examples/SearchServiceListIndexers.json b/specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchServiceListIndexers.json
index 6ceef86d3a41..08c000587dd4 100644
--- a/specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchServiceListIndexers.json
+++ b/specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchServiceListIndexers.json
@@ -58,7 +58,16 @@
}
}
],
- "disabled": false
+ "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/2020-06-30/examples/SearchServiceListSkillsets.json b/specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchServiceListSkillsets.json
index f9050db649bb..e90e798bd04a 100644
--- a/specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchServiceListSkillsets.json
+++ b/specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchServiceListSkillsets.json
@@ -130,7 +130,16 @@
],
"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/2020-06-30/searchservice.json b/specification/search/data-plane/Azure.Search/preview/2020-06-30/searchservice.json
index 57a5eedf1b93..54fe4d8b460b 100644
--- a/specification/search/data-plane/Azure.Search/preview/2020-06-30/searchservice.json
+++ b/specification/search/data-plane/Azure.Search/preview/2020-06-30/searchservice.json
@@ -5711,6 +5711,14 @@
"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": [
@@ -5779,14 +5787,253 @@
"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": {
- "type": "object",
- "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."
+ "$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\"."
}
},
- "description": "Represents parameters for indexer execution."
+ "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": {
@@ -5900,6 +6147,14 @@
"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
}
},
"required": [
@@ -6844,6 +7099,14 @@
"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": [
diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2020-01-01-preview/examples/secureScores/GetSecureScoresSingle_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2020-01-01-preview/examples/secureScores/GetSecureScoresSingle_example.json
index f2ea30f42b44..aa31327972d9 100644
--- a/specification/security/resource-manager/Microsoft.Security/preview/2020-01-01-preview/examples/secureScores/GetSecureScoresSingle_example.json
+++ b/specification/security/resource-manager/Microsoft.Security/preview/2020-01-01-preview/examples/secureScores/GetSecureScoresSingle_example.json
@@ -13,10 +13,11 @@
"properties": {
"displayName": "ASC score",
"score": {
- "max": 13,
- "current": 3
+ "max": 39,
+ "current": 23.53,
+ "percentage": 0.6033
},
- "weight": 15
+ "weight": 67
}
}
}
diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2020-01-01-preview/examples/secureScores/ListSecureScoreControlsForNameWithExpand_builtin_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2020-01-01-preview/examples/secureScores/ListSecureScoreControlsForNameWithExpand_builtin_example.json
index 99b0d5df2e2e..01f76f8ad702 100644
--- a/specification/security/resource-manager/Microsoft.Security/preview/2020-01-01-preview/examples/secureScores/ListSecureScoreControlsForNameWithExpand_builtin_example.json
+++ b/specification/security/resource-manager/Microsoft.Security/preview/2020-01-01-preview/examples/secureScores/ListSecureScoreControlsForNameWithExpand_builtin_example.json
@@ -7,123 +7,1101 @@
},
"responses": {
"200": {
- "parameters": {
- "secureScoreName": "ascScore"
- },
"body": {
"value": [
{
- "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/SecureScoreControls/a9909064-42b4-4d34-8143-275477afe18b",
+ "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/secureScores/ascScore/secureScoreControls/a9909064-42b4-4d34-8143-275477afe18b",
"name": "a9909064-42b4-4d34-8143-275477afe18b",
- "type": "Microsoft.Security/secureScoreControls",
+ "type": "Microsoft.Security/secureScores/secureScoreControls",
"properties": {
"displayName": "Protect applications against DDoS attacks",
"healthyResourceCount": 0,
"unhealthyResourceCount": 0,
- "notApplicableResourceCount": 10,
+ "notApplicableResourceCount": 1,
"score": {
"max": 0,
- "current": 0
+ "current": 0,
+ "percentage": 0
},
"definition": {
- "id": "/providers/Microsoft.Security/SecureScoreControlDefinitions/a9909064-42b4-4d34-8143-275477afe18b",
+ "id": "/providers/Microsoft.Security/secureScoreControlDefinitions/a9909064-42b4-4d34-8143-275477afe18b",
"name": "a9909064-42b4-4d34-8143-275477afe18b",
- "type": "Microsoft.Security/SecureScoreControlDefinitions",
+ "type": "Microsoft.Security/secureScoreControlDefinitions",
"properties": {
"source": {
"sourceType": "BuiltIn"
},
"displayName": "Protect applications against DDoS attacks",
- "description": "This control contains recommendations regarding DDoS attack prevention",
"maxScore": 2,
"assessmentDefinitions": [
{
"id": "/providers/Microsoft.Security/assessmentMetadata/e3de1cc0-f4dd-3b34-e496-8b5381ba2d70"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/08e628db-e2ed-4793-bc91-d13e684401c3"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/405c9ae6-49f9-46c4-8873-a86690f27818"
}
]
}
- }
+ },
+ "weight": 0
}
},
{
- "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/SecureScoreControls/34a42fb3-e6db-409c-b56b-7b1db6b8aee0",
+ "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/secureScores/ascScore/secureScoreControls/34a42fb3-e6db-409c-b56b-7b1db6b8aee0",
"name": "34a42fb3-e6db-409c-b56b-7b1db6b8aee0",
- "type": "Microsoft.Security/SecureScoreControls",
+ "type": "Microsoft.Security/secureScores/secureScoreControls",
"properties": {
"displayName": "Enable MFA",
- "healthyResourceCount": 0,
- "unhealthyResourceCount": 1,
+ "healthyResourceCount": 1,
+ "unhealthyResourceCount": 0,
"notApplicableResourceCount": 0,
"score": {
"max": 10,
- "current": 0
+ "current": 10,
+ "percentage": 1
},
"definition": {
- "id": "/providers/Microsoft.Security/SecureScoreControlDefinitions/34a42fb3-e6db-409c-b56b-7b1db6b8aee0",
+ "id": "/providers/Microsoft.Security/secureScoreControlDefinitions/34a42fb3-e6db-409c-b56b-7b1db6b8aee0",
"name": "34a42fb3-e6db-409c-b56b-7b1db6b8aee0",
- "type": "Microsoft.Security/SecureScoreControlDefinitions",
+ "type": "Microsoft.Security/secureScoreControlDefinitions",
"properties": {
"source": {
"sourceType": "BuiltIn"
},
"displayName": "Enable MFA",
- "description": "This control contains recommendations regarding MFA",
"maxScore": 10,
"assessmentDefinitions": [
{
- "id": "/providers/Microsoft.Security/assessmentMetadata/151e82c5-5341-a74b-1eb0-bc38d2c84bb5"
+ "id": "/providers/Microsoft.Security/assessmentMetadata/94290b00-4d0c-d7b4-7cea-064a9554e681"
},
{
"id": "/providers/Microsoft.Security/assessmentMetadata/57e98606-6b1e-6193-0e3d-fe621387c16b"
},
{
- "id": "/providers/Microsoft.Security/assessmentMetadata/94290b00-4d0c-d7b4-7cea-064a9554e681"
+ "id": "/providers/Microsoft.Security/assessmentMetadata/1f24d55a-df0f-4772-9090-4629c2d6bfff"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/8e3d9ac0-a248-4276-a437-304c6cd1443b"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/8d7a6128-c8f2-43df-b422-7877346f9ddb"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/dbfc99e3-e648-4c3b-bd32-995e6268430d"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/4a946e22-47e8-443d-8761-b25620b4a1e1"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/a7c8fa46-526d-4bf6-b8b3-17fa01310fd8"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/20f6c761-4dd7-4f27-9e37-6db8471486ef"
}
]
}
- }
+ },
+ "weight": 1
}
},
{
- "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/SecureScoreControls/a000c66f-6da2-4f9d-826d-2364347d2588",
- "name": "a000c66f-6da2-4f9d-826d-2364347d2588",
- "type": "Microsoft.Security/SecureScoreControls",
+ "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/secureScores/ascScore/secureScoreControls/76763537-9feb-42d3-b4f4-78c01117be80",
+ "name": "76763537-9feb-42d3-b4f4-78c01117be80",
+ "type": "Microsoft.Security/secureScores/secureScoreControls",
"properties": {
- "displayName": "Apply adaptive application control",
- "healthyResourceCount": 20,
+ "displayName": "Implement security best practices",
+ "healthyResourceCount": 7,
"unhealthyResourceCount": 0,
- "notApplicableResourceCount": 10,
+ "notApplicableResourceCount": 1,
"score": {
- "max": 3,
- "current": 3
+ "max": 0,
+ "current": 0,
+ "percentage": 0
},
"definition": {
- "id": "/providers/Microsoft.Security/SecureScoreControlDefinitions/a000c66f-6da2-4f9d-826d-2364347d2588",
- "name": "a000c66f-6da2-4f9d-826d-2364347d2588",
- "type": "Microsoft.Security/SecureScoreControlDefinitions",
+ "id": "/providers/Microsoft.Security/secureScoreControlDefinitions/76763537-9feb-42d3-b4f4-78c01117be80",
+ "name": "76763537-9feb-42d3-b4f4-78c01117be80",
+ "type": "Microsoft.Security/secureScoreControlDefinitions",
"properties": {
"source": {
"sourceType": "BuiltIn"
},
- "displayName": "Apply adaptive application control",
- "description": "This control contains recommendations regarding enabling adaptive application control",
- "maxScore": 3,
+ "displayName": "Implement security best practices",
+ "maxScore": 0,
"assessmentDefinitions": [
{
- "id": "/providers/Microsoft.Security/assessmentMetadata/35f45c95-27cf-4e52-891f-8390d1de5828"
+ "id": "/providers/Microsoft.Security/assessmentMetadata/151e82c5-5341-a74b-1eb0-bc38d2c84bb5"
},
{
- "id": "/providers/Microsoft.Security/assessmentMetadata/d1db3318-01ff-16de-29eb-28b344515626"
+ "id": "/providers/Microsoft.Security/assessmentMetadata/a8c6a4ad-d51e-88fe-2979-d3ee3c864f8b"
},
{
- "id": "/providers/Microsoft.Security/assessmentMetadata/e7ee30c4-bac9-2966-54bd-2023a4282872"
+ "id": "/providers/Microsoft.Security/assessmentMetadata/6f90a6d6-d4d6-0794-0ec1-98fa77878c2e"
},
{
- "id": "/providers/Microsoft.Security/assessmentMetadata/8e2b96ff-3de2-289b-b5c1-3b9921a3441e"
+ "id": "/providers/Microsoft.Security/assessmentMetadata/a9341235-9389-42f0-a0bf-9bfb57960d44"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/45d313c3-3fca-5040-035f-d61928366d31"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/f0553104-cfdb-65e6-759c-002812e38500"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/47bb383c-8e25-95f0-c2aa-437add1d87d3"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/12018f4f-3d10-999b-e4c4-86ec25be08a1"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/eade5b56-eefd-444f-95c8-23f29e5d93cb"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/ebe970fe-9c27-4dd7-a165-1e943d565e10"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/f7010359-8d21-4598-a9f2-c3e81a17141e"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/24d8af06-d441-40b4-a49c-311421aa9f58"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/8c3e93d3-0276-4d06-b20a-9a9f3012742c"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/9172da4e-9571-6e33-2b5b-d742847f3be7"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/093c685b-56dd-13a3-8ed5-887a001837a2"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/64b8637e-4e1d-76a9-0fc9-c1e487a97ed8"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/fe02b3b7-a722-d4d6-6731-6493776203a6"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/57f36d21-69e3-4b0f-a66c-18629d1b736d"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/6c99f570-2ce7-46bc-8175-cde013df43bc"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/22489c48-27d1-4e40-9420-4303ad9cffef"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/fc84abc0-eee6-4758-8372-a7681965ca44"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/726cde3e-02f8-4041-8935-727f2be19ba7"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/a2bb3a1b-4a09-4cf7-9e79-c438687e2c2f"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/664c6a0b-5cd2-4140-aaff-a94241c07afd"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/3af5de46-fda8-4b6e-90f1-6565187d7c48"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/a9a59ebb-5d6f-42f5-92a1-036fd0fd1879"
+ }
+ ]
+ }
+ },
+ "weight": 7
+ }
+ },
+ {
+ "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/secureScores/ascScore/secureScoreControls/4db8d6cf-075b-4149-a813-da09ca2ae120",
+ "name": "4db8d6cf-075b-4149-a813-da09ca2ae120",
+ "type": "Microsoft.Security/secureScores/secureScoreControls",
+ "properties": {
+ "displayName": "Enable Advanced Threat Protection",
+ "healthyResourceCount": 0,
+ "unhealthyResourceCount": 1,
+ "notApplicableResourceCount": 0,
+ "score": {
+ "max": 0,
+ "current": 0,
+ "percentage": 0
+ },
+ "definition": {
+ "id": "/providers/Microsoft.Security/secureScoreControlDefinitions/4db8d6cf-075b-4149-a813-da09ca2ae120",
+ "name": "4db8d6cf-075b-4149-a813-da09ca2ae120",
+ "type": "Microsoft.Security/secureScoreControlDefinitions",
+ "properties": {
+ "source": {
+ "sourceType": "BuiltIn"
+ },
+ "displayName": "Enable Advanced Threat Protection",
+ "maxScore": 0,
+ "assessmentDefinitions": [
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/56a6e81f-7413-4f72-9a1b-aaeeaa87c872"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/0876ef51-fee7-449d-ba1e-f2662c7e43c6"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/58d72d9d-0310-4792-9a3b-6dd111093cdb"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/6ac66a74-761f-4a59-928a-d373eea3f028"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/1be22853-8ed1-4005-9907-ddad64cb1417"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/86ea1a79-29d3-4eac-a9f4-3541ace4e718"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/53572822-d3fc-4363-bfb9-248645841612"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/b1af52e4-e968-4e2b-b6d0-6736c9651f0a"
+ }
+ ]
+ }
+ },
+ "weight": 1
+ }
+ },
+ {
+ "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/secureScores/ascScore/secureScoreControls/27b24961-75ba-4fe4-8909-97286d5dd5ee",
+ "name": "27b24961-75ba-4fe4-8909-97286d5dd5ee",
+ "type": "Microsoft.Security/secureScores/secureScoreControls",
+ "properties": {
+ "displayName": "Enable auditing and logging",
+ "healthyResourceCount": 1,
+ "unhealthyResourceCount": 4,
+ "notApplicableResourceCount": 0,
+ "score": {
+ "max": 1,
+ "current": 0.2,
+ "percentage": 0.2
+ },
+ "definition": {
+ "id": "/providers/Microsoft.Security/secureScoreControlDefinitions/27b24961-75ba-4fe4-8909-97286d5dd5ee",
+ "name": "27b24961-75ba-4fe4-8909-97286d5dd5ee",
+ "type": "Microsoft.Security/secureScoreControlDefinitions",
+ "properties": {
+ "source": {
+ "sourceType": "BuiltIn"
+ },
+ "displayName": "Enable auditing and logging",
+ "maxScore": 1,
+ "assessmentDefinitions": [
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/94208a8b-16e8-4e5b-abbd-4e81c9d02bee"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/c6dad669-efd7-cd72-61c5-289935607791"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/77785808-ce86-4e40-b45f-19110a547397"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/32771b45-220c-1a8b-584e-fdd5a2584a66"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/f11b27f2-8c49-5bb4-eff5-e1e5384bf95e"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/f19ab7d9-5ff2-f8fd-ab3b-0bf95dcb6889"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/ad5bbaeb-7632-5edf-f1c2-752075831ce8"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/dea5192e-1bb3-101b-b70c-4646546f5e1e"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/1597605a-0faf-5860-eb74-462ae2e9fc21"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/91387f44-7e43-4ecc-55f0-46f5adee3dd5"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/961eb649-3ea9-f8c2-6595-88e9a3aeedeb"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/88bbc99c-e5af-ddd7-6105-6150b2bfa519"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/22438e3c-73c8-40af-a083-10c980c63aa2"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/5720f1a6-6061-4768-9c0d-2000a6041744"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/dbfc99e3-e648-4c3b-bd32-995e6268430d"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/30c69b23-a9a2-4729-aca6-f21adacfff66"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/a9ac48d8-8dd7-42b9-9752-b1fa70ea5dd9"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/00261067-76a8-4ebb-b5fc-becc81067bee"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/83ca4867-58c1-45d6-b6b6-dbf226512891"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/a269cbdb-86e8-431c-9ff2-f0ea491174d8"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/5ea59e47-093b-446f-9765-5b0ec4c9da61"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/011397ca-1366-4bcc-b85a-7a5e3df2e80b"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/c62371bc-f6a7-4915-b5b5-14288682cf79"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/293ba336-7312-42fc-a59d-836e4e678b17"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/0b547a38-2c0d-47e1-b9a2-a59fccc140db"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/7d0ad86f-f43b-4889-b2f7-09d91bd1407b"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/b20558b6-de31-480c-8aa0-e920d62b9764"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/022efc2d-5119-480b-a203-e151b6b2645c"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/3ee7608e-f0e7-4c26-8921-5ae46c4e99df"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/33765629-073d-49eb-bab4-64bdf8ac90da"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/9c054f50-823f-45ab-839e-9df4eb7c2f11"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/f61e15f3-4bcf-4d2e-8f06-32237cabe0a0"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/cdb3af55-2abf-476b-aac7-5cfec366a4dd"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/bc26b0d4-a1d7-4665-9d44-efc205ae73f0"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/3812e247-34f2-4f06-a312-89a8fe51fa37"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/f0f8405a-5ecc-4314-808e-083e030d6163"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/c23e0eec-eee4-4632-b1c2-6c884c3c963b"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/7ce5a01f-e94b-438a-8b72-fa02c076f11a"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/46e4e0ed-106d-405e-b1a9-ca34c8f7d31f"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/b1294b0d-9b2e-4e1b-9f67-77a75fb10a65"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/0b86a67f-bde5-4c91-b10c-4102033b8692"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/3d55e4b1-ecdb-4eaf-9e3f-b00a764182bd"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/a7c8fa46-526d-4bf6-b8b3-17fa01310fd8"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/20f6c761-4dd7-4f27-9e37-6db8471486ef"
}
]
}
- }
+ },
+ "weight": 5
+ }
+ },
+ {
+ "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/secureScores/ascScore/secureScoreControls/2d85f639-0bea-4a4a-b6c6-608952a1414a",
+ "name": "2d85f639-0bea-4a4a-b6c6-608952a1414a",
+ "type": "Microsoft.Security/secureScores/secureScoreControls",
+ "properties": {
+ "displayName": "Manage access and permissions",
+ "healthyResourceCount": 1,
+ "unhealthyResourceCount": 1,
+ "notApplicableResourceCount": 0,
+ "score": {
+ "max": 4,
+ "current": 2,
+ "percentage": 0.5
+ },
+ "definition": {
+ "id": "/providers/Microsoft.Security/secureScoreControlDefinitions/2d85f639-0bea-4a4a-b6c6-608952a1414a",
+ "name": "2d85f639-0bea-4a4a-b6c6-608952a1414a",
+ "type": "Microsoft.Security/secureScoreControlDefinitions",
+ "properties": {
+ "source": {
+ "sourceType": "BuiltIn"
+ },
+ "displayName": "Manage access and permissions",
+ "maxScore": 4,
+ "assessmentDefinitions": [
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/c3b6ae71-f1f0-31b4-e6c1-d5951285d03d"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/04e7147b-0deb-9796-2e5c-0336343ceb3d"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/e52064aa-6853-e252-a11e-dffc675689c2"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/00c6d40b-e990-6acf-d4f3-471e747a27c4"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/2c79b4af-f830-b61e-92b9-63dfa30f16e4"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/b0fdc63a-38e7-4bab-a7c4-2c2665abbaa9"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/03afeb6f-7634-adb3-0a01-803b0b9cb611"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/9d07b7e6-2986-4964-a76c-b2689604e212"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/08e628db-e2ed-4793-bc91-d13e684401c3"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/5d90913f-a1c5-4429-ad54-2c6c17fb3c73"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/582c14e9-48c1-4b25-ab93-91bdeaf9120c"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/8a10942a-02ca-483f-81ae-2260ea7808cc"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/9b8eac17-6b11-4b94-9bb4-18c81aee7123"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/554ba13c-d7d4-4530-88ce-94cf11a670ce"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/66a1d478-4d24-42d4-8eca-dcdab6532a18"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/b396f112-a462-4813-a93f-80bc90041e4d"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/5425052d-cc0d-4424-af71-050311f99634"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/09cb7d54-db05-4d31-97f3-9bbfe1dff610"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/01fb1ad4-303b-4789-abf2-c024c4a76523"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/0de072b9-6515-4985-842e-0318047bb85b"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/8c3f474a-234e-442f-92b3-2a45e37f7eee"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/c55461af-4923-4fbb-b270-40d5e5f4c0ff"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/bbdc4999-1462-4d46-853b-2f8c6ca1c682"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/9e1f12d0-cb3d-4e1c-a468-6bc3d934c99d"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/fd5d38f6-340e-4bd2-88f2-e1314c3c07a9"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/0384d5b7-5def-4130-b7b5-db7da7e63276"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/dbfc99e3-e648-4c3b-bd32-995e6268430d"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/0ad39832-f031-4fdd-885e-c6cce85ac77c"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/90191798-da1b-40dd-aa9c-1c0eafb1ba87"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/ddced3c8-a5e2-4dc4-b0fe-1331c77fc9c4"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/52f83ea2-6871-45c3-8b26-13566e966638"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/79b4eb34-c06e-49bf-883d-5352a21a962f"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/5723400d-5b2a-45f1-99ee-837986866318"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/76e8881d-f18e-4e1b-b01d-376d0260e066"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/0eaf40a8-5673-4b33-8457-a31d85882233"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/5a235918-41a2-4bd0-8ab0-00a596e9d6a8"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/3ff38dcd-92e2-4b67-8765-35bb0174a4c7"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/1ff4501b-2109-4ef6-ba9d-e824a96d63d0"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/f493084a-d3c4-4886-8cf2-3c815aeef901"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/a7c8fa46-526d-4bf6-b8b3-17fa01310fd8"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/20f6c761-4dd7-4f27-9e37-6db8471486ef"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/11c95609-3553-430d-b788-fd41cde8b2db"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/27d6f0e9-b4d5-468b-ae7e-03d5473fd864"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/f0debc84-981c-4a0d-924d-aa4bd7d55fef"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/9b795646-9130-41a4-90b7-df9eae2437c8"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/802c0637-5a8c-4c98-abd7-7c96d89d6010"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/43dc2a2e-ce69-4d42-923e-ab7d136f2cfe"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/2acd365d-e8b5-4094-bce4-244b7c51d67c"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/51fd8bb1-0db4-bbf1-7e2b-cfcba7eb66a6"
+ }
+ ]
+ }
+ },
+ "weight": 2
+ }
+ },
+ {
+ "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/secureScores/ascScore/secureScoreControls/99fc8df2-e0f5-40f8-9415-a7f7ca948b5a",
+ "name": "99fc8df2-e0f5-40f8-9415-a7f7ca948b5a",
+ "type": "Microsoft.Security/secureScores/secureScoreControls",
+ "properties": {
+ "displayName": "Remediate security configurations",
+ "healthyResourceCount": 0,
+ "unhealthyResourceCount": 1,
+ "notApplicableResourceCount": 0,
+ "score": {
+ "max": 4,
+ "current": 0,
+ "percentage": 0
+ },
+ "definition": {
+ "id": "/providers/Microsoft.Security/secureScoreControlDefinitions/99fc8df2-e0f5-40f8-9415-a7f7ca948b5a",
+ "name": "99fc8df2-e0f5-40f8-9415-a7f7ca948b5a",
+ "type": "Microsoft.Security/secureScoreControlDefinitions",
+ "properties": {
+ "source": {
+ "sourceType": "BuiltIn"
+ },
+ "displayName": "Remediate security configurations",
+ "maxScore": 4,
+ "assessmentDefinitions": [
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/d1db3318-01ff-16de-29eb-28b344515626"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/e7ee30c4-bac9-2966-54bd-2023a4282872"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/27ac71b1-75c5-41c2-adc2-858f5db45b08"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/720a3e77-0b9a-4fa9-98b6-ddf0fd7e32c1"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/8e2b96ff-3de2-289b-b5c1-3b9921a3441e"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/181ac480-f7c4-544b-9865-11b8ffe87f47"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/8c3d9ad0-3639-4686-9cd2-2b2ab2609bda"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/0677209d-e675-2c6f-e91a-54cef2878663"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/a3eee263-aa01-4b52-a7c0-0094578ef48f"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/45cfe080-ceb1-a91e-9743-71551ed24e94"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/8941d121-f740-35f6-952c-6561d2b38d36"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/0396b18c-41aa-489c-affd-4ee5d1714a59"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/fa924a53-0837-4296-9bf7-18ce7dd68593"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/9e1789cd-7b61-42db-ba12-7268283ba466"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/233da9cd-11bf-463a-8aa7-4c81b9e788d1"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/c4131c22-1ecc-4beb-9961-d90108bd975f"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/d74d2738-2485-4103-9919-69c7e63776ec"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/5f65e47f-7a00-4bf3-acae-90ee441ee876"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/bc85a7ee-7f43-47ab-8736-4faaec9346b5"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/08e628db-e2ed-4793-bc91-d13e684401c3"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/86f91051-9d6a-47c3-a07f-bd14cb214b45"
+ }
+ ]
+ }
+ },
+ "weight": 1
+ }
+ },
+ {
+ "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/secureScores/ascScore/secureScoreControls/12136bd9-dc24-44f2-9587-7be3af6aac14",
+ "name": "12136bd9-dc24-44f2-9587-7be3af6aac14",
+ "type": "Microsoft.Security/secureScores/secureScoreControls",
+ "properties": {
+ "displayName": "Enable endpoint protection",
+ "healthyResourceCount": 0,
+ "unhealthyResourceCount": 1,
+ "notApplicableResourceCount": 0,
+ "score": {
+ "max": 2,
+ "current": 0,
+ "percentage": 0
+ },
+ "definition": {
+ "id": "/providers/Microsoft.Security/secureScoreControlDefinitions/12136bd9-dc24-44f2-9587-7be3af6aac14",
+ "name": "12136bd9-dc24-44f2-9587-7be3af6aac14",
+ "type": "Microsoft.Security/secureScoreControlDefinitions",
+ "properties": {
+ "source": {
+ "sourceType": "BuiltIn"
+ },
+ "displayName": "Enable endpoint protection",
+ "maxScore": 2,
+ "assessmentDefinitions": [
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/d1db3318-01ff-16de-29eb-28b344515626"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/e7ee30c4-bac9-2966-54bd-2023a4282872"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/27ac71b1-75c5-41c2-adc2-858f5db45b08"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/720a3e77-0b9a-4fa9-98b6-ddf0fd7e32c1"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/8e2b96ff-3de2-289b-b5c1-3b9921a3441e"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/83f577bd-a1b6-b7e1-0891-12ca19d1e6df"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/4fb67663-9ab9-475d-b026-8c544cced439"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/383cf3bc-fdf9-4a02-120a-3e7e36c6bfee"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/3bcd234d-c9c7-c2a2-89e0-c01f419c1a8a"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/37a3689a-818e-4a0e-82ac-b1392b9bb000"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/45cfe080-ceb1-a91e-9743-71551ed24e94"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/21300918-b2e3-0346-785f-c77ff57d243b"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/e71020c2-860c-3235-cd39-04f3f8c936d2"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/bc85a7ee-7f43-47ab-8736-4faaec9346b5"
+ }
+ ]
+ }
+ },
+ "weight": 1
+ }
+ },
+ {
+ "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/secureScores/ascScore/secureScoreControls/61702b76-1fab-41f2-bcbc-50b7870dcf38",
+ "name": "61702b76-1fab-41f2-bcbc-50b7870dcf38",
+ "type": "Microsoft.Security/secureScores/secureScoreControls",
+ "properties": {
+ "displayName": "Apply system updates",
+ "healthyResourceCount": 0,
+ "unhealthyResourceCount": 1,
+ "notApplicableResourceCount": 0,
+ "score": {
+ "max": 6,
+ "current": 0,
+ "percentage": 0
+ },
+ "definition": {
+ "id": "/providers/Microsoft.Security/secureScoreControlDefinitions/61702b76-1fab-41f2-bcbc-50b7870dcf38",
+ "name": "61702b76-1fab-41f2-bcbc-50b7870dcf38",
+ "type": "Microsoft.Security/secureScoreControlDefinitions",
+ "properties": {
+ "source": {
+ "sourceType": "BuiltIn"
+ },
+ "displayName": "Apply system updates",
+ "maxScore": 6,
+ "assessmentDefinitions": [
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/d1db3318-01ff-16de-29eb-28b344515626"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/e7ee30c4-bac9-2966-54bd-2023a4282872"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/27ac71b1-75c5-41c2-adc2-858f5db45b08"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/720a3e77-0b9a-4fa9-98b6-ddf0fd7e32c1"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/8e2b96ff-3de2-289b-b5c1-3b9921a3441e"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/4ab6e3c5-74dd-8b35-9ab9-f61b30875b27"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/f2805ebc-abc2-4aac-a8d6-35664c479971"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/c0f5316d-5ac5-9218-b77a-b96e16ccfd66"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/45cfe080-ceb1-a91e-9743-71551ed24e94"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/bd20bd91-aaf1-7f14-b6e4-866de2f43146"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/8bc390da-9eb6-938d-25ed-44a35d9bcc9d"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/22e18b64-4576-41e6-8972-0eb28c9af0c8"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/bc85a7ee-7f43-47ab-8736-4faaec9346b5"
+ }
+ ]
+ }
+ },
+ "weight": 1
+ }
+ },
+ {
+ "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/secureScores/ascScore/secureScoreControls/0e55495e-034f-4abc-8293-767229250176",
+ "name": "0e55495e-034f-4abc-8293-767229250176",
+ "type": "Microsoft.Security/secureScores/secureScoreControls",
+ "properties": {
+ "displayName": "Encrypt data in transit",
+ "healthyResourceCount": 5,
+ "unhealthyResourceCount": 1,
+ "notApplicableResourceCount": 0,
+ "score": {
+ "max": 4,
+ "current": 3.33,
+ "percentage": 0.8325
+ },
+ "definition": {
+ "id": "/providers/Microsoft.Security/secureScoreControlDefinitions/0e55495e-034f-4abc-8293-767229250176",
+ "name": "0e55495e-034f-4abc-8293-767229250176",
+ "type": "Microsoft.Security/secureScoreControlDefinitions",
+ "properties": {
+ "source": {
+ "sourceType": "BuiltIn"
+ },
+ "displayName": "Encrypt data in transit",
+ "maxScore": 4,
+ "assessmentDefinitions": [
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/1b351b29-41ca-6df5-946c-c190a56be5fe"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/cb0acdc6-0846-fd48-debe-9905af151b6d"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/bf82a334-13b6-ca57-ea75-096fc2ffce50"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/35b25be2-d08a-e340-45ed-f08a95d804fc"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/1c5de8e1-f68d-6a17-e0d2-ec259c42768c"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/a3ebc80a-847b-46d5-a37d-8dca5e6947df"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/c28a89d9-7cf4-439b-a8c4-ad4e769f68ee"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/2acc27c6-5fdb-405e-9080-cb66b850c8f5"
+ }
+ ]
+ }
+ },
+ "weight": 6
+ }
+ },
+ {
+ "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/secureScores/ascScore/secureScoreControls/f9d5432b-8f7b-45e9-b90c-e214a30f6a02",
+ "name": "f9d5432b-8f7b-45e9-b90c-e214a30f6a02",
+ "type": "Microsoft.Security/secureScores/secureScoreControls",
+ "properties": {
+ "displayName": "Restrict unauthorized network access",
+ "healthyResourceCount": 1,
+ "unhealthyResourceCount": 0,
+ "notApplicableResourceCount": 0,
+ "score": {
+ "max": 4,
+ "current": 4,
+ "percentage": 1
+ },
+ "definition": {
+ "id": "/providers/Microsoft.Security/secureScoreControlDefinitions/f9d5432b-8f7b-45e9-b90c-e214a30f6a02",
+ "name": "f9d5432b-8f7b-45e9-b90c-e214a30f6a02",
+ "type": "Microsoft.Security/secureScoreControlDefinitions",
+ "properties": {
+ "source": {
+ "sourceType": "BuiltIn"
+ },
+ "displayName": "Restrict unauthorized network access",
+ "maxScore": 4,
+ "assessmentDefinitions": [
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/483f12ed-ae23-447e-a2de-a67a10db4353"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/3b20e985-f71f-483b-b078-f30d73936d43"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/f9f0eed0-f143-47bf-b856-671ea2eeed62"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/1a2b5b4c-f80d-46e7-ac81-b51a9fb363de"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/c3b51c94-588b-426b-a892-24696f9e54cc"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/e40df93c-7a7c-1b0a-c787-9987ceb98e54"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/7b3d4796-9400-2904-692b-4a5ede7f0a1e"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/df4d1739-47f0-60c7-1706-3731fea6ab03"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/1a36f14a-8bd8-45f5-abe5-eef88d76ab5b"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/beb62be3-5e78-49bd-ac5f-099250ef3c7c"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/ba975338-f956-41e7-a9f2-7614832d382d"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/d5a8d84a-9ad0-42e2-80e0-d38e3d46028a"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/5a3d6cdd-8eb3-46d2-ba11-d24a0d47fe65"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/d8326952-60bb-40fb-b33f-51e662708a88"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/08e628db-e2ed-4793-bc91-d13e684401c3"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/5f88450f-9546-4b78-a181-a2d9162bb441"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/add45209-73f6-4fa5-a5a5-74a451b07fbe"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/dbfc99e3-e648-4c3b-bd32-995e6268430d"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/b3473ed6-78c0-40d5-b5f0-674e98924952"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/9dd55566-33b9-4c07-a959-14794ce02355"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/ad0b04b9-eaf9-49f8-b85e-724f9520e760"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/ece6ec5d-a862-4e22-a8db-271661216018"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/e40b679a-f44e-4366-87dd-7693e16a2128"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/0bdcd23c-4ff2-4077-aa14-eb6950bfbdd8"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/1f386f4e-449e-41e8-b829-a2fe01086ae1"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/2f6c8a5a-9407-467c-8082-0ad4ab915d77"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/3b1713ec-feb3-4b32-b5b0-251acff0a84a"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/049f1551-438b-444e-8904-a3c3afbcb43e"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/684307e9-62a8-4f2a-887a-4b90de5e4b98"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/0327f9da-f758-4d69-8903-55448b8cf70e"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/cc637123-c11e-40ee-adf8-93c0876481f4"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/a7c8fa46-526d-4bf6-b8b3-17fa01310fd8"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/20f6c761-4dd7-4f27-9e37-6db8471486ef"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/ebc68898-5c0f-4353-a426-4a5f1e737b12"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/f67fb4ed-d481-44d7-91e5-efadf504f74a"
+ }
+ ]
+ }
+ },
+ "weight": 1
+ }
+ },
+ {
+ "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/secureScores/ascScore/secureScoreControls/8fd574ec-43cf-426e-a439-a67cbaf2d564",
+ "name": "8fd574ec-43cf-426e-a439-a67cbaf2d564",
+ "type": "Microsoft.Security/secureScores/secureScoreControls",
+ "properties": {
+ "displayName": "Enable encryption at rest",
+ "healthyResourceCount": 1,
+ "unhealthyResourceCount": 0,
+ "notApplicableResourceCount": 0,
+ "score": {
+ "max": 4,
+ "current": 4,
+ "percentage": 1
+ },
+ "definition": {
+ "id": "/providers/Microsoft.Security/secureScoreControlDefinitions/8fd574ec-43cf-426e-a439-a67cbaf2d564",
+ "name": "8fd574ec-43cf-426e-a439-a67cbaf2d564",
+ "type": "Microsoft.Security/secureScoreControlDefinitions",
+ "properties": {
+ "source": {
+ "sourceType": "BuiltIn"
+ },
+ "displayName": "Enable encryption at rest",
+ "maxScore": 4,
+ "assessmentDefinitions": [
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/d57a4221-a804-52ca-3dea-768284f06bb7"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/651967bf-044e-4bde-8376-3e08e0600105"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/b12bc79e-4f12-44db-acda-571820191ddc"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/7f04fc0c-4a3d-5c7e-ce19-666cb871b510"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/dbfc99e3-e648-4c3b-bd32-995e6268430d"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/c01fab9f-bde1-4ba5-9d35-7de51f31c2d3"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/23b514bd-2afc-4a3e-8d3d-f4327118eee9"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/3053474d-4fab-4603-8d18-2a6dfd09f782"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/6be98232-0100-474a-b33d-ba9c1a747f70"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/a7c8fa46-526d-4bf6-b8b3-17fa01310fd8"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/20f6c761-4dd7-4f27-9e37-6db8471486ef"
+ }
+ ]
+ }
+ },
+ "weight": 1
}
}
]
diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2020-01-01-preview/examples/secureScores/ListSecureScoreControlsForName_builtin_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2020-01-01-preview/examples/secureScores/ListSecureScoreControlsForName_builtin_example.json
index aae8856966ea..cef6eb8e728a 100644
--- a/specification/security/resource-manager/Microsoft.Security/preview/2020-01-01-preview/examples/secureScores/ListSecureScoreControlsForName_builtin_example.json
+++ b/specification/security/resource-manager/Microsoft.Security/preview/2020-01-01-preview/examples/secureScores/ListSecureScoreControlsForName_builtin_example.json
@@ -9,48 +9,207 @@
"body": {
"value": [
{
- "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/SecureScoreControls/a9909064-42b4-4d34-8143-275477afe18b",
+ "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/secureScores/ascScore/secureScoreControls/a9909064-42b4-4d34-8143-275477afe18b",
"name": "a9909064-42b4-4d34-8143-275477afe18b",
- "type": "Microsoft.Security/SecureScoreControls",
+ "type": "Microsoft.Security/secureScores/secureScoreControls",
"properties": {
"displayName": "Protect applications against DDoS attacks",
"healthyResourceCount": 0,
"unhealthyResourceCount": 0,
- "notApplicableResourceCount": 10,
+ "notApplicableResourceCount": 1,
"score": {
"max": 0,
- "current": 0
- }
+ "current": 0,
+ "percentage": 0
+ },
+ "weight": 0
}
},
{
- "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/SecureScoreControls/34a42fb3-e6db-409c-b56b-7b1db6b8aee0",
+ "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/secureScores/ascScore/secureScoreControls/34a42fb3-e6db-409c-b56b-7b1db6b8aee0",
"name": "34a42fb3-e6db-409c-b56b-7b1db6b8aee0",
- "type": "Microsoft.Security/SecureScoreControls",
+ "type": "Microsoft.Security/secureScores/secureScoreControls",
"properties": {
"displayName": "Enable MFA",
+ "healthyResourceCount": 1,
+ "unhealthyResourceCount": 0,
+ "notApplicableResourceCount": 0,
+ "score": {
+ "max": 10,
+ "current": 10,
+ "percentage": 1
+ },
+ "weight": 1
+ }
+ },
+ {
+ "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/secureScores/ascScore/secureScoreControls/76763537-9feb-42d3-b4f4-78c01117be80",
+ "name": "76763537-9feb-42d3-b4f4-78c01117be80",
+ "type": "Microsoft.Security/secureScores/secureScoreControls",
+ "properties": {
+ "displayName": "Implement security best practices",
+ "healthyResourceCount": 7,
+ "unhealthyResourceCount": 0,
+ "notApplicableResourceCount": 1,
+ "score": {
+ "max": 0,
+ "current": 0,
+ "percentage": 0
+ },
+ "weight": 7
+ }
+ },
+ {
+ "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/secureScores/ascScore/secureScoreControls/4db8d6cf-075b-4149-a813-da09ca2ae120",
+ "name": "4db8d6cf-075b-4149-a813-da09ca2ae120",
+ "type": "Microsoft.Security/secureScores/secureScoreControls",
+ "properties": {
+ "displayName": "Enable Advanced Threat Protection",
"healthyResourceCount": 0,
"unhealthyResourceCount": 1,
"notApplicableResourceCount": 0,
"score": {
- "max": 10,
- "current": 0
- }
+ "max": 0,
+ "current": 0,
+ "percentage": 0
+ },
+ "weight": 1
}
},
{
- "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/SecureScoreControls/a000c66f-6da2-4f9d-826d-2364347d2588",
- "name": "a000c66f-6da2-4f9d-826d-2364347d2588",
- "type": "Microsoft.Security/SecureScoreControls",
+ "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/secureScores/ascScore/secureScoreControls/27b24961-75ba-4fe4-8909-97286d5dd5ee",
+ "name": "27b24961-75ba-4fe4-8909-97286d5dd5ee",
+ "type": "Microsoft.Security/secureScores/secureScoreControls",
"properties": {
- "displayName": "Apply adaptive application control",
- "healthyResourceCount": 20,
+ "displayName": "Enable auditing and logging",
+ "healthyResourceCount": 1,
+ "unhealthyResourceCount": 4,
+ "notApplicableResourceCount": 0,
+ "score": {
+ "max": 1,
+ "current": 0.2,
+ "percentage": 0.2
+ },
+ "weight": 5
+ }
+ },
+ {
+ "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/secureScores/ascScore/secureScoreControls/2d85f639-0bea-4a4a-b6c6-608952a1414a",
+ "name": "2d85f639-0bea-4a4a-b6c6-608952a1414a",
+ "type": "Microsoft.Security/secureScores/secureScoreControls",
+ "properties": {
+ "displayName": "Manage access and permissions",
+ "healthyResourceCount": 1,
+ "unhealthyResourceCount": 1,
+ "notApplicableResourceCount": 0,
+ "score": {
+ "max": 4,
+ "current": 2,
+ "percentage": 0.5
+ },
+ "weight": 2
+ }
+ },
+ {
+ "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/secureScores/ascScore/secureScoreControls/99fc8df2-e0f5-40f8-9415-a7f7ca948b5a",
+ "name": "99fc8df2-e0f5-40f8-9415-a7f7ca948b5a",
+ "type": "Microsoft.Security/secureScores/secureScoreControls",
+ "properties": {
+ "displayName": "Remediate security configurations",
+ "healthyResourceCount": 0,
+ "unhealthyResourceCount": 1,
+ "notApplicableResourceCount": 0,
+ "score": {
+ "max": 4,
+ "current": 0,
+ "percentage": 0
+ },
+ "weight": 1
+ }
+ },
+ {
+ "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/secureScores/ascScore/secureScoreControls/12136bd9-dc24-44f2-9587-7be3af6aac14",
+ "name": "12136bd9-dc24-44f2-9587-7be3af6aac14",
+ "type": "Microsoft.Security/secureScores/secureScoreControls",
+ "properties": {
+ "displayName": "Enable endpoint protection",
+ "healthyResourceCount": 0,
+ "unhealthyResourceCount": 1,
+ "notApplicableResourceCount": 0,
+ "score": {
+ "max": 2,
+ "current": 0,
+ "percentage": 0
+ },
+ "weight": 1
+ }
+ },
+ {
+ "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/secureScores/ascScore/secureScoreControls/61702b76-1fab-41f2-bcbc-50b7870dcf38",
+ "name": "61702b76-1fab-41f2-bcbc-50b7870dcf38",
+ "type": "Microsoft.Security/secureScores/secureScoreControls",
+ "properties": {
+ "displayName": "Apply system updates",
+ "healthyResourceCount": 0,
+ "unhealthyResourceCount": 1,
+ "notApplicableResourceCount": 0,
+ "score": {
+ "max": 6,
+ "current": 0,
+ "percentage": 0
+ },
+ "weight": 1
+ }
+ },
+ {
+ "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/secureScores/ascScore/secureScoreControls/0e55495e-034f-4abc-8293-767229250176",
+ "name": "0e55495e-034f-4abc-8293-767229250176",
+ "type": "Microsoft.Security/secureScores/secureScoreControls",
+ "properties": {
+ "displayName": "Encrypt data in transit",
+ "healthyResourceCount": 5,
+ "unhealthyResourceCount": 1,
+ "notApplicableResourceCount": 0,
+ "score": {
+ "max": 4,
+ "current": 3.33,
+ "percentage": 0.8325
+ },
+ "weight": 6
+ }
+ },
+ {
+ "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/secureScores/ascScore/secureScoreControls/f9d5432b-8f7b-45e9-b90c-e214a30f6a02",
+ "name": "f9d5432b-8f7b-45e9-b90c-e214a30f6a02",
+ "type": "Microsoft.Security/secureScores/secureScoreControls",
+ "properties": {
+ "displayName": "Restrict unauthorized network access",
+ "healthyResourceCount": 1,
"unhealthyResourceCount": 0,
- "notApplicableResourceCount": 10,
+ "notApplicableResourceCount": 0,
+ "score": {
+ "max": 4,
+ "current": 4,
+ "percentage": 1
+ },
+ "weight": 1
+ }
+ },
+ {
+ "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/secureScores/ascScore/secureScoreControls/8fd574ec-43cf-426e-a439-a67cbaf2d564",
+ "name": "8fd574ec-43cf-426e-a439-a67cbaf2d564",
+ "type": "Microsoft.Security/secureScores/secureScoreControls",
+ "properties": {
+ "displayName": "Enable encryption at rest",
+ "healthyResourceCount": 1,
+ "unhealthyResourceCount": 0,
+ "notApplicableResourceCount": 0,
"score": {
- "max": 3,
- "current": 3
- }
+ "max": 4,
+ "current": 4,
+ "percentage": 1
+ },
+ "weight": 1
}
}
]
diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2020-01-01-preview/examples/secureScores/ListSecureScoreControls_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2020-01-01-preview/examples/secureScores/ListSecureScoreControls_example.json
index c3c4542a72f3..8f8c888d2915 100644
--- a/specification/security/resource-manager/Microsoft.Security/preview/2020-01-01-preview/examples/secureScores/ListSecureScoreControls_example.json
+++ b/specification/security/resource-manager/Microsoft.Security/preview/2020-01-01-preview/examples/secureScores/ListSecureScoreControls_example.json
@@ -8,48 +8,207 @@
"body": {
"value": [
{
- "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/SecureScoreControls/a9909064-42b4-4d34-8143-275477afe18b",
+ "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/secureScores/ascScore/secureScoreControls/a9909064-42b4-4d34-8143-275477afe18b",
"name": "a9909064-42b4-4d34-8143-275477afe18b",
- "type": "Microsoft.Security/SecureScoreControls",
+ "type": "Microsoft.Security/secureScores/secureScoreControls",
"properties": {
"displayName": "Protect applications against DDoS attacks",
"healthyResourceCount": 0,
"unhealthyResourceCount": 0,
- "notApplicableResourceCount": 10,
+ "notApplicableResourceCount": 1,
"score": {
"max": 0,
- "current": 0
- }
+ "current": 0,
+ "percentage": 0
+ },
+ "weight": 0
}
},
{
- "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/SecureScoreControls/34a42fb3-e6db-409c-b56b-7b1db6b8aee0",
+ "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/secureScores/ascScore/secureScoreControls/34a42fb3-e6db-409c-b56b-7b1db6b8aee0",
"name": "34a42fb3-e6db-409c-b56b-7b1db6b8aee0",
- "type": "Microsoft.Security/SecureScoreControls",
+ "type": "Microsoft.Security/secureScores/secureScoreControls",
"properties": {
"displayName": "Enable MFA",
+ "healthyResourceCount": 1,
+ "unhealthyResourceCount": 0,
+ "notApplicableResourceCount": 0,
+ "score": {
+ "max": 10,
+ "current": 10,
+ "percentage": 1
+ },
+ "weight": 1
+ }
+ },
+ {
+ "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/secureScores/ascScore/secureScoreControls/76763537-9feb-42d3-b4f4-78c01117be80",
+ "name": "76763537-9feb-42d3-b4f4-78c01117be80",
+ "type": "Microsoft.Security/secureScores/secureScoreControls",
+ "properties": {
+ "displayName": "Implement security best practices",
+ "healthyResourceCount": 7,
+ "unhealthyResourceCount": 0,
+ "notApplicableResourceCount": 1,
+ "score": {
+ "max": 0,
+ "current": 0,
+ "percentage": 0
+ },
+ "weight": 7
+ }
+ },
+ {
+ "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/secureScores/ascScore/secureScoreControls/4db8d6cf-075b-4149-a813-da09ca2ae120",
+ "name": "4db8d6cf-075b-4149-a813-da09ca2ae120",
+ "type": "Microsoft.Security/secureScores/secureScoreControls",
+ "properties": {
+ "displayName": "Enable Advanced Threat Protection",
"healthyResourceCount": 0,
"unhealthyResourceCount": 1,
"notApplicableResourceCount": 0,
"score": {
- "max": 10,
- "current": 0
- }
+ "max": 0,
+ "current": 0,
+ "percentage": 0
+ },
+ "weight": 1
}
},
{
- "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/SecureScoreControls/a000c66f-6da2-4f9d-826d-2364347d2588",
- "name": "a000c66f-6da2-4f9d-826d-2364347d2588",
- "type": "Microsoft.Security/SecureScoreControls",
+ "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/secureScores/ascScore/secureScoreControls/27b24961-75ba-4fe4-8909-97286d5dd5ee",
+ "name": "27b24961-75ba-4fe4-8909-97286d5dd5ee",
+ "type": "Microsoft.Security/secureScores/secureScoreControls",
"properties": {
- "displayName": "Apply adaptive application control",
- "healthyResourceCount": 20,
+ "displayName": "Enable auditing and logging",
+ "healthyResourceCount": 1,
+ "unhealthyResourceCount": 4,
+ "notApplicableResourceCount": 0,
+ "score": {
+ "max": 1,
+ "current": 0.2,
+ "percentage": 0.2
+ },
+ "weight": 5
+ }
+ },
+ {
+ "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/secureScores/ascScore/secureScoreControls/2d85f639-0bea-4a4a-b6c6-608952a1414a",
+ "name": "2d85f639-0bea-4a4a-b6c6-608952a1414a",
+ "type": "Microsoft.Security/secureScores/secureScoreControls",
+ "properties": {
+ "displayName": "Manage access and permissions",
+ "healthyResourceCount": 1,
+ "unhealthyResourceCount": 1,
+ "notApplicableResourceCount": 0,
+ "score": {
+ "max": 4,
+ "current": 2,
+ "percentage": 0.5
+ },
+ "weight": 2
+ }
+ },
+ {
+ "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/secureScores/ascScore/secureScoreControls/99fc8df2-e0f5-40f8-9415-a7f7ca948b5a",
+ "name": "99fc8df2-e0f5-40f8-9415-a7f7ca948b5a",
+ "type": "Microsoft.Security/secureScores/secureScoreControls",
+ "properties": {
+ "displayName": "Remediate security configurations",
+ "healthyResourceCount": 0,
+ "unhealthyResourceCount": 1,
+ "notApplicableResourceCount": 0,
+ "score": {
+ "max": 4,
+ "current": 0,
+ "percentage": 0
+ },
+ "weight": 1
+ }
+ },
+ {
+ "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/secureScores/ascScore/secureScoreControls/12136bd9-dc24-44f2-9587-7be3af6aac14",
+ "name": "12136bd9-dc24-44f2-9587-7be3af6aac14",
+ "type": "Microsoft.Security/secureScores/secureScoreControls",
+ "properties": {
+ "displayName": "Enable endpoint protection",
+ "healthyResourceCount": 0,
+ "unhealthyResourceCount": 1,
+ "notApplicableResourceCount": 0,
+ "score": {
+ "max": 2,
+ "current": 0,
+ "percentage": 0
+ },
+ "weight": 1
+ }
+ },
+ {
+ "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/secureScores/ascScore/secureScoreControls/61702b76-1fab-41f2-bcbc-50b7870dcf38",
+ "name": "61702b76-1fab-41f2-bcbc-50b7870dcf38",
+ "type": "Microsoft.Security/secureScores/secureScoreControls",
+ "properties": {
+ "displayName": "Apply system updates",
+ "healthyResourceCount": 0,
+ "unhealthyResourceCount": 1,
+ "notApplicableResourceCount": 0,
+ "score": {
+ "max": 6,
+ "current": 0,
+ "percentage": 0
+ },
+ "weight": 1
+ }
+ },
+ {
+ "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/secureScores/ascScore/secureScoreControls/0e55495e-034f-4abc-8293-767229250176",
+ "name": "0e55495e-034f-4abc-8293-767229250176",
+ "type": "Microsoft.Security/secureScores/secureScoreControls",
+ "properties": {
+ "displayName": "Encrypt data in transit",
+ "healthyResourceCount": 5,
+ "unhealthyResourceCount": 1,
+ "notApplicableResourceCount": 0,
+ "score": {
+ "max": 4,
+ "current": 3.33,
+ "percentage": 0.8325
+ },
+ "weight": 6
+ }
+ },
+ {
+ "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/secureScores/ascScore/secureScoreControls/f9d5432b-8f7b-45e9-b90c-e214a30f6a02",
+ "name": "f9d5432b-8f7b-45e9-b90c-e214a30f6a02",
+ "type": "Microsoft.Security/secureScores/secureScoreControls",
+ "properties": {
+ "displayName": "Restrict unauthorized network access",
+ "healthyResourceCount": 1,
"unhealthyResourceCount": 0,
- "notApplicableResourceCount": 10,
+ "notApplicableResourceCount": 0,
+ "score": {
+ "max": 4,
+ "current": 4,
+ "percentage": 1
+ },
+ "weight": 1
+ }
+ },
+ {
+ "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/secureScores/ascScore/secureScoreControls/8fd574ec-43cf-426e-a439-a67cbaf2d564",
+ "name": "8fd574ec-43cf-426e-a439-a67cbaf2d564",
+ "type": "Microsoft.Security/secureScores/secureScoreControls",
+ "properties": {
+ "displayName": "Enable encryption at rest",
+ "healthyResourceCount": 1,
+ "unhealthyResourceCount": 0,
+ "notApplicableResourceCount": 0,
"score": {
- "max": 3,
- "current": 3
- }
+ "max": 4,
+ "current": 4,
+ "percentage": 1
+ },
+ "weight": 1
}
}
]
diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2020-01-01-preview/examples/secureScores/ListSecureScores_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2020-01-01-preview/examples/secureScores/ListSecureScores_example.json
index c301919d5266..78377220b726 100644
--- a/specification/security/resource-manager/Microsoft.Security/preview/2020-01-01-preview/examples/secureScores/ListSecureScores_example.json
+++ b/specification/security/resource-manager/Microsoft.Security/preview/2020-01-01-preview/examples/secureScores/ListSecureScores_example.json
@@ -14,10 +14,11 @@
"properties": {
"displayName": "ASC score",
"score": {
- "max": 13,
- "current": 3.5
+ "max": 39,
+ "current": 23.53,
+ "percentage": 0.6033
},
- "weight": 30
+ "weight": 67
}
}
]
diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2020-01-01-preview/secureScore.json b/specification/security/resource-manager/Microsoft.Security/preview/2020-01-01-preview/secureScore.json
index 4117c5311845..52ae9725b672 100644
--- a/specification/security/resource-manager/Microsoft.Security/preview/2020-01-01-preview/secureScore.json
+++ b/specification/security/resource-manager/Microsoft.Security/preview/2020-01-01-preview/secureScore.json
@@ -333,7 +333,7 @@
"$ref": "#/definitions/ScoreDetails"
},
"weight": {
- "description": "The weight for calculation of an aggregated score for several scopes",
+ "description": "The relative weight for each subscription. Used when calculating an aggregated secure score for multiple subscriptions.",
"readOnly": true,
"type": "integer",
"format": "int64",
@@ -362,6 +362,16 @@
"format": "double",
"minimum": 0.00,
"exclusiveMinimum": false
+ },
+ "percentage": {
+ "description": "Ratio of the current score divided by the maximum. Rounded to 4 digits after the decimal point",
+ "readOnly": true,
+ "type": "number",
+ "format": "double",
+ "minimum": 0.00,
+ "maximum": 1.00,
+ "exclusiveMinimum": false,
+ "exclusiveMaximum": false
}
}
},
@@ -386,6 +396,16 @@
"minimum": 0.00,
"maximum": 10.00,
"exclusiveMinimum": false
+ },
+ "percentage": {
+ "description": "Ratio of the current score divided by the maximum. Rounded to 4 digits after the decimal point",
+ "readOnly": true,
+ "type": "number",
+ "format": "double",
+ "minimum": 0.00,
+ "maximum": 1.00,
+ "exclusiveMinimum": false,
+ "exclusiveMaximum": false
}
}
},
@@ -455,6 +475,14 @@
"type": "integer",
"format": "int32"
},
+ "weight": {
+ "description": "The relative weight for this specific control in each of your subscriptions. Used when calculating an aggregated score for this control across all of your subscriptions.",
+ "readOnly": true,
+ "type": "integer",
+ "format": "int64",
+ "minimum": 0,
+ "exclusiveMinimum": false
+ },
"definition": {
"$ref": "#/definitions/SecureScoreControlDefinitionItem"
}
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
index 838aa27b70fa..1a4dd8e4a4b5 100644
--- 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
@@ -9,7 +9,12 @@
"name": "default",
"id": "/subscriptions/{subscriptionId}/providers/Microsoft.Security/iotDefenderSettings/default",
"type": "Microsoft.Security/iotDefenderSettings",
- "properties": {}
+ "properties": {
+ "deviceQuota": 2000,
+ "sentinelWorkspaceResourceIds": [
+ "/subscriptions/c4930e90-cd72-4aa5-93e9-2d081d129569/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace1"
+ ]
+ }
}
}
}
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
index 2cf5f5fee30d..7594b4d7cc01 100644
--- 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
@@ -11,7 +11,12 @@
"name": "default",
"id": "/subscriptions/{subscriptionId}/providers/Microsoft.Security/iotDefenderSettings/default",
"type": "Microsoft.Security/iotDefenderSettings",
- "properties": {}
+ "properties": {
+ "deviceQuota": 2000,
+ "sentinelWorkspaceResourceIds": [
+ "/subscriptions/c4930e90-cd72-4aa5-93e9-2d081d129569/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace1"
+ ]
+ }
}
]
}
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
index b4738db76a87..6eb347f06596 100644
--- 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
@@ -1,7 +1,15 @@
{
"parameters": {
"api-version": "2020-08-06-preview",
- "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23"
+ "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23",
+ "iotDefenderSettingsModel": {
+ "properties": {
+ "deviceQuota": 2000,
+ "sentinelWorkspaceResourceIds": [
+ "/subscriptions/c4930e90-cd72-4aa5-93e9-2d081d129569/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace1"
+ ]
+ }
+ }
},
"responses": {
"200": {
@@ -9,7 +17,12 @@
"name": "default",
"id": "/subscriptions/{subscriptionId}/providers/Microsoft.Security/iotDefenderSettings/default",
"type": "Microsoft.Security/iotDefenderSettings",
- "properties": {}
+ "properties": {
+ "deviceQuota": 2000,
+ "sentinelWorkspaceResourceIds": [
+ "/subscriptions/c4930e90-cd72-4aa5-93e9-2d081d129569/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace1"
+ ]
+ }
}
},
"201": {
@@ -17,7 +30,12 @@
"name": "default",
"id": "/subscriptions/{subscriptionId}/providers/Microsoft.Security/iotDefenderSettings/default",
"type": "Microsoft.Security/iotDefenderSettings",
- "properties": {}
+ "properties": {
+ "deviceQuota": 2000,
+ "sentinelWorkspaceResourceIds": [
+ "/subscriptions/c4930e90-cd72-4aa5-93e9-2d081d129569/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace1"
+ ]
+ }
}
}
}
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
index afdeadc4a050..8929c118bb08 100644
--- 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
@@ -122,6 +122,9 @@
},
{
"$ref": "../../../common/v1/types.json#/parameters/SubscriptionId"
+ },
+ {
+ "$ref": "#/parameters/IotDefenderSettingsModel"
}
],
"responses": {
@@ -251,7 +254,25 @@
"IotDefenderSettingsProperties": {
"type": "object",
"description": "IoT Defender settings properties",
- "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"
+ }
+ }
+ },
+ "required": [
+ "deviceQuota",
+ "sentinelWorkspaceResourceIds"
+ ]
},
"DownloadLink": {
"type": "string",
@@ -445,5 +466,16 @@
}
}
},
- "parameters": {}
+ "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/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 a70e71a83dc5..682ca4c40b17 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
@@ -2938,6 +2938,102 @@
}
}
},
+ "/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": {
@@ -6687,6 +6783,91 @@
},
"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"
+ },
"IncidentAdditionalData": {
"description": "Incident additional data property bag.",
"properties": {
@@ -6725,6 +6906,36 @@
},
"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"
+ }
+ }
+ },
+ "required": [
+ "value"
+ ]
+ },
"IncidentComment": {
"allOf": [
{
diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/examples/incidents/GetAllIncidentAlerts.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/examples/incidents/GetAllIncidentAlerts.json
new file mode 100644
index 000000000000..4a543ecd8e07
--- /dev/null
+++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/examples/incidents/GetAllIncidentAlerts.json
@@ -0,0 +1,51 @@
+{
+ "parameters": {
+ "api-version": "2019-01-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/2019-01-01-preview/examples/incidents/GetAllIncidentBookmarks.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/examples/incidents/GetAllIncidentBookmarks.json
new file mode 100644
index 000000000000..711caaffaf16
--- /dev/null
+++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/examples/incidents/GetAllIncidentBookmarks.json
@@ -0,0 +1,78 @@
+{
+ "parameters": {
+ "api-version": "2019-01-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/servicebus/resource-manager/Microsoft.ServiceBus/preview/2018-01-01-preview/namespace-preview.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2018-01-01-preview/namespace-preview.json
index c0c3b8bd4637..5885f3077d1d 100644
--- a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2018-01-01-preview/namespace-preview.json
+++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2018-01-01-preview/namespace-preview.json
@@ -634,6 +634,10 @@
"$ref": "#/definitions/SBSku",
"description": "Properties of SKU"
},
+ "identity": {
+ "$ref": "#/definitions/Identity",
+ "description": "Properties of BYOK Identity description"
+ },
"properties": {
"x-ms-client-flatten": true,
"$ref": "#/definitions/SBNamespaceProperties",
diff --git a/specification/servicebus/resource-manager/readme.cli.md b/specification/servicebus/resource-manager/readme.cli.md
index e1f6d11dfcc0..f1a8e278f7b1 100644
--- a/specification/servicebus/resource-manager/readme.cli.md
+++ b/specification/servicebus/resource-manager/readme.cli.md
@@ -8,6 +8,77 @@ This directory contains the Cli common model for the Dns service.
``` yaml
# Migrated from Powershell's readme
cli:
+ cli-name: servicebus
+ package-name: azure-mgmt-servicebus
+ namespace: azure.mgmt.servicebus
+ test-scenario:
+ - name: /Namespaces/put/NameSpaceCreate
+ - name: /Topics/put/TopicCreate
+ - name: /Queues/put/QueueCreate
+ - name: /DisasterRecoveryConfigs/put/SBAliasCreate
+ - name: /MigrationConfigs/put/MigrationConfigurationsStartMigration
+ - name: /Namespaces/put/NameSpaceNetworkRuleSetCreate
+ - name: /Namespaces/put/NameSpaceAuthorizationRuleCreate
+ - name: /Subscriptions/put/SubscriptionCreate
+ - name: /Queues/put/QueueAuthorizationRuleCreate
+ - name: /Topics/put/TopicAuthorizationRuleCreate
+ - name: /Rules/put/RulesCreateCorrelationFilter
+ - name: /Rules/put/RulesCreateSqlFilter
+ - name: /Rules/put/RulesCreateOrUpdate
+ - name: /DisasterRecoveryConfigs/get/DisasterRecoveryConfigsAuthorizationRuleGet
+ - name: /Rules/get/RulesGet
+ - name: /Topics/get/TopicAuthorizationRuleGet
+ - name: /Queues/get/QueueAuthorizationRuleGet
+ - name: /Rules/get/RulesListBySubscriptions
+ - name: /Subscriptions/get/SubscriptionGet
+ - name: /Subscriptions/get/SubscriptionListByTopic
+ - name: /DisasterRecoveryConfigs/get/NameSpaceAuthorizationRuleListAll
+ - name: /Namespaces/get/NameSpaceAuthorizationRuleGet
+ - name: /Namespaces/get/NameSpaceNetworkRuleSetGet
+ - name: /Topics/get/TopicAuthorizationRuleListAll
+ - name: /Queues/get/QueueAuthorizationRuleListAll
+ - name: /MigrationConfigs/get/MigrationConfigurationsGet
+ - name: /DisasterRecoveryConfigs/get/SBAliasGet
+ - name: /DisasterRecoveryConfigs/get/SBAliasList
+ - name: /Queues/get/QueueGet
+ - name: /Topics/get/TopicGet
+ - name: /MigrationConfigs/get/MigrationConfigurationsList
+ - name: /Namespaces/get/NameSpaceAuthorizationRuleListAll
+ - name: /Namespaces/get/NameSpaceNetworkRuleSetList
+ - name: /EventHubs/get/RulesCreateOrUpdate
+ - name: /Topics/get/TopicGet
+ - name: /Queues/get/QueueListByNameSpace
+ - name: /Namespaces/get/NameSpaceGet
+ - name: /Namespaces/get/NameSpaceListByResourceGroup
+ - name: /PremiumMessagingRegions/get/PremiumMessagingRegionsList
+ - name: /Regions/get/RegionsListBySku
+ - name: /Namespaces/get/NameSpaceList
+ - name: /Operations/get/OperationsList
+ - name: /DisasterRecoveryConfigs/post/DisasterRecoveryConfigsAuthorizationRuleListKey
+ - name: /Topics/post/TopicAuthorizationRuleRegenerateKey
+ - name: /Queues/post/QueueAuthorizationRuleRegenerateKey
+ - name: /Topics/post/TopicAuthorizationRuleListKey
+ - name: /Queues/post/QueueAuthorizationRuleListKey
+ - name: /Namespaces/post/NameSpaceAuthorizationRuleRegenerateKey
+ - name: /DisasterRecoveryConfigs/post/AliasNameAvailability
+ - name: /Namespaces/post/NameSpaceAuthorizationRuleListKey
+ - name: /MigrationConfigs/post/MigrationConfigurationsCompleteMigration
+ - name: /MigrationConfigs/post/MigrationConfigurationsRevert
+ - name: /DisasterRecoveryConfigs/post/SBEHAliasBreakPairing
+ - name: /DisasterRecoveryConfigs/post/SBAliasFailOver
+ - name: /Namespaces/post/NameSpaceUpdate
+ - name: /Namespaces/patch/NameSpaceUpdate
+ - name: /Namespaces/post/NameSpaceCheckNameAvailability
+ - name: /Rules/delete/RulesDelete
+ - name: /Queues/delete/QueueAuthorizationRuleDelete
+ - name: /Topics/delete/TopicAuthorizationRuleDelete
+ - name: /Subscriptions/delete/SubscriptionDelete
+ - name: /Namespaces/delete/NameSpaceAuthorizationRuleDelete
+ - name: /MigrationConfigs/delete/MigrationConfigurationsDelete
+ - name: /DisasterRecoveryConfigs/delete/SBAliasDelete
+ - name: /Topics/delete/TopicDelete
+ - name: /Queues/delete/QueueDelete
+ - name: /Namespaces/delete/NameSpaceDelete
cli-directive:
- select: 'operation'
where:
diff --git a/specification/servicebus/resource-manager/readme.md b/specification/servicebus/resource-manager/readme.md
index c9f4f4f4e15c..c615a3072a32 100644
--- a/specification/servicebus/resource-manager/readme.md
+++ b/specification/servicebus/resource-manager/readme.md
@@ -138,7 +138,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
@@ -149,12 +149,26 @@ python:
package-version: 0.5.0
clear-output-folder: true
```
+``` yaml $(python) && $(track2)
+python-mode: create
+azure-arm: true
+license-header: MICROSOFT_MIT_NO_VERSION
+namespace: azure.mgmt.servicebus
+package-name: azure-mgmt-servicebus
+package-version: 0.5.0
+clear-output-folder: true
+```
+
``` yaml $(python) && $(python-mode) == 'update'
+no-namespace-folders: true
+output-folder: $(python-sdks-folder)/servicebus/azure-mgmt-servicebus/azure/mgmt/servicebus
python:
no-namespace-folders: true
output-folder: $(python-sdks-folder)/servicebus/azure-mgmt-servicebus/azure/mgmt/servicebus
```
``` yaml $(python) && $(python-mode) == 'create'
+basic-setup-py: true
+output-folder: $(python-sdks-folder)/servicebus/azure-mgmt-servicebus
python:
basic-setup-py: true
output-folder: $(python-sdks-folder)/servicebus/azure-mgmt-servicebus
diff --git a/specification/servicefabric/resource-manager/readme.go.md b/specification/servicefabric/resource-manager/readme.go.md
index 866fdbb790d8..b47de2db193f 100644
--- a/specification/servicefabric/resource-manager/readme.go.md
+++ b/specification/servicefabric/resource-manager/readme.go.md
@@ -44,7 +44,7 @@ These settings apply only when `--tag=package-2018-02 --go` is specified on the
Please also specify `--go-sdk-folder=`.
``` yaml $(tag) == 'package-2018-02' && $(go)
-output-folder: $(go-sdk-folder)/services/$(namespace)/mgmt/2018-02-01/$(namespace)
+output-folder: $(go-sdk-folder)/services/preview/$(namespace)/mgmt/2018-02-01-preview/$(namespace)
```
### Tag: package-2017-07 and go
diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2019-06-01-preview/databases.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2019-06-01-preview/databases.json
index 2e2db731b65d..1a3a82038457 100644
--- a/specification/sql/resource-manager/Microsoft.Sql/preview/2019-06-01-preview/databases.json
+++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2019-06-01-preview/databases.json
@@ -940,7 +940,7 @@
"type": "integer"
},
"storageAccountType": {
- "description": "The storage account type used to store backups for this database. Currently the only supported option is GRS (GeoRedundantStorage).",
+ "description": "The storage account type used to store backups for this database.",
"enum": [
"GRS",
"LRS",
diff --git a/specification/sql/resource-manager/readme.md b/specification/sql/resource-manager/readme.md
index 507c3ad8420a..c6080b659d8d 100644
--- a/specification/sql/resource-manager/readme.md
+++ b/specification/sql/resource-manager/readme.md
@@ -31,6 +31,110 @@ tag: package-composite-v3
The following packages may be composed from multiple api-versions.
+### Tag: package-composite-v4
+
+These settings apply only when `--tag=package-composite-v4` is specified on the command line.
+
+This section contains the "composite-v4" set of APIs, which is composed from a selection of api-versions that will remain backwards compatible with "v4" clients such as .NET SDK Microsoft.Azure.Management.Sql version 1.44.3.0-preview.
+
+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.
+
+Differences in v4 (compared to v3):
+
+* Added new API for databases and elastic pools
+
+ * `-2020-08-01/databases.json`
+
+ * `-2020-08-01/elasticPools.json`
+
+* Failover API for elastic pools was integrated into elasticPools
+
+``` yaml $(tag) == 'package-composite-v4'
+input-file:
+- Microsoft.Sql/stable/2014-04-01/backups.json
+- Microsoft.Sql/stable/2014-04-01/connectionPolicies.json
+- Microsoft.Sql/stable/2014-04-01/databaseSecurityAlertPolicies.json
+- Microsoft.Sql/stable/2014-04-01/dataMasking.json
+- Microsoft.Sql/stable/2014-04-01/firewallRules.json
+- Microsoft.Sql/stable/2014-04-01/geoBackupPolicies.json
+- Microsoft.Sql/stable/2014-04-01/metrics.json
+- Microsoft.Sql/stable/2014-04-01/recommendedElasticPoolsDecoupled.json
+- Microsoft.Sql/stable/2014-04-01/replicationLinks.json
+- Microsoft.Sql/stable/2014-04-01/serverCommunicationLinks.json
+- Microsoft.Sql/stable/2014-04-01/serviceObjectives.json
+- Microsoft.Sql/stable/2014-04-01/sql.core.json
+- Microsoft.Sql/stable/2014-04-01/usages.json
+- Microsoft.Sql/preview/2015-05-01-preview/databaseAutomaticTuning.json
+- Microsoft.Sql/preview/2015-05-01-preview/encryptionProtectors.json
+- Microsoft.Sql/preview/2015-05-01-preview/failoverGroups.json
+- Microsoft.Sql/preview/2015-05-01-preview/operations.json
+- Microsoft.Sql/preview/2015-05-01-preview/serverKeys.json
+- Microsoft.Sql/preview/2015-05-01-preview/syncAgents.json
+- Microsoft.Sql/preview/2015-05-01-preview/usages.json
+- Microsoft.Sql/preview/2015-05-01-preview/virtualclusters.json
+- Microsoft.Sql/preview/2015-05-01-preview/virtualNetworkRules.json
+- Microsoft.Sql/preview/2017-03-01-preview/blobAuditing.json
+- Microsoft.Sql/preview/2017-03-01-preview/databaseVulnerabilityAssessmentBaselines.json
+- Microsoft.Sql/preview/2017-03-01-preview/databaseVulnerabilityAssessments.json
+- Microsoft.Sql/preview/2017-03-01-preview/jobs.json
+- Microsoft.Sql/preview/2017-03-01-preview/longTermRetention.json
+- Microsoft.Sql/preview/2017-03-01-preview/ManagedBackupShortTermRetention.json
+- Microsoft.Sql/preview/2017-03-01-preview/ManagedRestorableDroppedDatabaseBackupShortTermRetenion.json
+- Microsoft.Sql/preview/2017-03-01-preview/serverAutomaticTuning.json
+- Microsoft.Sql/preview/2017-03-01-preview/serverDnsAliases.json
+- Microsoft.Sql/preview/2017-03-01-preview/serverSecurityAlertPolicies.json
+- Microsoft.Sql/preview/2017-03-01-preview/restorableDroppedManagedDatabases.json
+- Microsoft.Sql/preview/2017-03-01-preview/restorePoints.json
+- Microsoft.Sql/preview/2017-03-01-preview/ManagedDatabaseSecurityAlertPolicies.json
+- Microsoft.Sql/preview/2017-03-01-preview/ManagedServerSecurityAlertPolicy.json
+- Microsoft.Sql/preview/2017-03-01-preview/SensitivityLabels.json
+- Microsoft.Sql/preview/2017-03-01-preview/managedInstanceAdministrators.json
+- Microsoft.Sql/preview/2017-10-01-preview/cancelOperations.json
+- Microsoft.Sql/preview/2017-10-01-preview/cancelPoolOperations.json
+- Microsoft.Sql/preview/2017-10-01-preview/databaseVulnerabilityAssessmentScans.json
+- Microsoft.Sql/preview/2017-10-01-preview/managedDatabaseVulnerabilityAssesmentRuleBaselines.json
+- Microsoft.Sql/preview/2017-10-01-preview/managedDatabaseVulnerabilityAssessmentScans.json
+- Microsoft.Sql/preview/2017-10-01-preview/managedDatabaseVulnerabilityAssessments.json
+- Microsoft.Sql/preview/2017-10-01-preview/instanceFailoverGroups.json
+- Microsoft.Sql/preview/2017-10-01-preview/TdeCertificates.json
+- Microsoft.Sql/preview/2017-10-01-preview/ManagedInstanceTdeCertificates.json
+- Microsoft.Sql/preview/2017-10-01-preview/ManagedInstanceKeys.json
+- Microsoft.Sql/preview/2017-10-01-preview/ManagedInstanceEncryptionProtectors.json
+- Microsoft.Sql/preview/2017-10-01-preview/recoverableManagedDatabases.json
+- Microsoft.Sql/preview/2018-06-01-preview/ManagedInstanceVulnerabilityAssessments.json
+- Microsoft.Sql/preview/2018-06-01-preview/ServerVulnerabilityAssessments.json
+- Microsoft.Sql/preview/2018-06-01-preview/managedDatabaseSensitivityLabels.json
+- Microsoft.Sql/preview/2018-06-01-preview/instancePools.json
+- Microsoft.Sql/preview/2018-06-01-preview/usages.json
+- Microsoft.Sql/preview/2018-06-01-preview/PrivateEndpointConnections.json
+- Microsoft.Sql/preview/2018-06-01-preview/PrivateLinkResources.json
+- Microsoft.Sql/preview/2019-06-01-preview/servers.json
+- Microsoft.Sql/preview/2018-06-01-preview/capabilities.json
+- Microsoft.Sql/preview/2018-06-01-preview/LongTermRetentionManagedInstanceBackups.json
+- Microsoft.Sql/preview/2018-06-01-preview/ManagedInstanceLongTermRetentionPolicies.json
+- Microsoft.Sql/preview/2019-06-01-preview/WorkloadGroups.json
+- Microsoft.Sql/preview/2019-06-01-preview/WorkloadClassifiers.json
+- Microsoft.Sql/preview/2019-06-01-preview/managedInstanceOperations.json
+- Microsoft.Sql/preview/2019-06-01-preview/ServerAzureADAdministrators.json
+- Microsoft.Sql/preview/2019-06-01-preview/syncGroups.json
+- Microsoft.Sql/preview/2019-06-01-preview/syncMembers.json
+- Microsoft.Sql/preview/2019-06-01-preview/FailoverManagedInstance.json
+- Microsoft.Sql/preview/2020-02-02-preview/shortTermRetentionPolicies.json
+- Microsoft.Sql/preview/2020-02-02-preview/managedDatabases.json
+- Microsoft.Sql/preview/2020-02-02-preview/ServerAzureADOnlyAuthentications.json
+- Microsoft.Sql/preview/2020-02-02-preview/managedInstances.json
+- Microsoft.Sql/preview/2020-02-02-preview/importexport.json
+- Microsoft.Sql/preview/2020-02-02-preview/ManagedInstanceAzureADOnlyAuthentications.json
+- Microsoft.Sql/preview/2020-02-02-preview/ServerTrustGroups.json
+- Microsoft.Sql/preview/2020-08-01-preview/databases.json
+- Microsoft.Sql/preview/2020-08-01-preview/elasticPools.json
+
+
+# Needed when there is more than one input file
+override-info:
+ title: SqlManagementClient
+```
+
### Tag: package-composite-v3
These settings apply only when `--tag=package-composite-v3` is specified on the command line.
diff --git a/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/blob.json b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/blob.json
index b07b7afda9ad..bfb8cb862ec7 100644
--- a/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/blob.json
+++ b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/blob.json
@@ -64,6 +64,9 @@
"x-ms-examples": {
"PutBlobServices": {
"$ref": "./examples/BlobServicesPut.json"
+ },
+ "BlobServicesPutLastAccessTimeBasedTracking": {
+ "$ref": "./examples/BlobServicesPutLastAccessTimeBasedTracking.json"
}
},
"description": "Sets the properties of a storage account’s Blob service, including properties for Storage Analytics and CORS (Cross-Origin Resource Sharing) rules. ",
@@ -1204,6 +1207,10 @@
"containerDeleteRetentionPolicy": {
"$ref": "./common.json#/definitions/DeleteRetentionPolicy",
"description": "The blob service properties for container soft delete."
+ },
+ "lastAccessTimeTrackingPolicy": {
+ "$ref": "#/definitions/LastAccessTimeTrackingPolicy",
+ "description": "The blob service property to configure last access time based tracking policy."
}
},
"x-ms-client-flatten": true,
@@ -1274,6 +1281,41 @@
],
"description": "The blob service properties for blob restore policy"
},
+ "LastAccessTimeTrackingPolicy": {
+ "properties": {
+ "enable": {
+ "type": "boolean",
+ "description": "When set to true last access time based tracking is enabled."
+ },
+ "name": {
+ "type": "string",
+ "description": "Name of the policy. The valid value is AccessTimeTracking. This field is currently read only",
+ "enum": [
+ "AccessTimeTracking"
+ ],
+ "x-ms-enum": {
+ "name": "name",
+ "modelAsString": true
+ }
+ },
+ "trackingGranularityInDays": {
+ "type": "integer",
+ "format": "int32",
+ "description": "The field specifies blob object tracking granularity in days, typically how often the blob object should be tracked.This field is currently read only with value as 1"
+ },
+ "blobType": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "An array of predefined supported blob types. Only blockBlob is the supported value. This field is currently read only"
+ }
+ },
+ "required": [
+ "enable"
+ ],
+ "description": "The blob service properties for Last access time based tracking policy."
+ },
"LeaseContainerRequest": {
"properties": {
"action": {
diff --git a/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/BlobServicesPutLastAccessTimeBasedTracking.json b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/BlobServicesPutLastAccessTimeBasedTracking.json
new file mode 100644
index 000000000000..a412fc28b489
--- /dev/null
+++ b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/BlobServicesPutLastAccessTimeBasedTracking.json
@@ -0,0 +1,41 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "res4410",
+ "accountName": "sto8607",
+ "BlobServicesName": "default",
+ "api-version": "2020-08-01-preview",
+ "monitor": "true",
+ "parameters": {
+ "properties": {
+ "lastAccessTimeTrackingPolicy": {
+ "enable": true,
+ "name": "AccessTimeTracking",
+ "trackingGranularityInDays": 1,
+ "blobType": [
+ "blockBlob"
+ ]
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/res4410/providers/Microsoft.Storage/storageAccounts/sto8607/blobServices/default",
+ "name": "default",
+ "type": "Microsoft.Storage/storageAccounts/blobServices",
+ "properties": {
+ "lastAccessTimeTrackingPolicy": {
+ "enable": true,
+ "name": "AccessTimeTracking",
+ "trackingGranularityInDays": 1,
+ "blobType": [
+ "blockBlob"
+ ]
+ }
+ }
+ }
+ }
+ }
+}
diff --git a/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/FileServicesPut_EnableSMBMultichannel.json b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/FileServicesPut_EnableSMBMultichannel.json
new file mode 100644
index 000000000000..4368652b23e3
--- /dev/null
+++ b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/FileServicesPut_EnableSMBMultichannel.json
@@ -0,0 +1,43 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "res4410",
+ "accountName": "sto8607",
+ "FileServicesName": "default",
+ "api-version": "2020-08-01-preview",
+ "monitor": "true",
+ "parameters": {
+ "properties": {
+ "protocolSettings": {
+ "smb": {
+ "multichannel": {
+ "enabled": true
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/res4410/providers/Microsoft.Storage/storageAccounts/sto8607/fileServices/default",
+ "name": "default",
+ "type": "Microsoft.Storage/storageAccounts/fileServices",
+ "properties": {
+ "protocolSettings": {
+ "smb": {
+ "multichannel": {
+ "enabled": true
+ }
+ }
+ }
+ },
+ "sku": {
+ "name": "Premium_LRS",
+ "tier": "Premium"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountCreate.json b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountCreate.json
index f560f583aac1..220209545654 100644
--- a/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountCreate.json
+++ b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountCreate.json
@@ -10,6 +10,10 @@
},
"kind": "Storage",
"location": "eastus",
+ "extendedLocation": {
+ "type": "EdgeZone",
+ "name": "losangeles001"
+ },
"properties": {
"isHnsEnabled": true,
"allowBlobPublicAccess": false,
@@ -47,6 +51,10 @@
"kind": "Storage",
"location": "eastus",
"name": "sto4445",
+ "extendedLocation": {
+ "type": "EdgeZone",
+ "name": "losangeles001"
+ },
"properties": {
"isHnsEnabled": true,
"allowBlobPublicAccess": false,
diff --git a/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountGetProperties.json b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountGetProperties.json
index 5fe7647f8058..339fc0850970 100644
--- a/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountGetProperties.json
+++ b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountGetProperties.json
@@ -25,7 +25,13 @@
"bypass": "AzureServices",
"defaultAction": "Allow",
"ipRules": [],
- "virtualNetworkRules": []
+ "virtualNetworkRules": [],
+ "resourceAccessRules": [
+ {
+ "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47",
+ "resourceId": "/subscriptions/a7e99807-abbf-4642-bdec-2c809a96a8bc/resourceGroups/res9407/providers/Microsoft.Synapse/workspaces/testworkspace"
+ }
+ ]
},
"primaryEndpoints": {
"web": "https://sto8596.web.core.windows.net/",
diff --git a/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountGetPropertiesCMKEnabled.json b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountGetPropertiesCMKEnabled.json
index 5554a5a31755..8b8626bd2f10 100644
--- a/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountGetPropertiesCMKEnabled.json
+++ b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountGetPropertiesCMKEnabled.json
@@ -30,7 +30,8 @@
"bypass": "AzureServices",
"defaultAction": "Allow",
"ipRules": [],
- "virtualNetworkRules": []
+ "virtualNetworkRules": [],
+ "resourceAccessRules": []
},
"primaryEndpoints": {
"web": "https://sto8596.web.core.windows.net/",
diff --git a/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountList.json b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountList.json
index 4744fc9baf61..c0617cc2028f 100644
--- a/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountList.json
+++ b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountList.json
@@ -129,6 +129,12 @@
"isHnsEnabled": true,
"creationTime": "2017-06-01T02:42:41.7633306Z",
"networkAcls": {
+ "resourceAccessRules": [
+ {
+ "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47",
+ "resourceId": "/subscriptions/a7e99807-abbf-4642-bdec-2c809a96a8bc/resourceGroups/res9407/providers/Microsoft.Synapse/workspaces/testworkspace"
+ }
+ ],
"bypass": "AzureServices",
"defaultAction": "Allow",
"ipRules": [],
diff --git a/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountSetManagementPolicy_LastAccessTimeBasedBlobActions.json b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountSetManagementPolicy_LastAccessTimeBasedBlobActions.json
new file mode 100644
index 000000000000..52c40ceacc81
--- /dev/null
+++ b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountSetManagementPolicy_LastAccessTimeBasedBlobActions.json
@@ -0,0 +1,102 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "res7687",
+ "accountName": "sto9699",
+ "managementPolicyName": "default",
+ "api-version": "2020-08-01-preview",
+ "monitor": "true",
+ "properties": {
+ "properties": {
+ "policy": {
+ "rules": [
+ {
+ "enabled": true,
+ "name": "olcmtest",
+ "type": "Lifecycle",
+ "definition": {
+ "filters": {
+ "blobTypes": [
+ "blockBlob"
+ ],
+ "prefixMatch": [
+ "olcmtestcontainer"
+ ]
+ },
+ "actions": {
+ "baseBlob": {
+ "tierToCool": {
+ "daysAfterLastAccessTimeGreaterThan": 30
+ },
+ "tierToArchive": {
+ "daysAfterLastAccessTimeGreaterThan": 90
+ },
+ "delete": {
+ "daysAfterLastAccessTimeGreaterThan": 1000
+ },
+ "enableAutoTierToHotFromCool": true
+ },
+ "snapshot": {
+ "delete": {
+ "daysAfterCreationGreaterThan": 30
+ }
+ }
+ }
+ }
+ }
+ ]
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/res7231/providers/Microsoft.Storage/storageAccounts/sto288/managementPolicies/default",
+ "name": "DefaultManagementPolicy",
+ "type": "Microsoft.Storage/storageAccounts/managementPolicies",
+ "properties": {
+ "policy": {
+ "rules": [
+ {
+ "enabled": true,
+ "name": "olcmtest",
+ "type": "Lifecycle",
+ "definition": {
+ "filters": {
+ "blobTypes": [
+ "blockBlob"
+ ],
+ "prefixMatch": [
+ "olcmtestcontainer"
+ ]
+ },
+ "actions": {
+ "baseBlob": {
+ "tierToCool": {
+ "daysAfterLastAccessTimeGreaterThan": 30
+ },
+ "tierToArchive": {
+ "daysAfterLastAccessTimeGreaterThan": 90
+ },
+ "delete": {
+ "daysAfterLastAccessTimeGreaterThan": 1000
+ },
+ "enableAutoTierToHotFromCool": true
+ },
+ "snapshot": {
+ "delete": {
+ "daysAfterCreationGreaterThan": 30
+ }
+ }
+ }
+ }
+ }
+ ]
+ },
+ "lastModifiedTime": "2018-06-08T02:53:39.0932539Z"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountUpdate.json b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountUpdate.json
index 52ad395f900c..1426ec2791e9 100644
--- a/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountUpdate.json
+++ b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountUpdate.json
@@ -10,6 +10,12 @@
"allowBlobPublicAccess": false,
"minimumTlsVersion": "TLS1_2",
"networkAcls": {
+ "resourceAccessRules": [
+ {
+ "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47",
+ "resourceId": "/subscriptions/a7e99807-abbf-4642-bdec-2c809a96a8bc/resourceGroups/res9407/providers/Microsoft.Synapse/workspaces/testworkspace"
+ }
+ ],
"defaultAction": "Allow"
},
"routingPreference": {
@@ -46,6 +52,12 @@
"minimumTlsVersion": "TLS1_2",
"creationTime": "2017-06-01T02:42:41.7633306Z",
"networkAcls": {
+ "resourceAccessRules": [
+ {
+ "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47",
+ "resourceId": "/subscriptions/a7e99807-abbf-4642-bdec-2c809a96a8bc/resourceGroups/res9407/providers/Microsoft.Synapse/workspaces/testworkspace"
+ }
+ ],
"bypass": "AzureServices",
"defaultAction": "Allow",
"ipRules": [],
diff --git a/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/file.json b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/file.json
index 2035390ef5ef..1f4729ed5ef9 100644
--- a/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/file.json
+++ b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/file.json
@@ -67,6 +67,9 @@
"x-ms-examples": {
"PutFileServices": {
"$ref": "./examples/FileServicesPut.json"
+ },
+ "PutFileServices_EnableSMBMultichannel": {
+ "$ref": "./examples/FileServicesPut_EnableSMBMultichannel.json"
}
},
"description": "Sets the properties of file services in storage accounts, including CORS (Cross-Origin Resource Sharing) rules. ",
@@ -526,6 +529,10 @@
"shareDeleteRetentionPolicy": {
"$ref": "./common.json#/definitions/DeleteRetentionPolicy",
"description": "The file service properties for share soft delete."
+ },
+ "protocolSettings": {
+ "$ref": "#/definitions/ProtocolSettings",
+ "description": "Protocol settings for file service"
}
},
"x-ms-client-flatten": true,
@@ -545,6 +552,33 @@
],
"description": "The properties of File services in storage account."
},
+ "ProtocolSettings": {
+ "properties": {
+ "smb": {
+ "$ref": "#/definitions/SmbSetting",
+ "description": "Setting for SMB protocol"
+ }
+ },
+ "description": "Protocol settings for file service"
+ },
+ "SmbSetting": {
+ "properties": {
+ "multichannel": {
+ "$ref": "#/definitions/Multichannel",
+ "description": "Multichannel setting. Applies to Premium FileStorage only."
+ }
+ },
+ "description": "Setting for SMB protocol"
+ },
+ "Multichannel": {
+ "properties": {
+ "enabled": {
+ "type": "boolean",
+ "description": "Indicates whether multichannel is enabled"
+ }
+ },
+ "description": "Multichannel setting. Applies to Premium FileStorage only."
+ },
"FileShare": {
"properties": {
"properties": {
diff --git a/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/storage.json b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/storage.json
index 1bc46b6069ab..82cb21fda43a 100644
--- a/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/storage.json
+++ b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/storage.json
@@ -825,6 +825,9 @@
"x-ms-examples": {
"StorageAccountSetManagementPolicies": {
"$ref": "./examples/StorageAccountSetManagementPolicy.json"
+ },
+ "StorageAccountSetManagementPolicy_LastAccessTimeBasedBlobActions": {
+ "$ref": "./examples/StorageAccountSetManagementPolicy_LastAccessTimeBasedBlobActions.json"
}
},
"parameters": [
@@ -1979,6 +1982,19 @@
],
"description": "The encryption settings on the storage account."
},
+ "ResourceAccessRule": {
+ "properties": {
+ "tenantId": {
+ "type": "string",
+ "description": "Tenant Id"
+ },
+ "resourceId": {
+ "type": "string",
+ "description": "Resource Id"
+ }
+ },
+ "description": "Resource Access Rule."
+ },
"VirtualNetworkRule": {
"properties": {
"id": {
@@ -2062,6 +2078,13 @@
"default": "AzureServices",
"description": "Specifies whether traffic is bypassed for Logging/Metrics/AzureServices. Possible values are any combination of Logging|Metrics|AzureServices (For example, \"Logging, Metrics\"), or None to bypass none of those traffics."
},
+ "resourceAccessRules": {
+ "type": "array",
+ "items": {
+ "description": "Resource Access Rules.",
+ "$ref": "#/definitions/ResourceAccessRule"
+ }
+ },
"virtualNetworkRules": {
"type": "array",
"items": {
@@ -2267,6 +2290,30 @@
],
"description": "Identity for the resource."
},
+ "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."
+ }
+ }
+ },
"StorageAccountCreateParameters": {
"properties": {
"sku": {
@@ -2292,6 +2339,10 @@
"type": "string",
"description": "Required. Gets or sets the location of the resource. This will be one of the supported and registered Azure Geo Regions (e.g. West US, East US, Southeast Asia, etc.). The geo region of a resource cannot be changed once it is created, but if an identical geo region is specified on update, the request will succeed."
},
+ "extendedLocation": {
+ "$ref": "#/definitions/ExtendedLocation",
+ "description": "Optional. Set the extended location of the resource. If not set, the storage account will be created in Azure main region. Otherwise it will be created in the specified extended location"
+ },
"tags": {
"type": "object",
"additionalProperties": {
@@ -2762,6 +2813,10 @@
"$ref": "#/definitions/Identity",
"description": "The identity of the resource."
},
+ "extendedLocation": {
+ "$ref": "#/definitions/ExtendedLocation",
+ "description": "The extendedLocation of the resource."
+ },
"properties": {
"x-ms-client-flatten": true,
"$ref": "#/definitions/StorageAccountProperties",
@@ -3504,6 +3559,10 @@
"delete": {
"$ref": "#/definitions/DateAfterModification",
"description": "The function to delete the blob"
+ },
+ "enableAutoTierToHotFromCool": {
+ "type": "boolean",
+ "description": "This property enables auto tiering of a blob from cool to hot on a blob access. This property requires tierToCool.daysAfterLastAccessTimeGreaterThan."
}
},
"description": "Management policy action for base blob."
@@ -3524,11 +3583,14 @@
"multipleOf": 1.0,
"minimum": 0,
"description": "Value indicating the age in days after last modification"
+ },
+ "daysAfterLastAccessTimeGreaterThan": {
+ "type": "number",
+ "multipleOf": 1.0,
+ "minimum": 0,
+ "description": "Value indicating the age in days after last blob access. This property can only be used in conjunction with last access time tracking policy"
}
},
- "required": [
- "daysAfterModificationGreaterThan"
- ],
"description": "Object to define the number of days after last modification."
},
"DateAfterCreation": {
diff --git a/specification/storage/resource-manager/readme.go.md b/specification/storage/resource-manager/readme.go.md
index 6ecd43bc6a06..96bcfeb1d9fe 100644
--- a/specification/storage/resource-manager/readme.go.md
+++ b/specification/storage/resource-manager/readme.go.md
@@ -71,7 +71,7 @@ These settings apply only when `--tag=package-2018-07 --go` is specified on the
Please also specify `--go-sdk-folder=`.
``` yaml $(tag) == 'package-2018-07' && $(go)
-output-folder: $(go-sdk-folder)/services/$(namespace)/mgmt/2018-07-01/$(namespace)
+output-folder: $(go-sdk-folder)/services/preview/$(namespace)/mgmt/2018-07-01-preview/$(namespace)
```
### Tag: package-2018-03 and go
diff --git a/specification/storage/resource-manager/readme.python.md b/specification/storage/resource-manager/readme.python.md
index 9c4a6ba3d79f..655dfb68e8b2 100644
--- a/specification/storage/resource-manager/readme.python.md
+++ b/specification/storage/resource-manager/readme.python.md
@@ -17,6 +17,8 @@ azure-arm: true
license-header: MICROSOFT_MIT_NO_VERSION
package-name: azure-mgmt-storage
no-namespace-folders: true
+modelerfour:
+ lenient-model-deduplication: true
```
### Python multi-api
diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/CloudEndpoints_Create.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/CloudEndpoints_Create.json
new file mode 100644
index 000000000000..c7286db17334
--- /dev/null
+++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/CloudEndpoints_Create.json
@@ -0,0 +1,51 @@
+{
+ "parameters": {
+ "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb",
+ "resourceGroupName": "SampleResourceGroup_1",
+ "storageSyncServiceName": "SampleStorageSyncService_1",
+ "syncGroupName": "SampleSyncGroup_1",
+ "cloudEndpointName": "SampleCloudEndpoint_1",
+ "api-version": "2020-09-01",
+ "parameters": {
+ "properties": {
+ "storageAccountResourceId": "/subscriptions/744f4d70-6d17-4921-8970-a765d14f763f/resourceGroups/tminienv59svc/providers/Microsoft.Storage/storageAccounts/tminienv59storage",
+ "azureFileShareName": "cvcloud-afscv-0719-058-a94a1354-a1fd-4e9a-9a50-919fad8c4ba4",
+ "storageAccountTenantId": "\"72f988bf-86f1-41af-91ab-2d7cd011db47\"",
+ "friendlyName": "ankushbsubscriptionmgmtmab"
+ }
+ }
+ },
+ "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": {
+ "backupEnabled": "false",
+ "provisioningState": "Succeeded",
+ "storageAccountResourceId": "/subscriptions/744f4d70-6d17-4921-8970-a765d14f763f/resourceGroups/tminienv59svc/providers/Microsoft.Storage/storageAccounts/tminienv59storage",
+ "azureFileShareName": "cvcloud-afscv-0719-058-a94a1354-a1fd-4e9a-9a50-919fad8c4ba4",
+ "storageAccountTenantId": "\"72f988bf-86f1-41af-91ab-2d7cd011db47\"",
+ "friendlyName": "ankushbsubscriptionmgmtmab",
+ "lastWorkflowId": "storageSyncServices/GATest/workflows/24ba0c4a-348e-419b-8f7a-091d0d9f07a4",
+ "partnershipId": "1|U0VSVkVSQVNTWU5DQ0xJRU5USEZTVjJ8RjhDODcwQTItMkFGNi00NDUyLTgzMDgtRjJCQTZEQjI3RkEwfEdFTkVSSUN8NTJCOERBMkYtNjFFMC00QTFGLThEREUtMzM2OTExRjM2N0ZC",
+ "lastOperationName": "ICreateCloudEndpointWorkflow"
+ },
+ "id": "/subscriptions/52b8da2f-61e0-4a1f-8dde-336911f367fb/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/syncGroups/SampleSyncGroup_1/cloudEndpoints/SampleCloudEndpoint_1",
+ "type": "Microsoft.StorageSync/storageSyncServices/syncGroups/cloudEndpoints"
+ }
+ },
+ "202": {
+ "headers": {
+ "Azure-AsyncOperation": "https://management.azure.com/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncservice_1/workflows/c1d54be7-4738-4898-8212-cc36774314f8/operations/7ce689b2-0eca-48f5-86f0-0b8d6ceef14a?api-version=2020-09-01",
+ "Location": "https://management.azure.com/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncservice_1/workflows/c1d54be7-4738-4898-8212-cc36774314f8/operationresults/7ce689b2-0eca-48f5-86f0-0b8d6ceef14a?api-version=2020-09-01",
+ "Retry-After": "10",
+ "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403",
+ "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730"
+ }
+ }
+ }
+}
diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/CloudEndpoints_Delete.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/CloudEndpoints_Delete.json
new file mode 100644
index 000000000000..b487abd29d5b
--- /dev/null
+++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/CloudEndpoints_Delete.json
@@ -0,0 +1,28 @@
+{
+ "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"
+ }
+ },
+ "202": {
+ "headers": {
+ "Azure-AsyncOperation": "https://management.azure.com/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/workflows/78a71465-77ef-4509-a026-2c0cd8b30208/operations/2d7f573a-7acd-4a3c-9425-fed7d029c69d?api-version=2020-09-01",
+ "Location": "https://management.azure.com/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/workflows/78a71465-77ef-4509-a026-2c0cd8b30208/operationresults/2d7f573a-7acd-4a3c-9425-fed7d029c69d?api-version=2020-09-01",
+ "Retry-After": "10",
+ "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403",
+ "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730"
+ }
+ },
+ "204": {}
+ }
+}
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
new file mode 100644
index 000000000000..aa12f906e412
--- /dev/null
+++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/CloudEndpoints_Get.json
@@ -0,0 +1,33 @@
+{
+ "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
new file mode 100644
index 000000000000..d7ea0c467cb8
--- /dev/null
+++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/CloudEndpoints_ListBySyncGroup.json
@@ -0,0 +1,36 @@
+{
+ "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_PostBackup.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/CloudEndpoints_PostBackup.json
new file mode 100644
index 000000000000..92c3e2894a3d
--- /dev/null
+++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/CloudEndpoints_PostBackup.json
@@ -0,0 +1,34 @@
+{
+ "parameters": {
+ "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb",
+ "resourceGroupName": "SampleResourceGroup_1",
+ "storageSyncServiceName": "SampleStorageSyncService_1",
+ "syncGroupName": "SampleSyncGroup_1",
+ "cloudEndpointName": "SampleCloudEndpoint_1",
+ "parameters": {
+ "azureFileShare": "https://sampleserver.file.core.test-cint.azure-test.net/sampleFileShare"
+ },
+ "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": {
+ "backupMetadata": {
+ "cloudEndpointName": "subscriptions/52b8da2f-61e0-4a1f-8dde-336911f367fb/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/syncGroups/SampleSyncGroup_1/cloudEndpoints/SampleCloudEndpoint_1"
+ }
+ }
+ },
+ "202": {
+ "headers": {
+ "x-ms-location": "https://management.azure.com/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/HfsMabFS1/syncGroups/HfsMabDS1/cloudEndpoints/HfsMabCE1/operationresults/baa40401-b043-4d1b-a80b-cb4e79fa1398?api-version=2020-09-01&resourcetype=PostBackupResourceType&ifxctx3=1847a938-7638-4d1b-943c-96ff2f8a2ec8",
+ "Retry-After": "10",
+ "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403",
+ "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730"
+ }
+ }
+ }
+}
diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/CloudEndpoints_PostRestore.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/CloudEndpoints_PostRestore.json
new file mode 100644
index 000000000000..cb39f0bb3622
--- /dev/null
+++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/CloudEndpoints_PostRestore.json
@@ -0,0 +1,49 @@
+{
+ "parameters": {
+ "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb",
+ "resourceGroupName": "SampleResourceGroup_1",
+ "storageSyncServiceName": "SampleStorageSyncService_1",
+ "syncGroupName": "SampleSyncGroup_1",
+ "cloudEndpointName": "SampleCloudEndpoint_1",
+ "parameters": {
+ "azureFileShareUri": "https://hfsazbackupdevintncus2.file.core.test-cint.azure-test.net/sampleFileShare",
+ "sourceAzureFileShareUri": "https://hfsazbackupdevintncus2.file.core.test-cint.azure-test.net/sampleFileShare",
+ "status": "Succeeded",
+ "restoreFileSpec": [
+ {
+ "path": "text1.txt",
+ "isdir": false
+ },
+ {
+ "path": "MyDir",
+ "isdir": true
+ },
+ {
+ "path": "MyDir/SubDir",
+ "isdir": false
+ },
+ {
+ "path": "MyDir/SubDir/File1.pdf",
+ "isdir": false
+ }
+ ]
+ },
+ "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"
+ }
+ },
+ "202": {
+ "headers": {
+ "x-ms-location": "https: //management.azure.com/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/HfsMabFS1/syncGroups/HfsMabDS1/cloudEndpoints/HfsMabCE1/operationresults/d67cfb91-1b13-4710-8226-83467bb5b66d?api-version=2020-09-01&resourcetype=preBackupResourceType&ifxctx3=005909ad-d156-4514-a26e-dd1cc566db64",
+ "Retry-After": "10",
+ "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403",
+ "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730"
+ }
+ }
+ }
+}
diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/CloudEndpoints_PreBackup.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/CloudEndpoints_PreBackup.json
new file mode 100644
index 000000000000..8b480d7a4227
--- /dev/null
+++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/CloudEndpoints_PreBackup.json
@@ -0,0 +1,29 @@
+{
+ "parameters": {
+ "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb",
+ "resourceGroupName": "SampleResourceGroup_1",
+ "storageSyncServiceName": "SampleStorageSyncService_1",
+ "syncGroupName": "SampleSyncGroup_1",
+ "cloudEndpointName": "SampleCloudEndpoint_1",
+ "api-version": "2020-09-01",
+ "parameters": {
+ "azureFileShare": "https://sampleserver.file.core.test-cint.azure-test.net/sampleFileShare"
+ }
+ },
+ "responses": {
+ "200": {
+ "headers": {
+ "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403",
+ "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730"
+ }
+ },
+ "202": {
+ "headers": {
+ "x-ms-location": "https://management.azure.com/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/HfsMabFS1/syncGroups/HfsMabDS1/cloudEndpoints/HfsMabCE1/operationresults/d67cfb91-1b13-4710-8226-83467bb5b66d?api-version=2020-09-01&resourcetype=preBackupResourceType&ifxctx3=005909ad-d156-4514-a26e-dd1cc566db64",
+ "Retry-After": "10",
+ "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403",
+ "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730"
+ }
+ }
+ }
+}
diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/CloudEndpoints_PreRestore.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/CloudEndpoints_PreRestore.json
new file mode 100644
index 000000000000..91062e6f90ad
--- /dev/null
+++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/CloudEndpoints_PreRestore.json
@@ -0,0 +1,47 @@
+{
+ "parameters": {
+ "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb",
+ "resourceGroupName": "SampleResourceGroup_1",
+ "storageSyncServiceName": "SampleStorageSyncService_1",
+ "syncGroupName": "SampleSyncGroup_1",
+ "cloudEndpointName": "SampleCloudEndpoint_1",
+ "api-version": "2020-09-01",
+ "parameters": {
+ "azureFileShareUri": "https://hfsazbackupdevintncus2.file.core.test-cint.azure-test.net/sampleFileShare",
+ "restoreFileSpec": [
+ {
+ "path": "text1.txt",
+ "isdir": false
+ },
+ {
+ "path": "MyDir",
+ "isdir": true
+ },
+ {
+ "path": "MyDir/SubDir",
+ "isdir": false
+ },
+ {
+ "path": "MyDir/SubDir/File1.pdf",
+ "isdir": false
+ }
+ ]
+ }
+ },
+ "responses": {
+ "200": {
+ "headers": {
+ "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403",
+ "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730"
+ }
+ },
+ "202": {
+ "headers": {
+ "x-ms-location": "https: //management.azure.com/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/HfsMabFS1/syncGroups/HfsMabDS1/cloudEndpoints/HfsMabCE1/operationresults/d67cfb91-1b13-4710-8226-83467bb5b66d?api-version=2020-09-01&resourcetype=preBackupResourceType&ifxctx3=005909ad-d156-4514-a26e-dd1cc566db64",
+ "Retry-After": "10",
+ "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403",
+ "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730"
+ }
+ }
+ }
+}
diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/CloudEndpoints_RestoreHeatbeat.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/CloudEndpoints_RestoreHeatbeat.json
new file mode 100644
index 000000000000..4f8c0fa23156
--- /dev/null
+++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/CloudEndpoints_RestoreHeatbeat.json
@@ -0,0 +1,18 @@
+{
+ "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"
+ }
+ }
+ }
+}
diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/CloudEndpoints_TriggerChangeDetection.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/CloudEndpoints_TriggerChangeDetection.json
new file mode 100644
index 000000000000..57a15665b0a5
--- /dev/null
+++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/CloudEndpoints_TriggerChangeDetection.json
@@ -0,0 +1,30 @@
+{
+ "parameters": {
+ "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb",
+ "resourceGroupName": "SampleResourceGroup_1",
+ "storageSyncServiceName": "SampleStorageSyncService_1",
+ "syncGroupName": "SampleSyncGroup_1",
+ "cloudEndpointName": "SampleCloudEndpoint_1",
+ "parameters": {
+ "directoryPath": "NewDirectory",
+ "changeDetectionMode": "Recursive"
+ },
+ "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"
+ }
+ },
+ "202": {
+ "headers": {
+ "x-ms-location": "https: //management.azure.com/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/HfsMabFS1/syncGroups/HfsMabDS1/cloudEndpoints/HfsMabCE1/operationresults/d67cfb91-1b13-4710-8226-83467bb5b66d?api-version=2020-09-01&resourcetype=preBackupResourceType&ifxctx3=005909ad-d156-4514-a26e-dd1cc566db64",
+ "Retry-After": "10",
+ "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403",
+ "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730"
+ }
+ }
+ }
+}
diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/OperationStatus_Get.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/OperationStatus_Get.json
new file mode 100644
index 000000000000..a06342086b23
--- /dev/null
+++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/OperationStatus_Get.json
@@ -0,0 +1,25 @@
+{
+ "parameters": {
+ "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb",
+ "resourceGroupName": "SampleResourceGroup_1",
+ "locationName": "westus",
+ "workflowId": "828219ea-083e-48b5-89ea-8fd9991b2e75",
+ "operationId": "14b50e24-f68d-4b29-a882-38be9dfb8bd1",
+ "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": "14b50e24-f68d-4b29-a882-38be9dfb8bd1",
+ "status": "Succeeded",
+ "startTime": "2019-05-09T23:53:21.7328715Z",
+ "endTime": "2019-05-09T23:53:23.3735483Z",
+ "error": null
+ }
+ }
+ }
+}
diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/Operations_List.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/Operations_List.json
new file mode 100644
index 000000000000..7925e43aefc6
--- /dev/null
+++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/Operations_List.json
@@ -0,0 +1,858 @@
+{
+ "parameters": {
+ "api-version": "2020-09-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "name": "microsoft.storagesync/register/action",
+ "display": {
+ "provider": "microsoft.storagesync",
+ "resource": "Storage Sync Provider",
+ "operation": "Registers the Storage Sync Provider",
+ "description": "Registers the subscription for the Storage Sync Provider"
+ },
+ "origin": "User"
+ },
+ {
+ "name": "microsoft.storagesync/unregister/action",
+ "display": {
+ "provider": "microsoft.storagesync",
+ "resource": "Storage Sync Provider",
+ "operation": "Unregisters the Storage Sync Provider",
+ "description": "Unregisters the subscription for the Storage Sync Provider"
+ },
+ "origin": "User"
+ },
+ {
+ "name": "microsoft.storagesync/operations/read",
+ "display": {
+ "provider": "microsoft.storagesync",
+ "resource": "Supported Operations",
+ "operation": "Gets the Supported Operations",
+ "description": "Gets a list of the Supported Operations"
+ },
+ "origin": "User"
+ },
+ {
+ "name": "microsoft.storagesync/storageSyncServices/read",
+ "display": {
+ "provider": "microsoft.storagesync",
+ "resource": "Storage Sync Services",
+ "operation": "Read Storage Sync Services",
+ "description": "Read any Storage Sync Services"
+ },
+ "origin": "User"
+ },
+ {
+ "name": "microsoft.storagesync/storageSyncServices/write",
+ "display": {
+ "provider": "microsoft.storagesync",
+ "resource": "Storage Sync Services",
+ "operation": "Create or Update Storage Sync Services",
+ "description": "Create or Update any Storage Sync Services"
+ },
+ "origin": "User"
+ },
+ {
+ "name": "microsoft.storagesync/storageSyncServices/delete",
+ "display": {
+ "provider": "microsoft.storagesync",
+ "resource": "Storage Sync Services",
+ "operation": "Delete Storage Sync Services",
+ "description": "Delete any Storage Sync Services"
+ },
+ "origin": "User"
+ },
+ {
+ "name": "microsoft.storagesync/storageSyncServices/providers/Microsoft.Insights/metricDefinitions/read",
+ "display": {
+ "provider": "microsoft.storagesync",
+ "resource": "Storage Sync Metrics",
+ "operation": "Read Storage Sync Services metric definitions",
+ "description": "Gets the available metrics for Storage Sync Services"
+ },
+ "origin": "System",
+ "properties": {
+ "serviceSpecification": {
+ "metricSpecifications": [
+ {
+ "name": "ServerSyncSessionResult",
+ "displayName": "Sync Session Result",
+ "displayDescription": "Metric that logs a value of 1 each time the Server Endpoint successfully completes a Sync Session with the Cloud Endpoint",
+ "unit": "Count",
+ "aggregationType": "Average",
+ "fillGapWithZero": false,
+ "dimensions": [
+ {
+ "name": "SyncGroupName",
+ "displayName": "Sync Group Name",
+ "toBeExportedForShoebox": true
+ },
+ {
+ "name": "ServerEndpointName",
+ "displayName": "Server Endpoint Name",
+ "toBeExportedForShoebox": true
+ },
+ {
+ "name": "SyncDirection",
+ "displayName": "Sync Direction",
+ "toBeExportedForShoebox": true
+ }
+ ]
+ },
+ {
+ "name": "StorageSyncSyncSessionAppliedFilesCount",
+ "displayName": "Files Synced",
+ "displayDescription": "Count of Files synced",
+ "unit": "Count",
+ "aggregationType": "Total",
+ "fillGapWithZero": false,
+ "dimensions": [
+ {
+ "name": "SyncGroupName",
+ "displayName": "Sync Group Name",
+ "toBeExportedForShoebox": true
+ },
+ {
+ "name": "ServerEndpointName",
+ "displayName": "Server Endpoint Name",
+ "toBeExportedForShoebox": true
+ },
+ {
+ "name": "SyncDirection",
+ "displayName": "Sync Direction",
+ "toBeExportedForShoebox": true
+ }
+ ]
+ },
+ {
+ "name": "StorageSyncSyncSessionPerItemErrorsCount",
+ "displayName": "Files not syncing",
+ "displayDescription": "Count of files failed to sync",
+ "unit": "Count",
+ "aggregationType": "Total",
+ "fillGapWithZero": false,
+ "dimensions": [
+ {
+ "name": "SyncGroupName",
+ "displayName": "Sync Group Name",
+ "toBeExportedForShoebox": true
+ },
+ {
+ "name": "ServerEndpointName",
+ "displayName": "Server Endpoint Name",
+ "toBeExportedForShoebox": true
+ },
+ {
+ "name": "SyncDirection",
+ "displayName": "Sync Direction",
+ "toBeExportedForShoebox": true
+ }
+ ]
+ },
+ {
+ "name": "StorageSyncBatchTransferredFileBytes",
+ "displayName": "Bytes synced",
+ "displayDescription": "Total file size transferred for Sync Sessions",
+ "unit": "Bytes",
+ "aggregationType": "Total",
+ "fillGapWithZero": false,
+ "dimensions": [
+ {
+ "name": "SyncGroupName",
+ "displayName": "Sync Group Name",
+ "toBeExportedForShoebox": true
+ },
+ {
+ "name": "ServerEndpointName",
+ "displayName": "Server Endpoint Name",
+ "toBeExportedForShoebox": true
+ },
+ {
+ "name": "SyncDirection",
+ "displayName": "Sync Direction",
+ "toBeExportedForShoebox": true
+ }
+ ]
+ },
+ {
+ "name": "StorageSyncServerHeartbeat",
+ "displayName": "Server Online Status",
+ "displayDescription": "Metric that logs a value of 1 each time the resigtered server successfully records a heartbeat with the Cloud Endpoint",
+ "unit": "Count",
+ "aggregationType": "Maximum",
+ "fillGapWithZero": true,
+ "dimensions": [
+ {
+ "name": "ServerName",
+ "displayName": "Server Name",
+ "toBeExportedForShoebox": true
+ }
+ ]
+ },
+ {
+ "name": "StorageSyncRecallIOTotalSizeBytes",
+ "displayName": "Cloud tiering recall",
+ "displayDescription": "Total size of data recalled by the server",
+ "unit": "Bytes",
+ "aggregationType": "Total",
+ "fillGapWithZero": false,
+ "dimensions": [
+ {
+ "name": "ServerName",
+ "displayName": "Server Name",
+ "toBeExportedForShoebox": true
+ }
+ ]
+ },
+ {
+ "name": "StorageSyncRecalledTotalNetworkBytes",
+ "displayName": "Cloud tiering recall size",
+ "displayDescription": "Size of data recalled",
+ "unit": "Bytes",
+ "aggregationType": "Total",
+ "fillGapWithZero": false,
+ "dimensions": [
+ {
+ "name": "SyncGroupName",
+ "displayName": "Sync Group Name",
+ "toBeExportedForShoebox": true
+ },
+ {
+ "name": "ServerName",
+ "displayName": "Server Name",
+ "toBeExportedForShoebox": true
+ }
+ ]
+ },
+ {
+ "name": "StorageSyncRecallThroughputBytesPerSecond",
+ "displayName": "Cloud tiering recall throughput",
+ "displayDescription": "Size of data recall throughput",
+ "unit": "BytesPerSecond",
+ "aggregationType": "Average",
+ "fillGapWithZero": false,
+ "dimensions": [
+ {
+ "name": "SyncGroupName",
+ "displayName": "Sync Group Name",
+ "toBeExportedForShoebox": true
+ },
+ {
+ "name": "ServerName",
+ "displayName": "Server Name",
+ "toBeExportedForShoebox": true
+ }
+ ]
+ },
+ {
+ "name": "StorageSyncRecalledNetworkBytesByApplication",
+ "displayName": "Cloud tiering recall size by application",
+ "displayDescription": "Size of data recalled by application",
+ "unit": "Bytes",
+ "aggregationType": "Total",
+ "fillGapWithZero": false,
+ "dimensions": [
+ {
+ "name": "SyncGroupName",
+ "displayName": "Sync Group Name",
+ "toBeExportedForShoebox": true
+ },
+ {
+ "name": "ServerName",
+ "displayName": "Server Name",
+ "toBeExportedForShoebox": true
+ },
+ {
+ "name": "ApplicationName",
+ "displayName": "Application Name",
+ "toBeExportedForShoebox": true
+ }
+ ]
+ }
+ ]
+ }
+ }
+ },
+ {
+ "name": "microsoft.storagesync/storageSyncServices/privateLinkResources/read",
+ "display": {
+ "provider": "microsoft.storagesync",
+ "resource": "Private Link Resources",
+ "operation": "Read Private Link Resources",
+ "description": "Read any Private Link Resources"
+ },
+ "origin": "User"
+ },
+ {
+ "name": "microsoft.storagesync/storageSyncServices/privateEndpointConnections/read",
+ "display": {
+ "provider": "microsoft.storagesync",
+ "resource": "Private Endpoint Connections",
+ "operation": "Read Private Endpoint Connections",
+ "description": "Read any Private Endpoint Connections"
+ },
+ "origin": "User"
+ },
+ {
+ "name": "microsoft.storagesync/storageSyncServices/privateEndpointConnections/write",
+ "display": {
+ "provider": "microsoft.storagesync",
+ "resource": "Private Endpoint Connections",
+ "operation": "Create or Update Private Endpoint Connections",
+ "description": "Create or Update any Private Endpoint Connections"
+ },
+ "origin": "User"
+ },
+ {
+ "name": "microsoft.storagesync/storageSyncServices/privateEndpointConnections/delete",
+ "display": {
+ "provider": "microsoft.storagesync",
+ "resource": "Private Endpoint Connections",
+ "operation": "Delete Private Endpoint Connections",
+ "description": "Delete any Private Endpoint Connections"
+ },
+ "origin": "User"
+ },
+ {
+ "name": "microsoft.storagesync/storageSyncServices/privateEndpointConnectionProxies/validate/action",
+ "display": {
+ "provider": "microsoft.storagesync",
+ "resource": "Private Endpoint ConnectionProxies",
+ "operation": "Validate Private Endpoint ConnectionProxies",
+ "description": "Validate any Private Endpoint ConnectionProxies"
+ },
+ "origin": "User"
+ },
+ {
+ "name": "microsoft.storagesync/storageSyncServices/privateEndpointConnectionProxies/read",
+ "display": {
+ "provider": "microsoft.storagesync",
+ "resource": "Private Endpoint ConnectionProxies",
+ "operation": "Read Private Endpoint ConnectionProxies",
+ "description": "Read any Private Endpoint ConnectionProxies"
+ },
+ "origin": "User"
+ },
+ {
+ "name": "microsoft.storagesync/storageSyncServices/privateEndpointConnectionProxies/write",
+ "display": {
+ "provider": "microsoft.storagesync",
+ "resource": "Private Endpoint ConnectionProxies",
+ "operation": "Create or Update Private Endpoint ConnectionProxies",
+ "description": "Create or Update any Private Endpoint ConnectionProxies"
+ },
+ "origin": "User"
+ },
+ {
+ "name": "microsoft.storagesync/storageSyncServices/privateEndpointConnectionProxies/delete",
+ "display": {
+ "provider": "microsoft.storagesync",
+ "resource": "Private Endpoint ConnectionProxies",
+ "operation": "Delete Private Endpoint ConnectionProxies",
+ "description": "Delete any Private Endpoint ConnectionProxies"
+ },
+ "origin": "User"
+ },
+ {
+ "name": "microsoft.storagesync/storageSyncServices/syncGroups/read",
+ "display": {
+ "provider": "microsoft.storagesync",
+ "resource": "Sync Groups",
+ "operation": "Read Sync Groups",
+ "description": "Read any Sync Groups"
+ },
+ "origin": "User"
+ },
+ {
+ "name": "microsoft.storagesync/storageSyncServices/syncGroups/write",
+ "display": {
+ "provider": "microsoft.storagesync",
+ "resource": "Sync Groups",
+ "operation": "Create or Update Sync Groups",
+ "description": "Create or Update any Sync Groups"
+ },
+ "origin": "User"
+ },
+ {
+ "name": "microsoft.storagesync/storageSyncServices/syncGroups/delete",
+ "display": {
+ "provider": "microsoft.storagesync",
+ "resource": "Sync Groups",
+ "operation": "Delete Sync Groups",
+ "description": "Delete any Sync Groups"
+ },
+ "origin": "User"
+ },
+ {
+ "name": "microsoft.storagesync/storageSyncServices/syncGroups/providers/Microsoft.Insights/metricDefinitions/read",
+ "display": {
+ "provider": "microsoft.storagesync",
+ "resource": "Sync Group Metrics",
+ "operation": "Read Sync Groups metric definitions",
+ "description": "Gets the available metrics for Sync Groups"
+ },
+ "origin": "System",
+ "properties": {
+ "serviceSpecification": {
+ "metricSpecifications": [
+ {
+ "name": "SyncGroupSyncSessionAppliedFilesCount",
+ "displayName": "Files Synced",
+ "displayDescription": "Count of Files synced",
+ "unit": "Count",
+ "aggregationType": "Total",
+ "fillGapWithZero": false,
+ "dimensions": [
+ {
+ "name": "SyncGroupName",
+ "displayName": "Sync Group Name",
+ "toBeExportedForShoebox": true
+ },
+ {
+ "name": "ServerEndpointName",
+ "displayName": "Server Endpoint Name",
+ "toBeExportedForShoebox": true
+ },
+ {
+ "name": "SyncDirection",
+ "displayName": "Sync Direction",
+ "toBeExportedForShoebox": true
+ }
+ ]
+ },
+ {
+ "name": "SyncGroupSyncSessionPerItemErrorsCount",
+ "displayName": "Files not syncing",
+ "displayDescription": "Count of files failed to sync",
+ "unit": "Count",
+ "aggregationType": "Total",
+ "fillGapWithZero": false,
+ "dimensions": [
+ {
+ "name": "SyncGroupName",
+ "displayName": "Sync Group Name",
+ "toBeExportedForShoebox": true
+ },
+ {
+ "name": "ServerEndpointName",
+ "displayName": "Server Endpoint Name",
+ "toBeExportedForShoebox": true
+ },
+ {
+ "name": "SyncDirection",
+ "displayName": "Sync Direction",
+ "toBeExportedForShoebox": true
+ }
+ ]
+ },
+ {
+ "name": "SyncGroupBatchTransferredFileBytes",
+ "displayName": "Bytes synced",
+ "displayDescription": "Total file size transferred for Sync Sessions",
+ "unit": "Bytes",
+ "aggregationType": "Total",
+ "fillGapWithZero": false,
+ "dimensions": [
+ {
+ "name": "SyncGroupName",
+ "displayName": "Sync Group Name",
+ "toBeExportedForShoebox": true
+ },
+ {
+ "name": "ServerEndpointName",
+ "displayName": "Server Endpoint Name",
+ "toBeExportedForShoebox": true
+ },
+ {
+ "name": "SyncDirection",
+ "displayName": "Sync Direction",
+ "toBeExportedForShoebox": true
+ }
+ ]
+ }
+ ]
+ }
+ }
+ },
+ {
+ "name": "microsoft.storagesync/storageSyncServices/syncGroups/cloudEndpoints/read",
+ "display": {
+ "provider": "microsoft.storagesync",
+ "resource": "Cloud Endpoints",
+ "operation": "Read Cloud Endpoints",
+ "description": "Read any Cloud Endpoints"
+ },
+ "origin": "User"
+ },
+ {
+ "name": "microsoft.storagesync/storageSyncServices/syncGroups/cloudEndpoints/write",
+ "display": {
+ "provider": "microsoft.storagesync",
+ "resource": "Cloud Endpoints",
+ "operation": "Create or Update Cloud Endpoints",
+ "description": "Create or Update any Cloud Endpoints"
+ },
+ "origin": "User"
+ },
+ {
+ "name": "microsoft.storagesync/storageSyncServices/syncGroups/cloudEndpoints/delete",
+ "display": {
+ "provider": "microsoft.storagesync",
+ "resource": "Cloud Endpoints",
+ "operation": "Delete Cloud Endpoints",
+ "description": "Delete any Cloud Endpoints"
+ },
+ "origin": "User"
+ },
+ {
+ "name": "microsoft.storagesync/storageSyncServices/syncGroups/cloudEndpoints/prebackup/action",
+ "display": {
+ "provider": "microsoft.storagesync",
+ "resource": "Cloud Endpoints",
+ "operation": "prebackup",
+ "description": "Call this action before backup"
+ },
+ "origin": "User"
+ },
+ {
+ "name": "microsoft.storagesync/storageSyncServices/syncGroups/cloudEndpoints/postbackup/action",
+ "display": {
+ "provider": "microsoft.storagesync",
+ "resource": "Cloud Endpoints",
+ "operation": "postbackup",
+ "description": "Call this action after backup"
+ },
+ "origin": "User"
+ },
+ {
+ "name": "microsoft.storagesync/storageSyncServices/syncGroups/cloudEndpoints/prerestore/action",
+ "display": {
+ "provider": "microsoft.storagesync",
+ "resource": "Cloud Endpoints",
+ "operation": "prerestore",
+ "description": "Call this action before restore"
+ },
+ "origin": "User"
+ },
+ {
+ "name": "microsoft.storagesync/storageSyncServices/syncGroups/cloudEndpoints/postrestore/action",
+ "display": {
+ "provider": "microsoft.storagesync",
+ "resource": "Cloud Endpoints",
+ "operation": "postrestore",
+ "description": "Call this action after restore"
+ },
+ "origin": "User"
+ },
+ {
+ "name": "microsoft.storagesync/storageSyncServices/syncGroups/cloudEndpoints/restoreheartbeat/action",
+ "display": {
+ "provider": "microsoft.storagesync",
+ "resource": "Cloud Endpoints",
+ "operation": "restoreheartbeat",
+ "description": "Restore heartbeat"
+ },
+ "origin": "User"
+ },
+ {
+ "name": "microsoft.storagesync/storageSyncServices/syncGroups/cloudEndpoints/operationresults/read",
+ "display": {
+ "provider": "microsoft.storagesync",
+ "resource": "Cloud Endpoints",
+ "operation": "Read cloudEndpoints/operationresults",
+ "description": "Gets the status of an asynchronous backup/restore operation"
+ },
+ "origin": "User"
+ },
+ {
+ "name": "microsoft.storagesync/storageSyncServices/syncGroups/cloudEndpoints/triggerChangeDetection/action",
+ "display": {
+ "provider": "microsoft.storagesync",
+ "resource": "Cloud Endpoints",
+ "operation": "triggerChangeDetection",
+ "description": "Call this action to trigger detection of changes on a cloud endpoint's file share"
+ },
+ "origin": "User"
+ },
+ {
+ "name": "microsoft.storagesync/storageSyncServices/syncGroups/serverEndpoints/read",
+ "display": {
+ "provider": "microsoft.storagesync",
+ "resource": "Server Endpoints",
+ "operation": "Read Server Endpoints",
+ "description": "Read any Server Endpoints"
+ },
+ "origin": "User"
+ },
+ {
+ "name": "microsoft.storagesync/storageSyncServices/syncGroups/serverEndpoints/write",
+ "display": {
+ "provider": "microsoft.storagesync",
+ "resource": "Server Endpoints",
+ "operation": "Create or Update Server Endpoints",
+ "description": "Create or Update any Server Endpoints"
+ },
+ "origin": "User"
+ },
+ {
+ "name": "microsoft.storagesync/storageSyncServices/syncGroups/serverEndpoints/delete",
+ "display": {
+ "provider": "microsoft.storagesync",
+ "resource": "Server Endpoints",
+ "operation": "Delete Server Endpoints",
+ "description": "Delete any Server Endpoints"
+ },
+ "origin": "User"
+ },
+ {
+ "name": "microsoft.storagesync/storageSyncServices/syncGroups/serverEndpoints/recallAction/action",
+ "display": {
+ "provider": "microsoft.storagesync",
+ "resource": "Server Endpoints",
+ "operation": "recallAction",
+ "description": "Call this action to recall files to a server"
+ },
+ "origin": "User"
+ },
+ {
+ "name": "microsoft.storagesync/storageSyncServices/syncGroups/serverEndpoints/providers/Microsoft.Insights/metricDefinitions/read",
+ "display": {
+ "provider": "microsoft.storagesync",
+ "resource": "Server Endpoint Metrics",
+ "operation": "Read Server Endpoints metric definitions",
+ "description": "Gets the available metrics for Server Endpoints"
+ },
+ "origin": "System",
+ "properties": {
+ "serviceSpecification": {
+ "metricSpecifications": [
+ {
+ "name": "ServerEndpointSyncSessionAppliedFilesCount",
+ "displayName": "Files Synced",
+ "displayDescription": "Count of Files synced",
+ "unit": "Count",
+ "aggregationType": "Total",
+ "fillGapWithZero": false,
+ "dimensions": [
+ {
+ "name": "ServerEndpointName",
+ "displayName": "Server Endpoint Name",
+ "toBeExportedForShoebox": true
+ },
+ {
+ "name": "SyncDirection",
+ "displayName": "Sync Direction",
+ "toBeExportedForShoebox": true
+ }
+ ]
+ },
+ {
+ "name": "ServerEndpointSyncSessionPerItemErrorsCount",
+ "displayName": "Files not syncing",
+ "displayDescription": "Count of files failed to sync",
+ "unit": "Count",
+ "aggregationType": "Total",
+ "fillGapWithZero": false,
+ "dimensions": [
+ {
+ "name": "ServerEndpointName",
+ "displayName": "Server Endpoint Name",
+ "toBeExportedForShoebox": true
+ },
+ {
+ "name": "SyncDirection",
+ "displayName": "Sync Direction",
+ "toBeExportedForShoebox": true
+ }
+ ]
+ },
+ {
+ "name": "ServerEndpointBatchTransferredFileBytes",
+ "displayName": "Bytes synced",
+ "displayDescription": "Total file size transferred for Sync Sessions",
+ "unit": "Bytes",
+ "aggregationType": "Total",
+ "fillGapWithZero": false,
+ "dimensions": [
+ {
+ "name": "ServerEndpointName",
+ "displayName": "Server Endpoint Name",
+ "toBeExportedForShoebox": true
+ },
+ {
+ "name": "SyncDirection",
+ "displayName": "Sync Direction",
+ "toBeExportedForShoebox": true
+ }
+ ]
+ }
+ ]
+ }
+ }
+ },
+ {
+ "name": "microsoft.storagesync/storageSyncServices/registeredServers/read",
+ "display": {
+ "provider": "microsoft.storagesync",
+ "resource": "Registered Server",
+ "operation": "Read Registered Server",
+ "description": "Read any Registered Server"
+ },
+ "origin": "User"
+ },
+ {
+ "name": "microsoft.storagesync/storageSyncServices/registeredServers/write",
+ "display": {
+ "provider": "microsoft.storagesync",
+ "resource": "Registered Server",
+ "operation": "Create or Update Registered Server",
+ "description": "Create or Update any Registered Server"
+ },
+ "origin": "User"
+ },
+ {
+ "name": "microsoft.storagesync/storageSyncServices/registeredServers/delete",
+ "display": {
+ "provider": "microsoft.storagesync",
+ "resource": "Registered Server",
+ "operation": "Delete Registered Server",
+ "description": "Delete any Registered Server"
+ },
+ "origin": "User"
+ },
+ {
+ "name": "microsoft.storagesync/storageSyncServices/registeredServers/providers/Microsoft.Insights/metricDefinitions/read",
+ "display": {
+ "provider": "microsoft.storagesync",
+ "resource": "Registered Server Metrics",
+ "operation": "Read Registered Server metric definitions",
+ "description": "Gets the available metrics for Registered Server"
+ },
+ "origin": "System",
+ "properties": {
+ "serviceSpecification": {
+ "metricSpecifications": [
+ {
+ "name": "ServerHeartbeat",
+ "displayName": "Server Online Status",
+ "displayDescription": "Metric that logs a value of 1 each time the resigtered server successfully records a heartbeat with the Cloud Endpoint",
+ "unit": "Count",
+ "aggregationType": "Maximum",
+ "fillGapWithZero": false,
+ "dimensions": [
+ {
+ "name": "ServerResourceId",
+ "displayName": "Registered Server Id",
+ "toBeExportedForShoebox": true
+ },
+ {
+ "name": "ServerName",
+ "displayName": "Server Name",
+ "toBeExportedForShoebox": true
+ }
+ ]
+ },
+ {
+ "name": "ServerRecallIOTotalSizeBytes",
+ "displayName": "Cloud tiering recall",
+ "displayDescription": "Total size of data recalled by the server",
+ "unit": "Bytes",
+ "aggregationType": "Total",
+ "fillGapWithZero": false,
+ "dimensions": [
+ {
+ "name": "ServerResourceId",
+ "displayName": "Registered Server Id",
+ "toBeExportedForShoebox": true
+ },
+ {
+ "name": "ServerName",
+ "displayName": "Server Name",
+ "toBeExportedForShoebox": true
+ }
+ ]
+ }
+ ]
+ }
+ }
+ },
+ {
+ "name": "microsoft.storagesync/storageSyncServices/workflows/read",
+ "display": {
+ "provider": "microsoft.storagesync",
+ "resource": "Workflow",
+ "operation": "Read Workflows",
+ "description": "Read Workflows"
+ },
+ "origin": "User"
+ },
+ {
+ "name": "microsoft.storagesync/storageSyncServices/workflows/operationresults/read",
+ "display": {
+ "provider": "microsoft.storagesync",
+ "resource": "Workflow",
+ "operation": "Read workflows/operationresults",
+ "description": "Gets the status of an asynchronous operation"
+ },
+ "origin": "User"
+ },
+ {
+ "name": "microsoft.storagesync/storageSyncServices/workflows/operations/read",
+ "display": {
+ "provider": "microsoft.storagesync",
+ "resource": "Workflow",
+ "operation": "Read workflows/operations",
+ "description": "Gets the status of an asynchronous operation"
+ },
+ "origin": "User"
+ },
+ {
+ "name": "microsoft.storagesync/locations/checkNameAvailability/action",
+ "display": {
+ "provider": "microsoft.storagesync",
+ "resource": "Name Availability",
+ "operation": "Check Name Availability",
+ "description": "Checks that storage sync service name is valid and is not in use."
+ },
+ "origin": "User"
+ },
+ {
+ "name": "microsoft.storagesync/locations/workflows/operations/read",
+ "display": {
+ "provider": "microsoft.storagesync",
+ "resource": "Workflow",
+ "operation": "Read locations/workflows/operations",
+ "description": "Gets the status of an asynchronous operation"
+ },
+ "origin": "User"
+ },
+ {
+ "name": "microsoft.storagesync/locations/operationresults/read",
+ "display": {
+ "provider": "microsoft.storagesync",
+ "resource": "operationresults",
+ "operation": "Read locations/operationresults",
+ "description": "Gets the result for an asynchronous operation"
+ },
+ "origin": "User"
+ },
+ {
+ "name": "microsoft.storagesync/locations/operations/read",
+ "display": {
+ "provider": "microsoft.storagesync",
+ "resource": "operations",
+ "operation": "Read locations/operations",
+ "description": "Gets the status for an azure asynchronous operation"
+ },
+ "origin": "User"
+ }
+ ],
+ "nextLink": ""
+ }
+ }
+ }
+}
diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/PrivateEndpointConnections_Create.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/PrivateEndpointConnections_Create.json
new file mode 100644
index 000000000000..9c1a989f3e26
--- /dev/null
+++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/PrivateEndpointConnections_Create.json
@@ -0,0 +1,46 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "res7687",
+ "storageSyncServiceName": "sss2527",
+ "privateEndpointConnectionName": "{privateEndpointConnectionName}",
+ "api-version": "2020-09-01",
+ "monitor": "true",
+ "properties": {
+ "properties": {
+ "privateLinkServiceConnectionState": {
+ "status": "Approved",
+ "description": "Auto-Approved"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/res7231/providers/Microsoft.StorageSync/storageSyncServices/sss2527/privateEndpointConnections/{privateEndpointConnectionName}",
+ "name": "{privateEndpointConnectionName}",
+ "type": "Microsoft.StorageSync/storageSyncServices/privateEndpointConnections",
+ "properties": {
+ "provisioningState": "Succeeded",
+ "privateEndpoint": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/res7231/providers/Microsoft.Network/privateEndpoints/petest01"
+ },
+ "privateLinkServiceConnectionState": {
+ "status": "Approved",
+ "description": "Auto-Approved"
+ }
+ }
+ }
+ },
+ "202": {
+ "headers": {
+ "Azure-AsyncOperation": "https://management.azure.com/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/workflows/78a71465-77ef-4509-a026-2c0cd8b30208/operations/2d7f573a-7acd-4a3c-9425-fed7d029c69d?api-version=2020-09-01",
+ "Location": "https://management.azure.com/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/workflows/78a71465-77ef-4509-a026-2c0cd8b30208/operationresults/2d7f573a-7acd-4a3c-9425-fed7d029c69d?api-version=2020-09-01",
+ "Retry-After": "10",
+ "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403",
+ "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730"
+ }
+ }
+ }
+}
diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/PrivateEndpointConnections_Delete.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/PrivateEndpointConnections_Delete.json
new file mode 100644
index 000000000000..c6410fa5f083
--- /dev/null
+++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/PrivateEndpointConnections_Delete.json
@@ -0,0 +1,23 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "res6977",
+ "storageSyncServiceName": "sss2527",
+ "privateEndpointConnectionName": "{privateEndpointConnectionName}",
+ "api-version": "2020-09-01",
+ "monitor": "true"
+ },
+ "responses": {
+ "200": {},
+ "202": {
+ "headers": {
+ "Azure-AsyncOperation": "https://management.azure.com/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/workflows/78a71465-77ef-4509-a026-2c0cd8b30208/operations/2d7f573a-7acd-4a3c-9425-fed7d029c69d?api-version=2020-09-01",
+ "Location": "https://management.azure.com/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/workflows/78a71465-77ef-4509-a026-2c0cd8b30208/operationresults/2d7f573a-7acd-4a3c-9425-fed7d029c69d?api-version=2020-09-01",
+ "Retry-After": "10",
+ "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403",
+ "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730"
+ }
+ },
+ "204": {}
+ }
+}
diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/PrivateEndpointConnections_Get.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/PrivateEndpointConnections_Get.json
new file mode 100644
index 000000000000..07048c36b7dc
--- /dev/null
+++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/PrivateEndpointConnections_Get.json
@@ -0,0 +1,29 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "res6977",
+ "storageSyncServiceName": "sss2527",
+ "privateEndpointConnectionName": "{privateEndpointConnectionName}",
+ "api-version": "2020-09-01",
+ "monitor": "true"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/res7231/providers/Microsoft.StorageSync/storageSyncServices/sss2527/privateEndpointConnections/{privateEndpointConnectionName}",
+ "name": "{privateEndpointConnectionName}",
+ "type": "Microsoft.StorageSync/storageSyncServices/privateEndpointConnections",
+ "properties": {
+ "provisioningState": "Succeeded",
+ "privateEndpoint": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/res7231/providers/Microsoft.Network/privateEndpoints/petest01"
+ },
+ "privateLinkServiceConnectionState": {
+ "status": "Approved",
+ "description": "Auto-Approved"
+ }
+ }
+ }
+ }
+ }
+}
diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/PrivateEndpointConnections_ListByStorageSyncService.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/PrivateEndpointConnections_ListByStorageSyncService.json
new file mode 100644
index 000000000000..f82166720521
--- /dev/null
+++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/PrivateEndpointConnections_ListByStorageSyncService.json
@@ -0,0 +1,48 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "res6977",
+ "storageSyncServiceName": "sss2527",
+ "privateEndpointConnectionName": "{privateEndpointConnectionName}",
+ "api-version": "2020-09-01",
+ "monitor": "true"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/res7231/providers/Microsoft.StorageSync/storageSyncServices/sss2527/privateEndpointConnections/{privateEndpointConnectionName}",
+ "name": "{privateEndpointConnectionName}",
+ "type": "Microsoft.StorageSync/storageSyncServices/privateEndpointConnections",
+ "properties": {
+ "provisioningState": "Succeeded",
+ "privateEndpoint": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/res7231/providers/Microsoft.Network/privateEndpoints/petest01"
+ },
+ "privateLinkServiceConnectionState": {
+ "status": "Approved",
+ "description": "Auto-Approved"
+ }
+ }
+ },
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/res7231/providers/Microsoft.StorageSync/storageSyncServices/sss2527/privateEndpointConnections/{privateEndpointConnectionName}",
+ "name": "{privateEndpointConnectionName}",
+ "type": "Microsoft.StorageSync/storageSyncServices/privateEndpointConnections",
+ "properties": {
+ "provisioningState": "Succeeded",
+ "privateEndpoint": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/res7231/providers/Microsoft.Network/privateEndpoints/petest02"
+ },
+ "privateLinkServiceConnectionState": {
+ "status": "Approved",
+ "description": "Auto-Approved"
+ }
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/PrivateLinkResources_List.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/PrivateLinkResources_List.json
new file mode 100644
index 000000000000..56d373b01187
--- /dev/null
+++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/PrivateLinkResources_List.json
@@ -0,0 +1,33 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "res6977",
+ "storageSyncServiceName": "sss2527",
+ "api-version": "2020-09-01",
+ "monitor": "true"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/res6977/providers/Microsoft.StorageSync/storageSyncServices/sss2527/privateLinkResources/afs",
+ "name": "afs",
+ "type": "Microsoft.StorageSync/storageSyncServices/privateLinkResources",
+ "properties": {
+ "groupId": "afs",
+ "requiredMembers": [
+ "management",
+ "sync.primary",
+ "sync.secondary"
+ ],
+ "requiredZoneNames": [
+ "privatelink.afs.azure.net"
+ ]
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/RegisteredServers_Create.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/RegisteredServers_Create.json
new file mode 100644
index 000000000000..f857a9b4e81c
--- /dev/null
+++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/RegisteredServers_Create.json
@@ -0,0 +1,64 @@
+{
+ "parameters": {
+ "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb",
+ "resourceGroupName": "SampleResourceGroup_1",
+ "storageSyncServiceName": "SampleStorageSyncService_1",
+ "serverId": "080d4133-bdb5-40a0-96a0-71a6057bfe9a",
+ "parameters": {
+ "properties": {
+ "serverRole": "Standalone",
+ "serverCertificate": "MIIDFjCCAf6gAwIBAgIQQS+DS8uhc4VNzUkTw7wbRjANBgkqhkiG9w0BAQ0FADAzMTEwLwYDVQQDEyhhbmt1c2hiLXByb2QzLnJlZG1vbmQuY29ycC5taWNyb3NvZnQuY29tMB4XDTE3MDgwMzE3MDQyNFoXDTE4MDgwNDE3MDQyNFowMzExMC8GA1UEAxMoYW5rdXNoYi1wcm9kMy5yZWRtb25kLmNvcnAubWljcm9zb2Z0LmNvbTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBALDRvV4gmsIy6jGDPiHsXmvgVP749NNP7DopdlbHaNhjFmYINHl0uWylyaZmgJrROt2mnxN/zEyJtGnqYHlzUr4xvGq/qV5pqgdB9tag/sw9i22gfe9PRZ0FmSOZnXMbLYgLiDFqLtut5gHcOuWMj03YnkfoBEKlFBxWbagvW2yxz/Sxi9OVSJOKCaXra0RpcIHrO/KFl6ho2eE1/7Ykmfa8hZvSdoPd5gHdLiQcMB/pxq+mWp1fI6c8vFZoDu7Atn+NXTzYPKUxKzaisF12TsaKpohUsJpbB3Wocb0F5frn614D2pg14ERB5otjAMWw1m65csQWPI6dP8KIYe0+QPkCAwEAAaMmMCQwIgYDVR0lAQH/BBgwFgYIKwYBBQUHAwIGCisGAQQBgjcKAwwwDQYJKoZIhvcNAQENBQADggEBAA4RhVIBkw34M1RwakJgHvtjsOFxF1tVQA941NtLokx1l2Z8+GFQkcG4xpZSt+UN6wLerdCbnNhtkCErWUDeaT0jxk4g71Ofex7iM04crT4iHJr8mi96/XnhnkTUs+GDk12VgdeeNEczMZz+8Mxw9dJ5NCnYgTwO0SzGlclRsDvjzkLo8rh2ZG6n/jKrEyNXXo+hOqhupij0QbRP2Tvexdfw201kgN1jdZify8XzJ8Oi0bTS0KpJf2pNPOlooK2bjMUei9ANtEdXwwfVZGWvVh6tJjdv6k14wWWJ1L7zhA1IIVb1J+sQUzJji5iX0DrezjTz1Fg+gAzITaA/WsuujlM=",
+ "serverOSVersion": "10.0.14393.0",
+ "agentVersion": "1.0.277.0",
+ "friendlyName": "afscv-2304-139",
+ "serverId": "080d4133-bdb5-40a0-96a0-71a6057bfe9a"
+ }
+ },
+ "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": {
+ "id": "/subscriptions/52b8da2f-61e0-4a1f-8dde-336911f367fb/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/registeredServers/530a0384-50ac-456d-8240-9d6621404151",
+ "type": "Microsoft.StorageSync/storageSyncServices/registeredServers",
+ "name": "ankushb-prod3.redmond.corp.microsoft.com",
+ "properties": {
+ "agentVersion": "3.1.5.0",
+ "agentVersionStatus": "Ok",
+ "agentVersionExpirationDate": "2018-06-11T21:50:40.5840543Z",
+ "serverOSVersion": "10.0.14393.0",
+ "serverManagementErrorCode": 0,
+ "lastHeartBeat": "2018-06-11T21:50:40.5840543Z",
+ "provisioningState": "Succeeded",
+ "serverRole": "Standalone",
+ "clusterId": "00000000-0000-0000-0000-000000000000",
+ "clusterName": "",
+ "serverId": "3635ca8b-5cc8-4a5c-bd43-c2de5ad8dc64",
+ "storageSyncServiceUid": "4aa14534-1c61-483b-b6a6-9630a76f109a",
+ "lastWorkflowId": "storageSyncServices/CV_FileStore_F1D485AA/workflows/4eecfbcf-9537-4b61-8fee-aaa3ace11c44",
+ "lastOperationName": "ICreateRegisteredServerWorkflow",
+ "friendlyName": "afscv-2304-139",
+ "serverName": "afscv-2304-139",
+ "managementEndpointUri": "https://kailanitest99.one.microsoft.com:443/",
+ "monitoringEndpointUri": "https://kailanitest99.one.microsoft.com:443/",
+ "discoveryEndpointUri": "https://kailanitest99.one.microsoft.com:443",
+ "resourceLocation": "westus",
+ "serviceLocation": "westus"
+ }
+ }
+ },
+ "202": {
+ "headers": {
+ "Azure-AsyncOperation": "https://management.azure.com/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/workflows/63e554fd-4d27-4b91-8249-2fc697de7c69/operations/d4b00aa1-7ae0-47f0-9fa7-7ed3ea527bc9?api-version=2020-09-01",
+ "Location": "https://management.azure.com/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/workflows/63e554fd-4d27-4b91-8249-2fc697de7c69/operationresults/d4b00aa1-7ae0-47f0-9fa7-7ed3ea527bc9?api-version=2020-09-01",
+ "Retry-After": "10",
+ "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403",
+ "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730"
+ }
+ }
+ }
+}
diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/RegisteredServers_Delete.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/RegisteredServers_Delete.json
new file mode 100644
index 000000000000..21b501c31b59
--- /dev/null
+++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/RegisteredServers_Delete.json
@@ -0,0 +1,27 @@
+{
+ "parameters": {
+ "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb",
+ "resourceGroupName": "SampleResourceGroup_1",
+ "storageSyncServiceName": "SampleStorageSyncService_1",
+ "serverId": "41166691-ab03-43e9-ab3e-0330eda162ac",
+ "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"
+ }
+ },
+ "202": {
+ "headers": {
+ "Azure-AsyncOperation": "https://management.azure.com/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/workflows/cdb963fd-ea36-457e-9222-f85754ff398c/operations/20675646-8111-4158-954b-6b637e922cbf?api-version=2020-09-01",
+ "Location": "https://management.azure.com/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/workflows/cdb963fd-ea36-457e-9222-f85754ff398c/operationresults/20675646-8111-4158-954b-6b637e922cbf?api-version=2020-09-01",
+ "Retry-After": "10",
+ "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403",
+ "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730"
+ }
+ },
+ "204": {}
+ }
+}
diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/RegisteredServers_Get.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/RegisteredServers_Get.json
new file mode 100644
index 000000000000..cdfa55cf7cea
--- /dev/null
+++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/RegisteredServers_Get.json
@@ -0,0 +1,45 @@
+{
+ "parameters": {
+ "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb",
+ "resourceGroupName": "SampleResourceGroup_1",
+ "storageSyncServiceName": "SampleStorageSyncService_1",
+ "serverId": "080d4133-bdb5-40a0-96a0-71a6057bfe9a",
+ "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": "SampleRegisteredServer_1.redmond.corp.microsoft.com",
+ "properties": {
+ "agentVersion": "3.1.5.0",
+ "agentVersionStatus": "Ok",
+ "agentVersionExpirationDate": "2018-06-11T21:50:40.5840543Z",
+ "serverOSVersion": "10.0.14393.0",
+ "serverManagementErrorCode": 0,
+ "lastHeartBeat": "2018-06-11T21:50:40.5840543Z",
+ "provisioningState": "Succeeded",
+ "serverRole": "Standalone",
+ "clusterId": "00000000-0000-0000-0000-000000000000",
+ "clusterName": "",
+ "serverId": "3635ca8b-5cc8-4a5c-bd43-c2de5ad8dc64",
+ "storageSyncServiceUid": "4aa14534-1c61-483b-b6a6-9630a76f109a",
+ "lastWorkflowId": "storageSyncServices/CV_FileStore_F1D485AA/workflows/4eecfbcf-9537-4b61-8fee-aaa3ace11c44",
+ "lastOperationName": "ICreateRegisteredServerWorkflow",
+ "friendlyName": "afscv-2304-139",
+ "serverName": "afscv-2304-139",
+ "managementEndpointUri": "https://kailanitest99.one.microsoft.com:443/",
+ "monitoringEndpointUri": "https://kailanitest99.one.microsoft.com:443/",
+ "discoveryEndpointUri": "https://kailanitest99.one.microsoft.com:443",
+ "resourceLocation": "westus",
+ "serviceLocation": "westus"
+ },
+ "id": "/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/registeredServers/080d4133-bdb5-40a0-96a0-71a6057bfe9a",
+ "type": "Microsoft.StorageSync/storageSyncServices/registeredServers"
+ }
+ }
+ }
+}
diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/RegisteredServers_ListByStorageSyncService.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/RegisteredServers_ListByStorageSyncService.json
new file mode 100644
index 000000000000..8c39e81b2ebd
--- /dev/null
+++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/RegisteredServers_ListByStorageSyncService.json
@@ -0,0 +1,48 @@
+{
+ "parameters": {
+ "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb",
+ "resourceGroupName": "SampleResourceGroup_1",
+ "storageSyncServiceName": "SampleStorageSyncService_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": "SampleRegisteredServer_1.redmond.corp.microsoft.com",
+ "properties": {
+ "agentVersion": "3.1.5.0",
+ "agentVersionStatus": "Ok",
+ "agentVersionExpirationDate": "2018-06-11T21:50:40.5840543Z",
+ "serverOSVersion": "10.0.14393.0",
+ "serverManagementErrorCode": 0,
+ "lastHeartBeat": "2018-06-11T21:50:40.5840543Z",
+ "provisioningState": "Succeeded",
+ "serverRole": "Standalone",
+ "clusterId": "00000000-0000-0000-0000-000000000000",
+ "clusterName": "",
+ "serverId": "3635ca8b-5cc8-4a5c-bd43-c2de5ad8dc64",
+ "storageSyncServiceUid": "4aa14534-1c61-483b-b6a6-9630a76f109a",
+ "lastWorkflowId": "storageSyncServices/CV_FileStore_F1D485AA/workflows/4eecfbcf-9537-4b61-8fee-aaa3ace11c44",
+ "lastOperationName": "ICreateRegisteredServerWorkflow",
+ "friendlyName": "afscv-2304-139",
+ "serverName": "afscv-2304-139",
+ "managementEndpointUri": "https://kailanitest99.one.microsoft.com:443/",
+ "monitoringEndpointUri": "https://kailanitest99.one.microsoft.com:443/",
+ "discoveryEndpointUri": "https://kailanitest99.one.microsoft.com:443",
+ "resourceLocation": "westus",
+ "serviceLocation": "westus"
+ },
+ "id": "/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/registeredServers/080d4133-bdb5-40a0-96a0-71a6057bfe9a",
+ "type": "Microsoft.StorageSync/storageSyncServices/registeredServers"
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/RegisteredServers_TriggerRollover.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/RegisteredServers_TriggerRollover.json
new file mode 100644
index 000000000000..649faa8b0888
--- /dev/null
+++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/RegisteredServers_TriggerRollover.json
@@ -0,0 +1,29 @@
+{
+ "parameters": {
+ "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb",
+ "resourceGroupName": "SampleResourceGroup_1",
+ "storageSyncServiceName": "SampleStorageSyncService_1",
+ "serverId": "d166ca76-dad2-49df-b409-12345642d730",
+ "parameters": {
+ "serverCertificate": "\"MIIDFjCCAf6gAwIBAgIQQS+DS8uhc4VNzUkTw7wbRjANBgkqhkiG9w0BAQ0FADAzMTEwLwYDVQQDEyhhbmt1c2hiLXByb2QzLnJlZG1vbmQuY29ycC5taWNyb3NvZnQuY29tMB4XDTE3MDgwMzE3MDQyNFoXDTE4MDgwNDE3MDQyNFowMzExMC8GA1UEAxMoYW5rdXNoYi1wcm9kMy5yZWRtb25kLmNvcnAubWljcm9zb2Z0LmNvbTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBALDRvV4gmsIy6jGDPiHsXmvgVP749NNP7DopdlbHaNhjFmYINHl0uWylyaZmgJrROt2mnxN/zEyJtGnqYHlzUr4xvGq/qV5pqgdB9tag/sw9i22gfe9PRZ0FmSOZnXMbLYgLiDFqLtut5gHcOuWMj03YnkfoBEKlFBxWbagvW2yxz/Sxi9OVSJOKCaXra0RpcIHrO/KFl6ho2eE1/7Ykmfa8hZvSdoPd5gHdLiQcMB/pxq+mWp1fI6c8vFZoDu7Atn+NXTzYPKUxKzaisF12TsaKpohUsJpbB3Wocb0F5frn614D2pg14ERB5otjAMWw1m65csQWPI6dP8KIYe0+QPkCAwEAAaMmMCQwIgYDVR0lAQH/BBgwFgYIKwYBBQUHAwIGCisGAQQBgjcKAwwwDQYJKoZIhvcNAQENBQADggEBAA4RhVIBkw34M1RwakJgHvtjsOFxF1tVQA941NtLokx1l2Z8+GFQkcG4xpZSt+UN6wLerdCbnNhtkCErWUDeaT0jxk4g71Ofex7iM04crT4iHJr8mi96/XnhnkTUs+GDk12VgdeeNEczMZz+8Mxw9dJ5NCnYgTwO0SzGlclRsDvjzkLo8rh2ZG6n/jKrEyNXXo+hOqhupij0QbRP2Tvexdfw201kgN1jdZify8XzJ8Oi0bTS0KpJf2pNPOlooK2bjMUei9ANtEdXwwfVZGWvVh6tJjdv6k14wWWJ1L7zhA1IIVb1J+sQUzJji5iX0DrezjTz1Fg+gAzITaA/WsuujlM=\""
+ },
+ "api-version": "2020-09-01"
+ },
+ "responses": {
+ "200": {
+ "headers": {
+ "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47222",
+ "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d222"
+ }
+ },
+ "202": {
+ "headers": {
+ "Azure-AsyncOperation": "https://management.azure.com/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/workflows/828219ea-083e-48b5-89ea-8fd9991b2e75/operations/fe680c98-5725-49c8-b0dc-5e29745f752b?api-version=2020-09-01",
+ "Location": "https://management.azure.com/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/workflows/828219ea-083e-48b5-89ea-8fd9991b2e75/operationresults/fe680c98-5725-49c8-b0dc-5e29745f752b?api-version=2020-09-01",
+ "Retry-After": "10",
+ "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403",
+ "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730"
+ }
+ }
+ }
+}
diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/ServerEndpoints_Create.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/ServerEndpoints_Create.json
new file mode 100644
index 000000000000..25a3b2868d2c
--- /dev/null
+++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/ServerEndpoints_Create.json
@@ -0,0 +1,66 @@
+{
+ "parameters": {
+ "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb",
+ "resourceGroupName": "SampleResourceGroup_1",
+ "storageSyncServiceName": "SampleStorageSyncService_1",
+ "syncGroupName": "SampleSyncGroup_1",
+ "serverEndpointName": "SampleServerEndpoint_1",
+ "parameters": {
+ "properties": {
+ "serverLocalPath": "D:\\SampleServerEndpoint_1",
+ "serverResourceId": "/subscriptions/52b8da2f-61e0-4a1f-8dde-336911f367fb/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/registeredServers/080d4133-bdb5-40a0-96a0-71a6057bfe9a",
+ "cloudTiering": "off",
+ "volumeFreeSpacePercent": 100,
+ "tierFilesOlderThanDays": 0,
+ "offlineDataTransfer": "on",
+ "offlineDataTransferShareName": "myfileshare",
+ "initialDownloadPolicy": "NamespaceThenModifiedFiles",
+ "localCacheMode": "UpdateLocallyCachedFiles"
+ }
+ },
+ "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": "SampleServerEndpoint_1",
+ "properties": {
+ "serverLocalPath": "D:\\SampleServerEndpoint_1",
+ "cloudTiering": "off",
+ "volumeFreeSpacePercent": 100,
+ "friendlyName": "somemachine.redmond.corp.microsoft.com",
+ "serverName": "somemachine.redmond.corp.microsoft.com",
+ "serverResourceId": "/subscriptions/52b8da2f-61e0-4a1f-8dde-336911f367fb/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/registeredServers/080d4133-bdb5-40a0-96a0-71a6057bfe9a",
+ "provisioningState": "Succeeded",
+ "lastWorkflowId": "storageSyncServices/healthDemo1/workflows/569afb5c-7172-4cf8-a8ea-d987f727f11a",
+ "lastOperationName": "ICreateServerEndpointWorkflow",
+ "tierFilesOlderThanDays": 0,
+ "syncStatus": null,
+ "offlineDataTransfer": "on",
+ "offlineDataTransferStorageAccountResourceId": "/subscriptions/744f4d70-6d17-4921-8970-a765d14f763f/resourceGroups/myRG/providers/Microsoft.Storage/storageAccounts/mysa",
+ "offlineDataTransferStorageAccountTenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47",
+ "offlineDataTransferShareName": "myfileshare",
+ "cloudTieringStatus": null,
+ "recallStatus": null,
+ "initialDownloadPolicy": "NamespaceThenModifiedFiles",
+ "localCacheMode": "UpdateLocallyCachedFiles"
+ },
+ "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"
+ }
+ },
+ "202": {
+ "headers": {
+ "Azure-AsyncOperation": "https://management.azure.com/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/workflows/828219ea-083e-48b5-89ea-8fd9991b2e75/operations/fe680c98-5725-49c8-b0dc-5e29745f752b?api-version=2020-09-01",
+ "Location": "https://management.azure.com/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/workflows/828219ea-083e-48b5-89ea-8fd9991b2e75/operationresults/fe680c98-5725-49c8-b0dc-5e29745f752b?api-version=2020-09-01",
+ "Retry-After": "10",
+ "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403",
+ "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730"
+ }
+ }
+ }
+}
diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/ServerEndpoints_Delete.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/ServerEndpoints_Delete.json
new file mode 100644
index 000000000000..cf7ebd290c61
--- /dev/null
+++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/ServerEndpoints_Delete.json
@@ -0,0 +1,27 @@
+{
+ "parameters": {
+ "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb",
+ "resourceGroupName": "SampleResourceGroup_1",
+ "storageSyncServiceName": "SampleStorageSyncService_1",
+ "syncGroupName": "SampleSyncGroup_1",
+ "serverEndpointName": "SampleServerEndpoint_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"
+ }
+ },
+ "202": {
+ "headers": {
+ "Azure-AsyncOperation": "https://management.azure.com/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/workflows/9122d971-147b-4dba-bada-1ceb7c9311e5/operations/6dce076b-1df5-4449-829b-69b24f38b5a1?api-version=2020-09-01",
+ "Location": "https://management.azure.com/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/workflows/9122d971-147b-4dba-bada-1ceb7c9311e5/operationresults/6dce076b-1df5-4449-829b-69b24f38b5a1?api-version=2020-09-01",
+ "Retry-After": "10",
+ "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403",
+ "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730"
+ }
+ }
+ }
+}
diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/ServerEndpoints_Get.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/ServerEndpoints_Get.json
new file mode 100644
index 000000000000..67a99648af47
--- /dev/null
+++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/ServerEndpoints_Get.json
@@ -0,0 +1,150 @@
+{
+ "parameters": {
+ "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb",
+ "resourceGroupName": "SampleResourceGroup_1",
+ "storageSyncServiceName": "SampleStorageSyncService_1",
+ "syncGroupName": "SampleSyncGroup_1",
+ "serverEndpointName": "SampleServerEndpoint_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": "SampleServerEndpoint_1",
+ "properties": {
+ "serverLocalPath": "D:\\SampleServerEndpoint_1",
+ "cloudTiering": "on",
+ "volumeFreeSpacePercent": 100,
+ "friendlyName": "somemachine.redmond.corp.microsoft.com",
+ "serverName": "somemachine.redmond.corp.microsoft.com",
+ "serverResourceId": "/subscriptions/52b8da2f-61e0-4a1f-8dde-336911f367fb/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/registeredServers/080d4133-bdb5-40a0-96a0-71a6057bfe9a",
+ "provisioningState": "Succeeded",
+ "lastWorkflowId": "storageSyncServices/healthDemo1/workflows/569afb5c-7172-4cf8-a8ea-d987f727f11a",
+ "lastOperationName": "ICreateServerEndpointWorkflow",
+ "tierFilesOlderThanDays": 0,
+ "syncStatus": {
+ "downloadHealth": "Healthy",
+ "uploadHealth": "Error",
+ "combinedHealth": "Error",
+ "syncActivity": "UploadAndDownload",
+ "totalPersistentFilesNotSyncingCount": null,
+ "lastUpdatedTimestamp": "2018-06-11T23:32:51.1057915Z",
+ "uploadStatus": {
+ "lastSyncResult": -2134351810,
+ "lastSyncTimestamp": "2018-06-11T23:32:51.1057915Z",
+ "lastSyncSuccessTimestamp": null,
+ "lastSyncPerItemErrorCount": 1000,
+ "persistentFilesNotSyncingCount": null,
+ "transientFilesNotSyncingCount": null,
+ "filesNotSyncingErrors": null
+ },
+ "downloadStatus": {
+ "lastSyncResult": 0,
+ "lastSyncTimestamp": "2018-06-11T23:28:33.9217334Z",
+ "lastSyncSuccessTimestamp": "2018-06-11T23:28:33.9217334Z",
+ "lastSyncPerItemErrorCount": 0,
+ "persistentFilesNotSyncingCount": null,
+ "transientFilesNotSyncingCount": null,
+ "filesNotSyncingErrors": null
+ },
+ "uploadActivity": {
+ "timestamp": "2018-06-11T23:32:51.1057915Z",
+ "perItemErrorCount": 300,
+ "appliedItemCount": 1000,
+ "totalItemCount": 2300,
+ "appliedBytes": 57348983,
+ "totalBytes": 1958367412
+ },
+ "downloadActivity": {
+ "timestamp": "2018-06-11T23:32:51.1057915Z",
+ "perItemErrorCount": 0,
+ "appliedItemCount": 100,
+ "totalItemCount": 300,
+ "appliedBytes": 94805587,
+ "totalBytes": 19583674
+ },
+ "offlineDataTransferStatus": "InProgress"
+ },
+ "offlineDataTransfer": "on",
+ "offlineDataTransferStorageAccountResourceId": "/subscriptions/744f4d70-6d17-4921-8970-a765d14f763f/resourceGroups/myRG/providers/Microsoft.Storage/storageAccounts/mysa",
+ "offlineDataTransferStorageAccountTenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47",
+ "offlineDataTransferShareName": "myfileshare",
+ "initialDownloadPolicy": "NamespaceThenModifiedFiles",
+ "localCacheMode": "UpdateLocallyCachedFiles",
+ "cloudTieringStatus": {
+ "lastUpdatedTimestamp": "2018-06-11T23:32:51.1057915Z",
+ "health": "Error",
+ "healthLastUpdatedTimestamp": "2018-06-11T23:32:51.1057915Z",
+ "lastCloudTieringResult": -2134347771,
+ "lastSuccessTimestamp": "2018-06-11T23:32:51.1057915Z",
+ "spaceSavings": {
+ "lastUpdatedTimestamp": "2019-04-17T19:04:59.1959227Z",
+ "volumeSizeBytes": 922337203685477580,
+ "totalSizeCloudBytes": 100000000,
+ "cachedSizeBytes": 50000000,
+ "spaceSavingsPercent": 50,
+ "spaceSavingsBytes": 50000000
+ },
+ "cachePerformance": {
+ "lastUpdatedTimestamp": "2019-04-17T19:04:59.1959227Z",
+ "cacheHitBytes": 922337203685477580,
+ "cacheMissBytes": 922337203685477580,
+ "cacheHitBytesPercent": 50
+ },
+ "filesNotTiering": {
+ "lastUpdatedTimestamp": "2019-04-17T19:04:59.1959227Z",
+ "totalFileCount": 60,
+ "errors": [
+ {
+ "errorCode": -2134347771,
+ "fileCount": 10
+ },
+ {
+ "errorCode": -2134347770,
+ "fileCount": 20
+ },
+ {
+ "errorCode": -2134347769,
+ "fileCount": 30
+ }
+ ]
+ },
+ "volumeFreeSpacePolicyStatus": {
+ "lastUpdatedTimestamp": "2019-04-17T19:04:59.1959227Z",
+ "effectiveVolumeFreeSpacePolicy": 30,
+ "currentVolumeFreeSpacePercent": 5
+ },
+ "datePolicyStatus": {
+ "lastUpdatedTimestamp": "2019-04-17T19:04:59.1959227Z",
+ "tieredFilesMostRecentAccessTimestamp": "2019-04-17T19:04:59.1959227Z"
+ }
+ },
+ "recallStatus": {
+ "lastUpdatedTimestamp": "2018-06-11T23:32:51.1057915Z",
+ "totalRecallErrorsCount": 30,
+ "recallErrors": [
+ {
+ "errorCode": -2134347775,
+ "count": 5
+ },
+ {
+ "errorCode": -2134347774,
+ "count": 10
+ },
+ {
+ "errorCode": -2134347773,
+ "count": 15
+ }
+ ]
+ }
+ },
+ "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_ListBySyncGroup.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/ServerEndpoints_ListBySyncGroup.json
new file mode 100644
index 000000000000..7b1f1e3acb73
--- /dev/null
+++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/ServerEndpoints_ListBySyncGroup.json
@@ -0,0 +1,195 @@
+{
+ "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": "SampleServerEndpoint_1",
+ "properties": {
+ "serverLocalPath": "D:\\SampleServerEndpoint_1",
+ "cloudTiering": "off",
+ "volumeFreeSpacePercent": 100,
+ "friendlyName": "somemachine.redmond.corp.microsoft.com",
+ "serverName": "somemachine.redmond.corp.microsoft.com",
+ "serverResourceId": "/subscriptions/52b8da2f-61e0-4a1f-8dde-336911f367fb/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/registeredServers/080d4133-bdb5-40a0-96a0-71a6057bfe9a",
+ "provisioningState": "Succeeded",
+ "lastWorkflowId": "storageSyncServices/healthDemo1/workflows/569afb5c-7172-4cf8-a8ea-d987f727f11a",
+ "lastOperationName": "ICreateServerEndpointWorkflow",
+ "tierFilesOlderThanDays": 0,
+ "syncStatus": {
+ "downloadHealth": "Healthy",
+ "uploadHealth": "Error",
+ "combinedHealth": "Error",
+ "syncActivity": null,
+ "totalPersistentFilesNotSyncingCount": null,
+ "lastUpdatedTimestamp": "2018-06-11T23:32:51.1057915Z",
+ "uploadStatus": {
+ "lastSyncResult": 0,
+ "lastSyncTimestamp": "2018-06-11T23:32:51.1057915Z",
+ "lastSyncSuccessTimestamp": "2018-06-11T23:32:51.1057915Z",
+ "lastSyncPerItemErrorCount": 0,
+ "persistentFilesNotSyncingCount": null,
+ "transientFilesNotSyncingCount": null,
+ "filesNotSyncingErrors": null
+ },
+ "downloadStatus": {
+ "lastSyncResult": 0,
+ "lastSyncTimestamp": "2018-06-11T23:28:33.9217334Z",
+ "lastSyncSuccessTimestamp": "2018-06-11T23:28:33.9217334Z",
+ "lastSyncPerItemErrorCount": 1000,
+ "persistentFilesNotSyncingCount": null,
+ "transientFilesNotSyncingCount": null,
+ "filesNotSyncingErrors": null
+ },
+ "uploadActivity": null,
+ "downloadActivity": null,
+ "offlineDataTransferStatus": "Complete"
+ },
+ "offlineDataTransfer": "on",
+ "offlineDataTransferStorageAccountResourceId": "/subscriptions/744f4d70-6d17-4921-8970-a765d14f763f/resourceGroups/myRG/providers/Microsoft.Storage/storageAccounts/mysa",
+ "offlineDataTransferStorageAccountTenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47",
+ "offlineDataTransferShareName": "myfileshare",
+ "initialDownloadPolicy": "NamespaceThenModifiedFiles",
+ "localCacheMode": "UpdateLocallyCachedFiles"
+ },
+ "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"
+ },
+ {
+ "name": "SampleServerEndpoint_2",
+ "properties": {
+ "serverLocalPath": "D:\\SampleServerEndpoint_2",
+ "cloudTiering": "on",
+ "volumeFreeSpacePercent": 80,
+ "friendlyName": "somemachine2.redmond.corp.microsoft.com",
+ "serverName": "somemachine2.redmond.corp.microsoft.com",
+ "serverResourceId": "/subscriptions/52b8da2f-61e0-4a1f-8dde-336911f367fb/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/registeredServers/f94e2944-b48d-4e5b-bdc7-c48ab3712659",
+ "provisioningState": "Succeeded",
+ "lastWorkflowId": "storageSyncServices/healthDemo1/workflows/40b1dc00-d7d9-4721-a1e9-ab60139b830a",
+ "lastOperationName": "ICreateServerEndpointWorkflow",
+ "tierFilesOlderThanDays": 5,
+ "initialDownloadPolicy": "NamespaceThenModifiedFiles",
+ "localCacheMode": "UpdateLocallyCachedFiles",
+ "syncStatus": {
+ "downloadHealth": "Healthy",
+ "uploadHealth": "Healthy",
+ "combinedHealth": "Healthy",
+ "syncActivity": "Upload",
+ "totalPersistentFilesNotSyncingCount": null,
+ "lastUpdatedTimestamp": "2018-06-11T23:32:51.1057915Z",
+ "uploadStatus": {
+ "lastSyncResult": 0,
+ "lastSyncTimestamp": "2018-06-11T23:32:51.1057915Z",
+ "lastSyncSuccessTimestamp": "2018-06-11T23:28:33.9217334Z",
+ "lastSyncPerItemErrorCount": 0,
+ "persistentFilesNotSyncingCount": null,
+ "transientFilesNotSyncingCount": null,
+ "filesNotSyncingErrors": null
+ },
+ "downloadStatus": {
+ "lastSyncResult": 0,
+ "lastSyncTimestamp": "2018-06-11T23:28:33.9217334Z",
+ "lastSyncSuccessTimestamp": "2018-06-11T23:28:33.9217334Z",
+ "lastSyncPerItemErrorCount": 0,
+ "persistentFilesNotSyncingCount": null,
+ "transientFilesNotSyncingCount": null,
+ "filesNotSyncingErrors": null
+ },
+ "uploadActivity": {
+ "timestamp": "2018-06-11T23:32:51.1057915Z",
+ "perItemErrorCount": 300,
+ "appliedItemCount": 1000,
+ "totalItemCount": 2300,
+ "appliedBytes": 57348983,
+ "totalBytes": 1958367412
+ },
+ "downloadActivity": null,
+ "offlineDataTransferStatus": "NotRunning"
+ },
+ "offlineDataTransfer": "off",
+ "cloudTieringStatus": {
+ "lastUpdatedTimestamp": "2018-06-11T23:32:51.1057915Z",
+ "health": "Error",
+ "healthLastUpdatedTimestamp": "2018-06-11T23:32:51.1057915Z",
+ "lastCloudTieringResult": -2134347771,
+ "lastSuccessTimestamp": "2018-06-11T23:32:51.1057915Z",
+ "spaceSavings": {
+ "lastUpdatedTimestamp": "2019-04-17T19:04:59.1959227Z",
+ "volumeSizeBytes": 922337203685477580,
+ "totalSizeCloudBytes": 100000000,
+ "cachedSizeBytes": 50000000,
+ "spaceSavingsPercent": 50,
+ "spaceSavingsBytes": 50000000
+ },
+ "cachePerformance": {
+ "lastUpdatedTimestamp": "2019-04-17T19:04:59.1959227Z",
+ "cacheHitBytes": 922337203685477580,
+ "cacheMissBytes": 922337203685477580,
+ "cacheHitBytesPercent": 50
+ },
+ "filesNotTiering": {
+ "lastUpdatedTimestamp": "2019-04-17T19:04:59.1959227Z",
+ "totalFileCount": 60,
+ "errors": [
+ {
+ "errorCode": -2134347771,
+ "fileCount": 10
+ },
+ {
+ "errorCode": -2134347770,
+ "fileCount": 20
+ },
+ {
+ "errorCode": -2134347769,
+ "fileCount": 30
+ }
+ ]
+ },
+ "volumeFreeSpacePolicyStatus": {
+ "lastUpdatedTimestamp": "2019-04-17T19:04:59.1959227Z",
+ "effectiveVolumeFreeSpacePolicy": 30,
+ "currentVolumeFreeSpacePercent": 5
+ },
+ "datePolicyStatus": {
+ "lastUpdatedTimestamp": "2019-04-17T19:04:59.1959227Z",
+ "tieredFilesMostRecentAccessTimestamp": "2019-04-17T19:04:59.1959227Z"
+ }
+ },
+ "recallStatus": {
+ "lastUpdatedTimestamp": "2018-06-11T23:32:51.1057915Z",
+ "totalRecallErrorsCount": 30,
+ "recallErrors": [
+ {
+ "errorCode": -2134347775,
+ "count": 5
+ },
+ {
+ "errorCode": -2134347774,
+ "count": 10
+ },
+ {
+ "errorCode": -2134347773,
+ "count": 15
+ }
+ ]
+ }
+ },
+ "id": "/subscriptions/52b8da2f-61e0-4a1f-8dde-336911f367fb/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/syncGroups/SampleSyncGroup_1/serverEndpoints/SampleServerEndpoint_2",
+ "type": "Microsoft.StorageSync/storageSyncServices/syncGroups/serverEndpoints"
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/ServerEndpoints_Recall.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/ServerEndpoints_Recall.json
new file mode 100644
index 000000000000..c4098d71cb89
--- /dev/null
+++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/ServerEndpoints_Recall.json
@@ -0,0 +1,31 @@
+{
+ "parameters": {
+ "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb",
+ "resourceGroupName": "SampleResourceGroup_1",
+ "storageSyncServiceName": "SampleStorageSyncService_1",
+ "syncGroupName": "SampleSyncGroup_1",
+ "serverEndpointName": "SampleServerEndpoint_1",
+ "api-version": "2020-09-01",
+ "parameters": {
+ "pattern": "",
+ "recallPath": ""
+ }
+ },
+ "responses": {
+ "200": {
+ "headers": {
+ "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403",
+ "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730"
+ }
+ },
+ "202": {
+ "headers": {
+ "Azure-AsyncOperation": "https://management.azure.com/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/workflows/828219ea-083e-48b5-89ea-8fd9991b2e75/operations/fe680c98-5725-49c8-b0dc-5e29745f752b?api-version=2020-09-01",
+ "Location": "https://management.azure.com/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/workflows/828219ea-083e-48b5-89ea-8fd9991b2e75/operationresults/fe680c98-5725-49c8-b0dc-5e29745f752b?api-version=2020-09-01",
+ "Retry-After": "10",
+ "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403",
+ "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730"
+ }
+ }
+ }
+}
diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/ServerEndpoints_Update.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/ServerEndpoints_Update.json
new file mode 100644
index 000000000000..9f1970e01f07
--- /dev/null
+++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/ServerEndpoints_Update.json
@@ -0,0 +1,89 @@
+{
+ "parameters": {
+ "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb",
+ "resourceGroupName": "SampleResourceGroup_1",
+ "storageSyncServiceName": "SampleStorageSyncService_1",
+ "cloudEndpointName": "SampleCloudEndpoint_1",
+ "syncGroupName": "SampleSyncGroup_1",
+ "serverEndpointName": "SampleServerEndpoint_1",
+ "parameters": {
+ "properties": {
+ "cloudTiering": "off",
+ "volumeFreeSpacePercent": 100,
+ "tierFilesOlderThanDays": 0,
+ "offlineDataTransfer": "off",
+ "localCacheMode": "UpdateLocallyCachedFiles"
+ }
+ },
+ "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": "SampleServerEndpoint_1",
+ "properties": {
+ "serverLocalPath": "C:\\data_quota2",
+ "cloudTiering": "off",
+ "volumeFreeSpacePercent": 20,
+ "tierFilesOlderThanDays": 0,
+ "friendlyName": "somemachine2.redmond.corp.microsoft.com",
+ "serverName": "somemachine2.redmond.corp.microsoft.com",
+ "serverResourceId": "/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/anpintDemoRG/providers/kailanitest07.one.microsoft.com/storageSyncServices/healthdemo1/registeredServers/f94e2944-b48d-4e5b-bdc7-c48ab3712659",
+ "provisioningState": "Succeeded",
+ "lastWorkflowId": "storageSyncServices/healthDemo1/workflows/569afb5c-7172-4cf8-a8ea-d987f727f11b",
+ "lastOperationName": "ICreateServerEndpointWorkflow",
+ "syncStatus": {
+ "downloadHealth": "Healthy",
+ "uploadHealth": "Error",
+ "combinedHealth": "Error",
+ "syncActivity": null,
+ "totalPersistentFilesNotSyncingCount": null,
+ "lastUpdatedTimestamp": "2018-06-11T23:32:51.1057915Z",
+ "uploadStatus": {
+ "lastSyncResult": -2134351810,
+ "lastSyncTimestamp": "2018-06-11T23:32:51.1057915Z",
+ "lastSyncSuccessTimestamp": null,
+ "lastSyncPerItemErrorCount": 0,
+ "persistentFilesNotSyncingCount": null,
+ "transientFilesNotSyncingCount": null,
+ "filesNotSyncingErrors": null
+ },
+ "downloadStatus": {
+ "lastSyncResult": 0,
+ "lastSyncTimestamp": "2018-06-11T23:28:33.9217334Z",
+ "lastSyncSuccessTimestamp": "2018-06-11T23:28:33.9217334Z",
+ "lastSyncPerItemErrorCount": 0,
+ "persistentFilesNotSyncingCount": null,
+ "transientFilesNotSyncingCount": null,
+ "filesNotSyncingErrors": null
+ },
+ "uploadActivity": null,
+ "downloadActivity": null,
+ "offlineDataTransferStatus": "Stopping"
+ },
+ "offlineDataTransfer": "off",
+ "offlineDataTransferStorageAccountResourceId": "/subscriptions/744f4d70-6d17-4921-8970-a765d14f763f/resourceGroups/myRG/providers/Microsoft.Storage/storageAccounts/mysa",
+ "offlineDataTransferStorageAccountTenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47",
+ "offlineDataTransferShareName": "myfileshare",
+ "initialDownloadPolicy": "NamespaceThenModifiedFiles",
+ "localCacheMode": "UpdateLocallyCachedFiles"
+ },
+ "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"
+ }
+ },
+ "202": {
+ "headers": {
+ "Azure-AsyncOperation": "https://management.azure.com/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SSS_Swagger_08-09_Test212/workflows/3af798a9-26fd-44e7-a121-a4ad65f451bd/operations/ef2a30f4-9bb8-40e7-b403-5d6d3dc67a3c?api-version=2020-09-01",
+ "Location": "https://management.azure.com/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SSS_Swagger_08-09_Test212/workflows/3af798a9-26fd-44e7-a121-a4ad65f451bd/operationresults/ef2a30f4-9bb8-40e7-b403-5d6d3dc67a3c?api-version=2020-09-01",
+ "Retry-After": "10",
+ "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403",
+ "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730"
+ }
+ }
+ }
+}
diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/StorageSyncServiceCheckNameAvailability_AlreadyExists.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/StorageSyncServiceCheckNameAvailability_AlreadyExists.json
new file mode 100644
index 000000000000..81403bd74522
--- /dev/null
+++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/StorageSyncServiceCheckNameAvailability_AlreadyExists.json
@@ -0,0 +1,20 @@
+{
+ "parameters": {
+ "api-version": "2020-09-01",
+ "subscriptionId": "5c6bc8e1-1eaf-4192-94d8-58ce463ac86c",
+ "locationName": "westus",
+ "parameters": {
+ "name": "newstoragesyncservicename",
+ "type": "Microsoft.StorageSync/storageSyncServices"
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "nameAvailable": false,
+ "reason": "AlreadyExists",
+ "message": "An account named 'newstoragesyncservicename' is already in use."
+ }
+ }
+ }
+}
diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/StorageSyncServiceCheckNameAvailability_Available.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/StorageSyncServiceCheckNameAvailability_Available.json
new file mode 100644
index 000000000000..c996ca88dc7b
--- /dev/null
+++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/StorageSyncServiceCheckNameAvailability_Available.json
@@ -0,0 +1,18 @@
+{
+ "parameters": {
+ "api-version": "2020-09-01",
+ "subscriptionId": "5c6bc8e1-1eaf-4192-94d8-58ce463ac86c",
+ "locationName": "westus",
+ "parameters": {
+ "name": "newstoragesyncservicename",
+ "type": "Microsoft.StorageSync/storageSyncServices"
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "nameAvailable": true
+ }
+ }
+ }
+}
diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/StorageSyncServices_Create.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/StorageSyncServices_Create.json
new file mode 100644
index 000000000000..a5ba8a0da848
--- /dev/null
+++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/StorageSyncServices_Create.json
@@ -0,0 +1,38 @@
+{
+ "parameters": {
+ "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb",
+ "resourceGroupName": "SampleResourceGroup_1",
+ "storageSyncServiceName": "SampleStorageSyncService_1",
+ "parameters": {
+ "properties": {
+ "incomingTrafficPolicy": "AllowAllTraffic"
+ },
+ "location": "WestUS",
+ "tags": {}
+ },
+ "api-version": "2020-09-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "name": "SampleStorageSyncService_1",
+ "location": "WestUS",
+ "properties": {
+ "incomingTrafficPolicy": "AllowAllTraffic"
+ },
+ "tags": {},
+ "id": "/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1",
+ "type": "Microsoft.StorageSync/storageSyncServices"
+ }
+ },
+ "202": {
+ "headers": {
+ "Azure-AsyncOperation": "https://management.azure.com/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/workflows/828219ea-083e-48b5-89ea-8fd9991b2e75/operations/fe680c98-5725-49c8-b0dc-5e29745f752b?api-version=2020-09-01",
+ "Location": "https://management.azure.com/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/workflows/828219ea-083e-48b5-89ea-8fd9991b2e75/operationresults/fe680c98-5725-49c8-b0dc-5e29745f752b?api-version=2020-09-01",
+ "Retry-After": "10",
+ "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403",
+ "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730"
+ }
+ }
+ }
+}
diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/StorageSyncServices_Delete.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/StorageSyncServices_Delete.json
new file mode 100644
index 000000000000..d213969cc0f3
--- /dev/null
+++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/StorageSyncServices_Delete.json
@@ -0,0 +1,21 @@
+{
+ "parameters": {
+ "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb",
+ "resourceGroupName": "SampleResourceGroup_1",
+ "storageSyncServiceName": "SampleStorageSyncService_1",
+ "api-version": "2020-09-01"
+ },
+ "responses": {
+ "200": {},
+ "204": {},
+ "202": {
+ "headers": {
+ "Azure-AsyncOperation": "https://management.azure.com/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/workflows/828219ea-083e-48b5-89ea-8fd9991b2e75/operations/fe680c98-5725-49c8-b0dc-5e29745f752b?api-version=2020-09-01",
+ "Location": "https://management.azure.com/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/workflows/828219ea-083e-48b5-89ea-8fd9991b2e75/operationresults/fe680c98-5725-49c8-b0dc-5e29745f752b?api-version=2020-09-01",
+ "Retry-After": "10",
+ "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403",
+ "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730"
+ }
+ }
+ }
+}
diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/StorageSyncServices_Get.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/StorageSyncServices_Get.json
new file mode 100644
index 000000000000..e20d1009c05d
--- /dev/null
+++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/StorageSyncServices_Get.json
@@ -0,0 +1,43 @@
+{
+ "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": {
+ "name": "SampleStorageSyncService_1",
+ "location": "WestUS",
+ "tags": {},
+ "properties": {
+ "storageSyncServiceStatus": 0,
+ "incomingTrafficPolicy": "AllowAllTraffic",
+ "storageSyncServiceUid": "\"2de01144-72da-4d7f-9d0c-e858855114a8\"",
+ "privateEndpointConnections": [
+ {
+ "id": "subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/{resource}/{resourceName}/privateEndpointConnections/SampleStorageSyncService_1.cd99f12ba6f3483f9292229e4f822258",
+ "properties": {
+ "privateEndpoint": {
+ "id": "subscriptions/52b8da2f-61e0-4a1f-8dde-336911f367fb/resourceGroups/SampleResourceGroup_2/providers/Microsoft.Network/privateEndpoints/testpe01"
+ },
+ "privateLinkServiceConnectionState": {
+ "status": "Pending",
+ "description": "Please approve my request, thanks."
+ }
+ }
+ }
+ ]
+ },
+ "id": "/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1",
+ "type": "Microsoft.StorageSync/storageSyncServices"
+ }
+ }
+ }
+}
diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/StorageSyncServices_ListByResourceGroup.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/StorageSyncServices_ListByResourceGroup.json
new file mode 100644
index 000000000000..febc889077bb
--- /dev/null
+++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/StorageSyncServices_ListByResourceGroup.json
@@ -0,0 +1,55 @@
+{
+ "parameters": {
+ "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb",
+ "resourceGroupName": "SampleResourceGroup_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": "SampleStorageSyncService_1",
+ "location": "WestUS",
+ "tags": {},
+ "properties": {
+ "storageSyncServiceStatus": 0,
+ "incomingTrafficPolicy": "AllowAllTraffic",
+ "storageSyncServiceUid": "\"3d1bf292-0f2a-4cc1-a3e1-60f35800e40c\""
+ },
+ "id": "/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1",
+ "type": "Microsoft.StorageSync/storageSyncServices"
+ },
+ {
+ "name": "SampleStorageSyncService_2",
+ "location": "WestUS",
+ "tags": {},
+ "properties": {
+ "storageSyncServiceStatus": 0,
+ "incomingTrafficPolicy": "AllowAllTraffic",
+ "storageSyncServiceUid": "\"2de01144-72da-4d7f-9d0c-e858855114a8\""
+ },
+ "id": "/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_2",
+ "type": "Microsoft.StorageSync/storageSyncServices"
+ },
+ {
+ "name": "SampleStorageSyncService_3",
+ "location": "WestUS",
+ "tags": {},
+ "properties": {
+ "storageSyncServiceStatus": 0,
+ "incomingTrafficPolicy": "AllowAllTraffic",
+ "storageSyncServiceUid": "\"b2c58ee5-933e-462c-8a9e-b30f2bdd8fa3\""
+ },
+ "id": "/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_3",
+ "type": "Microsoft.StorageSync/storageSyncServices"
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/StorageSyncServices_ListBySubscription.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/StorageSyncServices_ListBySubscription.json
new file mode 100644
index 000000000000..568500faeac6
--- /dev/null
+++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/StorageSyncServices_ListBySubscription.json
@@ -0,0 +1,54 @@
+{
+ "parameters": {
+ "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb",
+ "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": "SampleStorageSyncService_1",
+ "location": "WestUS",
+ "tags": {},
+ "properties": {
+ "storageSyncServiceStatus": 0,
+ "incomingTrafficPolicy": "AllowAllTraffic",
+ "storageSyncServiceUid": "\"3d1bf292-0f2a-4cc1-a3e1-60f35800e40c\""
+ },
+ "id": "/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1",
+ "type": "Microsoft.StorageSync/storageSyncServices"
+ },
+ {
+ "name": "SampleStorageSyncService_2",
+ "location": "WestUS",
+ "tags": {},
+ "properties": {
+ "storageSyncServiceStatus": 0,
+ "incomingTrafficPolicy": "AllowAllTraffic",
+ "storageSyncServiceUid": "\"2de01144-72da-4d7f-9d0c-e858855114a8\""
+ },
+ "id": "/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_2",
+ "type": "Microsoft.StorageSync/storageSyncServices"
+ },
+ {
+ "name": "SampleStorageSyncService_3",
+ "location": "WestUS",
+ "tags": {},
+ "properties": {
+ "storageSyncServiceStatus": 0,
+ "incomingTrafficPolicy": "AllowAllTraffic",
+ "storageSyncServiceUid": "\"b2c58ee5-933e-462c-8a9e-b30f2bdd8fa3\""
+ },
+ "id": "/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_3",
+ "type": "Microsoft.StorageSync/storageSyncServices"
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/StorageSyncServices_Update.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/StorageSyncServices_Update.json
new file mode 100644
index 000000000000..b5c846d0f8ca
--- /dev/null
+++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/StorageSyncServices_Update.json
@@ -0,0 +1,43 @@
+{
+ "parameters": {
+ "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb",
+ "resourceGroupName": "SampleResourceGroup_1",
+ "storageSyncServiceName": "SampleStorageSyncService_1",
+ "parameters": {
+ "properties": {
+ "incomingTrafficPolicy": "AllowAllTraffic"
+ },
+ "tags": {
+ "Environment": "Test",
+ "Dept": "IT"
+ }
+ },
+ "api-version": "2020-09-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "name": "SampleStorageSyncService_1",
+ "location": "WestUS",
+ "properties": {
+ "incomingTrafficPolicy": "AllowAllTraffic"
+ },
+ "tags": {
+ "Environment": "Test",
+ "Dept": "IT"
+ },
+ "id": "/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1",
+ "type": "Microsoft.StorageSync/storageSyncServices"
+ }
+ },
+ "202": {
+ "headers": {
+ "Azure-AsyncOperation": "https://management.azure.com/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/workflows/828219ea-083e-48b5-89ea-8fd9991b2e75/operations/fe680c98-5725-49c8-b0dc-5e29745f752b?api-version=2020-09-01",
+ "Location": "https://management.azure.com/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/workflows/828219ea-083e-48b5-89ea-8fd9991b2e75/operationresults/fe680c98-5725-49c8-b0dc-5e29745f752b?api-version=2020-09-01",
+ "Retry-After": "10",
+ "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403",
+ "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730"
+ }
+ }
+ }
+}
diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/SyncGroups_Create.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/SyncGroups_Create.json
new file mode 100644
index 000000000000..d06976ee1f44
--- /dev/null
+++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/SyncGroups_Create.json
@@ -0,0 +1,24 @@
+{
+ "parameters": {
+ "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb",
+ "resourceGroupName": "SampleResourceGroup_1",
+ "storageSyncServiceName": "SampleStorageSyncService_1",
+ "syncGroupName": "SampleSyncGroup_1",
+ "api-version": "2020-09-01",
+ "parameters": {
+ "properties": {}
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "name": "SampleSyncGroup_1",
+ "properties": {
+ "uniqueId": "7868e4ee-8ddd-4a2d-941b-0041f6052a8a"
+ },
+ "id": "/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/syncGroups/SampleSyncGroup_1",
+ "type": "Microsoft.StorageSync/storageSyncServices/syncGroups"
+ }
+ }
+ }
+}
diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/SyncGroups_Delete.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/SyncGroups_Delete.json
new file mode 100644
index 000000000000..ccea7daf7689
--- /dev/null
+++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/SyncGroups_Delete.json
@@ -0,0 +1,18 @@
+{
+ "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"
+ }
+ },
+ "204": {}
+ }
+}
diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/SyncGroups_Get.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/SyncGroups_Get.json
new file mode 100644
index 000000000000..0f13de87dfb7
--- /dev/null
+++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/SyncGroups_Get.json
@@ -0,0 +1,26 @@
+{
+ "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": {
+ "name": "SampleSyncGroup_1",
+ "properties": {
+ "uniqueId": "191660cd-6a1a-4f8c-9787-a6bed206a1dd",
+ "syncGroupStatus": "0"
+ },
+ "id": "/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SSS_Restore_08-08_Test112/syncGroups/SampleSyncGroup_1",
+ "type": "Microsoft.StorageSync/storageSyncServices/syncGroups"
+ }
+ }
+ }
+}
diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/SyncGroups_ListByStorageSyncService.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/SyncGroups_ListByStorageSyncService.json
new file mode 100644
index 000000000000..d385682f66b8
--- /dev/null
+++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/SyncGroups_ListByStorageSyncService.json
@@ -0,0 +1,29 @@
+{
+ "parameters": {
+ "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb",
+ "resourceGroupName": "SampleResourceGroup_1",
+ "storageSyncServiceName": "SampleStorageSyncService_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": "SampleSyncGroup_1",
+ "properties": {
+ "uniqueId": "191660cd-6a1a-4f8c-9787-a6bed206a1dd",
+ "syncGroupStatus": "0"
+ },
+ "id": "/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SSS_Restore_08-08_Test112/syncGroups/SampleSyncGroup_1",
+ "type": "Microsoft.StorageSync/storageSyncServices/syncGroups"
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/Workflows_Abort.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/Workflows_Abort.json
new file mode 100644
index 000000000000..0880db1c7ae3
--- /dev/null
+++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/Workflows_Abort.json
@@ -0,0 +1,17 @@
+{
+ "parameters": {
+ "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb",
+ "resourceGroupName": "SampleResourceGroup_1",
+ "storageSyncServiceName": "SampleStorageSyncService_1",
+ "workflowId": "7ffd50b3-5574-478d-9ff2-9371bc42ce68",
+ "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"
+ }
+ }
+ }
+}
diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/Workflows_Get.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/Workflows_Get.json
new file mode 100644
index 000000000000..97767e2e5f66
--- /dev/null
+++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/Workflows_Get.json
@@ -0,0 +1,32 @@
+{
+ "parameters": {
+ "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb",
+ "resourceGroupName": "SampleResourceGroup_1",
+ "storageSyncServiceName": "SampleStorageSyncService_1",
+ "workflowId": "828219ea-083e-48b5-89ea-8fd9991b2e75",
+ "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": "828219ea-083e-48b5-89ea-8fd9991b2e75",
+ "properties": {
+ "status": "succeeded",
+ "lastOperationId": "\"fe680c98-5725-49c8-b0dc-5e29745f752b\"",
+ "operation": "do",
+ "lastStepName": "runServerJob",
+ "steps": "[{\"name\":\"validateInput\",\"friendlyName\":\"validateInput\",\"status\":\"Succeeded\",\"error\":null},{\"name\":\"newServerEndpoint\",\"friendlyName\":\"newServerEndpoint\",\"status\":\"Succeeded\",\"error\":null},{\"name\":\"updateReplicaGroupCertificates\",\"friendlyName\":\"updateReplicaGroupCertificates\",\"status\":\"Succeeded\",\"error\":null},{\"name\":\"runServerJob\",\"friendlyName\":\"runServerJob\",\"status\":\"Succeeded\",\"error\":null}]",
+ "commandName": "ICreateServerEndpointWorkflow",
+ "createdTimestamp": "2019-04-17T19:04:59.1959227Z",
+ "lastStatusTimestamp": "2019-04-17T19:04:59.1959227Z"
+ },
+ "id": "/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/workflows/828219ea-083e-48b5-89ea-8fd9991b2e75",
+ "type": "Microsoft.StorageSync/storageSyncServices/workflows"
+ }
+ }
+ }
+}
diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/Workflows_ListByStorageSyncService.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/Workflows_ListByStorageSyncService.json
new file mode 100644
index 000000000000..841dcbcf146d
--- /dev/null
+++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/Workflows_ListByStorageSyncService.json
@@ -0,0 +1,32 @@
+{
+ "parameters": {
+ "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb",
+ "resourceGroupName": "SampleResourceGroup_1",
+ "storageSyncServiceName": "SampleStorageSyncService_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": "828219ea-083e-48b5-89ea-8fd9991b2e75",
+ "properties": {
+ "status": "succeeded",
+ "lastOperationId": "\"fe680c98-5725-49c8-b0dc-5e29745f752b\"",
+ "operation": "do",
+ "lastStepName": "runServerJob",
+ "steps": "[{\"name\":\"validateInput\",\"friendlyName\":\"validateInput\",\"status\":\"Succeeded\",\"error\":null},{\"name\":\"newServerEndpoint\",\"friendlyName\":\"newServerEndpoint\",\"status\":\"Succeeded\",\"error\":null},{\"name\":\"updateReplicaGroupCertificates\",\"friendlyName\":\"updateReplicaGroupCertificates\",\"status\":\"Succeeded\",\"error\":null},{\"name\":\"runServerJob\",\"friendlyName\":\"runServerJob\",\"status\":\"Succeeded\",\"error\":null}]"
+ },
+ "id": "/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/workflows/828219ea-083e-48b5-89ea-8fd9991b2e75",
+ "type": "Microsoft.StorageSync/storageSyncServices/workflows"
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/storagesync.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/storagesync.json
new file mode 100644
index 000000000000..14a65f0b4501
--- /dev/null
+++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/storagesync.json
@@ -0,0 +1,5195 @@
+{
+ "swagger": "2.0",
+ "info": {
+ "title": "Microsoft Storage Sync",
+ "description": "Microsoft Storage Sync Service API",
+ "version": "2020-09-01",
+ "x-ms-code-generation-settings": {
+ "name": "StorageSyncManagementClient"
+ }
+ },
+ "host": "management.azure.com",
+ "schemes": [
+ "https"
+ ],
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "paths": {
+ "/providers/Microsoft.StorageSync/operations": {
+ "get": {
+ "tags": [
+ "ResourceProvider",
+ "Operations"
+ ],
+ "operationId": "Operations_List",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter"
+ }
+ ],
+ "description": "Lists all of the available Storage Sync Rest API operations.",
+ "x-ms-examples": {
+ "Operations_List": {
+ "$ref": "./examples/Operations_List.json"
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Array of operations resources in the Resource Provider",
+ "schema": {
+ "$ref": "#/definitions/OperationEntityListResult"
+ },
+ "headers": {
+ "x-ms-request-id": {
+ "description": "request id.",
+ "type": "string"
+ },
+ "x-ms-correlation-request-id": {
+ "description": "correlation request id.",
+ "type": "string"
+ }
+ }
+ },
+ "default": {
+ "description": "Error message indicating why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/StorageSyncError"
+ }
+ }
+ },
+ "deprecated": false,
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/providers/Microsoft.StorageSync/locations/{locationName}/checkNameAvailability": {
+ "post": {
+ "tags": [
+ "StorageSyncService"
+ ],
+ "operationId": "StorageSyncServices_CheckNameAvailability",
+ "x-ms-examples": {
+ "StorageSyncServiceCheckNameAvailability_Available": {
+ "$ref": "./examples/StorageSyncServiceCheckNameAvailability_Available.json"
+ },
+ "StorageSyncServiceCheckNameAvailability_AlreadyExists": {
+ "$ref": "./examples/StorageSyncServiceCheckNameAvailability_AlreadyExists.json"
+ }
+ },
+ "description": "Check the give namespace name availability.",
+ "parameters": [
+ {
+ "name": "locationName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The desired region for the name check."
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/CheckNameAvailabilityParameters"
+ },
+ "description": "Parameters to check availability of the given namespace name"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "check availability returned successfully.",
+ "schema": {
+ "$ref": "#/definitions/CheckNameAvailabilityResult"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}": {
+ "put": {
+ "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"
+ },
+ {
+ "name": "storageSyncServiceName",
+ "in": "path",
+ "description": "Name of Storage Sync Service resource.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "description": "Storage Sync Service resource name.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/StorageSyncServiceCreateParameters"
+ }
+ }
+ ],
+ "tags": [
+ "StorageSyncServices Resource"
+ ],
+ "operationId": "StorageSyncServices_Create",
+ "description": "Create a new StorageSyncService.",
+ "x-ms-examples": {
+ "StorageSyncServices_Create": {
+ "$ref": "./examples/StorageSyncServices_Create.json"
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Storage Sync Service object created/updated",
+ "schema": {
+ "$ref": "#/definitions/StorageSyncService"
+ }
+ },
+ "202": {
+ "description": "Asynchronous Operation Status Location",
+ "headers": {
+ "Azure-AsyncOperation": {
+ "description": "Operation Status Location URI",
+ "type": "string"
+ },
+ "Location": {
+ "description": "Operation Status Location URI",
+ "type": "string"
+ },
+ "Retry-After": {
+ "description": "Retry After",
+ "type": "string"
+ },
+ "x-ms-request-id": {
+ "description": "Request id",
+ "type": "string"
+ },
+ "x-ms-correlation-request-id": {
+ "description": "correlation request id",
+ "type": "string"
+ }
+ }
+ },
+ "default": {
+ "description": "Error message indicating why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/StorageSyncError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true
+ },
+ "get": {
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "name": "storageSyncServiceName",
+ "in": "path",
+ "description": "Name of Storage Sync Service resource.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter"
+ }
+ ],
+ "tags": [
+ "StorageSyncServices Resource"
+ ],
+ "operationId": "StorageSyncServices_Get",
+ "description": "Get a given StorageSyncService.",
+ "x-ms-examples": {
+ "StorageSyncServices_Get": {
+ "$ref": "./examples/StorageSyncServices_Get.json"
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Storage Sync Service object",
+ "schema": {
+ "$ref": "#/definitions/StorageSyncService"
+ },
+ "headers": {
+ "x-ms-request-id": {
+ "description": "request id.",
+ "type": "string"
+ },
+ "x-ms-correlation-request-id": {
+ "description": "correlation request id.",
+ "type": "string"
+ }
+ }
+ },
+ "default": {
+ "description": "Error message indicating why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/StorageSyncError"
+ }
+ }
+ }
+ },
+ "patch": {
+ "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"
+ },
+ {
+ "name": "storageSyncServiceName",
+ "in": "path",
+ "description": "Name of Storage Sync Service resource.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "description": "Storage Sync Service resource.",
+ "schema": {
+ "$ref": "#/definitions/StorageSyncServiceUpdateParameters"
+ }
+ }
+ ],
+ "tags": [
+ "StorageSyncServices Resource"
+ ],
+ "operationId": "StorageSyncServices_Update",
+ "description": "Patch a given StorageSyncService.",
+ "x-ms-examples": {
+ "StorageSyncServices_Update": {
+ "$ref": "./examples/StorageSyncServices_Update.json"
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Storage Sync Service object created/updated",
+ "schema": {
+ "$ref": "#/definitions/StorageSyncService"
+ },
+ "headers": {
+ "x-ms-request-id": {
+ "description": "request id.",
+ "type": "string"
+ },
+ "x-ms-correlation-request-id": {
+ "description": "correlation request id.",
+ "type": "string"
+ }
+ }
+ },
+ "202": {
+ "description": "Asynchronous Operation Status Location",
+ "headers": {
+ "Azure-AsyncOperation": {
+ "description": "Operation Status Location URI",
+ "type": "string"
+ },
+ "Location": {
+ "description": "Operation Status Location URI",
+ "type": "string"
+ },
+ "Retry-After": {
+ "description": "Retry After",
+ "type": "string"
+ },
+ "x-ms-request-id": {
+ "description": "Request id",
+ "type": "string"
+ },
+ "x-ms-correlation-request-id": {
+ "description": "correlation request id",
+ "type": "string"
+ }
+ }
+ },
+ "default": {
+ "description": "Error message indicating why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/StorageSyncError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true
+ },
+ "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"
+ },
+ {
+ "name": "storageSyncServiceName",
+ "in": "path",
+ "description": "Name of Storage Sync Service resource.",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "tags": [
+ "StorageSyncServices Resource"
+ ],
+ "operationId": "StorageSyncServices_Delete",
+ "description": "Delete a given StorageSyncService.",
+ "x-ms-examples": {
+ "StorageSyncServices_Delete": {
+ "$ref": "./examples/StorageSyncServices_Delete.json"
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Storage Sync Service object was deleted.",
+ "headers": {
+ "x-ms-request-id": {
+ "description": "request id.",
+ "type": "string"
+ },
+ "x-ms-correlation-request-id": {
+ "description": "correlation request id.",
+ "type": "string"
+ }
+ }
+ },
+ "202": {
+ "description": "Asynchronous Operation Status Location",
+ "headers": {
+ "Azure-AsyncOperation": {
+ "description": "Operation Status Location URI",
+ "type": "string"
+ },
+ "Location": {
+ "description": "Operation Status Location URI",
+ "type": "string"
+ },
+ "Retry-After": {
+ "description": "Retry After",
+ "type": "string"
+ },
+ "x-ms-request-id": {
+ "description": "Request id",
+ "type": "string"
+ },
+ "x-ms-correlation-request-id": {
+ "description": "correlation request id",
+ "type": "string"
+ }
+ }
+ },
+ "204": {
+ "description": "Storage Sync Service Resource doesn't exist"
+ },
+ "default": {
+ "description": "Error message indicating why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/StorageSyncError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices": {
+ "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"
+ }
+ ],
+ "tags": [
+ "StorageSyncServices Resource"
+ ],
+ "operationId": "StorageSyncServices_ListByResourceGroup",
+ "description": "Get a StorageSyncService list by Resource group name.",
+ "x-ms-examples": {
+ "StorageSyncServices_ListByResourceGroup": {
+ "$ref": "./examples/StorageSyncServices_ListByResourceGroup.json"
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Array of registered Storage Sync Service resources in the Resource Group",
+ "schema": {
+ "$ref": "#/definitions/StorageSyncServiceArray"
+ },
+ "headers": {
+ "x-ms-request-id": {
+ "description": "request id.",
+ "type": "string"
+ },
+ "x-ms-correlation-request-id": {
+ "description": "correlation request id.",
+ "type": "string"
+ }
+ }
+ },
+ "default": {
+ "description": "Error message indicating why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/StorageSyncError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": null
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/providers/Microsoft.StorageSync/storageSyncServices": {
+ "get": {
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter"
+ }
+ ],
+ "tags": [
+ "StorageSyncServices Resource"
+ ],
+ "operationId": "StorageSyncServices_ListBySubscription",
+ "description": "Get a StorageSyncService list by subscription.",
+ "x-ms-examples": {
+ "StorageSyncServices_ListBySubscription": {
+ "$ref": "./examples/StorageSyncServices_ListBySubscription.json"
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Array of registered Storage Sync Service resources in the subscription.",
+ "schema": {
+ "$ref": "#/definitions/StorageSyncServiceArray"
+ },
+ "headers": {
+ "x-ms-request-id": {
+ "description": "request id.",
+ "type": "string"
+ },
+ "x-ms-correlation-request-id": {
+ "description": "correlation request id.",
+ "type": "string"
+ }
+ }
+ },
+ "default": {
+ "description": "Error message indicating why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/StorageSyncError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": null
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/privateLinkResources": {
+ "get": {
+ "tags": [
+ "PrivateLinkResources"
+ ],
+ "operationId": "PrivateLinkResources_ListByStorageSyncService",
+ "description": "Gets the private link resources that need to be created for a storage sync service.",
+ "x-ms-examples": {
+ "PrivateLinkResources_List": {
+ "$ref": "./examples/PrivateLinkResources_List.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/StorageSyncServiceNameParameter"
+ },
+ {
+ "$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 private link resources.",
+ "schema": {
+ "$ref": "../../../../../common-types/resource-management/v1/privatelinks.json#/definitions/PrivateLinkResourceListResult"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/privateEndpointConnections/{privateEndpointConnectionName}": {
+ "get": {
+ "tags": [
+ "PrivateEndpointConnections"
+ ],
+ "operationId": "PrivateEndpointConnections_Get",
+ "description": "Gets the specified private endpoint connection associated with the storage sync service.",
+ "x-ms-examples": {
+ "PrivateEndpointConnections_Get": {
+ "$ref": "./examples/PrivateEndpointConnections_Get.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/StorageSyncServiceNameParameter"
+ },
+ {
+ "$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/privatelinks.json#/parameters/PrivateEndpointConnectionName"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK -- Get the private endpoint connection properties successfully.",
+ "schema": {
+ "$ref": "../../../../../common-types/resource-management/v1/privatelinks.json#/definitions/PrivateEndpointConnection"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/StorageSyncError"
+ }
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "PrivateEndpointConnections"
+ ],
+ "operationId": "PrivateEndpointConnections_Create",
+ "description": "Update the state of specified private endpoint connection associated with the storage sync service.",
+ "x-ms-examples": {
+ "PrivateEndpointConnections_Create": {
+ "$ref": "./examples/PrivateEndpointConnections_Create.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/StorageSyncServiceNameParameter"
+ },
+ {
+ "$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/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": "OK -- Update the private endpoint connection properties successfully.",
+ "schema": {
+ "$ref": "../../../../../common-types/resource-management/v1/privatelinks.json#/definitions/PrivateEndpointConnection"
+ }
+ },
+ "202": {
+ "description": "Asynchronous Operation Status Location",
+ "headers": {
+ "Azure-AsyncOperation": {
+ "description": "Operation Status Location URI",
+ "type": "string"
+ },
+ "Location": {
+ "description": "Operation Status Location URI",
+ "type": "string"
+ },
+ "Retry-After": {
+ "description": "Retry After",
+ "type": "string"
+ },
+ "x-ms-request-id": {
+ "description": "Request id",
+ "type": "string"
+ },
+ "x-ms-correlation-request-id": {
+ "description": "correlation request id",
+ "type": "string"
+ }
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/StorageSyncError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true
+ },
+ "delete": {
+ "tags": [
+ "PrivateEndpointConnections"
+ ],
+ "operationId": "PrivateEndpointConnections_Delete",
+ "description": "Deletes the specified private endpoint connection associated with the storage sync service.",
+ "x-ms-examples": {
+ "PrivateEndpointConnections_Delete": {
+ "$ref": "./examples/PrivateEndpointConnections_Delete.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/StorageSyncServiceNameParameter"
+ },
+ {
+ "$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/privatelinks.json#/parameters/PrivateEndpointConnectionName"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK -- Delete the private endpoint connection successfully."
+ },
+ "202": {
+ "description": "Asynchronous Operation Status Location",
+ "headers": {
+ "Azure-AsyncOperation": {
+ "description": "Operation Status Location URI",
+ "type": "string"
+ },
+ "Location": {
+ "description": "Operation Status Location URI",
+ "type": "string"
+ },
+ "Retry-After": {
+ "description": "Retry After",
+ "type": "string"
+ },
+ "x-ms-request-id": {
+ "description": "Request id",
+ "type": "string"
+ },
+ "x-ms-correlation-request-id": {
+ "description": "correlation request id",
+ "type": "string"
+ }
+ }
+ },
+ "204": {
+ "description": "No Content -- The private endpoint connection does not exist."
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/StorageSyncError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/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"
+ },
+ {
+ "name": "storageSyncServiceName",
+ "in": "path",
+ "description": "Name of Storage Sync Service resource.",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "tags": [
+ "PrivateEndpointConnection Resource"
+ ],
+ "operationId": "PrivateEndpointConnections_ListByStorageSyncService",
+ "description": "Get a PrivateEndpointConnection List.",
+ "x-ms-examples": {
+ "PrivateEndpointConnections_ListByStorageSyncService": {
+ "$ref": "./examples/PrivateEndpointConnections_ListByStorageSyncService.json"
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Array of Sync Group resources in Storage Sync Service",
+ "schema": {
+ "$ref": "../../../../../common-types/resource-management/v1/privatelinks.json#/definitions/PrivateEndpointConnectionListResult"
+ },
+ "headers": {
+ "x-ms-request-id": {
+ "description": "request id.",
+ "type": "string"
+ },
+ "x-ms-correlation-request-id": {
+ "description": "correlation request id.",
+ "type": "string"
+ }
+ }
+ },
+ "default": {
+ "description": "Error message indicating why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/StorageSyncError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": null
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups": {
+ "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"
+ },
+ {
+ "name": "storageSyncServiceName",
+ "in": "path",
+ "description": "Name of Storage Sync Service resource.",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "tags": [
+ "SyncGroup Resource"
+ ],
+ "operationId": "SyncGroups_ListByStorageSyncService",
+ "description": "Get a SyncGroup List.",
+ "x-ms-examples": {
+ "SyncGroups_ListByStorageSyncService": {
+ "$ref": "./examples/SyncGroups_ListByStorageSyncService.json"
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Array of Sync Group resources in Storage Sync Service",
+ "schema": {
+ "$ref": "#/definitions/SyncGroupArray"
+ },
+ "headers": {
+ "x-ms-request-id": {
+ "description": "request id.",
+ "type": "string"
+ },
+ "x-ms-correlation-request-id": {
+ "description": "correlation request id.",
+ "type": "string"
+ }
+ }
+ },
+ "default": {
+ "description": "Error message indicating why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/StorageSyncError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": null
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups/{syncGroupName}": {
+ "put": {
+ "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"
+ },
+ {
+ "name": "storageSyncServiceName",
+ "in": "path",
+ "description": "Name of Storage Sync Service resource.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "syncGroupName",
+ "in": "path",
+ "description": "Name of Sync Group resource.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "description": "Sync Group Body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/SyncGroupCreateParameters"
+ }
+ }
+ ],
+ "tags": [
+ "SyncGroup Resource"
+ ],
+ "operationId": "SyncGroups_Create",
+ "description": "Create a new SyncGroup.",
+ "x-ms-examples": {
+ "SyncGroups_Create": {
+ "$ref": "./examples/SyncGroups_Create.json"
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Sync Group object",
+ "schema": {
+ "$ref": "#/definitions/SyncGroup"
+ },
+ "headers": {
+ "x-ms-request-id": {
+ "description": "request id.",
+ "type": "string"
+ },
+ "x-ms-correlation-request-id": {
+ "description": "correlation request id.",
+ "type": "string"
+ }
+ }
+ },
+ "default": {
+ "description": "Error message indicating why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/StorageSyncError"
+ }
+ }
+ }
+ },
+ "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"
+ },
+ {
+ "name": "storageSyncServiceName",
+ "in": "path",
+ "description": "Name of Storage Sync Service resource.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "syncGroupName",
+ "in": "path",
+ "description": "Name of Sync Group resource.",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "tags": [
+ "SyncGroup Resource"
+ ],
+ "operationId": "SyncGroups_Get",
+ "description": "Get a given SyncGroup.",
+ "x-ms-examples": {
+ "SyncGroups_Get": {
+ "$ref": "./examples/SyncGroups_Get.json"
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Sync Group object",
+ "schema": {
+ "$ref": "#/definitions/SyncGroup"
+ },
+ "headers": {
+ "x-ms-request-id": {
+ "description": "request id.",
+ "type": "string"
+ },
+ "x-ms-correlation-request-id": {
+ "description": "correlation request id.",
+ "type": "string"
+ }
+ }
+ },
+ "default": {
+ "description": "Error message indicating why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/StorageSyncError"
+ }
+ }
+ }
+ },
+ "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"
+ },
+ {
+ "name": "storageSyncServiceName",
+ "in": "path",
+ "description": "Name of Storage Sync Service resource.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "syncGroupName",
+ "in": "path",
+ "description": "Name of Sync Group resource.",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "tags": [
+ "SyncGroup Resource"
+ ],
+ "operationId": "SyncGroups_Delete",
+ "description": "Delete a given SyncGroup.",
+ "x-ms-examples": {
+ "SyncGroups_Delete": {
+ "$ref": "./examples/SyncGroups_Delete.json"
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Sync Group object was deleted",
+ "headers": {
+ "x-ms-request-id": {
+ "description": "Request id",
+ "type": "string"
+ },
+ "x-ms-correlation-request-id": {
+ "description": "correlation request id",
+ "type": "string"
+ }
+ }
+ },
+ "204": {
+ "description": "Resource doesn't exist"
+ },
+ "default": {
+ "description": "Error message indicating why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/StorageSyncError"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups/{syncGroupName}/cloudEndpoints/{cloudEndpointName}": {
+ "put": {
+ "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"
+ },
+ {
+ "name": "storageSyncServiceName",
+ "in": "path",
+ "description": "Name of Storage Sync Service resource.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "syncGroupName",
+ "in": "path",
+ "description": "Name of Sync Group resource.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "cloudEndpointName",
+ "in": "path",
+ "description": "Name of Cloud Endpoint object.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "description": "Body of Cloud Endpoint resource.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/CloudEndpointCreateParameters"
+ }
+ }
+ ],
+ "tags": [
+ "CloudEndpoint Resource"
+ ],
+ "operationId": "CloudEndpoints_Create",
+ "description": "Create a new CloudEndpoint.",
+ "x-ms-examples": {
+ "CloudEndpoints_Create": {
+ "$ref": "./examples/CloudEndpoints_Create.json"
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Cloud Endpoint object",
+ "schema": {
+ "$ref": "#/definitions/CloudEndpoint"
+ },
+ "headers": {
+ "x-ms-request-id": {
+ "description": "request id.",
+ "type": "string"
+ },
+ "x-ms-correlation-request-id": {
+ "description": "correlation request id.",
+ "type": "string"
+ }
+ }
+ },
+ "202": {
+ "description": "Asynchronous Operation Status Location",
+ "headers": {
+ "Azure-AsyncOperation": {
+ "description": "Operation Status Location URI",
+ "type": "string"
+ },
+ "Location": {
+ "description": "Operation Status Location URI",
+ "type": "string"
+ },
+ "Retry-After": {
+ "description": "Retry After",
+ "type": "string"
+ },
+ "x-ms-request-id": {
+ "description": "Request id",
+ "type": "string"
+ },
+ "x-ms-correlation-request-id": {
+ "description": "correlation request id",
+ "type": "string"
+ }
+ }
+ },
+ "default": {
+ "description": "Error message indicating why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/StorageSyncError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true
+ },
+ "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"
+ },
+ {
+ "name": "storageSyncServiceName",
+ "in": "path",
+ "description": "Name of Storage Sync Service resource.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "syncGroupName",
+ "in": "path",
+ "description": "Name of Sync Group resource.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "cloudEndpointName",
+ "in": "path",
+ "description": "Name of Cloud Endpoint object.",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "tags": [
+ "CloudEndpoint Resource"
+ ],
+ "operationId": "CloudEndpoints_Get",
+ "description": "Get a given CloudEndpoint.",
+ "x-ms-examples": {
+ "CloudEndpoints_Get": {
+ "$ref": "./examples/CloudEndpoints_Get.json"
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Cloud Endpoint object",
+ "schema": {
+ "$ref": "#/definitions/CloudEndpoint"
+ },
+ "headers": {
+ "x-ms-request-id": {
+ "description": "request id.",
+ "type": "string"
+ },
+ "x-ms-correlation-request-id": {
+ "description": "correlation request id.",
+ "type": "string"
+ }
+ }
+ },
+ "default": {
+ "description": "Error message indicating why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/StorageSyncError"
+ }
+ }
+ }
+ },
+ "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"
+ },
+ {
+ "name": "storageSyncServiceName",
+ "in": "path",
+ "description": "Name of Storage Sync Service resource.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "syncGroupName",
+ "in": "path",
+ "description": "Name of Sync Group resource.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "cloudEndpointName",
+ "in": "path",
+ "description": "Name of Cloud Endpoint object.",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "tags": [
+ "CloudEndpoint Resource"
+ ],
+ "operationId": "CloudEndpoints_Delete",
+ "description": "Delete a given CloudEndpoint.",
+ "x-ms-examples": {
+ "CloudEndpoints_Delete": {
+ "$ref": "./examples/CloudEndpoints_Delete.json"
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "headers": {
+ "x-ms-request-id": {
+ "description": "request id.",
+ "type": "string"
+ },
+ "x-ms-correlation-request-id": {
+ "description": "correlation request id.",
+ "type": "string"
+ }
+ }
+ },
+ "202": {
+ "description": "Asynchronous Operation Status Location",
+ "headers": {
+ "Azure-AsyncOperation": {
+ "description": "Operation Status Location URI",
+ "type": "string"
+ },
+ "Location": {
+ "description": "Operation Status Location URI",
+ "type": "string"
+ },
+ "Retry-After": {
+ "description": "Retry After",
+ "type": "string"
+ },
+ "x-ms-request-id": {
+ "description": "Request id",
+ "type": "string"
+ },
+ "x-ms-correlation-request-id": {
+ "description": "correlation request id",
+ "type": "string"
+ }
+ }
+ },
+ "204": {
+ "description": "Resource doesn't exist"
+ },
+ "default": {
+ "description": "Error message indicating why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/StorageSyncError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups/{syncGroupName}/cloudEndpoints": {
+ "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"
+ },
+ {
+ "name": "storageSyncServiceName",
+ "in": "path",
+ "description": "Name of Storage Sync Service resource.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "syncGroupName",
+ "in": "path",
+ "description": "Name of Sync Group resource.",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "tags": [
+ "CloudEndpoint Resource"
+ ],
+ "operationId": "CloudEndpoints_ListBySyncGroup",
+ "description": "Get a CloudEndpoint List.",
+ "x-ms-examples": {
+ "CloudEndpoints_ListBySyncGroup": {
+ "$ref": "./examples/CloudEndpoints_ListBySyncGroup.json"
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Array of Cloud Endpoint resources in Sync Group",
+ "schema": {
+ "$ref": "#/definitions/CloudEndpointArray"
+ },
+ "headers": {
+ "x-ms-request-id": {
+ "description": "request id.",
+ "type": "string"
+ },
+ "x-ms-correlation-request-id": {
+ "description": "correlation request id.",
+ "type": "string"
+ }
+ }
+ },
+ "default": {
+ "description": "Error message indicating why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/StorageSyncError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": null
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups/{syncGroupName}/cloudEndpoints/{cloudEndpointName}/prebackup": {
+ "post": {
+ "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"
+ },
+ {
+ "name": "storageSyncServiceName",
+ "in": "path",
+ "description": "Name of Storage Sync Service resource.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "syncGroupName",
+ "in": "path",
+ "description": "Name of Sync Group resource.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "cloudEndpointName",
+ "in": "path",
+ "description": "Name of Cloud Endpoint object.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "description": "Body of Backup request.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/BackupRequest"
+ }
+ }
+ ],
+ "tags": [
+ "CloudEndpoint Resource",
+ "Actions",
+ "Backup Restore"
+ ],
+ "operationId": "CloudEndpoints_PreBackup",
+ "description": "Pre Backup a given CloudEndpoint.",
+ "x-ms-examples": {
+ "CloudEndpoints_PreBackup": {
+ "$ref": "./examples/CloudEndpoints_PreBackup.json"
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "headers": {
+ "Location": {
+ "description": "Operation Status Location URI",
+ "type": "string"
+ },
+ "x-ms-request-id": {
+ "description": "request id.",
+ "type": "string"
+ },
+ "x-ms-correlation-request-id": {
+ "description": "correlation request id.",
+ "type": "string"
+ }
+ }
+ },
+ "202": {
+ "description": "Asynchronous Operation Status Location",
+ "headers": {
+ "Location": {
+ "description": "Operation Status Location URI",
+ "type": "string"
+ },
+ "x-ms-request-id": {
+ "description": "request id.",
+ "type": "string"
+ },
+ "x-ms-correlation-request-id": {
+ "description": "correlation request id.",
+ "type": "string"
+ }
+ }
+ },
+ "default": {
+ "description": "Error message indicating why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/StorageSyncError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups/{syncGroupName}/cloudEndpoints/{cloudEndpointName}/postbackup": {
+ "post": {
+ "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"
+ },
+ {
+ "name": "storageSyncServiceName",
+ "in": "path",
+ "description": "Name of Storage Sync Service resource.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "syncGroupName",
+ "in": "path",
+ "description": "Name of Sync Group resource.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "cloudEndpointName",
+ "in": "path",
+ "description": "Name of Cloud Endpoint object.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "description": "Body of Backup request.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/BackupRequest"
+ }
+ }
+ ],
+ "tags": [
+ "CloudEndpoint Resource",
+ "Actions",
+ "Backup Restore"
+ ],
+ "operationId": "CloudEndpoints_PostBackup",
+ "description": "Post Backup a given CloudEndpoint.",
+ "x-ms-examples": {
+ "CloudEndpoints_PostBackup": {
+ "$ref": "./examples/CloudEndpoints_PostBackup.json"
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "schema": {
+ "$ref": "#/definitions/PostBackupResponse"
+ },
+ "headers": {
+ "Location": {
+ "description": "Operation Status Location URI",
+ "type": "string"
+ },
+ "x-ms-request-id": {
+ "description": "request id.",
+ "type": "string"
+ },
+ "x-ms-correlation-request-id": {
+ "description": "correlation request id.",
+ "type": "string"
+ }
+ }
+ },
+ "202": {
+ "description": "Asynchronous Operation Status Location",
+ "headers": {
+ "Location": {
+ "description": "Operation Status Location URI",
+ "type": "string"
+ },
+ "x-ms-request-id": {
+ "description": "request id.",
+ "type": "string"
+ },
+ "x-ms-correlation-request-id": {
+ "description": "correlation request id.",
+ "type": "string"
+ }
+ }
+ },
+ "default": {
+ "description": "Error message indicating why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/StorageSyncError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups/{syncGroupName}/cloudEndpoints/{cloudEndpointName}/prerestore": {
+ "post": {
+ "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"
+ },
+ {
+ "name": "storageSyncServiceName",
+ "in": "path",
+ "description": "Name of Storage Sync Service resource.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "syncGroupName",
+ "in": "path",
+ "description": "Name of Sync Group resource.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "cloudEndpointName",
+ "in": "path",
+ "description": "Name of Cloud Endpoint object.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "description": "Body of Cloud Endpoint object.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/PreRestoreRequest"
+ }
+ }
+ ],
+ "tags": [
+ "CloudEndpoint Resource",
+ "Actions",
+ "Backup Restore"
+ ],
+ "operationId": "CloudEndpoints_PreRestore",
+ "description": "Pre Restore a given CloudEndpoint.",
+ "x-ms-examples": {
+ "CloudEndpoints_PreRestore": {
+ "$ref": "./examples/CloudEndpoints_PreRestore.json"
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Ok"
+ },
+ "202": {
+ "description": "Asynchronous Operation Status Location",
+ "headers": {
+ "Location": {
+ "description": "Operation Status Location URI",
+ "type": "string"
+ },
+ "x-ms-request-id": {
+ "description": "request id.",
+ "type": "string"
+ },
+ "x-ms-correlation-request-id": {
+ "description": "correlation request id.",
+ "type": "string"
+ }
+ }
+ },
+ "default": {
+ "description": "Error message indicating why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/StorageSyncError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups/{syncGroupName}/cloudEndpoints/{cloudEndpointName}/restoreheartbeat": {
+ "post": {
+ "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"
+ },
+ {
+ "name": "storageSyncServiceName",
+ "in": "path",
+ "description": "Name of Storage Sync Service resource.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "syncGroupName",
+ "in": "path",
+ "description": "Name of Sync Group resource.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "cloudEndpointName",
+ "in": "path",
+ "description": "Name of Cloud Endpoint object.",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "tags": [
+ "CloudEndpoint Resource",
+ "Actions",
+ "Backup Restore"
+ ],
+ "operationId": "CloudEndpoints_restoreheartbeat",
+ "description": "Restore Heartbeat a given CloudEndpoint.",
+ "x-ms-examples": {
+ "CloudEndpoints_restoreheartbeat": {
+ "$ref": "./examples/CloudEndpoints_RestoreHeatbeat.json"
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Restore Heartbeat Operation has ran successfully.",
+ "headers": {
+ "x-ms-request-id": {
+ "description": "request id.",
+ "type": "string"
+ },
+ "x-ms-correlation-request-id": {
+ "description": "correlation request id.",
+ "type": "string"
+ }
+ }
+ },
+ "default": {
+ "description": "Error message indicating why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/StorageSyncError"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups/{syncGroupName}/cloudEndpoints/{cloudEndpointName}/postrestore": {
+ "post": {
+ "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"
+ },
+ {
+ "name": "storageSyncServiceName",
+ "in": "path",
+ "description": "Name of Storage Sync Service resource.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "syncGroupName",
+ "in": "path",
+ "description": "Name of Sync Group resource.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "cloudEndpointName",
+ "in": "path",
+ "description": "Name of Cloud Endpoint object.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "description": "Body of Cloud Endpoint object.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/PostRestoreRequest"
+ }
+ }
+ ],
+ "tags": [
+ "CloudEndpoint Resource",
+ "Actions",
+ "Backup Restore"
+ ],
+ "operationId": "CloudEndpoints_PostRestore",
+ "description": "Post Restore a given CloudEndpoint.",
+ "x-ms-examples": {
+ "CloudEndpoints_PostRestore": {
+ "$ref": "./examples/CloudEndpoints_PostRestore.json"
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Ok"
+ },
+ "202": {
+ "description": "Asynchronous Operation Status Location",
+ "headers": {
+ "Location": {
+ "description": "Operation Status Location URI",
+ "type": "string"
+ },
+ "x-ms-request-id": {
+ "description": "request id.",
+ "type": "string"
+ },
+ "x-ms-correlation-request-id": {
+ "description": "correlation request id.",
+ "type": "string"
+ }
+ }
+ },
+ "default": {
+ "description": "Error message indicating why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/StorageSyncError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups/{syncGroupName}/cloudEndpoints/{cloudEndpointName}/triggerChangeDetection": {
+ "post": {
+ "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"
+ },
+ {
+ "name": "storageSyncServiceName",
+ "in": "path",
+ "description": "Name of Storage Sync Service resource.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "syncGroupName",
+ "in": "path",
+ "description": "Name of Sync Group resource.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "cloudEndpointName",
+ "in": "path",
+ "description": "Name of Cloud Endpoint object.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "description": "Trigger Change Detection Action parameters.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/TriggerChangeDetectionParameters"
+ }
+ }
+ ],
+ "tags": [
+ "CloudEndpoint Resource",
+ "Actions",
+ "Change Detection"
+ ],
+ "operationId": "CloudEndpoints_TriggerChangeDetection",
+ "description": "Triggers detection of changes performed on Azure File share connected to the specified Azure File Sync Cloud Endpoint.",
+ "x-ms-examples": {
+ "CloudEndpoints_TriggerChangeDetection": {
+ "$ref": "./examples/CloudEndpoints_TriggerChangeDetection.json"
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Ok"
+ },
+ "202": {
+ "description": "Asynchronous Operation Status Location",
+ "headers": {
+ "Location": {
+ "description": "Operation Status Location URI",
+ "type": "string"
+ },
+ "x-ms-request-id": {
+ "description": "request id.",
+ "type": "string"
+ },
+ "x-ms-correlation-request-id": {
+ "description": "correlation request id.",
+ "type": "string"
+ }
+ }
+ },
+ "default": {
+ "description": "Error message indicating why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/StorageSyncError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups/{syncGroupName}/serverEndpoints/{serverEndpointName}": {
+ "put": {
+ "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"
+ },
+ {
+ "name": "storageSyncServiceName",
+ "in": "path",
+ "description": "Name of Storage Sync Service resource.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "syncGroupName",
+ "in": "path",
+ "description": "Name of Sync Group resource.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "serverEndpointName",
+ "in": "path",
+ "description": "Name of Server Endpoint object.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "description": "Body of Server Endpoint object.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/ServerEndpointCreateParameters"
+ }
+ }
+ ],
+ "tags": [
+ "ServerEndpoint Resource"
+ ],
+ "operationId": "ServerEndpoints_Create",
+ "description": "Create a new ServerEndpoint.",
+ "x-ms-examples": {
+ "ServerEndpoints_Create": {
+ "$ref": "./examples/ServerEndpoints_Create.json"
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Server Endpoint object",
+ "schema": {
+ "$ref": "#/definitions/ServerEndpoint"
+ },
+ "headers": {
+ "x-ms-request-id": {
+ "description": "request id.",
+ "type": "string"
+ },
+ "x-ms-correlation-request-id": {
+ "description": "correlation request id.",
+ "type": "string"
+ }
+ }
+ },
+ "202": {
+ "description": "Asynchronous Operation Status Location",
+ "headers": {
+ "Azure-AsyncOperation": {
+ "description": "Operation Status Location URI",
+ "type": "string"
+ },
+ "Location": {
+ "description": "Operation Status Location URI",
+ "type": "string"
+ },
+ "x-ms-request-id": {
+ "description": "request id.",
+ "type": "string"
+ },
+ "x-ms-correlation-request-id": {
+ "description": "correlation request id.",
+ "type": "string"
+ }
+ }
+ },
+ "default": {
+ "description": "Error message indicating why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/StorageSyncError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true
+ },
+ "patch": {
+ "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"
+ },
+ {
+ "name": "storageSyncServiceName",
+ "in": "path",
+ "description": "Name of Storage Sync Service resource.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "syncGroupName",
+ "in": "path",
+ "description": "Name of Sync Group resource.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "serverEndpointName",
+ "in": "path",
+ "description": "Name of Server Endpoint object.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "description": "Any of the properties applicable in PUT request.",
+ "schema": {
+ "$ref": "#/definitions/ServerEndpointUpdateParameters"
+ }
+ }
+ ],
+ "tags": [
+ "ServerEndpoint Resource"
+ ],
+ "operationId": "ServerEndpoints_Update",
+ "description": "Patch a given ServerEndpoint.",
+ "x-ms-examples": {
+ "ServerEndpoints_Update": {
+ "$ref": "./examples/ServerEndpoints_Update.json"
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Server Endpoint object",
+ "schema": {
+ "$ref": "#/definitions/ServerEndpoint"
+ },
+ "headers": {
+ "x-ms-request-id": {
+ "description": "request id.",
+ "type": "string"
+ },
+ "x-ms-correlation-request-id": {
+ "description": "correlation request id.",
+ "type": "string"
+ }
+ }
+ },
+ "202": {
+ "description": "Asynchronous Operation Status Location",
+ "headers": {
+ "Azure-AsyncOperation": {
+ "description": "Operation Status Location URI",
+ "type": "string"
+ },
+ "Location": {
+ "description": "Operation Status Location URI",
+ "type": "string"
+ },
+ "x-ms-request-id": {
+ "description": "request id.",
+ "type": "string"
+ },
+ "x-ms-correlation-request-id": {
+ "description": "correlation request id.",
+ "type": "string"
+ }
+ }
+ },
+ "default": {
+ "description": "Error message indicating why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/StorageSyncError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true
+ },
+ "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"
+ },
+ {
+ "name": "storageSyncServiceName",
+ "in": "path",
+ "description": "Name of Storage Sync Service resource.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "syncGroupName",
+ "in": "path",
+ "description": "Name of Sync Group resource.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "serverEndpointName",
+ "in": "path",
+ "description": "Name of Server Endpoint object.",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "tags": [
+ "ServerEndpoint Resource"
+ ],
+ "operationId": "ServerEndpoints_Get",
+ "description": "Get a ServerEndpoint.",
+ "x-ms-examples": {
+ "ServerEndpoints_Get": {
+ "$ref": "./examples/ServerEndpoints_Get.json"
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Server Endpoint object",
+ "schema": {
+ "$ref": "#/definitions/ServerEndpoint"
+ },
+ "headers": {
+ "x-ms-request-id": {
+ "description": "request id.",
+ "type": "string"
+ },
+ "x-ms-correlation-request-id": {
+ "description": "correlation request id.",
+ "type": "string"
+ }
+ }
+ },
+ "default": {
+ "description": "Error message indicating why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/StorageSyncError"
+ }
+ }
+ }
+ },
+ "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"
+ },
+ {
+ "name": "storageSyncServiceName",
+ "in": "path",
+ "description": "Name of Storage Sync Service resource.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "syncGroupName",
+ "in": "path",
+ "description": "Name of Sync Group resource.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "serverEndpointName",
+ "in": "path",
+ "description": "Name of Server Endpoint object.",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "tags": [
+ "ServerEndpoint Resource"
+ ],
+ "operationId": "ServerEndpoints_Delete",
+ "description": "Delete a given ServerEndpoint.",
+ "x-ms-examples": {
+ "ServerEndpoints_Delete": {
+ "$ref": "./examples/ServerEndpoints_Delete.json"
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "headers": {
+ "x-ms-request-id": {
+ "description": "request id.",
+ "type": "string"
+ },
+ "x-ms-correlation-request-id": {
+ "description": "correlation request id.",
+ "type": "string"
+ }
+ }
+ },
+ "202": {
+ "description": "Asynchronous Operation Status Location",
+ "headers": {
+ "Location": {
+ "description": "Operation Status Location URI",
+ "type": "string"
+ },
+ "x-ms-request-id": {
+ "description": "request id.",
+ "type": "string"
+ },
+ "x-ms-correlation-request-id": {
+ "description": "correlation request id.",
+ "type": "string"
+ }
+ }
+ },
+ "default": {
+ "description": "Error message indicating why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/StorageSyncError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups/{syncGroupName}/serverEndpoints": {
+ "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"
+ },
+ {
+ "name": "storageSyncServiceName",
+ "in": "path",
+ "description": "Name of Storage Sync Service resource.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "syncGroupName",
+ "in": "path",
+ "description": "Name of Sync Group resource.",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "tags": [
+ "ServerEndpoint Resource"
+ ],
+ "operationId": "ServerEndpoints_ListBySyncGroup",
+ "description": "Get a ServerEndpoint list.",
+ "x-ms-examples": {
+ "ServerEndpoints_ListBySyncGroup": {
+ "$ref": "./examples/ServerEndpoints_ListBySyncGroup.json"
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Array of Server Endpoint resources in Sync Group",
+ "schema": {
+ "$ref": "#/definitions/ServerEndpointArray"
+ },
+ "headers": {
+ "Location": {
+ "description": "Operation Status Location URI",
+ "type": "string"
+ },
+ "x-ms-request-id": {
+ "description": "request id.",
+ "type": "string"
+ },
+ "x-ms-correlation-request-id": {
+ "description": "correlation request id.",
+ "type": "string"
+ }
+ }
+ },
+ "default": {
+ "description": "Error message indicating why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/StorageSyncError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": null
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups/{syncGroupName}/serverEndpoints/{serverEndpointName}/recallAction": {
+ "post": {
+ "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"
+ },
+ {
+ "name": "storageSyncServiceName",
+ "in": "path",
+ "description": "Name of Storage Sync Service resource.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "syncGroupName",
+ "in": "path",
+ "description": "Name of Sync Group resource.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "serverEndpointName",
+ "in": "path",
+ "description": "Name of Server Endpoint object.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "description": "Body of Recall Action object.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/RecallActionParameters"
+ }
+ }
+ ],
+ "tags": [
+ "ServerEndpoint Resource",
+ "Actions"
+ ],
+ "operationId": "ServerEndpoints_recallAction",
+ "description": "Recall a server endpoint.",
+ "x-ms-examples": {
+ "ServerEndpoints_recallAction": {
+ "$ref": "./examples/ServerEndpoints_Recall.json"
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Server Endpoint object",
+ "headers": {
+ "x-ms-request-id": {
+ "description": "request id.",
+ "type": "string"
+ },
+ "x-ms-correlation-request-id": {
+ "description": "correlation request id.",
+ "type": "string"
+ }
+ }
+ },
+ "202": {
+ "description": "Asynchronous Operation Status Location",
+ "headers": {
+ "Location": {
+ "description": "Operation Status Location URI",
+ "type": "string"
+ },
+ "x-ms-request-id": {
+ "description": "request id.",
+ "type": "string"
+ },
+ "x-ms-correlation-request-id": {
+ "description": "correlation request id.",
+ "type": "string"
+ }
+ }
+ },
+ "default": {
+ "description": "Error message indicating why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/StorageSyncError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/registeredServers": {
+ "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"
+ },
+ {
+ "name": "storageSyncServiceName",
+ "in": "path",
+ "description": "Name of Storage Sync Service resource.",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "tags": [
+ "RegisteredServer Resource"
+ ],
+ "operationId": "RegisteredServers_ListByStorageSyncService",
+ "description": "Get a given registered server list.",
+ "x-ms-examples": {
+ "RegisteredServers_ListByStorageSyncService": {
+ "$ref": "./examples/RegisteredServers_ListByStorageSyncService.json"
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Array of Registered Server resources in Storage Sync Service",
+ "schema": {
+ "$ref": "#/definitions/RegisteredServerArray"
+ },
+ "headers": {
+ "x-ms-request-id": {
+ "description": "request id.",
+ "type": "string"
+ },
+ "x-ms-correlation-request-id": {
+ "description": "correlation request id.",
+ "type": "string"
+ }
+ }
+ },
+ "default": {
+ "description": "Error message indicating why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/StorageSyncError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": null
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/registeredServers/{serverId}": {
+ "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"
+ },
+ {
+ "name": "storageSyncServiceName",
+ "in": "path",
+ "description": "Name of Storage Sync Service resource.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "serverId",
+ "in": "path",
+ "description": "GUID identifying the on-premises server.",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "tags": [
+ "RegisteredServer Resource"
+ ],
+ "operationId": "RegisteredServers_Get",
+ "description": "Get a given registered server.",
+ "x-ms-examples": {
+ "RegisteredServers_Get": {
+ "$ref": "./examples/RegisteredServers_Get.json"
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Registered Server resources in Sync Group",
+ "schema": {
+ "$ref": "#/definitions/RegisteredServer"
+ },
+ "headers": {
+ "x-ms-request-id": {
+ "description": "request id.",
+ "type": "string"
+ },
+ "x-ms-correlation-request-id": {
+ "description": "correlation request id.",
+ "type": "string"
+ }
+ }
+ },
+ "default": {
+ "description": "Error message indicating why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/StorageSyncError"
+ }
+ }
+ }
+ },
+ "put": {
+ "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"
+ },
+ {
+ "name": "storageSyncServiceName",
+ "in": "path",
+ "description": "Name of Storage Sync Service resource.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "serverId",
+ "in": "path",
+ "description": "GUID identifying the on-premises server.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "description": "Body of Registered Server object.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/RegisteredServerCreateParameters"
+ }
+ }
+ ],
+ "tags": [
+ "RegisteredServer Resource"
+ ],
+ "operationId": "RegisteredServers_Create",
+ "description": "Add a new registered server.",
+ "x-ms-examples": {
+ "RegisteredServers_Create": {
+ "$ref": "./examples/RegisteredServers_Create.json"
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Registered Server resources in Sync Group",
+ "schema": {
+ "$ref": "#/definitions/RegisteredServer"
+ },
+ "headers": {
+ "x-ms-request-id": {
+ "description": "request id.",
+ "type": "string"
+ },
+ "x-ms-correlation-request-id": {
+ "description": "correlation request id.",
+ "type": "string"
+ }
+ }
+ },
+ "202": {
+ "description": "Asynchronous Operation Status Location",
+ "headers": {
+ "Azure-AsyncOperation": {
+ "description": "Operation Status Location URI",
+ "type": "string"
+ },
+ "Location": {
+ "description": "Operation Status Location URI",
+ "type": "string"
+ },
+ "x-ms-request-id": {
+ "description": "request id.",
+ "type": "string"
+ },
+ "x-ms-correlation-request-id": {
+ "description": "correlation request id.",
+ "type": "string"
+ }
+ }
+ },
+ "default": {
+ "description": "Error message indicating why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/StorageSyncError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true
+ },
+ "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"
+ },
+ {
+ "name": "storageSyncServiceName",
+ "in": "path",
+ "description": "Name of Storage Sync Service resource.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "serverId",
+ "in": "path",
+ "description": "GUID identifying the on-premises server.",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "tags": [
+ "RegisteredServer Resource"
+ ],
+ "operationId": "RegisteredServers_Delete",
+ "description": "Delete the given registered server.",
+ "x-ms-examples": {
+ "RegisteredServers_Delete": {
+ "$ref": "./examples/RegisteredServers_Delete.json"
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "headers": {
+ "x-ms-request-id": {
+ "description": "request id.",
+ "type": "string"
+ },
+ "x-ms-correlation-request-id": {
+ "description": "correlation request id.",
+ "type": "string"
+ }
+ }
+ },
+ "202": {
+ "description": "Asynchronous Operation Status Location",
+ "headers": {
+ "Location": {
+ "description": "Operation Status Location URI",
+ "type": "string"
+ },
+ "x-ms-request-id": {
+ "description": "request id.",
+ "type": "string"
+ },
+ "x-ms-correlation-request-id": {
+ "description": "correlation request id.",
+ "type": "string"
+ }
+ }
+ },
+ "204": {
+ "description": "Resource doesn't exist"
+ },
+ "default": {
+ "description": "Error message indicating why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/StorageSyncError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/registeredServers/{serverId}/triggerRollover": {
+ "post": {
+ "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"
+ },
+ {
+ "name": "storageSyncServiceName",
+ "in": "path",
+ "description": "Name of Storage Sync Service resource.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "serverId",
+ "in": "path",
+ "description": "Server Id",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "description": "Body of Trigger Rollover request.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/TriggerRolloverRequest"
+ }
+ }
+ ],
+ "tags": [
+ "RegisteredServer Resource",
+ "Actions"
+ ],
+ "operationId": "RegisteredServers_triggerRollover",
+ "description": "Triggers Server certificate rollover.",
+ "x-ms-examples": {
+ "RegisteredServers_triggerRollover": {
+ "$ref": "./examples/RegisteredServers_TriggerRollover.json"
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Trigger Rollover success status",
+ "headers": {
+ "x-ms-request-id": {
+ "description": "request id.",
+ "type": "string"
+ },
+ "x-ms-correlation-request-id": {
+ "description": "correlation request id.",
+ "type": "string"
+ }
+ }
+ },
+ "202": {
+ "description": "Asynchronous Operation Status Location",
+ "headers": {
+ "Location": {
+ "description": "Operation Status Location URI",
+ "type": "string"
+ },
+ "x-ms-request-id": {
+ "description": "request id.",
+ "type": "string"
+ },
+ "x-ms-correlation-request-id": {
+ "description": "correlation request id.",
+ "type": "string"
+ }
+ }
+ },
+ "default": {
+ "description": "Error message indicating why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/StorageSyncError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/workflows": {
+ "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"
+ },
+ {
+ "name": "storageSyncServiceName",
+ "in": "path",
+ "description": "Name of Storage Sync Service resource.",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "tags": [
+ "Workflow Resource"
+ ],
+ "operationId": "Workflows_ListByStorageSyncService",
+ "description": "Get a Workflow List",
+ "x-ms-examples": {
+ "Workflows_ListByStorageSyncService": {
+ "$ref": "./examples/Workflows_ListByStorageSyncService.json"
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Array of Workflow resources in Storage Sync Service",
+ "schema": {
+ "$ref": "#/definitions/WorkflowArray"
+ },
+ "headers": {
+ "x-ms-request-id": {
+ "description": "request id.",
+ "type": "string"
+ },
+ "x-ms-correlation-request-id": {
+ "description": "correlation request id.",
+ "type": "string"
+ }
+ }
+ },
+ "default": {
+ "description": "Error message indicating why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/StorageSyncError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": null
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/workflows/{workflowId}": {
+ "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"
+ },
+ {
+ "name": "storageSyncServiceName",
+ "in": "path",
+ "description": "Name of Storage Sync Service resource.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "workflowId",
+ "in": "path",
+ "description": "workflow Id",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "tags": [
+ "Workflow Resource"
+ ],
+ "operationId": "Workflows_Get",
+ "description": "Get Workflows resource",
+ "x-ms-examples": {
+ "Workflows_Get": {
+ "$ref": "./examples/Workflows_Get.json"
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Workflow object",
+ "schema": {
+ "$ref": "#/definitions/Workflow"
+ },
+ "headers": {
+ "x-ms-request-id": {
+ "description": "request id.",
+ "type": "string"
+ },
+ "x-ms-correlation-request-id": {
+ "description": "correlation request id.",
+ "type": "string"
+ }
+ }
+ },
+ "default": {
+ "description": "Error message indicating why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/StorageSyncError"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/workflows/{workflowId}/abort": {
+ "post": {
+ "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"
+ },
+ {
+ "name": "storageSyncServiceName",
+ "in": "path",
+ "description": "Name of Storage Sync Service resource.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "workflowId",
+ "in": "path",
+ "description": "workflow Id",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "tags": [
+ "Workflow Resource",
+ "Actions"
+ ],
+ "operationId": "Workflows_Abort",
+ "description": "Abort the given workflow.",
+ "x-ms-examples": {
+ "Workflows_Abort": {
+ "$ref": "./examples/Workflows_Abort.json"
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "success",
+ "headers": {
+ "x-ms-request-id": {
+ "description": "request id.",
+ "type": "string"
+ },
+ "x-ms-correlation-request-id": {
+ "description": "correlation request id.",
+ "type": "string"
+ }
+ }
+ },
+ "default": {
+ "description": "Error message indicating why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/StorageSyncError"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/locations/{locationName}/workflows/{workflowId}/operations/{operationId}": {
+ "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"
+ },
+ {
+ "name": "locationName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The desired region to obtain information from."
+ },
+ {
+ "name": "workflowId",
+ "in": "path",
+ "description": "workflow Id",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "operationId",
+ "in": "path",
+ "description": "operation Id",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "tags": [
+ "Operation Status"
+ ],
+ "operationId": "OperationStatus_Get",
+ "description": "Get Operation status",
+ "x-ms-examples": {
+ "Workflows_Get": {
+ "$ref": "./examples/OperationStatus_Get.json"
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Operation Status",
+ "schema": {
+ "$ref": "#/definitions/OperationStatus"
+ },
+ "headers": {
+ "x-ms-request-id": {
+ "description": "request id.",
+ "type": "string"
+ },
+ "x-ms-correlation-request-id": {
+ "description": "correlation request id.",
+ "type": "string"
+ }
+ }
+ },
+ "default": {
+ "description": "Error message indicating why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/StorageSyncError"
+ }
+ }
+ }
+ }
+ }
+ },
+ "definitions": {
+ "StorageSyncError": {
+ "type": "object",
+ "description": "Error type",
+ "properties": {
+ "error": {
+ "$ref": "#/definitions/StorageSyncApiError",
+ "description": "Error details of the given entry."
+ },
+ "innererror": {
+ "$ref": "#/definitions/StorageSyncApiError",
+ "description": "Error details of the given entry."
+ }
+ }
+ },
+ "StorageSyncApiError": {
+ "type": "object",
+ "description": "Error type",
+ "properties": {
+ "code": {
+ "type": "string",
+ "description": "Error code of the given entry."
+ },
+ "message": {
+ "type": "string",
+ "description": "Error message of the given entry."
+ },
+ "target": {
+ "type": "string",
+ "description": "Target of the given error entry."
+ },
+ "details": {
+ "$ref": "#/definitions/StorageSyncErrorDetails",
+ "description": "Error details of the given entry."
+ },
+ "innerError": {
+ "$ref": "#/definitions/StorageSyncInnerErrorDetails",
+ "description": "Inner error details of the given entry."
+ }
+ }
+ },
+ "StorageSyncErrorDetails": {
+ "type": "object",
+ "description": "Error Details object.",
+ "properties": {
+ "code": {
+ "type": "string",
+ "description": "Error code of the given entry."
+ },
+ "message": {
+ "type": "string",
+ "description": "Error message of the given entry."
+ },
+ "target": {
+ "type": "string",
+ "description": "Target of the given entry."
+ },
+ "requestUri": {
+ "type": "string",
+ "description": "Request URI of the given entry."
+ },
+ "exceptionType": {
+ "type": "string",
+ "description": "Exception type of the given entry."
+ },
+ "httpMethod": {
+ "type": "string",
+ "description": "HTTP method of the given entry."
+ },
+ "hashedMessage": {
+ "type": "string",
+ "description": "Hashed message of the given entry."
+ },
+ "httpErrorCode": {
+ "type": "string",
+ "description": "HTTP error code of the given entry."
+ }
+ }
+ },
+ "StorageSyncInnerErrorDetails": {
+ "type": "object",
+ "description": "Error Details object.",
+ "properties": {
+ "callStack": {
+ "type": "string",
+ "description": "Call stack of the error."
+ },
+ "message": {
+ "type": "string",
+ "description": "Error message of the error."
+ },
+ "innerException": {
+ "type": "string",
+ "description": "Exception of the inner error."
+ },
+ "innerExceptionCallStack": {
+ "type": "string",
+ "description": "Call stack of the inner error."
+ }
+ }
+ },
+ "SubscriptionState": {
+ "type": "object",
+ "description": "Subscription State object.",
+ "properties": {
+ "state": {
+ "type": "string",
+ "description": "State of Azure Subscription",
+ "enum": [
+ "Registered",
+ "Unregistered",
+ "Warned",
+ "Suspended",
+ "Deleted"
+ ],
+ "x-ms-enum": {
+ "name": "Reason",
+ "modelAsString": true
+ }
+ },
+ "istransitioning": {
+ "type": "boolean",
+ "description": "Is Transitioning",
+ "readOnly": true
+ },
+ "properties": {
+ "x-ms-client-flatten": true,
+ "$ref": "#/definitions/SubscriptionStateProperties",
+ "description": "Subscription state properties."
+ }
+ }
+ },
+ "StorageSyncService": {
+ "type": "object",
+ "description": "Storage Sync Service object.",
+ "allOf": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/TrackedResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "x-ms-client-flatten": true,
+ "$ref": "#/definitions/StorageSyncServiceProperties",
+ "description": "Storage Sync Service properties."
+ }
+ }
+ },
+ "SyncGroup": {
+ "type": "object",
+ "description": "Sync Group object.",
+ "allOf": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ProxyResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "x-ms-client-flatten": true,
+ "$ref": "#/definitions/SyncGroupProperties",
+ "description": "SyncGroup properties."
+ }
+ }
+ },
+ "CloudEndpoint": {
+ "type": "object",
+ "description": "Cloud Endpoint object.",
+ "allOf": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ProxyResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "x-ms-client-flatten": true,
+ "$ref": "#/definitions/CloudEndpointProperties",
+ "description": "Cloud Endpoint properties."
+ }
+ }
+ },
+ "TriggerChangeDetectionParameters": {
+ "properties": {
+ "directoryPath": {
+ "type": "string",
+ "description": "Relative path to a directory Azure File share for which change detection is to be performed."
+ },
+ "changeDetectionMode": {
+ "type": "string",
+ "description": "Change Detection Mode. Applies to a directory specified in directoryPath parameter.",
+ "enum": [
+ "Default",
+ "Recursive"
+ ],
+ "x-ms-enum": {
+ "name": "changeDetectionMode",
+ "modelAsString": true
+ }
+ },
+ "paths": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "Array of relative paths on the Azure File share to be included in the change detection. Can be files and directories."
+ }
+ },
+ "description": "The parameters used when calling trigger change detection action on cloud endpoint."
+ },
+ "RecallActionParameters": {
+ "properties": {
+ "pattern": {
+ "type": "string",
+ "description": "Pattern of the files."
+ },
+ "recallPath": {
+ "type": "string",
+ "description": "Recall path."
+ }
+ },
+ "description": "The parameters used when calling recall action on server endpoint."
+ },
+ "StorageSyncServiceCreateParameters": {
+ "properties": {
+ "location": {
+ "type": "string",
+ "description": "Required. Gets or sets the location of the resource. This will be one of the supported and registered Azure Geo Regions (e.g. West US, East US, Southeast Asia, etc.). The geo region of a resource cannot be changed once it is created, but if an identical geo region is specified on update, the request will succeed."
+ },
+ "tags": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Gets or sets a list of key value pairs that describe the resource. These tags can be used for viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key with a length no greater than 128 characters and a value with a length no greater than 256 characters."
+ },
+ "properties": {
+ "x-ms-client-flatten": true,
+ "$ref": "#/definitions/StorageSyncServiceCreateParametersProperties",
+ "description": "The parameters used to create the storage sync service."
+ }
+ },
+ "required": [
+ "location"
+ ],
+ "description": "The parameters used when creating a storage sync service."
+ },
+ "SyncGroupCreateParameters": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ProxyResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "x-ms-client-flatten": true,
+ "$ref": "#/definitions/SyncGroupCreateParametersProperties",
+ "description": "The parameters used to create the sync group"
+ }
+ },
+ "description": "The parameters used when creating a sync group."
+ },
+ "SyncGroupCreateParametersProperties": {
+ "type": "object",
+ "description": "Sync Group Create Properties object.",
+ "properties": {}
+ },
+ "CloudEndpointCreateParameters": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ProxyResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "x-ms-client-flatten": true,
+ "$ref": "#/definitions/CloudEndpointCreateParametersProperties",
+ "description": "The parameters used to create the cloud endpoint."
+ }
+ },
+ "description": "The parameters used when creating a cloud endpoint."
+ },
+ "StorageSyncServiceCreateParametersProperties": {
+ "description": "StorageSyncService Properties object.",
+ "properties": {
+ "incomingTrafficPolicy": {
+ "$ref": "#/definitions/IncomingTrafficPolicy",
+ "description": "Incoming Traffic Policy"
+ }
+ }
+ },
+ "CloudEndpointCreateParametersProperties": {
+ "description": "CloudEndpoint Properties object.",
+ "properties": {
+ "storageAccountResourceId": {
+ "type": "string",
+ "description": "Storage Account Resource Id"
+ },
+ "azureFileShareName": {
+ "type": "string",
+ "description": "Azure file share name"
+ },
+ "storageAccountTenantId": {
+ "type": "string",
+ "description": "Storage Account Tenant Id"
+ },
+ "friendlyName": {
+ "type": "string",
+ "description": "Friendly Name"
+ }
+ }
+ },
+ "ServerEndpointCreateParameters": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ProxyResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "x-ms-client-flatten": true,
+ "$ref": "#/definitions/ServerEndpointCreateParametersProperties",
+ "description": "The parameters used to create the server endpoint."
+ }
+ },
+ "description": "The parameters used when creating a server endpoint."
+ },
+ "ServerEndpointCreateParametersProperties": {
+ "description": "ServerEndpoint Properties object.",
+ "properties": {
+ "serverLocalPath": {
+ "$ref": "#/definitions/PhysicalPath",
+ "description": "Server Local path."
+ },
+ "cloudTiering": {
+ "$ref": "#/definitions/FeatureStatus",
+ "description": "Cloud Tiering."
+ },
+ "volumeFreeSpacePercent": {
+ "type": "integer",
+ "minimum": 0,
+ "maximum": 100,
+ "description": "Level of free space to be maintained by Cloud Tiering if it is enabled."
+ },
+ "tierFilesOlderThanDays": {
+ "type": "integer",
+ "minimum": 0,
+ "maximum": 2147483647,
+ "description": "Tier files older than days."
+ },
+ "friendlyName": {
+ "type": "string",
+ "description": "Friendly Name"
+ },
+ "serverResourceId": {
+ "$ref": "#/definitions/ResourceId",
+ "description": "Server Resource Id."
+ },
+ "offlineDataTransfer": {
+ "$ref": "#/definitions/FeatureStatus",
+ "description": "Offline data transfer"
+ },
+ "offlineDataTransferShareName": {
+ "type": "string",
+ "description": "Offline data transfer share name"
+ },
+ "initialDownloadPolicy": {
+ "$ref": "#/definitions/InitialDownloadPolicy",
+ "description": "Policy for how namespace and files are recalled during FastDr."
+ },
+ "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."
+ }
+ }
+ },
+ "TriggerRolloverRequest": {
+ "type": "object",
+ "description": "Trigger Rollover Request.",
+ "properties": {
+ "serverCertificate": {
+ "type": "string",
+ "description": "Certificate Data"
+ }
+ }
+ },
+ "RegisteredServerCreateParameters": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ProxyResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "x-ms-client-flatten": true,
+ "$ref": "#/definitions/RegisteredServerCreateParametersProperties",
+ "description": "The parameters used to create the registered server."
+ }
+ },
+ "description": "The parameters used when creating a registered server."
+ },
+ "RegisteredServerCreateParametersProperties": {
+ "description": "RegisteredServer Create Properties object.",
+ "properties": {
+ "serverCertificate": {
+ "type": "string",
+ "description": "Registered Server Certificate"
+ },
+ "agentVersion": {
+ "type": "string",
+ "description": "Registered Server Agent Version"
+ },
+ "serverOSVersion": {
+ "type": "string",
+ "description": "Registered Server OS Version"
+ },
+ "lastHeartBeat": {
+ "type": "string",
+ "description": "Registered Server last heart beat"
+ },
+ "serverRole": {
+ "type": "string",
+ "description": "Registered Server serverRole"
+ },
+ "clusterId": {
+ "type": "string",
+ "description": "Registered Server clusterId"
+ },
+ "clusterName": {
+ "type": "string",
+ "description": "Registered Server clusterName"
+ },
+ "serverId": {
+ "type": "string",
+ "description": "Registered Server serverId"
+ },
+ "friendlyName": {
+ "type": "string",
+ "description": "Friendly Name"
+ }
+ }
+ },
+ "ServerEndpointUpdateParameters": {
+ "properties": {
+ "properties": {
+ "x-ms-client-flatten": true,
+ "$ref": "#/definitions/ServerEndpointUpdateProperties",
+ "description": "The properties of the server endpoint."
+ }
+ },
+ "description": "Parameters for updating an Server Endpoint."
+ },
+ "ServerEndpoint": {
+ "type": "object",
+ "description": "Server Endpoint object.",
+ "allOf": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ProxyResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "x-ms-client-flatten": true,
+ "$ref": "#/definitions/ServerEndpointProperties",
+ "description": "Server Endpoint properties."
+ }
+ }
+ },
+ "RegisteredServer": {
+ "type": "object",
+ "description": "Registered Server resource.",
+ "allOf": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ProxyResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "x-ms-client-flatten": true,
+ "$ref": "#/definitions/RegisteredServerProperties",
+ "description": "RegisteredServer properties."
+ }
+ }
+ },
+ "ResourcesMoveInfo": {
+ "type": "object",
+ "description": "Resource Move Info.",
+ "properties": {
+ "targetResourceGroup": {
+ "type": "string",
+ "description": "Target resource group."
+ },
+ "resources": {
+ "type": "array",
+ "description": "Collection of Resources.",
+ "items": {
+ "$ref": "#/definitions/ResourceId"
+ }
+ }
+ }
+ },
+ "Workflow": {
+ "type": "object",
+ "description": "Workflow resource.",
+ "allOf": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ProxyResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "x-ms-client-flatten": true,
+ "$ref": "#/definitions/WorkflowProperties",
+ "description": "Workflow properties."
+ }
+ }
+ },
+ "OperationEntityListResult": {
+ "description": "The list of storage sync operations.",
+ "type": "object",
+ "properties": {
+ "nextLink": {
+ "description": "The link used to get the next page of operations.",
+ "type": "string"
+ },
+ "value": {
+ "description": "The list of operations.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/OperationEntity"
+ }
+ }
+ }
+ },
+ "OperationEntity": {
+ "description": "The operation supported by storage sync.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "Operation name: {provider}/{resource}/{operation}.",
+ "type": "string"
+ },
+ "display": {
+ "$ref": "#/definitions/OperationDisplayInfo",
+ "description": "The operation supported by storage sync."
+ },
+ "origin": {
+ "type": "string",
+ "description": "The origin."
+ },
+ "properties": {
+ "$ref": "#/definitions/OperationProperties",
+ "description": "Properties of the operations resource."
+ }
+ }
+ },
+ "OperationDisplayInfo": {
+ "description": "The operation supported by storage sync.",
+ "type": "object",
+ "properties": {
+ "description": {
+ "description": "The description of the operation.",
+ "type": "string"
+ },
+ "operation": {
+ "description": "The action that users can perform, based on their permission level.",
+ "type": "string"
+ },
+ "provider": {
+ "description": "Service provider: Microsoft StorageSync.",
+ "type": "string"
+ },
+ "resource": {
+ "description": "Resource on which the operation is performed.",
+ "type": "string"
+ }
+ }
+ },
+ "OperationDisplayResource": {
+ "type": "object",
+ "description": "Operation Display Resource object.",
+ "properties": {
+ "provider": {
+ "type": "string",
+ "description": "Operation Display Resource Provider."
+ },
+ "resource": {
+ "type": "string",
+ "description": "Operation Display Resource."
+ },
+ "operation": {
+ "type": "string",
+ "description": "Operation Display Resource Operation."
+ },
+ "description": {
+ "type": "string",
+ "description": "Operation Display Resource Description."
+ }
+ }
+ },
+ "OperationProperties": {
+ "type": "object",
+ "description": "Properties of the operations resource.",
+ "properties": {
+ "serviceSpecification": {
+ "$ref": "#/definitions/OperationResourceServiceSpecification",
+ "description": "Service specification for the operations resource."
+ }
+ }
+ },
+ "OperationResourceServiceSpecification": {
+ "type": "object",
+ "description": "Service specification.",
+ "properties": {
+ "metricSpecifications": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/OperationResourceMetricSpecification"
+ },
+ "description": "List of metric specifications."
+ }
+ }
+ },
+ "OperationResourceMetricSpecification": {
+ "type": "object",
+ "description": "Operation Display Resource object.",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "Name of the metric."
+ },
+ "displayName": {
+ "type": "string",
+ "description": "Display name for the metric."
+ },
+ "displayDescription": {
+ "type": "string",
+ "description": "Display description for the metric."
+ },
+ "unit": {
+ "type": "string",
+ "description": "Unit for the metric."
+ },
+ "aggregationType": {
+ "type": "string",
+ "description": "Aggregation type for the metric."
+ },
+ "fillGapWithZero": {
+ "type": "boolean",
+ "description": "Fill gaps in the metric with zero."
+ },
+ "dimensions": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/OperationResourceMetricSpecificationDimension"
+ },
+ "description": "Dimensions for the metric specification."
+ }
+ }
+ },
+ "OperationResourceMetricSpecificationDimension": {
+ "type": "object",
+ "description": "OperationResourceMetricSpecificationDimension object.",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "Name of the dimension."
+ },
+ "displayName": {
+ "type": "string",
+ "description": "Display name of the dimensions."
+ },
+ "toBeExportedForShoebox": {
+ "type": "boolean",
+ "description": "Indicates metric should be exported for Shoebox."
+ }
+ }
+ },
+ "CheckNameAvailabilityParameters": {
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "The name to check for availability"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Microsoft.StorageSync/storageSyncServices"
+ ],
+ "x-ms-enum": {
+ "name": "Type",
+ "modelAsString": false
+ },
+ "description": "The resource type. Must be set to Microsoft.StorageSync/storageSyncServices"
+ }
+ },
+ "required": [
+ "name",
+ "type"
+ ],
+ "description": "Parameters for a check name availability request."
+ },
+ "CheckNameAvailabilityResult": {
+ "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
+ },
+ "description": "Gets the reason that a Storage Sync Service 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."
+ },
+ "PostRestoreRequest": {
+ "type": "object",
+ "description": "Post Restore Request",
+ "properties": {
+ "partition": {
+ "type": "string",
+ "description": "Post Restore partition."
+ },
+ "replicaGroup": {
+ "type": "string",
+ "description": "Post Restore replica group."
+ },
+ "requestId": {
+ "type": "string",
+ "description": "Post Restore request id."
+ },
+ "azureFileShareUri": {
+ "type": "string",
+ "description": "Post Restore Azure file share uri."
+ },
+ "status": {
+ "type": "string",
+ "description": "Post Restore Azure status."
+ },
+ "sourceAzureFileShareUri": {
+ "type": "string",
+ "description": "Post Restore Azure source azure file share uri."
+ },
+ "failedFileList": {
+ "type": "string",
+ "description": "Post Restore Azure failed file list."
+ },
+ "restoreFileSpec": {
+ "type": "array",
+ "description": "Post Restore restore file spec array.",
+ "items": {
+ "$ref": "#/definitions/RestoreFileSpec",
+ "description": "Post Restore restore file spec items array."
+ }
+ }
+ }
+ },
+ "PreRestoreRequest": {
+ "type": "object",
+ "description": "Pre Restore request object.",
+ "properties": {
+ "partition": {
+ "type": "string",
+ "description": "Pre Restore partition."
+ },
+ "replicaGroup": {
+ "type": "string",
+ "description": "Pre Restore replica group."
+ },
+ "requestId": {
+ "type": "string",
+ "description": "Pre Restore request id."
+ },
+ "azureFileShareUri": {
+ "type": "string",
+ "description": "Pre Restore Azure file share uri."
+ },
+ "status": {
+ "type": "string",
+ "description": "Pre Restore Azure status."
+ },
+ "sourceAzureFileShareUri": {
+ "type": "string",
+ "description": "Pre Restore Azure source azure file share uri."
+ },
+ "backupMetadataPropertyBag": {
+ "type": "string",
+ "description": "Pre Restore backup metadata property bag."
+ },
+ "restoreFileSpec": {
+ "type": "array",
+ "description": "Pre Restore restore file spec array.",
+ "items": {
+ "$ref": "#/definitions/RestoreFileSpec",
+ "description": "Pre Restore restore file spec items array."
+ }
+ },
+ "pauseWaitForSyncDrainTimePeriodInSeconds": {
+ "type": "integer",
+ "description": "Pre Restore pause wait for sync drain time period in seconds."
+ }
+ }
+ },
+ "BackupRequest": {
+ "type": "object",
+ "description": "Backup request",
+ "properties": {
+ "azureFileShare": {
+ "type": "string",
+ "description": "Azure File Share."
+ }
+ }
+ },
+ "PostBackupResponse": {
+ "type": "object",
+ "description": "Post Backup Response",
+ "properties": {
+ "backupMetadata": {
+ "x-ms-client-flatten": true,
+ "$ref": "#/definitions/PostBackupResponseProperties",
+ "description": "Post Backup Response Properties"
+ }
+ }
+ },
+ "RestoreFileSpec": {
+ "type": "object",
+ "description": "Restore file spec.",
+ "properties": {
+ "path": {
+ "type": "string",
+ "description": "Restore file spec path"
+ },
+ "isdir": {
+ "type": "boolean",
+ "description": "Restore file spec isdir"
+ }
+ }
+ },
+ "StorageSyncServiceArray": {
+ "type": "object",
+ "description": "Array of StorageSyncServices",
+ "properties": {
+ "value": {
+ "type": "array",
+ "description": "Collection of StorageSyncServices.",
+ "items": {
+ "$ref": "#/definitions/StorageSyncService"
+ }
+ }
+ }
+ },
+ "SyncGroupArray": {
+ "type": "object",
+ "description": "Array of SyncGroup",
+ "properties": {
+ "value": {
+ "type": "array",
+ "description": "Collection of SyncGroup.",
+ "items": {
+ "$ref": "#/definitions/SyncGroup"
+ }
+ }
+ }
+ },
+ "CloudEndpointArray": {
+ "type": "object",
+ "description": "Array of CloudEndpoint",
+ "properties": {
+ "value": {
+ "type": "array",
+ "description": "Collection of CloudEndpoint.",
+ "items": {
+ "$ref": "#/definitions/CloudEndpoint"
+ }
+ }
+ }
+ },
+ "ServerEndpointArray": {
+ "description": "Array of ServerEndpoint",
+ "type": "object",
+ "properties": {
+ "value": {
+ "type": "array",
+ "description": "Collection of ServerEndpoint.",
+ "items": {
+ "$ref": "#/definitions/ServerEndpoint"
+ }
+ }
+ }
+ },
+ "RegisteredServerArray": {
+ "description": "Array of RegisteredServer",
+ "type": "object",
+ "properties": {
+ "value": {
+ "type": "array",
+ "description": "Collection of Registered Server.",
+ "items": {
+ "$ref": "#/definitions/RegisteredServer"
+ }
+ }
+ }
+ },
+ "WorkflowArray": {
+ "description": "Array of Workflow",
+ "type": "object",
+ "properties": {
+ "value": {
+ "type": "array",
+ "description": "Collection of workflow items.",
+ "items": {
+ "$ref": "#/definitions/Workflow"
+ }
+ }
+ }
+ },
+ "SubscriptionStateProperties": {
+ "type": "object",
+ "description": "Subscription State properties."
+ },
+ "PostBackupResponseProperties": {
+ "type": "object",
+ "description": "Post Backup Response Properties object.",
+ "properties": {
+ "cloudEndpointName": {
+ "type": "string",
+ "description": "cloud endpoint Name.",
+ "readOnly": true
+ }
+ }
+ },
+ "StorageSyncServiceUpdateParameters": {
+ "properties": {
+ "tags": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "The user-specified tags associated with the storage sync service."
+ },
+ "properties": {
+ "x-ms-client-flatten": true,
+ "$ref": "#/definitions/StorageSyncServiceUpdateProperties",
+ "description": "The properties of the server endpoint."
+ }
+ },
+ "description": "Parameters for updating an Storage sync service."
+ },
+ "StorageSyncServiceUpdateProperties": {
+ "type": "object",
+ "description": "StorageSyncService Properties object.",
+ "properties": {
+ "incomingTrafficPolicy": {
+ "$ref": "#/definitions/IncomingTrafficPolicy",
+ "description": "Incoming Traffic Policy"
+ }
+ }
+ },
+ "StorageSyncServiceProperties": {
+ "type": "object",
+ "description": "Storage Sync Service Properties object.",
+ "properties": {
+ "incomingTrafficPolicy": {
+ "$ref": "#/definitions/IncomingTrafficPolicy",
+ "description": "Incoming Traffic Policy"
+ },
+ "storageSyncServiceStatus": {
+ "type": "integer",
+ "description": "Storage Sync service status.",
+ "readOnly": true
+ },
+ "storageSyncServiceUid": {
+ "type": "string",
+ "description": "Storage Sync service Uid",
+ "readOnly": true
+ },
+ "provisioningState": {
+ "readOnly": true,
+ "type": "string",
+ "description": "StorageSyncService Provisioning State"
+ },
+ "lastWorkflowId": {
+ "readOnly": true,
+ "type": "string",
+ "description": "StorageSyncService lastWorkflowId"
+ },
+ "lastOperationName": {
+ "readOnly": true,
+ "type": "string",
+ "description": "Resource Last Operation Name"
+ },
+ "privateEndpointConnections": {
+ "readOnly": true,
+ "type": "array",
+ "items": {
+ "$ref": "../../../../../common-types/resource-management/v1/privatelinks.json#/definitions/PrivateEndpointConnection"
+ },
+ "description": "List of private endpoint connection associated with the specified storage sync service"
+ }
+ }
+ },
+ "WorkflowProperties": {
+ "type": "object",
+ "description": "Workflow Properties object.",
+ "properties": {
+ "lastStepName": {
+ "type": "string",
+ "description": "last step name",
+ "readOnly": true
+ },
+ "status": {
+ "$ref": "#/definitions/WorkflowStatus",
+ "description": "workflow status.",
+ "readOnly": true
+ },
+ "operation": {
+ "$ref": "#/definitions/OperationDirection",
+ "description": "operation direction.",
+ "readOnly": true
+ },
+ "steps": {
+ "type": "string",
+ "description": "workflow steps",
+ "readOnly": true
+ },
+ "lastOperationId": {
+ "type": "string",
+ "description": "workflow last operation identifier.",
+ "readOnly": true
+ },
+ "commandName": {
+ "type": "string",
+ "description": "workflow command name.",
+ "readOnly": true
+ },
+ "createdTimestamp": {
+ "type": "string",
+ "format": "date-time",
+ "description": "workflow created timestamp.",
+ "readOnly": true
+ },
+ "lastStatusTimestamp": {
+ "type": "string",
+ "format": "date-time",
+ "description": "workflow last status timestamp.",
+ "readOnly": true
+ }
+ }
+ },
+ "SyncGroupProperties": {
+ "type": "object",
+ "description": "SyncGroup Properties object.",
+ "properties": {
+ "uniqueId": {
+ "type": "string",
+ "description": "Unique Id",
+ "readOnly": true
+ },
+ "syncGroupStatus": {
+ "type": "string",
+ "description": "Sync group status",
+ "readOnly": true
+ }
+ }
+ },
+ "RegisteredServerProperties": {
+ "type": "object",
+ "description": "RegisteredServer Properties object.",
+ "properties": {
+ "serverCertificate": {
+ "type": "string",
+ "description": "Registered Server Certificate"
+ },
+ "agentVersion": {
+ "type": "string",
+ "description": "Registered Server Agent Version"
+ },
+ "agentVersionStatus": {
+ "$ref": "#/definitions/RegisteredServerAgentVersionStatus",
+ "description": "Registered Server Agent Version Status",
+ "readOnly": true
+ },
+ "agentVersionExpirationDate": {
+ "type": "string",
+ "format": "date-time",
+ "description": "Registered Server Agent Version Expiration Date",
+ "readOnly": true
+ },
+ "serverOSVersion": {
+ "type": "string",
+ "description": "Registered Server OS Version"
+ },
+ "serverManagementErrorCode": {
+ "type": "integer",
+ "description": "Registered Server Management Error Code",
+ "readOnly": true
+ },
+ "lastHeartBeat": {
+ "type": "string",
+ "format": "date-time",
+ "description": "Registered Server last heart beat",
+ "readOnly": true
+ },
+ "provisioningState": {
+ "type": "string",
+ "description": "Registered Server Provisioning State",
+ "readOnly": true
+ },
+ "serverRole": {
+ "type": "string",
+ "description": "Registered Server serverRole"
+ },
+ "clusterId": {
+ "type": "string",
+ "description": "Registered Server clusterId"
+ },
+ "clusterName": {
+ "type": "string",
+ "description": "Registered Server clusterName"
+ },
+ "serverId": {
+ "type": "string",
+ "description": "Registered Server serverId"
+ },
+ "storageSyncServiceUid": {
+ "type": "string",
+ "description": "Registered Server storageSyncServiceUid",
+ "readOnly": true
+ },
+ "lastWorkflowId": {
+ "type": "string",
+ "description": "Registered Server lastWorkflowId",
+ "readOnly": true
+ },
+ "lastOperationName": {
+ "type": "string",
+ "description": "Resource Last Operation Name",
+ "readOnly": true
+ },
+ "discoveryEndpointUri": {
+ "type": "string",
+ "description": "Resource discoveryEndpointUri",
+ "readOnly": true
+ },
+ "resourceLocation": {
+ "type": "string",
+ "description": "Resource Location",
+ "readOnly": true
+ },
+ "serviceLocation": {
+ "type": "string",
+ "description": "Service Location",
+ "readOnly": true
+ },
+ "friendlyName": {
+ "type": "string",
+ "description": "Friendly Name"
+ },
+ "managementEndpointUri": {
+ "type": "string",
+ "description": "Management Endpoint Uri",
+ "readOnly": true
+ },
+ "monitoringEndpointUri": {
+ "type": "string",
+ "description": "Telemetry Endpoint Uri",
+ "readOnly": true
+ },
+ "monitoringConfiguration": {
+ "type": "string",
+ "description": "Monitoring Configuration",
+ "readOnly": true
+ },
+ "serverName": {
+ "type": "string",
+ "description": "Server name",
+ "readOnly": true
+ }
+ }
+ },
+ "CloudEndpointProperties": {
+ "type": "object",
+ "description": "CloudEndpoint Properties object.",
+ "properties": {
+ "storageAccountResourceId": {
+ "type": "string",
+ "description": "Storage Account Resource Id"
+ },
+ "azureFileShareName": {
+ "type": "string",
+ "description": "Azure file share name"
+ },
+ "storageAccountTenantId": {
+ "type": "string",
+ "description": "Storage Account Tenant Id"
+ },
+ "partnershipId": {
+ "type": "string",
+ "description": "Partnership Id"
+ },
+ "friendlyName": {
+ "type": "string",
+ "description": "Friendly Name"
+ },
+ "backupEnabled": {
+ "type": "string",
+ "description": "Backup Enabled",
+ "readOnly": true
+ },
+ "provisioningState": {
+ "type": "string",
+ "description": "CloudEndpoint Provisioning State"
+ },
+ "lastWorkflowId": {
+ "type": "string",
+ "description": "CloudEndpoint lastWorkflowId"
+ },
+ "lastOperationName": {
+ "type": "string",
+ "description": "Resource Last Operation Name"
+ }
+ }
+ },
+ "ServerEndpointUpdateProperties": {
+ "type": "object",
+ "description": "ServerEndpoint Update Properties object.",
+ "properties": {
+ "cloudTiering": {
+ "$ref": "#/definitions/FeatureStatus",
+ "description": "Cloud Tiering."
+ },
+ "volumeFreeSpacePercent": {
+ "type": "integer",
+ "minimum": 0,
+ "maximum": 100,
+ "description": "Level of free space to be maintained by Cloud Tiering if it is enabled."
+ },
+ "tierFilesOlderThanDays": {
+ "type": "integer",
+ "minimum": 0,
+ "maximum": 2147483647,
+ "description": "Tier files older than days."
+ },
+ "offlineDataTransfer": {
+ "$ref": "#/definitions/FeatureStatus",
+ "description": "Offline data transfer"
+ },
+ "offlineDataTransferShareName": {
+ "type": "string",
+ "description": "Offline data transfer share name"
+ },
+ "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."
+ }
+ }
+ },
+ "ServerEndpointProperties": {
+ "type": "object",
+ "description": "ServerEndpoint Properties object.",
+ "properties": {
+ "serverLocalPath": {
+ "$ref": "#/definitions/PhysicalPath",
+ "description": "Server Local path."
+ },
+ "cloudTiering": {
+ "$ref": "#/definitions/FeatureStatus",
+ "description": "Cloud Tiering."
+ },
+ "volumeFreeSpacePercent": {
+ "type": "integer",
+ "minimum": 0,
+ "maximum": 100,
+ "description": "Level of free space to be maintained by Cloud Tiering if it is enabled."
+ },
+ "tierFilesOlderThanDays": {
+ "type": "integer",
+ "minimum": 0,
+ "maximum": 2147483647,
+ "description": "Tier files older than days."
+ },
+ "friendlyName": {
+ "type": "string",
+ "description": "Friendly Name"
+ },
+ "serverResourceId": {
+ "$ref": "#/definitions/ResourceId",
+ "description": "Server Resource Id."
+ },
+ "provisioningState": {
+ "type": "string",
+ "description": "ServerEndpoint Provisioning State",
+ "readOnly": true
+ },
+ "lastWorkflowId": {
+ "type": "string",
+ "description": "ServerEndpoint lastWorkflowId",
+ "readOnly": true
+ },
+ "lastOperationName": {
+ "type": "string",
+ "description": "Resource Last Operation Name",
+ "readOnly": true
+ },
+ "syncStatus": {
+ "type": "object",
+ "$ref": "#/definitions/ServerEndpointSyncStatus",
+ "description": "Server Endpoint sync status",
+ "readOnly": true
+ },
+ "offlineDataTransfer": {
+ "$ref": "#/definitions/FeatureStatus",
+ "description": "Offline data transfer"
+ },
+ "offlineDataTransferStorageAccountResourceId": {
+ "type": "string",
+ "description": "Offline data transfer storage account resource ID",
+ "readOnly": true
+ },
+ "offlineDataTransferStorageAccountTenantId": {
+ "type": "string",
+ "description": "Offline data transfer storage account tenant ID",
+ "readOnly": true
+ },
+ "offlineDataTransferShareName": {
+ "type": "string",
+ "description": "Offline data transfer share name"
+ },
+ "cloudTieringStatus": {
+ "type": "object",
+ "$ref": "#/definitions/ServerEndpointCloudTieringStatus",
+ "description": "Cloud tiering status. Only populated if cloud tiering is enabled.",
+ "readOnly": true
+ },
+ "recallStatus": {
+ "type": "object",
+ "$ref": "#/definitions/ServerEndpointRecallStatus",
+ "description": "Recall status. Only populated if cloud tiering is enabled.",
+ "readOnly": true
+ },
+ "initialDownloadPolicy": {
+ "$ref": "#/definitions/InitialDownloadPolicy",
+ "description": "Policy for how namespace and files are recalled during FastDr."
+ },
+ "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."
+ },
+ "serverName": {
+ "type": "string",
+ "description": "Server name",
+ "readOnly": true
+ }
+ }
+ },
+ "ServerEndpointSyncStatus": {
+ "type": "object",
+ "description": "Server Endpoint sync status",
+ "properties": {
+ "downloadHealth": {
+ "$ref": "#/definitions/ServerEndpointHealthState",
+ "description": "Download Health Status.",
+ "readOnly": true
+ },
+ "uploadHealth": {
+ "$ref": "#/definitions/ServerEndpointHealthState",
+ "description": "Upload Health Status.",
+ "readOnly": true
+ },
+ "combinedHealth": {
+ "$ref": "#/definitions/ServerEndpointHealthState",
+ "description": "Combined Health Status.",
+ "readOnly": true
+ },
+ "syncActivity": {
+ "$ref": "#/definitions/ServerEndpointSyncActivityState",
+ "description": "Sync activity",
+ "readOnly": true
+ },
+ "totalPersistentFilesNotSyncingCount": {
+ "type": "integer",
+ "format": "int64",
+ "minimum": 0,
+ "description": "Total count of persistent files not syncing (combined upload + download).",
+ "readOnly": true
+ },
+ "lastUpdatedTimestamp": {
+ "type": "string",
+ "format": "date-time",
+ "description": "Last Updated Timestamp",
+ "readOnly": true
+ },
+ "uploadStatus": {
+ "$ref": "#/definitions/ServerEndpointSyncSessionStatus",
+ "description": "Upload Status",
+ "readOnly": true
+ },
+ "downloadStatus": {
+ "$ref": "#/definitions/ServerEndpointSyncSessionStatus",
+ "description": "Download Status",
+ "readOnly": true
+ },
+ "uploadActivity": {
+ "$ref": "#/definitions/ServerEndpointSyncActivityStatus",
+ "description": "Upload sync activity",
+ "readOnly": true
+ },
+ "downloadActivity": {
+ "$ref": "#/definitions/ServerEndpointSyncActivityStatus",
+ "description": "Download sync activity",
+ "readOnly": true
+ },
+ "offlineDataTransferStatus": {
+ "$ref": "#/definitions/ServerEndpointOfflineDataTransferState",
+ "description": "Offline Data Transfer State",
+ "readOnly": true
+ },
+ "backgroundDataDownloadActivity": {
+ "$ref": "#/definitions/ServerEndpointBackgroundDataDownloadActivity",
+ "description": "Background data download activity",
+ "readOnly": true
+ }
+ }
+ },
+ "ServerEndpointSyncSessionStatus": {
+ "type": "object",
+ "description": "Sync Session status object.",
+ "properties": {
+ "lastSyncResult": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Last sync result (HResult)",
+ "readOnly": true
+ },
+ "lastSyncTimestamp": {
+ "type": "string",
+ "format": "date-time",
+ "description": "Last sync timestamp",
+ "readOnly": true
+ },
+ "lastSyncSuccessTimestamp": {
+ "type": "string",
+ "format": "date-time",
+ "description": "Last sync success timestamp",
+ "readOnly": true
+ },
+ "lastSyncPerItemErrorCount": {
+ "type": "integer",
+ "format": "int64",
+ "minimum": 0,
+ "description": "Last sync per item error count.",
+ "readOnly": true
+ },
+ "persistentFilesNotSyncingCount": {
+ "type": "integer",
+ "format": "int64",
+ "minimum": 0,
+ "description": "Count of persistent files not syncing.",
+ "readOnly": true
+ },
+ "transientFilesNotSyncingCount": {
+ "type": "integer",
+ "format": "int64",
+ "minimum": 0,
+ "description": "Count of transient files not syncing.",
+ "readOnly": true
+ },
+ "filesNotSyncingErrors": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ServerEndpointFilesNotSyncingError"
+ },
+ "description": "Array of per-item errors coming from the last sync session.",
+ "readOnly": true
+ },
+ "lastSyncMode": {
+ "$ref": "#/definitions/ServerEndpointSyncMode",
+ "description": "Sync mode",
+ "readOnly": true
+ }
+ }
+ },
+ "ServerEndpointSyncActivityStatus": {
+ "type": "object",
+ "description": "Sync Session status object.",
+ "properties": {
+ "timestamp": {
+ "type": "string",
+ "format": "date-time",
+ "description": "Timestamp when properties were updated",
+ "readOnly": true
+ },
+ "perItemErrorCount": {
+ "type": "integer",
+ "format": "int64",
+ "minimum": 0,
+ "description": "Per item error count",
+ "readOnly": true
+ },
+ "appliedItemCount": {
+ "type": "integer",
+ "format": "int64",
+ "minimum": 0,
+ "description": "Applied item count.",
+ "readOnly": true
+ },
+ "totalItemCount": {
+ "type": "integer",
+ "format": "int64",
+ "minimum": 0,
+ "description": "Total item count (if available)",
+ "readOnly": true
+ },
+ "appliedBytes": {
+ "type": "integer",
+ "format": "int64",
+ "minimum": 0,
+ "description": "Applied bytes",
+ "readOnly": true
+ },
+ "totalBytes": {
+ "type": "integer",
+ "format": "int64",
+ "minimum": 0,
+ "description": "Total bytes (if available)",
+ "readOnly": true
+ },
+ "syncMode": {
+ "$ref": "#/definitions/ServerEndpointSyncMode",
+ "description": "Sync mode",
+ "readOnly": true
+ }
+ }
+ },
+ "ServerEndpointFilesNotSyncingError": {
+ "type": "object",
+ "description": "Files not syncing error object",
+ "properties": {
+ "errorCode": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Error code (HResult)",
+ "readOnly": true
+ },
+ "persistentCount": {
+ "type": "integer",
+ "format": "int64",
+ "minimum": 0,
+ "description": "Count of persistent files not syncing with the specified error code",
+ "readOnly": true
+ },
+ "transientCount": {
+ "type": "integer",
+ "format": "int64",
+ "minimum": 0,
+ "description": "Count of transient files not syncing with the specified error code",
+ "readOnly": true
+ }
+ }
+ },
+ "ServerEndpointBackgroundDataDownloadActivity": {
+ "type": "object",
+ "description": "Background data download activity object",
+ "properties": {
+ "timestamp": {
+ "type": "string",
+ "format": "date-time",
+ "description": "Timestamp when properties were updated",
+ "readOnly": true
+ },
+ "percentProgress": {
+ "type": "integer",
+ "format": "int32",
+ "minimum": 0,
+ "maximum": 100,
+ "description": "Progress percentage",
+ "readOnly": true
+ },
+ "downloadedBytes": {
+ "type": "integer",
+ "format": "int64",
+ "minimum": 0,
+ "description": "Running count of bytes downloaded",
+ "readOnly": true
+ }
+ }
+ },
+ "ServerEndpointSyncMode": {
+ "type": "string",
+ "description": "Sync mode for the server endpoint.",
+ "enum": [
+ "Regular",
+ "NamespaceDownload",
+ "InitialUpload",
+ "SnapshotUpload",
+ "InitialFullDownload"
+ ],
+ "x-ms-enum": {
+ "name": "ServerEndpointSyncMode",
+ "modelAsString": true
+ }
+ },
+ "PhysicalPath": {
+ "type": "string",
+ "description": "Server folder used for data synchronization"
+ },
+ "ResourceId": {
+ "type": "string",
+ "description": "Arm resource identifier."
+ },
+ "TagsObject": {
+ "type": "object",
+ "description": "Tags object."
+ },
+ "FeatureStatus": {
+ "type": "string",
+ "description": "Type of the Feature Status",
+ "enum": [
+ "on",
+ "off"
+ ],
+ "x-ms-enum": {
+ "name": "FeatureStatus",
+ "modelAsString": true
+ }
+ },
+ "IncomingTrafficPolicy": {
+ "type": "string",
+ "description": "Type of the Incoming Traffic Policy",
+ "enum": [
+ "AllowAllTraffic",
+ "AllowVirtualNetworksOnly"
+ ],
+ "x-ms-enum": {
+ "name": "IncomingTrafficPolicy",
+ "modelAsString": true
+ }
+ },
+ "LocalCacheMode": {
+ "type": "string",
+ "description": "Policy for enabling follow-the-sun business models: link local cache to cloud behavior to pre-populate before local access.",
+ "enum": [
+ "DownloadNewAndModifiedFiles",
+ "UpdateLocallyCachedFiles"
+ ],
+ "x-ms-enum": {
+ "name": "LocalCacheMode",
+ "modelAsString": true
+ }
+ },
+ "InitialDownloadPolicy": {
+ "type": "string",
+ "description": "Policy for how namespace and files are recalled during FastDr",
+ "enum": [
+ "NamespaceOnly",
+ "NamespaceThenModifiedFiles",
+ "AvoidTieredFiles"
+ ],
+ "x-ms-enum": {
+ "name": "InitialDownloadPolicy",
+ "modelAsString": true
+ }
+ },
+ "ServerEndpointHealthState": {
+ "type": "string",
+ "description": "Type of the server endpoint health state",
+ "enum": [
+ "Unavailable",
+ "Healthy",
+ "Error"
+ ],
+ "x-ms-enum": {
+ "name": "ServerEndpointHealthState",
+ "modelAsString": true
+ }
+ },
+ "ServerEndpointSyncActivityState": {
+ "type": "string",
+ "description": "Type of the sync activity state",
+ "enum": [
+ "Upload",
+ "Download",
+ "UploadAndDownload"
+ ],
+ "x-ms-enum": {
+ "name": "ServerEndpointSyncActivityState",
+ "modelAsString": true
+ }
+ },
+ "ServerEndpointOfflineDataTransferState": {
+ "type": "string",
+ "description": "Type of the Health state",
+ "enum": [
+ "InProgress",
+ "Stopping",
+ "NotRunning",
+ "Complete"
+ ],
+ "x-ms-enum": {
+ "name": "ServerEndpointOfflineDataTransferState",
+ "modelAsString": true
+ }
+ },
+ "WorkflowStatus": {
+ "type": "string",
+ "description": "Type of the Workflow Status",
+ "enum": [
+ "active",
+ "expired",
+ "succeeded",
+ "aborted",
+ "failed"
+ ],
+ "x-ms-enum": {
+ "name": "WorkflowStatus",
+ "modelAsString": true
+ }
+ },
+ "OperationDirection": {
+ "type": "string",
+ "description": "Type of the Operation Direction",
+ "enum": [
+ "do",
+ "undo",
+ "cancel"
+ ],
+ "x-ms-enum": {
+ "name": "OperationDirection",
+ "modelAsString": true
+ }
+ },
+ "ProgressType": {
+ "type": "string",
+ "description": "Type of the ProgressType",
+ "enum": [
+ "none",
+ "initialize",
+ "download",
+ "upload",
+ "recall"
+ ],
+ "x-ms-enum": {
+ "name": "ProgressType",
+ "modelAsString": true
+ }
+ },
+ "OperationStatus": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "readOnly": true,
+ "type": "string",
+ "description": "Operation Id"
+ },
+ "status": {
+ "readOnly": true,
+ "type": "string",
+ "description": "Operation status"
+ },
+ "startTime": {
+ "readOnly": true,
+ "type": "string",
+ "format": "date-time",
+ "description": "Start time of the operation"
+ },
+ "endTime": {
+ "readOnly": true,
+ "type": "string",
+ "format": "date-time",
+ "description": "End time of the operation"
+ },
+ "error": {
+ "readOnly": true,
+ "$ref": "#/definitions/StorageSyncApiError",
+ "description": "Error details."
+ }
+ },
+ "description": "Operation status object"
+ },
+ "ServerEndpointCloudTieringStatus": {
+ "type": "object",
+ "description": "Server endpoint cloud tiering status object.",
+ "properties": {
+ "lastUpdatedTimestamp": {
+ "type": "string",
+ "format": "date-time",
+ "description": "Last updated timestamp",
+ "readOnly": true
+ },
+ "health": {
+ "$ref": "#/definitions/ServerEndpointHealthState",
+ "description": "Cloud tiering health state.",
+ "readOnly": true
+ },
+ "healthLastUpdatedTimestamp": {
+ "type": "string",
+ "format": "date-time",
+ "description": "The last updated timestamp of health state",
+ "readOnly": true
+ },
+ "lastCloudTieringResult": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Last cloud tiering result (HResult)",
+ "readOnly": true
+ },
+ "lastSuccessTimestamp": {
+ "type": "string",
+ "format": "date-time",
+ "description": "Last cloud tiering success timestamp",
+ "readOnly": true
+ },
+ "spaceSavings": {
+ "$ref": "#/definitions/CloudTieringSpaceSavings",
+ "description": "Information regarding how much local space cloud tiering is saving.",
+ "readOnly": true
+ },
+ "cachePerformance": {
+ "$ref": "#/definitions/CloudTieringCachePerformance",
+ "description": "Information regarding how well the local cache on the server is performing.",
+ "readOnly": true
+ },
+ "filesNotTiering": {
+ "$ref": "#/definitions/CloudTieringFilesNotTiering",
+ "description": "Information regarding files that failed to be tiered",
+ "readOnly": true
+ },
+ "volumeFreeSpacePolicyStatus": {
+ "$ref": "#/definitions/CloudTieringVolumeFreeSpacePolicyStatus",
+ "description": "Status of the volume free space policy",
+ "readOnly": true
+ },
+ "datePolicyStatus": {
+ "$ref": "#/definitions/CloudTieringDatePolicyStatus",
+ "description": "Status of the date policy",
+ "readOnly": true
+ }
+ }
+ },
+ "CloudTieringSpaceSavings": {
+ "type": "object",
+ "description": "Server endpoint cloud tiering status object.",
+ "properties": {
+ "lastUpdatedTimestamp": {
+ "type": "string",
+ "format": "date-time",
+ "description": "Last updated timestamp",
+ "readOnly": true
+ },
+ "volumeSizeBytes": {
+ "type": "integer",
+ "format": "int64",
+ "description": "Volume size",
+ "readOnly": true,
+ "minimum": 0
+ },
+ "totalSizeCloudBytes": {
+ "type": "integer",
+ "format": "int64",
+ "description": "Total size of content in the azure file share",
+ "readOnly": true,
+ "minimum": 0
+ },
+ "cachedSizeBytes": {
+ "type": "integer",
+ "format": "int64",
+ "description": "Cached content size on the server",
+ "readOnly": true,
+ "minimum": 0
+ },
+ "spaceSavingsPercent": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Percentage of cached size over total size",
+ "readOnly": true,
+ "minimum": 0,
+ "maximum": 100
+ },
+ "spaceSavingsBytes": {
+ "type": "integer",
+ "format": "int64",
+ "description": "Count of bytes saved on the server",
+ "readOnly": true,
+ "minimum": 0
+ }
+ }
+ },
+ "CloudTieringCachePerformance": {
+ "type": "object",
+ "description": "Server endpoint cloud tiering status object.",
+ "properties": {
+ "lastUpdatedTimestamp": {
+ "type": "string",
+ "format": "date-time",
+ "description": "Last updated timestamp",
+ "readOnly": true
+ },
+ "cacheHitBytes": {
+ "type": "integer",
+ "format": "int64",
+ "description": "Count of bytes that were served from the local server",
+ "readOnly": true,
+ "minimum": 0
+ },
+ "cacheMissBytes": {
+ "type": "integer",
+ "format": "int64",
+ "description": "Count of bytes that were served from the cloud",
+ "readOnly": true,
+ "minimum": 0
+ },
+ "cacheHitBytesPercent": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Percentage of total bytes (hit + miss) that were served from the local server",
+ "readOnly": true,
+ "minimum": 0,
+ "maximum": 100
+ }
+ }
+ },
+ "CloudTieringFilesNotTiering": {
+ "type": "object",
+ "description": "Server endpoint cloud tiering status object.",
+ "properties": {
+ "lastUpdatedTimestamp": {
+ "type": "string",
+ "format": "date-time",
+ "description": "Last updated timestamp",
+ "readOnly": true
+ },
+ "totalFileCount": {
+ "type": "integer",
+ "format": "int64",
+ "description": "Last cloud tiering result (HResult)",
+ "readOnly": true,
+ "minimum": 0
+ },
+ "errors": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/FilesNotTieringError"
+ },
+ "description": "Array of tiering errors",
+ "readOnly": true
+ }
+ }
+ },
+ "FilesNotTieringError": {
+ "type": "object",
+ "description": "Files not tiering error object",
+ "properties": {
+ "errorCode": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Error code (HResult)",
+ "readOnly": true
+ },
+ "fileCount": {
+ "type": "integer",
+ "format": "int64",
+ "minimum": 0,
+ "description": "Count of files with this error",
+ "readOnly": true
+ }
+ }
+ },
+ "CloudTieringVolumeFreeSpacePolicyStatus": {
+ "type": "object",
+ "description": "Status of the volume free space policy",
+ "properties": {
+ "lastUpdatedTimestamp": {
+ "type": "string",
+ "format": "date-time",
+ "description": "Last updated timestamp",
+ "readOnly": true
+ },
+ "effectiveVolumeFreeSpacePolicy": {
+ "type": "integer",
+ "format": "int32",
+ "description": "In the case where multiple server endpoints are present in a volume, an effective free space policy is applied.",
+ "readOnly": true,
+ "minimum": 0,
+ "maximum": 100
+ },
+ "currentVolumeFreeSpacePercent": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Current volume free space percentage.",
+ "readOnly": true,
+ "minimum": 0,
+ "maximum": 100
+ }
+ }
+ },
+ "CloudTieringDatePolicyStatus": {
+ "type": "object",
+ "description": "Status of the date policy",
+ "properties": {
+ "lastUpdatedTimestamp": {
+ "type": "string",
+ "format": "date-time",
+ "description": "Last updated timestamp",
+ "readOnly": true
+ },
+ "tieredFilesMostRecentAccessTimestamp": {
+ "type": "string",
+ "format": "date-time",
+ "description": "Most recent access time of tiered files",
+ "readOnly": true
+ }
+ }
+ },
+ "ServerEndpointRecallStatus": {
+ "type": "object",
+ "description": "Server endpoint recall status object.",
+ "properties": {
+ "lastUpdatedTimestamp": {
+ "type": "string",
+ "format": "date-time",
+ "description": "Last updated timestamp",
+ "readOnly": true
+ },
+ "totalRecallErrorsCount": {
+ "type": "integer",
+ "format": "int64",
+ "minimum": 0,
+ "description": "Total count of recall errors.",
+ "readOnly": true
+ },
+ "recallErrors": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ServerEndpointRecallError"
+ },
+ "description": "Array of recall errors",
+ "readOnly": true
+ }
+ }
+ },
+ "ServerEndpointRecallError": {
+ "type": "object",
+ "description": "Server endpoint recall error object",
+ "properties": {
+ "errorCode": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Error code (HResult)",
+ "readOnly": true
+ },
+ "count": {
+ "type": "integer",
+ "format": "int64",
+ "minimum": 0,
+ "description": "Count of occurences of the error",
+ "readOnly": true
+ }
+ }
+ },
+ "RegisteredServerAgentVersionStatus": {
+ "type": "string",
+ "description": "Type of the registered server agent version status",
+ "enum": [
+ "Ok",
+ "NearExpiry",
+ "Expired",
+ "Blocked"
+ ],
+ "x-ms-enum": {
+ "name": "RegisteredServerAgentVersionStatus",
+ "modelAsString": true
+ }
+ }
+ },
+ "parameters": {
+ "StorageSyncServiceNameParameter": {
+ "name": "storageSyncServiceName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the storage sync service name within the specified resource group.",
+ "x-ms-parameter-location": "method"
+ }
+ },
+ "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"
+ }
+ }
+ },
+ "security": [
+ {
+ "azure_auth": [
+ "user_impersonation"
+ ]
+ }
+ ]
+}
diff --git a/specification/storagesync/resource-manager/readme.md b/specification/storagesync/resource-manager/readme.md
index efb6bc8c2b57..c1e76d40a214 100644
--- a/specification/storagesync/resource-manager/readme.md
+++ b/specification/storagesync/resource-manager/readme.md
@@ -26,18 +26,27 @@ These are the global settings for the Storage Sync API.
``` yaml
openapi-type: arm
-tag: package-2020-03-01
+tag: package-preview-2020-09-01
```
+### Tag: package-preview-2020-09-01
+
+These settings apply only when `--tag=package-preview-2020-09-01` is specified on the command line.
+
+```yaml $(tag) == 'package-preview-2020-09-01'
+input-file:
+ - Microsoft.StorageSync/preview/2020-09-01/storagesync.json
+```
### Tag: package-2020-03-01
These settings apply only when `--tag=package-2020-03-01` is specified on the command line.
-```yaml $(tag) == 'package-2020-03-01'
+``` yaml $(tag) == 'package-2020-03-01'
input-file:
- Microsoft.StorageSync/stable/2020-03-01/storagesync.json
```
+
### Tag: package-2019-10-01
These settings apply only when `--tag=package-2019-10-01` is specified on the command line.
diff --git a/specification/subscription/resource-manager/Microsoft.Subscription/stable/2020-09-01/subscriptions.json b/specification/subscription/resource-manager/Microsoft.Subscription/stable/2020-09-01/subscriptions.json
index a4c186194cff..10aa6a32f048 100644
--- a/specification/subscription/resource-manager/Microsoft.Subscription/stable/2020-09-01/subscriptions.json
+++ b/specification/subscription/resource-manager/Microsoft.Subscription/stable/2020-09-01/subscriptions.json
@@ -460,6 +460,10 @@
"subscriptionId": {
"description": "This parameter can be used to create alias for existing subscription Id",
"type": "string"
+ },
+ "resellerId": {
+ "description": "Reseller ID, basically MPN Id",
+ "type": "string"
}
}
},
diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/monitoring.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/monitoring.json
index a41141a84d23..27d62da3934b 100644
--- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/monitoring.json
+++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/monitoring.json
@@ -162,10 +162,12 @@
}
},
"sparkJobDefinition": {
- "type": "string"
+ "type": "string",
+ "x-nullable": true
},
"pipeline": {
"uniqueItems": false,
+ "x-nullable": true,
"type": "array",
"items": {
"$ref": "#/definitions/SparkJob"
diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/bigDataPool.json b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/bigDataPool.json
index 95b3cd1f9835..9a4769f7aae7 100644
--- a/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/bigDataPool.json
+++ b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/bigDataPool.json
@@ -423,6 +423,10 @@
"$ref": "#/definitions/LibraryRequirements",
"description": "Library version requirements"
},
+ "sparkConfigProperties": {
+ "$ref": "#/definitions/LibraryRequirements",
+ "description": "Spark configuration file to specify additional properties"
+ },
"sparkVersion": {
"type": "string",
"description": "The Apache Spark version."
@@ -438,7 +442,8 @@
"Medium",
"Large",
"XLarge",
- "XXLarge"
+ "XXLarge",
+ "XXXLarge"
],
"type": "string",
"description": "The level of compute power that each node in the Big Data pool has.",
diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/examples/CreateOrUpdateWorkspace.json b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/examples/CreateOrUpdateWorkspace.json
index f2e336622b5a..45024b169fef 100644
--- a/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/examples/CreateOrUpdateWorkspace.json
+++ b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/examples/CreateOrUpdateWorkspace.json
@@ -13,6 +13,13 @@
"accountUrl": "https://accountname.dfs.core.windows.net",
"filesystem": "default"
},
+ "managedVirtualNetworkSettings": {
+ "preventDataExfiltration": false,
+ "linkedAccessCheckOnTargetResource": false,
+ "allowedAadTenantIdsForLinking": [
+ "740239CE-A25B-485B-86A0-262F29F6EBDB"
+ ]
+ },
"sqlAdministratorLogin": "login",
"sqlAdministratorLoginPassword": "password",
"managedVirtualNetwork": "default",
@@ -45,6 +52,13 @@
"dev": "workspace1.dev.projectarcadia.net",
"sql": "workspace1.sql.projectarcadia.net"
},
+ "managedVirtualNetworkSettings": {
+ "preventDataExfiltration": false,
+ "linkedAccessCheckOnTargetResource": false,
+ "allowedAadTenantIdsForLinking": [
+ "740239CE-A25B-485B-86A0-262F29F6EBDB"
+ ]
+ },
"sqlAdministratorLogin": "login",
"sqlAdministratorLoginPassword": "password",
"managedResourceGroupName": "workspaceManagedResourceGroupUnique",
@@ -85,6 +99,13 @@
"accountUrl": "https://accountname.dfs.core.windows.net",
"filesystem": "default"
},
+ "managedVirtualNetworkSettings": {
+ "preventDataExfiltration": false,
+ "linkedAccessCheckOnTargetResource": false,
+ "allowedAadTenantIdsForLinking": [
+ "740239CE-A25B-485B-86A0-262F29F6EBDB"
+ ]
+ },
"connectivityEndpoints": {
"dev": "workspace1.dev.projectarcadia.net",
"sql": "workspace1.sql.projectarcadia.net"
diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/examples/DataMaskingPolicyCreateOrUpdateMax.json b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/examples/DataMaskingPolicyCreateOrUpdateMax.json
new file mode 100644
index 000000000000..020fcfa56e58
--- /dev/null
+++ b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/examples/DataMaskingPolicyCreateOrUpdateMax.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": "2019-06-01-preview",
+ "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": ""
+ }
+ }
+ }
+ }
+}
diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/examples/DataMaskingPolicyCreateOrUpdateMin.json b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/examples/DataMaskingPolicyCreateOrUpdateMin.json
new file mode 100644
index 000000000000..50709215690c
--- /dev/null
+++ b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/examples/DataMaskingPolicyCreateOrUpdateMin.json
@@ -0,0 +1,32 @@
+{
+ "parameters": {
+ "subscriptionId": "00000000-1111-2222-3333-444444444444",
+ "resourceGroupName": "sqlcrudtest-6852",
+ "workspaceName": "sqlcrudtest-2080",
+ "sqlPoolName": "sqlcrudtest-331",
+ "dataMaskingPolicyName": "Default",
+ "api-version": "2019-06-01-preview",
+ "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": ""
+ }
+ }
+ }
+ }
+}
diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/examples/DataMaskingPolicyGet.json b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/examples/DataMaskingPolicyGet.json
new file mode 100644
index 000000000000..73551e852dd7
--- /dev/null
+++ b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/examples/DataMaskingPolicyGet.json
@@ -0,0 +1,27 @@
+{
+ "parameters": {
+ "subscriptionId": "00000000-1111-2222-3333-444444444444",
+ "resourceGroupName": "sqlcrudtest-6852",
+ "workspaceName": "sqlcrudtest-2080",
+ "sqlPoolName": "sqlcrudtest-331",
+ "dataMaskingPolicyName": "Default",
+ "api-version": "2019-06-01-preview"
+ },
+ "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": ""
+ }
+ }
+ }
+ }
+}
diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/examples/DataMaskingRuleCreateOrUpdateDefaultMax.json b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/examples/DataMaskingRuleCreateOrUpdateDefaultMax.json
new file mode 100644
index 000000000000..8c7754248ab4
--- /dev/null
+++ b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/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": "2019-06-01-preview",
+ "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/preview/2019-06-01-preview/examples/DataMaskingRuleCreateOrUpdateDefaultMin.json b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/examples/DataMaskingRuleCreateOrUpdateDefaultMin.json
new file mode 100644
index 000000000000..8db1e3ef3765
--- /dev/null
+++ b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/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": "2019-06-01-preview",
+ "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/preview/2019-06-01-preview/examples/DataMaskingRuleCreateOrUpdateNumber.json b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/examples/DataMaskingRuleCreateOrUpdateNumber.json
new file mode 100644
index 000000000000..f442dbd00e10
--- /dev/null
+++ b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/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": "2019-06-01-preview",
+ "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/preview/2019-06-01-preview/examples/DataMaskingRuleCreateOrUpdateText.json b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/examples/DataMaskingRuleCreateOrUpdateText.json
new file mode 100644
index 000000000000..ca68baae606f
--- /dev/null
+++ b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/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": "2019-06-01-preview",
+ "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/preview/2019-06-01-preview/examples/DataMaskingRuleList.json b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/examples/DataMaskingRuleList.json
new file mode 100644
index 000000000000..72777db7a200
--- /dev/null
+++ b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/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": "2019-06-01-preview"
+ },
+ "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/preview/2019-06-01-preview/examples/ExtendedSqlPoolAzureMonitorAuditingCreateMin.json b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/examples/ExtendedSqlPoolAzureMonitorAuditingCreateMin.json
new file mode 100644
index 000000000000..a366921b14e5
--- /dev/null
+++ b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/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": "2019-06-01-preview",
+ "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/preview/2019-06-01-preview/examples/ExtendedSqlPoolBlobAuditingCreateMax.json b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/examples/ExtendedSqlPoolBlobAuditingCreateMax.json
new file mode 100644
index 000000000000..fb0a9328a552
--- /dev/null
+++ b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/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": "2019-06-01-preview",
+ "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/preview/2019-06-01-preview/examples/ExtendedSqlPoolBlobAuditingCreateMin.json b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/examples/ExtendedSqlPoolBlobAuditingCreateMin.json
new file mode 100644
index 000000000000..b57b39b62ac8
--- /dev/null
+++ b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/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": "2019-06-01-preview",
+ "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/preview/2019-06-01-preview/examples/ExtendedSqlPoolBlobAuditingGet.json b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/examples/ExtendedSqlPoolBlobAuditingGet.json
new file mode 100644
index 000000000000..867aec54f026
--- /dev/null
+++ b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/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": "2019-06-01-preview"
+ },
+ "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/preview/2019-06-01-preview/examples/GetSqlPoolColumnSensitivityLabelGet.json b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/examples/GetSqlPoolColumnSensitivityLabelGet.json
new file mode 100644
index 000000000000..deb5fc3b0953
--- /dev/null
+++ b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/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": "2019-06-01-preview"
+ },
+ "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/preview/2019-06-01-preview/examples/GetWorkspace.json b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/examples/GetWorkspace.json
index 955f65fa6046..ea7289112cc0 100644
--- a/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/examples/GetWorkspace.json
+++ b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/examples/GetWorkspace.json
@@ -21,6 +21,13 @@
"dev": "workspace1.dev.projectarcadia.net",
"sql": "workspace1.sql.projectarcadia.net"
},
+ "managedVirtualNetworkSettings": {
+ "preventDataExfiltration": false,
+ "linkedAccessCheckOnTargetResource": false,
+ "allowedAadTenantIdsForLinking": [
+ "740239CE-A25B-485B-86A0-262F29F6EBDB"
+ ]
+ },
"sqlAdministratorLogin": "login",
"sqlAdministratorLoginPassword": "password",
"managedResourceGroupName": "resourceGroup2",
diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/examples/SqlPoolAuditingSettingsList.json b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/examples/SqlPoolAuditingSettingsList.json
new file mode 100644
index 000000000000..87d770c69af9
--- /dev/null
+++ b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/examples/SqlPoolAuditingSettingsList.json
@@ -0,0 +1,32 @@
+{
+ "parameters": {
+ "subscriptionId": "00000000-1111-2222-3333-444444444444",
+ "resourceGroupName": "blobauditingtest-6852",
+ "workspaceName": "blobauditingtest-2080",
+ "sqlPoolName": "testdb",
+ "api-version": "2019-06-01-preview"
+ },
+ "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/preview/2019-06-01-preview/examples/SqlPoolColumnGet.json b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/examples/SqlPoolColumnGet.json
new file mode 100644
index 000000000000..a80da2ee5428
--- /dev/null
+++ b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/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": "2019-06-01-preview"
+ },
+ "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/preview/2019-06-01-preview/examples/SqlPoolExtendedAuditingSettingsList.json b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/examples/SqlPoolExtendedAuditingSettingsList.json
new file mode 100644
index 000000000000..80df8e8985e5
--- /dev/null
+++ b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/examples/SqlPoolExtendedAuditingSettingsList.json
@@ -0,0 +1,32 @@
+{
+ "parameters": {
+ "subscriptionId": "00000000-1111-2222-3333-444444444444",
+ "resourceGroupName": "blobauditingtest-6852",
+ "workspaceName": "blobauditingtest-2080",
+ "sqlPoolName": "testdb",
+ "api-version": "2019-06-01-preview"
+ },
+ "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/preview/2019-06-01-preview/examples/SqlPoolSchemaGet.json b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/examples/SqlPoolSchemaGet.json
new file mode 100644
index 000000000000..3ddaa4d2d73e
--- /dev/null
+++ b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/examples/SqlPoolSchemaGet.json
@@ -0,0 +1,19 @@
+{
+ "parameters": {
+ "subscriptionId": "00000000-1111-2222-3333-444444444444",
+ "resourceGroupName": "myRG",
+ "workspaceName": "serverName",
+ "sqlPoolName": "myDatabase",
+ "schemaName": "dbo",
+ "api-version": "2019-06-01-preview"
+ },
+ "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/preview/2019-06-01-preview/examples/SqlPoolTableGet.json b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/examples/SqlPoolTableGet.json
new file mode 100644
index 000000000000..e0b78cb45f01
--- /dev/null
+++ b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/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": "2019-06-01-preview"
+ },
+ "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/preview/2019-06-01-preview/examples/SqlPoolVulnerabilityAssessmentRuleBaselineGet.json b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/examples/SqlPoolVulnerabilityAssessmentRuleBaselineGet.json
new file mode 100644
index 000000000000..106bd5dbf4fc
--- /dev/null
+++ b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/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": "2019-06-01-preview"
+ },
+ "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/preview/2019-06-01-preview/examples/SqlPoolVulnerabilityAssessmentScanRecordsGet.json b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/examples/SqlPoolVulnerabilityAssessmentScanRecordsGet.json
new file mode 100644
index 000000000000..322b7e04bcbc
--- /dev/null
+++ b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/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": "2019-06-01-preview"
+ },
+ "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/preview/2019-06-01-preview/examples/UpdateWorkspace.json b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/examples/UpdateWorkspace.json
index 435b56249d86..c64c464f96f3 100644
--- a/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/examples/UpdateWorkspace.json
+++ b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/examples/UpdateWorkspace.json
@@ -11,6 +11,13 @@
"identity": {
"type": "SystemAssigned"
},
+ "managedVirtualNetworkSettings": {
+ "preventDataExfiltration": false,
+ "linkedAccessCheckOnTargetResource": false,
+ "allowedAadTenantIdsForLinking": [
+ "740239CE-A25B-485B-86A0-262F29F6EBDB"
+ ]
+ },
"properties": {
"sqlAdministratorLoginPassword": "password"
}
@@ -28,6 +35,13 @@
"accountUrl": "https://accountname.dfs.core.windows.net",
"filesystem": "default"
},
+ "managedVirtualNetworkSettings": {
+ "preventDataExfiltration": false,
+ "linkedAccessCheckOnTargetResource": false,
+ "allowedAadTenantIdsForLinking": [
+ "740239CE-A25B-485B-86A0-262F29F6EBDB"
+ ]
+ },
"connectivityEndpoints": {
"dev": "workspace1.dev.projectarcadia.net",
"sql": "workspace1.sql.projectarcadia.net"
@@ -53,6 +67,13 @@
"accountUrl": "https://accountname.dfs.core.windows.net",
"filesystem": "default"
},
+ "managedVirtualNetworkSettings": {
+ "preventDataExfiltration": false,
+ "linkedAccessCheckOnTargetResource": false,
+ "allowedAadTenantIdsForLinking": [
+ "740239CE-A25B-485B-86A0-262F29F6EBDB"
+ ]
+ },
"connectivityEndpoints": {
"dev": "workspace1.dev.projectarcadia.net",
"sql": "workspace1.sql.projectarcadia.net"
diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/sqlPool.json b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/sqlPool.json
index 554a90fdbe1f..4529f02a7bcc 100644
--- a/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/sqlPool.json
+++ b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/sqlPool.json
@@ -1665,6 +1665,90 @@
"$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/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"
+ },
+ {
+ "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": {
@@ -2677,6 +2761,90 @@
"$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/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"
+ },
+ {
+ "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}": {
@@ -2871,19 +3039,797 @@
],
"responses": {
"200": {
- "description": "Successfully removed the Sql pool vulnerability assessment."
+ "description": "Successfully removed the Sql pool vulnerability assessment."
+ },
+ "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/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"
+ },
+ {
+ "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/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"
+ },
+ {
+ "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/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"
+ },
+ {
+ "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/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"
+ },
+ {
+ "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": "#/definitions/CloudError"
+ }
+ }
+ }
+ },
+ "get": {
+ "tags": [
+ "SqlPools, DataMaskingPolicies"
+ ],
+ "operationId": "DataMaskingPolicies_Get",
+ "description": "Gets a Sql pool data masking policy.",
+ "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"
+ },
+ {
+ "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": "#/definitions/CloudError"
+ }
+ }
+ }
+ }
+ },
+ "/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/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"
+ },
+ {
+ "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": "#/definitions/CloudError"
+ }
+ }
+ }
+ }
+ },
+ "/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/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"
+ },
+ {
+ "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": "#/definitions/CloudError"
+ }
+ }
+ },
+ "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/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"
+ },
+ {
+ "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/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"
+ },
+ {
+ "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/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"
+ },
+ {
+ "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/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"
+ },
+ {
+ "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/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"
+ },
+ {
+ "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 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."
+ "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-examples": {
- "Remove a database's vulnerability assessment": {
- "$ref": "./examples/DeleteSqlPoolVulnerabilityAssessment.json"
+ "Gets a database vulnerability assessment scan record by scan ID": {
+ "$ref": "./examples/SqlPoolVulnerabilityAssessmentScanRecordsGet.json"
}
}
}
@@ -4464,6 +5410,365 @@
"type": "string"
}
}
+ },
+ "ExtendedSqlPoolBlobAuditingPolicy": {
+ "description": "An extended Sql pool blob auditing policy.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v1/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