Please response to the PR ${URL} . The PR isn''t updated in 48 hours.
Quick info.
If no response from ARM review board, please send email to armapireview@microsoft.com.
If need immediate ARM review, please get ARM review oncall contact point from ICM https://icm.ad.msft.net/imp/v3/oncall/current under Service "Azure Resource Manager" and Team "RP Manifest Approvers"
If no response from Azure API review board, please send email to azureapirbcore@microsoft.com.
If you have problem to fix CI task errors, please send email to Visual Studio China Swagger and Tool team vscswagger@microsoft.com.
If you want to opt out from Swagger reviewing for out of office period, please set vacation date at https://inframonitorweb1.azurewebsites.net/Home/MyView.
Best regards, Azure Management Experience '
- subject: "Action Required: Please respond to PR ${URL}"
- description: "None initial response in 48 hours. For public repo."
- name: "[PUBLIC] initial response notification"
+ booleanFilterExpression: "WaitForReviewRevisit&&!NotReadyForReview"
+ message: '
Dear Swagger reviewer,
The PR ${URL} requires your attention. You receive the email either because PR author put on the label "WaitForReviewVisit", or because the PR has not been updated for over 48 hours.
If it requires immediate ARM review, please get ARM review oncall contact point from ICM https://icm.ad.msft.net/imp/v3/oncall/current under Service "Azure Resource Manager" and Team "RP Manifest Approvers".
If it is data plane API and requires responses from Azure API review board, please send email to azureapirbcore@microsoft.com.
Please response to the PR ${URL} . The PR isn''t updated in 48 hours.
Quick info.
If no response from ARM review board, please send email to armapireview@microsoft.com.
If need immediate ARM review, please get ARM review oncall contact point from ICM https://icm.ad.msft.net/imp/v3/oncall/current under Service "Azure Resource Manager" and Team "RP Manifest Approvers"
If no response from Azure API review board, please send email to azureapirbcore@microsoft.com.
If you have problem to fix CI task errors, please send email to Visual Studio China Swagger and Tool team vscswagger@microsoft.com.
If you want to opt out from Swagger reviewing for out of office period, please set vacation date at https://inframonitorweb1.azurewebsites.net/Home/MyView.
Best regards, Azure Management Experience '
- subject: "Action Required: Please respond to PR ${URL}"
- description: "None initial response in 48 hours. For private repo."
- name: "[PRIVATE] initial response notification"
+ message: '
Dear Swagger reviewer,
The PR ${URL} requires your attention. You receive the email either because PR author put on the label "WaitForReviewVisit", or because the PR has not been updated for over 48 hours.
If it requires immediate ARM review, please get ARM review oncall contact point from ICM https://icm.ad.msft.net/imp/v3/oncall/current under Service "Azure Resource Manager" and Team "RP Manifest Approvers".
If it is data plane API and requires responses from Azure API review board, please send email to azureapirbcore@microsoft.com.
Please review the PR ${URL} . You receive the email because the PR is labeled with either "WaitForARMFeedback" or "WaitForARMRevisit".
Quick info.
After review, please remove the label “WaitForARMFeedback” or "WaitForARMRevisit" from the PR, so that there will not be further notification email.
DO NOT REPLY: This is an automated email. If you have any questions, please send an email to the Swagger and Tools Team (vscswagger@microsoft.com).
Best regards,
Swagger and Tools Team, Azure Management Experience
'
+ subject: "Action Required: Please respond to the PR ${URL}"
to: armapireview@microsoft.com
- description: "send email to ARM team for over 5 days PRs labelled with WaitForARMFeedback"
- name: "send email to ARM team"
+ cc:
+ - ${AUTHOR}
+ - ${ASSIGNEE}
+
+- scheduleTask:
+ action: sendEmail
+ scope: pull_request
+ name: "send email to swagger and tools team"
+ trigger:
+ - label
+ args:
+ booleanFilterExpression: (LintRuleCandidate||ValidationToolBug)
+ message: '
Dear Swagger and Tools Team,
Please check the PR ${URL} . You receive the email because the PR is labeled "LintRuleCandidate" or "ValidationToolBug"
Quick info.
After review, please ensure to replace the label “LintRuleCandidate” or "ValidationToolBug" with "LintRuleCandidateCollected" or "ValidationToolBugCollected", so that there will not be further notification email.
DO NOT REPLY: This is an automated email. If you have any questions, please send an email to the Swagger and Tools Team (vscswagger@microsoft.com).
Best regards,
Swagger and Tools Team, Azure Management Experience
The PR Reviewer has commented on your PR ${URL} , putting on the label "Reviewed-ChangesRequired" or "ARMChangeRequest". Please check out the comment by clicking the PR link attached previously, and update your commits accordingly.
Please ensure to remove "Reviewed-ChangesRequired" or "ARMChangeRequest" label, after you complete updates and comment back. If you need ARM board or swagger reviewer revisit your PR, please label the PR with "WaitForARMRevisit" and "WaitForReviewRevisit" respectively.
Please response to the issue ${URL} . The issue isn't updated in 48 hours.
Quick info.
If you have any question, please send email to Visual Studio Swagger and Tool team vscswagger@microsoft.com.
Best regards, Azure Management Experience "
subject: "Action Required: Please respond to issue ${URL}"
- cc: Ankun.Ning@microsoft.com
+ to: ${ASSIGNEE}
+ cc: vscswagger@microsoft.com
diff --git a/CODEOWNERS b/CODEOWNERS
index b9ebec7df9c7..c5db75e8217f 100644
--- a/CODEOWNERS
+++ b/CODEOWNERS
@@ -26,7 +26,7 @@
/specification/dns/ @owolabi2
/specification/documentdb/ @dmakwana
/specification/domainservices/ @jihochang
-/specification/eventgrid/ @kalyanaj
+/specification/eventgrid/ @Kishp01 @ahamad-MS
/specification/eventhub/ @v-ajnava
/specification/features/ @stankovski
/specification/graphrbac/ @lmazuel @yugangw-msft @amarzavery
@@ -66,7 +66,7 @@
/specification/servicebus/ @sazeesha @v-ajnava
/specification/servicefabric/ @juhacket @samedder
/specification/sql/ @dnayantara @jaredmoo @nathannfan
-/specification/storage/ @jasonyang-msft @xiaonlimsft
+/specification/storage/ @blueww @jasonyang-msft @xiaonlimsft @kasobol-msft
/specification/storageimportexport/ @leoz-ms
/specification/storagesync/ @ankushbindlish2
/specification/storsimple8000series/ @manaas-microsoft
diff --git a/custom-words.txt b/custom-words.txt
index 3584fbca536e..f2b1de52262c 100644
--- a/custom-words.txt
+++ b/custom-words.txt
@@ -1,4 +1,7 @@
-AADDS
+A128CBCPAD
+A192CBCPAD
+A256CBCPAD
+AADDS
aadiam
AADP
AATP
@@ -115,6 +118,7 @@ australiaeast
australiasoutheast
authenticatable
Authenticode
+authorityURL
authorizationrules
authprovider
authproviders
@@ -264,6 +268,8 @@ CIDR
CIDRs
CIFS
ciphertext
+claimCondition
+claimType
clfs
Clickthrough
clientaccesspolicy
@@ -290,6 +296,7 @@ cntk
CODEGEN
codegeneration
codemirror
+codepackage
cognitiveservices
colls
colocation
@@ -329,6 +336,8 @@ costcenter
costinsights
costmanagement
Couchbase
+cpim
+CPIM
creatable
createconsumergroup
createorupdate
@@ -457,6 +466,7 @@ domainservices
DOTALL
DRMs
dsmax
+DTDL
Dtus
duration'PT
EAPMSCHA
@@ -498,6 +508,7 @@ ErrorSchema
Español
estaba
Etag
+etags
Ethereum
evalue
evaluateautoscale
@@ -506,6 +517,7 @@ eventgrid
Eventhub
eventhubconnections
eventhubs
+eventroutes
eventtime
eventtypes
EWDG
@@ -561,6 +573,7 @@ Français
frontdoor
fsaction
Fulfilment
+fullmetadata
Fulltext
fullyqualified
functionappsettings
@@ -594,6 +607,7 @@ getprivatelinkresources
getsas
getskus
getssotoken
+gettestresultfile
getvpnclientipsecparameters
getvpnprofilepackageurl
gibibytes
@@ -629,6 +643,7 @@ Hardenings
hbase
hbasephoenix
hcatalog
+HCRP
HDFS
hdinsight
Headnode
@@ -676,6 +691,7 @@ imagesearch
IMDS
importdevices
Inbuild
+incomingrelationships
indic
inferencing
Informations
@@ -760,9 +776,11 @@ Kiswahili
Knowledgebase
knowledgebases
koelner
+Kölner
koreacentral
koreasouth
Kpis
+Kraaij
Ksettings
kstem
kube
@@ -976,6 +994,7 @@ nodeconfiguration
nodecounts
Nodeploy
nodrm
+nometadata
nonadmin
NONCLUSTERED
nonincreasing
@@ -1081,6 +1100,7 @@ pixelated
pkcs
playready
Plex
+Pohlmann
policyassignments
policydefinitions
policyinsights
@@ -1121,6 +1141,7 @@ pricesheets
pricings
primarybytes
privatedns
+privatelinks
privatepreview
projectable
Protectable
@@ -1165,6 +1186,7 @@ randint
Rankable
ratelimit
ravbhatnagar
+rawwebsockets
rawxml
rbac
rdbms
@@ -1246,8 +1268,10 @@ resourcename
resourceregion
resourcetype
Responsys
+RESTAPI
restoreheartbeat
Restproxy
+restype
resumable
resync
resynchronization
@@ -1272,6 +1296,8 @@ rosettanetprocessconfigurations
rotatediskencryptionkey
routable
routingendpointhealth
+rpki
+RPKI
rpns
RSAES
RSASSA
@@ -1511,7 +1537,9 @@ testall
testallroutes
testnew
testnewroute
+testresultfile
textanalytics
+TFIDF
Tful
Tfvc
timeframe
@@ -1696,6 +1724,7 @@ websearch
webservices
Webspace
webtest
+webtestresult
webtests
westcentralus
westeurope
@@ -1749,3 +1778,18 @@ cloudManifestFiles
highestcriticalimpact
apiserver
kubeadmin
+AzureAD
+PrivateLink
+privateLinkForAzureAd
+userprincipalname
+sessionstate
+sessionhosts
+hostpool
+Alexa
+regeneratekeys
+Directline
+Keyschannel
+azureADMetrics
+sparkr
+ambari
+dotnetspark
diff --git a/documentation/FAQ.md b/documentation/FAQ.md
new file mode 100644
index 000000000000..82cd2276edec
--- /dev/null
+++ b/documentation/FAQ.md
@@ -0,0 +1,41 @@
+# FAQ in Swagger PR Review
+
+This page is intended to answer questions frequently asked during Azure Swagger PR review.
+
+1. [I am new to Swagger/OpenAPI, How should I start?](#Onboard)
+2. [How to fix validation failure?](#validation)
+3. [How to generate SDK from Swagger?](#SDK)
+4. [How to generate document](#doc)
+5. [If need further help, who can we contact?](#contact)
+
+## How to onboard PR review Process?
+If you are new to Swagger/OpenAPI, you can refer to this [document](https://dev.azure.com/azure-sdk/internal/_wiki/wikis/internal.wiki/80/Getting-started-with-OpenAPI-specifications)
+
+If you are new to Swagger PR review process, you can refer to this [flowchart](https://dev.azure.com/azure-sdk/internal/_wiki/wikis/internal.wiki/212/Swagger-PR-Review)
+
+You can refer to this [document](https://dev.azure.com/azure-sdk/internal/_wiki/wikis/internal.wiki/49/Request-Access-to-Azure-SDK-repos) to get read permission to submit PR.
+
+## How to fix validation failure?
+| Validation | Description | How to fix |
+| --- | --- | --- |
+| [Model Validation](https://github.com/Azure/azure-rest-api-specs/blob/master/documentation/Semantic-and-Model-Violations-Reference.md) | Model validation enforces correctness between example and swagger. It checks whether definitions for request parameters and responses, match an expected input/output payload of the service. | [Here](https://aka.ms/ci-fix#model-validation) |
+| [Lint diff](https://github.com/Azure/azure-openapi-validator) | A tool to check whether changes in PR are satisfied with certain kind of rules outlined in the [automated rules checklist](https://github.com/Azure/azure-rest-api-specs/blob/master/documentation/openapi-authoring-automated-guidelines.md) | [Here](https://aka.ms/ci-fix#linter-validation) |
+| [Breaking Change](https://github.com/Azure/openapi-diff) | A tool to check what a swagger PR has changed and whether these changes violate [breaking changes rules](https://github.com/Azure/openapi-diff/blob/master/docs/README.md).| [Here](https://aka.ms/ci-fix#breaking-change-check)|
+| [Avocado](https://github.com/Azure/avocado/blob/master/README.md) | Avocado validates folder structure and configuration. | [Here](https://aka.ms/ci-fix#avocado) |
+| [Semantic](https://github.com/Azure/azure-rest-api-specs/blob/master/documentation/Semantic-and-Model-Violations-Reference.md) | Semantic validation enforces correctness on the swagger specific elements. Such as paths and operations. Ensure the element definition meet the OpenApi 2.0 specification. | [Here](https://aka.ms/ci-fix#semantic-validation) |
+| Prettier | Code formatter for Swagger | [Here](https://aka.ms/ci-fix#prettier-check) |
+| BranchProtectionForPrivateRepo | BranchProtectionForPrivateRepo is designed to always fail to prevent from merging PR into master which is not allow in private swagger repo as it will cause issue to sync up from public repo. | You can ignore this failure |
+
+Refer to [Document](https://aka.ms/ci-fix) for how to run these tools locally
+
+## How to generate SDK from Swagger?
+If you are working in the public repository,SDK generation is triggered as soon as your OpenAPI specification (a.k.a swagger) PR is created/committed/merged in to the azure-rest-api-specs repository.
+
+If you are working in the private repository, please refer to this [document](https://dev.azure.com/azure-sdk/internal/_wiki/wikis/internal.wiki/81/Management-Plane-SDK-generation) to manually generate SDKs of different languages, including Python, Java, Go, C#, Js etc.
+
+
+## How to generate Document from Swagger?
+Refer to [document](https://dev.azure.com/azure-sdk/internal/_wiki/wikis/internal.wiki/79/Generation-of-docs-on-docs.microsoft.com)
+
+## If need further help, who can we contact?
+If any other help need, Please send a mail to vscswagger@microsoft.com
\ No newline at end of file
diff --git a/documentation/openapi-authoring-automated-guidelines.md b/documentation/openapi-authoring-automated-guidelines.md
index 5427d2fc57ce..848f8f89f120 100644
--- a/documentation/openapi-authoring-automated-guidelines.md
+++ b/documentation/openapi-authoring-automated-guidelines.md
@@ -51,8 +51,11 @@ We request OpenAPI(Swagger) spec authoring be assigned to engineers who have an
| [R3011](#r3011) | [DescriptionMustNotBeNodeName](#r3011) | ARM and Data plane OpenAPI(swagger) specs |
| [R2020](#r2020) | [RequiredPropertiesMissingInResourceModel](#r2020) | ARM OpenAPI(swagger) specs |
| [R3020](#r3020) | [PathResourceProviderNamePascalCase](#r3020) | ARM OpenAPI(swagger) specs |
-| [R3021](#r3021) | [PathResouceTypeNameCamelCase](#r3021) | ARM OpenAPI(swagger) specs |
+| [R3021](#r3021) | [PathResourceTypeNameCamelCase](#r3021) | ARM OpenAPI(swagger) specs |
| [R4004](#r4004) | [OperationIdRequired](#r4004) | ARM OpenAPI(swagger) specs |
+| [R4007](#r4007) | [DefaultErrorResponseSchema](#r4007) | ARM OpenAPI(swagger) specs |
+| [R4010](#r4010) | [RequiredDefaultResponse](#r4010) | ARM OpenAPI(swagger) specs |
+| [R4011](#r4011) | [DeleteOperationResponses](#r4011) | ARM OpenAPI(swagger) specs |
#### ARM Warnings
@@ -63,6 +66,7 @@ We request OpenAPI(Swagger) spec authoring be assigned to engineers who have an
| [R2057](#r2057) | [InvalidSkuModel](#r2057) | ARM OpenAPI(swagger) specs |
| [R3010](#r3010) | [TrackedResourceListByImmediateParent](#r3010) | ARM OpenAPI(swagger) specs |
| [R2004](#r2004) | [NonApplicationJsonType](#r2004) | ARM OpenAPI(swagger) specs |
+| [R4009](#r4009) | [RequiredSystemDataInNewApiVersions](#r4009) | ARM OpenAPI(swagger) specs |
### SDK Violations
@@ -97,6 +101,9 @@ We request OpenAPI(Swagger) spec authoring be assigned to engineers who have an
| [R3024](#r3024) | [EnumUniqueValue](#r3024) | ARM and Data plan OpenAPI(swagger) specs |
| [R3029](#r3029) | [EnumMustNotHaveEmptyValue](#r3024) | ARM and Data plan OpenAPI(swagger) specs |
| [R4005](#r4005) | [UniqueXmsEnumName](#r4005) | ARM and Data plane OpenAPI(swagger) specs |
+| [R4008](#r4008) | [AvoidEmptyResponseSchema](#r4008) | ARM OpenAPI(swagger) specs |
+| [R4012](#r4012) | [XmsPageableMustHaveCorrespondingResponse](#r4012) | ARM OpenAPI(swagger) specs |
+| [R4013](#r4013) | [IntegerTypeMustHaveFormat](#r4013) | ARM OpenAPI(swagger) specs |
#### SDK Warnings
@@ -2315,4 +2322,264 @@ The following would be invalid:
Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rules](#automated-rules) | [ARM](#arm-violations): [Errors](#arm-errors) or [Warnings](#arm-warnings) | [SDK](#sdk-violations): [Errors](#sdk-errors) or [Warnings](#sdk-warnings)
+### R4007 DefaultErrorResponseSchema
+**Category** : ARM Error
+
+**Applies to** : ARM OpenAPI(swagger) specs
+
+**Output Message** : The default error response schema SHOULD correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content.
+
+**Description** : The default error response schema SHOULD correspond to the schema documented at [common-api-details](https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content).
+
+**CreatedAt**: April 2, 2020
+
+**LastModifiedAt**: April 2, 2020
+
+**How to fix the violation**: Following the ARM specification to modify the schema in the swagger file.
+
+The following would be invalid:
+
+```json
+ "responese":{
+ "default": {
+ "schema":{
+ "error":"error msg",
+ "code": 404,
+ "message":"some details"
+ }
+ }
+ }
+
+```
+
+the correct schema:
+
+```json
+ "responese":{
+ "default": {
+ "error":
+ {
+ "code": 404,
+ "message":"some details"
+ ...
+ }
+ }
+ }
+
+```
+
+Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rules](#automated-rules) | [ARM](#arm-violations): [Errors](#arm-errors) or [Warnings](#arm-warnings) | [SDK](#sdk-violations): [Errors](#sdk-errors) or [Warnings](#sdk-warnings)
+
+### R4008 AvoidEmptyResponseSchema
+
+**Category** : SDK Error
+
+**Applies to** : ARM OpenAPI(swagger) specs
+
+**Output Message** : Response schema must not be empty.
+
+**Description** : Response schema must not be empty, or it will block code genaration.
+
+**CreatedAt**: April 2, 2020
+
+**LastModifiedAt**: April 2, 2020
+
+**How to fix the violation**: Add the correct definition of the schema in the response or remove it if don't need.
+
+The following would be invalid:
+
+```json
+...
+ "responese":{
+ "default": {
+ "schema":{
+ }
+ }
+ }
+...
+```
+Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rules](#automated-rules) | [ARM](#arm-violations): [Errors](#arm-errors) or [Warnings](#arm-warnings) | [SDK](#sdk-violations): [Errors](#sdk-errors) or [Warnings](#sdk-warnings)
+
+### R4009 RequiredSystemDataInNewApiVersion
+
+**Category** : ARM Warning
+
+**Applies to** : ARM OpenAPI(swagger) specs
+
+**Output Message** : The response of operation '{operation name }' is defined without 'systemData'. Consider adding the systemData to the response.
+
+**Description** : The responses of GET, PUT and PATCH in new API versions should contain the `systemData` object.The version after 2020-05-01 consider as a new API version.
+For more information, see: [AzureRPCSystemData-RP_Copy.docx](https://microsoft.sharepoint.com/:w:/t/Operations_Management_Suite/EZP2GBYnvsRKnSmJ_FXV4jkBUz6xG_glzG3KVnmHN9Q0qA?e=99dfOo).
+
+**CreatedAt**: May 21, 2020
+
+**LastModifiedAt**: May 21, 2020
+
+**How to fix the violation**: For each response in the GET/PUT/PATCH opearation add the systemData object:
+``` json
+ "systemData": {
+ "$ref": "#/definitions/SystemData"
+ }
+```
+
+Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rules](#automated-rules) | [ARM](#arm-violations): [Errors](#arm-errors) or [Warnings](#arm-warnings) | [SDK](#sdk-violations): [Errors](#sdk-errors) or [Warnings](#sdk-warnings)
+
+### R4010 RequiredDefaultResponse
+
+**Category** : ARM Error
+
+**Applies to** : ARM OpenAPI(swagger) specs
+
+**Output Message** : The response is defined without a default error response implementation,please add it.
+
+**Description** : Per ARM Specs, every operation must have a default error response implementation.
+
+**CreatedAt**: May 21, 2020
+
+**LastModifiedAt**: May 21, 2020
+
+**How to fix the violation**: For each operation response, please add a default error response implementation:
+The following would be valid:
+
+```json
+...
+ "responses":{
+ "default": {
+ "schema":{
+ "$ref":#/definiton/Error
+ }
+ }
+ }
+...
+```
+
+Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rules](#automated-rules) | [ARM](#arm-violations): [Errors](#arm-errors) or [Warnings](#arm-warnings) | [SDK](#sdk-violations): [Errors](#sdk-errors) or [Warnings](#sdk-warnings)
+
+
+### R4011 DeleteOperationResponses
+
+**Category** : ARM Error
+
+**Applies to** : ARM OpenAPI(swagger) specs
+
+**Output Message** : The delete operation is defined without a 200 or 204 error response implementation,please add it.
+
+**Description** : Per ARM Specs, all DELETE methods must have responses code implementation: 200, 204.
+
+**CreatedAt**: May 21, 2020
+
+**LastModifiedAt**: May 21, 2020
+
+**How to fix the violation**: For each operation response, please add the missing code response implementation:
+
+The following would be valid:
+
+```json
+...
+"path1":{
+ "delete": {
+ "parameters": [
+ .....
+ .....
+ ]
+ "responese":{
+ "default": {
+ "schema":{
+ "$ref":#/definiton/Error
+ }
+ },
+ "200": {
+ "schema":{
+ "$ref":#/definiton/response
+ }
+ },
+ "204": {
+ "schema":{
+ "$ref":#/definiton/resonse
+ }
+ }
+ }
+ }
+}
+...
+```
+Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rules](#automated-rules) | [ARM](#arm-violations): [Errors](#arm-errors) or [Warnings](#arm-warnings) | [SDK](#sdk-violations): [Errors](#sdk-errors) or [Warnings](#sdk-warnings)
+
+### R4012 XmsPageableMustHaveCorrespondingResponse
+
+**Category** : SDK Error
+
+**Applies to** : ARM OpenAPI(swagger) specs
+
+**Output Message** : The operation: '{operation name}' is defined with x-ms-pageable enabled,but can not find the corresponding nextLink property in the response, please add it.
+
+**Description** : Per [extensions](https://github.com/Azure/autorest/blob/master/docs/extensions/readme.md#x-ms-pageable) ,when specifying a x-ms-pagable/nextLinkName, the corresponding nextlink property must be defined in the response schema.
+
+**CreatedAt**: May 21, 2020
+
+**LastModifiedAt**: May 21, 2020
+
+**How to fix the violation**: Add the missing corresponding property like nextLink in response:
+
+The following would be valid:
+
+```json
+...
+"get":{
+ ....
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ ....
+ "responese":{
+ "200": {
+ "schema":{
+ "description": "The list of metric items.",
+ "type": "object",
+ "properties": {
+ "nextLink": {
+ "description": "The link used to get the next page of operations.",
+ "type": "string"
+ }
+ ....
+ }
+ }
+ }
+ ....
+ }
+}
+...
+```
+Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rules](#automated-rules) | [ARM](#arm-violations): [Errors](#arm-errors) or [Warnings](#arm-warnings) | [SDK](#sdk-violations): [Errors](#sdk-errors) or [Warnings](#sdk-warnings)
+
+### R4013 IntegerTypeMustHaveFormat
+
+**Category** : SDK Error
+
+**Applies to** : ARM OpenAPI(swagger) specs
+
+**Output Message** : The integer type does not have a format, please add it.
+
+**Description** : The type:integer must have a required format. Possible value for format are int32 and int64.
+
+**CreatedAt**: May 21, 2020
+
+**LastModifiedAt**: May 21, 2020
+
+**Why this rule is important**: Right now it's possible to type a field as integer, but not specifying format. It actually creates problems for generate when the number of bits matter, like C#.
+
+**How to fix the violation**: Add the correct format for integer type:
+
+The following would be valid:
+
+```json
+...
+ "incomingChanges": {
+ "type": "integer",
+ "format": "int64",
+ ....
+ }
+...
+```
+Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rules](#automated-rules) | [ARM](#arm-violations): [Errors](#arm-errors) or [Warnings](#arm-warnings) | [SDK](#sdk-violations): [Errors](#sdk-errors) or [Warnings](#sdk-warnings)
\ No newline at end of file
diff --git a/package-lock.json b/package-lock.json
index af5001eb9fb9..85b829ee2129 100644
--- a/package-lock.json
+++ b/package-lock.json
@@ -24,14 +24,18 @@
}
},
"@azure/oad": {
- "version": "0.7.0",
- "resolved": "https://registry.npmjs.org/@azure/oad/-/oad-0.7.0.tgz",
- "integrity": "sha512-voz6Q71GmJpRAThFG5aDWqHiQCc6eL1ajAR0JqbqCsqStQdBauGkGZhOeawkNJIgHnFY3GG9GO/fWhfp36uBWg==",
+ "version": "0.8.1",
+ "resolved": "https://registry.npmjs.org/@azure/oad/-/oad-0.8.1.tgz",
+ "integrity": "sha512-Xl5vTMkfPkv0wVUgbvfITpaV07o6RIPOWpyPcCiZgQpkpfc0vsSh4SK3K4JSJ44z4BXTOhCSmkYgv/Zvtq/vSQ==",
"dev": true,
"requires": {
"@ts-common/fs": "^0.2.0",
- "@ts-common/json-parser": "^0.7.0",
- "autorest": "^2.0.0",
+ "@ts-common/iterator": "^0.3.6",
+ "@ts-common/json": "^0.3.1",
+ "@ts-common/json-parser": "^0.9.0",
+ "@ts-common/source-map": "^0.5.0",
+ "@ts-common/string-map": "^0.3.0",
+ "autorest": "^2.0.4407",
"glob": "^7.1.3",
"js-yaml": "^3.13.1",
"json-pointer": "^0.6.0",
@@ -44,12 +48,13 @@
},
"dependencies": {
"@ts-common/json-parser": {
- "version": "0.7.2",
- "resolved": "https://registry.npmjs.org/@ts-common/json-parser/-/json-parser-0.7.2.tgz",
- "integrity": "sha512-Rb0bA/maGzfjA7ZegDvfDABF+vz2norftJX80aTOLb88gLd2+SnD6gYVg3nZH9FpA5/34JXFDvMs4Fb5GuPoew==",
+ "version": "0.9.0",
+ "resolved": "https://registry.npmjs.org/@ts-common/json-parser/-/json-parser-0.9.0.tgz",
+ "integrity": "sha512-how0z/Ak7Bay+feIYfJFVV8UMw8Ky2Czoo5XwN7QigCOlN4HyW6wSNup4zrZ7t6NUB0002tW/+IOKCH2lAVJOg==",
"dev": true,
"requires": {
- "@ts-common/iterator": "^0.3.4",
+ "@ts-common/add-position": "0.0.2",
+ "@ts-common/iterator": "^0.3.5",
"@ts-common/json": "^0.3.1",
"@ts-common/source-map": "^0.5.0",
"@ts-common/string-map": "^0.3.0",
@@ -88,20 +93,21 @@
}
},
"@azure/rest-api-specs-scripts": {
- "version": "0.7.2",
- "resolved": "https://registry.npmjs.org/@azure/rest-api-specs-scripts/-/rest-api-specs-scripts-0.7.2.tgz",
- "integrity": "sha512-2/yMT7qHPXDjbiEzi5IDBjukQ8HUL82NEwT32tHKvKRbACKJ2NemouOPzzJcbogpPzyAW3FfMTR79L0yXEqNcQ==",
+ "version": "0.10.2",
+ "resolved": "https://registry.npmjs.org/@azure/rest-api-specs-scripts/-/rest-api-specs-scripts-0.10.2.tgz",
+ "integrity": "sha512-g7W4eSvbn2q5wOF0FCj2lZ2yXuASfmIsZoib8ms4LXfixnA8CL2uW4XiVUvx2KzdW1RCCdjgh5n+LfCywLe4jw==",
"dev": true,
"requires": {
"@azure/avocado": "^0.4.1",
- "@azure/oad": "^0.7.0",
+ "@azure/oad": "^0.8.1",
+ "@azure/swagger-validation-common": "^0.0.2",
"@octokit/rest": "^16.42.0",
"@ts-common/string-map": "^0.3.0",
"commonmark": "0.27.0",
"fs-extra": "^7.0.1",
"glob": "^7.1.3",
"js-yaml": "^3.13.1",
- "oav": "0.21.4",
+ "oav": "^0.21.6",
"request": "^2.88.0"
},
"dependencies": {
@@ -152,6 +158,12 @@
}
}
},
+ "@azure/swagger-validation-common": {
+ "version": "0.0.2",
+ "resolved": "https://registry.npmjs.org/@azure/swagger-validation-common/-/swagger-validation-common-0.0.2.tgz",
+ "integrity": "sha512-/OTgP3USqq2Cko6vzDgmODpqGjk9eTANYMBMXtgsTgh9RtR6b3HZdQTPe5dqkqes/YoIBW8IarJ0B0HucAv1+A==",
+ "dev": true
+ },
"@microsoft.azure/autorest-extension-base": {
"version": "1.0.13",
"resolved": "https://registry.npmjs.org/@microsoft.azure/autorest-extension-base/-/autorest-extension-base-1.0.13.tgz",
@@ -178,21 +190,21 @@
"dev": true
},
"@octokit/auth-token": {
- "version": "2.4.0",
- "resolved": "https://registry.npmjs.org/@octokit/auth-token/-/auth-token-2.4.0.tgz",
- "integrity": "sha512-eoOVMjILna7FVQf96iWc3+ZtE/ZT6y8ob8ZzcqKY1ibSQCnu4O/B7pJvzMx5cyZ/RjAff6DAdEb0O0Cjcxidkg==",
+ "version": "2.4.1",
+ "resolved": "https://registry.npmjs.org/@octokit/auth-token/-/auth-token-2.4.1.tgz",
+ "integrity": "sha512-NB81O5h39KfHYGtgfWr2booRxp2bWOJoqbWwbyUg2hw6h35ArWYlAST5B3XwAkbdcx13yt84hFXyFP5X0QToWA==",
"dev": true,
"requires": {
- "@octokit/types": "^2.0.0"
+ "@octokit/types": "^4.0.1"
}
},
"@octokit/endpoint": {
- "version": "6.0.1",
- "resolved": "https://registry.npmjs.org/@octokit/endpoint/-/endpoint-6.0.1.tgz",
- "integrity": "sha512-pOPHaSz57SFT/m3R5P8MUu4wLPszokn5pXcB/pzavLTQf2jbU+6iayTvzaY6/BiotuRS0qyEUkx3QglT4U958A==",
+ "version": "6.0.2",
+ "resolved": "https://registry.npmjs.org/@octokit/endpoint/-/endpoint-6.0.2.tgz",
+ "integrity": "sha512-xs1mmCEZ2y4shXCpFjNq3UbmNR+bLzxtZim2L0zfEtj9R6O6kc4qLDvYw66hvO6lUsYzPTM5hMkltbuNAbRAcQ==",
"dev": true,
"requires": {
- "@octokit/types": "^2.11.1",
+ "@octokit/types": "^4.0.1",
"is-plain-object": "^3.0.0",
"universal-user-agent": "^5.0.0"
},
@@ -215,6 +227,17 @@
"dev": true,
"requires": {
"@octokit/types": "^2.0.1"
+ },
+ "dependencies": {
+ "@octokit/types": {
+ "version": "2.16.2",
+ "resolved": "https://registry.npmjs.org/@octokit/types/-/types-2.16.2.tgz",
+ "integrity": "sha512-O75k56TYvJ8WpAakWwYRN8Bgu60KrmX0z1KqFp1kNiFNkgW+JW+9EBKZ+S33PU6SLvbihqd+3drvPxKK68Ee8Q==",
+ "dev": true,
+ "requires": {
+ "@types/node": ">= 8"
+ }
+ }
}
},
"@octokit/plugin-request-log": {
@@ -231,17 +254,28 @@
"requires": {
"@octokit/types": "^2.0.1",
"deprecation": "^2.3.1"
+ },
+ "dependencies": {
+ "@octokit/types": {
+ "version": "2.16.2",
+ "resolved": "https://registry.npmjs.org/@octokit/types/-/types-2.16.2.tgz",
+ "integrity": "sha512-O75k56TYvJ8WpAakWwYRN8Bgu60KrmX0z1KqFp1kNiFNkgW+JW+9EBKZ+S33PU6SLvbihqd+3drvPxKK68Ee8Q==",
+ "dev": true,
+ "requires": {
+ "@types/node": ">= 8"
+ }
+ }
}
},
"@octokit/request": {
- "version": "5.4.2",
- "resolved": "https://registry.npmjs.org/@octokit/request/-/request-5.4.2.tgz",
- "integrity": "sha512-zKdnGuQ2TQ2vFk9VU8awFT4+EYf92Z/v3OlzRaSh4RIP0H6cvW1BFPXq4XYvNez+TPQjqN+0uSkCYnMFFhcFrw==",
+ "version": "5.4.4",
+ "resolved": "https://registry.npmjs.org/@octokit/request/-/request-5.4.4.tgz",
+ "integrity": "sha512-vqv1lz41c6VTxUvF9nM+a6U+vvP3vGk7drDpr0DVQg4zyqlOiKVrY17DLD6de5okj+YLHKcoqaUZTBtlNZ1BtQ==",
"dev": true,
"requires": {
"@octokit/endpoint": "^6.0.1",
"@octokit/request-error": "^2.0.0",
- "@octokit/types": "^2.11.1",
+ "@octokit/types": "^4.0.1",
"deprecation": "^2.0.0",
"is-plain-object": "^3.0.0",
"node-fetch": "^2.3.0",
@@ -250,12 +284,12 @@
},
"dependencies": {
"@octokit/request-error": {
- "version": "2.0.0",
- "resolved": "https://registry.npmjs.org/@octokit/request-error/-/request-error-2.0.0.tgz",
- "integrity": "sha512-rtYicB4Absc60rUv74Rjpzek84UbVHGHJRu4fNVlZ1mCcyUPPuzFfG9Rn6sjHrd95DEsmjSt1Axlc699ZlbDkw==",
+ "version": "2.0.1",
+ "resolved": "https://registry.npmjs.org/@octokit/request-error/-/request-error-2.0.1.tgz",
+ "integrity": "sha512-5lqBDJ9/TOehK82VvomQ6zFiZjPeSom8fLkFVLuYL3sKiIb5RB8iN/lenLkY7oBmyQcGP7FBMGiIZTO8jufaRQ==",
"dev": true,
"requires": {
- "@octokit/types": "^2.0.0",
+ "@octokit/types": "^4.0.1",
"deprecation": "^2.0.0",
"once": "^1.4.0"
}
@@ -280,6 +314,17 @@
"@octokit/types": "^2.0.0",
"deprecation": "^2.0.0",
"once": "^1.4.0"
+ },
+ "dependencies": {
+ "@octokit/types": {
+ "version": "2.16.2",
+ "resolved": "https://registry.npmjs.org/@octokit/types/-/types-2.16.2.tgz",
+ "integrity": "sha512-O75k56TYvJ8WpAakWwYRN8Bgu60KrmX0z1KqFp1kNiFNkgW+JW+9EBKZ+S33PU6SLvbihqd+3drvPxKK68Ee8Q==",
+ "dev": true,
+ "requires": {
+ "@types/node": ">= 8"
+ }
+ }
}
},
"@octokit/rest": {
@@ -307,9 +352,9 @@
}
},
"@octokit/types": {
- "version": "2.11.1",
- "resolved": "https://registry.npmjs.org/@octokit/types/-/types-2.11.1.tgz",
- "integrity": "sha512-QaLoLkmFdfoNbk3eOzPv7vKrUY0nRJIYmZDoz/pTer4ICpqu80aSQTVHnnUxEFuURCiidig76CcxUOYC/bY3RQ==",
+ "version": "4.1.4",
+ "resolved": "https://registry.npmjs.org/@octokit/types/-/types-4.1.4.tgz",
+ "integrity": "sha512-W+aHUBA6pEZ8OC1fgfFW1/jrgtkaMVBhNr7jhhBErvbWQY4Ii9Hlf3LAurwcy5XXjz8EYluiCZjHhnQO4GSfNg==",
"dev": true,
"requires": {
"@types/node": ">= 8"
@@ -740,9 +785,9 @@
"dev": true
},
"aws4": {
- "version": "1.9.1",
- "resolved": "https://registry.npmjs.org/aws4/-/aws4-1.9.1.tgz",
- "integrity": "sha512-wMHVg2EOHaMRxbzgFJ9gtjOOCrI80OHLG14rxi28XwOW8ux6IiEbRCGGGqCtdAIg4FQCbW20k9RsT4y3gJlFug==",
+ "version": "1.10.0",
+ "resolved": "https://registry.npmjs.org/aws4/-/aws4-1.10.0.tgz",
+ "integrity": "sha512-3YDiu347mtVtjpyV3u5kVqQLP242c06zwDOgpeRnybmXlYYsLbtTrUBUm8i8srONt+FWobl5aibnU1030PeeuA==",
"dev": true
},
"balanced-match": {
@@ -3300,18 +3345,18 @@
"dev": true
},
"mime-db": {
- "version": "1.43.0",
- "resolved": "https://registry.npmjs.org/mime-db/-/mime-db-1.43.0.tgz",
- "integrity": "sha512-+5dsGEEovYbT8UY9yD7eE4XTc4UwJ1jBYlgaQQF38ENsKR3wj/8q8RFZrF9WIZpB2V1ArTVFUva8sAul1NzRzQ==",
+ "version": "1.44.0",
+ "resolved": "https://registry.npmjs.org/mime-db/-/mime-db-1.44.0.tgz",
+ "integrity": "sha512-/NOTfLrsPBVeH7YtFPgsVWveuL+4SjjYxaQ1xtM1KMFj7HdxlBlxeyNLzhyJVx7r4rZGJAZ/6lkKCitSc/Nmpg==",
"dev": true
},
"mime-types": {
- "version": "2.1.26",
- "resolved": "https://registry.npmjs.org/mime-types/-/mime-types-2.1.26.tgz",
- "integrity": "sha512-01paPWYgLrkqAyrlDorC1uDwl2p3qZT7yl806vW7DvDoxwXi46jsjFbg+WdwotBIk6/MbEhO/dh5aZ5sNj/dWQ==",
+ "version": "2.1.27",
+ "resolved": "https://registry.npmjs.org/mime-types/-/mime-types-2.1.27.tgz",
+ "integrity": "sha512-JIhqnCasI9yD+SsmkquHBxTSEuZdQX5BuQnS2Vc7puQQQ+8yiP5AY5uWhpdv4YL4VM5c6iliiYWPgJ/nJQLp7w==",
"dev": true,
"requires": {
- "mime-db": "1.43.0"
+ "mime-db": "1.44.0"
}
},
"mimic-fn": {
@@ -3597,9 +3642,9 @@
}
},
"moment": {
- "version": "2.24.0",
- "resolved": "https://registry.npmjs.org/moment/-/moment-2.24.0.tgz",
- "integrity": "sha512-bV7f+6l2QigeBBZSM/6yTNq4P2fNpSWj/0e7jQcy87A8e7o2nAfP/34/2ky5Vw4B9S446EtIhodAzkFCcR4dQg==",
+ "version": "2.26.0",
+ "resolved": "https://registry.npmjs.org/moment/-/moment-2.26.0.tgz",
+ "integrity": "sha512-oIixUO+OamkUkwjhAVE18rAMfRJNsNe/Stid/gwHSOfHrOtw9EhAY2AHvdKZ/k/MggcYELFCJz/Sn2pL8b8JMw==",
"dev": true
},
"ms": {
@@ -3732,9 +3777,9 @@
"dev": true
},
"oav": {
- "version": "0.21.4",
- "resolved": "https://registry.npmjs.org/oav/-/oav-0.21.4.tgz",
- "integrity": "sha512-YRuL35ERnSU0cLKjw/MHxVALaDMzVD5Kbu68zoQhOXFPMGMytxofEGVbxis2Bv9Mja2l5wsAF2vfaAjnoEbT7w==",
+ "version": "0.21.6",
+ "resolved": "https://registry.npmjs.org/oav/-/oav-0.21.6.tgz",
+ "integrity": "sha512-zPLaeYuQh1aJND/e2BBLMXAy1qKvHVPido6byoC4K2wsM3MdIFrK0QePBMUXA9gZjNb6HO5oaRuM5uCEeFaxjg==",
"dev": true,
"requires": {
"@azure/openapi-markdown": "^0.9.2",
@@ -3830,9 +3875,9 @@
}
},
"@types/node-fetch": {
- "version": "2.5.6",
- "resolved": "https://registry.npmjs.org/@types/node-fetch/-/node-fetch-2.5.6.tgz",
- "integrity": "sha512-2w0NTwMWF1d3NJMK0Uiq2UNN8htVCyOWOD0jIPjPgC5Ph/YP4dVhs9YxxcMcuLuwAslz0dVEcZQUaqkLs3IzOQ==",
+ "version": "2.5.7",
+ "resolved": "https://registry.npmjs.org/@types/node-fetch/-/node-fetch-2.5.7.tgz",
+ "integrity": "sha512-o2WVNf5UhWRkxlf6eq+jMZDu7kjgpgJfl4xVNlvryc95O/6F2ld8ztKX+qu+Rjyet93WAWm5LjeX9H5FGkODvw==",
"dev": true,
"requires": {
"@types/node": "*",
@@ -4417,9 +4462,9 @@
"dev": true
},
"qs": {
- "version": "6.9.3",
- "resolved": "https://registry.npmjs.org/qs/-/qs-6.9.3.tgz",
- "integrity": "sha512-EbZYNarm6138UKKq46tdx08Yo/q9ZhFoAXAI1meAFd2GtbRDhbZY2WQSICskT0c5q99aFzLG1D4nvTk9tqfXIw==",
+ "version": "6.9.4",
+ "resolved": "https://registry.npmjs.org/qs/-/qs-6.9.4.tgz",
+ "integrity": "sha512-A1kFqHekCTM7cz0udomYUoYNWjBebHm/5wzU/XqrBRBNWectVH0QIiN+NEcZ0Dte5hvzHwbr8+XQmguPhJ6WdQ==",
"dev": true
},
"randexp": {
@@ -4618,9 +4663,9 @@
"dev": true
},
"resolve": {
- "version": "1.16.1",
- "resolved": "https://registry.npmjs.org/resolve/-/resolve-1.16.1.tgz",
- "integrity": "sha512-rmAglCSqWWMrrBv/XM6sW0NuRFiKViw/W4d9EbC4pt+49H8JwHy+mcGmALTEg504AUDcLTvb1T2q3E9AnmY+ig==",
+ "version": "1.17.0",
+ "resolved": "https://registry.npmjs.org/resolve/-/resolve-1.17.0.tgz",
+ "integrity": "sha512-ic+7JYiV8Vi2yzQGFWOkiZD5Z9z7O2Zhm9XMaTxdJExKasieFCr+yXZ/WmXsckHiKl12ar0y6XiXDx3m4RHn1w==",
"dev": true,
"requires": {
"path-parse": "^1.0.6"
@@ -4944,9 +4989,9 @@
"dev": true
},
"spdx-correct": {
- "version": "3.1.0",
- "resolved": "https://registry.npmjs.org/spdx-correct/-/spdx-correct-3.1.0.tgz",
- "integrity": "sha512-lr2EZCctC2BNR7j7WzJ2FpDznxky1sjfxvvYEyzxNyb6lZXHODmEoJeFu4JupYlkfha1KZpJyoqiJ7pgA1qq8Q==",
+ "version": "3.1.1",
+ "resolved": "https://registry.npmjs.org/spdx-correct/-/spdx-correct-3.1.1.tgz",
+ "integrity": "sha512-cOYcUWwhCuHCXi49RhFRCyJEK3iPj1Ziz9DpViV3tbZOwXD49QzIN3MpOLJNxh2qwq2lJJZaKMVw9qNi4jTC0w==",
"dev": true,
"requires": {
"spdx-expression-parse": "^3.0.0",
@@ -4954,15 +4999,15 @@
}
},
"spdx-exceptions": {
- "version": "2.2.0",
- "resolved": "https://registry.npmjs.org/spdx-exceptions/-/spdx-exceptions-2.2.0.tgz",
- "integrity": "sha512-2XQACfElKi9SlVb1CYadKDXvoajPgBVPn/gOQLrTvHdElaVhr7ZEbqJaRnJLVNeaI4cMEAgVCeBMKF6MWRDCRA==",
+ "version": "2.3.0",
+ "resolved": "https://registry.npmjs.org/spdx-exceptions/-/spdx-exceptions-2.3.0.tgz",
+ "integrity": "sha512-/tTrYOC7PPI1nUAgx34hUpqXuyJG+DTHJTnIULG4rDygi4xu/tfgmq1e1cIRwRzwZgo4NLySi+ricLkZkw4i5A==",
"dev": true
},
"spdx-expression-parse": {
- "version": "3.0.0",
- "resolved": "https://registry.npmjs.org/spdx-expression-parse/-/spdx-expression-parse-3.0.0.tgz",
- "integrity": "sha512-Yg6D3XpRD4kkOmTpdgbUiEJFKghJH03fiC1OPll5h/0sO6neh2jqRDVHOQ4o/LMea0tgCkbMgea5ip/e+MkWyg==",
+ "version": "3.0.1",
+ "resolved": "https://registry.npmjs.org/spdx-expression-parse/-/spdx-expression-parse-3.0.1.tgz",
+ "integrity": "sha512-cbqHunsQWnJNE6KhVSMsMeH5H/L9EpymbzqTQ3uLwNCLZ1Q481oWaofqH7nO6V07xlXwY6PhQdQ2IedWx/ZK4Q==",
"dev": true,
"requires": {
"spdx-exceptions": "^2.1.0",
@@ -5339,9 +5384,9 @@
"dev": true
},
"uglify-js": {
- "version": "3.9.1",
- "resolved": "https://registry.npmjs.org/uglify-js/-/uglify-js-3.9.1.tgz",
- "integrity": "sha512-JUPoL1jHsc9fOjVFHdQIhqEEJsQvfKDjlubcCilu8U26uZ73qOg8VsN8O1jbuei44ZPlwL7kmbAdM4tzaUvqnA==",
+ "version": "3.9.4",
+ "resolved": "https://registry.npmjs.org/uglify-js/-/uglify-js-3.9.4.tgz",
+ "integrity": "sha512-8RZBJq5smLOa7KslsNsVcSH+KOXf1uDU8yqLeNuVKwmT0T3FA0ZoXlinQfRad7SDcbZZRZE4ov+2v71EnxNyCA==",
"dev": true,
"optional": true,
"requires": {
@@ -5961,15 +6006,15 @@
}
},
"z-schema": {
- "version": "4.2.2",
- "resolved": "https://registry.npmjs.org/z-schema/-/z-schema-4.2.2.tgz",
- "integrity": "sha512-7bGR7LohxSdlK1EOdvA/OHksvKGE4jTLSjd8dBj9YKT0S43N9pdMZ0Z7GZt9mHrBFhbNTRh3Ky6Eu2MHsPJe8g==",
+ "version": "4.2.3",
+ "resolved": "https://registry.npmjs.org/z-schema/-/z-schema-4.2.3.tgz",
+ "integrity": "sha512-zkvK/9TC6p38IwcrbnT3ul9in1UX4cm1y/VZSs4GHKIiDCrlafc+YQBgQBUdDXLAoZHf2qvQ7gJJOo6yT1LH6A==",
"dev": true,
"requires": {
"commander": "^2.7.1",
"lodash.get": "^4.4.2",
"lodash.isequal": "^4.5.0",
- "validator": "^11.0.0"
+ "validator": "^12.0.0"
},
"dependencies": {
"commander": {
@@ -5980,9 +6025,9 @@
"optional": true
},
"validator": {
- "version": "11.1.0",
- "resolved": "https://registry.npmjs.org/validator/-/validator-11.1.0.tgz",
- "integrity": "sha512-qiQ5ktdO7CD6C/5/mYV4jku/7qnqzjrxb3C/Q5wR3vGGinHTgJZN/TdFT3ZX4vXhX2R1PXx42fB1cn5W+uJ4lg==",
+ "version": "12.2.0",
+ "resolved": "https://registry.npmjs.org/validator/-/validator-12.2.0.tgz",
+ "integrity": "sha512-jJfE/DW6tIK1Ek8nCfNFqt8Wb3nzMoAbocBF6/Icgg1ZFSBpObdnwVY2jQj6qUqzhx5jc71fpvBWyLGO7Xl+nQ==",
"dev": true
}
}
diff --git a/package.json b/package.json
index abb8b56d0892..1a58a6b4c14d 100644
--- a/package.json
+++ b/package.json
@@ -11,7 +11,7 @@
"license": "MIT",
"devDependencies": {
"@azure/avocado": "^0.6.3",
- "@azure/rest-api-specs-scripts": "^0.7.2",
+ "@azure/rest-api-specs-scripts": "^0.10.2",
"@ts-common/commonmark-to-markdown": "^1.2.0",
"@ts-common/fs": "0.2.0",
"@ts-common/iterator": "^0.3.6",
diff --git a/preproduction-azure-pipelines.yml b/preproduction-azure-pipelines.yml
index 0b307b098e70..56c9816bf51f 100644
--- a/preproduction-azure-pipelines.yml
+++ b/preproduction-azure-pipelines.yml
@@ -19,3 +19,4 @@ jobs:
- template: .azure-pipelines/BreakingChange.yml
- template: .azure-pipelines/ModelValidation.yml
- template: .azure-pipelines/LintDiff.yml
+ - template: .azure-pipelines/Avocado.yml
diff --git a/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2019-05-05-preview/AlertsManagement.json b/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2019-05-05-preview/AlertsManagement.json
index 11df28bec57b..750d45a37d73 100644
--- a/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2019-05-05-preview/AlertsManagement.json
+++ b/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2019-05-05-preview/AlertsManagement.json
@@ -1689,7 +1689,13 @@
"enum": [
"AlertCreated",
"StateChange",
- "MonitorConditionChange"
+ "MonitorConditionChange",
+ "SeverityChange",
+ "ActionRuleTriggered",
+ "ActionRuleSuppressed",
+ "ActionsTriggered",
+ "ActionsSuppressed",
+ "ActionsFailed"
],
"x-ms-enum": {
"name": "AlertModificationEvent"
@@ -2023,7 +2029,8 @@
"description": "type of target scope",
"enum": [
"ResourceGroup",
- "Resource"
+ "Resource",
+ "Subscription"
],
"x-ms-enum": {
"name": "ScopeType",
diff --git a/specification/alertsmanagement/resource-manager/readme.trenton.md b/specification/alertsmanagement/resource-manager/readme.trenton.md
new file mode 100644
index 000000000000..06e42501cc61
--- /dev/null
+++ b/specification/alertsmanagement/resource-manager/readme.trenton.md
@@ -0,0 +1,47 @@
+## overrides
+
+These settings apply only when `--trenton` is specified on the command line.
+``` yaml $(trenton)
+overrides:
+ - where:
+ resource: "*"
+ set:
+ - NeedSeparated: false
+ - where:
+ resource: "ActionRules"
+ property: "properties"
+ set:
+ - GoFieldName: "Properties"
+ - where:
+ resource: "ActionRules"
+ method: "Update"
+ property: "properties"
+ set:
+ - GoFieldName: "PatchProperties"
+ - where:
+ property: "type"
+ set:
+ - Hidden: true
+ - where:
+ resource: "ActionRules"
+ property: "/actionRule/properties/type"
+ set:
+ - Hidden: false
+ - where:
+ resource: "ActionRules"
+ property: "scopeType"
+ set:
+ - EnumValues/0/GoEnumMemberName: "ScopeTypeResourceGroup"
+ - EnumValues/1/GoEnumMemberName: "ScopeTypeResource"
+```
+## trenton
+
+These settings apply only when `--trenton` is specified on the command line.
+
+``` yaml $(trenton)
+trenton:
+ cli-name: alertsManagement
+ package-name: alertsmanagement
+clear-output-folder: true
+output-folder: $(trenton-output-folder)/alertsmanagement
+```
diff --git a/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/preview/2019-11-01-preview/appconfiguration.json b/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/preview/2019-11-01-preview/appconfiguration.json
index 875ac3226401..cd6accbe06d4 100644
--- a/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/preview/2019-11-01-preview/appconfiguration.json
+++ b/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/preview/2019-11-01-preview/appconfiguration.json
@@ -939,6 +939,26 @@
"encryption": {
"$ref": "#/definitions/EncryptionProperties",
"description": "The encryption settings of the configuration store."
+ },
+ "privateEndpointConnections": {
+ "description": "The list of private endpoint connections that are set up for this resource.",
+ "type": "array",
+ "readOnly": true,
+ "items": {
+ "$ref": "#/definitions/PrivateEndpointConnectionReference"
+ }
+ },
+ "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
+ }
}
}
},
@@ -952,6 +972,32 @@
}
}
},
+ "PrivateEndpointConnectionReference": {
+ "type": "object",
+ "description": "A reference to a related private endpoint connection.",
+ "properties": {
+ "id": {
+ "description": "The resource ID.",
+ "type": "string",
+ "readOnly": true
+ },
+ "name": {
+ "description": "The name of the resource.",
+ "type": "string",
+ "readOnly": true
+ },
+ "type": {
+ "description": "The type of the resource.",
+ "type": "string",
+ "readOnly": true
+ },
+ "properties": {
+ "$ref": "#/definitions/PrivateEndpointConnectionProperties",
+ "description": "The properties of a private endpoint connection.",
+ "x-ms-client-flatten": true
+ }
+ }
+ },
"KeyVaultProperties": {
"type": "object",
"description": "Settings concerning key vault encryption for a configuration store.",
@@ -1534,6 +1580,14 @@
"type": "string"
},
"readOnly": true
+ },
+ "requiredZoneNames": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "readOnly": true,
+ "description": "The list of required DNS zone names of the private link resource."
}
},
"description": "Properties of a private link resource."
diff --git a/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/preview/2019-11-01-preview/examples/ConfigurationStoresCreate.json b/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/preview/2019-11-01-preview/examples/ConfigurationStoresCreate.json
index e167cae4c1e2..6142fd1b97ec 100644
--- a/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/preview/2019-11-01-preview/examples/ConfigurationStoresCreate.json
+++ b/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/preview/2019-11-01-preview/examples/ConfigurationStoresCreate.json
@@ -27,7 +27,9 @@
"keyIdentifier": null,
"identityClientId": null
}
- }
+ },
+ "privateEndpointConnections": [],
+ "publicNetworkAccess": "Disabled"
},
"sku": {
"name": "Standard"
@@ -52,7 +54,9 @@
"keyIdentifier": null,
"identityClientId": null
}
- }
+ },
+ "privateEndpointConnections": [],
+ "publicNetworkAccess": "Disabled"
},
"sku": {
"name": "Standard"
diff --git a/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/preview/2019-11-01-preview/examples/ConfigurationStoresCreateWithIdentity.json b/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/preview/2019-11-01-preview/examples/ConfigurationStoresCreateWithIdentity.json
index 44fbe46621c5..ec154f9d56ca 100644
--- a/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/preview/2019-11-01-preview/examples/ConfigurationStoresCreateWithIdentity.json
+++ b/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/preview/2019-11-01-preview/examples/ConfigurationStoresCreateWithIdentity.json
@@ -33,7 +33,9 @@
"keyIdentifier": null,
"identityClientId": null
}
- }
+ },
+ "privateEndpointConnections": [],
+ "publicNetworkAccess": "Disabled"
},
"sku": {
"name": "Standard"
@@ -69,7 +71,9 @@
"keyIdentifier": null,
"identityClientId": null
}
- }
+ },
+ "privateEndpointConnections": [],
+ "publicNetworkAccess": "Disabled"
},
"sku": {
"name": "Standard"
diff --git a/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/preview/2019-11-01-preview/examples/ConfigurationStoresGet.json b/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/preview/2019-11-01-preview/examples/ConfigurationStoresGet.json
index cf2f127f1a63..db9634cafed4 100644
--- a/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/preview/2019-11-01-preview/examples/ConfigurationStoresGet.json
+++ b/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/preview/2019-11-01-preview/examples/ConfigurationStoresGet.json
@@ -18,7 +18,9 @@
"keyIdentifier": null,
"identityClientId": null
}
- }
+ },
+ "privateEndpointConnections": [],
+ "publicNetworkAccess": "Disabled"
},
"sku": {
"name": "Standard"
diff --git a/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/preview/2019-11-01-preview/examples/ConfigurationStoresList.json b/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/preview/2019-11-01-preview/examples/ConfigurationStoresList.json
index c445586d33c3..95cc3ac9e372 100644
--- a/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/preview/2019-11-01-preview/examples/ConfigurationStoresList.json
+++ b/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/preview/2019-11-01-preview/examples/ConfigurationStoresList.json
@@ -18,7 +18,9 @@
"keyIdentifier": null,
"identityClientId": null
}
- }
+ },
+ "privateEndpointConnections": [],
+ "publicNetworkAccess": "Disabled"
},
"sku": {
"name": "Standard"
@@ -44,7 +46,9 @@
"keyIdentifier": null,
"identityClientId": null
}
- }
+ },
+ "privateEndpointConnections": [],
+ "publicNetworkAccess": "Disabled"
},
"sku": {
"name": "Standard"
diff --git a/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/preview/2019-11-01-preview/examples/ConfigurationStoresListByResourceGroup.json b/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/preview/2019-11-01-preview/examples/ConfigurationStoresListByResourceGroup.json
index cfb5b11382be..09d4d871b8d5 100644
--- a/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/preview/2019-11-01-preview/examples/ConfigurationStoresListByResourceGroup.json
+++ b/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/preview/2019-11-01-preview/examples/ConfigurationStoresListByResourceGroup.json
@@ -19,7 +19,9 @@
"keyIdentifier": null,
"identityClientId": null
}
- }
+ },
+ "privateEndpointConnections": [],
+ "publicNetworkAccess": "Disabled"
},
"sku": {
"name": "Standard"
@@ -40,7 +42,9 @@
"keyIdentifier": null,
"identityClientId": null
}
- }
+ },
+ "privateEndpointConnections": [],
+ "publicNetworkAccess": "Disabled"
},
"sku": {
"name": "Standard"
diff --git a/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/preview/2019-11-01-preview/examples/ConfigurationStoresUpdate.json b/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/preview/2019-11-01-preview/examples/ConfigurationStoresUpdate.json
index dd945689d19d..f9a284969e5b 100644
--- a/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/preview/2019-11-01-preview/examples/ConfigurationStoresUpdate.json
+++ b/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/preview/2019-11-01-preview/examples/ConfigurationStoresUpdate.json
@@ -26,7 +26,9 @@
"keyIdentifier": null,
"identityClientId": null
}
- }
+ },
+ "privateEndpointConnections": [],
+ "publicNetworkAccess": "Disabled"
},
"sku": {
"name": "Standard"
@@ -51,7 +53,9 @@
"keyIdentifier": null,
"identityClientId": null
}
- }
+ },
+ "privateEndpointConnections": [],
+ "publicNetworkAccess": "Disabled"
},
"sku": {
"name": "Standard"
diff --git a/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/preview/2019-11-01-preview/examples/ConfigurationStoresUpdateWithIdentity.json b/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/preview/2019-11-01-preview/examples/ConfigurationStoresUpdateWithIdentity.json
index 5ef16d741c7d..56fd7887c47c 100644
--- a/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/preview/2019-11-01-preview/examples/ConfigurationStoresUpdateWithIdentity.json
+++ b/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/preview/2019-11-01-preview/examples/ConfigurationStoresUpdateWithIdentity.json
@@ -32,7 +32,9 @@
"keyIdentifier": null,
"identityClientId": null
}
- }
+ },
+ "privateEndpointConnections": [],
+ "publicNetworkAccess": "Disabled"
},
"sku": {
"name": "Standard"
@@ -68,7 +70,9 @@
"keyIdentifier": null,
"identityClientId": null
}
- }
+ },
+ "privateEndpointConnections": [],
+ "publicNetworkAccess": "Disabled"
},
"sku": {
"name": "Standard"
diff --git a/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/preview/2019-11-01-preview/examples/PrivateLinkResourceGet.json b/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/preview/2019-11-01-preview/examples/PrivateLinkResourceGet.json
index 0f52593d85c9..bcfc29a23b24 100644
--- a/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/preview/2019-11-01-preview/examples/PrivateLinkResourceGet.json
+++ b/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/preview/2019-11-01-preview/examples/PrivateLinkResourceGet.json
@@ -16,6 +16,9 @@
"groupId": "configurationStores",
"requiredMembers": [
"configurationStores"
+ ],
+ "requiredZoneNames": [
+ "privatelink.azconfig.io"
]
}
}
diff --git a/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/preview/2019-11-01-preview/examples/PrivateLinkResourcesListByConfigurationStore.json b/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/preview/2019-11-01-preview/examples/PrivateLinkResourcesListByConfigurationStore.json
index e652e2399b97..4cad287f7123 100644
--- a/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/preview/2019-11-01-preview/examples/PrivateLinkResourcesListByConfigurationStore.json
+++ b/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/preview/2019-11-01-preview/examples/PrivateLinkResourcesListByConfigurationStore.json
@@ -17,6 +17,9 @@
"groupId": "configurationStores",
"requiredMembers": [
"configurationStores"
+ ],
+ "requiredZoneNames": [
+ "privatelink.azconfig.io"
]
}
}
diff --git a/specification/appconfiguration/resource-manager/readme.md b/specification/appconfiguration/resource-manager/readme.md
index de29d229eefa..feac2e4b88ce 100644
--- a/specification/appconfiguration/resource-manager/readme.md
+++ b/specification/appconfiguration/resource-manager/readme.md
@@ -68,6 +68,7 @@ This is not used by Autorest itself.
``` yaml $(swagger-to-sdk)
swagger-to-sdk:
- repo: azure-sdk-for-python
+ - repo: azure-sdk-for-python-track2
- repo: azure-sdk-for-java
- repo: azure-sdk-for-net
- repo: azure-sdk-for-js
diff --git a/specification/applicationinsights/data-plane/Microsoft.Insights/preview/2018-04-20/swagger.json b/specification/applicationinsights/data-plane/Microsoft.Insights/preview/2018-04-20/swagger.json
index 40df5f1ff2d4..1c49f1b2f3ec 100644
--- a/specification/applicationinsights/data-plane/Microsoft.Insights/preview/2018-04-20/swagger.json
+++ b/specification/applicationinsights/data-plane/Microsoft.Insights/preview/2018-04-20/swagger.json
@@ -133,7 +133,7 @@
},
"/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Insights/components/{applicationName}/metadata": {
"post": {
- "operationId": "Post_Metadata",
+ "operationId": "Metadata_Post",
"summary": "Gets metadata information",
"description": "Retrieve the metadata information for the app, including its schema, etc.",
"x-ms-examples": {
@@ -171,7 +171,7 @@
}
},
"get": {
- "operationId": "Get_Metadata",
+ "operationId": "Metadata_Get",
"summary": "Gets metadata information",
"description": "Retrieve the metadata information for the app, including its schema, etc.",
"x-ms-examples": {
@@ -1212,6 +1212,9 @@
"additionalProperties": {
"type": "object"
}
+ },
+ "additionalProperties": {
+ "type": "object"
}
},
"customMeasurements": {
@@ -1221,6 +1224,9 @@
"additionalProperties": {
"type": "object"
}
+ },
+ "additionalProperties": {
+ "type": "object"
}
},
"operation": {
diff --git a/specification/applicationinsights/data-plane/Microsoft.Insights/preview/v1/AppInsights.json b/specification/applicationinsights/data-plane/Microsoft.Insights/preview/v1/AppInsights.json
index f6ebd4cb640c..506c07d7005c 100644
--- a/specification/applicationinsights/data-plane/Microsoft.Insights/preview/v1/AppInsights.json
+++ b/specification/applicationinsights/data-plane/Microsoft.Insights/preview/v1/AppInsights.json
@@ -380,7 +380,7 @@
},
"/apps/{appId}/metadata": {
"post": {
- "operationId": "Post_Metadata",
+ "operationId": "Metadata_Post",
"summary": "Gets metadata information",
"description": "Retrieve the metadata information for the app, including its schema, etc.",
"x-ms-examples": {
@@ -409,7 +409,7 @@
}
},
"get": {
- "operationId": "Get_Metadata",
+ "operationId": "Metadata_Get",
"summary": "Gets metadata information",
"description": "Retrieve the metadata information for the app, including its schema, etc.",
"x-ms-examples": {
@@ -1139,6 +1139,9 @@
"additionalProperties": {
"type": "object"
}
+ },
+ "additionalProperties": {
+ "type": "object"
}
},
"customMeasurements": {
@@ -1148,6 +1151,9 @@
"additionalProperties": {
"type": "object"
}
+ },
+ "additionalProperties": {
+ "type": "object"
}
},
"operation": {
diff --git a/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2018-05-01/componentProactiveDetection_API.json b/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2018-05-01-preview/componentProactiveDetection_API.json
similarity index 100%
rename from specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2018-05-01/componentProactiveDetection_API.json
rename to specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2018-05-01-preview/componentProactiveDetection_API.json
diff --git a/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2018-05-01/components_API.json b/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2018-05-01-preview/components_API.json
similarity index 98%
rename from specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2018-05-01/components_API.json
rename to specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2018-05-01-preview/components_API.json
index fc10d313cfce..8ba066afb183 100644
--- a/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2018-05-01/components_API.json
+++ b/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2018-05-01-preview/components_API.json
@@ -532,6 +532,20 @@
"publicNetworkAccessForQuery": {
"description": "The network access type for accessing Application Insights query.",
"$ref": "#/definitions/PublicNetworkAccessType"
+ },
+ "IngestionMode": {
+ "type": "string",
+ "description": "Indicates the flow of the ingestion.",
+ "default": "ApplicationInsights",
+ "enum": [
+ "ApplicationInsights",
+ "ApplicationInsightsWithDiagnosticSettings",
+ "LogAnalytics"
+ ],
+ "x-ms-enum": {
+ "name": "IngestionMode",
+ "modelAsString": true
+ }
}
},
"required": [
diff --git a/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2018-05-01/examples/ComponentsCreate.json b/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2018-05-01-preview/examples/ComponentsCreate.json
similarity index 92%
rename from specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2018-05-01/examples/ComponentsCreate.json
rename to specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2018-05-01-preview/examples/ComponentsCreate.json
index 17a28fdee20e..70a74516f4e0 100644
--- a/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2018-05-01/examples/ComponentsCreate.json
+++ b/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2018-05-01-preview/examples/ComponentsCreate.json
@@ -41,7 +41,8 @@
"DisableIpMasking": false,
"ImmediatePurgeDataOn30Days": false,
"publicNetworkAccessForQuery": "Enabled",
- "publicNetworkAccessForIngestion": "Enabled"
+ "publicNetworkAccessForIngestion": "Enabled",
+ "IngestionMode": "ApplicationInsights"
}
}
},
@@ -71,7 +72,8 @@
"DisableIpMasking": false,
"ImmediatePurgeDataOn30Days": false,
"publicNetworkAccessForQuery": "Enabled",
- "publicNetworkAccessForIngestion": "Enabled"
+ "publicNetworkAccessForIngestion": "Enabled",
+ "IngestionMode": "ApplicationInsights"
}
}
}
diff --git a/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2018-05-01/examples/ComponentsDelete.json b/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2018-05-01-preview/examples/ComponentsDelete.json
similarity index 100%
rename from specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2018-05-01/examples/ComponentsDelete.json
rename to specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2018-05-01-preview/examples/ComponentsDelete.json
diff --git a/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2018-05-01/examples/ComponentsGet.json b/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2018-05-01-preview/examples/ComponentsGet.json
similarity index 92%
rename from specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2018-05-01/examples/ComponentsGet.json
rename to specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2018-05-01-preview/examples/ComponentsGet.json
index 3ace22b9672d..68d5f62719a7 100644
--- a/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2018-05-01/examples/ComponentsGet.json
+++ b/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2018-05-01-preview/examples/ComponentsGet.json
@@ -32,7 +32,8 @@
"DisableIpMasking": false,
"ImmediatePurgeDataOn30Days": false,
"publicNetworkAccessForQuery": "Enabled",
- "publicNetworkAccessForIngestion": "Enabled"
+ "publicNetworkAccessForIngestion": "Enabled",
+ "IngestionMode": "ApplicationInsights"
}
}
}
diff --git a/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2018-05-01/examples/ComponentsList.json b/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2018-05-01-preview/examples/ComponentsList.json
similarity index 92%
rename from specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2018-05-01/examples/ComponentsList.json
rename to specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2018-05-01-preview/examples/ComponentsList.json
index 281a057d8188..d9790161b4a4 100644
--- a/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2018-05-01/examples/ComponentsList.json
+++ b/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2018-05-01-preview/examples/ComponentsList.json
@@ -32,7 +32,8 @@
"DisableIpMasking": false,
"ImmediatePurgeDataOn30Days": false,
"publicNetworkAccessForQuery": "Enabled",
- "publicNetworkAccessForIngestion": "Enabled"
+ "publicNetworkAccessForIngestion": "Enabled",
+ "IngestionMode": "ApplicationInsights"
}
},
{
@@ -60,7 +61,8 @@
"DisableIpMasking": false,
"ImmediatePurgeDataOn30Days": false,
"publicNetworkAccessForQuery": "Enabled",
- "publicNetworkAccessForIngestion": "Enabled"
+ "publicNetworkAccessForIngestion": "Enabled",
+ "IngestionMode": "ApplicationInsights"
}
}
],
diff --git a/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2018-05-01/examples/ComponentsListByResourceGroup.json b/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2018-05-01-preview/examples/ComponentsListByResourceGroup.json
similarity index 92%
rename from specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2018-05-01/examples/ComponentsListByResourceGroup.json
rename to specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2018-05-01-preview/examples/ComponentsListByResourceGroup.json
index cee24e3764c9..8a34e64eb8a2 100644
--- a/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2018-05-01/examples/ComponentsListByResourceGroup.json
+++ b/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2018-05-01-preview/examples/ComponentsListByResourceGroup.json
@@ -33,7 +33,8 @@
"DisableIpMasking": false,
"ImmediatePurgeDataOn30Days": false,
"publicNetworkAccessForQuery": "Enabled",
- "publicNetworkAccessForIngestion": "Enabled"
+ "publicNetworkAccessForIngestion": "Enabled",
+ "IngestionMode": "ApplicationInsights"
}
},
{
@@ -61,7 +62,8 @@
"DisableIpMasking": false,
"ImmediatePurgeDataOn30Days": false,
"publicNetworkAccessForQuery": "Enabled",
- "publicNetworkAccessForIngestion": "Enabled"
+ "publicNetworkAccessForIngestion": "Enabled",
+ "IngestionMode": "ApplicationInsights"
}
}
],
diff --git a/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2018-05-01/examples/ComponentsPurge.json b/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2018-05-01-preview/examples/ComponentsPurge.json
similarity index 100%
rename from specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2018-05-01/examples/ComponentsPurge.json
rename to specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2018-05-01-preview/examples/ComponentsPurge.json
diff --git a/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2018-05-01/examples/ComponentsPurgeStatus.json b/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2018-05-01-preview/examples/ComponentsPurgeStatus.json
similarity index 100%
rename from specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2018-05-01/examples/ComponentsPurgeStatus.json
rename to specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2018-05-01-preview/examples/ComponentsPurgeStatus.json
diff --git a/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2018-05-01/examples/ComponentsUpdate.json b/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2018-05-01-preview/examples/ComponentsUpdate.json
similarity index 93%
rename from specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2018-05-01/examples/ComponentsUpdate.json
rename to specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2018-05-01-preview/examples/ComponentsUpdate.json
index b9df659a3d3f..30c8ce16a5e9 100644
--- a/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2018-05-01/examples/ComponentsUpdate.json
+++ b/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2018-05-01-preview/examples/ComponentsUpdate.json
@@ -43,7 +43,8 @@
"DisableIpMasking": false,
"ImmediatePurgeDataOn30Days": false,
"publicNetworkAccessForQuery": "Enabled",
- "publicNetworkAccessForIngestion": "Enabled"
+ "publicNetworkAccessForIngestion": "Enabled",
+ "IngestionMode": "ApplicationInsights"
}
}
},
@@ -76,7 +77,8 @@
"DisableIpMasking": false,
"ImmediatePurgeDataOn30Days": false,
"publicNetworkAccessForQuery": "Enabled",
- "publicNetworkAccessForIngestion": "Enabled"
+ "publicNetworkAccessForIngestion": "Enabled",
+ "IngestionMode": "ApplicationInsights"
}
}
}
diff --git a/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2018-05-01/examples/ComponentsUpdateTagsOnly.json b/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2018-05-01-preview/examples/ComponentsUpdateTagsOnly.json
similarity index 94%
rename from specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2018-05-01/examples/ComponentsUpdateTagsOnly.json
rename to specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2018-05-01-preview/examples/ComponentsUpdateTagsOnly.json
index 9d8d07877055..911c023ab0a9 100644
--- a/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2018-05-01/examples/ComponentsUpdateTagsOnly.json
+++ b/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2018-05-01-preview/examples/ComponentsUpdateTagsOnly.json
@@ -47,7 +47,8 @@
"DisableIpMasking": false,
"ImmediatePurgeDataOn30Days": false,
"publicNetworkAccessForQuery": "Enabled",
- "publicNetworkAccessForIngestion": "Enabled"
+ "publicNetworkAccessForIngestion": "Enabled",
+ "IngestionMode": "ApplicationInsights"
}
}
},
@@ -83,7 +84,8 @@
"DisableIpMasking": false,
"ImmediatePurgeDataOn30Days": false,
"publicNetworkAccessForQuery": "Enabled",
- "publicNetworkAccessForIngestion": "Enabled"
+ "publicNetworkAccessForIngestion": "Enabled",
+ "IngestionMode": "ApplicationInsights"
}
}
}
diff --git a/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2018-05-01/examples/ProactiveDetectionConfigurationGet.json b/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2018-05-01-preview/examples/ProactiveDetectionConfigurationGet.json
similarity index 100%
rename from specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2018-05-01/examples/ProactiveDetectionConfigurationGet.json
rename to specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2018-05-01-preview/examples/ProactiveDetectionConfigurationGet.json
diff --git a/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2018-05-01/examples/ProactiveDetectionConfigurationUpdate.json b/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2018-05-01-preview/examples/ProactiveDetectionConfigurationUpdate.json
similarity index 100%
rename from specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2018-05-01/examples/ProactiveDetectionConfigurationUpdate.json
rename to specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2018-05-01-preview/examples/ProactiveDetectionConfigurationUpdate.json
diff --git a/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2018-05-01/examples/ProactiveDetectionConfigurationsList.json b/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2018-05-01-preview/examples/ProactiveDetectionConfigurationsList.json
similarity index 100%
rename from specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2018-05-01/examples/ProactiveDetectionConfigurationsList.json
rename to specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2018-05-01-preview/examples/ProactiveDetectionConfigurationsList.json
diff --git a/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2020-02-02-preview/components_API.json b/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2020-02-02-preview/components_API.json
index 71cb6350a36c..c8606af89280 100644
--- a/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2020-02-02-preview/components_API.json
+++ b/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2020-02-02-preview/components_API.json
@@ -524,6 +524,20 @@
"publicNetworkAccessForQuery": {
"description": "The network access type for accessing Application Insights query.",
"$ref": "#/definitions/PublicNetworkAccessType"
+ },
+ "IngestionMode": {
+ "type": "string",
+ "description": "Indicates the flow of the ingestion.",
+ "default": "LogAnalytics",
+ "enum": [
+ "ApplicationInsights",
+ "ApplicationInsightsWithDiagnosticSettings",
+ "LogAnalytics"
+ ],
+ "x-ms-enum": {
+ "name": "IngestionMode",
+ "modelAsString": true
+ }
}
},
"required": [
diff --git a/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2020-02-02-preview/examples/ComponentsCreate.json b/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2020-02-02-preview/examples/ComponentsCreate.json
index b60e0da5861a..fbc47f63d6ab 100644
--- a/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2020-02-02-preview/examples/ComponentsCreate.json
+++ b/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2020-02-02-preview/examples/ComponentsCreate.json
@@ -41,7 +41,8 @@
"ConnectionString": "InstrumentationKey=bc095013-3cf2-45ac-ab47-123456789abc",
"DisableIpMasking": false,
"publicNetworkAccessForQuery": "Enabled",
- "publicNetworkAccessForIngestion": "Enabled"
+ "publicNetworkAccessForIngestion": "Enabled",
+ "IngestionMode": "LogAnalytics"
}
}
}
diff --git a/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2020-02-02-preview/examples/ComponentsGet.json b/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2020-02-02-preview/examples/ComponentsGet.json
index 8dc5e137725f..bbb10c0b9ceb 100644
--- a/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2020-02-02-preview/examples/ComponentsGet.json
+++ b/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2020-02-02-preview/examples/ComponentsGet.json
@@ -31,7 +31,8 @@
"ConnectionString": "InstrumentationKey=bc095013-3cf2-45ac-ab47-123456789abc",
"DisableIpMasking": false,
"publicNetworkAccessForQuery": "Enabled",
- "publicNetworkAccessForIngestion": "Enabled"
+ "publicNetworkAccessForIngestion": "Enabled",
+ "IngestionMode": "LogAnalytics"
}
}
}
diff --git a/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2020-02-02-preview/examples/ComponentsList.json b/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2020-02-02-preview/examples/ComponentsList.json
index 1a0e3d80e2eb..e1b8fef73125 100644
--- a/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2020-02-02-preview/examples/ComponentsList.json
+++ b/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2020-02-02-preview/examples/ComponentsList.json
@@ -31,7 +31,8 @@
"ConnectionString": "InstrumentationKey=dc5931c7-a7ad-4ad0-89d6-123456789abc",
"DisableIpMasking": false,
"publicNetworkAccessForQuery": "Enabled",
- "publicNetworkAccessForIngestion": "Enabled"
+ "publicNetworkAccessForIngestion": "Enabled",
+ "IngestionMode": "LogAnalytics"
}
},
{
@@ -58,7 +59,8 @@
"ConnectionString": "InstrumentationKey=bc095013-3cf2-45ac-ab47-123456789abc",
"DisableIpMasking": false,
"publicNetworkAccessForQuery": "Enabled",
- "publicNetworkAccessForIngestion": "Enabled"
+ "publicNetworkAccessForIngestion": "Enabled",
+ "IngestionMode": "LogAnalytics"
}
}
],
diff --git a/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2020-02-02-preview/examples/ComponentsListByResourceGroup.json b/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2020-02-02-preview/examples/ComponentsListByResourceGroup.json
index 93423a2b9955..26738b90bc39 100644
--- a/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2020-02-02-preview/examples/ComponentsListByResourceGroup.json
+++ b/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2020-02-02-preview/examples/ComponentsListByResourceGroup.json
@@ -32,7 +32,8 @@
"ConnectionString": "InstrumentationKey=dc5931c7-a7ad-4ad0-89d6-123456789abc",
"DisableIpMasking": false,
"publicNetworkAccessForQuery": "Enabled",
- "publicNetworkAccessForIngestion": "Enabled"
+ "publicNetworkAccessForIngestion": "Enabled",
+ "IngestionMode": "LogAnalytics"
}
},
{
@@ -59,7 +60,8 @@
"ConnectionString": "InstrumentationKey=bc095013-3cf2-45ac-ab47-123456789abc",
"DisableIpMasking": false,
"publicNetworkAccessForQuery": "Enabled",
- "publicNetworkAccessForIngestion": "Enabled"
+ "publicNetworkAccessForIngestion": "Enabled",
+ "IngestionMode": "LogAnalytics"
}
}
],
diff --git a/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2020-02-02-preview/examples/ComponentsUpdate.json b/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2020-02-02-preview/examples/ComponentsUpdate.json
index e02186407ca7..bb68a86b7bfb 100644
--- a/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2020-02-02-preview/examples/ComponentsUpdate.json
+++ b/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2020-02-02-preview/examples/ComponentsUpdate.json
@@ -42,7 +42,8 @@
"ConnectionString": "InstrumentationKey=bc095013-3cf2-45ac-ab47-123456789abc",
"DisableIpMasking": false,
"publicNetworkAccessForQuery": "Enabled",
- "publicNetworkAccessForIngestion": "Enabled"
+ "publicNetworkAccessForIngestion": "Enabled",
+ "IngestionMode": "LogAnalytics"
}
}
}
diff --git a/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2020-02-02-preview/examples/ComponentsUpdateTagsOnly.json b/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2020-02-02-preview/examples/ComponentsUpdateTagsOnly.json
index 806476c3cf96..7ca0781617d0 100644
--- a/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2020-02-02-preview/examples/ComponentsUpdateTagsOnly.json
+++ b/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2020-02-02-preview/examples/ComponentsUpdateTagsOnly.json
@@ -46,7 +46,8 @@
"ConnectionString": "InstrumentationKey=bc095013-3cf2-45ac-ab47-123456789abc",
"DisableIpMasking": false,
"publicNetworkAccessForQuery": "Enabled",
- "publicNetworkAccessForIngestion": "Enabled"
+ "publicNetworkAccessForIngestion": "Enabled",
+ "IngestionMode": "LogAnalytics"
}
}
}
diff --git a/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2020-02-10-preview/WebTestResults_API.json b/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2020-02-10-preview/WebTestResults_API.json
new file mode 100644
index 000000000000..7bcea7f72ba3
--- /dev/null
+++ b/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2020-02-10-preview/WebTestResults_API.json
@@ -0,0 +1,294 @@
+{
+ "swagger": "2.0",
+ "info": {
+ "title": "ApplicationInsightsManagementClient",
+ "description": "Azure Application Insights client for web test results.",
+ "version": "2020-02-10-preview"
+ },
+ "host": "management.azure.com",
+ "schemes": [
+ "https"
+ ],
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "security": [
+ {
+ "azure_auth": [
+ "user_impersonation"
+ ]
+ }
+ ],
+ "securityDefinitions": {
+ "azure_auth": {
+ "type": "oauth2",
+ "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize",
+ "flow": "implicit",
+ "description": "Azure Active Directory OAuth2 Flow",
+ "scopes": {
+ "user_impersonation": "impersonate your user account"
+ }
+ }
+ },
+ "paths": {
+ "/providers/microsoft.insights/operations": {
+ "get": {
+ "tags": [
+ "Operations"
+ ],
+ "summary": "List available operations.",
+ "description": "List the available operations supported by the Microsoft.EventGrid resource provider.",
+ "operationId": "Operations_List",
+ "consumes": [],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/OperationsListResult"
+ }
+ },
+ "default": {
+ "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error."
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-examples": {
+ "Operations_List": {
+ "$ref": "./examples/Operations_List.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/microsoft.insights/webtests/{webTestName}/getTestResultFile": {
+ "post": {
+ "tags": [
+ "WebTests_GetTestResultFile"
+ ],
+ "operationId": "getTestResultFile",
+ "description": "Returns a file test result for the matching test",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/WebTestNameParameter"
+ },
+ {
+ "$ref": "#/parameters/GeolocationIdParameter"
+ },
+ {
+ "$ref": "#/parameters/TimeStampParameter"
+ },
+ {
+ "$ref": "#/parameters/DownloadAsParameter"
+ },
+ {
+ "$ref": "#/parameters/TestSuccessfulCriteriaParameter"
+ },
+ {
+ "$ref": "#/parameters/ContinuationTokenParameter"
+ }
+ ],
+ "responses": {
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ },
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/TestResultFileResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Example Get call:": {
+ "$ref": "./examples/WebTestResultsTestResultFile.json"
+ }
+ }
+ }
+ }
+ },
+ "definitions": {
+ "ErrorResponse": {
+ "description": "Describes the format of Error response.",
+ "type": "object",
+ "properties": {
+ "code": {
+ "description": "Error code",
+ "type": "string"
+ },
+ "message": {
+ "description": "Error message indicating why the operation failed.",
+ "type": "string"
+ }
+ }
+ },
+ "TestResultFileResponse": {
+ "description": "Test result.",
+ "type": "object",
+ "properties": {
+ "data": {
+ "description": "File contents.",
+ "type": "string"
+ },
+ "nextLink": {
+ "description": "The URI that can be used to request the next section of the result file in the event the file is too large for a single request.",
+ "type": "string"
+ }
+ }
+ },
+ "OperationsListResult": {
+ "description": "Result of the List Operations operation",
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "A collection of operations",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/Operation"
+ }
+ },
+ "nextLink": {
+ "type": "string",
+ "description": "URL to get the next set of operation list results if there are any."
+ }
+ }
+ },
+ "Operation": {
+ "description": "Represents an operation returned by the GetOperations request",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "Name of the operation",
+ "type": "string"
+ },
+ "display": {
+ "$ref": "#/definitions/OperationInfo",
+ "description": "Display name of the operation"
+ },
+ "origin": {
+ "description": "Origin of the operation",
+ "type": "string"
+ },
+ "properties": {
+ "description": "Properties of the operation",
+ "type": "object",
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "OperationInfo": {
+ "description": "Information about an operation",
+ "type": "object",
+ "properties": {
+ "provider": {
+ "description": "Name of the provider",
+ "type": "string"
+ },
+ "resource": {
+ "description": "Name of the resource type",
+ "type": "string"
+ },
+ "operation": {
+ "description": "Name of the operation",
+ "type": "string"
+ },
+ "description": {
+ "description": "Description of the operation",
+ "type": "string"
+ }
+ }
+ }
+ },
+ "parameters": {
+ "WebTestNameParameter": {
+ "name": "webTestName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the Application Insights webtest resource.",
+ "x-ms-parameter-location": "method"
+ },
+ "GeolocationIdParameter": {
+ "name": "geoLocationId",
+ "in": "query",
+ "required": true,
+ "type": "string",
+ "description": "The location ID where the webtest was physically run.",
+ "x-ms-parameter-location": "method"
+ },
+ "TimeStampParameter": {
+ "name": "timeStamp",
+ "in": "query",
+ "required": true,
+ "type": "integer",
+ "format": "int64",
+ "description": "The posix (epoch) time stamp for the webtest result.",
+ "x-ms-parameter-location": "method"
+ },
+ "DownloadAsParameter": {
+ "name": "downloadAs",
+ "in": "query",
+ "required": true,
+ "type": "string",
+ "enum": [
+ "WebTestResult",
+ "Json"
+ ],
+ "x-ms-enum": {
+ "name": "downloadAs",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "WebTestResult",
+ "description": "Returned file will be in visual studio webtestresult file format."
+ },
+ {
+ "value": "Json",
+ "description": "Returned file will be in json file format."
+ }
+ ]
+ },
+ "description": "The format to use when returning the webtest result.",
+ "x-ms-parameter-location": "method"
+ },
+ "TestSuccessfulCriteriaParameter": {
+ "name": "testSuccessfulCriteria",
+ "in": "query",
+ "required": false,
+ "type": "boolean",
+ "description": "The success state criteria for the webtest result.",
+ "x-ms-parameter-location": "method"
+ },
+ "ContinuationTokenParameter": {
+ "name": "continuationToken",
+ "in": "query",
+ "required": false,
+ "type": "string",
+ "description": "The continuation token.",
+ "x-ms-parameter-location": "method"
+ }
+ }
+}
diff --git a/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2020-02-10-preview/examples/Operations_List.json b/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2020-02-10-preview/examples/Operations_List.json
new file mode 100644
index 000000000000..583aa46d8850
--- /dev/null
+++ b/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2020-02-10-preview/examples/Operations_List.json
@@ -0,0 +1,23 @@
+{
+ "parameters": {
+ "api-version": "2020-02-10-preview"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "name": "microsoft.insights/webtests/gettestresultfile",
+ "display": {
+ "provider": "Microsoft Container Instance",
+ "resource": "webtests",
+ "operation": "Get test results file",
+ "description": "Get the requested webtest result"
+ },
+ "origin": "User"
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2020-02-10-preview/examples/WebTestResultsTestResultFile.json b/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2020-02-10-preview/examples/WebTestResultsTestResultFile.json
new file mode 100644
index 000000000000..31dc3c9e7a99
--- /dev/null
+++ b/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2020-02-10-preview/examples/WebTestResultsTestResultFile.json
@@ -0,0 +1,21 @@
+{
+ "parameters": {
+ "api-version": "2020-02-10-preview",
+ "subscriptionId": "123subid",
+ "resourceGroupName": "myresourcegroup",
+ "webTestName": "my-test-name",
+ "geoLocationId": "brs",
+ "timeStamp": 1566819054,
+ "downloadAs": "WebTestResult",
+ "testSuccessfulCriteria": true,
+ "continuationToken": "0"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "data": "xxxxxxxxxx",
+ "nextLink": "https://management.azure.com/subscriptions/123subid/resourcegroups/myresourcegroup/providers/microsoft.insights/webtests/my-test-name/testresultfile?geoLocationId=brs×tamp=1566823240&downloadAs=webtestresult&testSuccessfulCriteria=true&continuationToken=10&api-version=2020-10-01-preview"
+ }
+ }
+ }
+}
diff --git a/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2015-05-01/components_API.json b/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2015-05-01/components_API.json
index 507d3910d1b1..73eb9e993907 100644
--- a/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2015-05-01/components_API.json
+++ b/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2015-05-01/components_API.json
@@ -512,6 +512,20 @@
"$ref": "#/definitions/PrivateLinkScopedResource"
},
"description": "List of linked private link scope resources."
+ },
+ "IngestionMode": {
+ "type": "string",
+ "description": "Indicates the flow of the ingestion.",
+ "default": "ApplicationInsights",
+ "enum": [
+ "ApplicationInsights",
+ "ApplicationInsightsWithDiagnosticSettings",
+ "LogAnalytics"
+ ],
+ "x-ms-enum": {
+ "name": "IngestionMode",
+ "modelAsString": true
+ }
}
},
"required": [
diff --git a/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2015-05-01/examples/ComponentsCreate.json b/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2015-05-01/examples/ComponentsCreate.json
index a2603e240382..88bcfebb39ce 100644
--- a/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2015-05-01/examples/ComponentsCreate.json
+++ b/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2015-05-01/examples/ComponentsCreate.json
@@ -39,7 +39,8 @@
"RetentionInDays": 90,
"ConnectionString": "InstrumentationKey=bc095013-3cf2-45ac-ab47-123456789abc",
"DisableIpMasking": false,
- "ImmediatePurgeDataOn30Days": false
+ "ImmediatePurgeDataOn30Days": false,
+ "IngestionMode": "ApplicationInsights"
}
}
}
diff --git a/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2015-05-01/examples/ComponentsGet.json b/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2015-05-01/examples/ComponentsGet.json
index ea7eb18ea7d0..c00693fd1988 100644
--- a/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2015-05-01/examples/ComponentsGet.json
+++ b/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2015-05-01/examples/ComponentsGet.json
@@ -30,7 +30,8 @@
"RetentionInDays": 90,
"ConnectionString": "InstrumentationKey=bc095013-3cf2-45ac-ab47-123456789abc",
"DisableIpMasking": false,
- "ImmediatePurgeDataOn30Days": false
+ "ImmediatePurgeDataOn30Days": false,
+ "IngestionMode": "ApplicationInsights"
}
}
}
diff --git a/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2015-05-01/examples/ComponentsList.json b/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2015-05-01/examples/ComponentsList.json
index ccb105e6cac0..3b8fbf90a8ee 100644
--- a/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2015-05-01/examples/ComponentsList.json
+++ b/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2015-05-01/examples/ComponentsList.json
@@ -30,7 +30,8 @@
"RetentionInDays": 90,
"ConnectionString": "InstrumentationKey=dc5931c7-a7ad-4ad0-89d6-123456789abc",
"DisableIpMasking": false,
- "ImmediatePurgeDataOn30Days": false
+ "ImmediatePurgeDataOn30Days": false,
+ "IngestionMode": "ApplicationInsights"
}
},
{
@@ -56,7 +57,8 @@
"RetentionInDays": 90,
"ConnectionString": "InstrumentationKey=bc095013-3cf2-45ac-ab47-123456789abc",
"DisableIpMasking": false,
- "ImmediatePurgeDataOn30Days": false
+ "ImmediatePurgeDataOn30Days": false,
+ "IngestionMode": "ApplicationInsights"
}
}
],
diff --git a/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2015-05-01/examples/ComponentsListByResourceGroup.json b/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2015-05-01/examples/ComponentsListByResourceGroup.json
index dc9c2b395132..92bc4f1c5498 100644
--- a/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2015-05-01/examples/ComponentsListByResourceGroup.json
+++ b/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2015-05-01/examples/ComponentsListByResourceGroup.json
@@ -31,7 +31,8 @@
"RetentionInDays": 90,
"ConnectionString": "InstrumentationKey=dc5931c7-a7ad-4ad0-89d6-123456789abc",
"DisableIpMasking": false,
- "ImmediatePurgeDataOn30Days": false
+ "ImmediatePurgeDataOn30Days": false,
+ "IngestionMode": "ApplicationInsights"
}
},
{
@@ -57,7 +58,8 @@
"RetentionInDays": 90,
"ConnectionString": "InstrumentationKey=bc095013-3cf2-45ac-ab47-123456789abc",
"DisableIpMasking": false,
- "ImmediatePurgeDataOn30Days": false
+ "ImmediatePurgeDataOn30Days": false,
+ "IngestionMode": "ApplicationInsights"
}
}
],
diff --git a/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2015-05-01/examples/ComponentsUpdate.json b/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2015-05-01/examples/ComponentsUpdate.json
index ac92ef81e926..9ab62afd13e7 100644
--- a/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2015-05-01/examples/ComponentsUpdate.json
+++ b/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2015-05-01/examples/ComponentsUpdate.json
@@ -41,7 +41,8 @@
"RetentionInDays": 90,
"ConnectionString": "InstrumentationKey=bc095013-3cf2-45ac-ab47-123456789abc",
"DisableIpMasking": false,
- "ImmediatePurgeDataOn30Days": false
+ "ImmediatePurgeDataOn30Days": false,
+ "IngestionMode": "ApplicationInsights"
}
}
}
diff --git a/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2015-05-01/examples/ComponentsUpdateTagsOnly.json b/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2015-05-01/examples/ComponentsUpdateTagsOnly.json
index 3487365d9a29..8bbbfec88eb7 100644
--- a/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2015-05-01/examples/ComponentsUpdateTagsOnly.json
+++ b/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2015-05-01/examples/ComponentsUpdateTagsOnly.json
@@ -45,7 +45,8 @@
"RetentionInDays": 90,
"ConnectionString": "InstrumentationKey=bc095013-3cf2-45ac-ab47-123456789abc",
"DisableIpMasking": false,
- "ImmediatePurgeDataOn30Days": false
+ "ImmediatePurgeDataOn30Days": false,
+ "IngestionMode": "ApplicationInsights"
}
}
}
diff --git a/specification/applicationinsights/resource-manager/readme.md b/specification/applicationinsights/resource-manager/readme.md
index 558182cc4ce0..b01e064aecde 100644
--- a/specification/applicationinsights/resource-manager/readme.md
+++ b/specification/applicationinsights/resource-manager/readme.md
@@ -4,10 +4,10 @@
This is the AutoRest configuration file for ApplicationInsights.
-
-
---
+
## Getting Started
+
To build the SDK for ApplicationInsights, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run:
> `autorest`
@@ -15,6 +15,7 @@ To build the SDK for ApplicationInsights, simply [Install AutoRest](https://aka.
To see additional help and options, run:
> `autorest --help`
+
---
## Configuration
@@ -27,7 +28,7 @@ These are the global settings for the ApplicationInsights API.
title: ApplicationInsightsManagementClient
description: Composite Swagger for Application Insights Management Client
openapi-type: arm
-tag: package-2015-05
+tag: package-preview-2020-02
```
## Suppression
@@ -237,6 +238,15 @@ directive:
reason: There are a bug in this rule. "ExportConfigurations_Create" is a valid operation id.
```
+
+### Tag: package-preview-2020-02
+
+These settings apply only when `--tag=package-preview-2020-02` is specified on the command line.
+
+```yaml $(tag) == 'package-preview-2020-02'
+input-file:
+ - Microsoft.Insights/preview/2020-02-10-preview/WebTestResults_API.json
+```
### Tag: package-2015-05
These settings apply only when `--tag=package-2015-05` is specified on the command line.
@@ -281,7 +291,7 @@ input-file:
These settings apply only when `--tag=package-2019-10-17-preview` is specified on the command line.
-```yaml $(tag) == 'package-2019-10-17-preview'
+``` yaml $(tag) == 'package-2019-10-17-preview'
input-file:
- Microsoft.Insights/preview/2019-10-17-preview/workbookTemplates_API.json
```
@@ -292,8 +302,8 @@ These settings apply only when `--tag=package-2018-05-01-preview` is specified o
``` yaml $(tag) == 'package-2018-05-01-preview'
input-file:
-- Microsoft.Insights/preview/2018-05-01/componentProactiveDetection_API.json
-- Microsoft.Insights/preview/2018-05-01/components_API.json
+- Microsoft.Insights/preview/2018-05-01-preview/componentProactiveDetection_API.json
+- Microsoft.Insights/preview/2018-05-01-preview/components_API.json
```
### Tag: package-2019-09-01-preview
@@ -342,7 +352,7 @@ input-file:
- Microsoft.Insights/stable/2015-05-01/webTests_API.json
- Microsoft.Insights/stable/2015-05-01/analyticsItems_API.json
- Microsoft.Insights/stable/2015-05-01/workbooks_API.json
-- Microsoft.Insights/preview/2020-02-02-preview/components_API.json
+- Microsoft.Insights/preview/2018-05-01-preview/components_API.json
- Microsoft.Insights/preview/2020-03-01-preview/componentLinkedStorageAccounts_API.json
```
@@ -445,6 +455,7 @@ require: $(this-folder)/../../../profiles/readme.md
# all the input files across all versions
input-file:
+ - $(this-folder)/Microsoft.Insights/preview/2020-02-10-preview/WebTestResults_API.json
- $(this-folder)/Microsoft.Insights/stable/2015-05-01/aiOperations_API.json
- $(this-folder)/Microsoft.Insights/stable/2015-05-01/componentAnnotations_API.json
- $(this-folder)/Microsoft.Insights/stable/2015-05-01/componentApiKeys_API.json
@@ -462,8 +473,8 @@ input-file:
- $(this-folder)/Microsoft.Insights/preview/2017-10-01/componentFeaturesAndPricing_API.json
- $(this-folder)/Microsoft.Insights/preview/2018-06-17-preview/workbooks_API.json
- $(this-folder)/Microsoft.Insights/preview/2019-10-17-preview/workbookTemplates_API.json
- - $(this-folder)/Microsoft.Insights/preview/2018-05-01/componentProactiveDetection_API.json
- - $(this-folder)/Microsoft.Insights/preview/2018-05-01/components_API.json
+ - $(this-folder)/Microsoft.Insights/preview/2018-05-01-preview/componentProactiveDetection_API.json
+ - $(this-folder)/Microsoft.Insights/preview/2018-05-01-preview/components_API.json
- $(this-folder)/Microsoft.Insights/preview/2019-09-01-preview/QueryPackQueries_API.json
- $(this-folder)/Microsoft.Insights/preview/2019-09-01-preview/QueryPacks_API.json
- $(this-folder)/Microsoft.Insights/preview/2020-02-02-preview/components_API.json
diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2019-05-01-preview/appplatform.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2019-05-01-preview/appplatform.json
index ac38d29130d5..773e65c8d69f 100644
--- a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2019-05-01-preview/appplatform.json
+++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2019-05-01-preview/appplatform.json
@@ -2159,6 +2159,44 @@
}
}
}
+ },
+ "/subscriptions/{subscriptionId}/providers/Microsoft.AppPlatform/skus": {
+ "get": {
+ "tags": [
+ "AppPlatform"
+ ],
+ "operationId": "Sku_List",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "schema": {
+ "$ref": "#/definitions/ResourceSkuCollection"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-examples": {
+ "Sku_List": {
+ "$ref": "./examples/Sku_List.json"
+ }
+ }
+ }
}
},
"definitions": {
@@ -2175,6 +2213,10 @@
"$ref": "#/definitions/ClusterResourceProperties",
"description": "Properties of the Service resource",
"x-ms-client-flatten": false
+ },
+ "sku": {
+ "$ref": "#/definitions/Sku",
+ "description": "Sku of the Service resource"
}
}
},
@@ -2267,6 +2309,50 @@
}
}
},
+ "ManagedIdentityProperties": {
+ "description": "Managed identity properties retrieved from ARM request headers.",
+ "type": "object",
+ "properties": {
+ "type": {
+ "enum": [
+ "None",
+ "SystemAssigned",
+ "UserAssigned",
+ "SystemAssigned,UserAssigned"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "ManagedIdentityType",
+ "modelAsString": true
+ }
+ },
+ "principalId": {
+ "type": "string"
+ },
+ "tenantId": {
+ "type": "string"
+ }
+ }
+ },
+ "Sku": {
+ "description": "Sku of Azure Spring Cloud",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "Name of the Sku",
+ "type": "string"
+ },
+ "tier": {
+ "description": "Tier of the Sku",
+ "type": "string"
+ },
+ "capacity": {
+ "format": "int32",
+ "description": "Current capacity of the target resource",
+ "type": "integer"
+ }
+ }
+ },
"ConfigServerProperties": {
"description": "Config server git properties payload",
"type": "object",
@@ -2534,6 +2620,10 @@
"description": "Properties of the App resource",
"x-ms-client-flatten": false
},
+ "identity": {
+ "$ref": "#/definitions/ManagedIdentityProperties",
+ "description": "The Managed Identity type of the app resource"
+ },
"location": {
"description": "The GEO location of the application, always the same with its parent resource",
"type": "string"
@@ -3093,18 +3183,14 @@
"properties": {
"cpu": {
"format": "int32",
- "description": "Required CPU",
+ "description": "Required CPU, basic tier should be 1, standard tier should be in range (1, 4)",
"default": 1,
- "maximum": 4.0,
- "minimum": 1.0,
"type": "integer"
},
"memoryInGB": {
"format": "int32",
- "description": "Required Memory size in GB",
+ "description": "Required Memory size in GB, basic tier should be in range (1, 2), standard tier should be in range (1, 8)",
"default": 1,
- "maximum": 8.0,
- "minimum": 1.0,
"type": "integer"
},
"jvmOptions": {
@@ -3113,10 +3199,8 @@
},
"instanceCount": {
"format": "int32",
- "description": "Instance count",
+ "description": "Instance count, basic tier should be in range (1, 25), standard tier should be in range (1, 500)",
"default": 1,
- "maximum": 20.0,
- "minimum": 1.0,
"type": "integer"
},
"environmentVariables": {
@@ -3241,7 +3325,7 @@
"description": "Name of the operation",
"type": "string"
},
- "dataAction": {
+ "isDataAction": {
"description": "Indicates whether the operation is a data action",
"type": "boolean"
},
@@ -3403,6 +3487,227 @@
}
}
},
+ "ResourceSkuCollection": {
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "Collection of resource SKU",
+ "uniqueItems": false,
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ResourceSku"
+ }
+ },
+ "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"
+ }
+ }
+ },
+ "ResourceSku": {
+ "description": "Describes an available Azure Spring Cloud SKU.",
+ "type": "object",
+ "properties": {
+ "resourceType": {
+ "description": "Gets the type of resource the SKU applies to.",
+ "type": "string"
+ },
+ "name": {
+ "description": "Gets the name of SKU.",
+ "type": "string"
+ },
+ "tier": {
+ "description": "Gets the tier of SKU.",
+ "type": "string"
+ },
+ "capacity": {
+ "$ref": "#/definitions/SkuCapacity",
+ "description": "Gets the capacity of SKU."
+ },
+ "locations": {
+ "description": "Gets the set of locations that the SKU is available.",
+ "uniqueItems": false,
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "locationInfo": {
+ "description": "Gets a list of locations and availability zones in those locations where the SKU is available.",
+ "uniqueItems": false,
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ResourceSkuLocationInfo"
+ }
+ },
+ "restrictions": {
+ "description": "Gets the restrictions because of which SKU cannot be used. This is\r\nempty if there are no restrictions.",
+ "uniqueItems": false,
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ResourceSkuRestrictions"
+ }
+ }
+ }
+ },
+ "SkuCapacity": {
+ "description": "The SKU capacity",
+ "required": [
+ "minimum"
+ ],
+ "type": "object",
+ "properties": {
+ "minimum": {
+ "format": "int32",
+ "description": "Gets or sets the minimum.",
+ "type": "integer"
+ },
+ "maximum": {
+ "format": "int32",
+ "description": "Gets or sets the maximum.",
+ "type": "integer"
+ },
+ "default": {
+ "format": "int32",
+ "description": "Gets or sets the default.",
+ "type": "integer"
+ },
+ "scaleType": {
+ "description": "Gets or sets the type of the scale.",
+ "enum": [
+ "None",
+ "Manual",
+ "Automatic"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "SkuScaleType",
+ "modelAsString": true
+ }
+ }
+ }
+ },
+ "ResourceSkuLocationInfo": {
+ "type": "object",
+ "properties": {
+ "location": {
+ "description": "Gets location of the SKU",
+ "type": "string"
+ },
+ "zones": {
+ "description": "Gets list of availability zones where the SKU is supported.",
+ "uniqueItems": false,
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "zoneDetails": {
+ "description": "Gets details of capabilities available to a SKU in specific zones.",
+ "uniqueItems": false,
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ResourceSkuZoneDetails"
+ }
+ }
+ }
+ },
+ "ResourceSkuRestrictions": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "description": "Gets the type of restrictions. Possible values include: 'Location', 'Zone'",
+ "enum": [
+ "Location",
+ "Zone"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "ResourceSkuRestrictionsType",
+ "modelAsString": true
+ }
+ },
+ "values": {
+ "description": "Gets the value of restrictions. If the restriction type is set to\r\nlocation. This would be different locations where the SKU is restricted.",
+ "uniqueItems": false,
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "restrictionInfo": {
+ "$ref": "#/definitions/ResourceSkuRestrictionInfo",
+ "description": "Gets the information about the restriction where the SKU cannot be used."
+ },
+ "reasonCode": {
+ "description": "Gets the reason for restriction. Possible values include: 'QuotaId', 'NotAvailableForSubscription'",
+ "enum": [
+ "QuotaId",
+ "NotAvailableForSubscription"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "ResourceSkuRestrictionsReasonCode",
+ "modelAsString": true
+ }
+ }
+ }
+ },
+ "ResourceSkuZoneDetails": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "Gets the set of zones that the SKU is available in with the\r\nspecified capabilities.",
+ "uniqueItems": false,
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "capabilities": {
+ "description": "Gets a list of capabilities that are available for the SKU in the\r\nspecified list of zones.",
+ "uniqueItems": false,
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ResourceSkuCapabilities"
+ }
+ }
+ }
+ },
+ "ResourceSkuRestrictionInfo": {
+ "type": "object",
+ "properties": {
+ "locations": {
+ "description": "Gets locations where the SKU is restricted",
+ "uniqueItems": false,
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "zones": {
+ "description": "Gets list of availability zones where the SKU is restricted.",
+ "uniqueItems": false,
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "ResourceSkuCapabilities": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "Gets an invariant to describe the feature.",
+ "type": "string"
+ },
+ "value": {
+ "description": "Gets an invariant if the feature is measured by quantity.",
+ "type": "string"
+ }
+ }
+ },
"CloudError": {
"description": "An error response from the service.",
"properties": {
diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2019-05-01-preview/examples/Apps_CreateOrUpdate.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2019-05-01-preview/examples/Apps_CreateOrUpdate.json
index 8145e8e44747..be7ae73efb86 100644
--- a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2019-05-01-preview/examples/Apps_CreateOrUpdate.json
+++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2019-05-01-preview/examples/Apps_CreateOrUpdate.json
@@ -15,6 +15,7 @@
"mountPath": "mypersistentdisk"
}
},
+ "identity": null,
"location": "eastus"
},
"api-version": "2019-05-01-preview",
@@ -44,6 +45,11 @@
}
},
"type": "Microsoft.AppPlatform/Spring/apps",
+ "identity": {
+ "type": "SystemAssigned",
+ "principalId": "principalid",
+ "tenantId": "tenantid"
+ },
"location": "eastus",
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apps/myapp",
"name": "myapp"
@@ -69,6 +75,11 @@
}
},
"type": "Microsoft.AppPlatform/Spring/apps",
+ "identity": {
+ "type": "SystemAssigned",
+ "principalId": "principalid",
+ "tenantId": "tenantid"
+ },
"location": "eastus",
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apps/myapp",
"name": "myapp"
diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2019-05-01-preview/examples/Apps_Get.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2019-05-01-preview/examples/Apps_Get.json
index abdcd6fbd998..d939253e293a 100644
--- a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2019-05-01-preview/examples/Apps_Get.json
+++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2019-05-01-preview/examples/Apps_Get.json
@@ -27,6 +27,11 @@
}
},
"type": "Microsoft.AppPlatform/Spring/apps",
+ "identity": {
+ "type": "SystemAssigned",
+ "principalId": "principalid",
+ "tenantId": "tenantid"
+ },
"location": "eastus",
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apps/myapp",
"name": "myapp"
diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2019-05-01-preview/examples/Apps_List.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2019-05-01-preview/examples/Apps_List.json
index 0e9002ad0c77..2d5263ba9412 100644
--- a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2019-05-01-preview/examples/Apps_List.json
+++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2019-05-01-preview/examples/Apps_List.json
@@ -28,6 +28,11 @@
}
},
"type": "Microsoft.AppPlatform/Spring/apps",
+ "identity": {
+ "type": "SystemAssigned",
+ "principalId": "principalid",
+ "tenantId": "tenantid"
+ },
"location": "eastus",
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apps/myapp",
"name": "myapp"
diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2019-05-01-preview/examples/Apps_Update.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2019-05-01-preview/examples/Apps_Update.json
index 2ad43819f26f..d54122ac471b 100644
--- a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2019-05-01-preview/examples/Apps_Update.json
+++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2019-05-01-preview/examples/Apps_Update.json
@@ -15,6 +15,11 @@
"mountPath": "mypersistentdisk"
}
},
+ "identity": {
+ "type": "SystemAssigned",
+ "principalId": null,
+ "tenantId": null
+ },
"location": "eastus"
},
"api-version": "2019-05-01-preview",
@@ -44,6 +49,11 @@
}
},
"type": "Microsoft.AppPlatform/Spring/apps",
+ "identity": {
+ "type": "SystemAssigned",
+ "principalId": "principalid",
+ "tenantId": "tenantid"
+ },
"location": "eastus",
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apps/myapp",
"name": "myapp"
@@ -69,6 +79,11 @@
}
},
"type": "Microsoft.AppPlatform/Spring/apps",
+ "identity": {
+ "type": "SystemAssigned",
+ "principalId": "principalid",
+ "tenantId": "tenantid"
+ },
"location": "eastus",
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apps/myapp",
"name": "myapp"
diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2019-05-01-preview/examples/Deployments_CreateOrUpdate.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2019-05-01-preview/examples/Deployments_CreateOrUpdate.json
index d1d902e57925..0204c12e6e2b 100644
--- a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2019-05-01-preview/examples/Deployments_CreateOrUpdate.json
+++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2019-05-01-preview/examples/Deployments_CreateOrUpdate.json
@@ -49,8 +49,8 @@
},
"runtimeVersion": "Java_8"
},
- "provisioningState": "Updating",
- "status": "Compiling",
+ "provisioningState": "Creating",
+ "status": "Running",
"active": false,
"instances": [
{
diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2019-05-01-preview/examples/Operations_List.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2019-05-01-preview/examples/Operations_List.json
index d80cd6b14ce0..bc83e3c0e539 100644
--- a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2019-05-01-preview/examples/Operations_List.json
+++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2019-05-01-preview/examples/Operations_List.json
@@ -8,7 +8,7 @@
"value": [
{
"name": "Microsoft.AppPlatform/Spring/read",
- "dataAction": false,
+ "isDataAction": false,
"display": {
"provider": "Microsoft Azure Distributed Managed Service for Spring",
"resource": "Managed Applications",
diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2019-05-01-preview/examples/Services_CreateOrUpdate.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2019-05-01-preview/examples/Services_CreateOrUpdate.json
index f21f1f432b7d..0b9eb4797dc1 100644
--- a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2019-05-01-preview/examples/Services_CreateOrUpdate.json
+++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2019-05-01-preview/examples/Services_CreateOrUpdate.json
@@ -18,6 +18,10 @@
"appInsightInstrumentationKey": "00000000-0000-0000-0000-000000000000"
}
},
+ "sku": {
+ "name": "P0",
+ "tier": "Premium"
+ },
"location": "eastus",
"tags": {
"key1": "value1"
@@ -53,6 +57,10 @@
"serviceId": "12345678abcd1234abcd12345678abcd"
},
"type": "Microsoft.AppPlatform/Spring",
+ "sku": {
+ "name": "P0",
+ "tier": "Premium"
+ },
"location": "eastus",
"tags": {
"key1": "value1"
@@ -85,6 +93,10 @@
"serviceId": "12345678abcd1234abcd12345678abcd"
},
"type": "Microsoft.AppPlatform/Spring",
+ "sku": {
+ "name": "P0",
+ "tier": "Premium"
+ },
"location": "eastus",
"tags": {
"key1": "value1"
diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2019-05-01-preview/examples/Services_Get.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2019-05-01-preview/examples/Services_Get.json
index ebe1db60e6d2..0fd464fbf73c 100644
--- a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2019-05-01-preview/examples/Services_Get.json
+++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2019-05-01-preview/examples/Services_Get.json
@@ -30,6 +30,10 @@
"serviceId": "12345678abcd1234abcd12345678abcd"
},
"type": "Microsoft.AppPlatform/Spring",
+ "sku": {
+ "name": "P0",
+ "tier": "Premium"
+ },
"location": "eastus",
"tags": {
"key1": "value1"
diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2019-05-01-preview/examples/Services_List.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2019-05-01-preview/examples/Services_List.json
index ce13e8f49f54..60bff7e0b137 100644
--- a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2019-05-01-preview/examples/Services_List.json
+++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2019-05-01-preview/examples/Services_List.json
@@ -31,6 +31,10 @@
"serviceId": "12345678abcd1234abcd12345678abcd"
},
"type": "Microsoft.AppPlatform/Spring",
+ "sku": {
+ "name": "P0",
+ "tier": "Premium"
+ },
"location": "eastus",
"tags": {
"key1": "value1"
diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2019-05-01-preview/examples/Services_ListBySubscription.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2019-05-01-preview/examples/Services_ListBySubscription.json
index 818367d797a5..1e7ffa74d93f 100644
--- a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2019-05-01-preview/examples/Services_ListBySubscription.json
+++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2019-05-01-preview/examples/Services_ListBySubscription.json
@@ -30,6 +30,10 @@
"serviceId": "12345678abcd1234abcd12345678abcd"
},
"type": "Microsoft.AppPlatform/Spring",
+ "sku": {
+ "name": "P0",
+ "tier": "Premium"
+ },
"location": "eastus",
"tags": {
"key1": "value1"
diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2019-05-01-preview/examples/Services_Update.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2019-05-01-preview/examples/Services_Update.json
index 6f71ce79b699..6ff77da01f9b 100644
--- a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2019-05-01-preview/examples/Services_Update.json
+++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2019-05-01-preview/examples/Services_Update.json
@@ -18,6 +18,10 @@
"appInsightInstrumentationKey": "00000000-0000-0000-0000-000000000000"
}
},
+ "sku": {
+ "name": "P0",
+ "tier": "Premium"
+ },
"location": "eastus",
"tags": {
"key1": "value1"
@@ -53,6 +57,10 @@
"serviceId": "12345678abcd1234abcd12345678abcd"
},
"type": "Microsoft.AppPlatform/Spring",
+ "sku": {
+ "name": "P0",
+ "tier": "Premium"
+ },
"location": "eastus",
"tags": {
"key1": "value1"
@@ -85,6 +93,10 @@
"serviceId": "12345678abcd1234abcd12345678abcd"
},
"type": "Microsoft.AppPlatform/Spring",
+ "sku": {
+ "name": "P0",
+ "tier": "Premium"
+ },
"location": "eastus",
"tags": {
"key1": "value1"
diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2019-05-01-preview/examples/Sku_List.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2019-05-01-preview/examples/Sku_List.json
new file mode 100644
index 000000000000..99c4c8efe8e7
--- /dev/null
+++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2019-05-01-preview/examples/Sku_List.json
@@ -0,0 +1,36 @@
+{
+ "parameters": {
+ "api-version": "2019-05-01-preview",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "resourceType": "Spring",
+ "name": "B0",
+ "tier": "Basic",
+ "capacity": {
+ "minimum": 1,
+ "maximum": 20,
+ "default": 1,
+ "scaleType": "Automatic"
+ },
+ "locations": [
+ "eastus"
+ ],
+ "locationInfo": [
+ {
+ "location": "eastus",
+ "zones": [],
+ "zoneDetails": []
+ }
+ ],
+ "restrictions": []
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/attestation/resource-manager/readme.az.md b/specification/attestation/resource-manager/readme.az.md
index 15a808946ef8..8f3cb7f07357 100644
--- a/specification/attestation/resource-manager/readme.az.md
+++ b/specification/attestation/resource-manager/readme.az.md
@@ -7,4 +7,6 @@ az:
extensions: attestation
package-name: azure-mgmt-attestation
namespace: azure.mgmt.attestation
+az-output-folder: $(azure-cli-extension-folder)/src/attestation
+python-sdk-output-folder: "$(az-output-folder)/azext_attestation/vendored_sdks/attestation"
```
diff --git a/specification/attestation/resource-manager/readme.cli.md b/specification/attestation/resource-manager/readme.cli.md
index c1990d90a9d8..539d9cf67e00 100644
--- a/specification/attestation/resource-manager/readme.cli.md
+++ b/specification/attestation/resource-manager/readme.cli.md
@@ -7,11 +7,12 @@ cli:
cli-name: attestation
package-name: azure-mgmt-attestation
namespace: azure.mgmt.attestation
- test-setup:
- - name: Operations_List
- - name: AttestationProviders_Create
- - name: AttestationProviders_Get
- - name: AttestationProviders_List
- - name: AttestationProviders_ListByResourceGroup
- - name: AttestationProviders_Delete
+ test-scenario:
+ - name: /AttestationProviders/put/AttestationProviders_Create
+ - name: /AttestationProviders/get/AttestationProviders_Get
+ - name: /AttestationProviders/get/AttestationProviders_ListByResourceGroup
+ - name: /AttestationProviders/get/AttestationProviders_List
+ - name: /Operations/get/Operations_List
+ - name: /AttestationProviders/patch/AttestationProviders_Update
+ - name: /AttestationProviders/delete/AttestationProviders_Delete
```
diff --git a/specification/azsadmin/resource-manager/commerce/Microsoft.Commerce.Admin/preview/2015-06-01-preview/Commerce.json b/specification/azsadmin/resource-manager/commerce/Microsoft.Commerce.Admin/preview/2015-06-01-preview/Commerce.json
index c34915e2be14..890c3b5b8fda 100644
--- a/specification/azsadmin/resource-manager/commerce/Microsoft.Commerce.Admin/preview/2015-06-01-preview/Commerce.json
+++ b/specification/azsadmin/resource-manager/commerce/Microsoft.Commerce.Admin/preview/2015-06-01-preview/Commerce.json
@@ -198,7 +198,8 @@
},
"quantity": {
"description": "The amount of the resource consumption that occurred in this time frame.",
- "type": "string"
+ "type": "number",
+ "format": "double"
},
"meterId": {
"description": "Unique ID for the resource that was consumed, for example, the Resource ID.",
diff --git a/specification/azsadmin/resource-manager/commerce/readme.azsautogen.md b/specification/azsadmin/resource-manager/commerce/readme.azsautogen.md
new file mode 100644
index 000000000000..77f54f1348bb
--- /dev/null
+++ b/specification/azsadmin/resource-manager/commerce/readme.azsautogen.md
@@ -0,0 +1,8 @@
+# AutoRest v3 generators
+
+> see https://aka.ms/autorest
+
+``` yaml
+input-file:
+ - Microsoft.Commerce.Admin/preview/2015-06-01-preview/Commerce.json
+```
diff --git a/specification/azsadmin/resource-manager/commerce/readme.md b/specification/azsadmin/resource-manager/commerce/readme.md
index 1676a911714f..7e36302807ea 100644
--- a/specification/azsadmin/resource-manager/commerce/readme.md
+++ b/specification/azsadmin/resource-manager/commerce/readme.md
@@ -84,4 +84,3 @@ uncomment the `exclude-file` section below and add the file paths.
#exclude-file:
# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json
```
-
diff --git a/specification/azsadmin/resource-manager/keyvault/readme.azsautogen.md b/specification/azsadmin/resource-manager/keyvault/readme.azsautogen.md
new file mode 100644
index 000000000000..46257a0daf5d
--- /dev/null
+++ b/specification/azsadmin/resource-manager/keyvault/readme.azsautogen.md
@@ -0,0 +1,9 @@
+# AutoRest v3 generators
+
+> see https://aka.ms/autorest
+
+``` yaml
+input-file:
+ - $(this-folder)/Microsoft.KeyVault.Admin/preview/2017-02-01-preview/KeyVault.json
+ - $(this-folder)/Microsoft.KeyVault.Admin/preview/2017-02-01-preview/Quotas.json
+```
\ No newline at end of file
diff --git a/specification/azsadmin/resource-manager/keyvault/readme.md b/specification/azsadmin/resource-manager/keyvault/readme.md
index a1804bffd6a2..0f0dcdf22372 100644
--- a/specification/azsadmin/resource-manager/keyvault/readme.md
+++ b/specification/azsadmin/resource-manager/keyvault/readme.md
@@ -52,7 +52,7 @@ csharp:
clear-output-folder: true
```
-## Multi-API/Profile support for AutoRest v3 generators
+## Multi-API/Profile support for AutoRest v3 generators
AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files.
@@ -73,7 +73,6 @@ If there are files that should not be in the `all-api-versions` set,
uncomment the `exclude-file` section below and add the file paths.
``` yaml $(tag) == 'all-api-versions'
-#exclude-file:
+#exclude-file:
# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json
```
-
diff --git a/specification/azsadmin/resource-manager/network/Microsoft.Network.Admin/preview/2015-06-15/Quotas.json b/specification/azsadmin/resource-manager/network/Microsoft.Network.Admin/preview/2015-06-15/Quotas.json
index adb8d7713fc4..68e78a682ab6 100644
--- a/specification/azsadmin/resource-manager/network/Microsoft.Network.Admin/preview/2015-06-15/Quotas.json
+++ b/specification/azsadmin/resource-manager/network/Microsoft.Network.Admin/preview/2015-06-15/Quotas.json
@@ -48,9 +48,6 @@
"schema": {
"$ref": "#/definitions/QuotaList"
}
- },
- "404": {
- "description": "Not Found"
}
},
"x-ms-pageable": {
@@ -91,9 +88,6 @@
"schema": {
"$ref": "#/definitions/Quota"
}
- },
- "404": {
- "description": "Not Found"
}
}
},
diff --git a/specification/azsadmin/resource-manager/network/Microsoft.Network.Admin/preview/2015-06-15/examples/Quota/Get.json b/specification/azsadmin/resource-manager/network/Microsoft.Network.Admin/preview/2015-06-15/examples/Quota/Get.json
index 9e69055d8579..d5e8a568242a 100644
--- a/specification/azsadmin/resource-manager/network/Microsoft.Network.Admin/preview/2015-06-15/examples/Quota/Get.json
+++ b/specification/azsadmin/resource-manager/network/Microsoft.Network.Admin/preview/2015-06-15/examples/Quota/Get.json
@@ -24,7 +24,6 @@
},
"id": "/subscriptions/fc8456aa-4843-4079-a152-f3497c63aa73/providers/Microsoft.Network.Admin/locations/local/quotas/Default Quota"
}
- },
- "404": {}
+ }
}
}
diff --git a/specification/azsadmin/resource-manager/network/Microsoft.Network.Admin/preview/2015-06-15/examples/Quota/List.json b/specification/azsadmin/resource-manager/network/Microsoft.Network.Admin/preview/2015-06-15/examples/Quota/List.json
index e852472afccb..175702564e6a 100644
--- a/specification/azsadmin/resource-manager/network/Microsoft.Network.Admin/preview/2015-06-15/examples/Quota/List.json
+++ b/specification/azsadmin/resource-manager/network/Microsoft.Network.Admin/preview/2015-06-15/examples/Quota/List.json
@@ -27,7 +27,6 @@
}
]
}
- },
- "404": {}
+ }
}
}
diff --git a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2019-08-08/examples/StorageAccounts/Undelete.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2019-08-08/examples/StorageAccounts/Undelete.json
index c4a30491f691..51713d045a6f 100644
--- a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2019-08-08/examples/StorageAccounts/Undelete.json
+++ b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2019-08-08/examples/StorageAccounts/Undelete.json
@@ -7,11 +7,7 @@
"summary": "false"
},
"responses": {
- "200": {
- "body": {
- "accountId": "80d458ce4ecd47888b54aaa277800748"
- }
- },
+ "200": {},
"202": {}
}
}
diff --git a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2019-08-08/settings.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2019-08-08/settings.json
index 9f8a9e4bc325..626252ba8783 100644
--- a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2019-08-08/settings.json
+++ b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2019-08-08/settings.json
@@ -121,8 +121,7 @@
"properties": {
"description": "Properties of the storage account.",
"x-ms-client-flatten": true,
- "$ref": "#/definitions/SettingProperties",
- "readOnly": true
+ "$ref": "#/definitions/SettingProperties"
}
},
"allOf": [
diff --git a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2019-08-08/storage.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2019-08-08/storage.json
index 7f09a86f4239..bd30cc8babdf 100644
--- a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2019-08-08/storage.json
+++ b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2019-08-08/storage.json
@@ -91,7 +91,7 @@
}
}
},
- "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroup}/providers/Microsoft.Storage.Admin/storageServices": {
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Storage.Admin/storageServices": {
"get": {
"x-ms-examples": {
"Returns the storage services list under the specified resource group and subscription.": {
@@ -166,7 +166,7 @@
}
}
},
- "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroup}/providers/Microsoft.Storage.Admin/storageServices/{serviceName}": {
+ "/subscriptions/{subscriptionId}resourceGroups/{resourceGroup}/providers/Microsoft.Storage.Admin/storageServices/{serviceName}": {
"get": {
"x-ms-examples": {
"Returns the specified storage service.": {
diff --git a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2019-08-08/storageaccounts.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2019-08-08/storageaccounts.json
index ec8df91cef15..93288e309e6d 100644
--- a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2019-08-08/storageaccounts.json
+++ b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2019-08-08/storageaccounts.json
@@ -137,10 +137,7 @@
],
"responses": {
"200": {
- "description": "OK -- Undelete either has been performed or account was not deleted.",
- "schema": {
- "$ref": "#/definitions/UndeleteStorageAccount"
- }
+ "description": "OK -- Undelete either has been performed or account was not deleted."
},
"202": {
"description": "Accepted -- undelete operation trigged; operation will complete asynchronously."
@@ -195,7 +192,10 @@
}
}
},
- "x-ms-long-running-operation": true
+ "x-ms-long-running-operation": true,
+ "x-ms-long-running-operation-options": {
+ "final-state-via": "location"
+ }
}
}
},
@@ -377,6 +377,7 @@
},
"primaryEndpoints": {
"description": "The URLs that are used to perform a retrieval of a public BLOB, queue, or table object.",
+ "type": "object",
"additionalProperties": {
"type": "string"
},
@@ -543,7 +544,8 @@
"in": "query",
"required": false,
"type": "boolean",
- "x-ms-parameter-location": "method"
+ "x-ms-parameter-location": "method",
+ "default": false
},
"FilterParameter": {
"description": "Filter string",
diff --git a/specification/azsadmin/resource-manager/storage/readme.azsautogen.md b/specification/azsadmin/resource-manager/storage/readme.azsautogen.md
new file mode 100644
index 000000000000..d6a523515d44
--- /dev/null
+++ b/specification/azsadmin/resource-manager/storage/readme.azsautogen.md
@@ -0,0 +1,55 @@
+# Storage Admin
+
+> see https://aka.ms/autorest
+
+This is the AutoRest configuration file for Storage Admin.
+
+---
+## Getting Started
+To build the SDK for Storage Admin, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run:
+
+> `autorest`
+
+To see additional help and options, run:
+
+> `autorest --help`
+---
+
+## Configuration
+
+### Basic Information
+These are the global settings for the Storage API.
+
+``` yaml
+title: StorageAdminClient
+description: Storage Admin Client
+openapi-type: arm
+tag: package-2019-08-08
+```
+
+``` yaml
+input-file:
+ - $(this-folder)/Microsoft.Storage.Admin/preview/2019-08-08/storageaccounts.json
+ - $(this-folder)/Microsoft.Storage.Admin/preview/2019-08-08/quotas.json
+ - $(this-folder)/Microsoft.Storage.Admin/preview/2019-08-08/settings.json
+ - $(this-folder)/Microsoft.Storage.Admin/preview/2019-08-08/storage.json
+ - $(this-folder)/Microsoft.Storage.Admin/preview/2019-08-08/acquisitions.json
+```
+
+---
+# Code Generation
+
+## C#
+
+These settings apply only when `--csharp` is specified on the command line.
+Please also specify `--csharp-sdks-folder=`.
+
+``` yaml $(csharp)
+csharp:
+ azure-arm: true
+ license-header: MICROSOFT_MIT_NO_VERSION
+ namespace: Microsoft.AzureStack.Management.Storage.Admin
+ payload-flattening-threshold: 1
+ output-folder: $(csharp-sdks-folder)/Generated
+ clear-output-folder: true
+```
diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-02-15/kusto.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-02-15/kusto.json
index 9f6452aaae4a..de503c5dc6ef 100644
--- a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-02-15/kusto.json
+++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-02-15/kusto.json
@@ -2877,7 +2877,7 @@
"description": "The statistics of the database."
},
"isFollowed": {
- "type": "string",
+ "type": "boolean",
"readOnly": true,
"description": "Indicates whether the database is followed."
}
diff --git a/specification/azure-kusto/resource-manager/readme.az.md b/specification/azure-kusto/resource-manager/readme.az.md
index 57ab1d5b9c1c..16ed7b113692 100644
--- a/specification/azure-kusto/resource-manager/readme.az.md
+++ b/specification/azure-kusto/resource-manager/readme.az.md
@@ -10,6 +10,7 @@ az:
az-output-folder: $(azure-cli-extension-folder)/src/kusto
python-sdk-output-folder: "$(az-output-folder)/azext_kusto/vendored_sdks/kusto"
+
cli:
cli-directive:
- where:
diff --git a/specification/azure-kusto/resource-manager/readme.java.md b/specification/azure-kusto/resource-manager/readme.java.md
index d8a5cd934f22..aa1b6240aba8 100644
--- a/specification/azure-kusto/resource-manager/readme.java.md
+++ b/specification/azure-kusto/resource-manager/readme.java.md
@@ -17,6 +17,7 @@ output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-kusto
``` yaml $(java) && $(multiapi)
batch:
- tag: package-2019-11-09
+ - tag: package-2020-02-15
```
### Tag: package-2018-09-07-preview and java
@@ -82,4 +83,17 @@ java:
output-folder: $(azure-libraries-for-java-folder)/sdk/kusto/mgmt-v2019_11_09
regenerate-manager: true
generate-interface: true
+```
+
+### Tag: package-2020-02-15 and java
+
+These settings apply only when `--tag=package-2020-02-15 --java` is specified on the command line.
+Please also specify `--azure-libraries-for-java=`.
+
+``` yaml $(tag) == 'package-2020-02-15' && $(java) && $(multiapi)
+java:
+ namespace: com.microsoft.azure.management.kusto.v2020_02_15
+ output-folder: $(azure-libraries-for-java-folder)/sdk/kusto/mgmt-v2020_02_15
+regenerate-manager: true
+generate-interface: true
```
\ No newline at end of file
diff --git a/specification/azureactivedirectory/resource-manager/Microsoft.Aadiam/preview/2020-03-01-preview/examples/AzureADPrivateLinkPolicyCreate.json b/specification/azureactivedirectory/resource-manager/Microsoft.Aadiam/preview/2020-03-01-preview/examples/AzureADPrivateLinkPolicyCreate.json
new file mode 100644
index 000000000000..57e47eddbf87
--- /dev/null
+++ b/specification/azureactivedirectory/resource-manager/Microsoft.Aadiam/preview/2020-03-01-preview/examples/AzureADPrivateLinkPolicyCreate.json
@@ -0,0 +1,50 @@
+{
+ "parameters": {
+ "subscriptionId": "00000000-1111-2222-3333-444444444444",
+ "resourceGroupName": "rg1",
+ "policyName": "ddb1",
+ "api-version": "2020-03-01-preview",
+ "privateLinkPolicy": {
+ "name": "myOrgPrivateLinkPolicy",
+ "allTenants": false,
+ "ownerTenantId": "950f8bca-bf4d-4a41-ad10-034e792a243d",
+ "tenants": [
+ "3616657d-1c80-41ae-9d83-2a2776f2c9be",
+ "727b6ef1-18ab-4627-ac95-3f9cd945ed87"
+ ],
+ "resourceName": "myOrgVnetPrivateLink",
+ "subscriptionId": "57849194-ea1f-470b-abda-d195b25634c1",
+ "resourceGroup": "myOrgVnetRG"
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "name": "myOrgPrivateLinkPolicy",
+ "ownerTenantId": "950f8bca-bf4d-4a41-ad10-034e792a243d",
+ "allTenants": false,
+ "tenants": [
+ "3616657d-1c80-41ae-9d83-2a2776f2c9be",
+ "727b6ef1-18ab-4627-ac95-3f9cd945ed87"
+ ],
+ "resourceName": "myOrgVnetPrivateLink",
+ "subscriptionId": "57849194-ea1f-470b-abda-d195b25634c1",
+ "resourceGroup": "myOrgVnetRG"
+ }
+ },
+ "201": {
+ "body": {
+ "name": "myOrgPrivateLinkPolicy",
+ "ownerTenantId": "950f8bca-bf4d-4a41-ad10-034e792a243d",
+ "allTenants": false,
+ "tenants": [
+ "3616657d-1c80-41ae-9d83-2a2776f2c9be",
+ "727b6ef1-18ab-4627-ac95-3f9cd945ed87"
+ ],
+ "resourceName": "myOrgVnetPrivateLink",
+ "subscriptionId": "57849194-ea1f-470b-abda-d195b25634c1",
+ "resourceGroup": "myOrgVnetRG"
+ }
+ }
+ }
+}
diff --git a/specification/azureactivedirectory/resource-manager/Microsoft.Aadiam/preview/2020-03-01-preview/examples/AzureADPrivateLinkPolicyDelete.json b/specification/azureactivedirectory/resource-manager/Microsoft.Aadiam/preview/2020-03-01-preview/examples/AzureADPrivateLinkPolicyDelete.json
new file mode 100644
index 000000000000..a67dbec84476
--- /dev/null
+++ b/specification/azureactivedirectory/resource-manager/Microsoft.Aadiam/preview/2020-03-01-preview/examples/AzureADPrivateLinkPolicyDelete.json
@@ -0,0 +1,24 @@
+{
+ "parameters": {
+ "subscriptionId": "00000000-1111-2222-3333-444444444444",
+ "resourceGroupName": "rg1",
+ "policyName": "ddb1",
+ "api-version": "2020-03-01-preview",
+ "privateLinkPolicy": {
+ "name": "myOrgPrivateLinkPolicy",
+ "ownerTenantId": "950f8bca-bf4d-4a41-ad10-034e792a243d",
+ "allTenants": false,
+ "tenants": [
+ "3616657d-1c80-41ae-9d83-2a2776f2c9be",
+ "727b6ef1-18ab-4627-ac95-3f9cd945ed87"
+ ],
+ "resourceName": "myOrgVnetPrivateLink",
+ "subscriptionId": "57849194-ea1f-470b-abda-d195b25634c1",
+ "resourceGroup": "myOrgVnetRG"
+ }
+ },
+ "responses": {
+ "200": {},
+ "204": {}
+ }
+}
diff --git a/specification/azureactivedirectory/resource-manager/Microsoft.Aadiam/preview/2020-03-01-preview/examples/AzureADPrivateLinkPolicyGet.json b/specification/azureactivedirectory/resource-manager/Microsoft.Aadiam/preview/2020-03-01-preview/examples/AzureADPrivateLinkPolicyGet.json
new file mode 100644
index 000000000000..8dbe8dcf0e61
--- /dev/null
+++ b/specification/azureactivedirectory/resource-manager/Microsoft.Aadiam/preview/2020-03-01-preview/examples/AzureADPrivateLinkPolicyGet.json
@@ -0,0 +1,24 @@
+{
+ "parameters": {
+ "subscriptionId": "00000000-1111-2222-3333-444444444444",
+ "resourceGroupName": "rg1",
+ "policyName": "ddb1",
+ "api-version": "2020-03-01-preview"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "name": "myOrgPrivateLinkPolicy",
+ "ownerTenantId": "950f8bca-bf4d-4a41-ad10-034e792a243d",
+ "allTenants": false,
+ "tenants": [
+ "3616657d-1c80-41ae-9d83-2a2776f2c9be",
+ "727b6ef1-18ab-4627-ac95-3f9cd945ed87"
+ ],
+ "resourceName": "myOrgVnetPrivateLink",
+ "subscriptionId": "57849194-ea1f-470b-abda-d195b25634c1",
+ "resourceGroup": "myOrgVnetRG"
+ }
+ }
+ }
+}
diff --git a/specification/azureactivedirectory/resource-manager/Microsoft.Aadiam/preview/2020-03-01-preview/examples/AzureADPrivateLinkPolicyList.json b/specification/azureactivedirectory/resource-manager/Microsoft.Aadiam/preview/2020-03-01-preview/examples/AzureADPrivateLinkPolicyList.json
new file mode 100644
index 000000000000..da9771decce0
--- /dev/null
+++ b/specification/azureactivedirectory/resource-manager/Microsoft.Aadiam/preview/2020-03-01-preview/examples/AzureADPrivateLinkPolicyList.json
@@ -0,0 +1,27 @@
+{
+ "parameters": {
+ "subscriptionId": "00000000-1111-2222-3333-444444444444",
+ "resourceGroupName": "rg1",
+ "api-version": "2020-03-01-preview"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "name": "myOrgPrivateLinkPolicy",
+ "ownerTenantId": "950f8bca-bf4d-4a41-ad10-034e792a243d",
+ "tenants": [
+ "3616657d-1c80-41ae-9d83-2a2776f2c9be",
+ "727b6ef1-18ab-4627-ac95-3f9cd945ed87"
+ ],
+ "resourceName": "myOrgVnetPrivateLink",
+ "subscriptionId": "57849194-ea1f-470b-abda-d195b25634c1",
+ "resourceGroup": "myOrgVnetRG"
+ }
+ ],
+ "nextLink": "null"
+ }
+ }
+ }
+}
diff --git a/specification/azureactivedirectory/resource-manager/Microsoft.Aadiam/preview/2020-03-01-preview/examples/AzureADPrivateLinkPolicyListBySubscription.json b/specification/azureactivedirectory/resource-manager/Microsoft.Aadiam/preview/2020-03-01-preview/examples/AzureADPrivateLinkPolicyListBySubscription.json
new file mode 100644
index 000000000000..4fb0b868ed83
--- /dev/null
+++ b/specification/azureactivedirectory/resource-manager/Microsoft.Aadiam/preview/2020-03-01-preview/examples/AzureADPrivateLinkPolicyListBySubscription.json
@@ -0,0 +1,27 @@
+{
+ "parameters": {
+ "subscriptionId": "00000000-1111-2222-3333-444444444444",
+ "api-version": "2020-03-01-preview"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "name": "myOrgPrivateLinkPolicy",
+ "ownerTenantId": "950f8bca-bf4d-4a41-ad10-034e792a243d",
+ "allTenants": false,
+ "tenants": [
+ "3616657d-1c80-41ae-9d83-2a2776f2c9be",
+ "727b6ef1-18ab-4627-ac95-3f9cd945ed87"
+ ],
+ "resourceName": "myOrgVnetPrivateLink",
+ "subscriptionId": "57849194-ea1f-470b-abda-d195b25634c1",
+ "resourceGroup": "myOrgVnetRG"
+ }
+ ],
+ "nextLink": "null"
+ }
+ }
+ }
+}
diff --git a/specification/azureactivedirectory/resource-manager/Microsoft.Aadiam/preview/2020-03-01-preview/examples/AzureADPrivateLinkPolicyMinCreate.json b/specification/azureactivedirectory/resource-manager/Microsoft.Aadiam/preview/2020-03-01-preview/examples/AzureADPrivateLinkPolicyMinCreate.json
new file mode 100644
index 000000000000..75a8b97c04e2
--- /dev/null
+++ b/specification/azureactivedirectory/resource-manager/Microsoft.Aadiam/preview/2020-03-01-preview/examples/AzureADPrivateLinkPolicyMinCreate.json
@@ -0,0 +1,50 @@
+{
+ "parameters": {
+ "subscriptionId": "00000000-1111-2222-3333-444444444444",
+ "resourceGroupName": "rg1",
+ "policyName": "ddb1",
+ "api-version": "2020-03-01-preview",
+ "privateLinkPolicy": {
+ "name": "myOrgPrivateLinkPolicy",
+ "ownerTenantId": "950f8bca-bf4d-4a41-ad10-034e792a243d",
+ "allTenants": false,
+ "tenants": [
+ "3616657d-1c80-41ae-9d83-2a2776f2c9be",
+ "727b6ef1-18ab-4627-ac95-3f9cd945ed87"
+ ],
+ "resourceName": "myOrgVnetPrivateLink",
+ "subscriptionId": "57849194-ea1f-470b-abda-d195b25634c1",
+ "resourceGroup": "myOrgVnetRG"
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "name": "myOrgPrivateLinkPolicy",
+ "ownerTenantId": "950f8bca-bf4d-4a41-ad10-034e792a243d",
+ "allTenants": false,
+ "tenants": [
+ "3616657d-1c80-41ae-9d83-2a2776f2c9be",
+ "727b6ef1-18ab-4627-ac95-3f9cd945ed87"
+ ],
+ "resourceName": "myOrgVnetPrivateLink",
+ "subscriptionId": "57849194-ea1f-470b-abda-d195b25634c1",
+ "resourceGroup": "myOrgVnetRG"
+ }
+ },
+ "201": {
+ "body": {
+ "name": "myOrgPrivateLinkPolicy",
+ "ownerTenantId": "950f8bca-bf4d-4a41-ad10-034e792a243d",
+ "allTenants": false,
+ "tenants": [
+ "3616657d-1c80-41ae-9d83-2a2776f2c9be",
+ "727b6ef1-18ab-4627-ac95-3f9cd945ed87"
+ ],
+ "resourceName": "myOrgVnetPrivateLink",
+ "subscriptionId": "57849194-ea1f-470b-abda-d195b25634c1",
+ "resourceGroup": "myOrgVnetRG"
+ }
+ }
+ }
+}
diff --git a/specification/azureactivedirectory/resource-manager/Microsoft.Aadiam/preview/2020-03-01-preview/examples/AzureADPrivateLinkPolicyUpdate.json b/specification/azureactivedirectory/resource-manager/Microsoft.Aadiam/preview/2020-03-01-preview/examples/AzureADPrivateLinkPolicyUpdate.json
new file mode 100644
index 000000000000..5902885602af
--- /dev/null
+++ b/specification/azureactivedirectory/resource-manager/Microsoft.Aadiam/preview/2020-03-01-preview/examples/AzureADPrivateLinkPolicyUpdate.json
@@ -0,0 +1,28 @@
+{
+ "parameters": {
+ "subscriptionId": "00000000-1111-2222-3333-444444444444",
+ "resourceGroupName": "rg1",
+ "policyName": "ddb1",
+ "api-version": "2020-03-01-preview",
+ "privateLinkPolicy": {
+ "tags": {}
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "name": "myOrgPrivateLinkPolicy",
+ "ownerTenantId": "950f8bca-bf4d-4a41-ad10-034e792a243d",
+ "allTenants": false,
+ "tenants": [
+ "3616657d-1c80-41ae-9d83-2a2776f2c9be",
+ "727b6ef1-18ab-4627-ac95-3f9cd945ed87"
+ ],
+ "resourceName": "myOrgVnetPrivateLink",
+ "subscriptionId": "57849194-ea1f-470b-abda-d195b25634c1",
+ "resourceGroup": "myOrgVnetRG",
+ "tags": {}
+ }
+ }
+ }
+}
diff --git a/specification/azureactivedirectory/resource-manager/Microsoft.Aadiam/preview/2020-03-01-preview/examples/AzureADPrivateLinkResourceGet.json b/specification/azureactivedirectory/resource-manager/Microsoft.Aadiam/preview/2020-03-01-preview/examples/AzureADPrivateLinkResourceGet.json
new file mode 100644
index 000000000000..31fbcdc073ef
--- /dev/null
+++ b/specification/azureactivedirectory/resource-manager/Microsoft.Aadiam/preview/2020-03-01-preview/examples/AzureADPrivateLinkResourceGet.json
@@ -0,0 +1,25 @@
+{
+ "parameters": {
+ "subscriptionId": "00000000-1111-2222-3333-444444444444",
+ "resourceGroupName": "rg1",
+ "policyName": "ddb1",
+ "groupName": "azureactivedirectory",
+ "api-version": "2020-03-01-preview"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/microsoft.aadiam/privateLinkForAzureAD/ddb1/privateLinkResources/azureactivedirectory",
+ "name": "azureactivedirectory",
+ "type": "microsoft.aadiam/privateLinkforAzureAD/privateLinkResources",
+ "properties": {
+ "groupId": "azureactivedirectory",
+ "requiredMembers": [
+ "authentication",
+ "nonauthentication"
+ ]
+ }
+ }
+ }
+ }
+}
diff --git a/specification/azureactivedirectory/resource-manager/Microsoft.Aadiam/preview/2020-03-01-preview/examples/AzureADPrivateLinkResourceListGet.json b/specification/azureactivedirectory/resource-manager/Microsoft.Aadiam/preview/2020-03-01-preview/examples/AzureADPrivateLinkResourceListGet.json
new file mode 100644
index 000000000000..60fe21893e83
--- /dev/null
+++ b/specification/azureactivedirectory/resource-manager/Microsoft.Aadiam/preview/2020-03-01-preview/examples/AzureADPrivateLinkResourceListGet.json
@@ -0,0 +1,29 @@
+{
+ "parameters": {
+ "subscriptionId": "00000000-1111-2222-3333-444444444444",
+ "resourceGroupName": "rg1",
+ "policyName": "ddb1",
+ "api-version": "2020-03-01-preview"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/microsoft.aadiam/privateLinkForAzureAD/ddb1/privateLinkResources/azureactivedirectory",
+ "name": "azureactivedirectory",
+ "type": "microsoft.aadiam/privateLinkforAzureAD/privateLinkResources",
+ "properties": {
+ "groupId": "azureactivedirectory",
+ "requiredMembers": [
+ "authentication",
+ "nonauthentication"
+ ]
+ }
+ }
+ ],
+ "nextLink": "null"
+ }
+ }
+ }
+}
diff --git a/specification/azureactivedirectory/resource-manager/Microsoft.Aadiam/preview/2020-03-01-preview/privateLinkForAzureAD.json b/specification/azureactivedirectory/resource-manager/Microsoft.Aadiam/preview/2020-03-01-preview/privateLinkForAzureAD.json
new file mode 100644
index 000000000000..28cedade989e
--- /dev/null
+++ b/specification/azureactivedirectory/resource-manager/Microsoft.Aadiam/preview/2020-03-01-preview/privateLinkForAzureAD.json
@@ -0,0 +1,480 @@
+{
+ "swagger": "2.0",
+ "info": {
+ "version": "2020-03-01-preview",
+ "title": "azureactivedirectory",
+ "description": "Private link Policy for Azure Active Directory."
+ },
+ "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.aadiam/privateLinkForAzureAd/{policyName}": {
+ "put": {
+ "tags": [
+ "privateLinkForAzureAd"
+ ],
+ "operationId": "privateLinkForAzureAd_Create",
+ "x-ms-long-running-operation": true,
+ "description": "Creates a private link policy.",
+ "x-ms-examples": {
+ "privateLinkPolicyCreate": {
+ "$ref": "./examples/AzureADPrivateLinkPolicyCreate.json"
+ },
+ "privateLinkPolicyMinCreate": {
+ "$ref": "./examples/AzureADPrivateLinkPolicyMinCreate.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/policyNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ },
+ {
+ "name": "privateLinkPolicy",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/privateLinkPolicy"
+ },
+ "description": "private link Policy supplied to the operation."
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Created -- Private Link Policy created.",
+ "schema": {
+ "$ref": "#/definitions/privateLinkPolicy"
+ }
+ },
+ "201": {
+ "description": "OK -- Private Link Policy is updated.",
+ "schema": {
+ "$ref": "#/definitions/privateLinkPolicy"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ }
+ },
+ "patch": {
+ "tags": [
+ "privateLinkForAzureAd"
+ ],
+ "operationId": "privateLinkForAzureAd_Update",
+ "description": "Updates private link policy tags with specified values.",
+ "x-ms-examples": {
+ "privateLinkPolicyUpdate": {
+ "$ref": "./examples/AzureADPrivateLinkPolicyUpdate.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/policyNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ },
+ {
+ "name": "privateLinkPolicy",
+ "in": "body",
+ "schema": {
+ "$ref": "#/definitions/privateLinkPolicyUpdateParameter"
+ },
+ "description": "Private Link Policy resource with the tags to be updated."
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK -- Private Link Policy tags are updated.",
+ "schema": {
+ "$ref": "#/definitions/privateLinkPolicy"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ }
+ },
+ "get": {
+ "tags": [
+ "privateLinkForAzureAd"
+ ],
+ "operationId": "privateLinkForAzureAd_Get",
+ "description": "Gets a private link policy with a given name.",
+ "x-ms-examples": {
+ "privateLinkPolicyGet": {
+ "$ref": "./examples/AzureADPrivateLinkPolicyGet.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/policyNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK -- Returns information about the private link policy.",
+ "schema": {
+ "$ref": "#/definitions/privateLinkPolicy"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "privateLinkForAzureAd"
+ ],
+ "operationId": "privateLinkForAzureAd_Delete",
+ "description": "Deletes a private link policy. When operation completes, status code 200 returned without content.",
+ "x-ms-examples": {
+ "privateLinkPolicyDelete": {
+ "$ref": "./examples/AzureADPrivateLinkPolicyDelete.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/policyNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK -- private link policy deleted."
+ },
+ "204": {
+ "description": "private link policy does not exist."
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/providers/microsoft.aadiam/privateLinkForAzureAd": {
+ "get": {
+ "tags": [
+ "privateLinkForAzureAd"
+ ],
+ "operationId": "privateLinkForAzureAd_ListBySubscription",
+ "description": "Lists all Private Link Policies For AzureAD in the given subscription.",
+ "x-ms-examples": {
+ "privateLinkPolicyListBySubscription": {
+ "$ref": "./examples/AzureADPrivateLinkPolicyListBySubscription.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK -- Returns a list of private link policies.",
+ "schema": {
+ "$ref": "#/definitions/privateLinkPolicyListResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.aadiam/privateLinkForAzureAd": {
+ "get": {
+ "tags": [
+ "privateLinkForAzureAd"
+ ],
+ "operationId": "privateLinkForAzureAd_List",
+ "x-ms-examples": {
+ "privateLinkPolicyGetList": {
+ "$ref": "./examples/AzureADPrivateLinkPolicyList.json"
+ }
+ },
+ "description": "Operation to return the list of Private Link Policies For AzureAD scoped to the resourceGroup.",
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successful request to get list of Private Links configuration objects For AzureAD.",
+ "schema": {
+ "$ref": "#/definitions/privateLinkPolicyListResult"
+ }
+ },
+ "default": {
+ "description": "Error, failed to get list of Private Links For AzureAD.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ }
+ }
+ }
+ },
+ "definitions": {
+ "privateLinkPolicyListResult": {
+ "description": "A list of private link policies",
+ "type": "object",
+ "properties": {
+ "value": {
+ "type": "array",
+ "description": "Array of private link policies",
+ "items": {
+ "$ref": "#/definitions/privateLinkPolicy"
+ }
+ },
+ "nextLink": {
+ "description": "The link used to get the next page of operations.",
+ "type": "string"
+ }
+ }
+ },
+ "privateLinkPolicy": {
+ "description": "PrivateLink Policy configuration object.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "Name of the Private Link Azure AD Policy.",
+ "type": "string"
+ },
+ "ownerTenantId": {
+ "description": "Guid of the owner tenant",
+ "type": "string"
+ },
+ "allTenants": {
+ "description": "Flag indicating whether all tenants are allowed",
+ "type": "boolean"
+ },
+ "tenants": {
+ "description": "The list of tenantIds.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "resourceName": {
+ "description": "Name of the private link policy resource",
+ "type": "string"
+ },
+ "subscriptionId": {
+ "description": "Subscription Identifier",
+ "type": "string"
+ },
+ "resourceGroup": {
+ "description": "Name of the resource group",
+ "type": "string"
+ },
+ "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": false,
+ "type": "string",
+ "description": "Name of this resource."
+ },
+ "type": {
+ "readOnly": true,
+ "type": "string",
+ "description": "Type of this resource."
+ }
+ }
+ },
+ "privateLinkPolicyUpdateParameter": {
+ "type": "object",
+ "description": "private Link policy parameters to be updated. ",
+ "properties": {
+ "tags": {
+ "type": "object",
+ "description": "Resource tags to be updated.",
+ "additionalProperties": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "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": {
+ "subscriptionIdParameter": {
+ "name": "subscriptionId",
+ "in": "path",
+ "description": "Azure subscription ID.",
+ "required": true,
+ "type": "string",
+ "x-ms-parameter-location": "client"
+ },
+ "apiVersionParameter": {
+ "name": "api-version",
+ "in": "query",
+ "required": true,
+ "type": "string",
+ "x-ms-parameter-location": "client",
+ "description": "Version of the API to be used with the client request."
+ },
+ "resourceGroupNameParameter": {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "pattern": "^[-\\w\\._\\(\\)]+$",
+ "minLength": 1,
+ "maxLength": 90,
+ "x-ms-parameter-location": "method",
+ "description": "Name of an Azure resource group."
+ },
+ "policyNameParameter": {
+ "name": "policyName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "x-ms-parameter-location": "method",
+ "description": "The name of the private link policy in Azure AD."
+ }
+ }
+}
diff --git a/specification/azureactivedirectory/resource-manager/Microsoft.Aadiam/preview/2020-03-01-preview/privateLinkResources.json b/specification/azureactivedirectory/resource-manager/Microsoft.Aadiam/preview/2020-03-01-preview/privateLinkResources.json
new file mode 100644
index 000000000000..dcd0d05e2ce0
--- /dev/null
+++ b/specification/azureactivedirectory/resource-manager/Microsoft.Aadiam/preview/2020-03-01-preview/privateLinkResources.json
@@ -0,0 +1,268 @@
+{
+ "swagger": "2.0",
+ "info": {
+ "version": "2020-03-01-preview",
+ "title": "azureactivedirectory",
+ "description": "Azure Active Directory Client."
+ },
+ "host": "management.azure.com",
+ "schemes": [
+ "https"
+ ],
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "security": [
+ {
+ "azure_auth": [
+ "user_impersonation"
+ ]
+ }
+ ],
+ "securityDefinitions": {
+ "azure_auth": {
+ "type": "oauth2",
+ "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize",
+ "flow": "implicit",
+ "description": "Azure Active Directory OAuth2 Flow",
+ "scopes": {
+ "user_impersonation": "impersonate your user account"
+ }
+ }
+ },
+ "paths": {
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.aadiam/privateLinkForAzureAd/{policyName}/privateLinkResources": {
+ "get": {
+ "tags": [
+ "PrivateLinkResources"
+ ],
+ "description": "Gets the private link resources that need to be created for a policy of AzureAD.",
+ "operationId": "PrivateLinkResources_ListByPrivateLinkPolicy",
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/policyNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successfully retrieved private link resources.",
+ "schema": {
+ "$ref": "#/definitions/PrivateLinkResourceListResult"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Gets private endpoint connection.": {
+ "$ref": "./examples/AzureADPrivateLinkResourceListGet.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.aadiam/privateLinkForAzureAd/{policyName}/privateLinkResources/{groupName}": {
+ "get": {
+ "tags": [
+ "PrivateLinkResources"
+ ],
+ "description": "Gets the private link resources that need to be created for a policy of AzureAD.",
+ "operationId": "PrivateLinkResources_Get",
+ "parameters": [
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/policyNameParameter"
+ },
+ {
+ "$ref": "#/parameters/groupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successfully retrieved a specified private link resource.",
+ "schema": {
+ "$ref": "#/definitions/PrivateLinkResource"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Gets private endpoint connection.": {
+ "$ref": "./examples/AzureADPrivateLinkResourceGet.json"
+ }
+ }
+ }
+ }
+ },
+ "definitions": {
+ "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
+ }
+ }
+ },
+ "PrivateLinkResourceListResult": {
+ "description": "A list of private link resources",
+ "type": "object",
+ "properties": {
+ "value": {
+ "type": "array",
+ "description": "Array of private link resources",
+ "items": {
+ "$ref": "#/definitions/PrivateLinkResource"
+ }
+ },
+ "nextLink": {
+ "description": "The link used to get the next page of operations.",
+ "type": "string"
+ }
+ }
+ },
+ "PrivateLinkResource": {
+ "description": "A private link resource",
+ "type": "object",
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/PrivateLinkResourceProperties",
+ "description": "Resource properties.",
+ "x-ms-client-flatten": true
+ }
+ },
+ "allOf": [
+ {
+ "$ref": "#/definitions/ARMProxyResource"
+ }
+ ]
+ },
+ "PrivateLinkResourceProperties": {
+ "description": "Properties of a private link resource.",
+ "type": "object",
+ "properties": {
+ "groupId": {
+ "description": "The private link resource group id.",
+ "type": "string",
+ "readOnly": true
+ },
+ "requiredMembers": {
+ "description": "The private link resource required member names.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "readOnly": true
+ }
+ }
+ },
+ "ARMProxyResource": {
+ "type": "object",
+ "description": "The resource model definition for a ARM proxy resource. It will have everything other than required location and tags",
+ "properties": {
+ "id": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The unique resource identifier of the Azure AD PrivateLink Policy."
+ },
+ "name": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The name of the Azure AD PrivateLink Policy."
+ },
+ "type": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The type of Azure resource."
+ }
+ },
+ "x-ms-azure-resource": true
+ }
+ },
+ "parameters": {
+ "subscriptionIdParameter": {
+ "name": "subscriptionId",
+ "in": "path",
+ "description": "Azure subscription ID.",
+ "required": true,
+ "type": "string",
+ "x-ms-parameter-location": "client"
+ },
+ "apiVersionParameter": {
+ "name": "api-version",
+ "in": "query",
+ "required": true,
+ "type": "string",
+ "description": "Version of the API to be used with the client request."
+ },
+ "resourceGroupNameParameter": {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "pattern": "^[-\\w\\._\\(\\)]+$",
+ "minLength": 1,
+ "maxLength": 90,
+ "x-ms-parameter-location": "method",
+ "description": "Name of an Azure resource group."
+ },
+ "groupNameParameter": {
+ "name": "groupName",
+ "in": "path",
+ "description": "The name of the private link resource.",
+ "required": true,
+ "x-ms-parameter-location": "method",
+ "type": "string"
+ },
+ "policyNameParameter": {
+ "name": "policyName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the private link policy in Azure AD.",
+ "x-ms-parameter-location": "method"
+ }
+ }
+}
diff --git a/specification/azureactivedirectory/resource-manager/Microsoft.Aadiam/preview/2020-07-01-preview/azureADMetrics.json b/specification/azureactivedirectory/resource-manager/Microsoft.Aadiam/preview/2020-07-01-preview/azureADMetrics.json
new file mode 100644
index 000000000000..1111208831f3
--- /dev/null
+++ b/specification/azureactivedirectory/resource-manager/Microsoft.Aadiam/preview/2020-07-01-preview/azureADMetrics.json
@@ -0,0 +1,432 @@
+{
+ "swagger": "2.0",
+ "info": {
+ "version": "2020-07-01-preview",
+ "title": "azureactivedirectory",
+ "description": "Metrics and Alerts for Azure Active Directory."
+ },
+ "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.aadiam/azureADMetrics/{azureADMetricsName}": {
+ "put": {
+ "tags": [
+ "azureADMetrics"
+ ],
+ "operationId": "azureADMetrics_CreateOrUpdate",
+ "x-ms-long-running-operation": true,
+ "description": "Creates a azureADMetrics instance.",
+ "x-ms-examples": {
+ "azureADMetricsCreate": {
+ "$ref": "./examples/AzureADMetricsCreateOrUpdate.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "../2020-03-01-preview/privateLinkForAzureAD.json#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/azureADMetricsNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ },
+ {
+ "name": "azureADMetricsConfig",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/azureADMetricsConfig"
+ },
+ "description": "AzureADMetrics definition supplied to the operation."
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK -- AzureADMetrics instance is updated.",
+ "schema": {
+ "$ref": "#/definitions/azureADMetricsConfig"
+ }
+ },
+ "201": {
+ "description": "Created -- AzureADMetrics instance created.",
+ "schema": {
+ "$ref": "#/definitions/azureADMetricsConfig"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ }
+ },
+ "patch": {
+ "tags": [
+ "azureADMetrics"
+ ],
+ "operationId": "azureADMetrics_Update",
+ "description": "Updates azureADMetrics tags with specified values.",
+ "x-ms-examples": {
+ "azureADMetricsUpdate": {
+ "$ref": "./examples/AzureADMetricsUpdate.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "../2020-03-01-preview/privateLinkForAzureAD.json#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/azureADMetricsNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ },
+ {
+ "name": "azureADMetricsConfig",
+ "in": "body",
+ "schema": {
+ "$ref": "#/definitions/azureADMetricsUpdateParameter"
+ },
+ "description": "AzureADMetrics resource with the tags to be updated."
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK -- AzureADMetrics tags are updated.",
+ "schema": {
+ "$ref": "#/definitions/azureADMetricsConfig"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ }
+ },
+ "get": {
+ "tags": [
+ "azureADMetrics"
+ ],
+ "operationId": "azureADMetrics_Get",
+ "description": "Gets a azureADMetrics instance with a given name.",
+ "x-ms-examples": {
+ "azureADMetricsGet": {
+ "$ref": "./examples/AzureADMetricsGet.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "../2020-03-01-preview/privateLinkForAzureAD.json#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/azureADMetricsNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK -- Returns information about the azureADMetrics resource.",
+ "schema": {
+ "$ref": "#/definitions/azureADMetricsConfig"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "azureADMetrics"
+ ],
+ "operationId": "azureADMetrics_Delete",
+ "description": "Deletes a AzureADMetrics resource. When operation completes, status code 200 returned without content.",
+ "x-ms-examples": {
+ "azureADMetricsDelete": {
+ "$ref": "./examples/AzureADMetricsDelete.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "../2020-03-01-preview/privateLinkForAzureAD.json#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/azureADMetricsNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK -- azureADMetrics resource deleted."
+ },
+ "204": {
+ "description": "azureADMetrics does not exist."
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/providers/microsoft.aadiam/azureADMetrics": {
+ "get": {
+ "tags": [
+ "azureADMetrics"
+ ],
+ "operationId": "azureADMetrics_ListBySubscription",
+ "description": "Lists all AzureADMetrics resources in the given subscription.",
+ "x-ms-examples": {
+ "azureADMetricsListBySubscription": {
+ "$ref": "./examples/AzureADMetricsListBySubscription.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "../2020-03-01-preview/privateLinkForAzureAD.json#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK -- Returns a list azureADMetrics resources.",
+ "schema": {
+ "$ref": "#/definitions/azureADMetricsListResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.aadiam/azureADMetrics": {
+ "get": {
+ "tags": [
+ "azureADMetrics"
+ ],
+ "operationId": "azureADMetrics_List",
+ "x-ms-examples": {
+ "azureADMetricsGetList": {
+ "$ref": "./examples/AzureADMetricsList.json"
+ }
+ },
+ "description": "Operation to return the list of AzureADMetrics resources scoped to the resourceGroup.",
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "parameters": [
+ {
+ "$ref": "../2020-03-01-preview/privateLinkForAzureAD.json#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successful request to get list of AzureADMetrics resources For AzureAD.",
+ "schema": {
+ "$ref": "#/definitions/azureADMetricsListResult"
+ }
+ },
+ "default": {
+ "description": "Error, failed to get list of AzureADMetrics resources.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ }
+ }
+ }
+ },
+ "definitions": {
+ "azureADMetricsListResult": {
+ "description": "A list of AzureADMetrics resources",
+ "type": "object",
+ "properties": {
+ "value": {
+ "type": "array",
+ "description": "Array of AzureADMetrics resources.",
+ "items": {
+ "$ref": "#/definitions/azureADMetricsConfig"
+ },
+ "readOnly": true
+ },
+ "nextLink": {
+ "description": "The link used to get the next page of operations.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "azureADMetricsConfig": {
+ "description": "AzureADMetrics resource.",
+ "type": "object",
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/AzureADMetricsPropertiesFormat"
+ }
+ },
+ "allOf": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/TrackedResource"
+ }
+ ]
+ },
+ "AzureADMetricsPropertiesFormat": {
+ "properties": {
+ "provisioningState": {
+ "type": "string",
+ "description": "The provisioning state of the resource.",
+ "enum": [
+ "Succeeded",
+ "Created",
+ "Failed"
+ ],
+ "x-ms-enum": {
+ "name": "ProvisioningState",
+ "modelAsString": true
+ },
+ "readOnly": true
+ }
+ }
+ },
+ "azureADMetricsUpdateParameter": {
+ "type": "object",
+ "description": "AzureADMetrics parameters to be updated. ",
+ "properties": {
+ "tags": {
+ "type": "object",
+ "description": "Resource tags to be updated.",
+ "additionalProperties": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "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": {
+ "apiVersionParameter": {
+ "name": "api-version",
+ "in": "query",
+ "required": true,
+ "type": "string",
+ "x-ms-parameter-location": "client",
+ "description": "Version of the API to be used with the client request."
+ },
+ "resourceGroupNameParameter": {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "pattern": "^[-\\w\\._\\(\\)]+$",
+ "minLength": 1,
+ "maxLength": 90,
+ "x-ms-parameter-location": "method",
+ "description": "Name of an Azure resource group."
+ },
+ "azureADMetricsNameParameter": {
+ "name": "azureADMetricsName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "x-ms-parameter-location": "method",
+ "description": "Name of the azureADMetrics instance."
+ }
+ }
+}
diff --git a/specification/azureactivedirectory/resource-manager/Microsoft.Aadiam/preview/2020-07-01-preview/examples/AzureADMetricsCreateOrUpdate.json b/specification/azureactivedirectory/resource-manager/Microsoft.Aadiam/preview/2020-07-01-preview/examples/AzureADMetricsCreateOrUpdate.json
new file mode 100644
index 000000000000..5c9e06214b75
--- /dev/null
+++ b/specification/azureactivedirectory/resource-manager/Microsoft.Aadiam/preview/2020-07-01-preview/examples/AzureADMetricsCreateOrUpdate.json
@@ -0,0 +1,38 @@
+{
+ "parameters": {
+ "subscriptionId": "00000000-1111-2222-3333-444444444444",
+ "resourceGroupName": "rg1",
+ "azureADMetricsName": "ddb1",
+ "api-version": "2020-07-01-preview",
+ "azureADMetricsConfig": {
+ "location": "West US",
+ "tags": {}
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/rg1/providers/Microsoft.Aadiam/azureADMetrics/ddb1",
+ "location": "West US",
+ "name": "ddb1",
+ "properties": {
+ "provisioningState": "Succeeded"
+ },
+ "tags": {},
+ "type": "Microsoft.Aadiam/azureADMetrics"
+ }
+ },
+ "201": {
+ "body": {
+ "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/rg1/providers/Microsoft.Aadiam/azureADMetrics/ddb1",
+ "location": "West US",
+ "name": "ddb1",
+ "properties": {
+ "provisioningState": "Created"
+ },
+ "tags": {},
+ "type": "Microsoft.Aadiam/azureADMetrics"
+ }
+ }
+ }
+}
diff --git a/specification/azureactivedirectory/resource-manager/Microsoft.Aadiam/preview/2020-07-01-preview/examples/AzureADMetricsDelete.json b/specification/azureactivedirectory/resource-manager/Microsoft.Aadiam/preview/2020-07-01-preview/examples/AzureADMetricsDelete.json
new file mode 100644
index 000000000000..87571e561014
--- /dev/null
+++ b/specification/azureactivedirectory/resource-manager/Microsoft.Aadiam/preview/2020-07-01-preview/examples/AzureADMetricsDelete.json
@@ -0,0 +1,12 @@
+{
+ "parameters": {
+ "subscriptionId": "00000000-1111-2222-3333-444444444444",
+ "resourceGroupName": "rg1",
+ "azureADMetricsName": "ddb1",
+ "api-version": "2020-07-01-preview"
+ },
+ "responses": {
+ "200": {},
+ "204": {}
+ }
+}
diff --git a/specification/azureactivedirectory/resource-manager/Microsoft.Aadiam/preview/2020-07-01-preview/examples/AzureADMetricsGet.json b/specification/azureactivedirectory/resource-manager/Microsoft.Aadiam/preview/2020-07-01-preview/examples/AzureADMetricsGet.json
new file mode 100644
index 000000000000..8dbfdc69b9d7
--- /dev/null
+++ b/specification/azureactivedirectory/resource-manager/Microsoft.Aadiam/preview/2020-07-01-preview/examples/AzureADMetricsGet.json
@@ -0,0 +1,22 @@
+{
+ "parameters": {
+ "subscriptionId": "00000000-1111-2222-3333-444444444444",
+ "resourceGroupName": "rg1",
+ "azureADMetricsName": "ddb1",
+ "api-version": "2020-07-01-preview"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/rg1/providers/Microsoft.Aadiam/azureADMetrics/ddb1",
+ "name": "ddb1",
+ "location": "West US",
+ "properties": {
+ "provisioningState": "Succeeded"
+ },
+ "tags": {},
+ "type": "Microsoft.Aadiam/azureADMetrics"
+ }
+ }
+ }
+}
diff --git a/specification/azureactivedirectory/resource-manager/Microsoft.Aadiam/preview/2020-07-01-preview/examples/AzureADMetricsList.json b/specification/azureactivedirectory/resource-manager/Microsoft.Aadiam/preview/2020-07-01-preview/examples/AzureADMetricsList.json
new file mode 100644
index 000000000000..519c5cc740f1
--- /dev/null
+++ b/specification/azureactivedirectory/resource-manager/Microsoft.Aadiam/preview/2020-07-01-preview/examples/AzureADMetricsList.json
@@ -0,0 +1,24 @@
+{
+ "parameters": {
+ "subscriptionId": "00000000-1111-2222-3333-444444444444",
+ "resourceGroupName": "rg1",
+ "api-version": "2020-07-01-preview"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/rg1/providers/Microsoft.Aadiam/azureADMetrics/ddb1",
+ "name": "ddb1",
+ "location": "West US",
+ "properties": {
+ "provisioningState": "Succeeded"
+ },
+ "type": "Microsoft.Aadiam/azureADMetrics"
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/azureactivedirectory/resource-manager/Microsoft.Aadiam/preview/2020-07-01-preview/examples/AzureADMetricsListBySubscription.json b/specification/azureactivedirectory/resource-manager/Microsoft.Aadiam/preview/2020-07-01-preview/examples/AzureADMetricsListBySubscription.json
new file mode 100644
index 000000000000..f8bf57a8f2be
--- /dev/null
+++ b/specification/azureactivedirectory/resource-manager/Microsoft.Aadiam/preview/2020-07-01-preview/examples/AzureADMetricsListBySubscription.json
@@ -0,0 +1,23 @@
+{
+ "parameters": {
+ "subscriptionId": "00000000-1111-2222-3333-444444444444",
+ "api-version": "2020-07-01-preview"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/rg1/providers/Microsoft.Aadiam/azureADMetrics/ddb1",
+ "name": "ddb1",
+ "location": "West US",
+ "properties": {
+ "provisioningState": "Succeeded"
+ },
+ "type": "Microsoft.Aadiam/azureADMetrics"
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/azureactivedirectory/resource-manager/Microsoft.Aadiam/preview/2020-07-01-preview/examples/AzureADMetricsUpdate.json b/specification/azureactivedirectory/resource-manager/Microsoft.Aadiam/preview/2020-07-01-preview/examples/AzureADMetricsUpdate.json
new file mode 100644
index 000000000000..bc7f75389954
--- /dev/null
+++ b/specification/azureactivedirectory/resource-manager/Microsoft.Aadiam/preview/2020-07-01-preview/examples/AzureADMetricsUpdate.json
@@ -0,0 +1,26 @@
+{
+ "parameters": {
+ "subscriptionId": "00000000-1111-2222-3333-444444444444",
+ "resourceGroupName": "rg1",
+ "azureADMetricsName": "ddb1",
+ "api-version": "2020-07-01-preview",
+ "location": "West US",
+ "azureADMetricsConfig": {
+ "tags": {}
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/rg1/providers/Microsoft.Aadiam/azureADMetrics/ddb1",
+ "location": "West US",
+ "name": "ddb1",
+ "properties": {
+ "provisioningState": "Succeeded"
+ },
+ "tags": {},
+ "type": "Microsoft.Aadiam/azureADMetrics"
+ }
+ }
+ }
+}
diff --git a/specification/azureactivedirectory/resource-manager/readme.md b/specification/azureactivedirectory/resource-manager/readme.md
index b1d96fb51aa0..46fe420e432e 100644
--- a/specification/azureactivedirectory/resource-manager/readme.md
+++ b/specification/azureactivedirectory/resource-manager/readme.md
@@ -24,20 +24,58 @@ For other options on installation see [Installing AutoRest](https://aka.ms/autor
These are the global settings for the azureactivedirectory.
-```yaml
+``` yaml
openapi-type: arm
-tag: package-2017-04-01
+tag: package-preview-2020-07
+```
+
+### Tag: package-preview-2020-07
+
+These settings apply only when `--tag=package-preview-2020-07` is specified on the command line.
+
+```yaml $(tag) == 'package-preview-2020-07'
+input-file:
+ - Microsoft.Aadiam/preview/2020-07-01-preview/azureADMetrics.json
+```
+
+### Tag: package-preview-2020-03
+
+These settings apply only when `--tag=package-preview-2020-03` is specified on the command line.
+
+```yaml $(tag) == 'package-preview-2020-07'
+input-file:
+ - Microsoft.Aadiam/preview/2020-03-01-preview/privateLinkForAzureAD.json
+ - Microsoft.Aadiam/preview/2020-03-01-preview/privateLinkResources.json
```
### Tag: package-2017-04-01
These settings apply only when `--tag=package-2017-04-01` is specified on the command line.
-```yaml $(tag) == 'package-2017-04-01'
+``` yaml $(tag) == 'package-2017-04-01'
input-file:
- Microsoft.Aadiam/stable/2017-04-01/azureactivedirectory.json
```
+## Suppression
+``` yaml
+directive:
+ - suppress: BodyTopLevelProperties
+ from: azureADMetrics.json
+ where: $.definitions.azureADMetricsConfig.properties
+ - suppress: BodyTopLevelProperties
+ from: privateLinkForAzureAD.json
+ where: $.definitions.privateLinkPolicy.properties
+ - suppress: RequiredPropertiesMissingInResourceModel
+ from: azureADMetrics.json
+ where: $.definitions.azureADMetricsConfig
+ - suppress: RequiredPropertiesMissingInResourceModel
+ from: privateLinkForAzureAD.json
+ where: $.definitions.privateLinkPolicy
+ - suppress: R3020
+ - suppress: R3023
+```
+
---
# Code Generation
@@ -47,7 +85,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-net
- repo: azure-sdk-for-python
@@ -79,7 +117,7 @@ See configuration in [readme.typescript.md](./readme.typescript.md)
See configuration in [readme.csharp.md](./readme.csharp.md)
-## Multi-API/Profile support for AutoRest v3 generators
+## Multi-API/Profile support for AutoRest v3 generators
AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files.
@@ -92,14 +130,17 @@ require: $(this-folder)/../../../profiles/readme.md
# all the input files across all versions
input-file:
- $(this-folder)/Microsoft.Aadiam/stable/2017-04-01/azureactivedirectory.json
+ - $(this-folder)/Microsoft.Aadiam/preview/2020-07-01-preview/azureADMetrics.json
+ - $(this-folder)/Microsoft.Aadiam/preview/2020-03-01-preview/privateLinkForAzureAD.json
+ - $(this-folder)/Microsoft.Aadiam/preview/2020-03-01-preview/privateLinkResources.json
+
```
-If there are files that should not be in the `all-api-versions` set,
+If there are files that should not be in the `all-api-versions` set,
uncomment the `exclude-file` section below and add the file paths.
``` yaml $(tag) == 'all-api-versions'
#exclude-file:
# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json
```
-
diff --git a/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2019-07-24-preview/azuredata.json b/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2019-07-24-preview/azuredata.json
index 85331f97bdb1..86241df72903 100644
--- a/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2019-07-24-preview/azuredata.json
+++ b/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2019-07-24-preview/azuredata.json
@@ -856,6 +856,294 @@
}
}
},
+ "/subscriptions/{subscriptionId}/providers/Microsoft.AzureData/sqlServerInstances": {
+ "get": {
+ "tags": [
+ "SqlServerInstances"
+ ],
+ "operationId": "SqlServerInstances_List",
+ "summary": "List sqlServerInstance resources in the subscription",
+ "parameters": [
+ {
+ "$ref": "#/parameters/subscriptionId"
+ },
+ {
+ "$ref": "#/parameters/apiVersion"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/SqlServerInstanceListResult"
+ }
+ },
+ "default": {
+ "description": "*** Error Responses: ***\n\n * 400 InvalidParameterValue - An invalid value was given to parameter.\n\n * 400 InvalidCrossSubscriptionVmMove - Invalid cross subscription move of resource.\n\n * 404 ResourceNotFound - The requested resource was not found.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-examples": {
+ "Gets all SQL Server Instance in a subscription.": {
+ "$ref": "./examples/ListSubscriptionSqlServerInstance.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureData/sqlServerInstances": {
+ "get": {
+ "tags": [
+ "SqlServerInstances"
+ ],
+ "operationId": "SqlServerInstances_ListByResourceGroup",
+ "description": "Gets all sqlServerInstances in a resource group.",
+ "summary": "List sqlServerInstance resources in the resource group",
+ "parameters": [
+ {
+ "$ref": "#/parameters/subscriptionId"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupName"
+ },
+ {
+ "$ref": "#/parameters/apiVersion"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/SqlServerInstanceListResult"
+ }
+ },
+ "default": {
+ "description": "*** Error Responses: ***",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-examples": {
+ "Gets all SQL Server Instance in a resource group.": {
+ "$ref": "./examples/ListByResourceGroupSqlServerInstance.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureData/sqlServerInstances/{sqlServerInstanceName}": {
+ "get": {
+ "tags": [
+ "SqlServerInstances"
+ ],
+ "operationId": "SqlServerInstances_Get",
+ "description": "Retrieves a SQL Server Instance resource",
+ "parameters": [
+ {
+ "$ref": "#/parameters/subscriptionId"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupName"
+ },
+ {
+ "name": "sqlServerInstanceName",
+ "description": "Name of SQL Server Instance",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "x-ms-parameter-location": "method"
+ },
+ {
+ "$ref": "#/parameters/apiVersion"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/SqlServerInstance"
+ }
+ },
+ "default": {
+ "description": "*** Error Responses: ***",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Updates a SQL Server Instance tags.": {
+ "$ref": "./examples/GetSqlServerInstance.json"
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "SqlServerInstances"
+ ],
+ "operationId": "SqlServerInstances_Create",
+ "description": "Creates or replaces a SQL Server Instance resource",
+ "parameters": [
+ {
+ "$ref": "#/parameters/subscriptionId"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupName"
+ },
+ {
+ "name": "sqlServerInstanceName",
+ "description": "The name of SQL Server Instance",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "x-ms-parameter-location": "method"
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "description": "The SQL Server Instance to be created or updated.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/SqlServerInstance"
+ }
+ },
+ {
+ "$ref": "#/parameters/apiVersion"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/SqlServerInstance"
+ }
+ },
+ "201": {
+ "description": "Created",
+ "schema": {
+ "$ref": "#/definitions/SqlServerInstance"
+ }
+ },
+ "default": {
+ "description": "*** Error Responses: ***",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Updates a SQL Server Instance tags.": {
+ "$ref": "./examples/CreateOrUpdateSqlServerInstance.json"
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "SqlServerInstances"
+ ],
+ "operationId": "SqlServerInstances_Delete",
+ "description": "Deletes a SQL Server Instance resource",
+ "parameters": [
+ {
+ "$ref": "#/parameters/subscriptionId"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupName"
+ },
+ {
+ "name": "sqlServerInstanceName",
+ "description": "The name of SQL Server Instance",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "x-ms-parameter-location": "method"
+ },
+ {
+ "$ref": "#/parameters/apiVersion"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successfully deleted the SQL Server Instance."
+ },
+ "default": {
+ "description": "*** Error Responses: ***",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ },
+ "204": {
+ "description": "The specified SQL Server Instance does not exist."
+ }
+ },
+ "x-ms-examples": {
+ "Delete a SQL Server Instance.": {
+ "$ref": "./examples/DeleteSqlServerInstance.json"
+ }
+ }
+ },
+ "patch": {
+ "tags": [
+ "SqlServerInstances"
+ ],
+ "operationId": "SqlServerInstances_Update",
+ "description": "Updates a SQL Server Instance resource",
+ "parameters": [
+ {
+ "$ref": "#/parameters/subscriptionId"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupName"
+ },
+ {
+ "name": "sqlServerInstanceName",
+ "description": "Name of sqlServerInstance",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "x-ms-parameter-location": "method"
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "description": "The SQL Server Instance.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/SqlServerInstanceUpdate"
+ }
+ },
+ {
+ "$ref": "#/parameters/apiVersion"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/SqlServerInstance"
+ }
+ },
+ "default": {
+ "description": "*** Error Responses: ***",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Updates a SQL Server Instance tags.": {
+ "$ref": "./examples/UpdateSqlServerInstance.json"
+ }
+ }
+ }
+ },
"/subscriptions/{subscriptionId}/providers/Microsoft.AzureData/postgresInstances": {
"get": {
"tags": [
@@ -1984,6 +2272,97 @@
}
}
},
+ "SqlServerInstanceProperties": {
+ "description": "Properties of SqlServerInstance.",
+ "type": "object",
+ "properties": {
+ "version": {
+ "type": "string",
+ "description": "SQL Server version."
+ },
+ "edition": {
+ "type": "string",
+ "description": "SQL Server edition."
+ },
+ "containerResourceId": {
+ "type": "string",
+ "description": "ARM Resource id of the container resource (Azure Arc for Servers)"
+ },
+ "createTime": {
+ "type": "string",
+ "description": "The time when the resource was created.",
+ "readOnly": true
+ },
+ "updateTime": {
+ "type": "string",
+ "description": "The time when the resource was last updated.",
+ "readOnly": true
+ },
+ "vCore": {
+ "type": "string",
+ "description": "The number of logical processors used by the SQL Server instance."
+ },
+ "status": {
+ "type": "string",
+ "description": "The cloud connectivity status."
+ }
+ },
+ "required": [
+ "version",
+ "edition",
+ "containerResourceId",
+ "vCore",
+ "status"
+ ]
+ },
+ "SqlServerInstance": {
+ "description": "A SqlServerInstance.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/TrackedResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/SqlServerInstanceProperties",
+ "description": "null",
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "SqlServerInstanceUpdate": {
+ "description": "An update to a SQL Server Instance.",
+ "type": "object",
+ "properties": {
+ "tags": {
+ "description": "Resource tags.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "SqlServerInstanceListResult": {
+ "description": "A list of SqlServerInstance.",
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "Array of results.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/SqlServerInstance"
+ },
+ "readOnly": true
+ },
+ "nextLink": {
+ "description": "Link to retrieve next page of results.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
"HybridDataManagerProperties": {
"description": "Hybrid data manager properties",
"type": "object"
@@ -2184,6 +2563,14 @@
"type": "string",
"x-ms-parameter-location": "method"
},
+ "SqlServerInstanceNameParameter": {
+ "in": "path",
+ "name": "sqlServerInstanceName",
+ "description": "The name of the resource.",
+ "required": true,
+ "type": "string",
+ "x-ms-parameter-location": "method"
+ },
"HybridDataManagerNameParameter": {
"in": "path",
"name": "hybridDataManagerName",
diff --git a/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2019-07-24-preview/examples/CreateOrUpdateSqlServerInstance.json b/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2019-07-24-preview/examples/CreateOrUpdateSqlServerInstance.json
new file mode 100644
index 000000000000..fff63fffd1b8
--- /dev/null
+++ b/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2019-07-24-preview/examples/CreateOrUpdateSqlServerInstance.json
@@ -0,0 +1,63 @@
+{
+ "parameters": {
+ "subscriptionId": "00000000-1111-2222-3333-444444444444",
+ "resourceGroupName": "testrg",
+ "sqlServerInstanceName": "testsqlServerInstance",
+ "api-version": "2017-07-24",
+ "parameters": {
+ "location": "northeurope",
+ "tags": {
+ "mytag": "myval"
+ },
+ "properties": {
+ "version": "SQL Server 2017",
+ "edition": "Developer",
+ "containerResourceId": "Arc Machine Name",
+ "vCore": "4",
+ "status": "Connected"
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "properties": {
+ "version": "SQL Server 2017",
+ "edition": "Developer",
+ "containerResourceId": "Arc Machine Name",
+ "createTime": "01/01/2020 01:01:01",
+ "updateTime": "01/01/2020 01:01:01",
+ "vCore": "4",
+ "status": "Connected"
+ },
+ "location": "northeurope",
+ "tags": {
+ "mytag": "myval"
+ },
+ "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureData/SqlServerInstances/testsqlServerInstance",
+ "name": "testsqlServerInstance",
+ "type": "Microsoft.AzureData/SqlServerInstances"
+ }
+ },
+ "201": {
+ "body": {
+ "properties": {
+ "version": "SQL Server 2017",
+ "edition": "Developer",
+ "containerResourceId": "Arc Machine Name",
+ "createTime": "01/01/2020 01:01:01",
+ "updateTime": "01/01/2020 01:01:01",
+ "vCore": "4",
+ "status": "Connected"
+ },
+ "location": "northeurope",
+ "tags": {
+ "mytag": "myval"
+ },
+ "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureData/SqlServerInstances/testsqlServerInstance",
+ "name": "testsqlServerInstance",
+ "type": "Microsoft.AzureData/SqlServerInstances"
+ }
+ }
+ }
+}
diff --git a/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2019-07-24-preview/examples/DeleteSqlServerInstance.json b/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2019-07-24-preview/examples/DeleteSqlServerInstance.json
new file mode 100644
index 000000000000..25be3d7479ed
--- /dev/null
+++ b/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2019-07-24-preview/examples/DeleteSqlServerInstance.json
@@ -0,0 +1,12 @@
+{
+ "parameters": {
+ "subscriptionId": "00000000-1111-2222-3333-444444444444",
+ "resourceGroupName": "testrg",
+ "sqlServerInstanceName": "testsqlServerInstance",
+ "api-version": "2017-07-24"
+ },
+ "responses": {
+ "200": {},
+ "204": {}
+ }
+}
diff --git a/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2019-07-24-preview/examples/GetSqlServerInstance.json b/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2019-07-24-preview/examples/GetSqlServerInstance.json
new file mode 100644
index 000000000000..b45f1e0e3995
--- /dev/null
+++ b/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2019-07-24-preview/examples/GetSqlServerInstance.json
@@ -0,0 +1,30 @@
+{
+ "parameters": {
+ "subscriptionId": "00000000-1111-2222-3333-444444444444",
+ "resourceGroupName": "testrg",
+ "sqlServerInstanceName": "testsqlServerInstance",
+ "api-version": "2017-07-24"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "properties": {
+ "version": "SQL Server 2017",
+ "edition": "Developer",
+ "containerResourceId": "Arc Machine Name",
+ "createTime": "01/01/2020 01:01:01",
+ "updateTime": "01/01/2020 01:01:01",
+ "vCore": "4",
+ "status": "Connected"
+ },
+ "location": "northeurope",
+ "tags": {
+ "mytag": "myval"
+ },
+ "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureData/SqlServerInstances/testsqlServerInstance",
+ "name": "testsqlServerInstance",
+ "type": "Microsoft.AzureData/SqlServerInstances"
+ }
+ }
+ }
+}
diff --git a/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2019-07-24-preview/examples/ListByResourceGroupSqlServerInstance.json b/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2019-07-24-preview/examples/ListByResourceGroupSqlServerInstance.json
new file mode 100644
index 000000000000..67ea60097317
--- /dev/null
+++ b/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2019-07-24-preview/examples/ListByResourceGroupSqlServerInstance.json
@@ -0,0 +1,51 @@
+{
+ "parameters": {
+ "subscriptionId": "00000000-1111-2222-3333-444444444444",
+ "resourceGroupName": "testrg",
+ "api-version": "2017-07-24"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "properties": {
+ "version": "SQL Server 2017",
+ "edition": "Developer",
+ "containerResourceId": "Arc Machine Name",
+ "createTime": "01/01/2020 01:01:01",
+ "updateTime": "01/01/2020 01:01:01",
+ "vCore": "4",
+ "status": "Connected"
+ },
+ "location": "northeurope",
+ "tags": {
+ "mytag": "myval"
+ },
+ "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureData/SqlServerInstances/sqlServerInstance1",
+ "name": "sqlServerInstance1",
+ "type": "Microsoft.AzureData/SqlServerInstances"
+ },
+ {
+ "properties": {
+ "version": "SQL Server 2017",
+ "edition": "Developer",
+ "containerResourceId": "Arc Machine Name",
+ "createTime": "01/01/2020 01:01:01",
+ "updateTime": "01/01/2020 01:01:01",
+ "vCore": "4",
+ "status": "Connected"
+ },
+ "location": "northeurope",
+ "tags": {
+ "mytag": "myval"
+ },
+ "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureData/SqlServerInstances/sqlServerInstance2",
+ "name": "sqlServerInstance2",
+ "type": "Microsoft.AzureData/SqlServerInstances"
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2019-07-24-preview/examples/ListSubscriptionSqlServerInstance.json b/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2019-07-24-preview/examples/ListSubscriptionSqlServerInstance.json
new file mode 100644
index 000000000000..9b8da63326af
--- /dev/null
+++ b/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2019-07-24-preview/examples/ListSubscriptionSqlServerInstance.json
@@ -0,0 +1,50 @@
+{
+ "parameters": {
+ "subscriptionId": "00000000-1111-2222-3333-444444444444",
+ "api-version": "2017-07-24"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "properties": {
+ "version": "SQL Server 2017",
+ "edition": "Developer",
+ "containerResourceId": "Arc Machine Name",
+ "createTime": "01/01/2020 01:01:01",
+ "updateTime": "01/01/2020 01:01:01",
+ "vCore": "4",
+ "status": "Connected"
+ },
+ "location": "northeurope",
+ "tags": {
+ "mytag": "myval"
+ },
+ "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureData/SqlServerInstances/sqlServerInstance1",
+ "name": "sqlServerInstance1",
+ "type": "Microsoft.AzureData/SqlServerInstances"
+ },
+ {
+ "properties": {
+ "version": "SQL Server 2017",
+ "edition": "Developer",
+ "containerResourceId": "Arc Machine Name",
+ "createTime": "01/01/2020 01:01:01",
+ "updateTime": "01/01/2020 01:01:01",
+ "vCore": "4",
+ "status": "Connected"
+ },
+ "location": "northeurope",
+ "tags": {
+ "mytag": "myval"
+ },
+ "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureData/SqlServerInstances/sqlServerInstance2",
+ "name": "sqlServerInstance2",
+ "type": "Microsoft.AzureData/SqlServerInstances"
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2019-07-24-preview/examples/UpdateSqlServerInstance.json b/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2019-07-24-preview/examples/UpdateSqlServerInstance.json
new file mode 100644
index 000000000000..54206a23fdda
--- /dev/null
+++ b/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2019-07-24-preview/examples/UpdateSqlServerInstance.json
@@ -0,0 +1,32 @@
+{
+ "parameters": {
+ "subscriptionId": "00000000-1111-2222-3333-444444444444",
+ "resourceGroupName": "testrg",
+ "sqlServerInstanceName": "testsqlServerInstance",
+ "api-version": "2017-07-24",
+ "parameters": {
+ "tags": {
+ "mytag": "myval"
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "properties": {
+ "version": "SQL Server 2017",
+ "edition": "Developer",
+ "containerResourceId": "Arc Machine Name",
+ "createTime": "01/01/2020 01:01:01",
+ "updateTime": "01/01/2020 01:01:01",
+ "vCore": "4",
+ "status": "Connected"
+ },
+ "location": "northeurope",
+ "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureData/SqlServerInstances/testsqlServerInstance",
+ "name": "testsqlServerInstance",
+ "type": "Microsoft.AzureData/SqlServerInstances"
+ }
+ }
+ }
+}
diff --git a/specification/azuredata/resource-manager/readme.go.md b/specification/azuredata/resource-manager/readme.go.md
index dc83264ea194..154eac206330 100644
--- a/specification/azuredata/resource-manager/readme.go.md
+++ b/specification/azuredata/resource-manager/readme.go.md
@@ -6,14 +6,21 @@ These settings apply only when `--go` is specified on the command line.
go:
license-header: MICROSOFT_APACHE_NO_VERSION
clear-output-folder: true
+ namespace: azuredata
```
-### Tag: package-2019-07-24 and go
+### Go multi-api
-These settings apply only when `--tag=package-2019-07-24 --go` is specified on the command line.
-Please also specify `--go-sdks-folder=`.
+``` yaml $(go) && $(multiapi)
+batch:
+ - tag: package-preview-2019-07
+```
+
+### Tag: package-preview-2019-07 and go
+
+These settings apply only when `--tag=package-preview-2019-07 --go` is specified on the command line.
+Please also specify `--go-sdk-folder=`.
-```yaml $(tag) == 'package-2019-07-24' && $(go)
-namespace: Microsoft.AzureData
-output-folder: $(go-sdks-folder)/services/preview/$(namespace)/mgmt/2019-07-24-preview/$(namespace)
+```yaml $(tag) == 'package-preview-2019-07' && $(go)
+output-folder: $(go-sdk-folder)/services/preview/$(namespace)/mgmt/2019-07-24-preview/$(namespace)
```
\ No newline at end of file
diff --git a/specification/azurestack/resource-manager/Microsoft.AzureStack/stable/2017-06-01/Registration.json b/specification/azurestack/resource-manager/Microsoft.AzureStack/stable/2017-06-01/Registration.json
index 62f2bd69c0b0..1216c20372ad 100644
--- a/specification/azurestack/resource-manager/Microsoft.AzureStack/stable/2017-06-01/Registration.json
+++ b/specification/azurestack/resource-manager/Microsoft.AzureStack/stable/2017-06-01/Registration.json
@@ -348,7 +348,11 @@
"read"
]
}
- }
+ },
+ "required": [
+ "properties",
+ "location"
+ ]
},
"RegistrationParameterProperties": {
"description": "Properties of the Azure Stack registration resource",
diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/BatchManagement.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/BatchManagement.json
new file mode 100644
index 000000000000..1dfb09e8472b
--- /dev/null
+++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/BatchManagement.json
@@ -0,0 +1,5147 @@
+{
+ "swagger": "2.0",
+ "info": {
+ "title": "BatchManagement",
+ "version": "2020-05-01",
+ "x-ms-code-generation-settings": {
+ "name": "BatchManagementClient"
+ }
+ },
+ "host": "management.azure.com",
+ "schemes": [
+ "https"
+ ],
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "security": [
+ {
+ "azure_auth": [
+ "user_impersonation"
+ ]
+ }
+ ],
+ "securityDefinitions": {
+ "azure_auth": {
+ "type": "oauth2",
+ "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize",
+ "flow": "implicit",
+ "description": "Azure Active Directory OAuth2 Flow",
+ "scopes": {
+ "user_impersonation": "impersonate your user account"
+ }
+ }
+ },
+ "paths": {
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}": {
+ "put": {
+ "tags": [
+ "BatchAccount"
+ ],
+ "operationId": "BatchAccount_Create",
+ "x-ms-examples": {
+ "BatchAccountCreate_Default": {
+ "$ref": "./examples/BatchAccountCreate_Default.json"
+ },
+ "BatchAccountCreate_BYOS": {
+ "$ref": "./examples/BatchAccountCreate_BYOS.json"
+ },
+ "PrivateBatchAccountCreate": {
+ "$ref": "./examples/PrivateBatchAccountCreate.json"
+ },
+ "BatchAccountCreate_SystemAssignedIdentity": {
+ "$ref": "./examples/BatchAccountCreate_SystemAssignedIdentity.json"
+ }
+ },
+ "description": "Creates a new Batch account with the specified parameters. Existing accounts cannot be updated with this API and should instead be updated with the Update Batch Account API.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "name": "accountName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "pattern": "^[a-z0-9]+$",
+ "minLength": 3,
+ "maxLength": 24,
+ "description": "A name for the Batch account which must be unique within the region. Batch account names must be between 3 and 24 characters in length and must use only numbers and lowercase letters. This name is used as part of the DNS name that is used to access the Batch service in the region in which the account is created. For example: http://accountname.region.batch.azure.com/."
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/BatchAccountCreateParameters"
+ },
+ "description": "Additional parameters for account creation."
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The operation was successful. The response contains the Batch account entity.",
+ "schema": {
+ "$ref": "#/definitions/BatchAccount"
+ }
+ },
+ "202": {
+ "description": "The operation will be completed asynchronously.",
+ "headers": {
+ "Location": {
+ "description": "The URL of the resource used to check the status of the asynchronous operation.",
+ "type": "string"
+ },
+ "Retry-After": {
+ "description": "Suggested delay to check the status of the asynchronous operation. The value is an integer that specifies the delay in seconds.",
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true
+ },
+ "patch": {
+ "tags": [
+ "BatchAccount"
+ ],
+ "operationId": "BatchAccount_Update",
+ "x-ms-examples": {
+ "BatchAccountUpdate": {
+ "$ref": "./examples/BatchAccountUpdate.json"
+ }
+ },
+ "description": "Updates the properties of an existing Batch account.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/AccountNameParameter"
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/BatchAccountUpdateParameters"
+ },
+ "description": "Additional parameters for account update."
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The operation was successful. The response contains the Batch account entity.",
+ "schema": {
+ "$ref": "#/definitions/BatchAccount"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "BatchAccount"
+ ],
+ "operationId": "BatchAccount_Delete",
+ "x-ms-examples": {
+ "BatchAccountDelete": {
+ "$ref": "./examples/BatchAccountDelete.json"
+ }
+ },
+ "description": "Deletes the specified Batch account.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/AccountNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The operation was successful."
+ },
+ "202": {
+ "description": "The operation will be completed asynchronously.",
+ "headers": {
+ "Location": {
+ "description": "The URL of the resource used to check the status of the asynchronous operation.",
+ "type": "string"
+ },
+ "Retry-After": {
+ "description": "Suggested delay to check the status of the asynchronous operation. The value is an integer that specifies the delay in seconds.",
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ },
+ "204": {
+ "description": "NoContent -- account does not exist in the subscription."
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true
+ },
+ "get": {
+ "tags": [
+ "BatchAccount"
+ ],
+ "operationId": "BatchAccount_Get",
+ "x-ms-examples": {
+ "BatchAccountGet": {
+ "$ref": "./examples/BatchAccountGet.json"
+ },
+ "PrivateBatchAccountGet": {
+ "$ref": "./examples/PrivateBatchAccountGet.json"
+ }
+ },
+ "description": "Gets information about the specified Batch account.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/AccountNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The operation was successful. The response contains the Batch account entity.",
+ "schema": {
+ "$ref": "#/definitions/BatchAccount"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/providers/Microsoft.Batch/batchAccounts": {
+ "get": {
+ "tags": [
+ "BatchAccount"
+ ],
+ "operationId": "BatchAccount_List",
+ "x-ms-examples": {
+ "BatchAccountList": {
+ "$ref": "./examples/BatchAccountList.json"
+ }
+ },
+ "description": "Gets information about the Batch accounts associated with the subscription.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The operation was successful. The response contains a list of Batch account entities associated with the subscription.",
+ "schema": {
+ "$ref": "#/definitions/BatchAccountListResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts": {
+ "get": {
+ "tags": [
+ "BatchAccount"
+ ],
+ "operationId": "BatchAccount_ListByResourceGroup",
+ "x-ms-examples": {
+ "BatchAccountListByResourceGroup": {
+ "$ref": "./examples/BatchAccountListByResourceGroup.json"
+ }
+ },
+ "description": "Gets information about the Batch accounts associated with the specified resource group.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The operation was successful. The response contains a list of Batch account entities associated with the resource group.",
+ "schema": {
+ "$ref": "#/definitions/BatchAccountListResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/syncAutoStorageKeys": {
+ "post": {
+ "tags": [
+ "BatchAccount"
+ ],
+ "operationId": "BatchAccount_SynchronizeAutoStorageKeys",
+ "x-ms-examples": {
+ "BatchAccountSynchronizeAutoStorageKeys": {
+ "$ref": "./examples/BatchAccountSynchronizeAutoStorageKeys.json"
+ }
+ },
+ "description": "Synchronizes access keys for the auto-storage account configured for the specified Batch account.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/AccountNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "The operation was successful."
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/regenerateKeys": {
+ "post": {
+ "tags": [
+ "BatchAccount"
+ ],
+ "operationId": "BatchAccount_RegenerateKey",
+ "x-ms-examples": {
+ "BatchAccountRegenerateKey": {
+ "$ref": "./examples/BatchAccountRegenerateKey.json"
+ }
+ },
+ "description": "Regenerates the specified account key for the Batch account.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/AccountNameParameter"
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/BatchAccountRegenerateKeyParameters"
+ },
+ "description": "The type of key to regenerate."
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The operation was successful. The response contains the Batch account keys.",
+ "schema": {
+ "$ref": "#/definitions/BatchAccountKeys"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/listKeys": {
+ "post": {
+ "tags": [
+ "BatchAccount"
+ ],
+ "operationId": "BatchAccount_GetKeys",
+ "x-ms-examples": {
+ "BatchAccountGetKeys": {
+ "$ref": "./examples/BatchAccountGetKeys.json"
+ }
+ },
+ "summary": "Gets the account keys for the specified Batch account.",
+ "description": "This operation applies only to Batch accounts created with a poolAllocationMode of 'BatchService'. If the Batch account was created with a poolAllocationMode of 'UserSubscription', clients cannot use access to keys to authenticate, and must use Azure Active Directory instead. In this case, getting the keys will fail.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/AccountNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The operation was successful. The response contains the keys of the Batch account.",
+ "schema": {
+ "$ref": "#/definitions/BatchAccountKeys"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}/versions/{versionName}/activate": {
+ "post": {
+ "tags": [
+ "ApplicationPackage"
+ ],
+ "operationId": "ApplicationPackage_Activate",
+ "x-ms-examples": {
+ "ApplicationPackageActivate": {
+ "$ref": "./examples/ApplicationPackageActivate.json"
+ }
+ },
+ "description": "Activates the specified application package. This should be done after the `ApplicationPackage` was created and uploaded. This needs to be done before an `ApplicationPackage` can be used on Pools or Tasks.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/AccountNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ApplicationNameParameter"
+ },
+ {
+ "$ref": "#/parameters/VersionNameParameter"
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/ActivateApplicationPackageParameters"
+ },
+ "description": "The parameters for the request."
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The operation was successful. The response contains the application package entity.",
+ "schema": {
+ "$ref": "#/definitions/ApplicationPackage"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}": {
+ "put": {
+ "tags": [
+ "Application"
+ ],
+ "operationId": "Application_Create",
+ "x-ms-examples": {
+ "ApplicationCreate": {
+ "$ref": "./examples/ApplicationCreate.json"
+ }
+ },
+ "description": "Adds an application to the specified Batch account.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/AccountNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ApplicationNameParameter"
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "required": false,
+ "schema": {
+ "$ref": "#/definitions/Application"
+ },
+ "description": "The parameters for the request."
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The operation was successful. The response contains the application entity.",
+ "schema": {
+ "$ref": "#/definitions/Application"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "Application"
+ ],
+ "operationId": "Application_Delete",
+ "x-ms-examples": {
+ "ApplicationDelete": {
+ "$ref": "./examples/ApplicationDelete.json"
+ }
+ },
+ "description": "Deletes an application.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/AccountNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ApplicationNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The operation was successful."
+ },
+ "204": {
+ "description": "The operation was successful."
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ }
+ },
+ "get": {
+ "tags": [
+ "Application"
+ ],
+ "operationId": "Application_Get",
+ "x-ms-examples": {
+ "ApplicationGet": {
+ "$ref": "./examples/ApplicationGet.json"
+ }
+ },
+ "description": "Gets information about the specified application.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/AccountNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ApplicationNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The operation was successful. The response contains the application entity.",
+ "schema": {
+ "$ref": "#/definitions/Application"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ }
+ },
+ "patch": {
+ "tags": [
+ "Application"
+ ],
+ "operationId": "Application_Update",
+ "x-ms-examples": {
+ "ApplicationUpdate": {
+ "$ref": "./examples/ApplicationUpdate.json"
+ }
+ },
+ "description": "Updates settings for the specified application.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/AccountNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ApplicationNameParameter"
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/Application"
+ },
+ "description": "The parameters for the request."
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The operation was successful. The response contains the application entity.",
+ "schema": {
+ "$ref": "#/definitions/Application"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}/versions/{versionName}": {
+ "put": {
+ "tags": [
+ "ApplicationPackage"
+ ],
+ "operationId": "ApplicationPackage_Create",
+ "x-ms-examples": {
+ "ApplicationPackageCreate": {
+ "$ref": "./examples/ApplicationPackageCreate.json"
+ }
+ },
+ "description": "Creates an application package record. The record contains the SAS where the package should be uploaded to. Once it is uploaded the `ApplicationPackage` needs to be activated using `ApplicationPackageActive` before it can be used.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/AccountNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ApplicationNameParameter"
+ },
+ {
+ "$ref": "#/parameters/VersionNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "required": false,
+ "schema": {
+ "$ref": "#/definitions/ApplicationPackage"
+ },
+ "description": "The parameters for the request."
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The operation was successful. The response contains the application package entity.",
+ "schema": {
+ "$ref": "#/definitions/ApplicationPackage"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "ApplicationPackage"
+ ],
+ "operationId": "ApplicationPackage_Delete",
+ "x-ms-examples": {
+ "ApplicationPackageDelete": {
+ "$ref": "./examples/ApplicationPackageDelete.json"
+ }
+ },
+ "description": "Deletes an application package record and its associated binary file.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/AccountNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ApplicationNameParameter"
+ },
+ {
+ "$ref": "#/parameters/VersionNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The operation was successful."
+ },
+ "204": {
+ "description": "The operation was successful."
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ }
+ },
+ "get": {
+ "tags": [
+ "ApplicationPackage"
+ ],
+ "operationId": "ApplicationPackage_Get",
+ "x-ms-examples": {
+ "ApplicationPackageGet": {
+ "$ref": "./examples/ApplicationPackageGet.json"
+ }
+ },
+ "description": "Gets information about the specified application package.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/AccountNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ApplicationNameParameter"
+ },
+ {
+ "$ref": "#/parameters/VersionNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The operation was successful. The response contains the application package entity.",
+ "schema": {
+ "$ref": "#/definitions/ApplicationPackage"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications": {
+ "get": {
+ "tags": [
+ "Application"
+ ],
+ "operationId": "Application_List",
+ "x-ms-examples": {
+ "ApplicationList": {
+ "$ref": "./examples/ApplicationList.json"
+ }
+ },
+ "description": "Lists all of the applications in the specified account.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/AccountNameParameter"
+ },
+ {
+ "name": "maxresults",
+ "in": "query",
+ "required": false,
+ "type": "integer",
+ "format": "int32",
+ "description": "The maximum number of items to return in the response."
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The operation was successful. The response contains a list of the application entities associated with the specified account.",
+ "schema": {
+ "$ref": "#/definitions/ListApplicationsResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}/versions": {
+ "get": {
+ "tags": [
+ "ApplicationPackage"
+ ],
+ "operationId": "ApplicationPackage_List",
+ "x-ms-examples": {
+ "ApplicationList": {
+ "$ref": "./examples/ApplicationPackageList.json"
+ }
+ },
+ "description": "Lists all of the application packages in the specified application.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/AccountNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ApplicationNameParameter"
+ },
+ {
+ "name": "maxresults",
+ "in": "query",
+ "required": false,
+ "type": "integer",
+ "format": "int32",
+ "description": "The maximum number of items to return in the response."
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The operation was successful. The response contains a list of the application package entities associated with the specified application.",
+ "schema": {
+ "$ref": "#/definitions/ListApplicationPackagesResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/providers/Microsoft.Batch/locations/{locationName}/quotas": {
+ "get": {
+ "tags": [
+ "Location"
+ ],
+ "operationId": "Location_GetQuotas",
+ "x-ms-examples": {
+ "LocationGetQuotas": {
+ "$ref": "./examples/LocationGetQuotas.json"
+ }
+ },
+ "description": "Gets the Batch service quotas for the specified subscription at the given location.",
+ "parameters": [
+ {
+ "name": "locationName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The region for which to retrieve Batch service quotas."
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The operation was successful. The response contains the Batch service quotas for the subscription in the specified location.",
+ "schema": {
+ "$ref": "#/definitions/BatchLocationQuota"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ }
+ }
+ },
+ "/providers/Microsoft.Batch/operations": {
+ "get": {
+ "tags": [
+ "Operations"
+ ],
+ "operationId": "Operations_List",
+ "description": "Lists available operations for the Microsoft.Batch provider",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The operation was successful. The response contains the list of available operations.",
+ "schema": {
+ "$ref": "#/definitions/OperationListResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/providers/Microsoft.Batch/locations/{locationName}/checkNameAvailability": {
+ "post": {
+ "operationId": "Location_CheckNameAvailability",
+ "description": "Checks whether the Batch account name is available in the specified region.",
+ "x-ms-examples": {
+ "LocationCheckNameAvailability_Available": {
+ "$ref": "./examples/LocationCheckNameAvailability_Available.json"
+ },
+ "LocationCheckNameAvailability_AlreadyExists": {
+ "$ref": "./examples/LocationCheckNameAvailability_AlreadyExists.json"
+ }
+ },
+ "parameters": [
+ {
+ "name": "locationName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The desired region for the name check."
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/CheckNameAvailabilityParameters"
+ },
+ "description": "Properties needed to check the availability of a name."
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success. Returns details about whether a Batch account name is available.",
+ "schema": {
+ "$ref": "#/definitions/CheckNameAvailabilityResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/certificates": {
+ "get": {
+ "tags": [
+ "Certificate"
+ ],
+ "operationId": "Certificate_ListByBatchAccount",
+ "description": "Lists all of the certificates in the specified account.",
+ "x-ms-examples": {
+ "ListCertificates": {
+ "$ref": "./examples/CertificateList.json"
+ },
+ "ListCertificates - Filter and Select": {
+ "$ref": "./examples/CertificateListWithFilter.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/AccountNameParameter"
+ },
+ {
+ "name": "maxresults",
+ "in": "query",
+ "required": false,
+ "type": "integer",
+ "format": "int32",
+ "description": "The maximum number of items to return in the response."
+ },
+ {
+ "name": "$select",
+ "in": "query",
+ "required": false,
+ "type": "string",
+ "description": "Comma separated list of properties that should be returned. e.g. \"properties/provisioningState\". Only top level properties under properties/ are valid for selection."
+ },
+ {
+ "name": "$filter",
+ "in": "query",
+ "required": false,
+ "type": "string",
+ "description": "OData filter expression. Valid properties for filtering are \"properties/provisioningState\", \"properties/provisioningStateTransitionTime\", \"name\"."
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The operation was successful. The response contains a list of certificates associated with the account.",
+ "schema": {
+ "$ref": "#/definitions/ListCertificatesResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/certificates/{certificateName}": {
+ "put": {
+ "tags": [
+ "Certificate"
+ ],
+ "operationId": "Certificate_Create",
+ "description": "Creates a new certificate inside the specified account.",
+ "x-ms-examples": {
+ "CreateCertificate - Minimal Pfx": {
+ "$ref": "./examples/CertificateCreate_Minimal.json"
+ },
+ "CreateCertificate - Minimal Cer": {
+ "$ref": "./examples/CertificateCreate_MinimalCer.json"
+ },
+ "CreateCertificate - Full": {
+ "$ref": "./examples/CertificateCreate_Full.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/AccountNameParameter"
+ },
+ {
+ "$ref": "#/parameters/CertificateNameParameter"
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/CertificateCreateOrUpdateParameters"
+ },
+ "description": "Additional parameters for certificate creation."
+ },
+ {
+ "name": "If-Match",
+ "in": "header",
+ "required": false,
+ "type": "string",
+ "description": "The entity state (ETag) version of the certificate to update. A value of \"*\" can be used to apply the operation only if the certificate already exists. If omitted, this operation will always be applied."
+ },
+ {
+ "name": "If-None-Match",
+ "in": "header",
+ "required": false,
+ "type": "string",
+ "description": "Set to '*' to allow a new certificate to be created, but to prevent updating an existing certificate. Other values will be ignored."
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The operation was successful. The response contains the certificate entity.",
+ "schema": {
+ "$ref": "#/definitions/Certificate"
+ },
+ "headers": {
+ "ETag": {
+ "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Match or If-None-Match headers.",
+ "type": "string"
+ }
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true
+ },
+ "patch": {
+ "tags": [
+ "Certificate"
+ ],
+ "operationId": "Certificate_Update",
+ "description": "Updates the properties of an existing certificate.",
+ "x-ms-examples": {
+ "UpdateCertificate": {
+ "$ref": "./examples/CertificateUpdate.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/AccountNameParameter"
+ },
+ {
+ "$ref": "#/parameters/CertificateNameParameter"
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/CertificateCreateOrUpdateParameters"
+ },
+ "description": "Certificate entity to update."
+ },
+ {
+ "name": "If-Match",
+ "in": "header",
+ "required": false,
+ "type": "string",
+ "description": "The entity state (ETag) version of the certificate to update. This value can be omitted or set to \"*\" to apply the operation unconditionally."
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The operation was successful. The response contains the certificate entity.",
+ "schema": {
+ "$ref": "#/definitions/Certificate"
+ },
+ "headers": {
+ "ETag": {
+ "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Match or If-None-Match headers.",
+ "type": "string"
+ }
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "Certificate"
+ ],
+ "operationId": "Certificate_Delete",
+ "description": "Deletes the specified certificate.",
+ "x-ms-examples": {
+ "CertificateDelete": {
+ "$ref": "./examples/CertificateDelete.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/AccountNameParameter"
+ },
+ {
+ "$ref": "#/parameters/CertificateNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The operation was successful."
+ },
+ "204": {
+ "description": "The operation was successful."
+ },
+ "202": {
+ "description": "The operation will be completed asynchronously.",
+ "headers": {
+ "Location": {
+ "description": "The URL of the resource used to check the status of the asynchronous operation.",
+ "type": "string"
+ },
+ "Retry-After": {
+ "description": "Suggested delay to check the status of the asynchronous operation. The value is an integer that represents the seconds.",
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true
+ },
+ "get": {
+ "tags": [
+ "Certificate"
+ ],
+ "operationId": "Certificate_Get",
+ "description": "Gets information about the specified certificate.",
+ "x-ms-examples": {
+ "Get Certificate": {
+ "$ref": "./examples/CertificateGet.json"
+ },
+ "Get Certificate with Deletion Error": {
+ "$ref": "./examples/CertificateGetWithDeletionError.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/AccountNameParameter"
+ },
+ {
+ "$ref": "#/parameters/CertificateNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The operation was successful. The response contains the certificate entity.",
+ "schema": {
+ "$ref": "#/definitions/Certificate"
+ },
+ "headers": {
+ "ETag": {
+ "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Match or If-None-Match headers.",
+ "type": "string"
+ }
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/certificates/{certificateName}/cancelDelete": {
+ "post": {
+ "tags": [
+ "Certificate"
+ ],
+ "operationId": "Certificate_CancelDeletion",
+ "summary": "Cancels a failed deletion of a certificate from the specified account.",
+ "description": "If you try to delete a certificate that is being used by a pool or compute node, the status of the certificate changes to deleteFailed. If you decide that you want to continue using the certificate, you can use this operation to set the status of the certificate back to active. If you intend to delete the certificate, you do not need to run this operation after the deletion failed. You must make sure that the certificate is not being used by any resources, and then you can try again to delete the certificate.",
+ "x-ms-examples": {
+ "CertificateCancelDeletion": {
+ "$ref": "./examples/CertificateCancelDeletion.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/AccountNameParameter"
+ },
+ {
+ "$ref": "#/parameters/CertificateNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The operation was successful. The response contains the certificate entity.",
+ "schema": {
+ "$ref": "#/definitions/Certificate"
+ },
+ "headers": {
+ "ETag": {
+ "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Match or If-None-Match headers.",
+ "type": "string"
+ }
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/privateLinkResources": {
+ "get": {
+ "tags": [
+ "PrivateLinkResource"
+ ],
+ "operationId": "PrivateLinkResource_ListByBatchAccount",
+ "description": "Lists all of the private link resources in the specified account.",
+ "x-ms-examples": {
+ "ListPrivateLinkResource": {
+ "$ref": "./examples/PrivateLinkResourcesList.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/AccountNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "name": "maxresults",
+ "in": "query",
+ "required": false,
+ "type": "integer",
+ "format": "int32",
+ "description": "The maximum number of items to return in the response."
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The operation was successful. The response contains a list of private link resources associated with the account.",
+ "schema": {
+ "$ref": "#/definitions/ListPrivateLinkResourcesResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/privateLinkResources/{privateLinkResourceName}": {
+ "get": {
+ "tags": [
+ "PrivateLinkResource"
+ ],
+ "operationId": "PrivateLinkResource_Get",
+ "description": "Gets information about the specified private link resource.",
+ "x-ms-examples": {
+ "GetPrivateLinkResource": {
+ "$ref": "./examples/PrivateLinkResourceGet.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/AccountNameParameter"
+ },
+ {
+ "$ref": "#/parameters/PrivateLinkResourceNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The operation was successful. The response contains the private link resource.",
+ "schema": {
+ "$ref": "#/definitions/PrivateLinkResource"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/privateEndpointConnections": {
+ "get": {
+ "tags": [
+ "PrivateEndpointConnection"
+ ],
+ "operationId": "PrivateEndpointConnection_ListByBatchAccount",
+ "description": "Lists all of the private endpoint connections in the specified account.",
+ "x-ms-examples": {
+ "ListPrivateEndpointConnections": {
+ "$ref": "./examples/PrivateEndpointConnectionsList.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/AccountNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "name": "maxresults",
+ "in": "query",
+ "required": false,
+ "type": "integer",
+ "format": "int32",
+ "description": "The maximum number of items to return in the response."
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The operation was successful. The response contains a list of private link resources associated with the account.",
+ "schema": {
+ "$ref": "#/definitions/ListPrivateEndpointConnectionsResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/privateEndpointConnections/{privateEndpointConnectionName}": {
+ "get": {
+ "tags": [
+ "PrivateEndpointConnection"
+ ],
+ "operationId": "PrivateEndpointConnection_Get",
+ "description": "Gets information about the specified private endpoint connection.",
+ "x-ms-examples": {
+ "GetPrivateEndpointConnection": {
+ "$ref": "./examples/PrivateEndpointConnectionGet.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/AccountNameParameter"
+ },
+ {
+ "$ref": "#/parameters/PrivateEndpointConnectionNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The operation was successful. The response contains the private endpoint connection.",
+ "schema": {
+ "$ref": "#/definitions/PrivateEndpointConnection"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ }
+ },
+ "patch": {
+ "tags": [
+ "PrivateEndpointConnection"
+ ],
+ "operationId": "PrivateEndpointConnection_Update",
+ "description": "Updates the properties of an existing private endpoint connection.",
+ "x-ms-examples": {
+ "UpdatePrivateEndpointConnection": {
+ "$ref": "./examples/PrivateEndpointConnectionUpdate.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/AccountNameParameter"
+ },
+ {
+ "$ref": "#/parameters/PrivateEndpointConnectionNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/PrivateEndpointConnection"
+ },
+ "description": "PrivateEndpointConnection properties that should be updated. Properties that are supplied will be updated, any property not supplied will be unchanged."
+ },
+ {
+ "name": "If-Match",
+ "in": "header",
+ "required": false,
+ "type": "string",
+ "description": "The state (ETag) version of the private endpoint connection to update. This value can be omitted or set to \"*\" to apply the operation unconditionally."
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The operation was successful. The response contains the PrivateEndpointConnection.",
+ "schema": {
+ "$ref": "#/definitions/PrivateEndpointConnection"
+ }
+ },
+ "204": {
+ "description": "The operation was successful."
+ },
+ "202": {
+ "description": "The operation will be completed asynchronously.",
+ "headers": {
+ "Location": {
+ "description": "The URL of the resource used to check the status of the asynchronous operation.",
+ "type": "string"
+ },
+ "Retry-After": {
+ "description": "Suggested delay to check the status of the asynchronous operation. The value is an integer that represents the seconds.",
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ },
+ "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.Batch/batchAccounts/{accountName}/pools": {
+ "get": {
+ "tags": [
+ "Pool"
+ ],
+ "operationId": "Pool_ListByBatchAccount",
+ "description": "Lists all of the pools in the specified account.",
+ "x-ms-examples": {
+ "ListPool": {
+ "$ref": "./examples/PoolList.json"
+ },
+ "ListPoolWithFilter": {
+ "$ref": "./examples/PoolListWithFilter.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/AccountNameParameter"
+ },
+ {
+ "name": "maxresults",
+ "in": "query",
+ "required": false,
+ "type": "integer",
+ "format": "int32",
+ "description": "The maximum number of items to return in the response."
+ },
+ {
+ "name": "$select",
+ "in": "query",
+ "required": false,
+ "type": "string",
+ "description": "Comma separated list of properties that should be returned. e.g. \"properties/provisioningState\". Only top level properties under properties/ are valid for selection."
+ },
+ {
+ "name": "$filter",
+ "in": "query",
+ "required": false,
+ "type": "string",
+ "description": "OData filter expression. Valid properties for filtering are:\n\n name\n properties/allocationState\n properties/allocationStateTransitionTime\n properties/creationTime\n properties/provisioningState\n properties/provisioningStateTransitionTime\n properties/lastModified\n properties/vmSize\n properties/interNodeCommunication\n properties/scaleSettings/autoScale\n properties/scaleSettings/fixedScale"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The operation was successful. The response contains a list of certificates associated with the account.",
+ "schema": {
+ "$ref": "#/definitions/ListPoolsResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/pools/{poolName}": {
+ "put": {
+ "tags": [
+ "Pool"
+ ],
+ "operationId": "Pool_Create",
+ "description": "Creates a new pool inside the specified account.",
+ "x-ms-examples": {
+ "CreatePool - Minimal CloudServiceConfiguration": {
+ "$ref": "./examples/PoolCreate_MinimalCloudServiceConfiguration.json"
+ },
+ "CreatePool - Minimal VirtualMachineConfiguration": {
+ "$ref": "./examples/PoolCreate_MinimalVirtualMachineConfiguration.json"
+ },
+ "CreatePool - Full Example": {
+ "$ref": "./examples/PoolCreate_FullExample.json"
+ },
+ "CreatePool - Custom Image": {
+ "$ref": "./examples/PoolCreate_CustomImage.json"
+ },
+ "CreatePool - Public IPs": {
+ "$ref": "./examples/PoolCreate_PublicIPs.json"
+ },
+ "CreatePool - Full VirtualMachineConfiguration": {
+ "$ref": "./examples/PoolCreate_VirtualMachineConfiguration.json"
+ },
+ "CreatePool - No public IP": {
+ "$ref": "./examples/PoolCreate_NoPublicIPAddresses.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/AccountNameParameter"
+ },
+ {
+ "$ref": "#/parameters/PoolNameParameter"
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/Pool"
+ },
+ "description": "Additional parameters for pool creation."
+ },
+ {
+ "name": "If-Match",
+ "in": "header",
+ "required": false,
+ "type": "string",
+ "description": "The entity state (ETag) version of the pool to update. A value of \"*\" can be used to apply the operation only if the pool already exists. If omitted, this operation will always be applied."
+ },
+ {
+ "name": "If-None-Match",
+ "in": "header",
+ "required": false,
+ "type": "string",
+ "description": "Set to '*' to allow a new pool to be created, but to prevent updating an existing pool. Other values will be ignored."
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The operation was successful. The response contains the pool entity.",
+ "schema": {
+ "$ref": "#/definitions/Pool"
+ },
+ "headers": {
+ "ETag": {
+ "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Match or If-None-Match headers.",
+ "type": "string"
+ }
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true
+ },
+ "patch": {
+ "tags": [
+ "Pool"
+ ],
+ "operationId": "Pool_Update",
+ "description": "Updates the properties of an existing pool.",
+ "x-ms-examples": {
+ "UpdatePool - Resize Pool": {
+ "$ref": "./examples/PoolUpdate_ResizePool.json"
+ },
+ "UpdatePool - Enable Autoscale": {
+ "$ref": "./examples/PoolUpdate_EnableAutoScale.json"
+ },
+ "UpdatePool - Remove Start Task": {
+ "$ref": "./examples/PoolUpdate_RemoveStartTask.json"
+ },
+ "UpdatePool - Other Properties": {
+ "$ref": "./examples/PoolUpdate_OtherProperties.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/AccountNameParameter"
+ },
+ {
+ "$ref": "#/parameters/PoolNameParameter"
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/Pool"
+ },
+ "description": "Pool properties that should be updated. Properties that are supplied will be updated, any property not supplied will be unchanged."
+ },
+ {
+ "name": "If-Match",
+ "in": "header",
+ "required": false,
+ "type": "string",
+ "description": "The entity state (ETag) version of the pool to update. This value can be omitted or set to \"*\" to apply the operation unconditionally."
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The operation was successful. The response contains the pool entity.",
+ "schema": {
+ "$ref": "#/definitions/Pool"
+ },
+ "headers": {
+ "ETag": {
+ "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Match or If-None-Match headers.",
+ "type": "string"
+ }
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "Pool"
+ ],
+ "operationId": "Pool_Delete",
+ "description": "Deletes the specified pool.",
+ "x-ms-examples": {
+ "DeletePool": {
+ "$ref": "./examples/PoolDelete.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/AccountNameParameter"
+ },
+ {
+ "$ref": "#/parameters/PoolNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The operation was successful."
+ },
+ "204": {
+ "description": "The operation was successful."
+ },
+ "202": {
+ "description": "The operation will be completed asynchronously.",
+ "headers": {
+ "Location": {
+ "description": "The URL of the resource used to check the status of the asynchronous operation.",
+ "type": "string"
+ },
+ "Retry-After": {
+ "description": "Suggested delay to check the status of the asynchronous operation. The value is an integer that represents the seconds.",
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true
+ },
+ "get": {
+ "tags": [
+ "Pool"
+ ],
+ "operationId": "Pool_Get",
+ "description": "Gets information about the specified pool.",
+ "x-ms-examples": {
+ "GetPool": {
+ "$ref": "./examples/PoolGet.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/AccountNameParameter"
+ },
+ {
+ "$ref": "#/parameters/PoolNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The operation was successful. The response contains the pool entity.",
+ "schema": {
+ "$ref": "#/definitions/Pool"
+ },
+ "headers": {
+ "ETag": {
+ "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Match or If-None-Match headers.",
+ "type": "string"
+ }
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/pools/{poolName}/disableAutoScale": {
+ "post": {
+ "tags": [
+ "Pool"
+ ],
+ "operationId": "Pool_DisableAutoScale",
+ "description": "Disables automatic scaling for a pool.",
+ "x-ms-examples": {
+ "Disable AutoScale": {
+ "$ref": "./examples/PoolDisableAutoScale.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/AccountNameParameter"
+ },
+ {
+ "$ref": "#/parameters/PoolNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The operation was successful. The response contains the pool entity.",
+ "schema": {
+ "$ref": "#/definitions/Pool"
+ },
+ "headers": {
+ "ETag": {
+ "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Match or If-None-Match headers.",
+ "type": "string"
+ }
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/pools/{poolName}/stopResize": {
+ "post": {
+ "tags": [
+ "Pool"
+ ],
+ "operationId": "Pool_StopResize",
+ "summary": "Stops an ongoing resize operation on the pool.",
+ "description": "This does not restore the pool to its previous state before the resize operation: it only stops any further changes being made, and the pool maintains its current state. After stopping, the pool stabilizes at the number of nodes it was at when the stop operation was done. During the stop operation, the pool allocation state changes first to stopping and then to steady. A resize operation need not be an explicit resize pool request; this API can also be used to halt the initial sizing of the pool when it is created.",
+ "x-ms-examples": {
+ "StopPoolResize": {
+ "$ref": "./examples/PoolStopResize.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/AccountNameParameter"
+ },
+ {
+ "$ref": "#/parameters/PoolNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The operation was successful. The response contains the pool entity.",
+ "schema": {
+ "$ref": "#/definitions/Pool"
+ },
+ "headers": {
+ "ETag": {
+ "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Match or If-None-Match headers.",
+ "type": "string"
+ }
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ }
+ }
+ }
+ },
+ "definitions": {
+ "AutoStorageBaseProperties": {
+ "properties": {
+ "storageAccountId": {
+ "type": "string",
+ "description": "The resource ID of the storage account to be used for auto-storage account."
+ }
+ },
+ "required": [
+ "storageAccountId"
+ ],
+ "description": "The properties related to the auto-storage account."
+ },
+ "BatchAccountUpdateProperties": {
+ "properties": {
+ "autoStorage": {
+ "$ref": "#/definitions/AutoStorageBaseProperties",
+ "description": "The properties related to the auto-storage account."
+ },
+ "encryption": {
+ "title": "The encryption configuration for the Batch account.",
+ "description": "Configures how customer data is encrypted inside the Batch account. By default, accounts are encrypted using a Microsoft managed key. For additional control, a customer-managed key can be used instead.",
+ "$ref": "#/definitions/EncryptionProperties"
+ }
+ },
+ "description": "The properties of a Batch account."
+ },
+ "BatchAccountCreateProperties": {
+ "properties": {
+ "autoStorage": {
+ "$ref": "#/definitions/AutoStorageBaseProperties",
+ "description": "The properties related to the auto-storage account."
+ },
+ "poolAllocationMode": {
+ "title": "The allocation mode to use for creating pools in the Batch account.",
+ "description": "The pool allocation mode also affects how clients may authenticate to the Batch Service API. If the mode is BatchService, clients may authenticate using access keys or Azure Active Directory. If the mode is UserSubscription, clients must use Azure Active Directory. The default is BatchService.",
+ "$ref": "#/definitions/PoolAllocationMode"
+ },
+ "keyVaultReference": {
+ "$ref": "#/definitions/KeyVaultReference",
+ "description": "A reference to the Azure key vault associated with the Batch account."
+ },
+ "publicNetworkAccess": {
+ "title": "The network access type for accessing Azure Batch account.",
+ "description": "If not specified, the default value is 'enabled'.",
+ "$ref": "#/definitions/PublicNetworkAccessType"
+ },
+ "encryption": {
+ "title": "The encryption configuration for the Batch account.",
+ "description": "Configures how customer data is encrypted inside the Batch account. By default, accounts are encrypted using a Microsoft managed key. For additional control, a customer-managed key can be used instead.",
+ "$ref": "#/definitions/EncryptionProperties"
+ }
+ },
+ "description": "The properties of a Batch account."
+ },
+ "BatchAccountCreateParameters": {
+ "properties": {
+ "location": {
+ "type": "string",
+ "description": "The region in which to create the account."
+ },
+ "tags": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "The user-specified tags associated with the account."
+ },
+ "properties": {
+ "x-ms-client-flatten": true,
+ "$ref": "#/definitions/BatchAccountCreateProperties",
+ "description": "The properties of the Batch account."
+ },
+ "identity": {
+ "$ref": "#/definitions/BatchAccountIdentity",
+ "description": "The identity of the Batch account."
+ }
+ },
+ "required": [
+ "location"
+ ],
+ "description": "Parameters supplied to the Create operation."
+ },
+ "KeyVaultReference": {
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "The resource ID of the Azure key vault associated with the Batch account."
+ },
+ "url": {
+ "type": "string",
+ "description": "The URL of the Azure key vault associated with the Batch account."
+ }
+ },
+ "required": [
+ "id",
+ "url"
+ ],
+ "description": "Identifies the Azure key vault associated with a Batch account."
+ },
+ "AutoStorageProperties": {
+ "properties": {
+ "lastKeySync": {
+ "type": "string",
+ "format": "date-time",
+ "description": "The UTC time at which storage keys were last synchronized with the Batch account."
+ }
+ },
+ "required": [
+ "lastKeySync"
+ ],
+ "allOf": [
+ {
+ "$ref": "#/definitions/AutoStorageBaseProperties"
+ }
+ ],
+ "description": "Contains information about the auto-storage account associated with a Batch account."
+ },
+ "VirtualMachineFamilyCoreQuota": {
+ "properties": {
+ "name": {
+ "readOnly": true,
+ "x-nullable": false,
+ "type": "string",
+ "description": "The Virtual Machine family name."
+ },
+ "coreQuota": {
+ "readOnly": true,
+ "x-nullable": false,
+ "type": "integer",
+ "format": "int32",
+ "description": "The core quota for the VM family for the Batch account."
+ }
+ },
+ "description": "A VM Family and its associated core quota for the Batch account."
+ },
+ "BatchAccountIdentity": {
+ "properties": {
+ "principalId": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The principal id of the Batch account. This property will only be provided for a system assigned identity."
+ },
+ "tenantId": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The tenant id associated with the Batch account. This property will only be provided for a system assigned identity."
+ },
+ "type": {
+ "type": "string",
+ "description": "The type of identity used for the Batch account.",
+ "enum": [
+ "SystemAssigned",
+ "None"
+ ],
+ "x-ms-enum": {
+ "name": "ResourceIdentityType",
+ "modelAsString": false,
+ "values": [
+ {
+ "value": "SystemAssigned",
+ "description": "Batch account has a system assigned identity with it."
+ },
+ {
+ "value": "None",
+ "description": "Batch account has no identity associated with it. Setting `None` in update account will remove existing identities."
+ }
+ ]
+ }
+ }
+ },
+ "description": "The identity of the Batch account, if configured. This is only used when the user specifies 'Azure.KeyVault' as their Batch account encryption configuration.",
+ "required": [
+ "type"
+ ]
+ },
+ "BatchAccountProperties": {
+ "properties": {
+ "accountEndpoint": {
+ "type": "string",
+ "readOnly": true,
+ "description": "The account endpoint used to interact with the Batch service."
+ },
+ "provisioningState": {
+ "type": "string",
+ "readOnly": true,
+ "x-nullable": false,
+ "description": "The provisioned state of the resource",
+ "enum": [
+ "Invalid",
+ "Creating",
+ "Deleting",
+ "Succeeded",
+ "Failed",
+ "Cancelled"
+ ],
+ "x-ms-enum": {
+ "name": "ProvisioningState",
+ "modelAsString": false,
+ "values": [
+ {
+ "value": "Invalid",
+ "description": "The account is in an invalid state."
+ },
+ {
+ "value": "Creating",
+ "description": "The account is being created."
+ },
+ {
+ "value": "Deleting",
+ "description": "The account is being deleted."
+ },
+ {
+ "value": "Succeeded",
+ "description": "The account has been created and is ready for use."
+ },
+ {
+ "value": "Failed",
+ "description": "The last operation for the account is failed."
+ },
+ {
+ "value": "Cancelled",
+ "description": "The last operation for the account is cancelled."
+ }
+ ]
+ }
+ },
+ "poolAllocationMode": {
+ "readOnly": true,
+ "x-nullable": false,
+ "title": "The allocation mode to use for creating pools in the Batch account.",
+ "$ref": "#/definitions/PoolAllocationMode"
+ },
+ "keyVaultReference": {
+ "title": "A reference to the Azure key vault associated with the Batch account.",
+ "readOnly": true,
+ "$ref": "#/definitions/KeyVaultReference"
+ },
+ "publicNetworkAccess": {
+ "readOnly": true,
+ "x-nullable": true,
+ "title": "The network interface type for accessing Azure Batch service and Batch account operations.",
+ "description": "If not specified, the default value is 'enabled'.",
+ "$ref": "#/definitions/PublicNetworkAccessType"
+ },
+ "privateEndpointConnections": {
+ "readOnly": true,
+ "x-nullable": true,
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/PrivateEndpointConnection"
+ },
+ "description": "List of private endpoint connections associated with the Batch account"
+ },
+ "autoStorage": {
+ "title": "The properties and status of any auto-storage account associated with the Batch account.",
+ "readOnly": true,
+ "$ref": "#/definitions/AutoStorageProperties"
+ },
+ "encryption": {
+ "title": "The encryption configuration for the Batch account.",
+ "description": "Configures how customer data is encrypted inside the Batch account. By default, accounts are encrypted using a Microsoft managed key. For additional control, a customer-managed key can be used instead.",
+ "readOnly": true,
+ "$ref": "#/definitions/EncryptionProperties"
+ },
+ "dedicatedCoreQuota": {
+ "readOnly": true,
+ "x-nullable": true,
+ "type": "integer",
+ "format": "int32",
+ "title": "The dedicated core quota for the Batch account.",
+ "description": "For accounts with PoolAllocationMode set to UserSubscription, quota is managed on the subscription so this value is not returned."
+ },
+ "lowPriorityCoreQuota": {
+ "readOnly": true,
+ "x-nullable": true,
+ "type": "integer",
+ "format": "int32",
+ "title": "The low-priority core quota for the Batch account.",
+ "description": "For accounts with PoolAllocationMode set to UserSubscription, quota is managed on the subscription so this value is not returned."
+ },
+ "dedicatedCoreQuotaPerVMFamily": {
+ "readOnly": true,
+ "x-nullable": true,
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/VirtualMachineFamilyCoreQuota"
+ },
+ "description": "A list of the dedicated core quota per Virtual Machine family for the Batch account. For accounts with PoolAllocationMode set to UserSubscription, quota is managed on the subscription so this value is not returned."
+ },
+ "dedicatedCoreQuotaPerVMFamilyEnforced": {
+ "readOnly": true,
+ "x-nullable": false,
+ "type": "boolean",
+ "title": "A value indicating whether the core quota for the Batch Account is enforced per Virtual Machine family or not.",
+ "description": "Batch is transitioning its core quota system for dedicated cores to be enforced per Virtual Machine family. During this transitional phase, the dedicated core quota per Virtual Machine family may not yet be enforced. If this flag is false, dedicated core quota is enforced via the old dedicatedCoreQuota property on the account and does not consider Virtual Machine family. If this flag is true, dedicated core quota is enforced via the dedicatedCoreQuotaPerVMFamily property on the account, and the old dedicatedCoreQuota does not apply."
+ },
+ "poolQuota": {
+ "readOnly": true,
+ "x-nullable": false,
+ "type": "integer",
+ "format": "int32",
+ "title": "The pool quota for the Batch account."
+ },
+ "activeJobAndJobScheduleQuota": {
+ "readOnly": true,
+ "x-nullable": false,
+ "type": "integer",
+ "format": "int32",
+ "title": "The active job and job schedule quota for the Batch account."
+ }
+ },
+ "description": "Account specific properties."
+ },
+ "BatchAccount": {
+ "properties": {
+ "properties": {
+ "x-ms-client-flatten": true,
+ "$ref": "#/definitions/BatchAccountProperties",
+ "description": "The properties associated with the account."
+ },
+ "identity": {
+ "$ref": "#/definitions/BatchAccountIdentity",
+ "description": "The identity of the Batch account."
+ }
+ },
+ "allOf": [
+ {
+ "$ref": "#/definitions/Resource"
+ }
+ ],
+ "description": "Contains information about an Azure Batch account."
+ },
+ "BatchAccountUpdateParameters": {
+ "properties": {
+ "tags": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "The user-specified tags associated with the account."
+ },
+ "properties": {
+ "x-ms-client-flatten": true,
+ "$ref": "#/definitions/BatchAccountUpdateProperties",
+ "description": "The properties of the account."
+ },
+ "identity": {
+ "$ref": "#/definitions/BatchAccountIdentity",
+ "description": "The identity of the Batch account."
+ }
+ },
+ "description": "Parameters for updating an Azure Batch account."
+ },
+ "BatchAccountListResult": {
+ "properties": {
+ "value": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/BatchAccount"
+ },
+ "description": "The collection of Batch accounts returned by the listing operation."
+ },
+ "nextLink": {
+ "type": "string",
+ "description": "The continuation token."
+ }
+ },
+ "description": "Values returned by the List operation."
+ },
+ "EncryptionProperties": {
+ "properties": {
+ "keySource": {
+ "type": "string",
+ "description": "Type of the key source.",
+ "enum": [
+ "Microsoft.Batch",
+ "Microsoft.KeyVault"
+ ],
+ "x-ms-enum": {
+ "name": "KeySource",
+ "modelAsString": false,
+ "values": [
+ {
+ "value": "Microsoft.Batch",
+ "description": "Batch creates and manages the encryption keys used to protect the account data."
+ },
+ {
+ "value": "Microsoft.KeyVault",
+ "description": "The encryption keys used to protect the account data are stored in an external key vault. If this is set then the Batch Account identity must be set to `SystemAssigned` and a valid Key Identifier must also be supplied under the keyVaultProperties."
+ }
+ ]
+ }
+ },
+ "keyVaultProperties": {
+ "$ref": "#/definitions/KeyVaultProperties",
+ "description": "Additional details when using Microsoft.KeyVault"
+ }
+ },
+ "description": "Configures how customer data is encrypted inside the Batch account. By default, accounts are encrypted using a Microsoft managed key. For additional control, a customer-managed key can be used instead."
+ },
+ "KeyVaultProperties": {
+ "properties": {
+ "keyIdentifier": {
+ "type": "string",
+ "description": "Full path to the versioned secret. Example https://mykeyvault.vault.azure.net/keys/testkey/6e34a81fef704045975661e297a4c053. To be usable the following prerequisites must be met:\n\n The Batch Account has a System Assigned identity\n The account identity has been granted Key/Get, Key/Unwrap and Key/Wrap permissions\n The KeyVault has soft-delete and purge protection enabled"
+ }
+ },
+ "description": "KeyVault configuration when using an encryption KeySource of Microsoft.KeyVault."
+ },
+ "BatchAccountRegenerateKeyParameters": {
+ "properties": {
+ "keyName": {
+ "type": "string",
+ "description": "The type of account key to regenerate.",
+ "enum": [
+ "Primary",
+ "Secondary"
+ ],
+ "x-ms-enum": {
+ "name": "AccountKeyType",
+ "modelAsString": false,
+ "values": [
+ {
+ "value": "Primary",
+ "description": "The primary account key."
+ },
+ {
+ "value": "Secondary",
+ "description": "The secondary account key."
+ }
+ ]
+ }
+ }
+ },
+ "required": [
+ "keyName"
+ ],
+ "description": "Parameters supplied to the RegenerateKey operation."
+ },
+ "BatchAccountKeys": {
+ "properties": {
+ "accountName": {
+ "type": "string",
+ "readOnly": true,
+ "description": "The Batch account name."
+ },
+ "primary": {
+ "type": "string",
+ "readOnly": true,
+ "description": "The primary key associated with the account."
+ },
+ "secondary": {
+ "type": "string",
+ "readOnly": true,
+ "description": "The secondary key associated with the account."
+ }
+ },
+ "description": "A set of Azure Batch account keys."
+ },
+ "ActivateApplicationPackageParameters": {
+ "properties": {
+ "format": {
+ "type": "string",
+ "description": "The format of the application package binary file."
+ }
+ },
+ "required": [
+ "format"
+ ],
+ "description": "Parameters for an activating an application package."
+ },
+ "Application": {
+ "properties": {
+ "properties": {
+ "x-ms-client-flatten": true,
+ "$ref": "#/definitions/ApplicationProperties",
+ "description": "The properties associated with the Application."
+ }
+ },
+ "allOf": [
+ {
+ "$ref": "#/definitions/ProxyResource"
+ }
+ ],
+ "description": "Contains information about an application in a Batch account."
+ },
+ "ApplicationProperties": {
+ "properties": {
+ "displayName": {
+ "type": "string",
+ "description": "The display name for the application."
+ },
+ "allowUpdates": {
+ "type": "boolean",
+ "description": "A value indicating whether packages within the application may be overwritten using the same version string."
+ },
+ "defaultVersion": {
+ "type": "string",
+ "description": "The package to use if a client requests the application but does not specify a version. This property can only be set to the name of an existing package."
+ }
+ },
+ "description": "The properties associated with the Application."
+ },
+ "ApplicationPackage": {
+ "properties": {
+ "properties": {
+ "x-ms-client-flatten": true,
+ "$ref": "#/definitions/ApplicationPackageProperties",
+ "description": "The properties associated with the Application Package."
+ }
+ },
+ "allOf": [
+ {
+ "$ref": "#/definitions/ProxyResource"
+ }
+ ],
+ "description": "An application package which represents a particular version of an application."
+ },
+ "ApplicationPackageProperties": {
+ "properties": {
+ "state": {
+ "type": "string",
+ "readOnly": true,
+ "description": "The current state of the application package.",
+ "enum": [
+ "Pending",
+ "Active"
+ ],
+ "x-ms-enum": {
+ "name": "PackageState",
+ "modelAsString": false,
+ "values": [
+ {
+ "value": "Pending",
+ "description": "The application package has been created but has not yet been activated."
+ },
+ {
+ "value": "Active",
+ "description": "The application package is ready for use."
+ }
+ ]
+ }
+ },
+ "format": {
+ "type": "string",
+ "readOnly": true,
+ "description": "The format of the application package, if the package is active."
+ },
+ "storageUrl": {
+ "type": "string",
+ "readOnly": true,
+ "description": "The URL for the application package in Azure Storage."
+ },
+ "storageUrlExpiry": {
+ "type": "string",
+ "format": "date-time",
+ "readOnly": true,
+ "description": "The UTC time at which the Azure Storage URL will expire."
+ },
+ "lastActivationTime": {
+ "type": "string",
+ "format": "date-time",
+ "readOnly": true,
+ "description": "The time at which the package was last activated, if the package is active."
+ }
+ },
+ "description": "Properties of an application package"
+ },
+ "ListApplicationsResult": {
+ "properties": {
+ "value": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/Application"
+ },
+ "description": "The list of applications."
+ },
+ "nextLink": {
+ "type": "string",
+ "description": "The URL to get the next set of results."
+ }
+ },
+ "description": "The result of performing list applications."
+ },
+ "ListApplicationPackagesResult": {
+ "properties": {
+ "value": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ApplicationPackage"
+ },
+ "description": "The list of application packages."
+ },
+ "nextLink": {
+ "type": "string",
+ "description": "The URL to get the next set of results."
+ }
+ },
+ "description": "The result of performing list application packages."
+ },
+ "BatchLocationQuota": {
+ "properties": {
+ "accountQuota": {
+ "type": "integer",
+ "format": "int32",
+ "readOnly": true,
+ "description": "The number of Batch accounts that may be created under the subscription in the specified region."
+ }
+ },
+ "description": "Quotas associated with a Batch region for a particular subscription."
+ },
+ "Resource": {
+ "properties": {
+ "id": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The ID of the resource."
+ },
+ "name": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The name of the resource."
+ },
+ "type": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The type of the resource."
+ },
+ "location": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The location of the resource."
+ },
+ "tags": {
+ "readOnly": true,
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "The tags of the resource."
+ }
+ },
+ "description": "A definition of an Azure resource.",
+ "x-ms-azure-resource": true
+ },
+ "ProxyResource": {
+ "properties": {
+ "id": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The ID of the resource."
+ },
+ "name": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The name of the resource."
+ },
+ "type": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The type of the resource."
+ },
+ "etag": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The ETag of the resource, used for concurrency statements."
+ }
+ },
+ "description": "A definition of an Azure resource.",
+ "x-ms-azure-resource": true
+ },
+ "PublicNetworkAccessType": {
+ "type": "string",
+ "description": "The network access type for operating on the resources in the Batch account.",
+ "default": "Enabled",
+ "enum": [
+ "Enabled",
+ "Disabled"
+ ],
+ "x-ms-enum": {
+ "name": "PublicNetworkAccessType",
+ "modelAsString": false,
+ "values": [
+ {
+ "value": "Enabled",
+ "description": "Enables connectivity to Azure Batch through public DNS."
+ },
+ {
+ "value": "Disabled",
+ "description": "Disables public connectivity and enables private connectivity to Azure Batch Service through private endpoint resource."
+ }
+ ]
+ }
+ },
+ "PoolAllocationMode": {
+ "type": "string",
+ "description": "The allocation mode for creating pools in the Batch account.",
+ "enum": [
+ "BatchService",
+ "UserSubscription"
+ ],
+ "x-ms-enum": {
+ "name": "PoolAllocationMode",
+ "modelAsString": false,
+ "values": [
+ {
+ "value": "BatchService",
+ "description": "Pools will be allocated in subscriptions owned by the Batch service."
+ },
+ {
+ "value": "UserSubscription",
+ "description": "Pools will be allocated in a subscription owned by the user."
+ }
+ ]
+ }
+ },
+ "CertificateBaseProperties": {
+ "properties": {
+ "thumbprintAlgorithm": {
+ "type": "string",
+ "title": "The algorithm of the certificate thumbprint.",
+ "description": "This must match the first portion of the certificate name. Currently required to be 'SHA1'."
+ },
+ "thumbprint": {
+ "type": "string",
+ "title": "The thumbprint of the certificate.",
+ "description": "This must match the thumbprint from the name."
+ },
+ "format": {
+ "type": "string",
+ "x-nullable": false,
+ "description": "The format of the certificate - either Pfx or Cer. If omitted, the default is Pfx.",
+ "enum": [
+ "Pfx",
+ "Cer"
+ ],
+ "x-ms-enum": {
+ "name": "CertificateFormat",
+ "modelAsString": false,
+ "values": [
+ {
+ "value": "Pfx",
+ "description": "The certificate is a PFX (PKCS#12) formatted certificate or certificate chain."
+ },
+ {
+ "value": "Cer",
+ "description": "The certificate is a base64-encoded X.509 certificate."
+ }
+ ]
+ }
+ }
+ }
+ },
+ "CertificateProperties": {
+ "properties": {
+ "provisioningState": {
+ "type": "string",
+ "readOnly": true,
+ "x-nullable": false,
+ "title": "The provisioned state of the resource",
+ "enum": [
+ "Succeeded",
+ "Deleting",
+ "Failed"
+ ],
+ "x-ms-enum": {
+ "name": "CertificateProvisioningState",
+ "modelAsString": false,
+ "values": [
+ {
+ "value": "Succeeded",
+ "description": "The certificate is available for use in pools."
+ },
+ {
+ "value": "Deleting",
+ "description": "The user has requested that the certificate be deleted, but the delete operation has not yet completed. You may not reference the certificate when creating or updating pools."
+ },
+ {
+ "value": "Failed",
+ "description": "The user requested that the certificate be deleted, but there are pools that still have references to the certificate, or it is still installed on one or more compute nodes. (The latter can occur if the certificate has been removed from the pool, but the node has not yet restarted. Nodes refresh their certificates only when they restart.) You may use the cancel certificate delete operation to cancel the delete, or the delete certificate operation to retry the delete."
+ }
+ ]
+ }
+ },
+ "provisioningStateTransitionTime": {
+ "type": "string",
+ "format": "date-time",
+ "title": "The time at which the certificate entered its current state.",
+ "readOnly": true
+ },
+ "previousProvisioningState": {
+ "type": "string",
+ "readOnly": true,
+ "x-nullable": false,
+ "description": "The previous provisioned state of the resource",
+ "enum": [
+ "Succeeded",
+ "Deleting",
+ "Failed"
+ ],
+ "x-ms-enum": {
+ "name": "CertificateProvisioningState",
+ "modelAsString": false,
+ "values": [
+ {
+ "value": "Succeeded",
+ "description": "The certificate is available for use in pools."
+ },
+ {
+ "value": "Deleting",
+ "description": "The user has requested that the certificate be deleted, but the delete operation has not yet completed. You may not reference the certificate when creating or updating pools."
+ },
+ {
+ "value": "Failed",
+ "description": "The user requested that the certificate be deleted, but there are pools that still have references to the certificate, or it is still installed on one or more compute nodes. (The latter can occur if the certificate has been removed from the pool, but the node has not yet restarted. Nodes refresh their certificates only when they restart.) You may use the cancel certificate delete operation to cancel the delete, or the delete certificate operation to retry the delete."
+ }
+ ]
+ }
+ },
+ "previousProvisioningStateTransitionTime": {
+ "type": "string",
+ "format": "date-time",
+ "title": "The time at which the certificate entered its previous state.",
+ "readOnly": true
+ },
+ "publicData": {
+ "type": "string",
+ "readOnly": true,
+ "description": "The public key of the certificate."
+ },
+ "deleteCertificateError": {
+ "readOnly": true,
+ "$ref": "#/definitions/DeleteCertificateError",
+ "title": "The error which occurred while deleting the certificate",
+ "description": "This is only returned when the certificate provisioningState is 'Failed'."
+ }
+ },
+ "allOf": [
+ {
+ "$ref": "#/definitions/CertificateBaseProperties"
+ }
+ ],
+ "description": "Certificate properties."
+ },
+ "CertificateCreateOrUpdateProperties": {
+ "allOf": [
+ {
+ "$ref": "#/definitions/CertificateBaseProperties"
+ }
+ ],
+ "properties": {
+ "data": {
+ "type": "string",
+ "title": "The base64-encoded contents of the certificate.",
+ "description": "The maximum size is 10KB."
+ },
+ "password": {
+ "type": "string",
+ "title": "The password to access the certificate's private key.",
+ "description": "This must not be specified if the certificate format is Cer."
+ }
+ },
+ "description": "Certificate properties for create operations",
+ "required": [
+ "data"
+ ]
+ },
+ "Certificate": {
+ "properties": {
+ "properties": {
+ "x-ms-client-flatten": true,
+ "$ref": "#/definitions/CertificateProperties",
+ "description": "The properties associated with the certificate."
+ }
+ },
+ "allOf": [
+ {
+ "$ref": "#/definitions/ProxyResource"
+ }
+ ],
+ "description": "Contains information about a certificate."
+ },
+ "CertificateCreateOrUpdateParameters": {
+ "properties": {
+ "properties": {
+ "x-ms-client-flatten": true,
+ "$ref": "#/definitions/CertificateCreateOrUpdateProperties",
+ "description": "The properties associated with the certificate."
+ }
+ },
+ "allOf": [
+ {
+ "$ref": "#/definitions/ProxyResource"
+ }
+ ],
+ "description": "Contains information about a certificate."
+ },
+ "ListCertificatesResult": {
+ "properties": {
+ "value": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/Certificate"
+ },
+ "description": "The collection of returned certificates."
+ },
+ "nextLink": {
+ "type": "string",
+ "description": "The continuation token."
+ }
+ },
+ "description": "Values returned by the List operation."
+ },
+ "DeleteCertificateError": {
+ "properties": {
+ "code": {
+ "type": "string",
+ "description": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically."
+ },
+ "message": {
+ "type": "string",
+ "description": "A message describing the error, intended to be suitable for display in a user interface."
+ },
+ "target": {
+ "type": "string",
+ "description": "The target of the particular error. For example, the name of the property in error."
+ },
+ "details": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/DeleteCertificateError"
+ },
+ "description": "A list of additional details about the error."
+ }
+ },
+ "required": [
+ "code",
+ "message"
+ ],
+ "description": "An error response from the Batch service."
+ },
+ "PrivateLinkResource": {
+ "properties": {
+ "properties": {
+ "x-ms-client-flatten": true,
+ "$ref": "#/definitions/PrivateLinkResourceProperties",
+ "description": "The properties associated with the private link resource."
+ }
+ },
+ "allOf": [
+ {
+ "$ref": "#/definitions/ProxyResource"
+ }
+ ],
+ "description": "Contains information about a private link resource."
+ },
+ "PrivateLinkResourceProperties": {
+ "properties": {
+ "groupId": {
+ "type": "string",
+ "title": "The group id of the private link resource.",
+ "description": "The group id is used to establish the private link connection.",
+ "readOnly": true
+ },
+ "requiredMembers": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "title": "The list of required members that are used to establish the private link connection.",
+ "readOnly": true
+ },
+ "requiredZoneNames": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "title": "The list of required zone names for the private DNS resource name",
+ "readOnly": true
+ }
+ },
+ "description": "Private link resource properties."
+ },
+ "PrivateEndpointConnection": {
+ "properties": {
+ "properties": {
+ "x-ms-client-flatten": true,
+ "$ref": "#/definitions/PrivateEndpointConnectionProperties",
+ "description": "The properties associated with the private endpoint connection."
+ }
+ },
+ "allOf": [
+ {
+ "$ref": "#/definitions/ProxyResource"
+ }
+ ],
+ "description": "Contains information about a private link resource."
+ },
+ "PrivateEndpointConnectionProperties": {
+ "properties": {
+ "provisioningState": {
+ "type": "string",
+ "readOnly": true,
+ "x-nullable": false,
+ "title": "The provisioning state of the private endpoint connection.",
+ "enum": [
+ "Succeeded",
+ "Updating",
+ "Failed"
+ ],
+ "x-ms-enum": {
+ "name": "PrivateEndpointConnectionProvisioningState",
+ "modelAsString": false,
+ "values": [
+ {
+ "value": "Succeeded",
+ "description": "The connection status is final and is ready for use if Status is Approved."
+ },
+ {
+ "value": "Updating",
+ "description": "The user has requested that the connection status be updated, but the update operation has not yet completed. You may not reference the connection when connecting the Batch account."
+ },
+ {
+ "value": "Failed",
+ "description": "The user requested that the connection be updated and it failed. You may retry the update operation."
+ }
+ ]
+ }
+ },
+ "privateEndpoint": {
+ "$ref": "#/definitions/PrivateEndpoint",
+ "title": "The ARM resource identifier of the private endpoint."
+ },
+ "privateLinkServiceConnectionState": {
+ "$ref": "#/definitions/PrivateLinkServiceConnectionState",
+ "title": "The private link service connection state of the private endpoint connection."
+ }
+ },
+ "description": "Private endpoint connection properties."
+ },
+ "PrivateEndpoint": {
+ "properties": {
+ "id": {
+ "type": "string",
+ "title": "The ARM resource identifier of the private endpoint. This is of the form /subscriptions/{subscription}/resourceGroups/{group}/providers/Microsoft.Network/privateEndpoints/{privateEndpoint}.",
+ "readOnly": true
+ }
+ },
+ "description": "The private endpoint of the private endpoint connection."
+ },
+ "PrivateLinkServiceConnectionState": {
+ "properties": {
+ "status": {
+ "$ref": "#/definitions/PrivateLinkServiceConnectionStatus",
+ "title": "The status for the private endpoint connection of Batch account"
+ },
+ "description": {
+ "type": "string",
+ "title": "Description of the private Connection state"
+ },
+ "actionRequired": {
+ "type": "string",
+ "title": "Action required on the private connection state",
+ "readOnly": true
+ }
+ },
+ "required": [
+ "status"
+ ],
+ "description": "The private link service connection state of the private endpoint connection"
+ },
+ "PrivateLinkServiceConnectionStatus": {
+ "type": "string",
+ "title": "The status of the Batch private endpoint connection",
+ "enum": [
+ "Approved",
+ "Pending",
+ "Rejected",
+ "Disconnected"
+ ],
+ "x-ms-enum": {
+ "name": "PrivateLinkServiceConnectionStatus",
+ "modelAsString": false,
+ "values": [
+ {
+ "value": "Approved",
+ "description": "The private endpoint connection is approved and can be used to access Batch account"
+ },
+ {
+ "value": "Pending",
+ "description": "The private endpoint connection is pending and cannot be used to access Batch account"
+ },
+ {
+ "value": "Rejected",
+ "description": "The private endpoint connection is rejected and cannot be used to access Batch account"
+ },
+ {
+ "value": "Disconnected",
+ "description": "The private endpoint connection is disconnected and cannot be used to access Batch account"
+ }
+ ]
+ }
+ },
+ "Pool": {
+ "properties": {
+ "properties": {
+ "x-ms-client-flatten": true,
+ "$ref": "#/definitions/PoolProperties",
+ "description": "The properties associated with the pool."
+ }
+ },
+ "allOf": [
+ {
+ "$ref": "#/definitions/ProxyResource"
+ }
+ ],
+ "description": "Contains information about a pool."
+ },
+ "PoolProperties": {
+ "properties": {
+ "displayName": {
+ "type": "string",
+ "title": "The display name for the pool.",
+ "description": "The display name need not be unique and can contain any Unicode characters up to a maximum length of 1024."
+ },
+ "lastModified": {
+ "type": "string",
+ "format": "date-time",
+ "title": "The last modified time of the pool.",
+ "description": "This is the last time at which the pool level data, such as the targetDedicatedNodes or autoScaleSettings, changed. It does not factor in node-level changes such as a compute node changing state.",
+ "readOnly": true
+ },
+ "creationTime": {
+ "type": "string",
+ "format": "date-time",
+ "title": "The creation time of the pool.",
+ "readOnly": true
+ },
+ "provisioningState": {
+ "type": "string",
+ "title": "The current state of the pool.",
+ "enum": [
+ "Succeeded",
+ "Deleting"
+ ],
+ "x-ms-enum": {
+ "name": "PoolProvisioningState",
+ "modelAsString": false,
+ "values": [
+ {
+ "value": "Succeeded",
+ "description": "The pool is available to run tasks subject to the availability of compute nodes."
+ },
+ {
+ "value": "Deleting",
+ "description": "The user has requested that the pool be deleted, but the delete operation has not yet completed."
+ }
+ ]
+ },
+ "readOnly": true
+ },
+ "provisioningStateTransitionTime": {
+ "type": "string",
+ "format": "date-time",
+ "title": "The time at which the pool entered its current state.",
+ "readOnly": true
+ },
+ "allocationState": {
+ "type": "string",
+ "title": "Whether the pool is resizing.",
+ "enum": [
+ "Steady",
+ "Resizing",
+ "Stopping"
+ ],
+ "x-ms-enum": {
+ "name": "AllocationState",
+ "modelAsString": false,
+ "values": [
+ {
+ "value": "Steady",
+ "description": "The pool is not resizing. There are no changes to the number of nodes in the pool in progress. A pool enters this state when it is created and when no operations are being performed on the pool to change the number of nodes."
+ },
+ {
+ "value": "Resizing",
+ "description": "The pool is resizing; that is, compute nodes are being added to or removed from the pool."
+ },
+ {
+ "value": "Stopping",
+ "description": "The pool was resizing, but the user has requested that the resize be stopped, but the stop request has not yet been completed."
+ }
+ ]
+ },
+ "readOnly": true
+ },
+ "allocationStateTransitionTime": {
+ "type": "string",
+ "format": "date-time",
+ "title": "The time at which the pool entered its current allocation state.",
+ "readOnly": true
+ },
+ "vmSize": {
+ "type": "string",
+ "title": "The size of virtual machines in the pool. All VMs in a pool are the same size.",
+ "description": "For information about available sizes of virtual machines for Cloud Services pools (pools created with cloudServiceConfiguration), see Sizes for Cloud Services (https://azure.microsoft.com/documentation/articles/cloud-services-sizes-specs/). Batch supports all Cloud Services VM sizes except ExtraSmall. For information about available VM sizes for pools using images from the Virtual Machines Marketplace (pools created with virtualMachineConfiguration) see Sizes for Virtual Machines (Linux) (https://azure.microsoft.com/documentation/articles/virtual-machines-linux-sizes/) or Sizes for Virtual Machines (Windows) (https://azure.microsoft.com/documentation/articles/virtual-machines-windows-sizes/). Batch supports all Azure VM sizes except STANDARD_A0 and those with premium storage (STANDARD_GS, STANDARD_DS, and STANDARD_DSV2 series)."
+ },
+ "deploymentConfiguration": {
+ "$ref": "#/definitions/DeploymentConfiguration",
+ "title": "This property describes how the pool nodes will be deployed - using Cloud Services or Virtual Machines.",
+ "description": "Using CloudServiceConfiguration specifies that the nodes should be creating using Azure Cloud Services (PaaS), while VirtualMachineConfiguration uses Azure Virtual Machines (IaaS)."
+ },
+ "currentDedicatedNodes": {
+ "type": "integer",
+ "format": "int32",
+ "title": "The number of compute nodes currently in the pool.",
+ "readOnly": true
+ },
+ "currentLowPriorityNodes": {
+ "type": "integer",
+ "format": "int32",
+ "title": "The number of low priority compute nodes currently in the pool.",
+ "readOnly": true
+ },
+ "scaleSettings": {
+ "$ref": "#/definitions/ScaleSettings",
+ "title": "Settings which configure the number of nodes in the pool."
+ },
+ "autoScaleRun": {
+ "$ref": "#/definitions/AutoScaleRun",
+ "title": "The results and errors from the last execution of the autoscale formula.",
+ "description": "This property is set only if the pool automatically scales, i.e. autoScaleSettings are used.",
+ "readOnly": true
+ },
+ "interNodeCommunication": {
+ "type": "string",
+ "enum": [
+ "Enabled",
+ "Disabled"
+ ],
+ "x-ms-enum": {
+ "name": "InterNodeCommunicationState",
+ "modelAsString": false,
+ "values": [
+ {
+ "value": "Enabled",
+ "description": "Enable network communication between virtual machines."
+ },
+ {
+ "value": "Disabled",
+ "description": "Disable network communication between virtual machines."
+ }
+ ]
+ },
+ "title": "Whether the pool permits direct communication between nodes.",
+ "description": "This imposes restrictions on which nodes can be assigned to the pool. Enabling this value can reduce the chance of the requested number of nodes to be allocated in the pool. If not specified, this value defaults to 'Disabled'."
+ },
+ "networkConfiguration": {
+ "$ref": "#/definitions/NetworkConfiguration",
+ "title": "The network configuration for the pool."
+ },
+ "maxTasksPerNode": {
+ "type": "integer",
+ "format": "int32",
+ "title": "The maximum number of tasks that can run concurrently on a single compute node in the pool.",
+ "description": "The default value is 1. The maximum value is the smaller of 4 times the number of cores of the vmSize of the pool or 256."
+ },
+ "taskSchedulingPolicy": {
+ "$ref": "#/definitions/TaskSchedulingPolicy",
+ "title": "How tasks are distributed across compute nodes in a pool.",
+ "description": "If not specified, the default is spread."
+ },
+ "userAccounts": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/UserAccount"
+ },
+ "title": "The list of user accounts to be created on each node in the pool."
+ },
+ "metadata": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/MetadataItem"
+ },
+ "title": "A list of name-value pairs associated with the pool as metadata.",
+ "description": "The Batch service does not assign any meaning to metadata; it is solely for the use of user code."
+ },
+ "startTask": {
+ "$ref": "#/definitions/StartTask",
+ "title": "A task specified to run on each compute node as it joins the pool.",
+ "description": "In an PATCH (update) operation, this property can be set to an empty object to remove the start task from the pool."
+ },
+ "certificates": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/CertificateReference"
+ },
+ "title": "The list of certificates to be installed on each compute node in the pool.",
+ "description": "For Windows compute nodes, the Batch service installs the certificates to the specified certificate store and location. For Linux compute nodes, the certificates are stored in a directory inside the task working directory and an environment variable AZ_BATCH_CERTIFICATES_DIR is supplied to the task to query for this location. For certificates with visibility of 'remoteUser', a 'certs' directory is created in the user's home directory (e.g., /home/{user-name}/certs) and certificates are placed in that directory."
+ },
+ "applicationPackages": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ApplicationPackageReference"
+ },
+ "title": "The list of application packages to be installed on each compute node in the pool.",
+ "description": "Changes to application package references affect all new compute nodes joining the pool, but do not affect compute nodes that are already in the pool until they are rebooted or reimaged. There is a maximum of 10 application package references on any given pool."
+ },
+ "applicationLicenses": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "title": "The list of application licenses the Batch service will make available on each compute node in the pool.",
+ "description": "The list of application licenses must be a subset of available Batch service application licenses. If a license is requested which is not supported, pool creation will fail."
+ },
+ "resizeOperationStatus": {
+ "$ref": "#/definitions/ResizeOperationStatus",
+ "title": "Contains details about the current or last completed resize operation.",
+ "readOnly": true
+ },
+ "mountConfiguration": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/MountConfiguration"
+ },
+ "title": "A list of file systems to mount on each node in the pool.",
+ "description": "This supports Azure Files, NFS, CIFS/SMB, and Blobfuse."
+ }
+ },
+ "description": "Pool properties."
+ },
+ "DeploymentConfiguration": {
+ "properties": {
+ "cloudServiceConfiguration": {
+ "$ref": "#/definitions/CloudServiceConfiguration",
+ "title": "The cloud service configuration for the pool.",
+ "description": "This property and virtualMachineConfiguration are mutually exclusive and one of the properties must be specified. This property cannot be specified if the Batch account was created with its poolAllocationMode property set to 'UserSubscription'."
+ },
+ "virtualMachineConfiguration": {
+ "$ref": "#/definitions/VirtualMachineConfiguration",
+ "title": "The virtual machine configuration for the pool.",
+ "description": "This property and cloudServiceConfiguration are mutually exclusive and one of the properties must be specified."
+ }
+ },
+ "title": "Deployment configuration properties."
+ },
+ "ScaleSettings": {
+ "properties": {
+ "fixedScale": {
+ "$ref": "#/definitions/FixedScaleSettings",
+ "title": "Fixed scale settings for the pool.",
+ "description": "This property and autoScale are mutually exclusive and one of the properties must be specified."
+ },
+ "autoScale": {
+ "$ref": "#/definitions/AutoScaleSettings",
+ "title": "AutoScale settings for the pool.",
+ "description": "This property and fixedScale are mutually exclusive and one of the properties must be specified."
+ }
+ },
+ "title": "Scale settings for the pool",
+ "description": "Defines the desired size of the pool. This can either be 'fixedScale' where the requested targetDedicatedNodes is specified, or 'autoScale' which defines a formula which is periodically reevaluated. If this property is not specified, the pool will have a fixed scale with 0 targetDedicatedNodes."
+ },
+ "AutoScaleSettings": {
+ "properties": {
+ "formula": {
+ "type": "string",
+ "title": "A formula for the desired number of compute nodes in the pool.",
+ "externalDocs": {
+ "url": "https://docs.microsoft.com/en-us/azure/batch/batch-automatic-scaling",
+ "description": "Create an automatic scaling formula for scaling compute nodes in a Batch pool"
+ }
+ },
+ "evaluationInterval": {
+ "type": "string",
+ "format": "duration",
+ "title": "The time interval at which to automatically adjust the pool size according to the autoscale formula.",
+ "description": "If omitted, the default value is 15 minutes (PT15M)."
+ }
+ },
+ "required": [
+ "formula"
+ ],
+ "title": "AutoScale settings for the pool."
+ },
+ "FixedScaleSettings": {
+ "properties": {
+ "resizeTimeout": {
+ "type": "string",
+ "format": "duration",
+ "title": "The timeout for allocation of compute nodes to the pool.",
+ "description": "The default value is 15 minutes. Timeout values use ISO 8601 format. For example, use PT10M for 10 minutes. The minimum value is 5 minutes. If you specify a value less than 5 minutes, the Batch service rejects the request with an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request)."
+ },
+ "targetDedicatedNodes": {
+ "type": "integer",
+ "format": "int32",
+ "title": "The desired number of dedicated compute nodes in the pool.",
+ "description": "At least one of targetDedicatedNodes, targetLowPriorityNodes must be set."
+ },
+ "targetLowPriorityNodes": {
+ "type": "integer",
+ "format": "int32",
+ "title": "The desired number of low-priority compute nodes in the pool.",
+ "description": "At least one of targetDedicatedNodes, targetLowPriorityNodes must be set."
+ },
+ "nodeDeallocationOption": {
+ "title": "Determines what to do with a node and its running task(s) if the pool size is decreasing.",
+ "description": "If omitted, the default value is Requeue.",
+ "$ref": "#/definitions/ComputeNodeDeallocationOption"
+ }
+ },
+ "title": "Fixed scale settings for the pool."
+ },
+ "ComputeNodeDeallocationOption": {
+ "type": "string",
+ "title": "Determines what to do with a node and its running task(s) after it has been selected for deallocation.",
+ "enum": [
+ "Requeue",
+ "Terminate",
+ "TaskCompletion",
+ "RetainedData"
+ ],
+ "x-ms-enum": {
+ "name": "ComputeNodeDeallocationOption",
+ "modelAsString": false,
+ "values": [
+ {
+ "value": "Requeue",
+ "description": "Terminate running task processes and requeue the tasks. The tasks will run again when a node is available. Remove nodes as soon as tasks have been terminated."
+ },
+ {
+ "value": "Terminate",
+ "description": "Terminate running tasks. The tasks will be completed with failureInfo indicating that they were terminated, and will not run again. Remove nodes as soon as tasks have been terminated."
+ },
+ {
+ "value": "TaskCompletion",
+ "description": "Allow currently running tasks to complete. Schedule no new tasks while waiting. Remove nodes when all tasks have completed."
+ },
+ {
+ "value": "RetainedData",
+ "description": "Allow currently running tasks to complete, then wait for all task data retention periods to expire. Schedule no new tasks while waiting. Remove nodes when all task retention periods have expired."
+ }
+ ]
+ }
+ },
+ "CertificateReference": {
+ "properties": {
+ "id": {
+ "type": "string",
+ "title": "The fully qualified ID of the certificate to install on the pool. This must be inside the same batch account as the pool."
+ },
+ "storeLocation": {
+ "type": "string",
+ "title": "The location of the certificate store on the compute node into which to install the certificate.",
+ "description": "The default value is currentUser. This property is applicable only for pools configured with Windows nodes (that is, created with cloudServiceConfiguration, or with virtualMachineConfiguration using a Windows image reference). For Linux compute nodes, the certificates are stored in a directory inside the task working directory and an environment variable AZ_BATCH_CERTIFICATES_DIR is supplied to the task to query for this location. For certificates with visibility of 'remoteUser', a 'certs' directory is created in the user's home directory (e.g., /home/{user-name}/certs) and certificates are placed in that directory.",
+ "enum": [
+ "CurrentUser",
+ "LocalMachine"
+ ],
+ "x-ms-enum": {
+ "name": "CertificateStoreLocation",
+ "modelAsString": false,
+ "values": [
+ {
+ "value": "CurrentUser",
+ "description": "Certificates should be installed to the CurrentUser certificate store."
+ },
+ {
+ "value": "LocalMachine",
+ "description": "Certificates should be installed to the LocalMachine certificate store."
+ }
+ ]
+ }
+ },
+ "storeName": {
+ "type": "string",
+ "title": "The name of the certificate store on the compute node into which to install the certificate.",
+ "description": "This property is applicable only for pools configured with Windows nodes (that is, created with cloudServiceConfiguration, or with virtualMachineConfiguration using a Windows image reference). Common store names include: My, Root, CA, Trust, Disallowed, TrustedPeople, TrustedPublisher, AuthRoot, AddressBook, but any custom store name can also be used. The default value is My."
+ },
+ "visibility": {
+ "type": "array",
+ "items": {
+ "type": "string",
+ "x-nullable": false,
+ "enum": [
+ "StartTask",
+ "Task",
+ "RemoteUser"
+ ],
+ "x-ms-enum": {
+ "name": "CertificateVisibility",
+ "modelAsString": false,
+ "values": [
+ {
+ "value": "StartTask",
+ "description": "The certificate should be visible to the user account under which the start task is run. Note that if AutoUser Scope is Pool for both the StartTask and a Task, this certificate will be visible to the Task as well."
+ },
+ {
+ "value": "Task",
+ "description": "The certificate should be visible to the user accounts under which job tasks are run."
+ },
+ {
+ "value": "RemoteUser",
+ "description": "The certificate should be visible to the user accounts under which users remotely access the node."
+ }
+ ]
+ }
+ },
+ "title": "Which user accounts on the compute node should have access to the private data of the certificate."
+ }
+ },
+ "required": [
+ "id"
+ ],
+ "title": "A reference to a certificate to be installed on compute nodes in a pool. This must exist inside the same account as the pool."
+ },
+ "ApplicationPackageReference": {
+ "properties": {
+ "id": {
+ "type": "string",
+ "title": "The ID of the application package to install. This must be inside the same batch account as the pool. This can either be a reference to a specific version or the default version if one exists."
+ },
+ "version": {
+ "type": "string",
+ "title": "The version of the application to deploy. If omitted, the default version is deployed.",
+ "description": "If this is omitted, and no default version is specified for this application, the request fails with the error code InvalidApplicationPackageReferences. If you are calling the REST API directly, the HTTP status code is 409."
+ }
+ },
+ "title": "Link to an application package inside the batch account",
+ "required": [
+ "id"
+ ]
+ },
+ "ResizeError": {
+ "properties": {
+ "code": {
+ "type": "string",
+ "description": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically."
+ },
+ "message": {
+ "type": "string",
+ "description": "A message describing the error, intended to be suitable for display in a user interface."
+ },
+ "details": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ResizeError"
+ },
+ "title": "Additional details about the error."
+ }
+ },
+ "title": "An error that occurred when resizing a pool.",
+ "required": [
+ "code",
+ "message"
+ ]
+ },
+ "AutoScaleRunError": {
+ "properties": {
+ "code": {
+ "type": "string",
+ "description": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically."
+ },
+ "message": {
+ "type": "string",
+ "description": "A message describing the error, intended to be suitable for display in a user interface."
+ },
+ "details": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/AutoScaleRunError"
+ },
+ "title": "Additional details about the error."
+ }
+ },
+ "title": "An error that occurred when autoscaling a pool.",
+ "required": [
+ "code",
+ "message"
+ ]
+ },
+ "AutoScaleRun": {
+ "properties": {
+ "evaluationTime": {
+ "type": "string",
+ "format": "date-time",
+ "title": "The time at which the autoscale formula was last evaluated."
+ },
+ "results": {
+ "type": "string",
+ "title": "The final values of all variables used in the evaluation of the autoscale formula.",
+ "description": "Each variable value is returned in the form $variable=value, and variables are separated by semicolons."
+ },
+ "error": {
+ "$ref": "#/definitions/AutoScaleRunError",
+ "title": "Details of the error encountered evaluating the autoscale formula on the pool, if the evaluation was unsuccessful."
+ }
+ },
+ "required": [
+ "evaluationTime"
+ ],
+ "title": "The results and errors from an execution of a pool autoscale formula."
+ },
+ "VirtualMachineConfiguration": {
+ "properties": {
+ "imageReference": {
+ "$ref": "#/definitions/ImageReference",
+ "title": "A reference to the Azure Virtual Machines Marketplace Image or the custom Virtual Machine Image to use."
+ },
+ "nodeAgentSkuId": {
+ "type": "string",
+ "title": "The SKU of the Batch node agent to be provisioned on compute nodes in the pool.",
+ "description": "The Batch node agent is a program that runs on each node in the pool, and provides the command-and-control interface between the node and the Batch service. There are different implementations of the node agent, known as SKUs, for different operating systems. You must specify a node agent SKU which matches the selected image reference. To get the list of supported node agent SKUs along with their list of verified image references, see the 'List supported node agent SKUs' operation."
+ },
+ "windowsConfiguration": {
+ "$ref": "#/definitions/WindowsConfiguration",
+ "title": "Windows operating system settings on the virtual machine.",
+ "description": "This property must not be specified if the imageReference specifies a Linux OS image."
+ },
+ "dataDisks": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/DataDisk"
+ },
+ "title": "The configuration for data disks attached to the compute nodes in the pool.",
+ "description": "This property must be specified if the compute nodes in the pool need to have empty data disks attached to them."
+ },
+ "licenseType": {
+ "type": "string",
+ "title": "The type of on-premises license to be used when deploying the operating system.",
+ "description": "This only applies to images that contain the Windows operating system, and should only be used when you hold valid on-premises licenses for the nodes which will be deployed. If omitted, no on-premises licensing discount is applied. Values are:\n\n Windows_Server - The on-premises license is for Windows Server.\n Windows_Client - The on-premises license is for Windows Client.\n"
+ },
+ "containerConfiguration": {
+ "$ref": "#/definitions/ContainerConfiguration",
+ "title": "The container configuration for the pool.",
+ "description": "If specified, setup is performed on each node in the pool to allow tasks to run in containers. All regular tasks and job manager tasks run on this pool must specify the containerSettings property, and all other tasks may specify it."
+ },
+ "diskEncryptionConfiguration": {
+ "$ref": "#/definitions/DiskEncryptionConfiguration",
+ "title": "The disk encryption configuration for the pool.",
+ "description": "If specified, encryption is performed on each node in the pool during node provisioning."
+ }
+ },
+ "required": [
+ "imageReference",
+ "nodeAgentSkuId"
+ ],
+ "title": "The configuration for compute nodes in a pool based on the Azure Virtual Machines infrastructure."
+ },
+ "ContainerRegistry": {
+ "properties": {
+ "registryServer": {
+ "type": "string",
+ "title": "The registry URL.",
+ "description": "If omitted, the default is \"docker.io\"."
+ },
+ "username": {
+ "type": "string",
+ "x-ms-client-name": "userName",
+ "title": "The user name to log into the registry server."
+ },
+ "password": {
+ "type": "string",
+ "title": "The password to log into the registry server."
+ }
+ },
+ "required": [
+ "username",
+ "password"
+ ],
+ "title": "A private container registry."
+ },
+ "DiskEncryptionConfiguration": {
+ "properties": {
+ "targets": {
+ "type": "array",
+ "items": {
+ "type": "string",
+ "x-nullable": false,
+ "title": "The disks to encrypt on each compute node.",
+ "description": "If omitted, no disks on the compute nodes in the pool will be encrypted.",
+ "enum": [
+ "OsDisk",
+ "TemporaryDisk"
+ ],
+ "x-ms-enum": {
+ "name": "DiskEncryptionTarget",
+ "modelAsString": false,
+ "values": [
+ {
+ "value": "OsDisk",
+ "description": "The OS Disk on the compute node is encrypted.",
+ "name": "OsDisk"
+ },
+ {
+ "value": "TemporaryDisk",
+ "description": "The temporary disk on the compute node is encrypted. On Linux this encryption applies to other partitions (such as those on mounted data disks) when encryption occurs at boot time.",
+ "name": "TemporaryDisk"
+ }
+ ]
+ }
+ },
+ "title": "The list of disk targets Batch Service will encrypt on the compute node",
+ "description": "On Linux pool, only \"TemporaryDisk\" is supported; on Windows pool, \"OsDisk\" and \"TemporaryDisk\" must be specified."
+ }
+ },
+ "description": "The disk encryption configuration applied on compute nodes in the pool. Disk encryption configuration is not supported on Linux pool created with Virtual Machine Image or Shared Image Gallery Image."
+ },
+ "ContainerConfiguration": {
+ "properties": {
+ "type": {
+ "type": "string",
+ "title": "The container technology to be used.",
+ "enum": [
+ "DockerCompatible"
+ ],
+ "x-ms-enum": {
+ "name": "ContainerType",
+ "modelAsString": false,
+ "values": [
+ {
+ "value": "DockerCompatible",
+ "description": "A Docker compatible container technology will be used to launch the containers."
+ }
+ ]
+ }
+ },
+ "containerImageNames": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "title": "The collection of container image names.",
+ "description": "This is the full image reference, as would be specified to \"docker pull\". An image will be sourced from the default Docker registry unless the image is fully qualified with an alternative registry."
+ },
+ "containerRegistries": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ContainerRegistry"
+ },
+ "title": "Additional private registries from which containers can be pulled.",
+ "description": "If any images must be downloaded from a private registry which requires credentials, then those credentials must be provided here."
+ }
+ },
+ "required": [
+ "type"
+ ],
+ "title": "The configuration for container-enabled pools."
+ },
+ "WindowsConfiguration": {
+ "properties": {
+ "enableAutomaticUpdates": {
+ "type": "boolean",
+ "title": "Whether automatic updates are enabled on the virtual machine.",
+ "description": "If omitted, the default value is true."
+ }
+ },
+ "title": "Windows operating system settings to apply to the virtual machine."
+ },
+ "ImageReference": {
+ "properties": {
+ "publisher": {
+ "type": "string",
+ "title": "The publisher of the Azure Virtual Machines Marketplace image.",
+ "description": "For example, Canonical or MicrosoftWindowsServer."
+ },
+ "offer": {
+ "type": "string",
+ "title": "The offer type of the Azure Virtual Machines Marketplace image.",
+ "description": "For example, UbuntuServer or WindowsServer."
+ },
+ "sku": {
+ "type": "string",
+ "title": "The SKU of the Azure Virtual Machines Marketplace image.",
+ "description": "For example, 18.04-LTS or 2019-Datacenter."
+ },
+ "version": {
+ "type": "string",
+ "title": "The version of the Azure Virtual Machines Marketplace image.",
+ "description": "A value of 'latest' can be specified to select the latest version of an image. If omitted, the default is 'latest'."
+ },
+ "id": {
+ "type": "string",
+ "title": "The ARM resource identifier of the Shared Image Gallery Image. Compute Nodes in the Pool will be created using this Image Id. This is of the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName}/versions/{versionId}.",
+ "description": "This property is mutually exclusive with other properties. The Shared Image Gallery image must have replicas in the same region as the Azure Batch account. For information about the firewall settings for the Batch node agent to communicate with the Batch service see https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration."
+ }
+ },
+ "title": "A reference to an Azure Virtual Machines Marketplace image or the Azure Image resource of a custom Virtual Machine. To get the list of all imageReferences verified by Azure Batch, see the 'List supported node agent SKUs' operation."
+ },
+ "DataDisk": {
+ "properties": {
+ "lun": {
+ "type": "integer",
+ "format": "int32",
+ "title": "The logical unit number.",
+ "description": "The lun is used to uniquely identify each data disk. If attaching multiple disks, each should have a distinct lun."
+ },
+ "caching": {
+ "$ref": "#/definitions/CachingType",
+ "title": "The type of caching to be enabled for the data disks.",
+ "description": "Values are:\n\n none - The caching mode for the disk is not enabled.\n readOnly - The caching mode for the disk is read only.\n readWrite - The caching mode for the disk is read and write.\n\n The default value for caching is none. For information about the caching options see: https://blogs.msdn.microsoft.com/windowsazurestorage/2012/06/27/exploring-windows-azure-drives-disks-and-images/."
+ },
+ "diskSizeGB": {
+ "type": "integer",
+ "format": "int32",
+ "title": "The initial disk size in GB when creating new data disk."
+ },
+ "storageAccountType": {
+ "title": "The storage account type to be used for the data disk.",
+ "description": "If omitted, the default is \"Standard_LRS\". Values are:\n\n Standard_LRS - The data disk should use standard locally redundant storage.\n Premium_LRS - The data disk should use premium locally redundant storage.",
+ "$ref": "#/definitions/StorageAccountType"
+ }
+ },
+ "required": [
+ "lun",
+ "diskSizeGB"
+ ],
+ "description": "Settings which will be used by the data disks associated to Compute Nodes in the Pool. When using attached data disks, you need to mount and format the disks from within a VM to use them."
+ },
+ "TaskSchedulingPolicy": {
+ "properties": {
+ "nodeFillType": {
+ "type": "string",
+ "title": "How tasks should be distributed across compute nodes.",
+ "enum": [
+ "Spread",
+ "Pack"
+ ],
+ "x-ms-enum": {
+ "name": "ComputeNodeFillType",
+ "modelAsString": false,
+ "values": [
+ {
+ "value": "Spread",
+ "description": "Tasks should be assigned evenly across all nodes in the pool."
+ },
+ {
+ "value": "Pack",
+ "description": "As many tasks as possible (maxTasksPerNode) should be assigned to each node in the pool before any tasks are assigned to the next node in the pool."
+ }
+ ]
+ }
+ }
+ },
+ "required": [
+ "nodeFillType"
+ ],
+ "title": "Specifies how tasks should be distributed across compute nodes."
+ },
+ "LinuxUserConfiguration": {
+ "properties": {
+ "uid": {
+ "type": "integer",
+ "format": "int32",
+ "title": "The user ID of the user account.",
+ "description": "The uid and gid properties must be specified together or not at all. If not specified the underlying operating system picks the uid."
+ },
+ "gid": {
+ "type": "integer",
+ "format": "int32",
+ "title": "The group ID for the user account.",
+ "description": "The uid and gid properties must be specified together or not at all. If not specified the underlying operating system picks the gid."
+ },
+ "sshPrivateKey": {
+ "type": "string",
+ "title": "The SSH private key for the user account.",
+ "description": "The private key must not be password protected. The private key is used to automatically configure asymmetric-key based authentication for SSH between nodes in a Linux pool when the pool's enableInterNodeCommunication property is true (it is ignored if enableInterNodeCommunication is false). It does this by placing the key pair into the user's .ssh directory. If not specified, password-less SSH is not configured between nodes (no modification of the user's .ssh directory is done)."
+ }
+ },
+ "title": "Properties used to create a user account on a Linux node."
+ },
+ "WindowsUserConfiguration": {
+ "properties": {
+ "loginMode": {
+ "type": "string",
+ "title": "Login mode for user",
+ "description": "Specifies login mode for the user. The default value for VirtualMachineConfiguration pools is interactive mode and for CloudServiceConfiguration pools is batch mode.",
+ "enum": [
+ "Batch",
+ "Interactive"
+ ],
+ "x-ms-enum": {
+ "name": "LoginMode",
+ "modelAsString": false,
+ "values": [
+ {
+ "value": "Batch",
+ "description": "The LOGON32_LOGON_BATCH Win32 login mode. The batch login mode is recommended for long running parallel processes."
+ },
+ {
+ "value": "Interactive",
+ "description": "The LOGON32_LOGON_INTERACTIVE Win32 login mode. Some applications require having permissions associated with the interactive login mode. If this is the case for an application used in your task, then this option is recommended."
+ }
+ ]
+ }
+ }
+ },
+ "title": "Properties used to create a user account on a Windows node."
+ },
+ "UserAccount": {
+ "properties": {
+ "name": {
+ "type": "string",
+ "title": "The name of the user account."
+ },
+ "password": {
+ "type": "string",
+ "title": "The password for the user account."
+ },
+ "elevationLevel": {
+ "title": "The elevation level of the user account.",
+ "description": "nonAdmin - The auto user is a standard user without elevated access. admin - The auto user is a user with elevated access and operates with full Administrator permissions. The default value is nonAdmin.",
+ "$ref": "#/definitions/ElevationLevel"
+ },
+ "linuxUserConfiguration": {
+ "title": "The Linux-specific user configuration for the user account.",
+ "description": "This property is ignored if specified on a Windows pool. If not specified, the user is created with the default options.",
+ "$ref": "#/definitions/LinuxUserConfiguration"
+ },
+ "windowsUserConfiguration": {
+ "title": "The Windows-specific user configuration for the user account.",
+ "description": "This property can only be specified if the user is on a Windows pool. If not specified and on a Windows pool, the user is created with the default options.",
+ "$ref": "#/definitions/WindowsUserConfiguration"
+ }
+ },
+ "required": [
+ "name",
+ "password"
+ ],
+ "title": "Properties used to create a user on an Azure Batch node."
+ },
+ "StartTask": {
+ "properties": {
+ "commandLine": {
+ "type": "string",
+ "title": "The command line of the start task.",
+ "description": "The command line does not run under a shell, and therefore cannot take advantage of shell features such as environment variable expansion. If you want to take advantage of such features, you should invoke the shell in the command line, for example using \"cmd /c MyCommand\" in Windows or \"/bin/sh -c MyCommand\" in Linux. Required if any other properties of the startTask are specified."
+ },
+ "resourceFiles": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ResourceFile"
+ },
+ "title": "A list of files that the Batch service will download to the compute node before running the command line."
+ },
+ "environmentSettings": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/EnvironmentSetting"
+ },
+ "title": "A list of environment variable settings for the start task."
+ },
+ "userIdentity": {
+ "$ref": "#/definitions/UserIdentity",
+ "title": "The user identity under which the start task runs.",
+ "description": "If omitted, the task runs as a non-administrative user unique to the task."
+ },
+ "maxTaskRetryCount": {
+ "type": "integer",
+ "format": "int32",
+ "title": "The maximum number of times the task may be retried.",
+ "description": "The Batch service retries a task if its exit code is nonzero. Note that this value specifically controls the number of retries. The Batch service will try the task once, and may then retry up to this limit. For example, if the maximum retry count is 3, Batch tries the task up to 4 times (one initial try and 3 retries). If the maximum retry count is 0, the Batch service does not retry the task. If the maximum retry count is -1, the Batch service retries the task without limit."
+ },
+ "waitForSuccess": {
+ "type": "boolean",
+ "title": "Whether the Batch service should wait for the start task to complete successfully (that is, to exit with exit code 0) before scheduling any tasks on the compute node.",
+ "description": "If true and the start task fails on a compute node, the Batch service retries the start task up to its maximum retry count (maxTaskRetryCount). If the task has still not completed successfully after all retries, then the Batch service marks the compute node unusable, and will not schedule tasks to it. This condition can be detected via the node state and scheduling error detail. If false, the Batch service will not wait for the start task to complete. In this case, other tasks can start executing on the compute node while the start task is still running; and even if the start task fails, new tasks will continue to be scheduled on the node. The default is true."
+ },
+ "containerSettings": {
+ "$ref": "#/definitions/TaskContainerSettings",
+ "title": "The settings for the container under which the start task runs.",
+ "description": "When this is specified, all directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) are mapped into the container, all task environment variables are mapped into the container, and the task command line is executed in the container."
+ }
+ },
+ "title": "A task which is run when a compute node joins a pool in the Azure Batch service, or when the compute node is rebooted or reimaged.",
+ "description": "In some cases the start task may be re-run even though the node was not rebooted. Due to this, start tasks should be idempotent and exit gracefully if the setup they're performing has already been done. Special care should be taken to avoid start tasks which create breakaway process or install/launch services from the start task working directory, as this will block Batch from being able to re-run the start task."
+ },
+ "TaskContainerSettings": {
+ "properties": {
+ "containerRunOptions": {
+ "type": "string",
+ "title": "Additional options to the container create command.",
+ "description": "These additional options are supplied as arguments to the \"docker create\" command, in addition to those controlled by the Batch Service."
+ },
+ "imageName": {
+ "type": "string",
+ "title": "The image to use to create the container in which the task will run.",
+ "description": "This is the full image reference, as would be specified to \"docker pull\". If no tag is provided as part of the image name, the tag \":latest\" is used as a default."
+ },
+ "registry": {
+ "$ref": "#/definitions/ContainerRegistry",
+ "title": "The private registry which contains the container image.",
+ "description": "This setting can be omitted if was already provided at pool creation."
+ },
+ "workingDirectory": {
+ "type": "string",
+ "title": "A flag to indicate where the container task working directory is. The default is 'taskWorkingDirectory'.",
+ "enum": [
+ "TaskWorkingDirectory",
+ "ContainerImageDefault"
+ ],
+ "x-ms-enum": {
+ "name": "ContainerWorkingDirectory",
+ "modelAsString": false,
+ "values": [
+ {
+ "value": "TaskWorkingDirectory",
+ "description": "Use the standard Batch service task working directory, which will contain the Task resource files populated by Batch."
+ },
+ {
+ "value": "ContainerImageDefault",
+ "description": "Using container image defined working directory. Beware that this directory will not contain the resource files downloaded by Batch."
+ }
+ ]
+ }
+ }
+ },
+ "required": [
+ "imageName"
+ ],
+ "title": "The container settings for a task."
+ },
+ "ResourceFile": {
+ "properties": {
+ "autoStorageContainerName": {
+ "type": "string",
+ "title": "The storage container name in the auto storage account.",
+ "description": "The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified."
+ },
+ "storageContainerUrl": {
+ "type": "string",
+ "title": "The URL of the blob container within Azure Blob Storage.",
+ "description": "The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified. This URL must be readable and listable using anonymous access; that is, the Batch service does not present any credentials when downloading the blob. There are two ways to get such a URL for a blob in Azure storage: include a Shared Access Signature (SAS) granting read and list permissions on the blob, or set the ACL for the blob or its container to allow public access."
+ },
+ "httpUrl": {
+ "type": "string",
+ "title": "The URL of the file to download.",
+ "description": "The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified. If the URL is Azure Blob Storage, it must be readable using anonymous access; that is, the Batch service does not present any credentials when downloading the blob. There are two ways to get such a URL for a blob in Azure storage: include a Shared Access Signature (SAS) granting read permissions on the blob, or set the ACL for the blob or its container to allow public access."
+ },
+ "blobPrefix": {
+ "type": "string",
+ "title": "The blob prefix to use when downloading blobs from an Azure Storage container. Only the blobs whose names begin with the specified prefix will be downloaded.",
+ "description": "The property is valid only when autoStorageContainerName or storageContainerUrl is used. This prefix can be a partial filename or a subdirectory. If a prefix is not specified, all the files in the container will be downloaded."
+ },
+ "filePath": {
+ "type": "string",
+ "title": "The location on the compute node to which to download the file, relative to the task's working directory.",
+ "description": "If the httpUrl property is specified, the filePath is required and describes the path which the file will be downloaded to, including the filename. Otherwise, if the autoStorageContainerName or storageContainerUrl property is specified, filePath is optional and is the directory to download the files to. In the case where filePath is used as a directory, any directory structure already associated with the input data will be retained in full and appended to the specified filePath directory. The specified relative path cannot break out of the task's working directory (for example by using '..')."
+ },
+ "fileMode": {
+ "type": "string",
+ "title": "The file permission mode attribute in octal format.",
+ "description": "This property applies only to files being downloaded to Linux compute nodes. It will be ignored if it is specified for a resourceFile which will be downloaded to a Windows node. If this property is not specified for a Linux node, then a default value of 0770 is applied to the file."
+ }
+ },
+ "title": "A single file or multiple files to be downloaded to a compute node."
+ },
+ "EnvironmentSetting": {
+ "properties": {
+ "name": {
+ "type": "string",
+ "title": "The name of the environment variable."
+ },
+ "value": {
+ "type": "string",
+ "title": "The value of the environment variable."
+ }
+ },
+ "required": [
+ "name"
+ ],
+ "title": "An environment variable to be set on a task process."
+ },
+ "UserIdentity": {
+ "properties": {
+ "userName": {
+ "type": "string",
+ "title": "The name of the user identity under which the task is run.",
+ "description": "The userName and autoUser properties are mutually exclusive; you must specify one but not both."
+ },
+ "autoUser": {
+ "$ref": "#/definitions/AutoUserSpecification",
+ "title": "The auto user under which the task is run.",
+ "description": "The userName and autoUser properties are mutually exclusive; you must specify one but not both."
+ }
+ },
+ "title": "The definition of the user identity under which the task is run.",
+ "description": "Specify either the userName or autoUser property, but not both."
+ },
+ "AutoUserSpecification": {
+ "properties": {
+ "scope": {
+ "type": "string",
+ "title": "The scope for the auto user",
+ "description": "The default value is Pool. If the pool is running Windows a value of Task should be specified if stricter isolation between tasks is required. For example, if the task mutates the registry in a way which could impact other tasks, or if certificates have been specified on the pool which should not be accessible by normal tasks but should be accessible by start tasks.",
+ "enum": [
+ "Task",
+ "Pool"
+ ],
+ "x-ms-enum": {
+ "name": "AutoUserScope",
+ "modelAsString": false,
+ "values": [
+ {
+ "value": "Task",
+ "description": "Specifies that the service should create a new user for the task."
+ },
+ {
+ "value": "Pool",
+ "description": "Specifies that the task runs as the common auto user account which is created on every node in a pool."
+ }
+ ]
+ }
+ },
+ "elevationLevel": {
+ "title": "The elevation level of the auto user.",
+ "description": "The default value is nonAdmin.",
+ "$ref": "#/definitions/ElevationLevel"
+ }
+ },
+ "title": "Specifies the parameters for the auto user that runs a task on the Batch service."
+ },
+ "ElevationLevel": {
+ "type": "string",
+ "title": "The elevation level of the user.",
+ "enum": [
+ "NonAdmin",
+ "Admin"
+ ],
+ "x-ms-enum": {
+ "name": "ElevationLevel",
+ "modelAsString": false,
+ "values": [
+ {
+ "value": "NonAdmin",
+ "description": "The user is a standard user without elevated access."
+ },
+ {
+ "value": "Admin",
+ "description": "The user is a user with elevated access and operates with full Administrator permissions."
+ }
+ ]
+ }
+ },
+ "StorageAccountType": {
+ "type": "string",
+ "title": "The storage account type for use in creating data disks.",
+ "enum": [
+ "Standard_LRS",
+ "Premium_LRS"
+ ],
+ "x-ms-enum": {
+ "name": "StorageAccountType",
+ "modelAsString": false,
+ "values": [
+ {
+ "value": "Standard_LRS",
+ "description": "The data disk should use standard locally redundant storage."
+ },
+ {
+ "value": "Premium_LRS",
+ "description": "The data disk should use premium locally redundant storage."
+ }
+ ]
+ }
+ },
+ "CachingType": {
+ "type": "string",
+ "title": "The type of caching to enable for the disk.",
+ "enum": [
+ "None",
+ "ReadOnly",
+ "ReadWrite"
+ ],
+ "x-ms-enum": {
+ "name": "CachingType",
+ "modelAsString": false,
+ "values": [
+ {
+ "value": "None",
+ "description": "The caching mode for the disk is not enabled."
+ },
+ {
+ "value": "ReadOnly",
+ "description": "The caching mode for the disk is read only."
+ },
+ {
+ "value": "ReadWrite",
+ "description": "The caching mode for the disk is read and write."
+ }
+ ]
+ }
+ },
+ "IPAddressProvisioningType": {
+ "type": "string",
+ "title": "The provisioning type for Public IP Addresses for the Batch Pool.",
+ "enum": [
+ "BatchManaged",
+ "UserManaged",
+ "NoPublicIPAddresses"
+ ],
+ "x-ms-enum": {
+ "name": "IPAddressProvisioningType",
+ "modelAsString": false,
+ "values": [
+ {
+ "value": "BatchManaged",
+ "description": "A public IP will be created and managed by Batch. There may be multiple public IPs depending on the size of the Pool."
+ },
+ {
+ "value": "UserManaged",
+ "description": "Public IPs are provided by the user and will be used to provision the Compute Nodes."
+ },
+ {
+ "value": "NoPublicIPAddresses",
+ "description": "No public IP Address will be created for the Compute Nodes in the Pool."
+ }
+ ]
+ }
+ },
+ "PublicIPAddressConfiguration": {
+ "properties": {
+ "provision": {
+ "$ref": "#/definitions/IPAddressProvisioningType",
+ "title": "The provisioning type for Public IP Addresses for the pool",
+ "description": "The default value is BatchManaged"
+ },
+ "ipAddressIds": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "title": "The list of public IPs which the Batch service will use when provisioning Compute Nodes.",
+ "description": "The number of IPs specified here limits the maximum size of the Pool - 50 dedicated nodes or 20 low-priority nodes can be allocated for each public IP. For example, a pool needing 150 dedicated VMs would need at least 3 public IPs specified. Each element of this collection is of the form: /subscriptions/{subscription}/resourceGroups/{group}/providers/Microsoft.Network/publicIPAddresses/{ip}."
+ }
+ },
+ "description": "The public IP Address configuration of the networking configuration of a Pool."
+ },
+ "NetworkConfiguration": {
+ "properties": {
+ "subnetId": {
+ "type": "string",
+ "title": "The ARM resource identifier of the virtual network subnet which the compute nodes of the pool will join. This is of the form /subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}.",
+ "description": "The virtual network must be in the same region and subscription as the Azure Batch account. The specified subnet should have enough free IP addresses to accommodate the number of nodes in the pool. If the subnet doesn't have enough free IP addresses, the pool will partially allocate compute nodes and a resize error will occur. The 'MicrosoftAzureBatch' service principal must have the 'Classic Virtual Machine Contributor' Role-Based Access Control (RBAC) role for the specified VNet. The specified subnet must allow communication from the Azure Batch service to be able to schedule tasks on the compute nodes. This can be verified by checking if the specified VNet has any associated Network Security Groups (NSG). If communication to the compute nodes in the specified subnet is denied by an NSG, then the Batch service will set the state of the compute nodes to unusable. If the specified VNet has any associated Network Security Groups (NSG), then a few reserved system ports must be enabled for inbound communication. For pools created with a virtual machine configuration, enable ports 29876 and 29877, as well as port 22 for Linux and port 3389 for Windows. For pools created with a cloud service configuration, enable ports 10100, 20100, and 30100. Also enable outbound connections to Azure Storage on port 443. For cloudServiceConfiguration pools, only 'classic' VNETs are supported. For more details see: https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration",
+ "externalDocs": {
+ "url": "https://azure.microsoft.com/en-us/documentation/articles/role-based-access-built-in-roles/#classic-virtual-machine-contributor",
+ "description": "Setting up RBAC for Azure Batch VNets"
+ }
+ },
+ "endpointConfiguration": {
+ "$ref": "#/definitions/PoolEndpointConfiguration",
+ "title": "The configuration for endpoints on compute nodes in the Batch pool.",
+ "description": "Pool endpoint configuration is only supported on pools with the virtualMachineConfiguration property."
+ },
+ "publicIPAddressConfiguration": {
+ "$ref": "#/definitions/PublicIPAddressConfiguration",
+ "title": "The Public IPAddress configuration for Compute Nodes in the Batch Pool.",
+ "description": "This property is only supported on Pools with the virtualMachineConfiguration property."
+ }
+ },
+ "description": "The network configuration for a pool."
+ },
+ "CloudServiceConfiguration": {
+ "properties": {
+ "osFamily": {
+ "type": "string",
+ "title": "The Azure Guest OS family to be installed on the virtual machines in the pool.",
+ "description": "Possible values are: 2 - OS Family 2, equivalent to Windows Server 2008 R2 SP1. 3 - OS Family 3, equivalent to Windows Server 2012. 4 - OS Family 4, equivalent to Windows Server 2012 R2. 5 - OS Family 5, equivalent to Windows Server 2016. 6 - OS Family 6, equivalent to Windows Server 2019. For more information, see Azure Guest OS Releases (https://azure.microsoft.com/documentation/articles/cloud-services-guestos-update-matrix/#releases)."
+ },
+ "osVersion": {
+ "type": "string",
+ "title": "The Azure Guest OS version to be installed on the virtual machines in the pool.",
+ "description": "The default value is * which specifies the latest operating system version for the specified OS family."
+ }
+ },
+ "required": [
+ "osFamily"
+ ],
+ "title": "The configuration for nodes in a pool based on the Azure Cloud Services platform."
+ },
+ "MetadataItem": {
+ "properties": {
+ "name": {
+ "type": "string",
+ "title": "The name of the metadata item."
+ },
+ "value": {
+ "type": "string",
+ "title": "The value of the metadata item."
+ }
+ },
+ "required": [
+ "name",
+ "value"
+ ],
+ "title": "A name-value pair associated with a Batch service resource.",
+ "description": "The Batch service does not assign any meaning to this metadata; it is solely for the use of user code."
+ },
+ "ResizeOperationStatus": {
+ "properties": {
+ "targetDedicatedNodes": {
+ "type": "integer",
+ "format": "int32",
+ "title": "The desired number of dedicated compute nodes in the pool."
+ },
+ "targetLowPriorityNodes": {
+ "type": "integer",
+ "format": "int32",
+ "title": "The desired number of low-priority compute nodes in the pool."
+ },
+ "resizeTimeout": {
+ "type": "string",
+ "format": "duration",
+ "title": "The timeout for allocation of compute nodes to the pool or removal of compute nodes from the pool.",
+ "description": "The default value is 15 minutes. The minimum value is 5 minutes. If you specify a value less than 5 minutes, the Batch service returns an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request)."
+ },
+ "nodeDeallocationOption": {
+ "title": "Determines what to do with a node and its running task(s) if the pool size is decreasing.",
+ "description": "The default value is requeue.",
+ "$ref": "#/definitions/ComputeNodeDeallocationOption"
+ },
+ "startTime": {
+ "type": "string",
+ "format": "date-time",
+ "title": "The time when this resize operation was started."
+ },
+ "errors": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ResizeError"
+ },
+ "title": "Details of any errors encountered while performing the last resize on the pool.",
+ "description": "This property is set only if an error occurred during the last pool resize, and only when the pool allocationState is Steady."
+ }
+ },
+ "title": "Details about the current or last completed resize operation.",
+ "description": "Describes either the current operation (if the pool AllocationState is Resizing) or the previously completed operation (if the AllocationState is Steady)."
+ },
+ "PoolEndpointConfiguration": {
+ "properties": {
+ "inboundNatPools": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/InboundNatPool"
+ },
+ "title": "A list of inbound NAT pools that can be used to address specific ports on an individual compute node externally.",
+ "description": "The maximum number of inbound NAT pools per Batch pool is 5. If the maximum number of inbound NAT pools is exceeded the request fails with HTTP status code 400."
+ }
+ },
+ "required": [
+ "inboundNatPools"
+ ],
+ "title": "The endpoint configuration for a pool."
+ },
+ "InboundNatPool": {
+ "properties": {
+ "name": {
+ "type": "string",
+ "title": "The name of the endpoint.",
+ "description": "The name must be unique within a Batch pool, can contain letters, numbers, underscores, periods, and hyphens. Names must start with a letter or number, must end with a letter, number, or underscore, and cannot exceed 77 characters. If any invalid values are provided the request fails with HTTP status code 400."
+ },
+ "protocol": {
+ "type": "string",
+ "title": "The protocol of the endpoint.",
+ "enum": [
+ "TCP",
+ "UDP"
+ ],
+ "x-ms-enum": {
+ "name": "InboundEndpointProtocol",
+ "modelAsString": false,
+ "values": [
+ {
+ "value": "TCP",
+ "description": "Use TCP for the endpoint."
+ },
+ {
+ "value": "UDP",
+ "description": "Use UDP for the endpoint."
+ }
+ ]
+ }
+ },
+ "backendPort": {
+ "type": "integer",
+ "format": "int32",
+ "title": "The port number on the compute node.",
+ "description": "This must be unique within a Batch pool. Acceptable values are between 1 and 65535 except for 22, 3389, 29876 and 29877 as these are reserved. If any reserved values are provided the request fails with HTTP status code 400."
+ },
+ "frontendPortRangeStart": {
+ "type": "integer",
+ "format": "int32",
+ "title": "The first port number in the range of external ports that will be used to provide inbound access to the backendPort on individual compute nodes.",
+ "description": "Acceptable values range between 1 and 65534 except ports from 50000 to 55000 which are reserved. All ranges within a pool must be distinct and cannot overlap. If any reserved or overlapping values are provided the request fails with HTTP status code 400."
+ },
+ "frontendPortRangeEnd": {
+ "type": "integer",
+ "format": "int32",
+ "title": "The last port number in the range of external ports that will be used to provide inbound access to the backendPort on individual compute nodes.",
+ "description": "Acceptable values range between 1 and 65534 except ports from 50000 to 55000 which are reserved by the Batch service. All ranges within a pool must be distinct and cannot overlap. If any reserved or overlapping values are provided the request fails with HTTP status code 400."
+ },
+ "networkSecurityGroupRules": {
+ "type": "array",
+ "title": "A list of network security group rules that will be applied to the endpoint.",
+ "description": "The maximum number of rules that can be specified across all the endpoints on a Batch pool is 25. If no network security group rules are specified, a default rule will be created to allow inbound access to the specified backendPort. If the maximum number of network security group rules is exceeded the request fails with HTTP status code 400.",
+ "items": {
+ "$ref": "#/definitions/NetworkSecurityGroupRule"
+ }
+ }
+ },
+ "required": [
+ "name",
+ "protocol",
+ "backendPort",
+ "frontendPortRangeStart",
+ "frontendPortRangeEnd"
+ ],
+ "title": "A inbound NAT pool that can be used to address specific ports on compute nodes in a Batch pool externally."
+ },
+ "NetworkSecurityGroupRule": {
+ "properties": {
+ "priority": {
+ "type": "integer",
+ "format": "int32",
+ "title": "The priority for this rule.",
+ "description": "Priorities within a pool must be unique and are evaluated in order of priority. The lower the number the higher the priority. For example, rules could be specified with order numbers of 150, 250, and 350. The rule with the order number of 150 takes precedence over the rule that has an order of 250. Allowed priorities are 150 to 4096. If any reserved or duplicate values are provided the request fails with HTTP status code 400."
+ },
+ "access": {
+ "type": "string",
+ "title": "The action that should be taken for a specified IP address, subnet range or tag.",
+ "enum": [
+ "Allow",
+ "Deny"
+ ],
+ "x-ms-enum": {
+ "name": "NetworkSecurityGroupRuleAccess",
+ "modelAsString": false,
+ "values": [
+ {
+ "value": "Allow",
+ "description": "Allow access."
+ },
+ {
+ "value": "Deny",
+ "description": "Deny access."
+ }
+ ]
+ }
+ },
+ "sourceAddressPrefix": {
+ "type": "string",
+ "title": "The source address prefix or tag to match for the rule.",
+ "description": "Valid values are a single IP address (i.e. 10.10.10.10), IP subnet (i.e. 192.168.1.0/24), default tag, or * (for all addresses). If any other values are provided the request fails with HTTP status code 400."
+ },
+ "sourcePortRanges": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "title": "The source port ranges to match for the rule.",
+ "description": "Valid values are '*' (for all ports 0 - 65535) or arrays of ports or port ranges (i.e. 100-200). The ports should in the range of 0 to 65535 and the port ranges or ports can't overlap. If any other values are provided the request fails with HTTP status code 400. Default value will be *."
+ }
+ },
+ "required": [
+ "priority",
+ "access",
+ "sourceAddressPrefix"
+ ],
+ "title": "A network security group rule to apply to an inbound endpoint."
+ },
+ "ListPrivateLinkResourcesResult": {
+ "properties": {
+ "value": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/PrivateLinkResource"
+ },
+ "description": "The collection of returned private link resources."
+ },
+ "nextLink": {
+ "type": "string",
+ "description": "The continuation token."
+ }
+ },
+ "description": "Values returned by the List operation."
+ },
+ "ListPrivateEndpointConnectionsResult": {
+ "properties": {
+ "value": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/PrivateEndpointConnection"
+ },
+ "description": "The collection of returned private endpoint connection."
+ },
+ "nextLink": {
+ "type": "string",
+ "description": "The continuation token."
+ }
+ },
+ "description": "Values returned by the List operation."
+ },
+ "ListPoolsResult": {
+ "properties": {
+ "value": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/Pool"
+ },
+ "description": "The collection of returned pools."
+ },
+ "nextLink": {
+ "type": "string",
+ "description": "The continuation token."
+ }
+ },
+ "description": "Values returned by the List operation."
+ },
+ "CloudError": {
+ "x-ms-external": true,
+ "properties": {
+ "error": {
+ "$ref": "#/definitions/CloudErrorBody"
+ }
+ },
+ "description": "An error response from the Batch service."
+ },
+ "CloudErrorBody": {
+ "x-ms-external": true,
+ "properties": {
+ "code": {
+ "type": "string",
+ "description": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically."
+ },
+ "message": {
+ "type": "string",
+ "description": "A message describing the error, intended to be suitable for display in a user interface."
+ },
+ "target": {
+ "type": "string",
+ "description": "The target of the particular error. For example, the name of the property in error."
+ },
+ "details": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/CloudErrorBody"
+ },
+ "description": "A list of additional details about the error."
+ }
+ },
+ "description": "An error response from the Batch service."
+ },
+ "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, or listKeys/action",
+ "type": "string"
+ },
+ "resource": {
+ "title": "The resource type on which the operation is performed.",
+ "type": "string"
+ },
+ "description": {
+ "title": "The friendly name of the operation",
+ "type": "string"
+ }
+ }
+ },
+ "origin": {
+ "title": "The intended executor of the operation.",
+ "type": "string"
+ },
+ "properties": {
+ "title": "Properties of the operation.",
+ "type": "object"
+ }
+ }
+ },
+ "OperationListResult": {
+ "title": "Result of the request to list REST API operations. It contains a list of operations and a URL nextLink to get the next set of results.",
+ "properties": {
+ "value": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/Operation"
+ },
+ "title": "The list of operations supported by the resource provider."
+ },
+ "nextLink": {
+ "type": "string",
+ "title": "The URL to get the next set of operation list results if there are any."
+ }
+ }
+ },
+ "CheckNameAvailabilityParameters": {
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "The name to check for availability"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Microsoft.Batch/batchAccounts"
+ ],
+ "x-ms-enum": {
+ "name": "ResourceType",
+ "modelAsString": false,
+ "values": [
+ {
+ "value": "Microsoft.Batch/batchAccounts",
+ "description": "The Batch account resource type.",
+ "name": "BatchAccounts"
+ }
+ ]
+ },
+ "description": "The resource type."
+ }
+ },
+ "required": [
+ "name",
+ "type"
+ ],
+ "description": "Parameters for a check name availability request."
+ },
+ "CheckNameAvailabilityResult": {
+ "properties": {
+ "nameAvailable": {
+ "readOnly": true,
+ "type": "boolean",
+ "description": "Gets a boolean value that indicates whether the name is available for you to use. If true, the name is available. If false, the name has already been taken or invalid and cannot be used."
+ },
+ "reason": {
+ "readOnly": true,
+ "type": "string",
+ "enum": [
+ "Invalid",
+ "AlreadyExists"
+ ],
+ "x-ms-enum": {
+ "name": "NameAvailabilityReason",
+ "modelAsString": false,
+ "values": [
+ {
+ "value": "Invalid",
+ "description": "The requested name is invalid."
+ },
+ {
+ "value": "AlreadyExists",
+ "description": "The requested name is already in use."
+ }
+ ]
+ },
+ "description": "Gets the reason that a Batch account name could not be used. The Reason element is only returned if NameAvailable is false."
+ },
+ "message": {
+ "readOnly": true,
+ "type": "string",
+ "description": "Gets an error message explaining the Reason value in more detail."
+ }
+ },
+ "description": "The CheckNameAvailability operation response."
+ },
+ "MountConfiguration": {
+ "properties": {
+ "azureBlobFileSystemConfiguration": {
+ "$ref": "#/definitions/AzureBlobFileSystemConfiguration",
+ "title": "The Azure Storage Container to mount using blob FUSE on each node.",
+ "description": "This property is mutually exclusive with all other properties."
+ },
+ "nfsMountConfiguration": {
+ "$ref": "#/definitions/NFSMountConfiguration",
+ "title": "The NFS file system to mount on each node.",
+ "description": "This property is mutually exclusive with all other properties."
+ },
+ "cifsMountConfiguration": {
+ "$ref": "#/definitions/CIFSMountConfiguration",
+ "title": "The CIFS/SMB file system to mount on each node.",
+ "description": "This property is mutually exclusive with all other properties."
+ },
+ "azureFileShareConfiguration": {
+ "$ref": "#/definitions/AzureFileShareConfiguration",
+ "title": "The Azure File Share to mount on each node.",
+ "description": "This property is mutually exclusive with all other properties."
+ }
+ },
+ "title": "The file system to mount on each node."
+ },
+ "AzureBlobFileSystemConfiguration": {
+ "properties": {
+ "accountName": {
+ "type": "string",
+ "title": "The Azure Storage Account name."
+ },
+ "containerName": {
+ "type": "string",
+ "title": "The Azure Blob Storage Container name."
+ },
+ "accountKey": {
+ "type": "string",
+ "title": "The Azure Storage Account key.",
+ "description": "This property is mutually exclusive with sasKey and one must be specified."
+ },
+ "sasKey": {
+ "type": "string",
+ "title": "The Azure Storage SAS token.",
+ "description": "This property is mutually exclusive with accountKey and one must be specified."
+ },
+ "blobfuseOptions": {
+ "type": "string",
+ "title": "Additional command line options to pass to the mount command.",
+ "description": "These are 'net use' options in Windows and 'mount' options in Linux."
+ },
+ "relativeMountPath": {
+ "type": "string",
+ "title": "The relative path on the compute node where the file system will be mounted",
+ "description": "All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable."
+ }
+ },
+ "required": [
+ "accountName",
+ "containerName",
+ "relativeMountPath"
+ ],
+ "title": "Information used to connect to an Azure Storage Container using Blobfuse."
+ },
+ "NFSMountConfiguration": {
+ "properties": {
+ "source": {
+ "type": "string",
+ "title": "The URI of the file system to mount."
+ },
+ "relativeMountPath": {
+ "type": "string",
+ "title": "The relative path on the compute node where the file system will be mounted",
+ "description": "All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable."
+ },
+ "mountOptions": {
+ "type": "string",
+ "title": "Additional command line options to pass to the mount command.",
+ "description": "These are 'net use' options in Windows and 'mount' options in Linux."
+ }
+ },
+ "required": [
+ "source",
+ "relativeMountPath"
+ ],
+ "title": "Information used to connect to an NFS file system."
+ },
+ "CIFSMountConfiguration": {
+ "properties": {
+ "username": {
+ "type": "string",
+ "title": "The user to use for authentication against the CIFS file system."
+ },
+ "source": {
+ "type": "string",
+ "title": "The URI of the file system to mount."
+ },
+ "relativeMountPath": {
+ "type": "string",
+ "title": "The relative path on the compute node where the file system will be mounted",
+ "description": "All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable."
+ },
+ "mountOptions": {
+ "type": "string",
+ "title": "Additional command line options to pass to the mount command.",
+ "description": "These are 'net use' options in Windows and 'mount' options in Linux."
+ },
+ "password": {
+ "type": "string",
+ "title": "The password to use for authentication against the CIFS file system."
+ }
+ },
+ "required": [
+ "username",
+ "source",
+ "password",
+ "relativeMountPath"
+ ],
+ "title": "Information used to connect to a CIFS file system."
+ },
+ "AzureFileShareConfiguration": {
+ "properties": {
+ "accountName": {
+ "type": "string",
+ "title": "The Azure Storage account name."
+ },
+ "azureFileUrl": {
+ "type": "string",
+ "title": "The Azure Files URL.",
+ "description": "This is of the form 'https://{account}.file.core.windows.net/'."
+ },
+ "accountKey": {
+ "type": "string",
+ "title": "The Azure Storage account key."
+ },
+ "relativeMountPath": {
+ "type": "string",
+ "title": "The relative path on the compute node where the file system will be mounted",
+ "description": "All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable."
+ },
+ "mountOptions": {
+ "type": "string",
+ "title": "Additional command line options to pass to the mount command.",
+ "description": "These are 'net use' options in Windows and 'mount' options in Linux."
+ }
+ },
+ "required": [
+ "accountName",
+ "azureFileUrl",
+ "accountKey",
+ "relativeMountPath"
+ ],
+ "title": "Information used to connect to an Azure Fileshare."
+ }
+ },
+ "parameters": {
+ "SubscriptionIdParameter": {
+ "name": "subscriptionId",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000)"
+ },
+ "ApiVersionParameter": {
+ "name": "api-version",
+ "in": "query",
+ "required": true,
+ "type": "string",
+ "description": "The API version to be used with the HTTP request."
+ },
+ "ResourceGroupNameParameter": {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group that contains the Batch account.",
+ "x-ms-parameter-location": "method"
+ },
+ "AccountNameParameter": {
+ "name": "accountName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9]+$",
+ "minLength": 3,
+ "maxLength": 24,
+ "description": "The name of the Batch account.",
+ "x-ms-parameter-location": "method"
+ },
+ "CertificateNameParameter": {
+ "name": "certificateName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "pattern": "^[\\w]+-[\\w]+$",
+ "minLength": 5,
+ "maxLength": 45,
+ "description": "The identifier for the certificate. This must be made up of algorithm and thumbprint separated by a dash, and must match the certificate data in the request. For example SHA1-a3d1c5.",
+ "x-ms-parameter-location": "method"
+ },
+ "PoolNameParameter": {
+ "name": "poolName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9_-]+$",
+ "minLength": 1,
+ "maxLength": 64,
+ "description": "The pool name. This must be unique within the account.",
+ "x-ms-parameter-location": "method"
+ },
+ "PrivateLinkResourceNameParameter": {
+ "name": "privateLinkResourceName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9_-]+\\.?[a-fA-F0-9-]*$",
+ "minLength": 1,
+ "maxLength": 101,
+ "description": "The private link resource name. This must be unique within the account.",
+ "x-ms-parameter-location": "method"
+ },
+ "PrivateEndpointConnectionNameParameter": {
+ "name": "privateEndpointConnectionName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9_-]+\\.?[a-fA-F0-9-]*$",
+ "minLength": 1,
+ "maxLength": 101,
+ "description": "The private endpoint connection name. This must be unique within the account.",
+ "x-ms-parameter-location": "method"
+ },
+ "ApplicationNameParameter": {
+ "name": "applicationName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9_-]+$",
+ "minLength": 1,
+ "maxLength": 64,
+ "description": "The name of the application. This must be unique within the account.",
+ "x-ms-parameter-location": "method"
+ },
+ "VersionNameParameter": {
+ "name": "versionName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9_-][a-zA-Z0-9_.-]*$",
+ "minLength": 1,
+ "maxLength": 64,
+ "description": "The version of the application.",
+ "x-ms-parameter-location": "method"
+ }
+ }
+}
diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/examples/ApplicationCreate.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/examples/ApplicationCreate.json
new file mode 100644
index 000000000000..16009a56c7bb
--- /dev/null
+++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/examples/ApplicationCreate.json
@@ -0,0 +1,32 @@
+{
+ "parameters": {
+ "accountName": "sampleacct",
+ "resourceGroupName": "default-azurebatch-japaneast",
+ "api-version": "2020-05-01",
+ "subscriptionId": "subid",
+ "applicationName": "app1",
+ "parameters": {
+ "properties": {
+ "allowUpdates": false,
+ "displayName": "myAppName"
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "headers": {
+ "ETag": "W/\"0x8D64F8EBB3DC411\""
+ },
+ "body": {
+ "type": "Microsoft.Batch/batchAccounts/applications",
+ "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/applications/app1",
+ "name": "app1",
+ "etag": "W/\"0x8D64F8EBB3DC411\"",
+ "properties": {
+ "allowUpdates": false,
+ "displayName": "myAppName"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/examples/ApplicationDelete.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/examples/ApplicationDelete.json
new file mode 100644
index 000000000000..e8f03a6df4f0
--- /dev/null
+++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/examples/ApplicationDelete.json
@@ -0,0 +1,13 @@
+{
+ "parameters": {
+ "accountName": "sampleacct",
+ "resourceGroupName": "default-azurebatch-japaneast",
+ "api-version": "2020-05-01",
+ "subscriptionId": "subid",
+ "applicationName": "app1"
+ },
+ "responses": {
+ "200": {},
+ "204": {}
+ }
+}
diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/examples/ApplicationGet.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/examples/ApplicationGet.json
new file mode 100644
index 000000000000..dd5c284ca55f
--- /dev/null
+++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/examples/ApplicationGet.json
@@ -0,0 +1,26 @@
+{
+ "parameters": {
+ "accountName": "sampleacct",
+ "resourceGroupName": "default-azurebatch-japaneast",
+ "api-version": "2020-05-01",
+ "subscriptionId": "subid",
+ "applicationName": "app1"
+ },
+ "responses": {
+ "200": {
+ "headers": {
+ "ETag": "W/\"0x8D64F915BDF7F00\""
+ },
+ "body": {
+ "type": "Microsoft.Batch/batchAccounts/applications",
+ "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/applications/app1",
+ "name": "app1",
+ "etag": "W/\"0x8D64F915BDF7F00\"",
+ "properties": {
+ "allowUpdates": true,
+ "displayName": "Sample Application"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/examples/ApplicationList.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/examples/ApplicationList.json
new file mode 100644
index 000000000000..651478cdd313
--- /dev/null
+++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/examples/ApplicationList.json
@@ -0,0 +1,37 @@
+{
+ "parameters": {
+ "accountName": "sampleacct",
+ "resourceGroupName": "default-azurebatch-japaneast",
+ "api-version": "2020-05-01",
+ "subscriptionId": "subid"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "type": "Microsoft.Batch/batchAccounts/applications",
+ "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/applications/app1",
+ "name": "app1",
+ "etag": "W/\"0x8D64F91A9089879\"",
+ "properties": {
+ "allowUpdates": false,
+ "defaultVersion": "1"
+ }
+ },
+ {
+ "type": "Microsoft.Batch/batchAccounts/applications",
+ "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/applications/app2",
+ "name": "app1",
+ "etag": "W/\"0x8D64F91A9089879\"",
+ "properties": {
+ "allowUpdates": false,
+ "defaultVersion": "2.0",
+ "displayName": "myAppName"
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/examples/ApplicationPackageActivate.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/examples/ApplicationPackageActivate.json
new file mode 100644
index 000000000000..c1c09f9b22e3
--- /dev/null
+++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/examples/ApplicationPackageActivate.json
@@ -0,0 +1,31 @@
+{
+ "parameters": {
+ "accountName": "sampleacct",
+ "resourceGroupName": "default-azurebatch-japaneast",
+ "api-version": "2020-05-01",
+ "subscriptionId": "subid",
+ "applicationName": "app1",
+ "versionName": "1",
+ "parameters": {
+ "format": "zip"
+ }
+ },
+ "responses": {
+ "200": {
+ "headers": {
+ "ETag": "W/\"0x8D64FEC83A3B436\""
+ },
+ "body": {
+ "type": "Microsoft.Batch/batchAccounts/applications/versions",
+ "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/applications/app1/versions/1",
+ "name": "1",
+ "etag": "W/\"0x8D64FEC83A3B436\"",
+ "properties": {
+ "state": "Active",
+ "format": "zip",
+ "lastActivationTime": "2017-06-27T18:48:09.9330991Z"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/examples/ApplicationPackageCreate.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/examples/ApplicationPackageCreate.json
new file mode 100644
index 000000000000..e0fd8532640a
--- /dev/null
+++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/examples/ApplicationPackageCreate.json
@@ -0,0 +1,28 @@
+{
+ "parameters": {
+ "accountName": "sampleacct",
+ "resourceGroupName": "default-azurebatch-japaneast",
+ "api-version": "2020-05-01",
+ "subscriptionId": "subid",
+ "applicationName": "app1",
+ "versionName": "1"
+ },
+ "responses": {
+ "200": {
+ "headers": {
+ "ETag": "W/\"0x8D64FEC83A3B436\""
+ },
+ "body": {
+ "type": "Microsoft.Batch/batchAccounts/applications/versions",
+ "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/applications/app1/versions/1",
+ "name": "1",
+ "etag": "W/\"0x8D64FEC83A3B436\"",
+ "properties": {
+ "storageUrl": "http://mystorage1.blob.core.windows.net/myapp?mysas",
+ "storageUrlExpiry": "2017-06-27T18:48:09.9330991Z",
+ "state": "Pending"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/examples/ApplicationPackageDelete.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/examples/ApplicationPackageDelete.json
new file mode 100644
index 000000000000..ebe52d66c821
--- /dev/null
+++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/examples/ApplicationPackageDelete.json
@@ -0,0 +1,14 @@
+{
+ "parameters": {
+ "accountName": "sampleacct",
+ "resourceGroupName": "default-azurebatch-japaneast",
+ "api-version": "2020-05-01",
+ "subscriptionId": "subid",
+ "applicationName": "app1",
+ "versionName": "1"
+ },
+ "responses": {
+ "200": {},
+ "204": {}
+ }
+}
diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/examples/ApplicationPackageGet.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/examples/ApplicationPackageGet.json
new file mode 100644
index 000000000000..28709cf90aec
--- /dev/null
+++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/examples/ApplicationPackageGet.json
@@ -0,0 +1,28 @@
+{
+ "parameters": {
+ "accountName": "sampleacct",
+ "resourceGroupName": "default-azurebatch-japaneast",
+ "api-version": "2020-05-01",
+ "subscriptionId": "subid",
+ "applicationName": "app1",
+ "versionName": "1"
+ },
+ "responses": {
+ "200": {
+ "headers": {
+ "ETag": "W/\"0x8D64FEC83A3B436\""
+ },
+ "body": {
+ "type": "Microsoft.Batch/batchAccounts/applications/versions",
+ "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/applications/app1/versions/1",
+ "name": "1",
+ "etag": "W/\"0x8D64FEC83A3B436\"",
+ "properties": {
+ "state": "Active",
+ "format": "zip",
+ "lastActivationTime": "2017-06-27T18:48:09.9330991Z"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/examples/ApplicationPackageList.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/examples/ApplicationPackageList.json
new file mode 100644
index 000000000000..6fe30818df6b
--- /dev/null
+++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/examples/ApplicationPackageList.json
@@ -0,0 +1,37 @@
+{
+ "parameters": {
+ "accountName": "sampleacct",
+ "resourceGroupName": "default-azurebatch-japaneast",
+ "api-version": "2020-05-01",
+ "subscriptionId": "subid",
+ "applicationName": "app1"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "type": "Microsoft.Batch/batchAccounts/applications/versions",
+ "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/applications/app1/versions/1.0",
+ "name": "1.0",
+ "etag": "W/\"0x8D64FF0B9F47F67\"",
+ "properties": {
+ "state": "Pending"
+ }
+ },
+ {
+ "type": "Microsoft.Batch/batchAccounts/applications/versions",
+ "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/applications/app1/versions/2.0",
+ "name": "2.0",
+ "etag": "W/\"0x8D64FF0B9F47F67\"",
+ "properties": {
+ "state": "Active",
+ "format": "zip",
+ "lastActivationTime": "2017-06-27T18:48:09.9330991Z"
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/examples/ApplicationUpdate.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/examples/ApplicationUpdate.json
new file mode 100644
index 000000000000..f081a5a7caef
--- /dev/null
+++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/examples/ApplicationUpdate.json
@@ -0,0 +1,34 @@
+{
+ "parameters": {
+ "accountName": "sampleacct",
+ "resourceGroupName": "default-azurebatch-japaneast",
+ "api-version": "2020-05-01",
+ "subscriptionId": "subid",
+ "applicationName": "app1",
+ "parameters": {
+ "properties": {
+ "allowUpdates": true,
+ "displayName": "myAppName",
+ "defaultVersion": "2"
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "headers": {
+ "ETag": "W/\"0x8D64F915BDF7F00\""
+ },
+ "body": {
+ "type": "Microsoft.Batch/batchAccounts/applications",
+ "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/applications/app1",
+ "name": "app1",
+ "etag": "W/\"0x8D64F915BDF7F00\"",
+ "properties": {
+ "allowUpdates": true,
+ "displayName": "myAppName",
+ "defaultVersion": "2"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/examples/BatchAccountCreate_BYOS.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/examples/BatchAccountCreate_BYOS.json
new file mode 100644
index 000000000000..ad1deeb87891
--- /dev/null
+++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/examples/BatchAccountCreate_BYOS.json
@@ -0,0 +1,53 @@
+{
+ "parameters": {
+ "accountName": "sampleacct",
+ "resourceGroupName": "default-azurebatch-japaneast",
+ "api-version": "2020-05-01",
+ "subscriptionId": "subid",
+ "parameters": {
+ "location": "japaneast",
+ "properties": {
+ "autoStorage": {
+ "storageAccountId": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Storage/storageAccounts/samplestorage"
+ },
+ "poolAllocationMode": "UserSubscription",
+ "keyVaultReference": {
+ "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.KeyVault/vaults/sample",
+ "url": "http://sample.vault.azure.net/"
+ }
+ }
+ }
+ },
+ "responses": {
+ "202": {},
+ "200": {
+ "body": {
+ "name": "sampleacct",
+ "location": "japaneast",
+ "properties": {
+ "accountEndpoint": "sampleacct.japaneast.batch.azure.com",
+ "provisioningState": "Succeeded",
+ "poolAllocationMode": "UserSubscription",
+ "dedicatedCoreQuota": 20,
+ "lowPriorityCoreQuota": 20,
+ "poolQuota": 20,
+ "activeJobAndJobScheduleQuota": 20,
+ "autoStorage": {
+ "storageAccountId": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Storage/storageAccounts/samplestorage",
+ "lastKeySync": "2016-03-10T23:48:38.9878479Z"
+ },
+ "keyVaultReference": {
+ "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.KeyVault/vaults/sample",
+ "url": "http://sample.vault.azure.net/"
+ },
+ "publicNetworkAccess": "Enabled"
+ },
+ "identity": {
+ "type": "None"
+ },
+ "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct",
+ "type": "Microsoft.Batch/batchAccounts"
+ }
+ }
+ }
+}
diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/examples/BatchAccountCreate_Default.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/examples/BatchAccountCreate_Default.json
new file mode 100644
index 000000000000..37ae0bdcc728
--- /dev/null
+++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/examples/BatchAccountCreate_Default.json
@@ -0,0 +1,44 @@
+{
+ "parameters": {
+ "accountName": "sampleacct",
+ "resourceGroupName": "default-azurebatch-japaneast",
+ "api-version": "2020-05-01",
+ "subscriptionId": "subid",
+ "parameters": {
+ "location": "japaneast",
+ "properties": {
+ "autoStorage": {
+ "storageAccountId": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Storage/storageAccounts/samplestorage"
+ }
+ }
+ }
+ },
+ "responses": {
+ "202": {},
+ "200": {
+ "body": {
+ "name": "sampleacct",
+ "location": "japaneast",
+ "properties": {
+ "accountEndpoint": "sampleacct.japaneast.batch.azure.com",
+ "provisioningState": "Succeeded",
+ "poolAllocationMode": "BatchService",
+ "dedicatedCoreQuota": 20,
+ "lowPriorityCoreQuota": 20,
+ "poolQuota": 20,
+ "activeJobAndJobScheduleQuota": 20,
+ "autoStorage": {
+ "storageAccountId": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Storage/storageAccounts/samplestorage",
+ "lastKeySync": "2016-03-10T23:48:38.9878479Z"
+ },
+ "publicNetworkAccess": "Enabled"
+ },
+ "identity": {
+ "type": "None"
+ },
+ "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct",
+ "type": "Microsoft.Batch/batchAccounts"
+ }
+ }
+ }
+}
diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/examples/BatchAccountCreate_SystemAssignedIdentity.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/examples/BatchAccountCreate_SystemAssignedIdentity.json
new file mode 100644
index 000000000000..bf48db1bffb9
--- /dev/null
+++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/examples/BatchAccountCreate_SystemAssignedIdentity.json
@@ -0,0 +1,49 @@
+{
+ "parameters": {
+ "accountName": "sampleacct",
+ "resourceGroupName": "default-azurebatch-japaneast",
+ "api-version": "2020-05-01",
+ "subscriptionId": "subid",
+ "parameters": {
+ "location": "japaneast",
+ "properties": {
+ "autoStorage": {
+ "storageAccountId": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Storage/storageAccounts/samplestorage"
+ }
+ },
+ "identity": {
+ "type": "SystemAssigned"
+ }
+ }
+ },
+ "responses": {
+ "202": {},
+ "200": {
+ "body": {
+ "name": "sampleacct",
+ "location": "japaneast",
+ "properties": {
+ "accountEndpoint": "sampleacct.japaneast.batch.azure.com",
+ "provisioningState": "Succeeded",
+ "poolAllocationMode": "BatchService",
+ "dedicatedCoreQuota": 20,
+ "lowPriorityCoreQuota": 20,
+ "poolQuota": 20,
+ "activeJobAndJobScheduleQuota": 20,
+ "autoStorage": {
+ "storageAccountId": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Storage/storageAccounts/samplestorage",
+ "lastKeySync": "2016-03-10T23:48:38.9878479Z"
+ },
+ "publicNetworkAccess": "Enabled"
+ },
+ "identity": {
+ "principalId": "1a2e532b-9900-414c-8600-cfc6126628d7",
+ "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd",
+ "type": "SystemAssigned"
+ },
+ "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct",
+ "type": "Microsoft.Batch/batchAccounts"
+ }
+ }
+ }
+}
diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/examples/BatchAccountDelete.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/examples/BatchAccountDelete.json
new file mode 100644
index 000000000000..9103547c7136
--- /dev/null
+++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/examples/BatchAccountDelete.json
@@ -0,0 +1,13 @@
+{
+ "parameters": {
+ "accountName": "sampleacct",
+ "resourceGroupName": "default-azurebatch-japaneast",
+ "api-version": "2020-05-01",
+ "subscriptionId": "subid"
+ },
+ "responses": {
+ "200": {},
+ "202": {},
+ "204": {}
+ }
+}
diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/examples/BatchAccountGet.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/examples/BatchAccountGet.json
new file mode 100644
index 000000000000..401016113385
--- /dev/null
+++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/examples/BatchAccountGet.json
@@ -0,0 +1,35 @@
+{
+ "parameters": {
+ "accountName": "sampleacct",
+ "resourceGroupName": "default-azurebatch-japaneast",
+ "api-version": "2020-05-01",
+ "subscriptionId": "subid"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "name": "sampleacct",
+ "location": "japaneast",
+ "properties": {
+ "accountEndpoint": "sampleacct.japaneast.batch.azure.com",
+ "provisioningState": "Succeeded",
+ "poolAllocationMode": "BatchService",
+ "dedicatedCoreQuota": 20,
+ "lowPriorityCoreQuota": 20,
+ "poolQuota": 20,
+ "activeJobAndJobScheduleQuota": 20,
+ "autoStorage": {
+ "storageAccountId": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Storage/storageAccounts/samplestorage",
+ "lastKeySync": "2016-03-10T23:48:38.9878479Z"
+ },
+ "publicNetworkAccess": "Enabled"
+ },
+ "identity": {
+ "type": "None"
+ },
+ "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct",
+ "type": "Microsoft.Batch/batchAccounts"
+ }
+ }
+ }
+}
diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/examples/BatchAccountGetKeys.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/examples/BatchAccountGetKeys.json
new file mode 100644
index 000000000000..11bca180606c
--- /dev/null
+++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/examples/BatchAccountGetKeys.json
@@ -0,0 +1,17 @@
+{
+ "parameters": {
+ "accountName": "sampleacct",
+ "resourceGroupName": "default-azurebatch-japaneast",
+ "api-version": "2020-05-01",
+ "subscriptionId": "subid"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "accountName": "sampleacct",
+ "primary": "AAAA==",
+ "secondary": "BBBB=="
+ }
+ }
+ }
+}
diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/examples/BatchAccountList.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/examples/BatchAccountList.json
new file mode 100644
index 000000000000..4d4d1292d486
--- /dev/null
+++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/examples/BatchAccountList.json
@@ -0,0 +1,37 @@
+{
+ "parameters": {
+ "api-version": "2020-05-01",
+ "subscriptionId": "subid"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "name": "sampleacct",
+ "location": "japaneast",
+ "properties": {
+ "accountEndpoint": "sampleacct.japaneast.batch.azure.com",
+ "provisioningState": "Succeeded",
+ "poolAllocationMode": "BatchService",
+ "dedicatedCoreQuota": 20,
+ "lowPriorityCoreQuota": 20,
+ "poolQuota": 20,
+ "activeJobAndJobScheduleQuota": 20,
+ "autoStorage": {
+ "storageAccountId": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Storage/storageAccounts/samplestorage",
+ "lastKeySync": "2016-03-10T23:48:38.9878479Z"
+ },
+ "publicNetworkAccess": "Enabled"
+ },
+ "identity": {
+ "type": "None"
+ },
+ "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct",
+ "type": "Microsoft.Batch/batchAccounts"
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/examples/BatchAccountListByResourceGroup.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/examples/BatchAccountListByResourceGroup.json
new file mode 100644
index 000000000000..6a9dc23225aa
--- /dev/null
+++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/examples/BatchAccountListByResourceGroup.json
@@ -0,0 +1,38 @@
+{
+ "parameters": {
+ "resourceGroupName": "default-azurebatch-japaneast",
+ "api-version": "2020-05-01",
+ "subscriptionId": "subid"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "name": "sampleacct",
+ "location": "japaneast",
+ "properties": {
+ "accountEndpoint": "sampleacct.japaneast.batch.azure.com",
+ "provisioningState": "Succeeded",
+ "poolAllocationMode": "BatchService",
+ "dedicatedCoreQuota": 20,
+ "lowPriorityCoreQuota": 20,
+ "poolQuota": 20,
+ "activeJobAndJobScheduleQuota": 20,
+ "autoStorage": {
+ "storageAccountId": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Storage/storageAccounts/samplestorage",
+ "lastKeySync": "2016-03-10T23:48:38.9878479Z"
+ },
+ "publicNetworkAccess": "Enabled"
+ },
+ "identity": {
+ "type": "None"
+ },
+ "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct",
+ "type": "Microsoft.Batch/batchAccounts"
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/examples/BatchAccountRegenerateKey.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/examples/BatchAccountRegenerateKey.json
new file mode 100644
index 000000000000..ffb559ceebf5
--- /dev/null
+++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/examples/BatchAccountRegenerateKey.json
@@ -0,0 +1,20 @@
+{
+ "parameters": {
+ "accountName": "sampleacct",
+ "resourceGroupName": "default-azurebatch-japaneast",
+ "api-version": "2020-05-01",
+ "subscriptionId": "subid",
+ "parameters": {
+ "keyName": "Primary"
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "accountName": "sampleacct",
+ "primary": "AAAA==",
+ "secondary": "BBBB=="
+ }
+ }
+ }
+}
diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/examples/BatchAccountSynchronizeAutoStorageKeys.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/examples/BatchAccountSynchronizeAutoStorageKeys.json
new file mode 100644
index 000000000000..224e8b5e867a
--- /dev/null
+++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/examples/BatchAccountSynchronizeAutoStorageKeys.json
@@ -0,0 +1,11 @@
+{
+ "parameters": {
+ "accountName": "sampleacct",
+ "resourceGroupName": "default-azurebatch-japaneast",
+ "api-version": "2020-05-01",
+ "subscriptionId": "subid"
+ },
+ "responses": {
+ "204": {}
+ }
+}
diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/examples/BatchAccountUpdate.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/examples/BatchAccountUpdate.json
new file mode 100644
index 000000000000..aab50023dd67
--- /dev/null
+++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/examples/BatchAccountUpdate.json
@@ -0,0 +1,42 @@
+{
+ "parameters": {
+ "accountName": "sampleacct",
+ "resourceGroupName": "default-azurebatch-japaneast",
+ "api-version": "2020-05-01",
+ "subscriptionId": "subid",
+ "parameters": {
+ "properties": {
+ "autoStorage": {
+ "storageAccountId": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Storage/storageAccounts/samplestorage"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "name": "sampleacct",
+ "location": "japaneast",
+ "properties": {
+ "accountEndpoint": "sampleacct.japaneast.batch.azure.com",
+ "provisioningState": "Succeeded",
+ "poolAllocationMode": "BatchService",
+ "dedicatedCoreQuota": 20,
+ "lowPriorityCoreQuota": 20,
+ "poolQuota": 20,
+ "activeJobAndJobScheduleQuota": 20,
+ "autoStorage": {
+ "storageAccountId": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Storage/storageAccounts/samplestorage",
+ "lastKeySync": "2016-03-10T23:48:38.9878479Z"
+ },
+ "publicNetworkAccess": "Enabled"
+ },
+ "identity": {
+ "type": "None"
+ },
+ "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct",
+ "type": "Microsoft.Batch/batchAccounts"
+ }
+ }
+ }
+}
diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/examples/CertificateCancelDeletion.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/examples/CertificateCancelDeletion.json
new file mode 100644
index 000000000000..457a543600be
--- /dev/null
+++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/examples/CertificateCancelDeletion.json
@@ -0,0 +1,32 @@
+{
+ "parameters": {
+ "accountName": "sampleacct",
+ "resourceGroupName": "default-azurebatch-japaneast",
+ "api-version": "2020-05-01",
+ "subscriptionId": "subid",
+ "certificateName": "sha1-0a0e4f50d51beadeac1d35afc5116098e7902e6e"
+ },
+ "responses": {
+ "200": {
+ "headers": {
+ "ETag": "W/\"0x8D4EDD513C3EDBB\""
+ },
+ "body": {
+ "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/samplecct/certificates/sha1-0a0e4f50d51beadeac1d35afc5116098e7902e6e",
+ "name": "sha1-0a0e4f50d51beadeac1d35afc5116098e7902e6e",
+ "type": "Microsoft.Batch/batchAccounts/certificates",
+ "etag": "W/\"0x8D4EDD513C3EDBB\"",
+ "properties": {
+ "thumbprintAlgorithm": "sha1",
+ "thumbprint": "0a0e4f50d51beadeac1d35afc5116098e7902e6e",
+ "provisioningState": "Succeeded",
+ "provisioningStateTransitionTime": "2017-07-21T01:47:38.4420202Z",
+ "previousProvisioningState": "Failed",
+ "previousProvisioningStateTransitionTime": "2017-07-21T00:22:54.3299195Z",
+ "format": "Pfx",
+ "publicData": "MIICrjCCAZagAwI..."
+ }
+ }
+ }
+ }
+}
diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/examples/CertificateCreate_Full.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/examples/CertificateCreate_Full.json
new file mode 100644
index 000000000000..6c6b1f27ef7c
--- /dev/null
+++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/examples/CertificateCreate_Full.json
@@ -0,0 +1,39 @@
+{
+ "parameters": {
+ "accountName": "sampleacct",
+ "resourceGroupName": "default-azurebatch-japaneast",
+ "api-version": "2020-05-01",
+ "subscriptionId": "subid",
+ "certificateName": "sha1-0a0e4f50d51beadeac1d35afc5116098e7902e6e",
+ "parameters": {
+ "properties": {
+ "thumbprintAlgorithm": "sha1",
+ "thumbprint": "0a0e4f50d51beadeac1d35afc5116098e7902e6e",
+ "data": "MIIJsgIBAzCCCW4GCSqGSIb3DQE...",
+ "password": "KG0UY40e...",
+ "format": "Pfx"
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "headers": {
+ "ETag": "W/\"0x8D4EDD5118668F7\""
+ },
+ "body": {
+ "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/samplecct/certificates/sha1-0a0e4f50d51beadeac1d35afc5116098e7902e6e",
+ "name": "sha1-0a0e4f50d51beadeac1d35afc5116098e7902e6e",
+ "type": "Microsoft.Batch/batchAccounts/certificates",
+ "etag": "W/\"0x8D4EDD5118668F7\"",
+ "properties": {
+ "thumbprintAlgorithm": "sha1",
+ "thumbprint": "0a0e4f50d51beadeac1d35afc5116098e7902e6e",
+ "provisioningState": "Succeeded",
+ "provisioningStateTransitionTime": "2017-07-21T01:47:38.4420202Z",
+ "format": "Pfx",
+ "publicData": "MIICrjCCAZagAwI..."
+ }
+ }
+ }
+ }
+}
diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/examples/CertificateCreate_Minimal.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/examples/CertificateCreate_Minimal.json
new file mode 100644
index 000000000000..f7ad8232a213
--- /dev/null
+++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/examples/CertificateCreate_Minimal.json
@@ -0,0 +1,36 @@
+{
+ "parameters": {
+ "accountName": "sampleacct",
+ "resourceGroupName": "default-azurebatch-japaneast",
+ "api-version": "2020-05-01",
+ "subscriptionId": "subid",
+ "certificateName": "sha1-0a0e4f50d51beadeac1d35afc5116098e7902e6e",
+ "parameters": {
+ "properties": {
+ "data": "MIIJsgIBAzCCCW4GCSqGSIb3DQE...",
+ "password": "KG0UY40e..."
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "headers": {
+ "ETag": "W/\"0x8D4EDD5118668F7\""
+ },
+ "body": {
+ "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/samplecct/certificates/sha1-0a0e4f50d51beadeac1d35afc5116098e7902e6e",
+ "name": "sha1-0a0e4f50d51beadeac1d35afc5116098e7902e6e",
+ "type": "Microsoft.Batch/batchAccounts/certificates",
+ "etag": "W/\"0x8D4EDD5118668F7\"",
+ "properties": {
+ "thumbprintAlgorithm": "sha1",
+ "thumbprint": "0a0e4f50d51beadeac1d35afc5116098e7902e6e",
+ "provisioningState": "Succeeded",
+ "provisioningStateTransitionTime": "2017-07-21T01:47:38.4420202Z",
+ "format": "Pfx",
+ "publicData": "MIICrjCCAZagAwI..."
+ }
+ }
+ }
+ }
+}
diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/examples/CertificateCreate_MinimalCer.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/examples/CertificateCreate_MinimalCer.json
new file mode 100644
index 000000000000..b3311c1ff0bd
--- /dev/null
+++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/examples/CertificateCreate_MinimalCer.json
@@ -0,0 +1,36 @@
+{
+ "parameters": {
+ "accountName": "sampleacct",
+ "resourceGroupName": "default-azurebatch-japaneast",
+ "api-version": "2020-05-01",
+ "subscriptionId": "subid",
+ "certificateName": "sha1-0a0e4f50d51beadeac1d35afc5116098e7902e6e",
+ "parameters": {
+ "properties": {
+ "data": "MIICrjCCAZagAwI...",
+ "format": "Cer"
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "headers": {
+ "ETag": "W/\"0x8D4EDD5118668F7\""
+ },
+ "body": {
+ "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/samplecct/certificates/sha1-0a0e4f50d51beadeac1d35afc5116098e7902e6e",
+ "name": "sha1-0a0e4f50d51beadeac1d35afc5116098e7902e6e",
+ "type": "Microsoft.Batch/batchAccounts/certificates",
+ "etag": "W/\"0x8D4EDD5118668F7\"",
+ "properties": {
+ "thumbprintAlgorithm": "sha1",
+ "thumbprint": "0a0e4f50d51beadeac1d35afc5116098e7902e6e",
+ "provisioningState": "Succeeded",
+ "provisioningStateTransitionTime": "2017-07-21T01:47:38.4420202Z",
+ "format": "Cer",
+ "publicData": "MIICrjCCAZagAwI..."
+ }
+ }
+ }
+ }
+}
diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/examples/CertificateDelete.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/examples/CertificateDelete.json
new file mode 100644
index 000000000000..21fda8af211f
--- /dev/null
+++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/examples/CertificateDelete.json
@@ -0,0 +1,19 @@
+{
+ "parameters": {
+ "subscriptionId": "subid",
+ "resourceGroupName": "default-azurebatch-japaneast",
+ "accountName": "sampleacct",
+ "certificateName": "sha1-0a0e4f50d51beadeac1d35afc5116098e7902e6e",
+ "api-version": "2020-05-01"
+ },
+ "responses": {
+ "200": {},
+ "202": {
+ "headers": {
+ "Retry-After": "15",
+ "Location": "https://management.azure.com/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/certificateOperationResults/sha1-0a0e4f50d51beadeac1d35afc5116098e7902e6e-8D4EDFF164A11C9?api-version=2020-05-01"
+ }
+ },
+ "204": {}
+ }
+}
diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/examples/CertificateGet.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/examples/CertificateGet.json
new file mode 100644
index 000000000000..c6b66963910f
--- /dev/null
+++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/examples/CertificateGet.json
@@ -0,0 +1,30 @@
+{
+ "parameters": {
+ "subscriptionId": "subid",
+ "resourceGroupName": "default-azurebatch-japaneast",
+ "accountName": "sampleacct",
+ "certificateName": "sha1-0a0e4f50d51beadeac1d35afc5116098e7902e6e",
+ "api-version": "2020-05-01"
+ },
+ "responses": {
+ "200": {
+ "headers": {
+ "ETag": "W/\"0x8D4EDD5118668F7\""
+ },
+ "body": {
+ "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/samplecct/certificates/sha1-0a0e4f50d51beadeac1d35afc5116098e7902e6e",
+ "name": "sha1-0a0e4f50d51beadeac1d35afc5116098e7902e6e",
+ "type": "Microsoft.Batch/batchAccounts/certificates",
+ "etag": "W/\"0x8D4EDD5118668F7\"",
+ "properties": {
+ "thumbprintAlgorithm": "sha1",
+ "thumbprint": "0a0e4f50d51beadeac1d35afc5116098e7902e6e",
+ "provisioningState": "Succeeded",
+ "provisioningStateTransitionTime": "2017-07-21T01:47:38.4420202Z",
+ "format": "Pfx",
+ "publicData": "MIICrjCCAZagAwI..."
+ }
+ }
+ }
+ }
+}
diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/examples/CertificateGetWithDeletionError.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/examples/CertificateGetWithDeletionError.json
new file mode 100644
index 000000000000..4eaf42316298
--- /dev/null
+++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/examples/CertificateGetWithDeletionError.json
@@ -0,0 +1,43 @@
+{
+ "parameters": {
+ "subscriptionId": "subid",
+ "resourceGroupName": "default-azurebatch-japaneast",
+ "accountName": "sampleacct",
+ "certificateName": "sha1-0a0e4f50d51beadeac1d35afc5116098e7902e6e",
+ "api-version": "2020-05-01"
+ },
+ "responses": {
+ "200": {
+ "headers": {
+ "ETag": "W/\"0x8D4EDD5118668F7\""
+ },
+ "body": {
+ "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/samplecct/certificates/sha1-0a0e4f50d51beadeac1d35afc5116098e7902e6e",
+ "name": "sha1-0a0e4f50d51beadeac1d35afc5116098e7902e6e",
+ "type": "Microsoft.Batch/batchAccounts/certificates",
+ "etag": "W/\"0x8D4EDD5118668F7\"",
+ "properties": {
+ "thumbprintAlgorithm": "sha1",
+ "thumbprint": "0a0e4f50d51beadeac1d35afc5116098e7902e6e",
+ "provisioningState": "Failed",
+ "provisioningStateTransitionTime": "2017-07-21T01:47:38.4420202Z",
+ "previousProvisioningState": "Deleting",
+ "previousProvisioningStateTransitionTime": "2017-07-21T00:15:25.5625498Z",
+ "format": "Pfx",
+ "publicData": "MIICrjCCAZagAwI...",
+ "deleteCertificateError": {
+ "code": "NodesReferencingCertificate",
+ "message": "The specified certificate is being used by the below mentioned node(s)\nRequestId:2dc78afc-b15b-42d2-8c85-39cb61a0799e\nTime:2017-08-28T10:22:52.8633406Z",
+ "target": "BatchAccount",
+ "details": [
+ {
+ "code": "Nodes",
+ "message": "node1, node3"
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+}
diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/examples/CertificateList.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/examples/CertificateList.json
new file mode 100644
index 000000000000..c0c870527f3a
--- /dev/null
+++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/examples/CertificateList.json
@@ -0,0 +1,32 @@
+{
+ "parameters": {
+ "subscriptionId": "subid",
+ "resourceGroupName": "default-azurebatch-japaneast",
+ "accountName": "sampleacct",
+ "api-version": "2020-05-01",
+ "maxResults": "1"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/samplecct/certificates/sha1-0a0e4f50d51beadeac1d35afc5116098e7902e6e",
+ "name": "sha1-0a0e4f50d51beadeac1d35afc5116098e7902e6e",
+ "type": "Microsoft.Batch/batchAccounts/certificates",
+ "etag": "W/\"0x8D4EDD5118668F7\"",
+ "properties": {
+ "thumbprintAlgorithm": "sha1",
+ "thumbprint": "0a0e4f50d51beadeac1d35afc5116098e7902e6e",
+ "provisioningState": "Succeeded",
+ "provisioningStateTransitionTime": "2017-07-21T01:47:38.4420202Z",
+ "format": "Pfx",
+ "publicData": "MIICrjCCAZagAwI..."
+ }
+ }
+ ],
+ "nextLink": "https://management.azure.com/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/samplecct/certificates?api-version=2020-05-01&$skiptoken=NPK%3D28%3A2857p428pug%2022F53A7734C947B8NRK%3D45%3Asha1-c23dc7f22edc793856a7506fe66397ccb4a33b46SM%3D5%3AFalse"
+ }
+ }
+ }
+}
diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/examples/CertificateListWithFilter.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/examples/CertificateListWithFilter.json
new file mode 100644
index 000000000000..f68c7c5600bb
--- /dev/null
+++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/examples/CertificateListWithFilter.json
@@ -0,0 +1,38 @@
+{
+ "parameters": {
+ "subscriptionId": "subid",
+ "resourceGroupName": "default-azurebatch-japaneast",
+ "accountName": "sampleacct",
+ "api-version": "2020-05-01",
+ "$filter": "properties/provisioningStateTransitionTime gt '2017-05-01' or properties/provisioningState eq 'Failed'",
+ "$select": "properties/format,properties/provisioningState"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/samplecct/certificates/sha1-0a0e4f50d51beadeac1d35afc5116098e7902e6e",
+ "name": "sha1-0a0e4f50d51beadeac1d35afc5116098e7902e6e",
+ "type": "Microsoft.Batch/batchAccounts/certificates",
+ "etag": "W/\"0x8D4EDD5118668F7\"",
+ "properties": {
+ "provisioningState": "Failed",
+ "format": "Pfx"
+ }
+ },
+ {
+ "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/samplecct/certificates/sha1-aeb228ffb0bf67a793d61dce263ebd16949f15a1",
+ "name": "sha1-aeb228ffb0bf67a793d61dce263ebd16949f15a1",
+ "type": "Microsoft.Batch/batchAccounts/certificates",
+ "etag": "W/\"0x8D4EDD5118572E0\"",
+ "properties": {
+ "provisioningState": "Failed",
+ "format": "Cer"
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/examples/CertificateUpdate.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/examples/CertificateUpdate.json
new file mode 100644
index 000000000000..f7ad8232a213
--- /dev/null
+++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/examples/CertificateUpdate.json
@@ -0,0 +1,36 @@
+{
+ "parameters": {
+ "accountName": "sampleacct",
+ "resourceGroupName": "default-azurebatch-japaneast",
+ "api-version": "2020-05-01",
+ "subscriptionId": "subid",
+ "certificateName": "sha1-0a0e4f50d51beadeac1d35afc5116098e7902e6e",
+ "parameters": {
+ "properties": {
+ "data": "MIIJsgIBAzCCCW4GCSqGSIb3DQE...",
+ "password": "KG0UY40e..."
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "headers": {
+ "ETag": "W/\"0x8D4EDD5118668F7\""
+ },
+ "body": {
+ "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/samplecct/certificates/sha1-0a0e4f50d51beadeac1d35afc5116098e7902e6e",
+ "name": "sha1-0a0e4f50d51beadeac1d35afc5116098e7902e6e",
+ "type": "Microsoft.Batch/batchAccounts/certificates",
+ "etag": "W/\"0x8D4EDD5118668F7\"",
+ "properties": {
+ "thumbprintAlgorithm": "sha1",
+ "thumbprint": "0a0e4f50d51beadeac1d35afc5116098e7902e6e",
+ "provisioningState": "Succeeded",
+ "provisioningStateTransitionTime": "2017-07-21T01:47:38.4420202Z",
+ "format": "Pfx",
+ "publicData": "MIICrjCCAZagAwI..."
+ }
+ }
+ }
+ }
+}
diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/examples/LocationCheckNameAvailability_AlreadyExists.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/examples/LocationCheckNameAvailability_AlreadyExists.json
new file mode 100644
index 000000000000..8cb7e5ff744c
--- /dev/null
+++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/examples/LocationCheckNameAvailability_AlreadyExists.json
@@ -0,0 +1,20 @@
+{
+ "parameters": {
+ "api-version": "2020-05-01",
+ "subscriptionId": "subid",
+ "locationName": "japaneast",
+ "parameters": {
+ "name": "existingaccountname",
+ "type": "Microsoft.Batch/batchAccounts"
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "nameAvailable": false,
+ "reason": "AlreadyExists",
+ "message": "An account named 'existingaccountname' is already in use."
+ }
+ }
+ }
+}
diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/examples/LocationCheckNameAvailability_Available.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/examples/LocationCheckNameAvailability_Available.json
new file mode 100644
index 000000000000..98f87826d783
--- /dev/null
+++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/examples/LocationCheckNameAvailability_Available.json
@@ -0,0 +1,18 @@
+{
+ "parameters": {
+ "api-version": "2020-05-01",
+ "subscriptionId": "subid",
+ "locationName": "japaneast",
+ "parameters": {
+ "name": "newaccountname",
+ "type": "Microsoft.Batch/batchAccounts"
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "nameAvailable": true
+ }
+ }
+ }
+}
diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/examples/LocationGetQuotas.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/examples/LocationGetQuotas.json
new file mode 100644
index 000000000000..48c9db6087b8
--- /dev/null
+++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/examples/LocationGetQuotas.json
@@ -0,0 +1,14 @@
+{
+ "parameters": {
+ "api-version": "2020-05-01",
+ "subscriptionId": "subid",
+ "locationName": "japaneast"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "accountQuota": 1
+ }
+ }
+ }
+}
diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/examples/PoolCreate_CustomImage.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/examples/PoolCreate_CustomImage.json
new file mode 100644
index 000000000000..1e7cf603c18a
--- /dev/null
+++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/examples/PoolCreate_CustomImage.json
@@ -0,0 +1,65 @@
+{
+ "parameters": {
+ "subscriptionId": "subid",
+ "resourceGroupName": "default-azurebatch-japaneast",
+ "accountName": "sampleacct",
+ "poolName": "testpool",
+ "api-version": "2020-05-01",
+ "parameters": {
+ "properties": {
+ "vmSize": "STANDARD_D4",
+ "deploymentConfiguration": {
+ "virtualMachineConfiguration": {
+ "imageReference": {
+ "id": "/subscriptions/subid/resourceGroups/networking-group/providers/Microsoft.Compute/images/image-123"
+ },
+ "nodeAgentSkuId": "batch.node.ubuntu 18.04"
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "headers": {
+ "ETag": "W/\"0x8D4EDFEBFADF4AB\""
+ },
+ "body": {
+ "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool",
+ "name": "testpool",
+ "type": "Microsoft.Batch/batchAccounts/pools",
+ "etag": "W/\"0x8D4EDFEBFADF4AB\"",
+ "properties": {
+ "lastModified": "2017-08-28T10:22:55.9407275Z",
+ "creationTime": "2017-08-28T10:22:55.9407275Z",
+ "provisioningState": "Succeeded",
+ "provisioningStateTransitionTime": "2017-08-28T10:22:55.9407275Z",
+ "allocationState": "Steady",
+ "allocationStateTransitionTime": "2017-08-28T10:22:55.9407275Z",
+ "vmSize": "STANDARD_D4",
+ "interNodeCommunication": "Disabled",
+ "maxTasksPerNode": 1,
+ "taskSchedulingPolicy": {
+ "nodeFillType": "Spread"
+ },
+ "deploymentConfiguration": {
+ "virtualMachineConfiguration": {
+ "imageReference": {
+ "id": "/subscriptions/subid/resourceGroups/networking-group/providers/Microsoft.Compute/images/image-123"
+ },
+ "nodeAgentSkuId": "batch.node.ubuntu 18.04"
+ }
+ },
+ "scaleSettings": {
+ "fixedScale": {
+ "targetDedicatedNodes": 0,
+ "targetLowPriorityNodes": 0
+ }
+ },
+ "currentDedicatedNodes": 0,
+ "currentLowPriorityNodes": 0
+ }
+ }
+ }
+ }
+}
diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/examples/PoolCreate_FullExample.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/examples/PoolCreate_FullExample.json
new file mode 100644
index 000000000000..d529980ee55a
--- /dev/null
+++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/examples/PoolCreate_FullExample.json
@@ -0,0 +1,285 @@
+{
+ "parameters": {
+ "subscriptionId": "subid",
+ "resourceGroupName": "default-azurebatch-japaneast",
+ "accountName": "sampleacct",
+ "poolName": "testpool",
+ "api-version": "2020-05-01",
+ "parameters": {
+ "properties": {
+ "displayName": "my-pool-name",
+ "vmSize": "STANDARD_D4",
+ "interNodeCommunication": "Enabled",
+ "maxTasksPerNode": 13,
+ "taskSchedulingPolicy": {
+ "nodeFillType": "Pack"
+ },
+ "deploymentConfiguration": {
+ "cloudServiceConfiguration": {
+ "osFamily": "4",
+ "osVersion": "WA-GUEST-OS-4.45_201708-01"
+ }
+ },
+ "networkConfiguration": {
+ "subnetId": "/subscriptions/subid/resourceGroups/rg1234/providers/Microsoft.Network/virtualNetworks/network1234/subnets/subnet123",
+ "publicIPAddressConfiguration": {
+ "provision": "UserManaged",
+ "ipAddressIds": [
+ "/subscriptions/subid1/resourceGroups/rg13/providers/Microsoft.Network/publicIPAddresses/ip135",
+ "/subscriptions/subid2/resourceGroups/rg24/providers/Microsoft.Network/publicIPAddresses/ip268"
+ ]
+ },
+ "endpointConfiguration": {
+ "inboundNatPools": [
+ {
+ "name": "testnat",
+ "protocol": "TCP",
+ "backendPort": 12001,
+ "frontendPortRangeStart": 15000,
+ "frontendPortRangeEnd": 15100,
+ "networkSecurityGroupRules": [
+ {
+ "access": "Allow",
+ "sourceAddressPrefix": "192.100.12.45",
+ "priority": 150,
+ "sourcePortRanges": [
+ "*"
+ ]
+ },
+ {
+ "access": "Deny",
+ "sourceAddressPrefix": "*",
+ "priority": 3500,
+ "sourcePortRanges": [
+ "*"
+ ]
+ }
+ ]
+ }
+ ]
+ }
+ },
+ "scaleSettings": {
+ "fixedScale": {
+ "targetDedicatedNodes": 6,
+ "targetLowPriorityNodes": 28,
+ "resizeTimeout": "PT8M",
+ "nodeDeallocationOption": "TaskCompletion"
+ }
+ },
+ "metadata": [
+ {
+ "name": "metadata-1",
+ "value": "value-1"
+ },
+ {
+ "name": "metadata-2",
+ "value": "value-2"
+ }
+ ],
+ "startTask": {
+ "commandLine": "cmd /c SET",
+ "resourceFiles": [
+ {
+ "httpUrl": "https://testaccount.blob.core.windows.net/example-blob-file",
+ "filePath": "c:\\temp\\gohere",
+ "fileMode": "777"
+ }
+ ],
+ "environmentSettings": [
+ {
+ "name": "MYSET",
+ "value": "1234"
+ }
+ ],
+ "userIdentity": {
+ "autoUser": {
+ "scope": "Pool",
+ "elevationLevel": "Admin"
+ }
+ },
+ "maxTaskRetryCount": 6,
+ "waitForSuccess": true
+ },
+ "userAccounts": [
+ {
+ "name": "username1",
+ "password": "examplepassword",
+ "elevationLevel": "Admin",
+ "linuxUserConfiguration": {
+ "sshPrivateKey": "sshprivatekeyvalue",
+ "uid": 1234,
+ "gid": 4567
+ }
+ }
+ ],
+ "applicationPackages": [
+ {
+ "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool/applications/app_1234",
+ "version": "asdf"
+ }
+ ],
+ "certificates": [
+ {
+ "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool/certificates/sha1-1234567",
+ "storeLocation": "LocalMachine",
+ "storeName": "MY",
+ "visibility": [
+ "RemoteUser"
+ ]
+ }
+ ],
+ "applicationLicenses": [
+ "app-license0",
+ "app-license1"
+ ]
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "headers": {
+ "ETag": "W/\"0x8D4EDFEBFADF4AB\""
+ },
+ "body": {
+ "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool",
+ "name": "testpool",
+ "type": "Microsoft.Batch/batchAccounts/pools",
+ "etag": "W/\"0x8D4EDFEBFADF4AB\"",
+ "properties": {
+ "lastModified": "2017-08-28T10:22:55.9407275Z",
+ "creationTime": "2017-08-28T10:22:55.9407275Z",
+ "provisioningState": "Succeeded",
+ "provisioningStateTransitionTime": "2017-08-28T10:22:55.9407275Z",
+ "allocationState": "Resizing",
+ "allocationStateTransitionTime": "2017-08-28T10:22:55.9407275Z",
+ "vmSize": "STANDARD_D4",
+ "interNodeCommunication": "Enabled",
+ "maxTasksPerNode": 13,
+ "taskSchedulingPolicy": {
+ "nodeFillType": "Pack"
+ },
+ "deploymentConfiguration": {
+ "cloudServiceConfiguration": {
+ "osFamily": "4",
+ "osVersion": "WA-GUEST-OS-4.45_201708-01"
+ }
+ },
+ "scaleSettings": {
+ "fixedScale": {
+ "targetDedicatedNodes": 6,
+ "targetLowPriorityNodes": 28,
+ "resizeTimeout": "PT8M",
+ "nodeDeallocationOption": "TaskCompletion"
+ }
+ },
+ "networkConfiguration": {
+ "subnetId": "/subscriptions/subid/resourceGroups/rg1234/providers/Microsoft.Network/virtualNetworks/network1234/subnets/subnet123",
+ "publicIPAddressConfiguration": {
+ "provision": "UserManaged",
+ "ipAddressIds": [
+ "/subscriptions/subid1/resourceGroups/rg13/providers/Microsoft.Network/publicIPAddresses/ip135",
+ "/subscriptions/subid2/resourceGroups/rg24/providers/Microsoft.Network/publicIPAddresses/ip268"
+ ]
+ },
+ "endpointConfiguration": {
+ "inboundNatPools": [
+ {
+ "name": "testnat",
+ "protocol": "TCP",
+ "backendPort": 12001,
+ "frontendPortRangeStart": 15000,
+ "frontendPortRangeEnd": 15100,
+ "networkSecurityGroupRules": [
+ {
+ "access": "Allow",
+ "sourceAddressPrefix": "192.100.12.45",
+ "priority": 150,
+ "sourcePortRanges": [
+ "*"
+ ]
+ },
+ {
+ "access": "Deny",
+ "sourceAddressPrefix": "*",
+ "priority": 3500,
+ "sourcePortRanges": [
+ "*"
+ ]
+ }
+ ]
+ }
+ ]
+ }
+ },
+ "metadata": [
+ {
+ "name": "metadata-1",
+ "value": "value-1"
+ },
+ {
+ "name": "metadata-2",
+ "value": "value-2"
+ }
+ ],
+ "startTask": {
+ "commandLine": "cmd /c SET",
+ "resourceFiles": [
+ {
+ "httpUrl": "https://testaccount.blob.core.windows.net/example-blob-file",
+ "filePath": "c:\\temp\\gohere",
+ "fileMode": "777"
+ }
+ ],
+ "environmentSettings": [
+ {
+ "name": "MYSET",
+ "value": "1234"
+ }
+ ],
+ "userIdentity": {
+ "autoUser": {
+ "scope": "Pool",
+ "elevationLevel": "Admin"
+ }
+ },
+ "maxTaskRetryCount": 6,
+ "waitForSuccess": true
+ },
+ "userAccounts": [
+ {
+ "name": "username1",
+ "elevationLevel": "Admin",
+ "linuxUserConfiguration": {
+ "uid": 1234,
+ "gid": 4567
+ }
+ }
+ ],
+ "applicationPackages": [
+ {
+ "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool/applications/app_1234",
+ "version": "asdf"
+ }
+ ],
+ "certificates": [
+ {
+ "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool/certificates/sha1-1234567",
+ "storeLocation": "LocalMachine",
+ "storeName": "MY",
+ "visibility": [
+ "RemoteUser"
+ ]
+ }
+ ],
+ "applicationLicenses": [
+ "app-license0",
+ "app-license1"
+ ],
+ "currentDedicatedNodes": 0,
+ "currentLowPriorityNodes": 0
+ }
+ }
+ }
+ }
+}
diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/examples/PoolCreate_MinimalCloudServiceConfiguration.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/examples/PoolCreate_MinimalCloudServiceConfiguration.json
new file mode 100644
index 000000000000..a55033e53e12
--- /dev/null
+++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/examples/PoolCreate_MinimalCloudServiceConfiguration.json
@@ -0,0 +1,72 @@
+{
+ "parameters": {
+ "subscriptionId": "subid",
+ "resourceGroupName": "default-azurebatch-japaneast",
+ "accountName": "sampleacct",
+ "poolName": "testpool",
+ "api-version": "2020-05-01",
+ "parameters": {
+ "properties": {
+ "vmSize": "STANDARD_D4",
+ "deploymentConfiguration": {
+ "cloudServiceConfiguration": {
+ "osFamily": "5"
+ }
+ },
+ "scaleSettings": {
+ "fixedScale": {
+ "targetDedicatedNodes": 3
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "headers": {
+ "ETag": "W/\"0x8D4EDFEBFADF4AB\""
+ },
+ "body": {
+ "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool",
+ "name": "testpool",
+ "type": "Microsoft.Batch/batchAccounts/pools",
+ "etag": "W/\"0x8D4EDFEBFADF4AB\"",
+ "properties": {
+ "lastModified": "2017-08-28T10:22:55.9407275Z",
+ "creationTime": "2017-08-28T10:22:55.9407275Z",
+ "provisioningState": "Succeeded",
+ "provisioningStateTransitionTime": "2017-08-28T10:22:55.9407275Z",
+ "allocationState": "Resizing",
+ "allocationStateTransitionTime": "2017-08-28T10:22:55.9407275Z",
+ "vmSize": "STANDARD_D4",
+ "interNodeCommunication": "Disabled",
+ "maxTasksPerNode": 1,
+ "taskSchedulingPolicy": {
+ "nodeFillType": "Spread"
+ },
+ "deploymentConfiguration": {
+ "cloudServiceConfiguration": {
+ "osFamily": "5",
+ "osVersion": "*"
+ }
+ },
+ "scaleSettings": {
+ "fixedScale": {
+ "targetDedicatedNodes": 3,
+ "targetLowPriorityNodes": 0,
+ "resizeTimeout": "PT15M"
+ }
+ },
+ "currentDedicatedNodes": 0,
+ "currentLowPriorityNodes": 0,
+ "resizeOperationStatus": {
+ "startTime": "2017-08-28T10:22:55.9407275Z",
+ "targetDedicatedNodes": 3,
+ "nodeDeallocationOption": "Requeue",
+ "resizeTimeout": "PT15M"
+ }
+ }
+ }
+ }
+ }
+}
diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/examples/PoolCreate_MinimalVirtualMachineConfiguration.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/examples/PoolCreate_MinimalVirtualMachineConfiguration.json
new file mode 100644
index 000000000000..67d22ba673a5
--- /dev/null
+++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/examples/PoolCreate_MinimalVirtualMachineConfiguration.json
@@ -0,0 +1,77 @@
+{
+ "parameters": {
+ "subscriptionId": "subid",
+ "resourceGroupName": "default-azurebatch-japaneast",
+ "accountName": "sampleacct",
+ "poolName": "testpool",
+ "api-version": "2020-05-01",
+ "parameters": {
+ "properties": {
+ "vmSize": "STANDARD_D4",
+ "deploymentConfiguration": {
+ "virtualMachineConfiguration": {
+ "imageReference": {
+ "publisher": "Canonical",
+ "offer": "UbuntuServer",
+ "sku": "18.04-LTS",
+ "version": "latest"
+ },
+ "nodeAgentSkuId": "batch.node.ubuntu 18.04"
+ }
+ },
+ "scaleSettings": {
+ "autoScale": {
+ "formula": "$TargetDedicatedNodes=1",
+ "evaluationInterval": "PT5M"
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "headers": {
+ "ETag": "W/\"0x8D4EDFEBFADF4AB\""
+ },
+ "body": {
+ "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool",
+ "name": "testpool",
+ "type": "Microsoft.Batch/batchAccounts/pools",
+ "etag": "W/\"0x8D4EDFEBFADF4AB\"",
+ "properties": {
+ "lastModified": "2017-08-28T10:22:55.9407275Z",
+ "creationTime": "2017-08-28T10:22:55.9407275Z",
+ "provisioningState": "Succeeded",
+ "provisioningStateTransitionTime": "2017-08-28T10:22:55.9407275Z",
+ "allocationState": "Resizing",
+ "allocationStateTransitionTime": "2017-08-28T10:22:55.9407275Z",
+ "vmSize": "STANDARD_D4",
+ "interNodeCommunication": "Disabled",
+ "maxTasksPerNode": 1,
+ "taskSchedulingPolicy": {
+ "nodeFillType": "Spread"
+ },
+ "deploymentConfiguration": {
+ "virtualMachineConfiguration": {
+ "imageReference": {
+ "publisher": "Canonical",
+ "offer": "UbuntuServer",
+ "sku": "18.04-LTS",
+ "version": "latest"
+ },
+ "nodeAgentSkuId": "batch.node.ubuntu 18.04"
+ }
+ },
+ "scaleSettings": {
+ "autoScale": {
+ "formula": "$TargetDedicatedNodes=1",
+ "evaluationInterval": "PT5M"
+ }
+ },
+ "currentDedicatedNodes": 0,
+ "currentLowPriorityNodes": 0
+ }
+ }
+ }
+ }
+}
diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/examples/PoolCreate_NoPublicIPAddresses.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/examples/PoolCreate_NoPublicIPAddresses.json
new file mode 100644
index 000000000000..7473b7c2593d
--- /dev/null
+++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/examples/PoolCreate_NoPublicIPAddresses.json
@@ -0,0 +1,77 @@
+{
+ "parameters": {
+ "subscriptionId": "subid",
+ "resourceGroupName": "default-azurebatch-japaneast",
+ "accountName": "sampleacct",
+ "poolName": "testpool",
+ "api-version": "2020-05-01",
+ "parameters": {
+ "properties": {
+ "vmSize": "STANDARD_D4",
+ "networkConfiguration": {
+ "subnetId": "/subscriptions/subid/resourceGroups/rg1234/providers/Microsoft.Network/virtualNetworks/network1234/subnets/subnet123",
+ "publicIPAddressConfiguration": {
+ "provision": "NoPublicIPAddresses"
+ }
+ },
+ "deploymentConfiguration": {
+ "virtualMachineConfiguration": {
+ "imageReference": {
+ "id": "/subscriptions/subid/resourceGroups/networking-group/providers/Microsoft.Compute/images/image-123"
+ },
+ "nodeAgentSkuId": "batch.node.ubuntu 18.04"
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "headers": {
+ "ETag": "W/\"0x8D4EDFEBFADF4AB\""
+ },
+ "body": {
+ "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool",
+ "name": "testpool",
+ "type": "Microsoft.Batch/batchAccounts/pools",
+ "etag": "W/\"0x8D4EDFEBFADF4AB\"",
+ "properties": {
+ "lastModified": "2017-08-28T10:22:55.9407275Z",
+ "creationTime": "2017-08-28T10:22:55.9407275Z",
+ "provisioningState": "Succeeded",
+ "provisioningStateTransitionTime": "2017-08-28T10:22:55.9407275Z",
+ "allocationState": "Steady",
+ "allocationStateTransitionTime": "2017-08-28T10:22:55.9407275Z",
+ "vmSize": "STANDARD_D4",
+ "interNodeCommunication": "Disabled",
+ "maxTasksPerNode": 1,
+ "taskSchedulingPolicy": {
+ "nodeFillType": "Spread"
+ },
+ "networkConfiguration": {
+ "subnetId": "/subscriptions/subid/resourceGroups/rg1234/providers/Microsoft.Network/virtualNetworks/network1234/subnets/subnet123",
+ "publicIPAddressConfiguration": {
+ "provision": "NoPublicIPAddresses"
+ }
+ },
+ "deploymentConfiguration": {
+ "virtualMachineConfiguration": {
+ "imageReference": {
+ "id": "/subscriptions/subid/resourceGroups/networking-group/providers/Microsoft.Compute/images/image-123"
+ },
+ "nodeAgentSkuId": "batch.node.ubuntu 18.04"
+ }
+ },
+ "scaleSettings": {
+ "fixedScale": {
+ "targetDedicatedNodes": 0,
+ "targetLowPriorityNodes": 0
+ }
+ },
+ "currentDedicatedNodes": 0,
+ "currentLowPriorityNodes": 0
+ }
+ }
+ }
+ }
+}
diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/examples/PoolCreate_PublicIPs.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/examples/PoolCreate_PublicIPs.json
new file mode 100644
index 000000000000..7d0d5e4626ee
--- /dev/null
+++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/examples/PoolCreate_PublicIPs.json
@@ -0,0 +1,83 @@
+{
+ "parameters": {
+ "subscriptionId": "subid",
+ "resourceGroupName": "default-azurebatch-japaneast",
+ "accountName": "sampleacct",
+ "poolName": "testpool",
+ "api-version": "2020-05-01",
+ "parameters": {
+ "properties": {
+ "vmSize": "STANDARD_D4",
+ "networkConfiguration": {
+ "subnetId": "/subscriptions/subid/resourceGroups/rg1234/providers/Microsoft.Network/virtualNetworks/network1234/subnets/subnet123",
+ "publicIPAddressConfiguration": {
+ "provision": "UserManaged",
+ "ipAddressIds": [
+ "/subscriptions/subid1/resourceGroups/rg13/providers/Microsoft.Network/publicIPAddresses/ip135"
+ ]
+ }
+ },
+ "deploymentConfiguration": {
+ "virtualMachineConfiguration": {
+ "imageReference": {
+ "id": "/subscriptions/subid/resourceGroups/networking-group/providers/Microsoft.Compute/images/image-123"
+ },
+ "nodeAgentSkuId": "batch.node.ubuntu 18.04"
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "headers": {
+ "ETag": "W/\"0x8D4EDFEBFADF4AB\""
+ },
+ "body": {
+ "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool",
+ "name": "testpool",
+ "type": "Microsoft.Batch/batchAccounts/pools",
+ "etag": "W/\"0x8D4EDFEBFADF4AB\"",
+ "properties": {
+ "lastModified": "2017-08-28T10:22:55.9407275Z",
+ "creationTime": "2017-08-28T10:22:55.9407275Z",
+ "provisioningState": "Succeeded",
+ "provisioningStateTransitionTime": "2017-08-28T10:22:55.9407275Z",
+ "allocationState": "Steady",
+ "allocationStateTransitionTime": "2017-08-28T10:22:55.9407275Z",
+ "vmSize": "STANDARD_D4",
+ "interNodeCommunication": "Disabled",
+ "maxTasksPerNode": 1,
+ "taskSchedulingPolicy": {
+ "nodeFillType": "Spread"
+ },
+ "networkConfiguration": {
+ "subnetId": "/subscriptions/subid/resourceGroups/rg1234/providers/Microsoft.Network/virtualNetworks/network1234/subnets/subnet123",
+ "publicIPAddressConfiguration": {
+ "provision": "UserManaged",
+ "ipAddressIds": [
+ "/subscriptions/subid1/resourceGroups/rg13/providers/Microsoft.Network/publicIPAddresses/ip135"
+ ]
+ }
+ },
+ "deploymentConfiguration": {
+ "virtualMachineConfiguration": {
+ "imageReference": {
+ "id": "/subscriptions/subid/resourceGroups/networking-group/providers/Microsoft.Compute/images/image-123"
+ },
+ "nodeAgentSkuId": "batch.node.ubuntu 18.04"
+ }
+ },
+ "scaleSettings": {
+ "fixedScale": {
+ "targetDedicatedNodes": 0,
+ "targetLowPriorityNodes": 0
+ }
+ },
+ "currentDedicatedNodes": 0,
+ "currentLowPriorityNodes": 0
+ }
+ }
+ }
+ }
+}
diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/examples/PoolCreate_VirtualMachineConfiguration.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/examples/PoolCreate_VirtualMachineConfiguration.json
new file mode 100644
index 000000000000..f83091ed4d2f
--- /dev/null
+++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/examples/PoolCreate_VirtualMachineConfiguration.json
@@ -0,0 +1,189 @@
+{
+ "parameters": {
+ "subscriptionId": "subid",
+ "resourceGroupName": "default-azurebatch-japaneast",
+ "accountName": "sampleacct",
+ "poolName": "testpool",
+ "api-version": "2020-05-01",
+ "parameters": {
+ "properties": {
+ "vmSize": "STANDARD_D4",
+ "deploymentConfiguration": {
+ "virtualMachineConfiguration": {
+ "imageReference": {
+ "publisher": "MicrosoftWindowsServer",
+ "offer": "WindowsServer",
+ "sku": "2016-Datacenter-SmallDisk",
+ "version": "latest"
+ },
+ "nodeAgentSkuId": "batch.node.windows amd64",
+ "windowsConfiguration": {
+ "enableAutomaticUpdates": false
+ },
+ "licenseType": "Windows_Server",
+ "dataDisks": [
+ {
+ "lun": 0,
+ "caching": "ReadWrite",
+ "diskSizeGB": 30,
+ "storageAccountType": "Premium_LRS"
+ },
+ {
+ "lun": 1,
+ "caching": "None",
+ "diskSizeGB": 200,
+ "storageAccountType": "Standard_LRS"
+ }
+ ],
+ "diskEncryptionConfiguration": {
+ "targets": [
+ "OsDisk",
+ "TemporaryDisk"
+ ]
+ }
+ }
+ },
+ "networkConfiguration": {
+ "endpointConfiguration": {
+ "inboundNatPools": [
+ {
+ "name": "testnat",
+ "protocol": "TCP",
+ "backendPort": 12001,
+ "frontendPortRangeStart": 15000,
+ "frontendPortRangeEnd": 15100,
+ "networkSecurityGroupRules": [
+ {
+ "access": "Allow",
+ "sourceAddressPrefix": "192.100.12.45",
+ "priority": 150,
+ "sourcePortRanges": [
+ "1",
+ "2"
+ ]
+ },
+ {
+ "access": "Deny",
+ "sourceAddressPrefix": "*",
+ "priority": 3500,
+ "sourcePortRanges": [
+ "*"
+ ]
+ }
+ ]
+ }
+ ]
+ }
+ },
+ "scaleSettings": {
+ "autoScale": {
+ "formula": "$TargetDedicatedNodes=1",
+ "evaluationInterval": "PT5M"
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "headers": {
+ "ETag": "W/\"0x8D4EDFEBFADF4AB\""
+ },
+ "body": {
+ "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool",
+ "name": "testpool",
+ "type": "Microsoft.Batch/batchAccounts/pools",
+ "etag": "W/\"0x8D4EDFEBFADF4AB\"",
+ "properties": {
+ "lastModified": "2017-08-28T10:22:55.9407275Z",
+ "creationTime": "2017-08-28T10:22:55.9407275Z",
+ "provisioningState": "Succeeded",
+ "provisioningStateTransitionTime": "2017-08-28T10:22:55.9407275Z",
+ "allocationState": "Resizing",
+ "allocationStateTransitionTime": "2017-08-28T10:22:55.9407275Z",
+ "vmSize": "STANDARD_D4",
+ "interNodeCommunication": "Disabled",
+ "maxTasksPerNode": 1,
+ "taskSchedulingPolicy": {
+ "nodeFillType": "Spread"
+ },
+ "deploymentConfiguration": {
+ "virtualMachineConfiguration": {
+ "imageReference": {
+ "publisher": "MicrosoftWindowsServer",
+ "offer": "WindowsServer",
+ "sku": "2016-Datacenter-SmallDisk",
+ "version": "latest"
+ },
+ "nodeAgentSkuId": "batch.node.windows amd64",
+ "windowsConfiguration": {
+ "enableAutomaticUpdates": false
+ },
+ "licenseType": "Windows_Server",
+ "dataDisks": [
+ {
+ "lun": 0,
+ "caching": "ReadWrite",
+ "diskSizeGB": 30,
+ "storageAccountType": "Premium_LRS"
+ },
+ {
+ "lun": 1,
+ "caching": "None",
+ "diskSizeGB": 200,
+ "storageAccountType": "Standard_LRS"
+ }
+ ],
+ "diskEncryptionConfiguration": {
+ "targets": [
+ "OsDisk",
+ "TemporaryDisk"
+ ]
+ }
+ }
+ },
+ "networkConfiguration": {
+ "endpointConfiguration": {
+ "inboundNatPools": [
+ {
+ "name": "testnat",
+ "protocol": "TCP",
+ "backendPort": 12001,
+ "frontendPortRangeStart": 15000,
+ "frontendPortRangeEnd": 15100,
+ "networkSecurityGroupRules": [
+ {
+ "access": "Allow",
+ "sourceAddressPrefix": "192.100.12.45",
+ "priority": 150,
+ "sourcePortRanges": [
+ "1",
+ "2"
+ ]
+ },
+ {
+ "access": "Deny",
+ "sourceAddressPrefix": "*",
+ "priority": 3500,
+ "sourcePortRanges": [
+ "*"
+ ]
+ }
+ ]
+ }
+ ]
+ }
+ },
+ "scaleSettings": {
+ "autoScale": {
+ "formula": "$TargetDedicatedNodes=1",
+ "evaluationInterval": "PT5M"
+ }
+ },
+ "currentDedicatedNodes": 0,
+ "currentLowPriorityNodes": 0
+ }
+ }
+ }
+ }
+}
diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/examples/PoolDelete.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/examples/PoolDelete.json
new file mode 100644
index 000000000000..381176d019ca
--- /dev/null
+++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/examples/PoolDelete.json
@@ -0,0 +1,19 @@
+{
+ "parameters": {
+ "subscriptionId": "subid",
+ "resourceGroupName": "default-azurebatch-japaneast",
+ "accountName": "sampleacct",
+ "poolName": "testpool",
+ "api-version": "2020-05-01"
+ },
+ "responses": {
+ "200": {},
+ "204": {},
+ "202": {
+ "headers": {
+ "Retry-After": "15",
+ "Location": "https://management.azure.com/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/poolOperationResults/delete-testpool-8D4EDFF164A11C9?api-version=2020-05-01"
+ }
+ }
+ }
+}
diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/examples/PoolDisableAutoScale.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/examples/PoolDisableAutoScale.json
new file mode 100644
index 000000000000..e0b8fec34a92
--- /dev/null
+++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/examples/PoolDisableAutoScale.json
@@ -0,0 +1,56 @@
+{
+ "parameters": {
+ "subscriptionId": "subid",
+ "resourceGroupName": "default-azurebatch-japaneast",
+ "accountName": "sampleacct",
+ "poolName": "testpool",
+ "api-version": "2020-05-01"
+ },
+ "responses": {
+ "200": {
+ "headers": {
+ "ETag": "W/\"0x8D4EDFEBFADF4AB\""
+ },
+ "body": {
+ "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool",
+ "name": "testpool",
+ "type": "Microsoft.Batch/batchAccounts/pools",
+ "etag": "W/\"0x8D4EDFEBFADF4AB\"",
+ "properties": {
+ "lastModified": "2017-08-28T10:22:55.9407275Z",
+ "creationTime": "2017-08-28T10:22:55.9407275Z",
+ "provisioningState": "Succeeded",
+ "provisioningStateTransitionTime": "2017-08-28T10:22:55.9407275Z",
+ "allocationState": "Resizing",
+ "allocationStateTransitionTime": "2017-08-28T10:22:55.9407275Z",
+ "vmSize": "STANDARD_D4",
+ "interNodeCommunication": "Disabled",
+ "maxTasksPerNode": 1,
+ "taskSchedulingPolicy": {
+ "nodeFillType": "Spread"
+ },
+ "deploymentConfiguration": {
+ "virtualMachineConfiguration": {
+ "imageReference": {
+ "publisher": "Canonical",
+ "offer": "UbuntuServer",
+ "sku": "18.04-LTS",
+ "version": "latest"
+ },
+ "nodeAgentSkuId": "batch.node.ubuntu 18.04"
+ }
+ },
+ "scaleSettings": {
+ "fixedScale": {
+ "targetDedicatedNodes": 3,
+ "targetLowPriorityNodes": 0,
+ "resizeTimeout": "PT15M"
+ }
+ },
+ "currentDedicatedNodes": 0,
+ "currentLowPriorityNodes": 0
+ }
+ }
+ }
+ }
+}
diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/examples/PoolGet.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/examples/PoolGet.json
new file mode 100644
index 000000000000..1255c7f77df4
--- /dev/null
+++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/examples/PoolGet.json
@@ -0,0 +1,155 @@
+{
+ "parameters": {
+ "subscriptionId": "subid",
+ "resourceGroupName": "default-azurebatch-japaneast",
+ "accountName": "sampleacct",
+ "poolName": "testpool",
+ "api-version": "2020-05-01"
+ },
+ "responses": {
+ "200": {
+ "headers": {
+ "ETag": "W/\"0x8D4EDFEBFADF4AB\""
+ },
+ "body": {
+ "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool",
+ "name": "testpool",
+ "type": "Microsoft.Batch/batchAccounts/pools",
+ "etag": "W/\"0x8D4EDFEBFADF4AB\"",
+ "properties": {
+ "lastModified": "2017-08-28T10:22:55.9407275Z",
+ "creationTime": "2017-08-28T10:22:55.9407275Z",
+ "provisioningState": "Succeeded",
+ "provisioningStateTransitionTime": "2017-08-28T10:22:55.9407275Z",
+ "allocationState": "Resizing",
+ "allocationStateTransitionTime": "2017-08-28T10:22:55.9407275Z",
+ "vmSize": "STANDARD_D4",
+ "interNodeCommunication": "Enabled",
+ "maxTasksPerNode": 13,
+ "taskSchedulingPolicy": {
+ "nodeFillType": "Pack"
+ },
+ "deploymentConfiguration": {
+ "cloudServiceConfiguration": {
+ "osFamily": "4",
+ "osVersion": "WA-GUEST-OS-4.45_201708-01"
+ }
+ },
+ "scaleSettings": {
+ "fixedScale": {
+ "targetDedicatedNodes": 6,
+ "targetLowPriorityNodes": 28,
+ "resizeTimeout": "PT8M"
+ }
+ },
+ "networkConfiguration": {
+ "subnetId": "/subscriptions/subid/resourceGroups/rg1234/providers/Microsoft.Network/virtualNetworks/network1234/subnets/subnet123",
+ "endpointConfiguration": {
+ "inboundNatPools": [
+ {
+ "name": "testnat",
+ "protocol": "TCP",
+ "backendPort": 12001,
+ "frontendPortRangeStart": 15000,
+ "frontendPortRangeEnd": 15100,
+ "networkSecurityGroupRules": [
+ {
+ "access": "Allow",
+ "sourceAddressPrefix": "192.100.12.45",
+ "priority": 150,
+ "sourcePortRanges": [
+ "123",
+ "22"
+ ]
+ },
+ {
+ "access": "Deny",
+ "sourceAddressPrefix": "*",
+ "priority": 3500,
+ "sourcePortRanges": [
+ "*"
+ ]
+ }
+ ]
+ }
+ ]
+ }
+ },
+ "metadata": [
+ {
+ "name": "metadata-1",
+ "value": "value-1"
+ },
+ {
+ "name": "metadata-2",
+ "value": "value-2"
+ }
+ ],
+ "startTask": {
+ "commandLine": "cmd /c SET",
+ "resourceFiles": [
+ {
+ "httpUrl": "https://testaccount.blob.core.windows.net/example-blob-file",
+ "filePath": "c:\\temp\\gohere",
+ "fileMode": "777"
+ }
+ ],
+ "environmentSettings": [
+ {
+ "name": "MYSET",
+ "value": "1234"
+ }
+ ],
+ "userIdentity": {
+ "autoUser": {
+ "scope": "Pool",
+ "elevationLevel": "Admin"
+ }
+ },
+ "maxTaskRetryCount": 6,
+ "waitForSuccess": true
+ },
+ "userAccounts": [
+ {
+ "name": "username1",
+ "elevationLevel": "Admin",
+ "linuxUserConfiguration": {
+ "uid": 1234,
+ "gid": 4567
+ }
+ }
+ ],
+ "applicationPackages": [
+ {
+ "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool/applications/app_1234",
+ "version": "asdf"
+ }
+ ],
+ "certificates": [
+ {
+ "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool/certificates/sha1-1234567",
+ "storeLocation": "LocalMachine",
+ "storeName": "MY",
+ "visibility": [
+ "RemoteUser"
+ ]
+ }
+ ],
+ "applicationLicenses": [
+ "app-license0",
+ "app-license1"
+ ],
+ "currentDedicatedNodes": 0,
+ "currentLowPriorityNodes": 0,
+ "resizeOperationStatus": {
+ "startTime": "2017-08-28T10:22:55.9407275Z",
+ "targetDedicatedNodes": 6,
+ "targetLowPriorityNodes": 28,
+ "nodeDeallocationOption": "TaskCompletion",
+ "resizeTimeout": "PT8M"
+ }
+ }
+ }
+ }
+ }
+}
diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/examples/PoolList.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/examples/PoolList.json
new file mode 100644
index 000000000000..39d49bb8a38a
--- /dev/null
+++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/examples/PoolList.json
@@ -0,0 +1,161 @@
+{
+ "parameters": {
+ "subscriptionId": "subid",
+ "resourceGroupName": "default-azurebatch-japaneast",
+ "accountName": "sampleacct",
+ "poolName": "testpool",
+ "api-version": "2020-05-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool",
+ "name": "testpool",
+ "type": "Microsoft.Batch/batchAccounts/pools",
+ "etag": "W/\"0x8D4EDFEBFADF4AB\"",
+ "properties": {
+ "lastModified": "2017-08-28T10:22:55.9407275Z",
+ "creationTime": "2017-08-28T10:22:55.9407275Z",
+ "provisioningState": "Succeeded",
+ "provisioningStateTransitionTime": "2017-08-28T10:22:55.9407275Z",
+ "allocationState": "Steady",
+ "allocationStateTransitionTime": "2017-08-28T10:22:55.9407275Z",
+ "vmSize": "STANDARD_D4",
+ "interNodeCommunication": "Enabled",
+ "maxTasksPerNode": 13,
+ "taskSchedulingPolicy": {
+ "nodeFillType": "Pack"
+ },
+ "deploymentConfiguration": {
+ "cloudServiceConfiguration": {
+ "osFamily": "4",
+ "osVersion": "WA-GUEST-OS-4.45_201708-01"
+ }
+ },
+ "scaleSettings": {
+ "fixedScale": {
+ "targetDedicatedNodes": 6,
+ "targetLowPriorityNodes": 28,
+ "resizeTimeout": "PT8M"
+ }
+ },
+ "networkConfiguration": {
+ "subnetId": "/subscriptions/subid/resourceGroups/rg1234/providers/Microsoft.Network/virtualNetworks/network1234/subnets/subnet123",
+ "endpointConfiguration": {
+ "inboundNatPools": [
+ {
+ "name": "testnat",
+ "protocol": "TCP",
+ "backendPort": 12001,
+ "frontendPortRangeStart": 15000,
+ "frontendPortRangeEnd": 15100,
+ "networkSecurityGroupRules": [
+ {
+ "access": "Allow",
+ "sourceAddressPrefix": "192.100.12.45",
+ "priority": 150,
+ "sourcePortRanges": [
+ "*"
+ ]
+ },
+ {
+ "access": "Deny",
+ "sourceAddressPrefix": "*",
+ "priority": 3500,
+ "sourcePortRanges": [
+ "*"
+ ]
+ }
+ ]
+ }
+ ]
+ }
+ },
+ "metadata": [
+ {
+ "name": "metadata-1",
+ "value": "value-1"
+ },
+ {
+ "name": "metadata-2",
+ "value": "value-2"
+ }
+ ],
+ "startTask": {
+ "commandLine": "cmd /c SET",
+ "resourceFiles": [
+ {
+ "httpUrl": "https://testaccount.blob.core.windows.net/example-blob-file",
+ "filePath": "c:\\temp\\gohere",
+ "fileMode": "777"
+ }
+ ],
+ "environmentSettings": [
+ {
+ "name": "MYSET",
+ "value": "1234"
+ }
+ ],
+ "userIdentity": {
+ "autoUser": {
+ "scope": "Pool",
+ "elevationLevel": "Admin"
+ }
+ },
+ "maxTaskRetryCount": 6,
+ "waitForSuccess": true
+ },
+ "userAccounts": [
+ {
+ "name": "username1",
+ "elevationLevel": "Admin",
+ "linuxUserConfiguration": {
+ "uid": 1234,
+ "gid": 4567
+ }
+ }
+ ],
+ "applicationPackages": [
+ {
+ "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool/applications/app_1234",
+ "version": "asdf"
+ }
+ ],
+ "certificates": [
+ {
+ "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool/certificates/sha1-1234567",
+ "storeLocation": "LocalMachine",
+ "storeName": "MY",
+ "visibility": [
+ "RemoteUser"
+ ]
+ }
+ ],
+ "applicationLicenses": [
+ "app-license0",
+ "app-license1"
+ ],
+ "currentDedicatedNodes": 0,
+ "currentLowPriorityNodes": 0,
+ "resizeOperationStatus": {
+ "startTime": "2017-08-28T10:22:55.9407275Z",
+ "targetDedicatedNodes": 6,
+ "targetLowPriorityNodes": 28,
+ "nodeDeallocationOption": "TaskCompletion",
+ "resizeTimeout": "PT8M",
+ "errors": [
+ {
+ "code": "AllocationTimedout",
+ "message": "Desired number of dedicated nodes could not be allocated as the resize timeout was reached"
+ }
+ ]
+ }
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/examples/PoolListWithFilter.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/examples/PoolListWithFilter.json
new file mode 100644
index 000000000000..af59f8dfbc23
--- /dev/null
+++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/examples/PoolListWithFilter.json
@@ -0,0 +1,44 @@
+{
+ "parameters": {
+ "subscriptionId": "subid",
+ "resourceGroupName": "default-azurebatch-japaneast",
+ "accountName": "sampleacct",
+ "poolName": "testpool",
+ "api-version": "2020-05-01",
+ "$filter": "startswith(name, 'po') or (properties/allocationState eq 'Steady' and properties/provisioningStateTransitionTime lt datetime'2017-02-02')",
+ "$select": "properties/allocationState,properties/provisioningStateTransitionTime,properties/currentDedicatedNodes,properties/currentLowPriorityNodes",
+ "maxResults": "50"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool",
+ "name": "testpool",
+ "type": "Microsoft.Batch/batchAccounts/pools",
+ "etag": "W/\"0x8D4EDFEBFADF4AB\"",
+ "properties": {
+ "provisioningStateTransitionTime": "2017-08-28T10:22:55.9407275Z",
+ "allocationState": "Steady",
+ "currentDedicatedNodes": 0,
+ "currentLowPriorityNodes": 2
+ }
+ },
+ {
+ "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/pooltest",
+ "name": "pooltest",
+ "type": "Microsoft.Batch/batchAccounts/pools",
+ "etag": "W/\"0x8D4EDFEBFADF4AB\"",
+ "properties": {
+ "provisioningStateTransitionTime": "2017-08-26T10:22:55.9407275Z",
+ "allocationState": "Resizing",
+ "currentDedicatedNodes": 4,
+ "currentLowPriorityNodes": 0
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/examples/PoolStopResize.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/examples/PoolStopResize.json
new file mode 100644
index 000000000000..1fa19c7bb841
--- /dev/null
+++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/examples/PoolStopResize.json
@@ -0,0 +1,62 @@
+{
+ "parameters": {
+ "subscriptionId": "subid",
+ "resourceGroupName": "default-azurebatch-japaneast",
+ "accountName": "sampleacct",
+ "poolName": "testpool",
+ "api-version": "2020-05-01"
+ },
+ "responses": {
+ "200": {
+ "headers": {
+ "ETag": "W/\"0x8D4EDFEBFADF4AB\""
+ },
+ "body": {
+ "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool",
+ "name": "testpool",
+ "type": "Microsoft.Batch/batchAccounts/pools",
+ "etag": "W/\"0x8D4EDFEBFADF4AB\"",
+ "properties": {
+ "lastModified": "2017-08-28T10:22:55.9407275Z",
+ "creationTime": "2017-08-28T10:22:55.9407275Z",
+ "provisioningState": "Succeeded",
+ "provisioningStateTransitionTime": "2017-08-28T10:22:55.9407275Z",
+ "allocationState": "Steady",
+ "allocationStateTransitionTime": "2017-08-28T10:22:55.9407275Z",
+ "vmSize": "STANDARD_D4",
+ "interNodeCommunication": "Disabled",
+ "maxTasksPerNode": 1,
+ "taskSchedulingPolicy": {
+ "nodeFillType": "Spread"
+ },
+ "deploymentConfiguration": {
+ "virtualMachineConfiguration": {
+ "imageReference": {
+ "publisher": "Canonical",
+ "offer": "UbuntuServer",
+ "sku": "18.04-LTS",
+ "version": "latest"
+ },
+ "nodeAgentSkuId": "batch.node.ubuntu 18.04"
+ }
+ },
+ "scaleSettings": {
+ "fixedScale": {
+ "targetDedicatedNodes": 3,
+ "targetLowPriorityNodes": 0,
+ "resizeTimeout": "PT15M"
+ }
+ },
+ "resizeOperationStatus": {
+ "startTime": "2017-08-28T10:22:55.9407275Z",
+ "targetDedicatedNodes": 1,
+ "nodeDeallocationOption": "Requeue",
+ "resizeTimeout": "PT10M"
+ },
+ "currentDedicatedNodes": 0,
+ "currentLowPriorityNodes": 0
+ }
+ }
+ }
+ }
+}
diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/examples/PoolUpdate_EnableAutoScale.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/examples/PoolUpdate_EnableAutoScale.json
new file mode 100644
index 000000000000..c88633fb713f
--- /dev/null
+++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/examples/PoolUpdate_EnableAutoScale.json
@@ -0,0 +1,69 @@
+{
+ "parameters": {
+ "subscriptionId": "subid",
+ "resourceGroupName": "default-azurebatch-japaneast",
+ "accountName": "sampleacct",
+ "poolName": "testpool",
+ "api-version": "2020-05-01",
+ "parameters": {
+ "properties": {
+ "scaleSettings": {
+ "autoScale": {
+ "formula": "$TargetDedicatedNodes=34"
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "headers": {
+ "ETag": "W/\"0x8D4EDFEBFADF4AB\""
+ },
+ "body": {
+ "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool",
+ "name": "testpool",
+ "type": "Microsoft.Batch/batchAccounts/pools",
+ "etag": "W/\"0x8D4EDFEBFADF4AB\"",
+ "properties": {
+ "lastModified": "2017-08-29T10:22:55.9407275Z",
+ "creationTime": "2017-08-28T10:22:55.9407275Z",
+ "provisioningState": "Succeeded",
+ "provisioningStateTransitionTime": "2017-08-28T10:22:55.9407275Z",
+ "allocationState": "Resizing",
+ "allocationStateTransitionTime": "2017-08-29T10:22:55.9407275Z",
+ "vmSize": "STANDARD_D4",
+ "interNodeCommunication": "Disabled",
+ "maxTasksPerNode": 1,
+ "taskSchedulingPolicy": {
+ "nodeFillType": "Spread"
+ },
+ "deploymentConfiguration": {
+ "cloudServiceConfiguration": {
+ "osFamily": "5",
+ "osVersion": "*"
+ }
+ },
+ "scaleSettings": {
+ "autoScale": {
+ "formula": "$TargetDedicated=34",
+ "evaluationInterval": "PT15M"
+ }
+ },
+ "autoScaleRun": {
+ "evaluationTime": "2017-08-29T10:22:55.9407275Z",
+ "results": "$TargetDedicatedNodes=34;NodeDeallocationOption=requeue"
+ },
+ "currentDedicatedNodes": 12,
+ "currentLowPriorityNodes": 0,
+ "resizeOperationStatus": {
+ "startTime": "2017-08-29T10:22:55.9407275Z",
+ "targetDedicatedNodes": 34,
+ "nodeDeallocationOption": "Requeue",
+ "resizeTimeout": "PT15M"
+ }
+ }
+ }
+ }
+ }
+}
diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/examples/PoolUpdate_OtherProperties.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/examples/PoolUpdate_OtherProperties.json
new file mode 100644
index 000000000000..5570f4dc09de
--- /dev/null
+++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/examples/PoolUpdate_OtherProperties.json
@@ -0,0 +1,115 @@
+{
+ "parameters": {
+ "subscriptionId": "subid",
+ "resourceGroupName": "default-azurebatch-japaneast",
+ "accountName": "sampleacct",
+ "poolName": "testpool",
+ "api-version": "2020-05-01",
+ "parameters": {
+ "properties": {
+ "metadata": [
+ {
+ "name": "key1",
+ "value": "value1"
+ }
+ ],
+ "applicationPackages": [
+ {
+ "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool/applications/app_1234"
+ },
+ {
+ "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool/applications/app_5678",
+ "version": "1.0"
+ }
+ ],
+ "certificates": [
+ {
+ "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool/certificates/sha1-1234567",
+ "storeLocation": "LocalMachine",
+ "storeName": "MY"
+ }
+ ]
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "headers": {
+ "ETag": "W/\"0x8D4EDFEBFADF4AB\""
+ },
+ "body": {
+ "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool",
+ "name": "testpool",
+ "type": "Microsoft.Batch/batchAccounts/pools",
+ "etag": "W/\"0x8D4EDFEBFADF4AB\"",
+ "properties": {
+ "lastModified": "2017-08-29T10:22:55.9407275Z",
+ "creationTime": "2017-08-28T10:22:55.9407275Z",
+ "provisioningState": "Succeeded",
+ "provisioningStateTransitionTime": "2017-08-28T10:22:55.9407275Z",
+ "allocationState": "Resizing",
+ "allocationStateTransitionTime": "2017-08-29T10:22:55.9407275Z",
+ "vmSize": "STANDARD_D4",
+ "interNodeCommunication": "Disabled",
+ "maxTasksPerNode": 1,
+ "taskSchedulingPolicy": {
+ "nodeFillType": "Spread"
+ },
+ "deploymentConfiguration": {
+ "cloudServiceConfiguration": {
+ "osFamily": "5",
+ "osVersion": "*"
+ }
+ },
+ "scaleSettings": {
+ "fixedScale": {
+ "targetDedicatedNodes": 1,
+ "targetLowPriorityNodes": 0,
+ "resizeTimeout": "PT8M",
+ "nodeDeallocationOption": "TaskCompletion"
+ }
+ },
+ "autoScaleRun": {
+ "evaluationTime": "2017-08-29T10:22:55.9407275Z",
+ "results": "$TargetDedicatedNodes=34;NodeDeallocationOption=requeue"
+ },
+ "currentDedicatedNodes": 12,
+ "currentLowPriorityNodes": 0,
+ "resizeOperationStatus": {
+ "startTime": "2017-08-29T10:22:55.9407275Z",
+ "targetDedicatedNodes": 8,
+ "nodeDeallocationOption": "TaskCompletion",
+ "resizeTimeout": "PT8M"
+ },
+ "metadata": [
+ {
+ "name": "key1",
+ "value": "value1"
+ }
+ ],
+ "applicationPackages": [
+ {
+ "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool/applications/app_1234"
+ },
+ {
+ "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool/applications/app_5678",
+ "version": "1.0"
+ }
+ ],
+ "certificates": [
+ {
+ "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool/certificates/sha1-1234567",
+ "storeLocation": "LocalMachine",
+ "storeName": "MY",
+ "visibility": [
+ "StartTask",
+ "Task",
+ "RemoteUser"
+ ]
+ }
+ ]
+ }
+ }
+ }
+ }
+}
diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/examples/PoolUpdate_RemoveStartTask.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/examples/PoolUpdate_RemoveStartTask.json
new file mode 100644
index 000000000000..a39339130ac0
--- /dev/null
+++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/examples/PoolUpdate_RemoveStartTask.json
@@ -0,0 +1,65 @@
+{
+ "parameters": {
+ "subscriptionId": "subid",
+ "resourceGroupName": "default-azurebatch-japaneast",
+ "accountName": "sampleacct",
+ "poolName": "testpool",
+ "api-version": "2020-05-01",
+ "parameters": {
+ "properties": {
+ "startTask": {}
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "headers": {
+ "ETag": "W/\"0x8D4EDFEBFADF4AB\""
+ },
+ "body": {
+ "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool",
+ "name": "testpool",
+ "type": "Microsoft.Batch/batchAccounts/pools",
+ "etag": "W/\"0x8D4EDFEBFADF4AB\"",
+ "properties": {
+ "lastModified": "2017-08-29T10:22:55.9407275Z",
+ "creationTime": "2017-08-28T10:22:55.9407275Z",
+ "provisioningState": "Succeeded",
+ "provisioningStateTransitionTime": "2017-08-28T10:22:55.9407275Z",
+ "allocationState": "Resizing",
+ "allocationStateTransitionTime": "2017-08-29T10:22:55.9407275Z",
+ "vmSize": "STANDARD_D4",
+ "interNodeCommunication": "Disabled",
+ "maxTasksPerNode": 1,
+ "taskSchedulingPolicy": {
+ "nodeFillType": "Spread"
+ },
+ "deploymentConfiguration": {
+ "cloudServiceConfiguration": {
+ "osFamily": "5",
+ "osVersion": "*"
+ }
+ },
+ "scaleSettings": {
+ "autoScale": {
+ "formula": "$TargetDedicated=34",
+ "evaluationInterval": "PT15M"
+ }
+ },
+ "autoScaleRun": {
+ "evaluationTime": "2017-08-29T10:22:55.9407275Z",
+ "results": "$TargetDedicatedNodes=34;NodeDeallocationOption=requeue"
+ },
+ "currentDedicatedNodes": 12,
+ "currentLowPriorityNodes": 0,
+ "resizeOperationStatus": {
+ "startTime": "2017-08-29T10:22:55.9407275Z",
+ "targetDedicatedNodes": 34,
+ "nodeDeallocationOption": "Requeue",
+ "resizeTimeout": "PT15M"
+ }
+ }
+ }
+ }
+ }
+}
diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/examples/PoolUpdate_ResizePool.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/examples/PoolUpdate_ResizePool.json
new file mode 100644
index 000000000000..4c5a4a3d5b34
--- /dev/null
+++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/examples/PoolUpdate_ResizePool.json
@@ -0,0 +1,74 @@
+{
+ "parameters": {
+ "subscriptionId": "subid",
+ "resourceGroupName": "default-azurebatch-japaneast",
+ "accountName": "sampleacct",
+ "poolName": "testpool",
+ "api-version": "2020-05-01",
+ "parameters": {
+ "properties": {
+ "scaleSettings": {
+ "fixedScale": {
+ "targetDedicatedNodes": 5,
+ "targetLowPriorityNodes": 0,
+ "resizeTimeout": "PT8M",
+ "nodeDeallocationOption": "TaskCompletion"
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "headers": {
+ "ETag": "W/\"0x8D4EDFEBFADF4AB\""
+ },
+ "body": {
+ "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool",
+ "name": "testpool",
+ "type": "Microsoft.Batch/batchAccounts/pools",
+ "etag": "W/\"0x8D4EDFEBFADF4AB\"",
+ "properties": {
+ "lastModified": "2017-08-29T10:22:55.9407275Z",
+ "creationTime": "2017-08-28T10:22:55.9407275Z",
+ "provisioningState": "Succeeded",
+ "provisioningStateTransitionTime": "2017-08-28T10:22:55.9407275Z",
+ "allocationState": "Resizing",
+ "allocationStateTransitionTime": "2017-08-29T10:22:55.9407275Z",
+ "vmSize": "STANDARD_D4",
+ "interNodeCommunication": "Disabled",
+ "maxTasksPerNode": 1,
+ "taskSchedulingPolicy": {
+ "nodeFillType": "Spread"
+ },
+ "deploymentConfiguration": {
+ "cloudServiceConfiguration": {
+ "osFamily": "5",
+ "osVersion": "*"
+ }
+ },
+ "scaleSettings": {
+ "fixedScale": {
+ "targetDedicatedNodes": 1,
+ "targetLowPriorityNodes": 0,
+ "resizeTimeout": "PT8M",
+ "nodeDeallocationOption": "TaskCompletion"
+ }
+ },
+ "autoScaleRun": {
+ "evaluationTime": "2017-08-29T10:22:55.9407275Z",
+ "results": "$TargetDedicatedNodes=34;NodeDeallocationOption=requeue"
+ },
+ "currentDedicatedNodes": 12,
+ "currentLowPriorityNodes": 0,
+ "resizeOperationStatus": {
+ "startTime": "2017-08-29T10:22:55.9407275Z",
+ "targetDedicatedNodes": 8,
+ "nodeDeallocationOption": "TaskCompletion",
+ "resizeTimeout": "PT8M"
+ }
+ }
+ }
+ }
+ }
+}
diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/examples/PrivateBatchAccountCreate.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/examples/PrivateBatchAccountCreate.json
new file mode 100644
index 000000000000..2d72f33bbecd
--- /dev/null
+++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/examples/PrivateBatchAccountCreate.json
@@ -0,0 +1,53 @@
+{
+ "parameters": {
+ "accountName": "sampleacct",
+ "resourceGroupName": "default-azurebatch-japaneast",
+ "api-version": "2020-05-01",
+ "subscriptionId": "subid",
+ "parameters": {
+ "location": "japaneast",
+ "properties": {
+ "autoStorage": {
+ "storageAccountId": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Storage/storageAccounts/samplestorage"
+ },
+ "keyVaultReference": {
+ "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.KeyVault/vaults/sample",
+ "url": "http://sample.vault.azure.net/"
+ },
+ "publicNetworkAccess": "Disabled"
+ }
+ }
+ },
+ "responses": {
+ "202": {},
+ "200": {
+ "body": {
+ "name": "sampleacct",
+ "location": "japaneast",
+ "properties": {
+ "accountEndpoint": "sampleacct.japaneast.batch.azure.com",
+ "provisioningState": "Succeeded",
+ "poolAllocationMode": "UserSubscription",
+ "dedicatedCoreQuota": 20,
+ "lowPriorityCoreQuota": 20,
+ "poolQuota": 20,
+ "activeJobAndJobScheduleQuota": 20,
+ "autoStorage": {
+ "storageAccountId": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Storage/storageAccounts/samplestorage",
+ "lastKeySync": "2016-03-10T23:48:38.9878479Z"
+ },
+ "keyVaultReference": {
+ "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.KeyVault/vaults/sample",
+ "url": "http://sample.vault.azure.net/"
+ },
+ "publicNetworkAccess": "Disabled"
+ },
+ "identity": {
+ "type": "None"
+ },
+ "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct",
+ "type": "Microsoft.Batch/batchAccounts"
+ }
+ }
+ }
+}
diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/examples/PrivateBatchAccountGet.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/examples/PrivateBatchAccountGet.json
new file mode 100644
index 000000000000..6fffebe21a02
--- /dev/null
+++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/examples/PrivateBatchAccountGet.json
@@ -0,0 +1,48 @@
+{
+ "parameters": {
+ "accountName": "sampleacct",
+ "resourceGroupName": "default-azurebatch-japaneast",
+ "api-version": "2020-05-01",
+ "subscriptionId": "subid"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "name": "sampleacct",
+ "location": "japaneast",
+ "properties": {
+ "accountEndpoint": "sampleacct.japaneast.batch.azure.com",
+ "provisioningState": "Succeeded",
+ "poolAllocationMode": "BatchService",
+ "dedicatedCoreQuota": 20,
+ "lowPriorityCoreQuota": 20,
+ "poolQuota": 20,
+ "activeJobAndJobScheduleQuota": 20,
+ "autoStorage": {
+ "storageAccountId": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Storage/storageAccounts/samplestorage",
+ "lastKeySync": "2016-03-10T23:48:38.9878479Z"
+ },
+ "publicNetworkAccess": "Disabled",
+ "privateEndpointConnections": [
+ {
+ "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/privateEndpointConnections/testprivateEndpointConnection.24d6b4b5-e65c-4330-bbe9-3a290d62f8e0",
+ "name": "testprivateEndpointConnection.24d6b4b5-e65c-4330-bbe9-3a290d62f8e0",
+ "type": "Microsoft.Batch/batchAccounts/privateEndpointConnections",
+ "properties": {
+ "privateEndpoint": {
+ "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Network/privateEndpoints/testprivateEndpoint"
+ },
+ "privateLinkServiceConnectionState": {
+ "status": "Approved",
+ "description": "Approved by xyz.abc@company.com"
+ }
+ }
+ }
+ ]
+ },
+ "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct",
+ "type": "Microsoft.Batch/batchAccounts"
+ }
+ }
+ }
+}
diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/examples/PrivateEndpointConnectionGet.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/examples/PrivateEndpointConnectionGet.json
new file mode 100644
index 000000000000..dcf7e38ee64c
--- /dev/null
+++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/examples/PrivateEndpointConnectionGet.json
@@ -0,0 +1,27 @@
+{
+ "parameters": {
+ "subscriptionId": "subid",
+ "resourceGroupName": "default-azurebatch-japaneast",
+ "accountName": "sampleacct",
+ "privateEndpointConnectionName": "testprivateEndpointConnection5testprivateEndpointConnection5.24d6b4b5-e65c-4330-bbe9-3a290d62f8e0",
+ "api-version": "2020-05-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/privateEndpointConnections/testprivateEndpointConnection5testprivateEndpointConnection5.24d6b4b5-e65c-4330-bbe9-3a290d62f8e0",
+ "name": "testprivateEndpointConnection5testprivateEndpointConnection5.24d6b4b5-e65c-4330-bbe9-3a290d62f8e0",
+ "type": "Microsoft.Batch/batchAccounts/privateEndpointConnections",
+ "properties": {
+ "privateEndpoint": {
+ "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Network/privateEndpoints/testprivateEndpoint"
+ },
+ "privateLinkServiceConnectionState": {
+ "status": "Approved",
+ "description": "Approved by xyz.abc@company.com"
+ }
+ }
+ }
+ }
+ }
+}
diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/examples/PrivateEndpointConnectionUpdate.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/examples/PrivateEndpointConnectionUpdate.json
new file mode 100644
index 000000000000..3ab6694f43f6
--- /dev/null
+++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/examples/PrivateEndpointConnectionUpdate.json
@@ -0,0 +1,47 @@
+{
+ "parameters": {
+ "subscriptionId": "subid",
+ "resourceGroupName": "default-azurebatch-japaneast",
+ "accountName": "sampleacct",
+ "privateEndpointConnectionName": "testprivateEndpointConnection5.24d6b4b5-e65c-4330-bbe9-3a290d62f8e0",
+ "api-version": "2020-05-01",
+ "parameters": {
+ "properties": {
+ "privateLinkServiceConnectionState": {
+ "status": "Approved",
+ "description": "Approved by xyz.abc@company.com"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "headers": {
+ "ETag": "W/\"0x8D4EDFEBFADF4AB\""
+ },
+ "body": {
+ "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/privateEndpointConnections/testprivateEndpointConnection5.24d6b4b5-e65c-4330-bbe9-3a290d62f8e0",
+ "name": "testprivateEndpointConnection5.24d6b4b5-e65c-4330-bbe9-3a290d62f8e0",
+ "type": "Microsoft.Batch/batchAccounts/privateEndpointConnections",
+ "etag": "W/\"0x8D4EDFEBFADF4AB\"",
+ "properties": {
+ "provisioningState": "Succeeded",
+ "privateEndpoint": {
+ "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Network/privateEndpoints/testprivateEndpoint"
+ },
+ "privateLinkServiceConnectionState": {
+ "status": "Approved",
+ "description": "Approved by xyz.abc@company.com"
+ }
+ }
+ }
+ },
+ "204": {},
+ "202": {
+ "headers": {
+ "Retry-After": "15",
+ "Location": "https://management.azure.com/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/privateEndpointConnectionProxyResults/Updating$testprivateEndpointConnection5.24d6b4b5$e65c-4330-bbe9-3a290d62f8e0-8D4EDFF164A11C9?api-version=2020-05-01"
+ }
+ }
+ }
+}
diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/examples/PrivateEndpointConnectionsList.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/examples/PrivateEndpointConnectionsList.json
new file mode 100644
index 000000000000..50787f91b384
--- /dev/null
+++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/examples/PrivateEndpointConnectionsList.json
@@ -0,0 +1,31 @@
+{
+ "parameters": {
+ "subscriptionId": "subid",
+ "resourceGroupName": "default-azurebatch-japaneast",
+ "accountName": "sampleacct",
+ "privateEndpointConnectionName": "testprivateEndpointConnection",
+ "api-version": "2020-05-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/privateEndpointConnections/testprivateEndpointConnection",
+ "name": "testprivateEndpointConnection",
+ "type": "Microsoft.Batch/batchAccounts/privateEndpointConnections",
+ "properties": {
+ "privateEndpoint": {
+ "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Network/privateEndpoints/testprivateEndpoint"
+ },
+ "privateLinkServiceConnectionState": {
+ "status": "Approved",
+ "description": "Approved by xyz.abc@company.com"
+ }
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/examples/PrivateLinkResourceGet.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/examples/PrivateLinkResourceGet.json
new file mode 100644
index 000000000000..6028faf0890a
--- /dev/null
+++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/examples/PrivateLinkResourceGet.json
@@ -0,0 +1,27 @@
+{
+ "parameters": {
+ "subscriptionId": "subid",
+ "resourceGroupName": "default-azurebatch-japaneast",
+ "accountName": "sampleacct",
+ "privateLinkResourceName": "sampleacct",
+ "api-version": "2020-05-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/privateLinkResources/sampleacct",
+ "name": "sampleacct",
+ "type": "Microsoft.Batch/batchAccounts/privateLinkResources",
+ "properties": {
+ "groupId": "batchAccount",
+ "requiredMembers": [
+ "batchAccount"
+ ],
+ "requiredZoneNames": [
+ "privatelink.japaneast.batch.azure.com"
+ ]
+ }
+ }
+ }
+ }
+}
diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/examples/PrivateLinkResourcesList.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/examples/PrivateLinkResourcesList.json
new file mode 100644
index 000000000000..942d4346cd6b
--- /dev/null
+++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/examples/PrivateLinkResourcesList.json
@@ -0,0 +1,31 @@
+{
+ "parameters": {
+ "subscriptionId": "subid",
+ "resourceGroupName": "default-azurebatch-japaneast",
+ "accountName": "sampleacct",
+ "privateLinkResourceName": "testprivateLinkResource",
+ "api-version": "2020-05-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/privateLinkResources/testprivateLinkResource",
+ "name": "testprivateLinkResource",
+ "type": "Microsoft.Batch/batchAccounts/privateLinkResources",
+ "properties": {
+ "groupId": "batchAccount",
+ "requiredMembers": [
+ "batchAccount"
+ ],
+ "requiredZoneNames": [
+ "privatelink.japaneast.batch.azure.com"
+ ]
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/batch/resource-manager/readme.md b/specification/batch/resource-manager/readme.md
index ffa9383df33d..90df5aff354d 100644
--- a/specification/batch/resource-manager/readme.md
+++ b/specification/batch/resource-manager/readme.md
@@ -26,14 +26,23 @@ These are the global settings for the Batch API.
``` yaml
openapi-type: arm
-tag: package-2020-03
+tag: package-2020-05
```
+
+### Tag: package-2020-05
+
+These settings apply only when `--tag=package-2020-05` is specified on the command line.
+
+```yaml $(tag) == 'package-2020-05'
+input-file:
+ - Microsoft.Batch/stable/2020-05-01/BatchManagement.json
+```
### Tag: package-2020-03
These settings apply only when `--tag=package-2020-03` is specified on the command line.
-```yaml $(tag) == 'package-2020-03'
+``` yaml $(tag) == 'package-2020-03'
input-file:
- Microsoft.Batch/stable/2020-03-01/BatchManagement.json
```
@@ -42,7 +51,7 @@ input-file:
These settings apply only when `--tag=package-2019-08` is specified on the command line.
-```yaml $(tag) == 'package-2019-08'
+``` yaml $(tag) == 'package-2019-08'
input-file:
- Microsoft.Batch/stable/2019-08-01/BatchManagement.json
```
@@ -51,7 +60,7 @@ input-file:
These settings apply only when `--tag=package-2019-04` is specified on the command line.
-```yaml $(tag) == 'package-2019-04'
+``` yaml $(tag) == 'package-2019-04'
input-file:
- Microsoft.Batch/stable/2019-04-01/BatchManagement.json
```
@@ -180,7 +189,6 @@ csharp:
See configuration in [readme.go.md](./readme.go.md)
-
## Java
These settings apply only when `--java` is specified on the command line.
@@ -259,7 +267,7 @@ generate-interface: true
`
-## Multi-API/Profile support for AutoRest v3 generators
+## Multi-API/Profile support for AutoRest v3 generators
AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files.
@@ -271,6 +279,7 @@ require: $(this-folder)/../../../profiles/readme.md
# all the input files across all versions
input-file:
+ - $(this-folder)/Microsoft.Batch/stable/2020-05-01/BatchManagement.json
- $(this-folder)/Microsoft.Batch/stable/2020-03-01/BatchManagement.json
- $(this-folder)/Microsoft.Batch/stable/2019-08-01/BatchManagement.json
- $(this-folder)/Microsoft.Batch/stable/2019-04-01/BatchManagement.json
@@ -282,11 +291,10 @@ input-file:
```
-If there are files that should not be in the `all-api-versions` set,
+If there are files that should not be in the `all-api-versions` set,
uncomment the `exclude-file` section below and add the file paths.
``` yaml $(tag) == 'all-api-versions'
#exclude-file:
# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json
```
-
diff --git a/specification/billing/resource-manager/Microsoft.Billing/preview/2019-10-01-preview/billing.json b/specification/billing/resource-manager/Microsoft.Billing/preview/2019-10-01-preview/billing.json
index 474087d42ac9..9ef0b0294a0d 100644
--- a/specification/billing/resource-manager/Microsoft.Billing/preview/2019-10-01-preview/billing.json
+++ b/specification/billing/resource-manager/Microsoft.Billing/preview/2019-10-01-preview/billing.json
@@ -1604,7 +1604,7 @@
}
},
"operationId": "Invoices_ListByBillingAccount",
- "description": "Lists the invoices for a billing account for a given start date and end date. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.",
+ "description": "Lists the invoices for a billing account for a given start date and end date. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement, Microsoft Customer Agreement or Enterprise Agreement.",
"parameters": [
{
"$ref": "#/parameters/apiVersionParameter"
@@ -1643,6 +1643,45 @@
}
}
},
+ "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoices/{invoiceName}": {
+ "get": {
+ "tags": [
+ "Invoices"
+ ],
+ "x-ms-examples": {
+ "EnterpriseAgreementInvoice": {
+ "$ref": "./examples/BillingAccountInvoice.json"
+ }
+ },
+ "operationId": "Invoices_GetBillingAccountInvoice",
+ "description": "Gets an invoice by billing account name and ID. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement, Microsoft Customer Agreement or Enterprise Agreement.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/billingAccountNameParameter"
+ },
+ {
+ "$ref": "#/parameters/invoiceNameParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK. The request has succeeded.",
+ "schema": {
+ "$ref": "#/definitions/Invoice"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ }
+ }
+ },
"/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoices/{invoiceName}/pricesheet/default/download": {
"post": {
"tags": [
@@ -6245,7 +6284,8 @@
"enum": [
"Due",
"OverDue",
- "Paid"
+ "Paid",
+ "Void"
],
"readOnly": true,
"x-ms-enum": {
@@ -6359,6 +6399,11 @@
"description": "The ID of the subscription for which the invoice is generated.",
"type": "string",
"readOnly": true
+ },
+ "rebillDetails": {
+ "description": "Rebill details of an Enterprise Agreement invoice.",
+ "x-ms-client-flatten": true,
+ "$ref": "#/definitions/InvoiceRebillDetails"
}
}
},
@@ -6402,6 +6447,34 @@
}
}
},
+ "InvoiceRebillDetails": {
+ "description": "The rebill details of an invoice.",
+ "properties": {
+ "rebillDocumentType": {
+ "description": "The type of the document generated when an Enterprise Agreement invoice is rebilled.",
+ "type": "string",
+ "enum": [
+ "Credit",
+ "Rebill",
+ "Original"
+ ],
+ "x-ms-enum": {
+ "name": "rebillDocumentType",
+ "modelAsString": true
+ }
+ },
+ "rebilledInvoiceId": {
+ "description": "The ID of the invoice generated when an Enterprise Agreement invoice is rebilled.",
+ "type": "string",
+ "readOnly": true
+ },
+ "latestInvoiceId": {
+ "description": "The ID of the latest invoice generated when an Enterprise Agreement invoice is rebilled.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
"Document": {
"description": "The properties of a document.",
"properties": {
@@ -6424,6 +6497,14 @@
"description": "Document URL.",
"type": "string",
"readOnly": true
+ },
+ "documentNumbers": {
+ "description": "Document numbers for an Enterprise Agreement invoice.",
+ "type": "array",
+ "readOnly": true,
+ "items": {
+ "type": "string"
+ }
}
}
},
diff --git a/specification/billing/resource-manager/Microsoft.Billing/preview/2019-10-01-preview/examples/BillingAccountInvoice.json b/specification/billing/resource-manager/Microsoft.Billing/preview/2019-10-01-preview/examples/BillingAccountInvoice.json
new file mode 100644
index 000000000000..f79c4ce4b71e
--- /dev/null
+++ b/specification/billing/resource-manager/Microsoft.Billing/preview/2019-10-01-preview/examples/BillingAccountInvoice.json
@@ -0,0 +1,81 @@
+{
+ "parameters": {
+ "api-version": "2020-05-01",
+ "billingAccountName": "{billingAccountName}",
+ "invoiceName": "{invoiceName}"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoices/{invoiceName}",
+ "name": "{invoiceName}",
+ "type": "Microsoft.Billing/billingAccounts/invoices",
+ "properties": {
+ "dueDate": "2018-01-16T17:32:28Z",
+ "invoiceDate": "2018-01-01T17:32:28Z",
+ "status": "Due",
+ "amountDue": {
+ "currency": "USD",
+ "value": 16.53
+ },
+ "billedAmount": {
+ "currency": "USD",
+ "value": 33.99
+ },
+ "azurePrepaymentApplied": {
+ "currency": "USD",
+ "value": 15.46
+ },
+ "creditAmount": {
+ "currency": "USD",
+ "value": 2.00
+ },
+ "freeAzureCreditApplied": {
+ "currency": "USD",
+ "value": 0.00
+ },
+ "subTotal": {
+ "currency": "USD",
+ "value": 33.99
+ },
+ "taxAmount": {
+ "currency": "USD",
+ "value": 0.00
+ },
+ "totalAmount": {
+ "currency": "USD",
+ "value": 16.53
+ },
+ "invoicePeriodStartDate": "2018-01-01T17:32:28Z",
+ "invoicePeriodEndDate": "2018-01-15T17:32:28Z",
+ "isMonthlyInvoice": false,
+ "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}",
+ "billingProfileDisplayName": "Contoso Operations Billing",
+ "purchaseOrderNumber": "123456",
+ "documents": [
+ {
+ "kind": "Invoice",
+ "url": "https://microsoft.com/invoice.pdf"
+ },
+ {
+ "kind": "TaxReceipt",
+ "url": "https://microsoft.com/taxDoc.pdf"
+ }
+ ],
+ "payments": [
+ {
+ "date": "2018-01-14T17:32:28Z",
+ "paymentType": "credited",
+ "amount": {
+ "currency": "USD",
+ "value": 2.00
+ },
+ "paymentMethodFamily": "CreditCard",
+ "paymentMethodType": "visa"
+ }
+ ]
+ }
+ }
+ }
+ }
+}
diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/billing.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/billing.json
new file mode 100644
index 000000000000..873581679036
--- /dev/null
+++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/billing.json
@@ -0,0 +1,6092 @@
+{
+ "swagger": "2.0",
+ "info": {
+ "version": "2020-05-01",
+ "title": "BillingManagementClient",
+ "description": "Billing client provides access to billing resources for Azure subscriptions."
+ },
+ "host": "management.azure.com",
+ "schemes": [
+ "https"
+ ],
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "paths": {
+ "/providers/Microsoft.Billing/billingAccounts": {
+ "get": {
+ "tags": [
+ "BillingAccounts"
+ ],
+ "x-ms-examples": {
+ "BillingAccountsList": {
+ "$ref": "./examples/BillingAccountsList.json"
+ },
+ "BillingAccountsListWithExpand": {
+ "$ref": "./examples/BillingAccountsListWithExpand.json"
+ },
+ "BillingAccountsListWithExpandForEnrollmentDetails": {
+ "$ref": "./examples/BillingAccountsListWithExpandForEnrollmentDetails.json"
+ }
+ },
+ "operationId": "BillingAccounts_List",
+ "description": "Lists the billing accounts that a user has access to.",
+ "externalDocs": {
+ "url": "https://docs.microsoft.com/en-us/rest/api/billing/"
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ },
+ {
+ "name": "$expand",
+ "description": "May be used to expand the soldTo, invoice sections and billing profiles.",
+ "in": "query",
+ "required": false,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK. The request has succeeded.",
+ "schema": {
+ "$ref": "#/definitions/BillingAccountListResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}": {
+ "get": {
+ "tags": [
+ "BillingAccounts"
+ ],
+ "x-ms-examples": {
+ "BillingAccounts": {
+ "$ref": "./examples/BillingAccount.json"
+ },
+ "BillingAccountWithExpand": {
+ "$ref": "./examples/BillingAccountWithExpand.json"
+ }
+ },
+ "operationId": "BillingAccounts_Get",
+ "description": "Gets a billing account by its ID.",
+ "externalDocs": {
+ "url": "https://docs.microsoft.com/en-us/rest/api/billing/"
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/billingAccountNameParameter"
+ },
+ {
+ "name": "$expand",
+ "description": "May be used to expand the soldTo, invoice sections and billing profiles.",
+ "in": "query",
+ "required": false,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK. The request has succeeded.",
+ "schema": {
+ "$ref": "#/definitions/BillingAccount"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ }
+ },
+ "patch": {
+ "tags": [
+ "BillingAccounts"
+ ],
+ "operationId": "BillingAccounts_Update",
+ "x-ms-long-running-operation": true,
+ "x-ms-long-running-operation-options": {
+ "final-state-via": "azure-async-operation"
+ },
+ "description": "Updates the properties of a billing account. Currently, displayName and address can be updated. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.",
+ "x-ms-examples": {
+ "UpdateBillingAccount": {
+ "$ref": "./examples/UpdateBillingAccount.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/billingAccountNameParameter"
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/BillingAccountUpdateRequest"
+ },
+ "description": "Request parameters that are provided to the update billing account operation."
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK. The request has succeeded.",
+ "schema": {
+ "$ref": "#/definitions/BillingAccount"
+ }
+ },
+ "202": {
+ "description": "Accepted. Billing account update is in progress."
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/listInvoiceSectionsWithCreateSubscriptionPermission": {
+ "post": {
+ "tags": [
+ "BillingAccounts"
+ ],
+ "x-ms-examples": {
+ "InvoiceSectionsListWithCreateSubPermission": {
+ "$ref": "./examples/InvoiceSectionsListWithCreateSubPermission.json"
+ }
+ },
+ "operationId": "BillingAccounts_ListInvoiceSectionsByCreateSubscriptionPermission",
+ "description": "Lists the invoice sections for which the user has permission to create Azure subscriptions. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.",
+ "externalDocs": {
+ "url": "https://docs.microsoft.com/en-us/rest/api/billing/"
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/billingAccountNameParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK. The request has succeeded.",
+ "schema": {
+ "$ref": "#/definitions/InvoiceSectionListWithCreateSubPermissionResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/providers/Microsoft.Billing/validateAddress": {
+ "post": {
+ "tags": [
+ "Address"
+ ],
+ "x-ms-examples": {
+ "AddressValid": {
+ "$ref": "./examples/AddressValid.json"
+ },
+ "AddressInvalid": {
+ "$ref": "./examples/AddressInvalid.json"
+ }
+ },
+ "operationId": "Address_Validate",
+ "description": "Validates an address. Use the operation to validate an address before using it as soldTo or a billTo address.",
+ "externalDocs": {
+ "url": "https://docs.microsoft.com/en-us/rest/api/billing/"
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ },
+ {
+ "name": "address",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/AddressDetails"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK. The request has succeeded.",
+ "schema": {
+ "$ref": "#/definitions/ValidateAddressResponse"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/availableBalance/default": {
+ "get": {
+ "tags": [
+ "AvailableBalances"
+ ],
+ "operationId": "AvailableBalances_Get",
+ "description": "The available credit balance for a billing profile. This is the balance that can be used for pay now to settle due or past due invoices. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.",
+ "externalDocs": {
+ "url": "https://docs.microsoft.com/en-us/rest/api/billing/"
+ },
+ "x-ms-examples": {
+ "AvailableBalanceByBillingProfile": {
+ "$ref": "./examples/AvailableBalanceByBillingProfile.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/billingAccountNameParameter"
+ },
+ {
+ "$ref": "#/parameters/billingProfileNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK. The request has succeeded.",
+ "schema": {
+ "$ref": "#/definitions/AvailableBalance"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/instructions": {
+ "get": {
+ "tags": [
+ "Instructions"
+ ],
+ "operationId": "Instructions_ListByBillingProfile",
+ "description": "Lists the instructions by billing profile id.",
+ "externalDocs": {
+ "url": "https://docs.microsoft.com/en-us/rest/api/billing/"
+ },
+ "x-ms-examples": {
+ "InstructionsListByBillingProfile": {
+ "$ref": "./examples/InstructionsListByBillingProfile.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/billingAccountNameParameter"
+ },
+ {
+ "$ref": "#/parameters/billingProfileNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK. The request has succeeded.",
+ "schema": {
+ "$ref": "#/definitions/InstructionListResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/instructions/{instructionName}": {
+ "get": {
+ "tags": [
+ "Instructions"
+ ],
+ "x-ms-examples": {
+ "Instruction": {
+ "$ref": "./examples/Instruction.json"
+ }
+ },
+ "operationId": "Instructions_Get",
+ "description": "Get the instruction by name. These are custom billing instructions and are only applicable for certain customers.",
+ "externalDocs": {
+ "url": "https://docs.microsoft.com/en-us/rest/api/billing/"
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/billingAccountNameParameter"
+ },
+ {
+ "$ref": "#/parameters/billingProfileNameParameter"
+ },
+ {
+ "$ref": "#/parameters/instructionNameParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK. The request has succeeded.",
+ "schema": {
+ "$ref": "#/definitions/Instruction"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "Instructions"
+ ],
+ "operationId": "Instructions_Put",
+ "description": "Creates or updates an instruction. These are custom billing instructions and are only applicable for certain customers.",
+ "x-ms-examples": {
+ "PutInstruction": {
+ "$ref": "./examples/PutInstruction.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/billingAccountNameParameter"
+ },
+ {
+ "$ref": "#/parameters/billingProfileNameParameter"
+ },
+ {
+ "$ref": "#/parameters/instructionNameParameter"
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/Instruction"
+ },
+ "description": "The new instruction."
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK. The request has succeeded.",
+ "schema": {
+ "$ref": "#/definitions/Instruction"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles": {
+ "get": {
+ "tags": [
+ "BillingProfiles"
+ ],
+ "x-ms-examples": {
+ "BillingProfilesListByBillingAccount": {
+ "$ref": "./examples/BillingProfilesListByBillingAccount.json"
+ },
+ "BillingProfilesListWithExpand": {
+ "$ref": "./examples/BillingProfilesListWithExpand.json"
+ }
+ },
+ "operationId": "BillingProfiles_ListByBillingAccount",
+ "description": "Lists the billing profiles that a user has access to. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement or Microsoft Partner Agreement.",
+ "externalDocs": {
+ "url": "https://docs.microsoft.com/en-us/rest/api/billing/"
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/billingAccountNameParameter"
+ },
+ {
+ "name": "$expand",
+ "description": "May be used to expand the invoice sections.",
+ "in": "query",
+ "required": false,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK. The request has succeeded.",
+ "schema": {
+ "$ref": "#/definitions/BillingProfileListResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}": {
+ "get": {
+ "tags": [
+ "BillingProfiles"
+ ],
+ "x-ms-examples": {
+ "BillingProfile": {
+ "$ref": "./examples/BillingProfile.json"
+ },
+ "BillingProfileWithExpand": {
+ "$ref": "./examples/BillingProfileWithExpand.json"
+ }
+ },
+ "operationId": "BillingProfiles_Get",
+ "description": "Gets a billing profile by its ID. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement or Microsoft Partner Agreement.",
+ "externalDocs": {
+ "url": "https://docs.microsoft.com/en-us/rest/api/billing/"
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/billingAccountNameParameter"
+ },
+ {
+ "$ref": "#/parameters/billingProfileNameParameter"
+ },
+ {
+ "name": "$expand",
+ "description": "May be used to expand the invoice sections.",
+ "in": "query",
+ "required": false,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK. The request has succeeded.",
+ "schema": {
+ "$ref": "#/definitions/BillingProfile"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "BillingProfiles"
+ ],
+ "operationId": "BillingProfiles_CreateOrUpdate",
+ "x-ms-long-running-operation": true,
+ "description": "Creates or updates a billing profile. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement or Microsoft Partner Agreement.",
+ "x-ms-examples": {
+ "CreateBillingProfile": {
+ "$ref": "./examples/PutBillingProfile.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/billingAccountNameParameter"
+ },
+ {
+ "$ref": "#/parameters/billingProfileNameParameter"
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/BillingProfile"
+ },
+ "description": "The new or updated billing profile."
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK. The request has succeeded.",
+ "schema": {
+ "$ref": "#/definitions/BillingProfile"
+ }
+ },
+ "202": {
+ "description": "Accepted",
+ "headers": {
+ "Location": {
+ "description": "Location URI to poll for result",
+ "type": "string"
+ },
+ "Retry-After": {
+ "description": "Recommended time to wait before making another request to check the status of the operation. The time is specified in seconds.",
+ "type": "integer"
+ }
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/customers": {
+ "get": {
+ "tags": [
+ "Customers"
+ ],
+ "x-ms-examples": {
+ "CustomersListByBillingAccount": {
+ "$ref": "./examples/CustomersListByBillingProfile.json"
+ }
+ },
+ "operationId": "Customers_ListByBillingProfile",
+ "description": "Lists the customers that are billed to a billing profile. The operation is supported only for billing accounts with agreement type Microsoft Partner Agreement.",
+ "externalDocs": {
+ "url": "https://docs.microsoft.com/en-us/rest/api/billing/"
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/billingAccountNameParameter"
+ },
+ {
+ "$ref": "#/parameters/billingProfileNameParameter"
+ },
+ {
+ "name": "$search",
+ "description": "Used for searching customers by their name. Any customer with name containing the search text will be included in the response",
+ "in": "query",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "name": "$filter",
+ "description": "May be used to filter the list of customers.",
+ "in": "query",
+ "required": false,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK. The request has succeeded.",
+ "schema": {
+ "$ref": "#/definitions/CustomerListResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections": {
+ "get": {
+ "tags": [
+ "InvoiceSections"
+ ],
+ "x-ms-examples": {
+ "InvoiceSectionsListByBillingProfile": {
+ "$ref": "./examples/InvoiceSectionsListByBillingProfile.json"
+ }
+ },
+ "operationId": "InvoiceSections_ListByBillingProfile",
+ "description": "Lists the invoice sections that a user has access to. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.",
+ "externalDocs": {
+ "url": "https://docs.microsoft.com/en-us/rest/api/billing/"
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/billingAccountNameParameter"
+ },
+ {
+ "$ref": "#/parameters/billingProfileNameParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK. The request has succeeded.",
+ "schema": {
+ "$ref": "#/definitions/InvoiceSectionListResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}": {
+ "get": {
+ "tags": [
+ "InvoiceSections"
+ ],
+ "x-ms-examples": {
+ "InvoiceSection": {
+ "$ref": "./examples/InvoiceSection.json"
+ }
+ },
+ "operationId": "InvoiceSections_Get",
+ "description": "Gets an invoice section by its ID. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.",
+ "externalDocs": {
+ "url": "https://docs.microsoft.com/en-us/rest/api/billing/"
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/billingAccountNameParameter"
+ },
+ {
+ "$ref": "#/parameters/billingProfileNameParameter"
+ },
+ {
+ "$ref": "#/parameters/invoiceSectionNameParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK. The request has succeeded.",
+ "schema": {
+ "$ref": "#/definitions/InvoiceSection"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "InvoiceSections"
+ ],
+ "operationId": "InvoiceSections_CreateOrUpdate",
+ "x-ms-long-running-operation": true,
+ "description": "Creates or updates an invoice section. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.",
+ "x-ms-examples": {
+ "PutInvoiceSection": {
+ "$ref": "./examples/PutInvoiceSection.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/billingAccountNameParameter"
+ },
+ {
+ "$ref": "#/parameters/billingProfileNameParameter"
+ },
+ {
+ "$ref": "#/parameters/invoiceSectionNameParameter"
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/InvoiceSection"
+ },
+ "description": "The new or updated invoice section."
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK. The request has succeeded.",
+ "schema": {
+ "$ref": "#/definitions/InvoiceSection"
+ }
+ },
+ "202": {
+ "description": "Accepted",
+ "headers": {
+ "Location": {
+ "description": "Location URI to poll for result",
+ "type": "string"
+ },
+ "Retry-After": {
+ "description": "Recommended time to wait before making another request to check the status of the operation. The time is specified in seconds.",
+ "type": "integer"
+ }
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/customers": {
+ "get": {
+ "tags": [
+ "Customers"
+ ],
+ "x-ms-examples": {
+ "CustomersListByBillingAccount": {
+ "$ref": "./examples/CustomersListByBillingAccount.json"
+ }
+ },
+ "operationId": "Customers_ListByBillingAccount",
+ "description": "Lists the customers that are billed to a billing account. The operation is supported only for billing accounts with agreement type Microsoft Partner Agreement.",
+ "externalDocs": {
+ "url": "https://docs.microsoft.com/en-us/rest/api/billing/"
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/billingAccountNameParameter"
+ },
+ {
+ "name": "$search",
+ "description": "Used for searching customers by their name. Any customer with name containing the search text will be included in the response",
+ "in": "query",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "name": "$filter",
+ "description": "May be used to filter the list of customers.",
+ "in": "query",
+ "required": false,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK. The request has succeeded.",
+ "schema": {
+ "$ref": "#/definitions/CustomerListResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/customers/{customerName}": {
+ "get": {
+ "tags": [
+ "Customers"
+ ],
+ "x-ms-examples": {
+ "Customer": {
+ "$ref": "./examples/Customer.json"
+ },
+ "CustomerWithExpand": {
+ "$ref": "./examples/CustomerWithExpand.json"
+ }
+ },
+ "operationId": "Customers_Get",
+ "description": "Gets a customer by its ID. The operation is supported only for billing accounts with agreement type Microsoft Partner Agreement.",
+ "externalDocs": {
+ "url": "https://docs.microsoft.com/en-us/rest/api/billing/"
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/billingAccountNameParameter"
+ },
+ {
+ "$ref": "#/parameters/customerNameParameter"
+ },
+ {
+ "name": "$expand",
+ "description": "May be used to expand enabledAzurePlans and resellers",
+ "in": "query",
+ "required": false,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK. The request has succeeded.",
+ "schema": {
+ "$ref": "#/definitions/Customer"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/customers/{customerName}/billingPermissions": {
+ "get": {
+ "tags": [
+ "BillingPermissions"
+ ],
+ "x-ms-examples": {
+ "BillingProfilePermissionsList": {
+ "$ref": "./examples/CustomerPermissionsList.json"
+ }
+ },
+ "operationId": "BillingPermissions_ListByCustomer",
+ "description": "Lists the billing permissions the caller has for a customer.",
+ "externalDocs": {
+ "url": "https://docs.microsoft.com/en-us/rest/api/billing/"
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/billingAccountNameParameter"
+ },
+ {
+ "$ref": "#/parameters/customerNameParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK. The request has succeeded.",
+ "schema": {
+ "$ref": "#/definitions/BillingPermissionsListResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/customers/{customerName}/billingSubscriptions": {
+ "get": {
+ "tags": [
+ "BillingSubscriptions"
+ ],
+ "operationId": "BillingSubscriptions_ListByCustomer",
+ "description": "Lists the subscriptions for a customer. The operation is supported only for billing accounts with agreement type Microsoft Partner Agreement.",
+ "externalDocs": {
+ "url": "https://docs.microsoft.com/en-us/rest/api/billing/"
+ },
+ "x-ms-examples": {
+ "BillingSubscriptionsListByCustomer": {
+ "$ref": "./examples/BillingSubscriptionsListByCustomer.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/billingAccountNameParameter"
+ },
+ {
+ "$ref": "#/parameters/customerNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK. The request has succeeded.",
+ "schema": {
+ "$ref": "#/definitions/BillingSubscriptionsListResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/customers/{customerName}/products": {
+ "get": {
+ "tags": [
+ "Products"
+ ],
+ "operationId": "Products_ListByCustomer",
+ "description": "Lists the products for a customer. These don't include products billed based on usage.The operation is supported only for billing accounts with agreement type Microsoft Partner Agreement.",
+ "externalDocs": {
+ "url": "https://docs.microsoft.com/en-us/rest/api/billing/"
+ },
+ "x-ms-examples": {
+ "ProductsListByInvoiceSection": {
+ "$ref": "./examples/ProductsListByCustomer.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/billingAccountNameParameter"
+ },
+ {
+ "$ref": "#/parameters/customerNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK. The request has succeeded.",
+ "schema": {
+ "$ref": "#/definitions/ProductsListResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoices": {
+ "get": {
+ "tags": [
+ "Invoices"
+ ],
+ "x-ms-examples": {
+ "BillingAccountInvoicesList": {
+ "$ref": "./examples/BillingAccountInvoicesList.json"
+ }
+ },
+ "operationId": "Invoices_ListByBillingAccount",
+ "description": "Lists the invoices for a billing account for a given start date and end date. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.",
+ "externalDocs": {
+ "url": "https://docs.microsoft.com/en-us/rest/api/billing/"
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/billingAccountNameParameter"
+ },
+ {
+ "name": "periodStartDate",
+ "description": "The start date to fetch the invoices. The date should be specified in MM-DD-YYYY format.",
+ "in": "query",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "periodEndDate",
+ "description": "The end date to fetch the invoices. The date should be specified in MM-DD-YYYY format.",
+ "in": "query",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK. The request has succeeded.",
+ "schema": {
+ "$ref": "#/definitions/InvoiceListResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoices": {
+ "get": {
+ "tags": [
+ "Invoices"
+ ],
+ "x-ms-examples": {
+ "InvoicesListByBillingProfile": {
+ "$ref": "./examples/InvoicesListByBillingProfile.json"
+ }
+ },
+ "operationId": "Invoices_ListByBillingProfile",
+ "description": "Lists the invoices for a billing profile for a given start date and end date. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.",
+ "externalDocs": {
+ "url": "https://docs.microsoft.com/en-us/rest/api/billing/"
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/billingAccountNameParameter"
+ },
+ {
+ "$ref": "#/parameters/billingProfileNameParameter"
+ },
+ {
+ "name": "periodStartDate",
+ "description": "The start date to fetch the invoices. The date should be specified in MM-DD-YYYY format.",
+ "in": "query",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "periodEndDate",
+ "description": "The end date to fetch the invoices. The date should be specified in MM-DD-YYYY format.",
+ "in": "query",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK. The request has succeeded.",
+ "schema": {
+ "$ref": "#/definitions/InvoiceListResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoices/{invoiceName}": {
+ "get": {
+ "tags": [
+ "Invoices"
+ ],
+ "x-ms-examples": {
+ "Invoice": {
+ "$ref": "./examples/Invoice.json"
+ }
+ },
+ "operationId": "Invoices_Get",
+ "description": "Gets an invoice by billing account name and ID. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.",
+ "externalDocs": {
+ "url": "https://docs.microsoft.com/en-us/rest/api/billing/"
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/billingAccountNameParameter"
+ },
+ {
+ "$ref": "#/parameters/invoiceNameParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK. The request has succeeded.",
+ "schema": {
+ "$ref": "#/definitions/Invoice"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/providers/Microsoft.Billing/billingAccounts/default/invoices/{invoiceName}": {
+ "get": {
+ "tags": [
+ "Invoices"
+ ],
+ "x-ms-examples": {
+ "Invoice": {
+ "$ref": "./examples/InvoiceById.json"
+ }
+ },
+ "operationId": "Invoices_GetById",
+ "description": "Gets an invoice by ID. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.",
+ "externalDocs": {
+ "url": "https://docs.microsoft.com/en-us/rest/api/billing/"
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/invoiceNameParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK. The request has succeeded.",
+ "schema": {
+ "$ref": "#/definitions/Invoice"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoices/{invoiceName}/download": {
+ "post": {
+ "tags": [
+ "Invoices"
+ ],
+ "x-ms-examples": {
+ "InvoiceDownload": {
+ "$ref": "./examples/InvoiceDownload.json"
+ }
+ },
+ "operationId": "Invoices_DownloadInvoice",
+ "x-ms-long-running-operation": true,
+ "x-ms-long-running-operation-options": {
+ "final-state-via": "location"
+ },
+ "description": "Gets a URL to download an invoice. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.",
+ "externalDocs": {
+ "url": "https://docs.microsoft.com/en-us/rest/api/billing/"
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/billingAccountNameParameter"
+ },
+ {
+ "$ref": "#/parameters/invoiceNameParameter"
+ },
+ {
+ "name": "downloadToken",
+ "description": "Download token with document source and document ID.",
+ "in": "query",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "202": {
+ "description": "Accepted.",
+ "headers": {
+ "Location": {
+ "description": "GET this URL to retrieve the status of the asynchronous operation.",
+ "type": "string"
+ },
+ "Retry-After": {
+ "description": "The amount of delay to use while the status of the operation is checked. The value is expressed in seconds.",
+ "type": "string"
+ }
+ }
+ },
+ "200": {
+ "description": "OK. The request has succeeded.",
+ "schema": {
+ "$ref": "#/definitions/DownloadUrl"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingSubscriptions": {
+ "get": {
+ "tags": [
+ "BillingSubscriptions"
+ ],
+ "operationId": "BillingSubscriptions_ListByBillingAccount",
+ "description": "Lists the subscriptions for a billing account. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement or Microsoft Partner Agreement.",
+ "externalDocs": {
+ "url": "https://docs.microsoft.com/en-us/rest/api/billing/"
+ },
+ "x-ms-examples": {
+ "BillingSubscriptionsListByBillingAccount": {
+ "$ref": "./examples/BillingSubscriptionsListByBillingAccount.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/billingAccountNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK. The request has succeeded.",
+ "schema": {
+ "$ref": "#/definitions/BillingSubscriptionsListResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/providers/Microsoft.Billing/billingAccounts/default/billingSubscriptions/{subscriptionId}/invoices": {
+ "get": {
+ "tags": [
+ "Invoices"
+ ],
+ "operationId": "Invoices_ListByBillingSubscription",
+ "description": "Lists the invoices for a subscription.",
+ "externalDocs": {
+ "url": "https://docs.microsoft.com/en-us/rest/api/billing/"
+ },
+ "x-ms-examples": {
+ "BillingSubscriptionsListByBillingAccount": {
+ "$ref": "./examples/BillingSubscriptionInvoicesList.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "name": "periodStartDate",
+ "description": "Invoice period start date.",
+ "in": "query",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "periodEndDate",
+ "description": "Invoice period end date.",
+ "in": "query",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK. The request has succeeded.",
+ "schema": {
+ "$ref": "#/definitions/InvoiceListResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/providers/Microsoft.Billing/billingAccounts/default/billingSubscriptions/{subscriptionId}/invoices/{invoiceName}": {
+ "get": {
+ "tags": [
+ "Invoices"
+ ],
+ "operationId": "Invoices_GetBySubscriptionAndInvoiceId",
+ "description": "Gets an invoice by subscription ID and invoice ID.",
+ "externalDocs": {
+ "url": "https://docs.microsoft.com/en-us/rest/api/billing/"
+ },
+ "x-ms-examples": {
+ "BillingSubscriptionsListByBillingAccount": {
+ "$ref": "./examples/BillingSubscriptionInvoice.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/invoiceNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK. The request has succeeded.",
+ "schema": {
+ "$ref": "#/definitions/Invoice"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/providers/Microsoft.Billing/billingAccounts/default/billingSubscriptions/{subscriptionId}/invoices/{invoiceName}/download": {
+ "post": {
+ "tags": [
+ "Invoices"
+ ],
+ "x-ms-examples": {
+ "BillingSubscriptionInvoiceDownload": {
+ "$ref": "./examples/BillingSubscriptionInvoiceDownload.json"
+ }
+ },
+ "operationId": "Invoices_DownloadBillingSubscriptionInvoice",
+ "x-ms-long-running-operation": true,
+ "x-ms-long-running-operation-options": {
+ "final-state-via": "location"
+ },
+ "description": "Gets a URL to download an invoice.",
+ "externalDocs": {
+ "url": "https://docs.microsoft.com/en-us/rest/api/billing/"
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/invoiceNameParameter"
+ },
+ {
+ "name": "downloadToken",
+ "description": "Download token with document source and document ID.",
+ "in": "query",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "202": {
+ "description": "Accepted.",
+ "headers": {
+ "Location": {
+ "description": "GET this URL to retrieve the status of the asynchronous operation.",
+ "type": "string"
+ },
+ "Retry-After": {
+ "description": "The amount of delay to use while the status of the operation is checked. The value is expressed in seconds.",
+ "type": "string"
+ }
+ }
+ },
+ "200": {
+ "description": "OK. The request has succeeded.",
+ "schema": {
+ "$ref": "#/definitions/DownloadUrl"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/billingSubscriptions": {
+ "get": {
+ "tags": [
+ "BillingSubscriptions"
+ ],
+ "operationId": "BillingSubscriptions_ListByBillingProfile",
+ "description": "Lists the subscriptions that are billed to a billing profile. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement or Microsoft Partner Agreement.",
+ "externalDocs": {
+ "url": "https://docs.microsoft.com/en-us/rest/api/billing/"
+ },
+ "x-ms-examples": {
+ "BillingSubscriptionsListByBillingProfile": {
+ "$ref": "./examples/BillingSubscriptionsListByBillingProfile.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/billingAccountNameParameter"
+ },
+ {
+ "$ref": "#/parameters/billingProfileNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK. The request has succeeded.",
+ "schema": {
+ "$ref": "#/definitions/BillingSubscriptionsListResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/billingSubscriptions": {
+ "get": {
+ "tags": [
+ "BillingSubscriptions"
+ ],
+ "operationId": "BillingSubscriptions_ListByInvoiceSection",
+ "description": "Lists the subscriptions that are billed to an invoice section. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.",
+ "externalDocs": {
+ "url": "https://docs.microsoft.com/en-us/rest/api/billing/"
+ },
+ "x-ms-examples": {
+ "BillingSubscriptionsListByInvoiceSection": {
+ "$ref": "./examples/BillingSubscriptionsListByInvoiceSection.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/billingAccountNameParameter"
+ },
+ {
+ "$ref": "#/parameters/billingProfileNameParameter"
+ },
+ {
+ "$ref": "#/parameters/invoiceSectionNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK. The request has succeeded.",
+ "schema": {
+ "$ref": "#/definitions/BillingSubscriptionsListResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingSubscriptions/{subscriptionId}": {
+ "get": {
+ "tags": [
+ "BillingSubscriptions"
+ ],
+ "operationId": "BillingSubscriptions_Get",
+ "description": "Gets a subscription by its ID. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement and Microsoft Partner Agreement.",
+ "externalDocs": {
+ "url": "https://docs.microsoft.com/en-us/rest/api/billing/"
+ },
+ "x-ms-examples": {
+ "BillingSubscription": {
+ "$ref": "./examples/BillingSubscription.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/billingAccountNameParameter"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK. The request has succeeded.",
+ "schema": {
+ "$ref": "#/definitions/BillingSubscription"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ }
+ },
+ "patch": {
+ "tags": [
+ "BillingSubscriptions"
+ ],
+ "operationId": "BillingSubscriptions_Update",
+ "description": "Updates the properties of a billing subscription. Currently, cost center can be updated. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.",
+ "x-ms-examples": {
+ "UpdateBillingProperty": {
+ "$ref": "./examples/UpdateBillingSubscription.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/billingAccountNameParameter"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/BillingSubscription"
+ },
+ "description": "Request parameters that are provided to the update billing subscription operation."
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK. The request has succeeded.",
+ "schema": {
+ "$ref": "#/definitions/BillingSubscription"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingSubscriptions/{subscriptionId}/move": {
+ "post": {
+ "description": "Moves a subscription's charges to a new invoice section. The new invoice section must belong to the same billing profile as the existing invoice section. This operation is supported for billing accounts with agreement type Microsoft Customer Agreement.",
+ "externalDocs": {
+ "url": "https://docs.microsoft.com/en-us/rest/api/billing/"
+ },
+ "operationId": "BillingSubscriptions_Move",
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "MoveBillingSubscription": {
+ "$ref": "./examples/MoveBillingSubscription.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/billingAccountNameParameter"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/TransferBillingSubscriptionRequestProperties"
+ },
+ "description": "Request parameters that are provided to the move subscription operation."
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK. The request has succeeded.",
+ "schema": {
+ "$ref": "#/definitions/BillingSubscription"
+ }
+ },
+ "202": {
+ "description": "Accepted. Billing Subscription transfer is in progress.",
+ "headers": {
+ "Location": {
+ "description": "Location URI to poll for result.",
+ "type": "string"
+ },
+ "Retry-After": {
+ "description": "Recommended time to wait before making another request to check the status of the operation. The time is specified in seconds.",
+ "type": "integer"
+ }
+ }
+ },
+ "default": {
+ "description": "Unexpected error.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingSubscriptions/{subscriptionId}/validateMoveEligibility": {
+ "post": {
+ "x-ms-examples": {
+ "SubscriptionMoveValidateSuccess": {
+ "$ref": "./examples/ValidateSubscriptionMoveSuccess.json"
+ },
+ "SubscriptionMoveValidateFailure": {
+ "$ref": "./examples/ValidateSubscriptionMoveFailure.json"
+ }
+ },
+ "operationId": "BillingSubscriptions_ValidateMove",
+ "description": "Validates if a subscription's charges can be moved to a new invoice section. This operation is supported for billing accounts with agreement type Microsoft Customer Agreement.",
+ "externalDocs": {
+ "url": "https://docs.microsoft.com/en-us/rest/api/billing/"
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/billingAccountNameParameter"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/TransferBillingSubscriptionRequestProperties"
+ },
+ "description": "Request parameters that are provided to the validate move eligibility operation."
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK. The request has succeeded.",
+ "schema": {
+ "$ref": "#/definitions/ValidateSubscriptionTransferEligibilityResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/products": {
+ "get": {
+ "tags": [
+ "Products"
+ ],
+ "operationId": "Products_ListByBillingAccount",
+ "description": "Lists the products for a billing account. These don't include products billed based on usage. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement or Microsoft Partner Agreement.",
+ "externalDocs": {
+ "url": "https://docs.microsoft.com/en-us/rest/api/billing/"
+ },
+ "x-ms-examples": {
+ "ProductsListByBillingAccount": {
+ "$ref": "./examples/ProductsListByBillingAccount.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/billingAccountNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ },
+ {
+ "name": "$filter",
+ "description": "May be used to filter by product type. The filter supports 'eq', 'lt', 'gt', 'le', 'ge', and 'and'. It does not currently support 'ne', 'or', or 'not'. Tag filter is a key value pair string where key and value are separated by a colon (:).",
+ "in": "query",
+ "required": false,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK. The request has succeeded.",
+ "schema": {
+ "$ref": "#/definitions/ProductsListResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/products": {
+ "get": {
+ "tags": [
+ "Products"
+ ],
+ "operationId": "Products_ListByBillingProfile",
+ "description": "Lists the products for a billing profile. These don't include products billed based on usage. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement or Microsoft Partner Agreement.",
+ "externalDocs": {
+ "url": "https://docs.microsoft.com/en-us/rest/api/billing/"
+ },
+ "x-ms-examples": {
+ "ProductsListByBillingProfile": {
+ "$ref": "./examples/ProductsListByBillingProfile.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/billingAccountNameParameter"
+ },
+ {
+ "$ref": "#/parameters/billingProfileNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ },
+ {
+ "name": "$filter",
+ "description": "May be used to filter by product type. The filter supports 'eq', 'lt', 'gt', 'le', 'ge', and 'and'. It does not currently support 'ne', 'or', or 'not'. Tag filter is a key value pair string where key and value are separated by a colon (:).",
+ "in": "query",
+ "required": false,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK. The request has succeeded.",
+ "schema": {
+ "$ref": "#/definitions/ProductsListResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/products": {
+ "get": {
+ "tags": [
+ "Products"
+ ],
+ "operationId": "Products_ListByInvoiceSection",
+ "description": "Lists the products for an invoice section. These don't include products billed based on usage. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.",
+ "externalDocs": {
+ "url": "https://docs.microsoft.com/en-us/rest/api/billing/"
+ },
+ "x-ms-examples": {
+ "ProductsListByInvoiceSection": {
+ "$ref": "./examples/ProductsListByInvoiceSection.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/billingAccountNameParameter"
+ },
+ {
+ "$ref": "#/parameters/billingProfileNameParameter"
+ },
+ {
+ "$ref": "#/parameters/invoiceSectionNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ },
+ {
+ "name": "$filter",
+ "description": "May be used to filter by product type. The filter supports 'eq', 'lt', 'gt', 'le', 'ge', and 'and'. It does not currently support 'ne', 'or', or 'not'. Tag filter is a key value pair string where key and value are separated by a colon (:).",
+ "in": "query",
+ "required": false,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK. The request has succeeded.",
+ "schema": {
+ "$ref": "#/definitions/ProductsListResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/products/{productName}": {
+ "get": {
+ "tags": [
+ "Products"
+ ],
+ "operationId": "Products_Get",
+ "description": "Gets a product by ID. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.",
+ "externalDocs": {
+ "url": "https://docs.microsoft.com/en-us/rest/api/billing/"
+ },
+ "x-ms-examples": {
+ "Product": {
+ "$ref": "./examples/Product.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/billingAccountNameParameter"
+ },
+ {
+ "$ref": "#/parameters/productNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK. The request has succeeded.",
+ "schema": {
+ "$ref": "#/definitions/Product"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ }
+ },
+ "patch": {
+ "tags": [
+ "Products"
+ ],
+ "operationId": "Products_Update",
+ "description": "Updates the properties of a Product. Currently, auto renew can be updated. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.",
+ "x-ms-examples": {
+ "UpdateBillingProperty": {
+ "$ref": "./examples/UpdateProduct.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/billingAccountNameParameter"
+ },
+ {
+ "$ref": "#/parameters/productNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/Product"
+ },
+ "description": "Request parameters that are provided to the update product operation."
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK. The request has succeeded.",
+ "schema": {
+ "$ref": "#/definitions/Product"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/products/{productName}/move": {
+ "post": {
+ "tags": [
+ "Products"
+ ],
+ "operationId": "Products_Move",
+ "description": "Moves a product's charges to a new invoice section. The new invoice section must belong to the same billing profile as the existing invoice section. This operation is supported only for products that are purchased with a recurring charge and for billing accounts with agreement type Microsoft Customer Agreement.",
+ "externalDocs": {
+ "url": "https://docs.microsoft.com/en-us/rest/api/billing/"
+ },
+ "x-ms-examples": {
+ "MoveProduct": {
+ "$ref": "./examples/MoveProduct.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/billingAccountNameParameter"
+ },
+ {
+ "$ref": "#/parameters/productNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/TransferProductRequestProperties"
+ },
+ "description": "Request parameters that are provided to the move product operation."
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK. The request has succeeded.",
+ "schema": {
+ "$ref": "#/definitions/Product"
+ }
+ },
+ "202": {
+ "description": "Accepted",
+ "headers": {
+ "Location": {
+ "description": "Location URI to poll for result",
+ "type": "string"
+ },
+ "Retry-After": {
+ "description": "Recommended time to wait before making another request to check the status of the operation. The time is specified in seconds.",
+ "type": "integer"
+ }
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/products/{productName}/validateMoveEligibility": {
+ "post": {
+ "x-ms-examples": {
+ "SubscriptionMoveValidateSuccess": {
+ "$ref": "./examples/ValidateProductMoveSuccess.json"
+ },
+ "SubscriptionMoveValidateFailure": {
+ "$ref": "./examples/ValidateProductMoveFailure.json"
+ }
+ },
+ "operationId": "Products_ValidateMove",
+ "description": "Validates if a product's charges can be moved to a new invoice section. This operation is supported only for products that are purchased with a recurring charge and for billing accounts with agreement type Microsoft Customer Agreement.",
+ "externalDocs": {
+ "url": "https://docs.microsoft.com/en-us/rest/api/billing/"
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/billingAccountNameParameter"
+ },
+ {
+ "$ref": "#/parameters/productNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/TransferProductRequestProperties"
+ },
+ "description": "Request parameters that are provided to the validate move eligibility operation."
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK. The request has succeeded.",
+ "schema": {
+ "$ref": "#/definitions/ValidateProductTransferEligibilityResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoices/{invoiceName}/transactions": {
+ "get": {
+ "tags": [
+ "Transactions"
+ ],
+ "operationId": "Transactions_ListByInvoice",
+ "description": "Lists the transactions for an invoice. Transactions include purchases, refunds and Azure usage charges.",
+ "externalDocs": {
+ "url": "https://docs.microsoft.com/en-us/rest/api/billing/"
+ },
+ "x-ms-examples": {
+ "TransactionsListByInvoice": {
+ "$ref": "./examples/TransactionsListByInvoice.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/billingAccountNameParameter"
+ },
+ {
+ "$ref": "#/parameters/invoiceNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK. The request has succeeded.",
+ "schema": {
+ "$ref": "#/definitions/TransactionListResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/policies/default": {
+ "get": {
+ "tags": [
+ "Policies"
+ ],
+ "operationId": "Policies_GetByBillingProfile",
+ "description": "Lists the policies for a billing profile. This operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.",
+ "externalDocs": {
+ "url": "https://docs.microsoft.com/en-us/rest/api/billing/"
+ },
+ "x-ms-examples": {
+ "PolicyByBillingProfile": {
+ "$ref": "./examples/Policy.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/billingAccountNameParameter"
+ },
+ {
+ "$ref": "#/parameters/billingProfileNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK. The request has succeeded.",
+ "schema": {
+ "$ref": "#/definitions/Policy"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "Policies"
+ ],
+ "operationId": "Policies_Update",
+ "description": "Updates the policies for a billing profile. This operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.",
+ "x-ms-examples": {
+ "UpdatePolicy": {
+ "$ref": "./examples/UpdatePolicy.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/billingAccountNameParameter"
+ },
+ {
+ "$ref": "#/parameters/billingProfileNameParameter"
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/Policy"
+ },
+ "description": "Request parameters that are provided to the update policies operation."
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK. The request has succeeded.",
+ "schema": {
+ "$ref": "#/definitions/Policy"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/customers/{customerName}/policies/default": {
+ "get": {
+ "tags": [
+ "Policies"
+ ],
+ "operationId": "Policies_GetByCustomer",
+ "description": "Lists the policies for a customer. This operation is supported only for billing accounts with agreement type Microsoft Partner Agreement.",
+ "externalDocs": {
+ "url": "https://docs.microsoft.com/en-us/rest/api/billing/"
+ },
+ "x-ms-examples": {
+ "PolicyByCustomer": {
+ "$ref": "./examples/CustomerPolicy.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/billingAccountNameParameter"
+ },
+ {
+ "$ref": "#/parameters/customerNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK. The request has succeeded.",
+ "schema": {
+ "$ref": "#/definitions/CustomerPolicy"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "Policies"
+ ],
+ "operationId": "Policies_UpdateCustomer",
+ "description": "Updates the policies for a customer. This operation is supported only for billing accounts with agreement type Microsoft Partner Agreement.",
+ "x-ms-examples": {
+ "UpdateCustomer": {
+ "$ref": "./examples/UpdateCustomerPolicy.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/billingAccountNameParameter"
+ },
+ {
+ "$ref": "#/parameters/customerNameParameter"
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/CustomerPolicy"
+ },
+ "description": "Request parameters that are provided to the update policies operation."
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK. The request has succeeded.",
+ "schema": {
+ "$ref": "#/definitions/CustomerPolicy"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/providers/Microsoft.Billing/billingProperty/default": {
+ "get": {
+ "tags": [
+ "BillingProperties"
+ ],
+ "operationId": "BillingProperty_Get",
+ "description": "Get the billing properties for a subscription. This operation is not supported for billing accounts with agreement type Enterprise Agreement.",
+ "externalDocs": {
+ "url": "https://docs.microsoft.com/en-us/rest/api/billing/"
+ },
+ "x-ms-examples": {
+ "BillingProperty": {
+ "$ref": "./examples/BillingProperty.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK. The request has succeeded.",
+ "schema": {
+ "$ref": "#/definitions/BillingProperty"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ }
+ },
+ "patch": {
+ "tags": [
+ "BillingProperties"
+ ],
+ "operationId": "BillingProperty_Update",
+ "description": "Updates the billing property of a subscription. Currently, cost center can be updated. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.",
+ "x-ms-examples": {
+ "UpdateBillingProperty": {
+ "$ref": "./examples/UpdateBillingProperty.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/BillingProperty"
+ },
+ "description": "Request parameters that are provided to the update billing property operation."
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK. The request has succeeded.",
+ "schema": {
+ "$ref": "#/definitions/BillingProperty"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/providers/Microsoft.Billing/operations": {
+ "get": {
+ "tags": [
+ "Operations"
+ ],
+ "operationId": "Operations_List",
+ "description": "Lists the available billing REST API operations.",
+ "externalDocs": {
+ "url": "https://docs.microsoft.com/en-us/rest/api/billing/"
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK. The request has succeeded.",
+ "schema": {
+ "$ref": "#/definitions/OperationListResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingPermissions": {
+ "get": {
+ "tags": [
+ "BillingPermissions"
+ ],
+ "x-ms-examples": {
+ "BillingAccountPermissionsList": {
+ "$ref": "./examples/BillingAccountPermissionsList.json"
+ }
+ },
+ "operationId": "BillingPermissions_ListByBillingAccount",
+ "description": "Lists the billing permissions the caller has on a billing account.",
+ "externalDocs": {
+ "url": "https://docs.microsoft.com/en-us/rest/api/billing/"
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/billingAccountNameParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK. The request has succeeded.",
+ "schema": {
+ "$ref": "#/definitions/BillingPermissionsListResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/billingPermissions": {
+ "get": {
+ "tags": [
+ "BillingPermissions"
+ ],
+ "x-ms-examples": {
+ "InvoiceSectionPermissionsList": {
+ "$ref": "./examples/InvoiceSectionPermissionsList.json"
+ }
+ },
+ "operationId": "BillingPermissions_ListByInvoiceSections",
+ "description": "Lists the billing permissions the caller has on an invoice section.",
+ "externalDocs": {
+ "url": "https://docs.microsoft.com/en-us/rest/api/billing/"
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/billingAccountNameParameter"
+ },
+ {
+ "$ref": "#/parameters/billingProfileNameParameter"
+ },
+ {
+ "$ref": "#/parameters/invoiceSectionNameParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK. The request has succeeded.",
+ "schema": {
+ "$ref": "#/definitions/BillingPermissionsListResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/billingPermissions": {
+ "get": {
+ "tags": [
+ "BillingPermissions"
+ ],
+ "x-ms-examples": {
+ "BillingProfilePermissionsList": {
+ "$ref": "./examples/BillingProfilePermissionsList.json"
+ }
+ },
+ "operationId": "BillingPermissions_ListByBillingProfile",
+ "description": "Lists the billing permissions the caller has on a billing profile.",
+ "externalDocs": {
+ "url": "https://docs.microsoft.com/en-us/rest/api/billing/"
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/billingAccountNameParameter"
+ },
+ {
+ "$ref": "#/parameters/billingProfileNameParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK. The request has succeeded.",
+ "schema": {
+ "$ref": "#/definitions/BillingPermissionsListResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingRoleDefinitions/{billingRoleDefinitionName}": {
+ "get": {
+ "tags": [
+ "BillingRoleDefinitions"
+ ],
+ "x-ms-examples": {
+ "BillingAccountRoleDefinition": {
+ "$ref": "./examples/BillingAccountRoleDefinition.json"
+ }
+ },
+ "operationId": "BillingRoleDefinitions_GetByBillingAccount",
+ "description": "Gets the definition for a role on a billing account. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.",
+ "externalDocs": {
+ "url": "https://docs.microsoft.com/en-us/rest/api/billing/"
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/billingAccountNameParameter"
+ },
+ {
+ "$ref": "#/parameters/billingRoleDefinitionNameParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK. The request has succeeded.",
+ "schema": {
+ "$ref": "#/definitions/BillingRoleDefinition"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/billingRoleDefinitions/{billingRoleDefinitionName}": {
+ "get": {
+ "tags": [
+ "BillingRoleDefinitions"
+ ],
+ "x-ms-examples": {
+ "InvoiceSectionRoleDefinition": {
+ "$ref": "./examples/InvoiceSectionRoleDefinition.json"
+ }
+ },
+ "operationId": "BillingRoleDefinitions_GetByInvoiceSection",
+ "description": "Gets the definition for a role on an invoice section. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.",
+ "externalDocs": {
+ "url": "https://docs.microsoft.com/en-us/rest/api/billing/"
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/billingAccountNameParameter"
+ },
+ {
+ "$ref": "#/parameters/billingProfileNameParameter"
+ },
+ {
+ "$ref": "#/parameters/invoiceSectionNameParameter"
+ },
+ {
+ "$ref": "#/parameters/billingRoleDefinitionNameParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK. The request has succeeded.",
+ "schema": {
+ "$ref": "#/definitions/BillingRoleDefinition"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/billingRoleDefinitions/{billingRoleDefinitionName}": {
+ "get": {
+ "tags": [
+ "BillingRoleDefinitions"
+ ],
+ "x-ms-examples": {
+ "BillingProfileRoleDefinition": {
+ "$ref": "./examples/BillingProfileRoleDefinition.json"
+ }
+ },
+ "operationId": "BillingRoleDefinitions_GetByBillingProfile",
+ "description": "Gets the definition for a role on a billing profile. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.",
+ "externalDocs": {
+ "url": "https://docs.microsoft.com/en-us/rest/api/billing/"
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/billingAccountNameParameter"
+ },
+ {
+ "$ref": "#/parameters/billingProfileNameParameter"
+ },
+ {
+ "$ref": "#/parameters/billingRoleDefinitionNameParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK. The request has succeeded.",
+ "schema": {
+ "$ref": "#/definitions/BillingRoleDefinition"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingRoleDefinitions": {
+ "get": {
+ "tags": [
+ "BillingRoleDefinitions"
+ ],
+ "x-ms-examples": {
+ "BillingAccountRoleDefinitionsList": {
+ "$ref": "./examples/BillingAccountRoleDefinitionsList.json"
+ }
+ },
+ "operationId": "BillingRoleDefinitions_ListByBillingAccount",
+ "description": "Lists the role definitions for a billing account. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.",
+ "externalDocs": {
+ "url": "https://docs.microsoft.com/en-us/rest/api/billing/"
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/billingAccountNameParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK. The request has succeeded.",
+ "schema": {
+ "$ref": "#/definitions/BillingRoleDefinitionListResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/billingRoleDefinitions": {
+ "get": {
+ "tags": [
+ "BillingRoleDefinitions"
+ ],
+ "x-ms-examples": {
+ "InvoiceSectionRoleDefinitionsList": {
+ "$ref": "./examples/InvoiceSectionRoleDefinitionsList.json"
+ }
+ },
+ "operationId": "BillingRoleDefinitions_ListByInvoiceSection",
+ "description": "Lists the role definitions for an invoice section. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.",
+ "externalDocs": {
+ "url": "https://docs.microsoft.com/en-us/rest/api/billing/"
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/billingAccountNameParameter"
+ },
+ {
+ "$ref": "#/parameters/billingProfileNameParameter"
+ },
+ {
+ "$ref": "#/parameters/invoiceSectionNameParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK. The request has succeeded.",
+ "schema": {
+ "$ref": "#/definitions/BillingRoleDefinitionListResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/billingRoleDefinitions": {
+ "get": {
+ "tags": [
+ "BillingRoleDefinitions"
+ ],
+ "x-ms-examples": {
+ "BillingProfileRoleDefinitionsList": {
+ "$ref": "./examples/BillingProfileRoleDefinitionsList.json"
+ }
+ },
+ "operationId": "BillingRoleDefinitions_ListByBillingProfile",
+ "description": "Lists the role definitions for a billing profile. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.",
+ "externalDocs": {
+ "url": "https://docs.microsoft.com/en-us/rest/api/billing/"
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/billingAccountNameParameter"
+ },
+ {
+ "$ref": "#/parameters/billingProfileNameParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK. The request has succeeded.",
+ "schema": {
+ "$ref": "#/definitions/BillingRoleDefinitionListResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingRoleAssignments/{billingRoleAssignmentName}": {
+ "get": {
+ "tags": [
+ "BillingRoleAssignments"
+ ],
+ "x-ms-examples": {
+ "BillingAccountRoleAssignment": {
+ "$ref": "./examples/BillingAccountRoleAssignment.json"
+ }
+ },
+ "operationId": "BillingRoleAssignments_GetByBillingAccount",
+ "description": "Gets a role assignment for the caller on a billing account. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.",
+ "externalDocs": {
+ "url": "https://docs.microsoft.com/en-us/rest/api/billing/"
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/billingAccountNameParameter"
+ },
+ {
+ "$ref": "#/parameters/billingRoleAssignmentNameParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK. The request has succeeded.",
+ "schema": {
+ "$ref": "#/definitions/BillingRoleAssignment"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "BillingRoleAssignments"
+ ],
+ "x-ms-examples": {
+ "BillingAccountRoleAssignmentDelete": {
+ "$ref": "./examples/BillingAccountRoleAssignmentDelete.json"
+ }
+ },
+ "operationId": "BillingRoleAssignments_DeleteByBillingAccount",
+ "description": "Deletes a role assignment for the caller on a billing account. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/billingAccountNameParameter"
+ },
+ {
+ "$ref": "#/parameters/billingRoleAssignmentNameParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK. The request has succeeded.",
+ "schema": {
+ "$ref": "#/definitions/BillingRoleAssignment"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/billingRoleAssignments/{billingRoleAssignmentName}": {
+ "get": {
+ "tags": [
+ "BillingRoleAssignments"
+ ],
+ "x-ms-examples": {
+ "InvoiceSectionRoleAssignment": {
+ "$ref": "./examples/InvoiceSectionRoleAssignment.json"
+ }
+ },
+ "operationId": "BillingRoleAssignments_GetByInvoiceSection",
+ "description": "Gets a role assignment for the caller on an invoice section. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement.",
+ "externalDocs": {
+ "url": "https://docs.microsoft.com/en-us/rest/api/billing/"
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/billingAccountNameParameter"
+ },
+ {
+ "$ref": "#/parameters/billingProfileNameParameter"
+ },
+ {
+ "$ref": "#/parameters/invoiceSectionNameParameter"
+ },
+ {
+ "$ref": "#/parameters/billingRoleAssignmentNameParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK. The request has succeeded.",
+ "schema": {
+ "$ref": "#/definitions/BillingRoleAssignment"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "BillingRoleAssignments"
+ ],
+ "x-ms-examples": {
+ "InvoiceSectionRoleAssignmentDelete": {
+ "$ref": "./examples/InvoiceSectionRoleAssignmentDelete.json"
+ }
+ },
+ "operationId": "BillingRoleAssignments_DeleteByInvoiceSection",
+ "description": "Deletes a role assignment for the caller on an invoice section. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/billingAccountNameParameter"
+ },
+ {
+ "$ref": "#/parameters/billingProfileNameParameter"
+ },
+ {
+ "$ref": "#/parameters/invoiceSectionNameParameter"
+ },
+ {
+ "$ref": "#/parameters/billingRoleAssignmentNameParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK. The request has succeeded.",
+ "schema": {
+ "$ref": "#/definitions/BillingRoleAssignment"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/billingRoleAssignments/{billingRoleAssignmentName}": {
+ "get": {
+ "tags": [
+ "BillingRoleAssignments"
+ ],
+ "x-ms-examples": {
+ "BillingProfileRoleAssignment": {
+ "$ref": "./examples/BillingProfileRoleAssignment.json"
+ }
+ },
+ "operationId": "BillingRoleAssignments_GetByBillingProfile",
+ "description": "Gets a role assignment for the caller on a billing profile. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.",
+ "externalDocs": {
+ "url": "https://docs.microsoft.com/en-us/rest/api/billing/"
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/billingAccountNameParameter"
+ },
+ {
+ "$ref": "#/parameters/billingProfileNameParameter"
+ },
+ {
+ "$ref": "#/parameters/billingRoleAssignmentNameParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK. The request has succeeded.",
+ "schema": {
+ "$ref": "#/definitions/BillingRoleAssignment"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "BillingRoleAssignments"
+ ],
+ "x-ms-examples": {
+ "BillingProfileRoleAssignmentDelete": {
+ "$ref": "./examples/BillingProfileRoleAssignmentDelete.json"
+ }
+ },
+ "operationId": "BillingRoleAssignments_DeleteByBillingProfile",
+ "description": "Deletes a role assignment for the caller on a billing profile. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/billingAccountNameParameter"
+ },
+ {
+ "$ref": "#/parameters/billingProfileNameParameter"
+ },
+ {
+ "$ref": "#/parameters/billingRoleAssignmentNameParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK. The request has succeeded.",
+ "schema": {
+ "$ref": "#/definitions/BillingRoleAssignment"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingRoleAssignments": {
+ "get": {
+ "tags": [
+ "BillingRoleAssignments"
+ ],
+ "x-ms-examples": {
+ "BillingAccountRoleAssignmentList": {
+ "$ref": "./examples/BillingAccountRoleAssignmentList.json"
+ }
+ },
+ "operationId": "BillingRoleAssignments_ListByBillingAccount",
+ "description": "Lists the role assignments for the caller on a billing account. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.",
+ "externalDocs": {
+ "url": "https://docs.microsoft.com/en-us/rest/api/billing/"
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/billingAccountNameParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK. The request has succeeded.",
+ "schema": {
+ "$ref": "#/definitions/BillingRoleAssignmentListResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/billingRoleAssignments": {
+ "get": {
+ "tags": [
+ "BillingRoleAssignments"
+ ],
+ "x-ms-examples": {
+ "InvoiceSectionRoleAssignmentList": {
+ "$ref": "./examples/InvoiceSectionRoleAssignmentList.json"
+ }
+ },
+ "operationId": "BillingRoleAssignments_ListByInvoiceSection",
+ "description": "Lists the role assignments for the caller on an invoice section. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement.",
+ "externalDocs": {
+ "url": "https://docs.microsoft.com/en-us/rest/api/billing/"
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/billingAccountNameParameter"
+ },
+ {
+ "$ref": "#/parameters/billingProfileNameParameter"
+ },
+ {
+ "$ref": "#/parameters/invoiceSectionNameParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK. The request has succeeded.",
+ "schema": {
+ "$ref": "#/definitions/BillingRoleAssignmentListResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/billingRoleAssignments": {
+ "get": {
+ "tags": [
+ "BillingRoleAssignments"
+ ],
+ "x-ms-examples": {
+ "BillingProfileRoleAssignmentList": {
+ "$ref": "./examples/BillingProfileRoleAssignmentList.json"
+ }
+ },
+ "operationId": "BillingRoleAssignments_ListByBillingProfile",
+ "description": "Lists the role assignments for the caller on a billing profile. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement.",
+ "externalDocs": {
+ "url": "https://docs.microsoft.com/en-us/rest/api/billing/"
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/billingAccountNameParameter"
+ },
+ {
+ "$ref": "#/parameters/billingProfileNameParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK. The request has succeeded.",
+ "schema": {
+ "$ref": "#/definitions/BillingRoleAssignmentListResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/agreements": {
+ "get": {
+ "tags": [
+ "Agreements"
+ ],
+ "x-ms-examples": {
+ "AgreementsListByBillingAccount": {
+ "$ref": "./examples/AgreementsListByBillingAccount.json"
+ }
+ },
+ "operationId": "Agreements_ListByBillingAccount",
+ "description": "Lists the agreements for a billing account.",
+ "externalDocs": {
+ "url": "https://docs.microsoft.com/en-us/rest/api/billing/"
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/billingAccountNameParameter"
+ },
+ {
+ "name": "$expand",
+ "description": "May be used to expand the participants.",
+ "in": "query",
+ "required": false,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK. The request has succeeded.",
+ "schema": {
+ "$ref": "#/definitions/AgreementListResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/agreements/{agreementName}": {
+ "get": {
+ "tags": [
+ "Agreements"
+ ],
+ "x-ms-examples": {
+ "AgreementByName": {
+ "$ref": "./examples/AgreementByName.json"
+ }
+ },
+ "operationId": "Agreements_Get",
+ "description": "Gets an agreement by ID.",
+ "externalDocs": {
+ "url": "https://docs.microsoft.com/en-us/rest/api/billing/"
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/billingAccountNameParameter"
+ },
+ {
+ "$ref": "#/parameters/agreementNameParameter"
+ },
+ {
+ "name": "$expand",
+ "description": "May be used to expand the participants.",
+ "in": "query",
+ "required": false,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK. The request has succeeded.",
+ "schema": {
+ "$ref": "#/definitions/Agreement"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ }
+ }
+ }
+ },
+ "definitions": {
+ "CustomerListResult": {
+ "description": "The list of customers.",
+ "properties": {
+ "value": {
+ "description": "The list of customers.",
+ "type": "array",
+ "readOnly": true,
+ "items": {
+ "$ref": "#/definitions/Customer"
+ }
+ },
+ "nextLink": {
+ "description": "The link (url) to the next page of results.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "Customer": {
+ "description": "A partner's customer.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/Resource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "description": "The customer.",
+ "x-ms-client-flatten": true,
+ "$ref": "#/definitions/CustomerProperties"
+ }
+ }
+ },
+ "CustomerProperties": {
+ "description": "The properties of a customer.",
+ "properties": {
+ "billingProfileId": {
+ "description": "The ID of the billing profile for the invoice section.",
+ "type": "string",
+ "readOnly": true
+ },
+ "billingProfileDisplayName": {
+ "description": "The name of the billing profile for the invoice section.",
+ "type": "string",
+ "readOnly": true
+ },
+ "displayName": {
+ "description": "The name of the customer.",
+ "type": "string"
+ },
+ "enabledAzurePlans": {
+ "description": "Azure plans enabled for the customer.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/AzurePlan"
+ }
+ },
+ "resellers": {
+ "description": "The list of resellers for which an Azure plan is enabled for the customer.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/Reseller"
+ }
+ }
+ }
+ },
+ "ValidateAddressResponse": {
+ "type": "object",
+ "description": "Result of the address validation",
+ "properties": {
+ "status": {
+ "description": "status of the address validation.",
+ "$ref": "#/definitions/AddressValidationStatus"
+ },
+ "suggestedAddresses": {
+ "description": "The list of suggested addresses.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/AddressDetails"
+ }
+ },
+ "validationMessage": {
+ "description": "Validation error message.",
+ "type": "string"
+ }
+ }
+ },
+ "AddressValidationStatus": {
+ "type": "string",
+ "description": "Status of the address validation.",
+ "enum": [
+ "Valid",
+ "Invalid"
+ ],
+ "x-ms-enum": {
+ "name": "addressValidationStatus",
+ "modelAsString": true
+ }
+ },
+ "TransferProductRequestProperties": {
+ "description": "The properties of the product to initiate a transfer.",
+ "properties": {
+ "destinationInvoiceSectionId": {
+ "type": "string",
+ "description": "The destination invoice section id."
+ }
+ }
+ },
+ "TransferBillingSubscriptionRequestProperties": {
+ "type": "object",
+ "description": "Request parameters to transfer billing subscription.",
+ "required": [
+ "destinationInvoiceSectionId"
+ ],
+ "properties": {
+ "destinationInvoiceSectionId": {
+ "type": "string",
+ "description": "The destination invoice section id."
+ }
+ }
+ },
+ "ValidateSubscriptionTransferEligibilityResult": {
+ "type": "object",
+ "description": "Result of the transfer eligibility validation.",
+ "properties": {
+ "isMoveEligible": {
+ "description": "Specifies whether the subscription is eligible to be transferred.",
+ "type": "boolean",
+ "readOnly": true
+ },
+ "errorDetails": {
+ "description": "Validation error details.",
+ "$ref": "#/definitions/ValidateSubscriptionTransferEligibilityError"
+ }
+ }
+ },
+ "ValidateSubscriptionTransferEligibilityError": {
+ "type": "object",
+ "description": "Error details of the transfer eligibility validation",
+ "properties": {
+ "code": {
+ "description": "Error code for the product transfer validation.",
+ "$ref": "#/definitions/SubscriptionTransferValidationErrorCode"
+ },
+ "message": {
+ "description": "The error message.",
+ "type": "string"
+ },
+ "details": {
+ "description": "Detailed error message explaining the error.",
+ "type": "string"
+ }
+ }
+ },
+ "SubscriptionTransferValidationErrorCode": {
+ "type": "string",
+ "description": "Error code of the transfer validation response.",
+ "enum": [
+ "InvalidSource",
+ "SubscriptionNotActive",
+ "InsufficientPermissionOnSource",
+ "InsufficientPermissionOnDestination",
+ "DestinationBillingProfilePastDue",
+ "SubscriptionTypeNotSupported",
+ "CrossBillingAccountNotAllowed",
+ "NotAvailableForDestinationMarket"
+ ],
+ "x-ms-enum": {
+ "name": "subscriptionTransferValidationErrorCode",
+ "modelAsString": true
+ }
+ },
+ "BillingAccountListResult": {
+ "description": "The list of billing accounts.",
+ "properties": {
+ "value": {
+ "description": "The list of billing accounts.",
+ "type": "array",
+ "readOnly": true,
+ "items": {
+ "$ref": "#/definitions/BillingAccount"
+ }
+ },
+ "nextLink": {
+ "description": "The link (url) to the next page of results.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "BillingAccount": {
+ "description": "A billing account.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/Resource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "description": "The properties of the billing account.",
+ "x-ms-client-flatten": true,
+ "$ref": "#/definitions/BillingAccountProperties"
+ }
+ }
+ },
+ "BillingAccountProperties": {
+ "description": "The properties of the billing account.",
+ "properties": {
+ "displayName": {
+ "description": "The billing account name.",
+ "type": "string"
+ },
+ "soldTo": {
+ "description": "The address of the individual or organization that is responsible for the billing account.",
+ "$ref": "#/definitions/AddressDetails"
+ },
+ "agreementType": {
+ "description": "The type of agreement.",
+ "type": "string",
+ "enum": [
+ "MicrosoftCustomerAgreement",
+ "EnterpriseAgreement",
+ "MicrosoftOnlineServicesProgram",
+ "MicrosoftPartnerAgreement"
+ ],
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "AgreementType",
+ "modelAsString": true
+ }
+ },
+ "accountType": {
+ "description": "The type of customer.",
+ "type": "string",
+ "enum": [
+ "Enterprise",
+ "Individual",
+ "Partner"
+ ],
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "AccountType",
+ "modelAsString": true
+ }
+ },
+ "accountStatus": {
+ "description": "The current status of the billing account.",
+ "type": "string",
+ "enum": [
+ "Active",
+ "Deleted",
+ "Disabled",
+ "Expired",
+ "Transferred",
+ "Extended",
+ "Terminated"
+ ],
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "AccountStatus",
+ "modelAsString": true
+ }
+ },
+ "billingProfiles": {
+ "description": "The billing profiles associated with the billing account. By default this is not populated, unless it's specified in $expand.",
+ "$ref": "#/definitions/BillingProfilesOnExpand"
+ },
+ "enrollmentDetails": {
+ "description": "The details about the associated legacy enrollment. By default this is not populated, unless it's specified in $expand.",
+ "$ref": "#/definitions/Enrollment",
+ "readOnly": true
+ },
+ "departments": {
+ "description": "The departments associated to the enrollment.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/Department"
+ }
+ },
+ "enrollmentAccounts": {
+ "description": "The accounts associated to the enrollment.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/EnrollmentAccount"
+ }
+ },
+ "hasReadAccess": {
+ "description": "Indicates whether user has read access to the billing account.",
+ "type": "boolean",
+ "readOnly": true
+ }
+ }
+ },
+ "BillingProfilesOnExpand": {
+ "description": "The billing profiles associated with the billing account. By default this is not populated, unless it's specified in $expand.",
+ "properties": {
+ "hasMoreResults": {
+ "description": "Indicates whether there are more billing profiles than the ones listed in this collection. The collection lists a maximum of 50 billing profiles. To get all billing profiles, use the list billing profiles API.",
+ "type": "boolean",
+ "readOnly": true
+ },
+ "value": {
+ "description": "The billing profiles associated with the billing account.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/BillingProfile"
+ }
+ }
+ }
+ },
+ "BillingAccountUpdateRequest": {
+ "description": "The request properties of the billing account that can be updated.",
+ "properties": {
+ "properties": {
+ "description": "A billing property.",
+ "x-ms-client-flatten": true,
+ "$ref": "#/definitions/BillingAccountProperties"
+ }
+ }
+ },
+ "BillingProperty": {
+ "description": "A billing property.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/Resource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "description": "A billing property.",
+ "x-ms-client-flatten": true,
+ "$ref": "#/definitions/BillingPropertyProperties"
+ }
+ }
+ },
+ "BillingPropertyProperties": {
+ "description": "The billing property.",
+ "properties": {
+ "accountAdminNotificationEmailAddress": {
+ "description": "The email address on which the account admin gets all Azure notifications.",
+ "type": "string",
+ "readOnly": true
+ },
+ "billingTenantId": {
+ "description": "The Azure AD tenant ID of the billing account for the subscription.",
+ "type": "string",
+ "readOnly": true
+ },
+ "billingAccountId": {
+ "description": "The ID of the billing account to which the subscription is billed.",
+ "type": "string",
+ "readOnly": true
+ },
+ "billingAccountDisplayName": {
+ "description": "The name of the billing account to which the subscription is billed.",
+ "type": "string",
+ "readOnly": true
+ },
+ "billingProfileId": {
+ "description": "The ID of the billing profile to which the subscription is billed.",
+ "type": "string",
+ "readOnly": true
+ },
+ "billingProfileDisplayName": {
+ "description": "The name of the billing profile to which the subscription is billed.",
+ "type": "string",
+ "readOnly": true
+ },
+ "billingProfileStatus": {
+ "description": "The status of the billing profile.",
+ "enum": [
+ "Active",
+ "Disabled",
+ "Warned"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "BillingProfileStatus",
+ "modelAsString": true
+ }
+ },
+ "billingProfileStatusReasonCode": {
+ "description": "Reason for the specified billing profile status.",
+ "enum": [
+ "PastDue",
+ "SpendingLimitReached",
+ "SpendingLimitExpired"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "BillingProfileStatusReasonCode",
+ "modelAsString": true
+ }
+ },
+ "billingProfileSpendingLimit": {
+ "description": "The billing profile spending limit.",
+ "enum": [
+ "Off",
+ "On"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "BillingProfileSpendingLimit",
+ "modelAsString": true
+ }
+ },
+ "costCenter": {
+ "description": "The cost center applied to the subscription.",
+ "type": "string"
+ },
+ "invoiceSectionId": {
+ "description": "The ID of the invoice section to which the subscription is billed.",
+ "type": "string",
+ "readOnly": true
+ },
+ "invoiceSectionDisplayName": {
+ "description": "The name of the invoice section to which the subscription is billed.",
+ "type": "string",
+ "readOnly": true
+ },
+ "isAccountAdmin": {
+ "description": "Indicates whether user is the account admin.",
+ "type": "boolean",
+ "readOnly": true
+ },
+ "productId": {
+ "description": "The product ID of the Azure plan.",
+ "type": "string",
+ "readOnly": true
+ },
+ "productName": {
+ "description": "The product name of the Azure plan.",
+ "type": "string",
+ "readOnly": true
+ },
+ "skuId": {
+ "description": "The sku ID of the Azure plan for the subscription.",
+ "type": "string",
+ "readOnly": true
+ },
+ "skuDescription": {
+ "description": "The sku description of the Azure plan for the subscription.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "Enrollment": {
+ "description": "The properties of an enrollment.",
+ "properties": {
+ "startDate": {
+ "description": "The start date of the enrollment.",
+ "type": "string",
+ "format": "date-time"
+ },
+ "endDate": {
+ "description": "The end date of the enrollment.",
+ "type": "string",
+ "format": "date-time"
+ },
+ "currency": {
+ "description": "The billing currency for the enrollment.",
+ "type": "string",
+ "readOnly": true
+ },
+ "channel": {
+ "description": "The channel type of the enrollment.",
+ "type": "string",
+ "readOnly": true
+ },
+ "policies": {
+ "description": "The policies for Enterprise Agreement enrollments.",
+ "$ref": "#/definitions/EnrollmentPolicies",
+ "readOnly": true
+ },
+ "language": {
+ "description": "The language for the enrollment.",
+ "type": "string",
+ "readOnly": true
+ },
+ "countryCode": {
+ "description": "The country code of the enrollment.",
+ "type": "string",
+ "readOnly": true
+ },
+ "status": {
+ "description": "The current status of the enrollment.",
+ "type": "string",
+ "readOnly": true
+ },
+ "billingCycle": {
+ "description": "The billing cycle for the enrollment.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "EnrollmentPolicies": {
+ "description": "The policies for Enterprise Agreement enrollments.",
+ "properties": {
+ "accountOwnerViewCharges": {
+ "description": "The policy that controls whether Account Owners can view charges.",
+ "type": "boolean",
+ "readOnly": true
+ },
+ "departmentAdminViewCharges": {
+ "description": "The policy that controls whether Department Administrators can view charges.",
+ "type": "boolean",
+ "readOnly": true
+ },
+ "marketplacesEnabled": {
+ "description": "The policy that controls whether Azure marketplace purchases are allowed in the enrollment.",
+ "type": "boolean",
+ "readOnly": true
+ },
+ "reservedInstancesEnabled": {
+ "description": "The policy that controls whether Azure reservation purchases are allowed in the enrollment.",
+ "type": "boolean",
+ "readOnly": true
+ }
+ }
+ },
+ "Department": {
+ "description": "A department.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/Resource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "description": "A department.",
+ "x-ms-client-flatten": true,
+ "$ref": "#/definitions/DepartmentProperties"
+ }
+ }
+ },
+ "DepartmentProperties": {
+ "description": "The properties of a department.",
+ "properties": {
+ "departmentName": {
+ "description": "The name of the department.",
+ "type": "string"
+ },
+ "costCenter": {
+ "description": "The cost center associated with the department.",
+ "type": "string"
+ },
+ "status": {
+ "description": "The status of the department.",
+ "type": "string"
+ },
+ "enrollmentAccounts": {
+ "description": "Associated enrollment accounts. By default this is not populated, unless it's specified in $expand.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/EnrollmentAccount"
+ }
+ }
+ }
+ },
+ "EnrollmentAccount": {
+ "description": "An enrollment account.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/Resource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "description": "The properties of an enrollment account.",
+ "x-ms-client-flatten": true,
+ "$ref": "#/definitions/EnrollmentAccountProperties"
+ }
+ }
+ },
+ "EnrollmentAccountProperties": {
+ "description": "The properties of an enrollment account.",
+ "properties": {
+ "accountName": {
+ "description": "The name of the enrollment account.",
+ "type": "string"
+ },
+ "costCenter": {
+ "description": "The cost center associated with the enrollment account.",
+ "type": "string"
+ },
+ "accountOwner": {
+ "description": "The owner of the enrollment account.",
+ "type": "string"
+ },
+ "status": {
+ "description": "The status of the enrollment account.",
+ "type": "string"
+ },
+ "startDate": {
+ "description": "The start date of the enrollment account.",
+ "type": "string",
+ "format": "date-time"
+ },
+ "endDate": {
+ "description": "The end date of the enrollment account.",
+ "type": "string",
+ "format": "date-time"
+ },
+ "department": {
+ "description": "Associated department. By default this is not populated, unless it's specified in $expand.",
+ "$ref": "#/definitions/Department"
+ }
+ }
+ },
+ "InstructionListResult": {
+ "description": "The list of billing instructions used during invoice generation.",
+ "properties": {
+ "value": {
+ "description": "The list of billing instructions used during invoice generation.",
+ "type": "array",
+ "readOnly": true,
+ "items": {
+ "$ref": "#/definitions/Instruction"
+ }
+ },
+ "nextLink": {
+ "description": "The link (url) to the next page of results.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "BillingProfileListResult": {
+ "description": "The list of billing profiles.",
+ "properties": {
+ "value": {
+ "description": "The list of billing profiles.",
+ "type": "array",
+ "readOnly": true,
+ "items": {
+ "$ref": "#/definitions/BillingProfile"
+ }
+ },
+ "nextLink": {
+ "description": "The link (url) to the next page of results.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "BillingProfile": {
+ "description": "A billing profile.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/Resource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "description": "The properties of the billing profile.",
+ "x-ms-client-flatten": true,
+ "$ref": "#/definitions/BillingProfileProperties"
+ }
+ }
+ },
+ "Instruction": {
+ "description": "An instruction.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/Resource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "description": "A billing instruction used during invoice generation.",
+ "x-ms-client-flatten": true,
+ "$ref": "#/definitions/InstructionProperties"
+ }
+ }
+ },
+ "InstructionProperties": {
+ "description": "A billing instruction used during invoice generation.",
+ "required": [
+ "amount",
+ "startDate",
+ "endDate"
+ ],
+ "properties": {
+ "amount": {
+ "description": "The amount budgeted for this billing instruction.",
+ "type": "number"
+ },
+ "startDate": {
+ "description": "The date this billing instruction goes into effect.",
+ "type": "string",
+ "format": "date-time"
+ },
+ "endDate": {
+ "description": "The date this billing instruction is no longer in effect.",
+ "type": "string",
+ "format": "date-time"
+ },
+ "creationDate": {
+ "description": "The date this billing instruction was created.",
+ "type": "string",
+ "format": "date-time"
+ }
+ }
+ },
+ "BillingProfileCreationRequest": {
+ "description": "The request parameters for creating a new billing profile.",
+ "properties": {
+ "displayName": {
+ "description": "The name of the billing profile.",
+ "type": "string"
+ },
+ "poNumber": {
+ "description": "The purchase order name that will appear on the invoices generated for the billing profile.",
+ "type": "string"
+ },
+ "billTo": {
+ "description": "The address of the individual or organization that is responsible for the billing profile.",
+ "$ref": "#/definitions/AddressDetails"
+ },
+ "invoiceEmailOptIn": {
+ "description": "Flag controlling whether the invoices for the billing profile are sent through email.",
+ "type": "boolean"
+ },
+ "enabledAzurePlans": {
+ "description": "Enabled azure plans for the billing profile.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/AzurePlan"
+ }
+ }
+ }
+ },
+ "BillingProfileProperties": {
+ "description": "The properties of the billing profile.",
+ "properties": {
+ "displayName": {
+ "description": "The name of the billing profile.",
+ "type": "string"
+ },
+ "poNumber": {
+ "description": "The purchase order name that will appear on the invoices generated for the billing profile.",
+ "type": "string"
+ },
+ "billTo": {
+ "description": "Billing address.",
+ "$ref": "#/definitions/AddressDetails"
+ },
+ "invoiceEmailOptIn": {
+ "description": "Flag controlling whether the invoices for the billing profile are sent through email.",
+ "type": "boolean"
+ },
+ "invoiceDay": {
+ "description": "The day of the month when the invoice for the billing profile is generated.",
+ "type": "integer",
+ "readOnly": true
+ },
+ "currency": {
+ "description": "The currency in which the charges for the billing profile are billed.",
+ "type": "string",
+ "readOnly": true
+ },
+ "enabledAzurePlans": {
+ "description": "Information about the enabled azure plans.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/AzurePlan"
+ }
+ },
+ "invoiceSections": {
+ "description": "The invoice sections associated to the billing profile. By default this is not populated, unless it's specified in $expand.",
+ "$ref": "#/definitions/InvoiceSectionsOnExpand"
+ },
+ "hasReadAccess": {
+ "description": "Indicates whether user has read access to the billing profile.",
+ "type": "boolean",
+ "readOnly": true
+ },
+ "systemId": {
+ "description": "The system generated unique identifier for a billing profile.",
+ "type": "string",
+ "readOnly": true
+ },
+ "status": {
+ "description": "The status of the billing profile.",
+ "enum": [
+ "Active",
+ "Disabled",
+ "Warned"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "BillingProfileStatus",
+ "modelAsString": true
+ }
+ },
+ "statusReasonCode": {
+ "description": "Reason for the specified billing profile status.",
+ "enum": [
+ "PastDue",
+ "SpendingLimitReached",
+ "SpendingLimitExpired"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "StatusReasonCode",
+ "modelAsString": true
+ }
+ },
+ "spendingLimit": {
+ "description": "The billing profile spending limit.",
+ "enum": [
+ "Off",
+ "On"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "SpendingLimit",
+ "modelAsString": true
+ }
+ }
+ }
+ },
+ "InvoiceSectionsOnExpand": {
+ "description": "The invoice sections associated to the billing profile. By default this is not populated, unless it's specified in $expand.",
+ "properties": {
+ "hasMoreResults": {
+ "description": "Indicates whether there are more invoice sections than the ones listed in this collection. The collection lists a maximum of 50 invoice sections. To get all invoice sections, use the list invoice sections API.",
+ "type": "boolean",
+ "readOnly": true
+ },
+ "value": {
+ "description": "The invoice sections associated to the billing profile.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/InvoiceSection"
+ }
+ }
+ }
+ },
+ "AddressDetails": {
+ "description": "Address details.",
+ "required": [
+ "addressLine1",
+ "country"
+ ],
+ "properties": {
+ "firstName": {
+ "description": "First name.",
+ "type": "string"
+ },
+ "lastName": {
+ "description": "Last name.",
+ "type": "string"
+ },
+ "companyName": {
+ "description": "Company name.",
+ "type": "string"
+ },
+ "addressLine1": {
+ "description": "Address line 1.",
+ "type": "string"
+ },
+ "addressLine2": {
+ "description": "Address line 2.",
+ "type": "string"
+ },
+ "addressLine3": {
+ "description": "Address line 3.",
+ "type": "string"
+ },
+ "city": {
+ "description": "Address city.",
+ "type": "string"
+ },
+ "district": {
+ "description": "Address district.",
+ "type": "string"
+ },
+ "region": {
+ "description": "Address region.",
+ "type": "string"
+ },
+ "country": {
+ "description": "Country code uses ISO2, 2-digit format.",
+ "type": "string"
+ },
+ "postalCode": {
+ "description": "Postal code.",
+ "type": "string"
+ },
+ "email": {
+ "description": "Email address.",
+ "type": "string"
+ },
+ "phoneNumber": {
+ "description": "Phone number.",
+ "type": "string"
+ }
+ }
+ },
+ "InvoiceSectionCreationRequest": {
+ "description": "The properties of the invoice section.",
+ "properties": {
+ "displayName": {
+ "description": "The name of the invoice section.",
+ "type": "string"
+ }
+ }
+ },
+ "InvoiceSectionListResult": {
+ "description": "The list of invoice sections.",
+ "properties": {
+ "value": {
+ "description": "The list of invoice sections.",
+ "type": "array",
+ "readOnly": true,
+ "items": {
+ "$ref": "#/definitions/InvoiceSection"
+ }
+ },
+ "nextLink": {
+ "description": "The link (url) to the next page of results.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "InvoiceSection": {
+ "description": "An invoice section.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/Resource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "description": "The properties of an invoice section.",
+ "x-ms-client-flatten": true,
+ "$ref": "#/definitions/InvoiceSectionProperties"
+ }
+ }
+ },
+ "InvoiceSectionProperties": {
+ "description": "The properties of an invoice section.",
+ "properties": {
+ "displayName": {
+ "description": "The name of the invoice section.",
+ "type": "string"
+ },
+ "labels": {
+ "type": "object",
+ "description": "Dictionary of metadata associated with the invoice section.",
+ "additionalProperties": {
+ "type": "string"
+ },
+ "maxItems": 1000
+ },
+ "systemId": {
+ "description": "The system generated unique identifier for an invoice section.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "InvoiceSectionListWithCreateSubPermissionResult": {
+ "type": "object",
+ "description": "The list of invoice section properties with create subscription permission.",
+ "properties": {
+ "value": {
+ "description": "The list of invoice section properties with create subscription permission.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/InvoiceSectionWithCreateSubPermission"
+ }
+ },
+ "nextLink": {
+ "description": "The link (url) to the next page of results.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "InvoiceSectionWithCreateSubPermission": {
+ "description": "Invoice section properties with create subscription permission.",
+ "properties": {
+ "invoiceSectionId": {
+ "description": "The ID of the invoice section.",
+ "type": "string",
+ "readOnly": true
+ },
+ "invoiceSectionDisplayName": {
+ "description": "The name of the invoice section.",
+ "type": "string",
+ "readOnly": true
+ },
+ "invoiceSectionSystemId": {
+ "description": "The system generated unique identifier for an invoice section.",
+ "type": "string",
+ "readOnly": true
+ },
+ "billingProfileId": {
+ "description": "The ID of the billing profile for the invoice section.",
+ "type": "string",
+ "readOnly": true
+ },
+ "billingProfileDisplayName": {
+ "description": "The name of the billing profile for the invoice section.",
+ "type": "string",
+ "readOnly": true
+ },
+ "billingProfileStatus": {
+ "description": "The status of the billing profile.",
+ "enum": [
+ "Active",
+ "Disabled",
+ "Warned"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "BillingProfileStatus",
+ "modelAsString": true
+ }
+ },
+ "billingProfileStatusReasonCode": {
+ "description": "Reason for the specified billing profile status.",
+ "enum": [
+ "PastDue",
+ "SpendingLimitReached",
+ "SpendingLimitExpired"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "StatusReasonCodeForBillingProfile",
+ "modelAsString": true
+ }
+ },
+ "billingProfileSpendingLimit": {
+ "description": "The billing profile spending limit.",
+ "enum": [
+ "Off",
+ "On"
+ ],
+ "readOnly": true,
+ "type": "string",
+ "x-ms-enum": {
+ "name": "SpendingLimitForBillingProfile",
+ "modelAsString": true
+ }
+ },
+ "billingProfileSystemId": {
+ "description": "The system generated unique identifier for a billing profile.",
+ "type": "string",
+ "readOnly": true
+ },
+ "enabledAzurePlans": {
+ "description": "Enabled azure plans for the associated billing profile.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/AzurePlan"
+ }
+ }
+ }
+ },
+ "AzurePlan": {
+ "description": "Details of the Azure plan.",
+ "properties": {
+ "skuId": {
+ "description": "The sku id.",
+ "type": "string"
+ },
+ "skuDescription": {
+ "description": "The sku description.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "DownloadUrl": {
+ "description": "A secure URL that can be used to download a an entity until the URL expires.",
+ "properties": {
+ "expiryTime": {
+ "description": "The time in UTC when the download URL will expire.",
+ "type": "string",
+ "format": "date-time",
+ "readOnly": true
+ },
+ "url": {
+ "description": "The URL to the PDF file.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "ErrorDetails": {
+ "description": "The details of the error.",
+ "properties": {
+ "code": {
+ "description": "Error code.",
+ "type": "string",
+ "readOnly": true
+ },
+ "message": {
+ "description": "Error message indicating why the operation failed.",
+ "type": "string",
+ "readOnly": true
+ },
+ "target": {
+ "description": "The target of the particular error.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "ErrorResponse": {
+ "description": "Error response indicates that the service is not able to process the incoming request. The reason is provided in the error message.",
+ "type": "object",
+ "properties": {
+ "error": {
+ "description": "The details of the error.",
+ "$ref": "#/definitions/ErrorDetails"
+ }
+ }
+ },
+ "Reseller": {
+ "description": "Details of the reseller.",
+ "properties": {
+ "resellerId": {
+ "description": "The MPN ID of the reseller.",
+ "type": "string",
+ "readOnly": true
+ },
+ "description": {
+ "description": "The name of the reseller.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "Resource": {
+ "description": "The Resource model definition.",
+ "properties": {
+ "id": {
+ "readOnly": true,
+ "type": "string",
+ "description": "Resource Id."
+ },
+ "name": {
+ "readOnly": true,
+ "type": "string",
+ "description": "Resource name."
+ },
+ "type": {
+ "readOnly": true,
+ "type": "string",
+ "description": "Resource type."
+ }
+ },
+ "x-ms-azure-resource": true
+ },
+ "InvoiceListResult": {
+ "description": "The list of invoices.",
+ "properties": {
+ "value": {
+ "description": "The list of invoices.",
+ "type": "array",
+ "readOnly": true,
+ "items": {
+ "$ref": "#/definitions/Invoice"
+ }
+ },
+ "nextLink": {
+ "description": "The link (url) to the next page of results.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "Invoice": {
+ "description": "An invoice.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/Resource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "description": "An invoice.",
+ "x-ms-client-flatten": true,
+ "$ref": "#/definitions/InvoiceProperties"
+ }
+ }
+ },
+ "InvoiceProperties": {
+ "description": "The properties of the invoice.",
+ "properties": {
+ "dueDate": {
+ "description": "The due date for the invoice.",
+ "type": "string",
+ "format": "date-time",
+ "readOnly": true
+ },
+ "invoiceDate": {
+ "description": "The date when the invoice was generated.",
+ "type": "string",
+ "format": "date-time",
+ "readOnly": true
+ },
+ "status": {
+ "description": "The current status of the invoice.",
+ "type": "string",
+ "enum": [
+ "Due",
+ "OverDue",
+ "Paid"
+ ],
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "InvoiceStatus",
+ "modelAsString": true
+ }
+ },
+ "amountDue": {
+ "description": "The amount due as of now.",
+ "readOnly": true,
+ "$ref": "#/definitions/Amount"
+ },
+ "azurePrepaymentApplied": {
+ "description": "The amount of Azure prepayment applied to the charges. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement.",
+ "readOnly": true,
+ "$ref": "#/definitions/Amount"
+ },
+ "billedAmount": {
+ "description": "The total charges for the invoice billing period.",
+ "readOnly": true,
+ "$ref": "#/definitions/Amount"
+ },
+ "creditAmount": {
+ "description": "The total refund for returns and cancellations during the invoice billing period. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement.",
+ "readOnly": true,
+ "$ref": "#/definitions/Amount"
+ },
+ "freeAzureCreditApplied": {
+ "description": "The amount of free Azure credits applied to the charges. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement.",
+ "readOnly": true,
+ "$ref": "#/definitions/Amount"
+ },
+ "subTotal": {
+ "description": "The pre-tax amount due. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement.",
+ "readOnly": true,
+ "$ref": "#/definitions/Amount"
+ },
+ "taxAmount": {
+ "description": "The amount of tax charged for the billing period. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement.",
+ "readOnly": true,
+ "$ref": "#/definitions/Amount"
+ },
+ "totalAmount": {
+ "description": "The amount due when the invoice was generated. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement.",
+ "readOnly": true,
+ "$ref": "#/definitions/Amount"
+ },
+ "invoicePeriodStartDate": {
+ "description": "The start date of the billing period for which the invoice is generated.",
+ "type": "string",
+ "format": "date-time",
+ "readOnly": true
+ },
+ "invoicePeriodEndDate": {
+ "description": "The end date of the billing period for which the invoice is generated.",
+ "type": "string",
+ "format": "date-time",
+ "readOnly": true
+ },
+ "invoiceType": {
+ "description": "Invoice type.",
+ "enum": [
+ "AzureService",
+ "AzureMarketplace",
+ "AzureSupport"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "InvoiceType",
+ "modelAsString": true
+ }
+ },
+ "isMonthlyInvoice": {
+ "description": "Specifies if the invoice is generated as part of monthly invoicing cycle or not. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement.",
+ "type": "boolean",
+ "readOnly": true
+ },
+ "billingProfileId": {
+ "description": "The ID of the billing profile for which the invoice is generated.",
+ "type": "string",
+ "readOnly": true
+ },
+ "billingProfileDisplayName": {
+ "description": "The name of the billing profile for which the invoice is generated.",
+ "type": "string",
+ "readOnly": true
+ },
+ "purchaseOrderNumber": {
+ "description": "An optional purchase order number for the invoice.",
+ "type": "string",
+ "readOnly": true
+ },
+ "documents": {
+ "description": "List of documents available to download such as invoice and tax receipt.",
+ "type": "array",
+ "readOnly": true,
+ "items": {
+ "$ref": "#/definitions/Document"
+ }
+ },
+ "payments": {
+ "description": "List of payments.",
+ "type": "array",
+ "readOnly": true,
+ "items": {
+ "$ref": "#/definitions/PaymentProperties"
+ }
+ },
+ "subscriptionId": {
+ "description": "The ID of the subscription for which the invoice is generated.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "PaymentProperties": {
+ "description": "The properties of a payment.",
+ "properties": {
+ "paymentType": {
+ "description": "The type of payment.",
+ "type": "string",
+ "readOnly": true
+ },
+ "amount": {
+ "description": "The paid amount.",
+ "readOnly": true,
+ "$ref": "#/definitions/Amount"
+ },
+ "date": {
+ "description": "The date when the payment was made.",
+ "type": "string",
+ "format": "date-time",
+ "readOnly": true
+ },
+ "paymentMethodFamily": {
+ "description": "The family of payment method.",
+ "type": "string",
+ "enum": [
+ "Credits",
+ "CheckWire",
+ "CreditCard",
+ "None"
+ ],
+ "x-ms-enum": {
+ "name": "PaymentMethodFamily",
+ "modelAsString": true
+ }
+ },
+ "paymentMethodType": {
+ "description": "The type of payment method.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "Document": {
+ "description": "The properties of a document.",
+ "properties": {
+ "kind": {
+ "description": "The type of the document.",
+ "type": "string",
+ "enum": [
+ "Invoice",
+ "VoidNote",
+ "TaxReceipt",
+ "CreditNote"
+ ],
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "DocumentType",
+ "modelAsString": true
+ }
+ },
+ "url": {
+ "description": "Document URL.",
+ "type": "string",
+ "readOnly": true
+ },
+ "source": {
+ "description": "The source of the document. ENF for Brazil and DRS for rest of the world.",
+ "type": "string",
+ "enum": [
+ "DRS",
+ "ENF"
+ ],
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "DocumentSource",
+ "modelAsString": true
+ }
+ }
+ }
+ },
+ "ProductsListResult": {
+ "description": "The list of products. It contains a list of available product summaries in reverse chronological order by purchase date.",
+ "properties": {
+ "value": {
+ "description": "The list of products.",
+ "type": "array",
+ "readOnly": true,
+ "items": {
+ "$ref": "#/definitions/Product"
+ }
+ },
+ "nextLink": {
+ "description": "The link (url) to the next page of results.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "Product": {
+ "description": "A product.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/Resource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "x-ms-client-flatten": true,
+ "$ref": "#/definitions/ProductProperties",
+ "title": "Product properties"
+ }
+ }
+ },
+ "ProductProperties": {
+ "description": "The properties of a product.",
+ "properties": {
+ "autoRenew": {
+ "description": "Indicates whether auto renewal is turned on or off for a product.",
+ "type": "string",
+ "enum": [
+ "Off",
+ "On"
+ ],
+ "x-ms-enum": {
+ "name": "AutoRenew",
+ "modelAsString": true
+ }
+ },
+ "displayName": {
+ "description": "The display name of the product.",
+ "type": "string",
+ "readOnly": true
+ },
+ "purchaseDate": {
+ "description": "The date when the product was purchased.",
+ "type": "string",
+ "format": "date-time",
+ "readOnly": true
+ },
+ "productTypeId": {
+ "description": "The ID of the type of product.",
+ "type": "string",
+ "readOnly": true
+ },
+ "productType": {
+ "description": "The description of the type of product.",
+ "type": "string",
+ "readOnly": true
+ },
+ "status": {
+ "description": "The current status of the product.",
+ "type": "string",
+ "enum": [
+ "Active",
+ "Inactive",
+ "PastDue",
+ "Expiring",
+ "Expired",
+ "Disabled",
+ "Cancelled",
+ "AutoRenew"
+ ],
+ "x-ms-enum": {
+ "name": "ProductStatusType",
+ "modelAsString": true
+ }
+ },
+ "endDate": {
+ "description": "The date when the product will be renewed or canceled.",
+ "type": "string",
+ "format": "date-time",
+ "readOnly": true
+ },
+ "billingFrequency": {
+ "description": "The frequency at which the product will be billed.",
+ "type": "string",
+ "enum": [
+ "OneTime",
+ "Monthly",
+ "UsageBased"
+ ],
+ "x-ms-enum": {
+ "name": "BillingFrequency",
+ "modelAsString": true
+ }
+ },
+ "lastCharge": {
+ "description": "The last month charges.",
+ "readOnly": true,
+ "$ref": "#/definitions/Amount"
+ },
+ "lastChargeDate": {
+ "description": "The date of the last charge.",
+ "type": "string",
+ "format": "date-time",
+ "readOnly": true
+ },
+ "quantity": {
+ "description": "The quantity purchased for the product.",
+ "type": "number",
+ "readOnly": true
+ },
+ "skuId": {
+ "description": "The sku ID of the product.",
+ "type": "string",
+ "readOnly": true
+ },
+ "skuDescription": {
+ "description": "The sku description of the product.",
+ "type": "string",
+ "readOnly": true
+ },
+ "tenantId": {
+ "description": "The id of the tenant in which the product is used.",
+ "type": "string",
+ "readOnly": true
+ },
+ "availabilityId": {
+ "description": "The availability of the product.",
+ "type": "string",
+ "readOnly": true
+ },
+ "invoiceSectionId": {
+ "description": "The ID of the invoice section to which the product is billed.",
+ "type": "string",
+ "readOnly": true
+ },
+ "invoiceSectionDisplayName": {
+ "description": "The name of the invoice section to which the product is billed.",
+ "type": "string",
+ "readOnly": true
+ },
+ "billingProfileId": {
+ "description": "The ID of the billing profile to which the product is billed.",
+ "type": "string",
+ "readOnly": true
+ },
+ "billingProfileDisplayName": {
+ "description": "The name of the billing profile to which the product is billed.",
+ "type": "string",
+ "readOnly": true
+ },
+ "customerId": {
+ "description": "The ID of the customer for whom the product was purchased. The field is applicable only for Microsoft Partner Agreement billing account.",
+ "type": "string",
+ "readOnly": true
+ },
+ "customerDisplayName": {
+ "description": "The name of the customer for whom the product was purchased. The field is applicable only for Microsoft Partner Agreement billing account.",
+ "type": "string",
+ "readOnly": true
+ },
+ "reseller": {
+ "description": "Reseller for this product.",
+ "readOnly": true,
+ "$ref": "#/definitions/Reseller"
+ }
+ }
+ },
+ "ValidateProductTransferEligibilityResult": {
+ "type": "object",
+ "description": "Result of the product transfer eligibility validation.",
+ "properties": {
+ "isMoveEligible": {
+ "description": "Specifies whether the transfer is eligible or not.",
+ "type": "boolean",
+ "readOnly": true
+ },
+ "errorDetails": {
+ "description": "Validation error details.",
+ "$ref": "#/definitions/ValidateProductTransferEligibilityError"
+ }
+ }
+ },
+ "ValidateProductTransferEligibilityError": {
+ "type": "object",
+ "description": "Error details of the product transfer eligibility validation.",
+ "properties": {
+ "code": {
+ "description": "Error code for the product transfer validation.",
+ "$ref": "#/definitions/ProductTransferValidationErrorCode"
+ },
+ "message": {
+ "description": "The error message.",
+ "type": "string"
+ },
+ "details": {
+ "description": "Detailed error message explaining the error.",
+ "type": "string"
+ }
+ }
+ },
+ "ProductTransferValidationErrorCode": {
+ "type": "string",
+ "description": "Error code of the transfer validation response.",
+ "enum": [
+ "InvalidSource",
+ "ProductNotActive",
+ "InsufficientPermissionOnSource",
+ "InsufficientPermissionOnDestination",
+ "DestinationBillingProfilePastDue",
+ "ProductTypeNotSupported",
+ "CrossBillingAccountNotAllowed",
+ "NotAvailableForDestinationMarket",
+ "OneTimePurchaseProductTransferNotAllowed"
+ ],
+ "x-ms-enum": {
+ "name": "ProductTransferValidationErrorCode",
+ "modelAsString": true
+ }
+ },
+ "BillingSubscriptionsListResult": {
+ "description": "The list of billing subscriptions.",
+ "properties": {
+ "value": {
+ "description": "The list of billing subscriptions.",
+ "type": "array",
+ "readOnly": true,
+ "items": {
+ "$ref": "#/definitions/BillingSubscription"
+ }
+ },
+ "nextLink": {
+ "description": "The link (url) to the next page of results.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "BillingSubscription": {
+ "description": "A billing subscription.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/Resource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "x-ms-client-flatten": true,
+ "$ref": "#/definitions/BillingSubscriptionProperties",
+ "title": "Billing subscription properties"
+ }
+ }
+ },
+ "BillingSubscriptionProperties": {
+ "description": "The billing properties of a subscription.",
+ "properties": {
+ "displayName": {
+ "description": "The name of the subscription.",
+ "type": "string",
+ "readOnly": true
+ },
+ "subscriptionId": {
+ "description": "The ID of the subscription.",
+ "type": "string",
+ "format": "uuid",
+ "readOnly": true
+ },
+ "subscriptionBillingStatus": {
+ "description": "The current billing status of the subscription.",
+ "type": "string",
+ "enum": [
+ "Active",
+ "Inactive",
+ "Abandoned",
+ "Deleted",
+ "Warning"
+ ],
+ "x-ms-enum": {
+ "name": "BillingSubscriptionStatusType",
+ "modelAsString": true
+ }
+ },
+ "lastMonthCharges": {
+ "description": "The last month charges.",
+ "readOnly": true,
+ "$ref": "#/definitions/Amount"
+ },
+ "monthToDateCharges": {
+ "description": "The current month to date charges.",
+ "readOnly": true,
+ "$ref": "#/definitions/Amount"
+ },
+ "billingProfileId": {
+ "description": "The ID of the billing profile to which the subscription is billed.",
+ "type": "string",
+ "readOnly": true
+ },
+ "billingProfileDisplayName": {
+ "description": "The name of the billing profile to which the subscription is billed.",
+ "type": "string",
+ "readOnly": true
+ },
+ "costCenter": {
+ "description": "The cost center applied to the subscription.",
+ "type": "string"
+ },
+ "customerId": {
+ "description": "The ID of the customer for whom the subscription was created. The field is applicable only for Microsoft Partner Agreement billing account.",
+ "type": "string",
+ "readOnly": true
+ },
+ "customerDisplayName": {
+ "description": "The name of the customer for whom the subscription was created. The field is applicable only for Microsoft Partner Agreement billing account.",
+ "type": "string",
+ "readOnly": true
+ },
+ "invoiceSectionId": {
+ "description": "The ID of the invoice section to which the subscription is billed.",
+ "type": "string",
+ "readOnly": true
+ },
+ "invoiceSectionDisplayName": {
+ "description": "The name of the invoice section to which the subscription is billed.",
+ "type": "string",
+ "readOnly": true
+ },
+ "reseller": {
+ "description": "Reseller for this subscription.",
+ "readOnly": true,
+ "$ref": "#/definitions/Reseller"
+ },
+ "skuId": {
+ "description": "The sku ID of the Azure plan for the subscription.",
+ "type": "string"
+ },
+ "skuDescription": {
+ "description": "The sku description of the Azure plan for the subscription.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "EnrollmentAccountContext": {
+ "description": "The enrollment account context",
+ "properties": {
+ "costCenter": {
+ "description": "The cost center associated with the enrollment account.",
+ "type": "string"
+ },
+ "startDate": {
+ "description": "The start date of the enrollment account.",
+ "type": "string",
+ "format": "date-time"
+ },
+ "endDate": {
+ "description": "The end date of the enrollment account.",
+ "type": "string",
+ "format": "date-time"
+ },
+ "enrollmentAccountName": {
+ "description": "The ID of the enrollment account.",
+ "type": "string"
+ }
+ }
+ },
+ "TransactionListResult": {
+ "description": "The list of transactions.",
+ "properties": {
+ "value": {
+ "description": "The list of transactions.",
+ "type": "array",
+ "readOnly": true,
+ "items": {
+ "$ref": "#/definitions/Transaction"
+ }
+ },
+ "nextLink": {
+ "description": "The link (url) to the next page of results.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "Transaction": {
+ "description": "A transaction.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/Resource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "x-ms-client-flatten": true,
+ "$ref": "#/definitions/TransactionProperties",
+ "title": "Transaction properties"
+ }
+ }
+ },
+ "TransactionProperties": {
+ "description": "The properties of a transaction.",
+ "properties": {
+ "kind": {
+ "type": "string",
+ "description": "The kind of transaction. Options are all or reservation.",
+ "enum": [
+ "all",
+ "reservation"
+ ],
+ "x-ms-enum": {
+ "name": "TransactionTypeKind",
+ "modelAsString": true
+ }
+ },
+ "date": {
+ "description": "The date of transaction.",
+ "type": "string",
+ "format": "date-time",
+ "readOnly": true
+ },
+ "invoice": {
+ "description": "Invoice on which the transaction was billed or 'pending' if the transaction is not billed.",
+ "type": "string",
+ "readOnly": true
+ },
+ "invoiceId": {
+ "description": "The ID of the invoice on which the transaction was billed. This field is only applicable for transactions which are billed.",
+ "type": "string",
+ "readOnly": true
+ },
+ "orderId": {
+ "description": "The order ID of the reservation. The field is only applicable for transaction of kind reservation.",
+ "type": "string",
+ "readOnly": true
+ },
+ "orderName": {
+ "description": "The name of the reservation order. The field is only applicable for transactions of kind reservation.",
+ "type": "string",
+ "readOnly": true
+ },
+ "productFamily": {
+ "description": "The family of the product for which the transaction took place.",
+ "type": "string",
+ "readOnly": true
+ },
+ "productTypeId": {
+ "description": "The ID of the product type for which the transaction took place.",
+ "type": "string",
+ "readOnly": true
+ },
+ "productType": {
+ "description": "The type of the product for which the transaction took place.",
+ "type": "string",
+ "readOnly": true
+ },
+ "productDescription": {
+ "description": "The description of the product for which the transaction took place.",
+ "type": "string",
+ "readOnly": true
+ },
+ "transactionType": {
+ "description": "The type of transaction.",
+ "type": "string",
+ "enum": [
+ "Purchase",
+ "Usage Charge"
+ ],
+ "x-ms-enum": {
+ "name": "ReservationType",
+ "modelAsString": true
+ }
+ },
+ "transactionAmount": {
+ "description": "The charge associated with the transaction.",
+ "readOnly": true,
+ "$ref": "#/definitions/Amount"
+ },
+ "quantity": {
+ "description": "The quantity purchased in the transaction.",
+ "type": "integer",
+ "readOnly": true
+ },
+ "invoiceSectionId": {
+ "description": "The ID of the invoice section which will be billed for the transaction.",
+ "type": "string",
+ "readOnly": true
+ },
+ "invoiceSectionDisplayName": {
+ "description": "The name of the invoice section which will be billed for the transaction.",
+ "type": "string",
+ "readOnly": true
+ },
+ "billingProfileId": {
+ "description": "The ID of the billing profile which will be billed for the transaction.",
+ "type": "string",
+ "readOnly": true
+ },
+ "billingProfileDisplayName": {
+ "description": "The name of the billing profile which will be billed for the transaction.",
+ "type": "string",
+ "readOnly": true
+ },
+ "customerId": {
+ "description": "The ID of the customer for which the transaction took place. The field is applicable only for Microsoft Partner Agreement billing account.",
+ "type": "string",
+ "readOnly": true
+ },
+ "customerDisplayName": {
+ "description": "The name of the customer for which the transaction took place. The field is applicable only for Microsoft Partner Agreement billing account.",
+ "type": "string",
+ "readOnly": true
+ },
+ "subscriptionId": {
+ "description": "The ID of the subscription that was used for the transaction. The field is only applicable for transaction of kind reservation.",
+ "type": "string",
+ "readOnly": true
+ },
+ "subscriptionName": {
+ "description": "The name of the subscription that was used for the transaction. The field is only applicable for transaction of kind reservation.",
+ "type": "string",
+ "readOnly": true
+ },
+ "azurePlan": {
+ "description": "The type of azure plan of the subscription that was used for the transaction.",
+ "type": "string",
+ "readOnly": true
+ },
+ "azureCreditApplied": {
+ "description": "The amount of any Azure credits automatically applied to this transaction.",
+ "readOnly": true,
+ "$ref": "#/definitions/Amount"
+ },
+ "billingCurrency": {
+ "description": "The ISO 4217 code for the currency in which this transaction is billed.",
+ "type": "string",
+ "readOnly": true
+ },
+ "discount": {
+ "description": "The percentage discount, if any, applied to this transaction.",
+ "type": "number",
+ "readOnly": true
+ },
+ "effectivePrice": {
+ "description": "The price of the product after applying any discounts.",
+ "readOnly": true,
+ "$ref": "#/definitions/Amount"
+ },
+ "exchangeRate": {
+ "description": "The exchange rate used to convert charged amount to billing currency, if applicable.",
+ "type": "number",
+ "readOnly": true
+ },
+ "marketPrice": {
+ "description": "The retail price of the product.",
+ "readOnly": true,
+ "$ref": "#/definitions/Amount"
+ },
+ "pricingCurrency": {
+ "description": "The ISO 4217 code for the currency in which the product is priced.",
+ "type": "string",
+ "readOnly": true
+ },
+ "servicePeriodStartDate": {
+ "description": "The date of the purchase of the product, or the start date of the month in which usage started.",
+ "type": "string",
+ "format": "date-time",
+ "readOnly": true
+ },
+ "servicePeriodEndDate": {
+ "description": "The end date of the product term, or the end date of the month in which usage ended.",
+ "type": "string",
+ "format": "date-time",
+ "readOnly": true
+ },
+ "subTotal": {
+ "description": "The pre-tax charged amount for the transaction.",
+ "readOnly": true,
+ "$ref": "#/definitions/Amount"
+ },
+ "tax": {
+ "description": "The tax amount applied to the transaction.",
+ "readOnly": true,
+ "$ref": "#/definitions/Amount"
+ },
+ "unitOfMeasure": {
+ "description": "The unit of measure used to bill for the product. For example, compute services are billed per hour.",
+ "type": "string",
+ "readOnly": true
+ },
+ "units": {
+ "description": "The number of units used for a given product.",
+ "type": "number",
+ "readOnly": true
+ },
+ "unitType": {
+ "description": "The description for the unit of measure for a given product.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "Policy": {
+ "description": "A policy.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/Resource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "x-ms-client-flatten": true,
+ "$ref": "#/definitions/PolicyProperties",
+ "title": "Policy properties"
+ }
+ }
+ },
+ "PolicyProperties": {
+ "description": "The properties of a policy.",
+ "properties": {
+ "marketplacePurchases": {
+ "description": "The policy that controls whether Azure marketplace purchases are allowed for a billing profile.",
+ "type": "string",
+ "enum": [
+ "AllAllowed",
+ "OnlyFreeAllowed",
+ "NotAllowed"
+ ],
+ "x-ms-enum": {
+ "name": "MarketplacePurchasesPolicy",
+ "modelAsString": true
+ }
+ },
+ "reservationPurchases": {
+ "description": "The policy that controls whether Azure reservation purchases are allowed for a billing profile.",
+ "type": "string",
+ "enum": [
+ "Allowed",
+ "NotAllowed"
+ ],
+ "x-ms-enum": {
+ "name": "ReservationPurchasesPolicy",
+ "modelAsString": true
+ }
+ },
+ "viewCharges": {
+ "description": "The policy that controls whether users with Azure RBAC access to a subscription can view its charges.",
+ "type": "string",
+ "enum": [
+ "Allowed",
+ "NotAllowed"
+ ],
+ "x-ms-enum": {
+ "name": "ViewChargesPolicy",
+ "modelAsString": true
+ }
+ }
+ }
+ },
+ "CustomerPolicy": {
+ "description": "The customer's Policy.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/Resource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "x-ms-client-flatten": true,
+ "$ref": "#/definitions/CustomerPolicyProperties",
+ "title": "Customer Policy properties"
+ }
+ }
+ },
+ "CustomerPolicyProperties": {
+ "description": "The properties of a customer's policy.",
+ "properties": {
+ "viewCharges": {
+ "description": "The policy that controls whether the users in customer's organization can view charges at pay-as-you-go prices.",
+ "type": "string",
+ "enum": [
+ "Allowed",
+ "NotAllowed"
+ ],
+ "x-ms-enum": {
+ "name": "ViewCharges",
+ "modelAsString": true
+ }
+ }
+ }
+ },
+ "AvailableBalance": {
+ "description": "The latest Azure credit balance. This is the balance available for pay now.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/Resource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "x-ms-client-flatten": true,
+ "$ref": "#/definitions/AvailableBalanceProperties",
+ "title": "Available balance properties"
+ }
+ }
+ },
+ "AvailableBalanceProperties": {
+ "description": "The properties of available balance.",
+ "properties": {
+ "amount": {
+ "description": "Balance amount.",
+ "readOnly": true,
+ "$ref": "#/definitions/Amount"
+ }
+ }
+ },
+ "Amount": {
+ "description": "The amount.",
+ "properties": {
+ "currency": {
+ "description": "The currency for the amount value.",
+ "type": "string",
+ "readOnly": true
+ },
+ "value": {
+ "description": "Amount value.",
+ "type": "number"
+ }
+ }
+ },
+ "Operation": {
+ "description": "A Billing REST API operation.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "Operation name: {provider}/{resource}/{operation}.",
+ "type": "string",
+ "readOnly": true
+ },
+ "display": {
+ "description": "The object that represents the operation.",
+ "properties": {
+ "provider": {
+ "description": "Service provider: Microsoft.Billing.",
+ "type": "string",
+ "readOnly": true
+ },
+ "resource": {
+ "description": "Resource on which the operation is performed such as invoice and billing subscription.",
+ "type": "string",
+ "readOnly": true
+ },
+ "operation": {
+ "description": "Operation type such as read, write and delete.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ }
+ }
+ },
+ "OperationListResult": {
+ "description": "The list of billing operations and a URL link to get the next set of results.",
+ "properties": {
+ "value": {
+ "description": "The list of billing operations supported by the Microsoft.Billing resource provider.",
+ "type": "array",
+ "readOnly": true,
+ "items": {
+ "$ref": "#/definitions/Operation"
+ }
+ },
+ "nextLink": {
+ "description": "URL to get the next set of operation list results if there are any.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "BillingRoleAssignmentListResult": {
+ "description": "The list of role assignments.",
+ "properties": {
+ "value": {
+ "description": "The list of role assignments.",
+ "type": "array",
+ "readOnly": true,
+ "items": {
+ "$ref": "#/definitions/BillingRoleAssignment"
+ }
+ },
+ "nextLink": {
+ "description": "The link (url) to the next page of results.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "BillingRoleAssignment": {
+ "description": "The role assignment",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/Resource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "description": "The properties of the role assignment.",
+ "x-ms-client-flatten": true,
+ "$ref": "#/definitions/BillingRoleAssignmentProperties"
+ }
+ }
+ },
+ "BillingRoleAssignmentProperties": {
+ "description": "The properties of the role assignment.",
+ "properties": {
+ "createdOn": {
+ "description": "The date the role assignment was created.",
+ "type": "string",
+ "readOnly": true
+ },
+ "createdByPrincipalTenantId": {
+ "description": "The tenant Id of the user who created the role assignment.",
+ "type": "string",
+ "readOnly": true
+ },
+ "createdByPrincipalId": {
+ "description": "The principal Id of the user who created the role assignment.",
+ "type": "string",
+ "readOnly": true
+ },
+ "createdByUserEmailAddress": {
+ "description": "The email address of the user who created the role assignment.",
+ "type": "string",
+ "readOnly": true
+ },
+ "principalId": {
+ "description": "The principal id of the user to whom the role was assigned.",
+ "type": "string",
+ "readOnly": true
+ },
+ "principalTenantId": {
+ "description": "The principal tenant id of the user to whom the role was assigned.",
+ "type": "string",
+ "readOnly": true
+ },
+ "roleDefinitionId": {
+ "description": "The ID of the role definition.",
+ "type": "string",
+ "readOnly": true
+ },
+ "scope": {
+ "description": "The scope at which the role was assigned.",
+ "type": "string",
+ "readOnly": true
+ },
+ "userAuthenticationType": {
+ "description": "The authentication type.",
+ "type": "string",
+ "readOnly": true
+ },
+ "userEmailAddress": {
+ "description": "The email address of the user.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "BillingRoleDefinitionListResult": {
+ "description": "The list of role definitions.",
+ "properties": {
+ "value": {
+ "description": "The role definitions.",
+ "type": "array",
+ "readOnly": true,
+ "items": {
+ "$ref": "#/definitions/BillingRoleDefinition"
+ }
+ },
+ "nextLink": {
+ "description": "The link (url) to the next page of results.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "BillingRoleDefinition": {
+ "description": "The properties of a role definition.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/Resource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "description": "The properties of the a role definition.",
+ "x-ms-client-flatten": true,
+ "$ref": "#/definitions/BillingRoleDefinitionProperties"
+ }
+ }
+ },
+ "BillingRoleDefinitionProperties": {
+ "description": "The properties of the a role definition.",
+ "properties": {
+ "description": {
+ "description": "The role description",
+ "type": "string",
+ "readOnly": true
+ },
+ "permissions": {
+ "description": "The billingPermissions the role has",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/BillingPermissionsProperties"
+ }
+ },
+ "roleName": {
+ "description": "The name of the role",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "BillingPermissionsListResult": {
+ "description": "Result of list billingPermissions a caller has on a billing account.",
+ "properties": {
+ "value": {
+ "description": "The list of billingPermissions a caller has on a billing account.",
+ "type": "array",
+ "readOnly": true,
+ "items": {
+ "$ref": "#/definitions/BillingPermissionsProperties"
+ }
+ },
+ "nextLink": {
+ "description": "The link (url) to the next page of results.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "BillingPermissionsProperties": {
+ "description": "The set of allowed action and not allowed actions a caller has on a billing account",
+ "type": "object",
+ "properties": {
+ "actions": {
+ "description": "The set of actions that the caller is allowed to perform.",
+ "type": "array",
+ "readOnly": true,
+ "items": {
+ "$ref": "#/definitions/Action"
+ }
+ },
+ "notActions": {
+ "description": "The set of actions that the caller is not allowed to perform.",
+ "type": "array",
+ "readOnly": true,
+ "items": {
+ "$ref": "#/definitions/NotAction"
+ }
+ }
+ }
+ },
+ "AgreementListResult": {
+ "description": "Result of listing agreements.",
+ "properties": {
+ "value": {
+ "description": "The list of agreements.",
+ "type": "array",
+ "readOnly": true,
+ "items": {
+ "$ref": "#/definitions/Agreement"
+ }
+ },
+ "nextLink": {
+ "description": "The link (url) to the next page of results.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "Agreement": {
+ "description": "An agreement.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/Resource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "description": "The properties of an agreement.",
+ "x-ms-client-flatten": true,
+ "$ref": "#/definitions/AgreementProperties"
+ }
+ }
+ },
+ "AgreementProperties": {
+ "description": "The properties of an agreement.",
+ "properties": {
+ "agreementLink": {
+ "description": "The URL to download the agreement.",
+ "type": "string",
+ "readOnly": true
+ },
+ "category": {
+ "type": "string",
+ "description": "The category of the agreement signed by a customer.",
+ "readOnly": true,
+ "enum": [
+ "MicrosoftCustomerAgreement",
+ "AffiliatePurchaseTerms",
+ "Other"
+ ],
+ "x-ms-enum": {
+ "name": "category",
+ "modelAsString": true
+ }
+ },
+ "acceptanceMode": {
+ "type": "string",
+ "description": "The mode of acceptance for an agreement.",
+ "readOnly": true,
+ "enum": [
+ "ClickToAccept",
+ "ESignEmbedded",
+ "ESignOffline"
+ ],
+ "x-ms-enum": {
+ "name": "acceptanceMode",
+ "modelAsString": true
+ }
+ },
+ "effectiveDate": {
+ "description": "The date from which the agreement is effective.",
+ "type": "string",
+ "format": "date-time",
+ "readOnly": true
+ },
+ "expirationDate": {
+ "description": "The date when the agreement expires.",
+ "type": "string",
+ "format": "date-time",
+ "readOnly": true
+ },
+ "participants": {
+ "description": "The list of participants that participates in acceptance of an agreement.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/Participants"
+ }
+ },
+ "status": {
+ "description": "The current status of the agreement.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "Participants": {
+ "description": "The details about a participant.",
+ "properties": {
+ "status": {
+ "description": "The acceptance status of the participant.",
+ "type": "string",
+ "readOnly": true
+ },
+ "statusDate": {
+ "description": "The date when the status got changed.",
+ "type": "string",
+ "format": "date-time",
+ "readOnly": true
+ },
+ "email": {
+ "description": "The email address of the participant.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "Action": {
+ "description": "The action the caller is allowed to perform.",
+ "type": "string",
+ "readOnly": true
+ },
+ "NotAction": {
+ "description": "The set of actions that the caller is not allowed to perform.",
+ "type": "string",
+ "readOnly": true
+ }
+ },
+ "parameters": {
+ "apiVersionParameter": {
+ "name": "api-version",
+ "in": "query",
+ "required": true,
+ "type": "string",
+ "description": "The version of the API to be used with the client request. The current version is 2020-05-01."
+ },
+ "subscriptionIdParameter": {
+ "name": "subscriptionId",
+ "in": "path",
+ "description": "The ID that uniquely identifies an Azure subscription.",
+ "required": true,
+ "type": "string"
+ },
+ "billingAccountNameParameter": {
+ "name": "billingAccountName",
+ "in": "path",
+ "description": "The ID that uniquely identifies a billing account.",
+ "required": true,
+ "type": "string",
+ "x-ms-parameter-location": "method"
+ },
+ "invoiceSectionNameParameter": {
+ "name": "invoiceSectionName",
+ "in": "path",
+ "description": "The ID that uniquely identifies an invoice section.",
+ "required": true,
+ "type": "string",
+ "x-ms-parameter-location": "method"
+ },
+ "enrollmentAccountNameParameter": {
+ "name": "enrollmentAccountName",
+ "in": "path",
+ "description": "The ID that uniquely identifies an enrollment account.",
+ "required": true,
+ "type": "string",
+ "x-ms-parameter-location": "method"
+ },
+ "departmentNameParameter": {
+ "name": "departmentName",
+ "in": "path",
+ "description": "The ID that uniquely identifies a department.",
+ "required": true,
+ "type": "string",
+ "x-ms-parameter-location": "method"
+ },
+ "instructionNameParameter": {
+ "name": "instructionName",
+ "in": "path",
+ "description": "Instruction Name.",
+ "required": true,
+ "type": "string",
+ "x-ms-parameter-location": "method"
+ },
+ "billingProfileNameParameter": {
+ "name": "billingProfileName",
+ "in": "path",
+ "description": "The ID that uniquely identifies a billing profile.",
+ "required": true,
+ "type": "string",
+ "x-ms-parameter-location": "method"
+ },
+ "operationIdParameter": {
+ "name": "operationId",
+ "in": "path",
+ "description": "Operation Id.",
+ "required": true,
+ "type": "string",
+ "x-ms-parameter-location": "method"
+ },
+ "billingRoleDefinitionNameParameter": {
+ "name": "billingRoleDefinitionName",
+ "in": "path",
+ "description": "The ID that uniquely identifies a role definition.",
+ "required": true,
+ "type": "string",
+ "x-ms-parameter-location": "method"
+ },
+ "billingRoleAssignmentNameParameter": {
+ "name": "billingRoleAssignmentName",
+ "in": "path",
+ "description": "The ID that uniquely identifies a role assignment.",
+ "required": true,
+ "type": "string",
+ "x-ms-parameter-location": "method"
+ },
+ "invoiceNameParameter": {
+ "name": "invoiceName",
+ "in": "path",
+ "description": "The ID that uniquely identifies an invoice.",
+ "required": true,
+ "type": "string",
+ "x-ms-parameter-location": "method"
+ },
+ "productNameParameter": {
+ "name": "productName",
+ "in": "path",
+ "description": "The ID that uniquely identifies a product.",
+ "required": true,
+ "type": "string",
+ "x-ms-parameter-location": "method"
+ },
+ "agreementNameParameter": {
+ "name": "agreementName",
+ "in": "path",
+ "description": "The ID that uniquely identifies an agreement.",
+ "required": true,
+ "type": "string",
+ "x-ms-parameter-location": "method"
+ },
+ "transactionNameParameter": {
+ "name": "transactionName",
+ "in": "path",
+ "description": "The ID that uniquely identifies a transaction.",
+ "required": true,
+ "type": "string",
+ "x-ms-parameter-location": "method"
+ },
+ "customerNameParameter": {
+ "name": "customerName",
+ "in": "path",
+ "description": "The ID that uniquely identifies a customer.",
+ "required": true,
+ "type": "string",
+ "x-ms-parameter-location": "method"
+ }
+ },
+ "security": [
+ {
+ "azure_auth": [
+ "user_impersonation"
+ ]
+ }
+ ],
+ "securityDefinitions": {
+ "azure_auth": {
+ "type": "oauth2",
+ "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize",
+ "flow": "implicit",
+ "description": "Azure Active Directory OAuth2 Flow.",
+ "scopes": {
+ "user_impersonation": "impersonate your user account"
+ }
+ }
+ }
+}
diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/AddressInvalid.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/AddressInvalid.json
new file mode 100644
index 000000000000..d65cc255d3f3
--- /dev/null
+++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/AddressInvalid.json
@@ -0,0 +1,36 @@
+{
+ "parameters": {
+ "api-version": "2020-05-01",
+ "address": {
+ "addressLine1": "1 Test",
+ "city": "bellevue",
+ "region": "wa",
+ "postalCode": "12345",
+ "country": "us"
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "status": "Invalid",
+ "suggestedAddresses": [
+ {
+ "country": "US",
+ "region": "WA",
+ "city": "Bellevue",
+ "addressLine1": "1 Test Address",
+ "postalCode": "98052"
+ },
+ {
+ "country": "US",
+ "region": "WA",
+ "city": "Bellevue",
+ "addressLine1": "1 Test Address",
+ "postalCode": "12345-0000"
+ }
+ ],
+ "validationMessage": "Invalid address"
+ }
+ }
+ }
+}
diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/AddressValid.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/AddressValid.json
new file mode 100644
index 000000000000..8f56faee38da
--- /dev/null
+++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/AddressValid.json
@@ -0,0 +1,28 @@
+{
+ "parameters": {
+ "api-version": "2020-05-01",
+ "address": {
+ "addressLine1": "1 Test Address",
+ "city": "bellevue",
+ "region": "wa",
+ "postalCode": "12345",
+ "country": "us"
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "status": "Valid",
+ "suggestedAddresses": [
+ {
+ "country": "US",
+ "region": "WA",
+ "city": "Bellevue",
+ "addressLine1": "1 Test Address",
+ "postalCode": "12345-0000"
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/AgreementByName.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/AgreementByName.json
new file mode 100644
index 000000000000..0b7f7f2c21c5
--- /dev/null
+++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/AgreementByName.json
@@ -0,0 +1,36 @@
+{
+ "parameters": {
+ "api-version": "2020-05-01",
+ "billingAccountName": "{billingAccountName}",
+ "agreementName": "{agreementName}"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/agreements/{agreementName}",
+ "name": "{agreementName}",
+ "type": "Microsoft.Billing/billingAccounts/agreements",
+ "properties": {
+ "agreementLink": "https://agreementuri1.com",
+ "category": "MicrosoftCustomerAgreement",
+ "acceptanceMode": "ClickToAccept",
+ "effectiveDate": "2018-12-05T00:00:00Z",
+ "expirationDate": "2018-12-05T00:00:00Z",
+ "participants": [
+ {
+ "status": "Accepted",
+ "statusDate": "2018-11-01T00:00:00Z",
+ "email": "abc@contoso.com"
+ },
+ {
+ "status": "Declined",
+ "statusDate": "2018-11-02T00:00:00Z",
+ "email": "xyz@contoso.com"
+ }
+ ],
+ "status": "Published"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/AgreementsListByBillingAccount.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/AgreementsListByBillingAccount.json
new file mode 100644
index 000000000000..9be6ba760cbc
--- /dev/null
+++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/AgreementsListByBillingAccount.json
@@ -0,0 +1,59 @@
+{
+ "parameters": {
+ "api-version": "2020-05-01",
+ "billingAccountName": "{billingAccountName}"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/agreements/Agreement1",
+ "name": "Agreement1",
+ "type": "Microsoft.Billing/billingAccounts/agreements",
+ "properties": {
+ "agreementLink": "https://agreementuri1.com",
+ "category": "MicrosoftCustomerAgreement",
+ "acceptanceMode": "ClickToAccept",
+ "effectiveDate": "2018-12-05T00:00:00Z",
+ "expirationDate": "2018-12-05T00:00:00Z",
+ "participants": [
+ {
+ "status": "Accepted",
+ "statusDate": "2018-11-01T00:00:00Z",
+ "email": "abc@contoso.com"
+ },
+ {
+ "status": "Declined",
+ "statusDate": "2018-11-02T00:00:00Z",
+ "email": "xtz@contoso.com"
+ }
+ ],
+ "status": "Published"
+ }
+ },
+ {
+ "id": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/agreements/Agreement2",
+ "name": "Agreement2",
+ "type": "Microsoft.Billing/billingAccounts/agreements",
+ "properties": {
+ "agreementLink": "https://agreementuri2.com",
+ "category": "MicrosoftCustomerAgreement",
+ "acceptanceMode": "ESignEmbedded",
+ "effectiveDate": "2018-12-05T00:00:00Z",
+ "expirationDate": "2018-12-05T00:00:00Z",
+ "participants": [
+ {
+ "status": "Unknown",
+ "statusDate": "2018-11-01T00:00:00Z",
+ "email": "abc@contoso.com"
+ }
+ ],
+ "status": "PendingSignature"
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/AvailableBalanceByBillingProfile.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/AvailableBalanceByBillingProfile.json
new file mode 100644
index 000000000000..03063a39e8d0
--- /dev/null
+++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/AvailableBalanceByBillingProfile.json
@@ -0,0 +1,22 @@
+{
+ "parameters": {
+ "api-version": "2020-05-01",
+ "billingAccountName": "{billingAccountName}",
+ "billingProfileName": "{billingProfileName}"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/availableBalance/default",
+ "name": "default",
+ "type": "Microsoft.Billing/billingAccounts/billingProfiles/availableBalance",
+ "properties": {
+ "amount": {
+ "currency": "USD",
+ "value": 500.00
+ }
+ }
+ }
+ }
+ }
+}
diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingAccount.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingAccount.json
new file mode 100644
index 000000000000..30462b5d9d7e
--- /dev/null
+++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingAccount.json
@@ -0,0 +1,22 @@
+{
+ "parameters": {
+ "api-version": "2020-05-01",
+ "billingAccountName": "{billingAccountName}"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}",
+ "name": "{billingAccountName}",
+ "type": "Microsoft.Billing/billingAccounts",
+ "properties": {
+ "displayName": "Test Account",
+ "agreementType": "MicrosoftCustomerAgreement",
+ "accountStatus": "Active",
+ "accountType": "Enterprise",
+ "hasReadAccess": true
+ }
+ }
+ }
+ }
+}
diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingAccountInvoicesList.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingAccountInvoicesList.json
new file mode 100644
index 000000000000..843c4e2bc85a
--- /dev/null
+++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingAccountInvoicesList.json
@@ -0,0 +1,150 @@
+{
+ "parameters": {
+ "api-version": "2020-05-01",
+ "billingAccountName": "{billingAccountName}",
+ "periodStartDate": "2018-01-01",
+ "periodEndDate": "2018-06-30"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoices/1383723",
+ "name": "1383723",
+ "type": "Microsoft.Billing/billingAccounts/invoices",
+ "properties": {
+ "dueDate": "2018-01-16T17:32:28Z",
+ "invoiceDate": "2018-01-01T17:32:28Z",
+ "status": "Due",
+ "amountDue": {
+ "currency": "USD",
+ "value": 8.53
+ },
+ "billedAmount": {
+ "currency": "USD",
+ "value": 33.99
+ },
+ "azurePrepaymentApplied": {
+ "currency": "USD",
+ "value": 25.46
+ },
+ "creditAmount": {
+ "currency": "USD",
+ "value": 1.00
+ },
+ "freeAzureCreditApplied": {
+ "currency": "USD",
+ "value": 0.00
+ },
+ "subTotal": {
+ "currency": "USD",
+ "value": 33.99
+ },
+ "taxAmount": {
+ "currency": "USD",
+ "value": 0.00
+ },
+ "totalAmount": {
+ "currency": "USD",
+ "value": 7.53
+ },
+ "invoicePeriodStartDate": "2018-01-01T17:32:28Z",
+ "invoicePeriodEndDate": "2018-01-15T17:32:28Z",
+ "isMonthlyInvoice": false,
+ "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/11000000-0000-0000-0000-000000000000",
+ "billingProfileDisplayName": "Contoso Operations Billing",
+ "purchaseOrderNumber": "123456",
+ "documents": [
+ {
+ "kind": "Invoice",
+ "url": "https://microsoft.com/invoice.pdf",
+ "source": "DRS"
+ }
+ ],
+ "payments": [
+ {
+ "date": "2018-01-14T17:32:28Z",
+ "paymentType": "credited",
+ "amount": {
+ "currency": "USD",
+ "value": 1.00
+ },
+ "paymentMethodFamily": "CreditCard",
+ "paymentMethodType": "visa"
+ }
+ ]
+ }
+ },
+ {
+ "id": "providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoices/1383724",
+ "name": "1383724",
+ "type": "Microsoft.Billing/billingAccounts/invoices",
+ "properties": {
+ "dueDate": "2018-03-01T17:32:28Z",
+ "invoiceDate": "2018-02-01T17:32:28Z",
+ "status": "PastDue",
+ "amountDue": {
+ "currency": "USD",
+ "value": 16.53
+ },
+ "billedAmount": {
+ "currency": "USD",
+ "value": 33.99
+ },
+ "azurePrepaymentApplied": {
+ "currency": "USD",
+ "value": 15.46
+ },
+ "creditAmount": {
+ "currency": "USD",
+ "value": 2.00
+ },
+ "freeAzureCreditApplied": {
+ "currency": "USD",
+ "value": 0.00
+ },
+ "subTotal": {
+ "currency": "USD",
+ "value": 33.99
+ },
+ "taxAmount": {
+ "currency": "USD",
+ "value": 0.00
+ },
+ "totalAmount": {
+ "currency": "USD",
+ "value": 16.53
+ },
+ "invoicePeriodStartDate": "2018-02-01T17:32:28Z",
+ "invoicePeriodEndDate": "2018-02-28T17:32:28Z",
+ "isMonthlyInvoice": true,
+ "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/11000000-0000-0000-0000-000000000000",
+ "billingProfileDisplayName": "Contoso Operations Billing",
+ "purchaseOrderNumber": "123456",
+ "documents": [
+ {
+ "kind": "TaxReceipt",
+ "url": "https://microsoft.com/taxreceipt.pdf",
+ "source": "DRS"
+ }
+ ],
+ "payments": [
+ {
+ "date": "2018-01-14T17:32:28Z",
+ "paymentType": "credited",
+ "amount": {
+ "currency": "USD",
+ "value": 2.00
+ },
+ "paymentMethodFamily": "CreditCard",
+ "paymentMethodType": "visa"
+ }
+ ]
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingAccountPermissionsList.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingAccountPermissionsList.json
new file mode 100644
index 000000000000..27bb3da53918
--- /dev/null
+++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingAccountPermissionsList.json
@@ -0,0 +1,39 @@
+{
+ "parameters": {
+ "api-version": "2020-05-01",
+ "billingAccountName": "{billingAccountName}"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "actions": [
+ "10000000-aaaa-bbbb-cccc-200000000006",
+ "10000000-aaaa-bbbb-cccc-200000000003",
+ "10000000-aaaa-bbbb-cccc-200000000002",
+ "10000000-aaaa-bbbb-cccc-200000000001",
+ "10000000-aaaa-bbbb-cccc-200000000000",
+ "30000000-aaaa-bbbb-cccc-200000000007",
+ "30000000-aaaa-bbbb-cccc-200000000004",
+ "30000000-aaaa-bbbb-cccc-200000000015",
+ "20000000-aaaa-bbbb-cccc-200000000002",
+ "30000000-aaaa-bbbb-cccc-200000000009",
+ "40000000-aaaa-bbbb-cccc-200000000000",
+ "30000000-aaaa-bbbb-cccc-200000000000",
+ "20000000-aaaa-bbbb-cccc-200000000000",
+ "10000000-aaaa-bbbb-cccc-200000000008",
+ "10000000-aaaa-bbbb-cccc-200000000007",
+ "40000000-aaaa-bbbb-cccc-200000000008",
+ "40000000-aaaa-bbbb-cccc-200000000006",
+ "40000000-aaaa-bbbb-cccc-200000000007",
+ "30000000-aaaa-bbbb-cccc-200000000010",
+ "30000000-aaaa-bbbb-cccc-200000000001"
+ ],
+ "notActions": []
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingAccountRoleAssignment.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingAccountRoleAssignment.json
new file mode 100644
index 000000000000..17693c2027f8
--- /dev/null
+++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingAccountRoleAssignment.json
@@ -0,0 +1,25 @@
+{
+ "parameters": {
+ "api-version": "2020-05-01",
+ "billingAccountName": "{billingAccountName}",
+ "billingRoleAssignmentName": "{billingRoleAssignmentId}"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingRoleAssignments/10000000-aaaa-bbbb-cccc-100000000000_6fd330f6-7d26-4aff-b9cf-7bd699f965b9",
+ "name": "10000000-aaaa-bbbb-cccc-100000000000_6fd330f6-7d26-4aff-b9cf-7bd699f965b9",
+ "properties": {
+ "createdOn": "2018-06-21T21:34:12.2363515+00:00",
+ "createdByPrincipalTenantId": "7ca289b9-c32d-4f01-8566-7ff93261d76f",
+ "createdByPrincipalId": "10000000-aaaa-bbbb-cccc-3fd5ff9d6aa1",
+ "principalId": "6fd330f6-7d26-4aff-b9cf-7bd699f965b9",
+ "scope": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}",
+ "principalTenantId": "10000000-aaaa-bbbb-cccc-2d7cd011db47",
+ "roleDefinitionId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingRoleDefinitions/50000000-aaaa-bbbb-cccc-100000000002"
+ },
+ "type": "Microsoft.Billing/billingAccounts/billingRoleAssignments"
+ }
+ }
+ }
+}
diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingAccountRoleAssignmentDelete.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingAccountRoleAssignmentDelete.json
new file mode 100644
index 000000000000..2d1a0b6bdc87
--- /dev/null
+++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingAccountRoleAssignmentDelete.json
@@ -0,0 +1,25 @@
+{
+ "parameters": {
+ "api-version": "2020-05-01",
+ "billingAccountName": "{billingAccountName}",
+ "billingRoleAssignmentName": "{billingRoleAssignmentName}"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingRoleAssignments/10000000-aaaa-bbbb-cccc-100000000000_6fd330f6-7d26-4aff-b9cf-7bd699f965b9",
+ "name": "10000000-aaaa-bbbb-cccc-100000000000_6fd330f6-7d26-4aff-b9cf-7bd699f965b9",
+ "type": "Microsoft.Billing/billingAccounts/billingRoleAssignments",
+ "properties": {
+ "createdOn": "2018-06-21T21:34:12.2363515+00:00",
+ "createdByPrincipalTenantId": "7ca289b9-c32d-4f01-8566-7ff93261d76f",
+ "createdByPrincipalId": "10000000-aaaa-bbbb-cccc-3fd5ff9d6aa1",
+ "principalId": "6fd330f6-7d26-4aff-b9cf-7bd699f965b9",
+ "scope": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}",
+ "principalTenantId": "10000000-aaaa-bbbb-cccc-2d7cd011db47",
+ "roleDefinitionId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingRoleDefinitions/50000000-aaaa-bbbb-cccc-100000000002"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingAccountRoleAssignmentList.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingAccountRoleAssignmentList.json
new file mode 100644
index 000000000000..9d4e484d6671
--- /dev/null
+++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingAccountRoleAssignmentList.json
@@ -0,0 +1,42 @@
+{
+ "parameters": {
+ "api-version": "2020-05-01",
+ "billingAccountName": "{billingAccountName}"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingRoleAssignments/10000000-aaaa-bbbb-cccc-100000000000_6fd330f6-7d26-4aff-b9cf-7bd699f965b9",
+ "name": "10000000-aaaa-bbbb-cccc-100000000000_6fd330f6-7d26-4aff-b9cf-7bd699f965b9",
+ "properties": {
+ "createdOn": "2018-06-21T21:34:12.2363515+00:00",
+ "createdByPrincipalTenantId": "7ca289b9-c32d-4f01-8566-7ff93261d76f",
+ "createdByPrincipalId": "10000000-aaaa-bbbb-cccc-3fd5ff9d6aa1",
+ "principalId": "6fd330f6-7d26-4aff-b9cf-7bd699f965b9",
+ "scope": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}",
+ "principalTenantId": "10000000-aaaa-bbbb-cccc-2d7cd011db47",
+ "roleDefinitionId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingRoleDefinitions/50000000-aaaa-bbbb-cccc-100000000002"
+ },
+ "type": "Microsoft.Billing/billingAccounts/billingRoleAssignments"
+ },
+ {
+ "id": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingRoleAssignments/10000000-aaaa-bbbb-cccc-100000000000_b1839933-b3ac-42ca-8112-d29c43f3ab47",
+ "name": "10000000-aaaa-bbbb-cccc-100000000000_b1839933-b3ac-42ca-8112-d29c43f3ab47",
+ "properties": {
+ "createdOn": "2018-06-21T21:58:19.9073876+00:00",
+ "createdByPrincipalTenantId": "7ca289b9-c32d-4f01-8566-7ff93261d76f",
+ "createdByPrincipalId": "10000000-aaaa-bbbb-cccc-3fd5ff9d6aa1",
+ "principalId": "b1839933-b3ac-42ca-8112-d29c43f3ab47",
+ "scope": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}",
+ "principalTenantId": "10000000-aaaa-bbbb-cccc-2d7cd011db47",
+ "roleDefinitionId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingRoleDefinitions/50000000-aaaa-bbbb-cccc-100000000002"
+ },
+ "type": "Microsoft.Billing/billingAccounts/billingRoleAssignments"
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingAccountRoleDefinition.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingAccountRoleDefinition.json
new file mode 100644
index 000000000000..9912b5ea4a17
--- /dev/null
+++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingAccountRoleDefinition.json
@@ -0,0 +1,47 @@
+{
+ "parameters": {
+ "api-version": "2020-05-01",
+ "billingAccountName": "{billingAccountName}",
+ "billingRoleDefinitionName": "{billingRoleDefinitionName}"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingRoleDefinitions/{billingRoleDefinitionName}",
+ "name": "{billingRoleDefinitionName}",
+ "properties": {
+ "description": "The Owner role gives the user all permissions including access management rights to the billing account.",
+ "permissions": [
+ {
+ "actions": [
+ "10000000-aaaa-bbbb-cccc-200000000000",
+ "10000000-aaaa-bbbb-cccc-200000000008",
+ "10000000-aaaa-bbbb-cccc-200000000001",
+ "10000000-aaaa-bbbb-cccc-200000000002",
+ "10000000-aaaa-bbbb-cccc-200000000003",
+ "10000000-aaaa-bbbb-cccc-200000000006",
+ "10000000-aaaa-bbbb-cccc-200000000007",
+ "20000000-aaaa-bbbb-cccc-200000000000",
+ "30000000-aaaa-bbbb-cccc-200000000000",
+ "40000000-aaaa-bbbb-cccc-200000000000",
+ "30000000-aaaa-bbbb-cccc-200000000009",
+ "20000000-aaaa-bbbb-cccc-200000000002",
+ "30000000-aaaa-bbbb-cccc-200000000015",
+ "30000000-aaaa-bbbb-cccc-200000000004",
+ "30000000-aaaa-bbbb-cccc-200000000007",
+ "30000000-aaaa-bbbb-cccc-200000000001",
+ "30000000-aaaa-bbbb-cccc-200000000010",
+ "40000000-aaaa-bbbb-cccc-200000000007",
+ "40000000-aaaa-bbbb-cccc-200000000006",
+ "40000000-aaaa-bbbb-cccc-200000000008"
+ ],
+ "notActions": []
+ }
+ ],
+ "roleName": "Billing acount owner"
+ },
+ "type": "Microsoft.Billing/billingAccounts/billingRoleDefinitions"
+ }
+ }
+ }
+}
diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingAccountRoleDefinitionsList.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingAccountRoleDefinitionsList.json
new file mode 100644
index 000000000000..1ccbc73a3065
--- /dev/null
+++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingAccountRoleDefinitionsList.json
@@ -0,0 +1,127 @@
+{
+ "parameters": {
+ "api-version": "2020-05-01",
+ "billingAccountName": "{billingAccountName}"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingRoleDefinitions/10000000-aaaa-bbbb-cccc-100000000000",
+ "name": "10000000-aaaa-bbbb-cccc-100000000000",
+ "properties": {
+ "description": "The Owner role gives the user all permissions including access management rights to the billing account.",
+ "permissions": [
+ {
+ "actions": [
+ "10000000-aaaa-bbbb-cccc-200000000000",
+ "10000000-aaaa-bbbb-cccc-200000000008",
+ "10000000-aaaa-bbbb-cccc-200000000001",
+ "10000000-aaaa-bbbb-cccc-200000000002",
+ "10000000-aaaa-bbbb-cccc-200000000003",
+ "10000000-aaaa-bbbb-cccc-200000000006",
+ "10000000-aaaa-bbbb-cccc-200000000007",
+ "20000000-aaaa-bbbb-cccc-200000000000",
+ "30000000-aaaa-bbbb-cccc-200000000000",
+ "40000000-aaaa-bbbb-cccc-200000000000",
+ "30000000-aaaa-bbbb-cccc-200000000009",
+ "20000000-aaaa-bbbb-cccc-200000000002",
+ "30000000-aaaa-bbbb-cccc-200000000015",
+ "30000000-aaaa-bbbb-cccc-200000000004",
+ "30000000-aaaa-bbbb-cccc-200000000007",
+ "30000000-aaaa-bbbb-cccc-200000000001",
+ "30000000-aaaa-bbbb-cccc-200000000010",
+ "40000000-aaaa-bbbb-cccc-200000000007",
+ "40000000-aaaa-bbbb-cccc-200000000006",
+ "40000000-aaaa-bbbb-cccc-200000000008"
+ ],
+ "notActions": []
+ }
+ ],
+ "roleName": "Billing account owner"
+ },
+ "type": "Microsoft.Billing/billingAccounts/billingRoleDefinitions"
+ },
+ {
+ "id": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingRoleDefinitions/10000000-aaaa-bbbb-cccc-100000000001",
+ "name": "10000000-aaaa-bbbb-cccc-100000000001",
+ "properties": {
+ "description": "The Contributor role give the user all permissions except access management rights to the billing account.",
+ "permissions": [
+ {
+ "actions": [
+ "10000000-aaaa-bbbb-cccc-200000000008",
+ "10000000-aaaa-bbbb-cccc-200000000001",
+ "10000000-aaaa-bbbb-cccc-200000000002",
+ "10000000-aaaa-bbbb-cccc-200000000003",
+ "10000000-aaaa-bbbb-cccc-200000000006",
+ "10000000-aaaa-bbbb-cccc-200000000007",
+ "30000000-aaaa-bbbb-cccc-200000000009",
+ "20000000-aaaa-bbbb-cccc-200000000002",
+ "30000000-aaaa-bbbb-cccc-200000000015",
+ "30000000-aaaa-bbbb-cccc-200000000004",
+ "30000000-aaaa-bbbb-cccc-200000000007",
+ "30000000-aaaa-bbbb-cccc-200000000001",
+ "30000000-aaaa-bbbb-cccc-200000000010",
+ "40000000-aaaa-bbbb-cccc-200000000007",
+ "40000000-aaaa-bbbb-cccc-200000000006",
+ "40000000-aaaa-bbbb-cccc-200000000008"
+ ],
+ "notActions": []
+ }
+ ],
+ "roleName": "Billing account contributor"
+ },
+ "type": "Microsoft.Billing/billingAccounts/billingRoleDefinitions"
+ },
+ {
+ "id": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingRoleDefinitions/10000000-aaaa-bbbb-cccc-100000000002",
+ "name": "10000000-aaaa-bbbb-cccc-100000000002",
+ "properties": {
+ "description": "The Reader role gives the user read only access to the billing account.",
+ "permissions": [
+ {
+ "actions": [
+ "10000000-aaaa-bbbb-cccc-200000000008",
+ "10000000-aaaa-bbbb-cccc-200000000003",
+ "20000000-aaaa-bbbb-cccc-200000000002",
+ "30000000-aaaa-bbbb-cccc-200000000015",
+ "30000000-aaaa-bbbb-cccc-200000000004",
+ "30000000-aaaa-bbbb-cccc-200000000007",
+ "30000000-aaaa-bbbb-cccc-200000000001",
+ "30000000-aaaa-bbbb-cccc-200000000010",
+ "40000000-aaaa-bbbb-cccc-200000000007",
+ "40000000-aaaa-bbbb-cccc-200000000006",
+ "40000000-aaaa-bbbb-cccc-200000000008"
+ ],
+ "notActions": []
+ }
+ ],
+ "roleName": "Billing account reader"
+ },
+ "type": "Microsoft.Billing/billingAccounts/billingRoleDefinitions"
+ },
+ {
+ "id": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingRoleDefinitions/10000000-aaaa-bbbb-cccc-100000000003",
+ "name": "10000000-aaaa-bbbb-cccc-100000000003",
+ "properties": {
+ "description": "The Signatory role can sign agreements on behalf of the customer.",
+ "permissions": [
+ {
+ "actions": [
+ "10000000-aaaa-bbbb-cccc-200000000002",
+ "10000000-aaaa-bbbb-cccc-200000000003"
+ ],
+ "notActions": []
+ }
+ ],
+ "roleName": "Signatory"
+ },
+ "type": "Microsoft.Billing/billingAccounts/billingRoleDefinitions"
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingAccountWithExpand.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingAccountWithExpand.json
new file mode 100644
index 000000000000..fc45287d5e7a
--- /dev/null
+++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingAccountWithExpand.json
@@ -0,0 +1,159 @@
+{
+ "parameters": {
+ "api-version": "2020-05-01",
+ "billingAccountName": "{billingAccountName}",
+ "$expand": "soldTo,billingProfiles,billingProfiles/invoiceSections"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}",
+ "name": "{billingAccountName}",
+ "type": "Microsoft.Billing/billingAccounts",
+ "properties": {
+ "displayName": "Test Account 1",
+ "agreementType": "MicrosoftCustomerAgreement",
+ "accountStatus": "Active",
+ "soldTo": {
+ "companyName": "Contoso",
+ "firstName": "Test",
+ "lastName": "User",
+ "addressLine1": "Test Address",
+ "addressLine2": "Test Address",
+ "addressLine3": "Test Address",
+ "city": "City",
+ "postalCode": "00000",
+ "region": "WA",
+ "country": "US",
+ "email": "abc@contoso.com",
+ "phoneNumber": "000-000-0000"
+ },
+ "accountType": "Enterprise",
+ "billingProfiles": {
+ "hasMoreResults": true,
+ "value": [
+ {
+ "id": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/11000000-0000-0000-0000-000000000000",
+ "name": "11000000-0000-0000-0000-000000000000",
+ "type": "Microsoft.Billing/billingAccounts/billingProfiles",
+ "properties": {
+ "displayName": "BillingProfile1",
+ "billTo": {
+ "companyName": "Contoso",
+ "firstName": "Test",
+ "lastName": "User",
+ "addressLine1": "Test Address1",
+ "addressLine2": "Test Address2",
+ "addressLine3": "Test Address3",
+ "city": "City",
+ "postalCode": "00000",
+ "region": "WA",
+ "country": "US",
+ "email": "abc@contoso.com",
+ "phoneNumber": "000-000-0000"
+ },
+ "currency": "USD",
+ "enabledAzurePlans": [
+ {
+ "skuId": "0001",
+ "skuDescription": "Microsoft Azure Plan"
+ },
+ {
+ "skuId": "0002",
+ "skuDescription": "Microsoft Azure Plan for DevTest"
+ }
+ ],
+ "invoiceDay": 5,
+ "invoiceEmailOptIn": true,
+ "poNumber": "ABC12345",
+ "hasReadAccess": true,
+ "systemId": "1XXX-11XX-XX1-XXXX-XXX",
+ "status": "Warned",
+ "statusReasonCode": "PastDue",
+ "spendingLimit": "On",
+ "invoiceSections": {
+ "hasMoreResults": true,
+ "value": [
+ {
+ "id": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/11000000-0000-0000-0000-000000000000/invoiceSections/invoiceSectionId1",
+ "name": "invoiceSectionId1",
+ "type": "Microsoft.Billing/billingAccounts/billingProfiles/invoiceSections",
+ "properties": {
+ "displayName": "invoiceSectionName1",
+ "labels": {
+ "pcCode": "A123456",
+ "costCategory": "Support"
+ },
+ "systemId": "9XXX-11XX-XX1-XXXX-XXX"
+ }
+ }
+ ]
+ }
+ }
+ },
+ {
+ "id": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/11000000-0000-0000-0000-000000000001",
+ "name": "11000000-0000-0000-0000-000000000001",
+ "type": "Microsoft.Billing/billingAccounts/billingProfiles",
+ "properties": {
+ "displayName": "BillingProfile2",
+ "billTo": {
+ "companyName": "Contoso",
+ "firstName": "Test",
+ "lastName": "User",
+ "addressLine1": "Test Address1",
+ "addressLine2": "Test Address2",
+ "addressLine3": "Test Address3",
+ "city": "City",
+ "postalCode": "00000",
+ "region": "WA",
+ "country": "US",
+ "email": "abc@contoso.com",
+ "phoneNumber": "000-000-0000"
+ },
+ "currency": "USD",
+ "enabledAzurePlans": [
+ {
+ "skuId": "0001",
+ "skuDescription": "Microsoft Azure Plan"
+ },
+ {
+ "skuId": "0002",
+ "skuDescription": "Microsoft Azure Plan for DevTest"
+ }
+ ],
+ "invoiceDay": 5,
+ "invoiceEmailOptIn": true,
+ "poNumber": "ABC12345",
+ "hasReadAccess": true,
+ "systemId": "2XXX-22XX-XX1-XXXX-XXX",
+ "status": "Active",
+ "spendingLimit": "Off",
+ "invoiceSections": {
+ "hasMoreResults": true,
+ "value": [
+ {
+ "id": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/11000000-0000-0000-0000-000000000001/invoiceSections/invoiceSectionId2",
+ "name": "invoiceSectionId2",
+ "type": "Microsoft.Billing/billingAccounts/billingProfiles/invoiceSections",
+ "properties": {
+ "displayName": "invoiceSectionName2",
+ "labels": {
+ "pcCode": "Z223456",
+ "costCategory": "Marketing"
+ },
+ "systemId": "9XXX-22XX-XX1-XXXX-XXX"
+ }
+ }
+ ]
+ }
+ }
+ }
+ ]
+ },
+ "hasReadAccess": true
+ }
+ }
+ }
+ }
+}
diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingAccountsList.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingAccountsList.json
new file mode 100644
index 000000000000..ca8792baf70d
--- /dev/null
+++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingAccountsList.json
@@ -0,0 +1,50 @@
+{
+ "parameters": {
+ "api-version": "2020-05-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000_00000000-0000-0000-0000-000000000000",
+ "name": "00000000-0000-0000-0000-000000000000_00000000-0000-0000-0000-000000000000",
+ "type": "Microsoft.Billing/billingAccounts",
+ "properties": {
+ "displayName": "Test Account 1",
+ "agreementType": "MicrosoftCustomerAgreement",
+ "accountStatus": "Active",
+ "accountType": "Enterprise",
+ "hasReadAccess": true
+ }
+ },
+ {
+ "id": "/providers/Microsoft.Billing/billingAccounts/10000000-0000-0000-0000-000000000001_00000000-0000-0000-0000-000000000000",
+ "name": "10000000-0000-0000-0000-000000000001_00000000-0000-0000-0000-000000000000",
+ "type": "Microsoft.Billing/billingAccounts",
+ "properties": {
+ "displayName": "Test Account 2",
+ "agreementType": "MicrosoftCustomerAgreement",
+ "accountStatus": "Active",
+ "soldTo": null,
+ "accountType": "Enterprise",
+ "hasReadAccess": true
+ }
+ },
+ {
+ "id": "/providers/Microsoft.Billing/billingAccounts/20000000-0000-0000-0000-000000000002_00000000-0000-0000-0000-000000000000",
+ "name": "20000000-0000-0000-0000-000000000002_00000000-0000-0000-0000-000000000000",
+ "type": "Microsoft.Billing/billingAccounts",
+ "properties": {
+ "displayName": "Test Account 3",
+ "agreementType": "MicrosoftCustomerAgreement",
+ "accountStatus": "Active",
+ "accountType": "Enterprise",
+ "hasReadAccess": true
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingAccountsListWithExpand.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingAccountsListWithExpand.json
new file mode 100644
index 000000000000..840377864089
--- /dev/null
+++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingAccountsListWithExpand.json
@@ -0,0 +1,337 @@
+{
+ "parameters": {
+ "api-version": "2020-05-01",
+ "$expand": "soldTo,billingProfiles,billingProfiles/invoiceSections"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000_00000000-0000-0000-0000-000000000000",
+ "name": "00000000-0000-0000-0000-000000000000_00000000-0000-0000-0000-000000000000",
+ "type": "Microsoft.Billing/billingAccounts",
+ "properties": {
+ "displayName": "Test Account 1",
+ "agreementType": "MicrosoftCustomerAgreement",
+ "accountStatus": "Active",
+ "soldTo": {
+ "companyName": "Contoso",
+ "firstName": "Test",
+ "lastName": "User",
+ "addressLine1": "Test Address",
+ "addressLine2": "Test Address",
+ "addressLine3": "Test Address",
+ "city": "City",
+ "postalCode": "00000",
+ "region": "WA",
+ "country": "US",
+ "email": "abc@contoso.com",
+ "phoneNumber": "000-000-0000"
+ },
+ "accountType": "Enterprise",
+ "billingProfiles": {
+ "hasMoreResults": true,
+ "value": [
+ {
+ "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000_00000000-0000-0000-0000-000000000000/billingProfiles/11000000-0000-0000-0000-000000000000",
+ "name": "11000000-0000-0000-0000-000000000000",
+ "type": "Microsoft.Billing/billingAccounts/billingProfiles",
+ "properties": {
+ "displayName": "BillingProfile1",
+ "billTo": {
+ "companyName": "Contoso",
+ "firstName": "Test",
+ "lastName": "User",
+ "addressLine1": "Test Address1",
+ "addressLine2": "Test Address2",
+ "addressLine3": "Test Address3",
+ "city": "City",
+ "postalCode": "00000",
+ "region": "WA",
+ "country": "US",
+ "email": "abc@contoso.com",
+ "phoneNumber": "000-000-0000"
+ },
+ "currency": "USD",
+ "enabledAzurePlans": [
+ {
+ "skuId": "0001",
+ "skuDescription": "Microsoft Azure Plan"
+ },
+ {
+ "skuId": "0002",
+ "skuDescription": "Microsoft Azure Plan for DevTest"
+ }
+ ],
+ "invoiceDay": 5,
+ "invoiceEmailOptIn": true,
+ "poNumber": "ABC12345",
+ "hasReadAccess": true,
+ "systemId": "1XXX-11XX-XX1-XXXX-XXX",
+ "status": "Warned",
+ "statusReasonCode": "PastDue",
+ "spendingLimit": "On",
+ "invoiceSections": {
+ "hasMoreResults": false,
+ "value": [
+ {
+ "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000_00000000-0000-0000-0000-000000000000/billingProfiles/11000000-0000-0000-0000-000000000000/invoiceSections/invoiceSectionId1",
+ "name": "invoiceSectionId1",
+ "type": "Microsoft.Billing/billingAccounts/billingProfiles/invoiceSections",
+ "properties": {
+ "displayName": "invoiceSectionName1",
+ "labels": {
+ "pcCode": "A123456",
+ "costCategory": "Support"
+ },
+ "systemId": "9XXX-11XX-XX1-XXXX-XXX"
+ }
+ },
+ {
+ "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000_00000000-0000-0000-0000-000000000000/billingProfiles/11000000-0000-0000-0000-000000000000/invoiceSections/invoiceSectionId2",
+ "name": "invoiceSectionId2",
+ "type": "Microsoft.Billing/billingAccounts/billingProfiles/invoiceSections",
+ "properties": {
+ "displayName": "invoiceSectionName2",
+ "labels": {
+ "pcCode": "B223456",
+ "costCategory": "Finance"
+ },
+ "systemId": "9XXX-22XX-XX1-XXXX-XXX"
+ }
+ }
+ ]
+ }
+ }
+ },
+ {
+ "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000_00000000-0000-0000-0000-000000000000/billingProfiles/11000000-0000-0000-0000-000000000001",
+ "name": "11000000-0000-0000-0000-000000000001",
+ "type": "Microsoft.Billing/billingAccounts/billingProfiles",
+ "properties": {
+ "displayName": "BillingProfile2",
+ "billTo": {
+ "companyName": "Contoso",
+ "firstName": "Test",
+ "lastName": "User",
+ "addressLine1": "Test Address1",
+ "addressLine2": "Test Address2",
+ "addressLine3": "Test Address3",
+ "city": "City",
+ "postalCode": "00000",
+ "region": "WA",
+ "country": "US",
+ "email": "abc@contoso.com",
+ "phoneNumber": "000-000-0000"
+ },
+ "currency": "USD",
+ "enabledAzurePlans": [
+ {
+ "skuId": "0001",
+ "skuDescription": "Microsoft Azure Plan"
+ },
+ {
+ "skuId": "0002",
+ "skuDescription": "Microsoft Azure Plan for DevTest"
+ }
+ ],
+ "invoiceDay": 5,
+ "invoiceEmailOptIn": true,
+ "poNumber": "ABC12345",
+ "hasReadAccess": true,
+ "systemId": "2XXX-22XX-XX1-XXXX-XXX",
+ "status": "Active",
+ "spendingLimit": "Off",
+ "invoiceSections": {
+ "hasMoreResults": false,
+ "value": [
+ {
+ "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000_00000000-0000-0000-0000-000000000000/billingProfiles/11000000-0000-0000-0000-000000000001/invoiceSections/invoiceSectionId11",
+ "name": "invoiceSectionId11",
+ "type": "Microsoft.Billing/billingAccounts/billingProfiles/invoiceSections",
+ "properties": {
+ "displayName": "invoiceSectionName11",
+ "labels": {
+ "pcCode": "Z223456",
+ "costCategory": "Marketing"
+ },
+ "systemId": "9XXX-33XX-XX1-XXXX-XXX"
+ }
+ }
+ ]
+ }
+ }
+ }
+ ]
+ },
+ "hasReadAccess": true
+ }
+ },
+ {
+ "id": "/providers/Microsoft.Billing/billingAccounts/10000000-0000-0000-0000-000000000001_00000000-0000-0000-0000-000000000000",
+ "name": "10000000-0000-0000-0000-000000000001_00000000-0000-0000-0000-000000000000",
+ "type": "Microsoft.Billing/billingAccounts",
+ "properties": {
+ "displayName": "Test Account 2",
+ "agreementType": "MicrosoftCustomerAgreement",
+ "accountStatus": "Active",
+ "soldTo": null,
+ "accountType": "Enterprise",
+ "billingProfiles": {
+ "hasMoreResults": true,
+ "value": [
+ {
+ "id": "/providers/Microsoft.Billing/billingAccounts/10000000-0000-0000-0000-000000000001_00000000-0000-0000-0000-000000000000/billingProfiles/11000000-0000-0000-0000-000000000004",
+ "name": "11000000-0000-0000-0000-000000000004",
+ "type": "Microsoft.Billing/billingAccounts/billingProfiles",
+ "properties": {
+ "displayName": "BillingProfile3",
+ "billTo": {
+ "companyName": "Contoso Test",
+ "firstName": "Test",
+ "lastName": "User",
+ "addressLine1": "Test Address1",
+ "addressLine2": "Test Address2",
+ "addressLine3": "Test Address3",
+ "city": "City",
+ "postalCode": "00000",
+ "region": "WA",
+ "country": "US",
+ "email": "abc@contoso.com",
+ "phoneNumber": "000-000-0000"
+ },
+ "currency": "USD",
+ "enabledAzurePlans": [
+ {
+ "skuId": "0001",
+ "skuDescription": "Microsoft Azure Plan"
+ },
+ {
+ "skuId": "0002",
+ "skuDescription": "Microsoft Azure Plan for DevTest"
+ }
+ ],
+ "invoiceDay": 5,
+ "invoiceEmailOptIn": true,
+ "poNumber": "ABC12345",
+ "hasReadAccess": true,
+ "systemId": "3XXX-33XX-XX1-XXXX-XXX",
+ "status": "Warned",
+ "statusReasonCode": "PastDue",
+ "spendingLimit": "On",
+ "invoiceSections": {
+ "hasMoreResults": true,
+ "value": [
+ {
+ "id": "/providers/Microsoft.Billing/billingAccounts/10000000-0000-0000-0000-000000000001_00000000-0000-0000-0000-000000000000/billingProfiles/11000000-0000-0000-0000-000000000004/invoiceSections/invoiceSectionId3",
+ "name": "invoiceSectionId3",
+ "type": "Microsoft.Billing/billingAccounts/billingProfiles/invoiceSections",
+ "properties": {
+ "displayName": "invoiceSectionName3",
+ "labels": {
+ "pcCode": "C123456",
+ "costCategory": "Support"
+ },
+ "systemId": "9XXX-44XX-XX1-XXXX-XXX"
+ }
+ },
+ {
+ "id": "/providers/Microsoft.Billing/billingAccounts/10000000-0000-0000-0000-000000000001_00000000-0000-0000-0000-000000000000/billingProfiles/11000000-0000-0000-0000-000000000004/invoiceSections/invoiceSectionId4",
+ "name": "invoiceSectionId4",
+ "type": "Microsoft.Billing/billingAccounts/billingProfiles/invoiceSections",
+ "properties": {
+ "displayName": "invoiceSectionName4",
+ "labels": {
+ "pcCode": "D123456",
+ "costCategory": "Marketing"
+ },
+ "systemId": "9XXX-55XX-XX1-XXXX-XXX"
+ }
+ }
+ ]
+ }
+ }
+ },
+ {
+ "id": "/providers/Microsoft.Billing/billingAccounts/10000000-0000-0000-0000-000000000001_00000000-0000-0000-0000-000000000000/billingProfiles/11000000-0000-0000-0000-000000000005",
+ "name": "11000000-0000-0000-0000-000000000005",
+ "type": "Microsoft.Billing/billingAccounts/billingProfiles",
+ "properties": {
+ "displayName": "BillingProfile4",
+ "billTo": {
+ "companyName": "Contoso Test",
+ "firstName": "Test",
+ "lastName": "User",
+ "addressLine1": "Test Address1",
+ "addressLine2": "Test Address2",
+ "addressLine3": "Test Address3",
+ "city": "City",
+ "postalCode": "00000",
+ "region": "WA",
+ "country": "US",
+ "email": "abc@contoso.com",
+ "phoneNumber": "000-000-0000"
+ },
+ "currency": "USD",
+ "enabledAzurePlans": [
+ {
+ "skuId": "0001",
+ "skuDescription": "Microsoft Azure Plan"
+ },
+ {
+ "skuId": "0002",
+ "skuDescription": "Microsoft Azure Plan for DevTest"
+ }
+ ],
+ "invoiceDay": 5,
+ "invoiceEmailOptIn": true,
+ "poNumber": "ABC12345",
+ "hasReadAccess": true,
+ "systemId": "4XXX-44XX-XX1-XXXX-XXX",
+ "status": "Warned",
+ "statusReasonCode": "PastDue",
+ "spendingLimit": "On",
+ "invoiceSections": {
+ "hasMoreResults": true,
+ "value": [
+ {
+ "id": "/providers/Microsoft.Billing/billingAccounts/10000000-0000-0000-0000-000000000001_00000000-0000-0000-0000-000000000000/billingProfiles/11000000-0000-0000-0000-000000000005/invoiceSections/invoiceSectionId5",
+ "name": "invoiceSectionId5",
+ "type": "Microsoft.Billing/billingAccounts/billingProfiles/invoiceSections",
+ "properties": {
+ "displayName": "invoiceSectionName5",
+ "labels": {
+ "pcCode": "E123456",
+ "costCategory": "Finance"
+ },
+ "systemId": "9XXX-66XX-XX1-XXXX-XXX"
+ }
+ },
+ {
+ "id": "/providers/Microsoft.Billing/billingAccounts/10000000-0000-0000-0000-000000000001_00000000-0000-0000-0000-000000000000/billingProfiles/11000000-0000-0000-0000-000000000005/invoiceSections/invoiceSectionId6",
+ "name": "invoiceSectionId6",
+ "type": "Microsoft.Billing/billingAccounts/billingProfiles/invoiceSections",
+ "properties": {
+ "displayName": "invoiceSectionName6",
+ "labels": {
+ "pcCode": "O123456",
+ "costCategory": "Support"
+ },
+ "systemId": "9XXX-77XX-XX1-XXXX-XXX"
+ }
+ }
+ ]
+ }
+ }
+ }
+ ]
+ },
+ "hasReadAccess": true
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingAccountsListWithExpandForEnrollmentDetails.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingAccountsListWithExpandForEnrollmentDetails.json
new file mode 100644
index 000000000000..a546b96ac97f
--- /dev/null
+++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingAccountsListWithExpandForEnrollmentDetails.json
@@ -0,0 +1,107 @@
+{
+ "parameters": {
+ "api-version": "2020-05-01",
+ "$expand": "enrollmentDetails,departments,enrollmentAccounts"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "/providers/Microsoft.Billing/billingAccounts/7645820",
+ "name": "7645820",
+ "type": "Microsoft.Billing/billingAccounts",
+ "properties": {
+ "agreementType": "EnterpriseAgreement",
+ "soldTo": {
+ "addressLine1": "Test Address",
+ "addressLine2": "Test Address",
+ "addressLine3": "Test Address",
+ "city": "City",
+ "postalCode": "00000",
+ "region": "WA",
+ "country": "US"
+ },
+ "enrollmentDetails": {
+ "startDate": "2018-05-01T17:32:28Z",
+ "endDate": "2019-05-31T17:32:28Z",
+ "currency": "USD",
+ "channel": "EaDirect",
+ "language": "en",
+ "countryCode": "US",
+ "status": "Active",
+ "billingCycle": "Monthly",
+ "policies": {
+ "accountOwnerViewCharges": true,
+ "departmentAdminViewCharges": true,
+ "marketplacesEnabled": true,
+ "reservedInstancesEnabled": true
+ }
+ },
+ "departments": [
+ {
+ "id": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/departments/departmentId1",
+ "name": "departmentId1",
+ "type": "Microsoft.Billing/departments",
+ "properties": {
+ "departmentName": "departmentName1",
+ "costCenter": "C1",
+ "status": "Active"
+ }
+ },
+ {
+ "id": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/departments/departmentId2",
+ "name": "departmentId2",
+ "type": "Microsoft.Billing/departments",
+ "properties": {
+ "departmentName": "departmentName2",
+ "costCenter": "C4",
+ "status": "Active"
+ }
+ }
+ ],
+ "enrollmentAccounts": [
+ {
+ "id": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/enrollmentAccounts/accountId0",
+ "name": "accountId0",
+ "type": "Microsoft.Billing/enrollmentAccounts",
+ "properties": {
+ "accountName": "AccountName0",
+ "costCenter": "C0",
+ "status": "Active",
+ "startDate": "2018-05-01T17:32:28Z",
+ "endDate": "2019-05-31T17:32:28Z"
+ }
+ },
+ {
+ "id": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/enrollmentAccounts/accountId1",
+ "name": "accountId1",
+ "type": "Microsoft.Billing/enrollmentAccounts",
+ "properties": {
+ "accountName": "AccountName1",
+ "costCenter": "C4",
+ "status": "Active",
+ "startDate": "2018-05-01T17:32:28Z",
+ "endDate": "2019-05-31T17:32:28Z"
+ }
+ },
+ {
+ "id": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/enrollmentAccounts/accountId2",
+ "name": "accountId2",
+ "type": "Microsoft.Billing/enrollmentAccounts",
+ "properties": {
+ "accountName": "AccountName2",
+ "costCenter": "C4",
+ "status": "Active",
+ "startDate": "2018-05-01T17:32:28Z",
+ "endDate": "2019-05-31T17:32:28Z"
+ }
+ }
+ ]
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingProfile.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingProfile.json
new file mode 100644
index 000000000000..a8dcf52150fa
--- /dev/null
+++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingProfile.json
@@ -0,0 +1,52 @@
+{
+ "parameters": {
+ "api-version": "2020-05-01",
+ "billingAccountName": "{billingAccountName}",
+ "billingProfileName": "{billingProfileName}"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}",
+ "name": "{billingProfileName}",
+ "type": "Microsoft.Billing/billingAccounts/billingProfiles",
+ "properties": {
+ "displayName": "Billing Profile1",
+ "billTo": {
+ "companyName": "Contoso",
+ "firstName": "Test",
+ "lastName": "User",
+ "addressLine1": "Test Address1",
+ "addressLine2": "Test Address2",
+ "addressLine3": "Test Address3",
+ "city": "City",
+ "postalCode": "00000",
+ "region": "WA",
+ "country": "US",
+ "email": "abc@contoso.com",
+ "phoneNumber": "000-000-0000"
+ },
+ "currency": "USD",
+ "enabledAzurePlans": [
+ {
+ "skuId": "0001",
+ "skuDescription": "Microsoft Azure Plan"
+ },
+ {
+ "skuId": "0002",
+ "skuDescription": "Microsoft Azure Plan for DevTest"
+ }
+ ],
+ "invoiceDay": 5,
+ "invoiceEmailOptIn": true,
+ "poNumber": "ABC12345",
+ "hasReadAccess": true,
+ "systemId": "1XXX-11XX-XX1-XXXX-XXX",
+ "status": "Warned",
+ "statusReasonCode": "PastDue",
+ "spendingLimit": "On"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingProfilePermissionsList.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingProfilePermissionsList.json
new file mode 100644
index 000000000000..131dcb9aeff1
--- /dev/null
+++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingProfilePermissionsList.json
@@ -0,0 +1,40 @@
+{
+ "parameters": {
+ "api-version": "2020-05-01",
+ "billingAccountName": "{billingAccountName}",
+ "billingProfileName": "{billingProfileName}"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "actions": [
+ "10000000-aaaa-bbbb-cccc-200000000006",
+ "10000000-aaaa-bbbb-cccc-200000000003",
+ "10000000-aaaa-bbbb-cccc-200000000002",
+ "10000000-aaaa-bbbb-cccc-200000000001",
+ "10000000-aaaa-bbbb-cccc-200000000000",
+ "30000000-aaaa-bbbb-cccc-200000000007",
+ "30000000-aaaa-bbbb-cccc-200000000004",
+ "30000000-aaaa-bbbb-cccc-200000000015",
+ "20000000-aaaa-bbbb-cccc-200000000002",
+ "30000000-aaaa-bbbb-cccc-200000000009",
+ "40000000-aaaa-bbbb-cccc-200000000000",
+ "30000000-aaaa-bbbb-cccc-200000000000",
+ "20000000-aaaa-bbbb-cccc-200000000000",
+ "10000000-aaaa-bbbb-cccc-200000000008",
+ "10000000-aaaa-bbbb-cccc-200000000007",
+ "40000000-aaaa-bbbb-cccc-200000000008",
+ "40000000-aaaa-bbbb-cccc-200000000006",
+ "40000000-aaaa-bbbb-cccc-200000000007",
+ "30000000-aaaa-bbbb-cccc-200000000010",
+ "30000000-aaaa-bbbb-cccc-200000000001"
+ ],
+ "notActions": []
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingProfileRoleAssignment.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingProfileRoleAssignment.json
new file mode 100644
index 000000000000..6de1eb19bc72
--- /dev/null
+++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingProfileRoleAssignment.json
@@ -0,0 +1,26 @@
+{
+ "parameters": {
+ "api-version": "2020-05-01",
+ "billingAccountName": "{billingAccountName}",
+ "billingProfileName": "{billingProfileName}",
+ "billingRoleAssignmentName": "{billingRoleAssignmentName}"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/billingRoleAssignments/10000000-aaaa-bbbb-cccc-100000000000_b1839933-b3ac-42ca-8112-d29c43f3ab47",
+ "name": "10000000-aaaa-bbbb-cccc-100000000000_b1839933-b3ac-42ca-8112-d29c43f3ab47",
+ "properties": {
+ "createdOn": "2018-06-21T21:58:19.9073876+00:00",
+ "scope": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}",
+ "createdByPrincipalTenantId": "7ca289b9-c32d-4f01-8566-7ff93261d76f",
+ "createdByPrincipalId": "10000000-aaaa-bbbb-cccc-3fd5ff9d6aa1",
+ "principalId": "6fd330f6-7d26-4aff-b9cf-7bd699f965b9",
+ "principalTenantId": "10000000-aaaa-bbbb-cccc-2d7cd011db47",
+ "roleDefinitionId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingRoleDefinitions/50000000-aaaa-bbbb-cccc-100000000002"
+ },
+ "type": "Microsoft.Billing/billingAccounts/billingProfiles/billingRoleAssignments"
+ }
+ }
+ }
+}
diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingProfileRoleAssignmentDelete.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingProfileRoleAssignmentDelete.json
new file mode 100644
index 000000000000..417086394bb9
--- /dev/null
+++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingProfileRoleAssignmentDelete.json
@@ -0,0 +1,26 @@
+{
+ "parameters": {
+ "api-version": "2020-05-01",
+ "billingAccountName": "{billingAccountName}",
+ "billingProfileName": "{billingProfileName}",
+ "billingRoleAssignmentName": "{billingRoleAssignmentName}"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/10000000-aaaa-bbbb-cccc-100000000000_b1839933-b3ac-42ca-8112-d29c43f3ab47",
+ "name": "10000000-aaaa-bbbb-cccc-100000000000_b1839933-b3ac-42ca-8112-d29c43f3ab47",
+ "properties": {
+ "createdOn": "2018-06-21T21:58:19.9073876+00:00",
+ "scope": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}",
+ "createdByPrincipalTenantId": "7ca289b9-c32d-4f01-8566-7ff93261d76f",
+ "createdByPrincipalId": "10000000-aaaa-bbbb-cccc-3fd5ff9d6aa1",
+ "principalId": "6fd330f6-7d26-4aff-b9cf-7bd699f965b9",
+ "principalTenantId": "10000000-aaaa-bbbb-cccc-2d7cd011db47",
+ "roleDefinitionId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingRoleDefinitions/50000000-aaaa-bbbb-cccc-100000000002"
+ },
+ "type": "Microsoft.Billing/billingAccounts/billingProfiles/billingRoleAssignments"
+ }
+ }
+ }
+}
diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingProfileRoleAssignmentList.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingProfileRoleAssignmentList.json
new file mode 100644
index 000000000000..d550705d7a17
--- /dev/null
+++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingProfileRoleAssignmentList.json
@@ -0,0 +1,43 @@
+{
+ "parameters": {
+ "api-version": "2020-05-01",
+ "billingAccountName": "{billingAccountName}",
+ "billingProfileName": "{billingProfileName}"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/10000000-aaaa-bbbb-cccc-100000000000_6fd330f6-7d26-4aff-b9cf-7bd699f965b9",
+ "name": "10000000-aaaa-bbbb-cccc-100000000000_6fd330f6-7d26-4aff-b9cf-7bd699f965b9",
+ "properties": {
+ "createdOn": "2018-06-21T21:34:12.2363515+00:00",
+ "scope": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}",
+ "createdByPrincipalTenantId": "7ca289b9-c32d-4f01-8566-7ff93261d76f",
+ "createdByPrincipalId": "10000000-aaaa-bbbb-cccc-3fd5ff9d6aa1",
+ "principalId": "6fd330f6-7d26-4aff-b9cf-7bd699f965b9",
+ "principalTenantId": "10000000-aaaa-bbbb-cccc-2d7cd011db47",
+ "roleDefinitionId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingRoleDefinitions/50000000-aaaa-bbbb-cccc-100000000002"
+ },
+ "type": "Microsoft.Billing/billingAccounts/billingProfiles/billingRoleAssignments"
+ },
+ {
+ "id": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/10000000-aaaa-bbbb-cccc-100000000000_00000000-0000-0000-0000-000000000000",
+ "name": "10000000-aaaa-bbbb-cccc-100000000000_00000000-0000-0000-0000-000000000000",
+ "properties": {
+ "createdOn": "2018-06-21T21:58:19.9073876+00:00",
+ "scope": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}",
+ "createdByPrincipalTenantId": "7ca289b9-c32d-4f01-8566-7ff93261d76f",
+ "createdByPrincipalId": "10000000-aaaa-bbbb-cccc-3fd5ff9d6aa1",
+ "principalId": "b1839933-b3ac-42ca-8112-d29c43f3ab47",
+ "principalTenantId": "10000000-aaaa-bbbb-cccc-2d7cd011db47",
+ "roleDefinitionId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingRoleDefinitions/50000000-aaaa-bbbb-cccc-100000000002"
+ },
+ "type": "Microsoft.Billing/billingAccounts/billingProfiles/billingRoleAssignments"
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingProfileRoleDefinition.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingProfileRoleDefinition.json
new file mode 100644
index 000000000000..ddbac23b4fdc
--- /dev/null
+++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingProfileRoleDefinition.json
@@ -0,0 +1,48 @@
+{
+ "parameters": {
+ "api-version": "2020-05-01",
+ "billingAccountName": "{billingAccountName}",
+ "billingProfileName": "{billingProfileName}",
+ "billingRoleDefinitionName": "{billingRoleDefinitionName}"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/billingRoleDefinitions/{billingRoleDefinitionName}",
+ "name": "{billingRoleDefinitionName}",
+ "properties": {
+ "description": "The Owner role gives the user all permissions including access management rights to the billing profile.",
+ "permissions": [
+ {
+ "actions": [
+ "10000000-aaaa-bbbb-cccc-200000000000",
+ "10000000-aaaa-bbbb-cccc-200000000008",
+ "10000000-aaaa-bbbb-cccc-200000000001",
+ "10000000-aaaa-bbbb-cccc-200000000002",
+ "10000000-aaaa-bbbb-cccc-200000000003",
+ "10000000-aaaa-bbbb-cccc-200000000006",
+ "10000000-aaaa-bbbb-cccc-200000000007",
+ "20000000-aaaa-bbbb-cccc-200000000000",
+ "30000000-aaaa-bbbb-cccc-200000000000",
+ "40000000-aaaa-bbbb-cccc-200000000000",
+ "30000000-aaaa-bbbb-cccc-200000000009",
+ "20000000-aaaa-bbbb-cccc-200000000002",
+ "30000000-aaaa-bbbb-cccc-200000000015",
+ "30000000-aaaa-bbbb-cccc-200000000004",
+ "30000000-aaaa-bbbb-cccc-200000000007",
+ "30000000-aaaa-bbbb-cccc-200000000001",
+ "30000000-aaaa-bbbb-cccc-200000000010",
+ "40000000-aaaa-bbbb-cccc-200000000007",
+ "40000000-aaaa-bbbb-cccc-200000000006",
+ "40000000-aaaa-bbbb-cccc-200000000008"
+ ],
+ "notActions": []
+ }
+ ],
+ "roleName": "Billing profile owner"
+ },
+ "type": "Microsoft.Billing/billingAccounts/billingProfiles/billingRoleDefinitions"
+ }
+ }
+ }
+}
diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingProfileRoleDefinitionsList.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingProfileRoleDefinitionsList.json
new file mode 100644
index 000000000000..0437df534f06
--- /dev/null
+++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingProfileRoleDefinitionsList.json
@@ -0,0 +1,83 @@
+{
+ "parameters": {
+ "api-version": "2020-05-01",
+ "billingAccountName": "{billingAccountName}",
+ "billingProfileName": "{billingProfileName}"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/billingRoleDefinitions/10000000-aaaa-bbbb-cccc-100000000000",
+ "name": "10000000-aaaa-bbbb-cccc-100000000000",
+ "properties": {
+ "description": "The Owner role gives the user all permissions including access management rights to the billing profile.",
+ "permissions": [
+ {
+ "actions": [
+ "10000000-aaaa-bbbb-cccc-200000000000",
+ "10000000-aaaa-bbbb-cccc-200000000008",
+ "10000000-aaaa-bbbb-cccc-200000000001",
+ "10000000-aaaa-bbbb-cccc-200000000002",
+ "10000000-aaaa-bbbb-cccc-200000000003",
+ "10000000-aaaa-bbbb-cccc-200000000006",
+ "10000000-aaaa-bbbb-cccc-200000000007",
+ "20000000-aaaa-bbbb-cccc-200000000000",
+ "30000000-aaaa-bbbb-cccc-200000000000",
+ "40000000-aaaa-bbbb-cccc-200000000000",
+ "30000000-aaaa-bbbb-cccc-200000000009",
+ "20000000-aaaa-bbbb-cccc-200000000002",
+ "30000000-aaaa-bbbb-cccc-200000000015",
+ "30000000-aaaa-bbbb-cccc-200000000004",
+ "30000000-aaaa-bbbb-cccc-200000000007",
+ "30000000-aaaa-bbbb-cccc-200000000001",
+ "30000000-aaaa-bbbb-cccc-200000000010",
+ "40000000-aaaa-bbbb-cccc-200000000007",
+ "40000000-aaaa-bbbb-cccc-200000000006",
+ "40000000-aaaa-bbbb-cccc-200000000008"
+ ],
+ "notActions": []
+ }
+ ],
+ "roleName": "Billing profile owner"
+ },
+ "type": "Microsoft.Billing/billingAccounts/billingProfiles/billingRoleDefinitions"
+ },
+ {
+ "id": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/billingRoleDefinitions/10000000-aaaa-bbbb-cccc-100000000001",
+ "name": "10000000-aaaa-bbbb-cccc-100000000001",
+ "properties": {
+ "description": "The Contributor role give the user all permissions except access management rights to the billing profile.",
+ "permissions": [
+ {
+ "actions": [
+ "10000000-aaaa-bbbb-cccc-200000000008",
+ "10000000-aaaa-bbbb-cccc-200000000001",
+ "10000000-aaaa-bbbb-cccc-200000000002",
+ "10000000-aaaa-bbbb-cccc-200000000003",
+ "10000000-aaaa-bbbb-cccc-200000000006",
+ "10000000-aaaa-bbbb-cccc-200000000007",
+ "30000000-aaaa-bbbb-cccc-200000000009",
+ "20000000-aaaa-bbbb-cccc-200000000002",
+ "30000000-aaaa-bbbb-cccc-200000000015",
+ "30000000-aaaa-bbbb-cccc-200000000004",
+ "30000000-aaaa-bbbb-cccc-200000000007",
+ "30000000-aaaa-bbbb-cccc-200000000001",
+ "30000000-aaaa-bbbb-cccc-200000000010",
+ "40000000-aaaa-bbbb-cccc-200000000007",
+ "40000000-aaaa-bbbb-cccc-200000000006",
+ "40000000-aaaa-bbbb-cccc-200000000008"
+ ],
+ "notActions": []
+ }
+ ],
+ "roleName": "Billing profile contributor"
+ },
+ "type": "Microsoft.Billing/billingAccounts/billingProfiles/billingRoleDefinitions"
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingProfileWithExpand.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingProfileWithExpand.json
new file mode 100644
index 000000000000..ef48d861b956
--- /dev/null
+++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingProfileWithExpand.json
@@ -0,0 +1,71 @@
+{
+ "parameters": {
+ "api-version": "2020-05-01",
+ "billingAccountName": "{billingAccountName}",
+ "billingProfileName": "{billingProfileName}",
+ "$expand": "invoiceSections"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}",
+ "name": "{billingProfileName}",
+ "type": "Microsoft.Billing/billingAccounts/billingProfiles",
+ "properties": {
+ "displayName": "Billing Profile1",
+ "billTo": {
+ "companyName": "Contoso",
+ "firstName": "Test",
+ "lastName": "User",
+ "addressLine1": "Test Address1",
+ "addressLine2": "Test Address2",
+ "addressLine3": "Test Address3",
+ "city": "City",
+ "postalCode": "00000",
+ "region": "WA",
+ "country": "US",
+ "email": "abc@contoso.com",
+ "phoneNumber": "000-000-0000"
+ },
+ "currency": "USD",
+ "enabledAzurePlans": [
+ {
+ "skuId": "0001",
+ "skuDescription": "Microsoft Azure Plan"
+ },
+ {
+ "skuId": "0002",
+ "skuDescription": "Microsoft Azure Plan for DevTest"
+ }
+ ],
+ "invoiceDay": 5,
+ "invoiceEmailOptIn": true,
+ "poNumber": "ABC12345",
+ "hasReadAccess": true,
+ "systemId": "1XXX-11XX-XX1-XXXX-XXX",
+ "status": "Warned",
+ "statusReasonCode": "PastDue",
+ "spendingLimit": "On",
+ "invoiceSections": {
+ "hasMoreResults": false,
+ "value": [
+ {
+ "id": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/invoiceSectionId1",
+ "name": "invoiceSectionId1",
+ "type": "Microsoft.Billing/billingAccounts/billingProfiles/invoiceSections",
+ "properties": {
+ "displayName": "invoiceSectionName1",
+ "labels": {
+ "pcCode": "A123456",
+ "costCategory": "Support"
+ },
+ "systemId": "9XXX-11XX-XX1-XXXX-XXX"
+ }
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+}
diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingProfilesListByBillingAccount.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingProfilesListByBillingAccount.json
new file mode 100644
index 000000000000..d3d8175d403d
--- /dev/null
+++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingProfilesListByBillingAccount.json
@@ -0,0 +1,95 @@
+{
+ "parameters": {
+ "api-version": "2020-05-01",
+ "billingAccountName": "{billingAccountName}"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/11000000-0000-0000-0000-000000000000",
+ "name": "11000000-0000-0000-0000-000000000000",
+ "type": "Microsoft.Billing/billingAccounts/billingProfiles",
+ "properties": {
+ "displayName": "BillingProfile1",
+ "billTo": {
+ "companyName": "Contoso",
+ "firstName": "Test",
+ "lastName": "User",
+ "addressLine1": "Test Address1",
+ "addressLine2": "Test Address2",
+ "addressLine3": "Test Address3",
+ "city": "City",
+ "postalCode": "00000",
+ "region": "WA",
+ "country": "US",
+ "email": "abc@contoso.com",
+ "phoneNumber": "000-000-0000"
+ },
+ "currency": "USD",
+ "enabledAzurePlans": [
+ {
+ "skuId": "0001",
+ "skuDescription": "Microsoft Azure Plan"
+ },
+ {
+ "skuId": "0002",
+ "skuDescription": "Microsoft Azure Plan for DevTest"
+ }
+ ],
+ "invoiceDay": 5,
+ "invoiceEmailOptIn": true,
+ "poNumber": "ABC12345",
+ "hasReadAccess": true,
+ "systemId": "1XXX-11XX-XX1-XXXX-XXX",
+ "status": "Warned",
+ "statusReasonCode": "PastDue",
+ "spendingLimit": "On"
+ }
+ },
+ {
+ "id": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/11000000-0000-0000-0000-000000000001",
+ "name": "11000000-0000-0000-0000-000000000001",
+ "type": "Microsoft.Billing/billingAccounts/billingProfiles",
+ "properties": {
+ "displayName": "BillingProfile2",
+ "billTo": {
+ "companyName": "Contoso",
+ "firstName": "Test",
+ "lastName": "User",
+ "addressLine1": "Test Address1",
+ "addressLine2": "Test Address2",
+ "addressLine3": "Test Address3",
+ "city": "City",
+ "postalCode": "00000",
+ "region": "WA",
+ "country": "US",
+ "email": "abc@contoso.com",
+ "phoneNumber": "000-000-0000"
+ },
+ "currency": "USD",
+ "enabledAzurePlans": [
+ {
+ "skuId": "0001",
+ "skuDescription": "Microsoft Azure Plan"
+ },
+ {
+ "skuId": "0002",
+ "skuDescription": "Microsoft Azure Plan for DevTest"
+ }
+ ],
+ "invoiceDay": 5,
+ "invoiceEmailOptIn": true,
+ "poNumber": "ABC12345",
+ "hasReadAccess": true,
+ "systemId": "2XXX-22XX-XX1-XXXX-XXX",
+ "status": "Active",
+ "spendingLimit": "Off"
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingProfilesListWithExpand.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingProfilesListWithExpand.json
new file mode 100644
index 000000000000..85a10f54a285
--- /dev/null
+++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingProfilesListWithExpand.json
@@ -0,0 +1,133 @@
+{
+ "parameters": {
+ "api-version": "2020-05-01",
+ "billingAccountName": "{billingAccountName}",
+ "$expand": "invoiceSections"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/11000000-0000-0000-0000-000000000000",
+ "name": "11000000-0000-0000-0000-000000000000",
+ "type": "Microsoft.Billing/billingAccounts/billingProfiles",
+ "properties": {
+ "displayName": "BillingProfile1",
+ "billTo": {
+ "companyName": "Contoso",
+ "firstName": "Test",
+ "lastName": "User",
+ "addressLine1": "Test Address1",
+ "addressLine2": "Test Address2",
+ "addressLine3": "Test Address3",
+ "city": "City",
+ "postalCode": "00000",
+ "region": "WA",
+ "country": "US",
+ "email": "abc@contoso.com",
+ "phoneNumber": "000-000-0000"
+ },
+ "currency": "USD",
+ "enabledAzurePlans": [
+ {
+ "skuId": "0001",
+ "skuDescription": "Microsoft Azure Plan"
+ },
+ {
+ "skuId": "0002",
+ "skuDescription": "Microsoft Azure Plan for DevTest"
+ }
+ ],
+ "invoiceDay": 5,
+ "invoiceEmailOptIn": true,
+ "poNumber": "ABC12345",
+ "hasReadAccess": true,
+ "systemId": "1XXX-11XX-XX1-XXXX-XXX",
+ "status": "Warned",
+ "statusReasonCode": "PastDue",
+ "spendingLimit": "On",
+ "invoiceSections": {
+ "hasMoreResults": false,
+ "value": [
+ {
+ "id": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/11000000-0000-0000-0000-000000000000/invoiceSections/invoiceSectionId1",
+ "name": "invoiceSectionId1",
+ "type": "Microsoft.Billing/billingAccounts/billingProfiles/invoiceSections",
+ "properties": {
+ "displayName": "invoiceSectionName1",
+ "labels": {
+ "pcCode": "A123456",
+ "costCategory": "Support"
+ },
+ "systemId": "9XXX-11XX-XX1-XXXX-XXX"
+ }
+ }
+ ]
+ }
+ }
+ },
+ {
+ "id": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/11000000-0000-0000-0000-000000000001",
+ "name": "11000000-0000-0000-0000-000000000001",
+ "type": "Microsoft.Billing/billingAccounts/billingProfiles",
+ "properties": {
+ "displayName": "BillingProfile2",
+ "billTo": {
+ "companyName": "Contoso",
+ "firstName": "Test",
+ "lastName": "User",
+ "addressLine1": "Test Address1",
+ "addressLine2": "Test Address2",
+ "addressLine3": "Test Address3",
+ "city": "City",
+ "postalCode": "00000",
+ "region": "WA",
+ "country": "US",
+ "email": "abc@contoso.com",
+ "phoneNumber": "000-000-0000"
+ },
+ "currency": "USD",
+ "enabledAzurePlans": [
+ {
+ "skuId": "0001",
+ "skuDescription": "Microsoft Azure Plan"
+ },
+ {
+ "skuId": "0002",
+ "skuDescription": "Microsoft Azure Plan for DevTest"
+ }
+ ],
+ "invoiceDay": 5,
+ "invoiceEmailOptIn": true,
+ "poNumber": "ABC12345",
+ "hasReadAccess": true,
+ "systemId": "2XXX-22XX-XX1-XXXX-XXX",
+ "status": "Warned",
+ "statusReasonCode": "PastDue",
+ "spendingLimit": "On",
+ "invoiceSections": {
+ "hasMoreResults": false,
+ "value": [
+ {
+ "id": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/11000000-0000-0000-0000-000000000001/invoiceSections/invoiceSectionId2",
+ "name": "invoiceSectionId2",
+ "type": "Microsoft.Billing/billingAccounts/billingProfiles/invoiceSections",
+ "properties": {
+ "displayName": "invoiceSectionName2",
+ "labels": {
+ "pcCode": "Z223456",
+ "costCategory": "Marketing"
+ },
+ "systemId": "9XXX-22XX-XX1-XXXX-XXX"
+ }
+ }
+ ]
+ }
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingProperty.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingProperty.json
new file mode 100644
index 000000000000..70e263978a92
--- /dev/null
+++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingProperty.json
@@ -0,0 +1,34 @@
+{
+ "parameters": {
+ "api-version": "2020-05-01",
+ "subscriptionId": "{subscriptionId}"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/{subscriptionId}/providers/Microsoft.Billing/billingProperty/default",
+ "name": "default",
+ "type": "Microsoft.Billing/billingProperty",
+ "properties": {
+ "accountAdminNotificationEmailAddress": "test@contoso.com",
+ "billingTenantId": "90000000-0000-0000-0000-000000000011",
+ "billingAccountId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000_00000000-0000-0000-0000-000000000000",
+ "billingAccountDisplayName": "My Account",
+ "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000_00000000-0000-0000-0000-000000000000/billingProfiles/11000000-0000-0000-0000-000000000000",
+ "billingProfileDisplayName": "Contoso operations billing",
+ "billingProfileStatus": "Warned",
+ "billingProfileStatusReasonCode": "PastDue",
+ "billingProfileSpendingLimit": "On",
+ "costCenter": "1010",
+ "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000_00000000-0000-0000-0000-000000000000/invoiceSections/22000000-0000-0000-0000-000000000000",
+ "invoiceSectionDisplayName": "Contoso operations invoice section",
+ "isAccountAdmin": true,
+ "productId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000_00000000-0000-0000-0000-000000000000/invoiceSections/22000000-0000-0000-0000-000000000000/products/44000000-0000-0000-0000-000000000000",
+ "productName": "Standard Dev",
+ "skuId": "0001",
+ "skuDescription": "Microsoft Azure Plan for DevTest"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingSubscription.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingSubscription.json
new file mode 100644
index 000000000000..82f9307e93a9
--- /dev/null
+++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingSubscription.json
@@ -0,0 +1,36 @@
+{
+ "parameters": {
+ "api-version": "2020-05-01",
+ "billingAccountName": "{billingAccountName}",
+ "subscriptionId": "{subscriptionId}"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/providers/Microsoft.Billing/BillingAccounts/{billingAccountName}/billingSubscriptions/{subscriptionId}",
+ "name": "{subscriptionId}",
+ "type": "Microsoft.Billing/billingAccounts/billingSubscriptions",
+ "properties": {
+ "displayName": "My Subscription",
+ "subscriptionId": "6b96d3f2-9008-4a9d-912f-f87744185aa3",
+ "subscriptionBillingStatus": "Active",
+ "lastMonthCharges": {
+ "currency": "USD",
+ "value": 5000.00
+ },
+ "monthToDateCharges": {
+ "currency": "USD",
+ "value": 600
+ },
+ "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/11000000-0000-0000-0000-000000000000/invoiceSections/22000000-0000-0000-0000-000000000000",
+ "invoiceSectionDisplayName": "Contoso operations invoiceSection",
+ "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/11000000-0000-0000-0000-000000000000",
+ "billingProfileDisplayName": "Contoso operations billing",
+ "costCenter": "ABC1234",
+ "skuId": "0001",
+ "skuDescription": "Microsoft Azure Plan"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingSubscriptionInvoice.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingSubscriptionInvoice.json
new file mode 100644
index 000000000000..84718dc27df1
--- /dev/null
+++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingSubscriptionInvoice.json
@@ -0,0 +1,55 @@
+{
+ "parameters": {
+ "api-version": "2020-05-01",
+ "subscriptionId": "{subscriptionId}",
+ "invoiceName": "{invoiceName}"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingSubscriptions/11000000-0000-0000-0000-000000000000/invoices/1383724",
+ "name": "1383724",
+ "type": "Microsoft.Billing/billingAccounts/billingSubscriptions/invoices",
+ "properties": {
+ "dueDate": "2018-03-01T17:32:28Z",
+ "invoiceDate": "2018-02-01T17:32:28Z",
+ "status": "Paid",
+ "amountDue": {
+ "currency": "USD",
+ "value": 2000.00
+ },
+ "billedAmount": {
+ "currency": "USD",
+ "value": 2000.00
+ },
+ "invoicePeriodStartDate": "2018-02-01T17:32:28Z",
+ "invoicePeriodEndDate": "2018-02-30T17:32:28Z",
+ "invoiceType": "AzureMarketplace",
+ "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/11000000-0000-0000-0000-000000000000",
+ "billingProfileDisplayName": "Contoso Operations Billing",
+ "purchaseOrderNumber": "123456",
+ "documents": [
+ {
+ "kind": "Invoice",
+ "url": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingSubscriptions/11000000-0000-0000-0000-000000000000/invoices/1383724/download",
+ "source": "DRS"
+ }
+ ],
+ "payments": [
+ {
+ "date": "2018-01-14T17:32:28Z",
+ "paymentType": "credited",
+ "amount": {
+ "currency": "USD",
+ "value": 2000.00
+ },
+ "paymentMethodFamily": "CreditCard",
+ "paymentMethodType": "visa"
+ }
+ ],
+ "subscriptionId": "55000000-0000-0000-0000-000000000011"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingSubscriptionInvoiceDownload.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingSubscriptionInvoiceDownload.json
new file mode 100644
index 000000000000..226bfa9ef63e
--- /dev/null
+++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingSubscriptionInvoiceDownload.json
@@ -0,0 +1,21 @@
+{
+ "parameters": {
+ "api-version": "2020-05-01",
+ "subscriptionId": "{subscriptionId}",
+ "invoiceName": "{invoiceName}",
+ "downloadToken": "DRS_12345"
+ },
+ "responses": {
+ "202": {
+ "headers": {
+ "Location": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/default/billingSubscriptions/11000000-0000-0000-0000-000000000000/operationResults/invoiceDownload_11000000-0000-0000-0000-000000000000?api-version=2020-05-01",
+ "Retry-After": "10"
+ }
+ },
+ "200": {
+ "body": {
+ "url": "https://myaccount.blob.core.windows.net/invoices/1383724.pdf?sv=2019-02-02&sr=b&sig=sp=r"
+ }
+ }
+ }
+}
diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingSubscriptionInvoicesList.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingSubscriptionInvoicesList.json
new file mode 100644
index 000000000000..7fabd49c628b
--- /dev/null
+++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingSubscriptionInvoicesList.json
@@ -0,0 +1,79 @@
+{
+ "parameters": {
+ "api-version": "2020-05-01",
+ "subscriptionId": "{subscriptionId}",
+ "periodStartDate": "2018-01-01",
+ "periodEndDate": "2018-06-30"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingSubscriptions/11000000-0000-0000-0000-000000000000/invoices/1383723",
+ "name": "1383723",
+ "type": "Microsoft.Billing/billingAccounts/billingSubscriptions/invoices",
+ "properties": {
+ "dueDate": "2018-01-16T17:32:28Z",
+ "invoiceDate": "2018-01-01T17:32:28Z",
+ "status": "Due",
+ "amountDue": {
+ "currency": "USD",
+ "value": 2000.00
+ },
+ "invoicePeriodStartDate": "2018-01-01T17:32:28Z",
+ "invoicePeriodEndDate": "2018-01-15T17:32:28Z",
+ "invoiceType": "AzureServices",
+ "purchaseOrderNumber": "123456",
+ "subscriptionId": "55000000-0000-0000-0000-000000000011"
+ }
+ },
+ {
+ "id": "providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingSubscriptions/11000000-0000-0000-0000-000000000000/invoices/1383724",
+ "name": "1383724",
+ "type": "Microsoft.Billing/billingAccounts/billingSubscriptions/invoices",
+ "properties": {
+ "dueDate": "2018-03-01T17:32:28Z",
+ "invoiceDate": "2018-02-01T17:32:28Z",
+ "status": "Paid",
+ "amountDue": {
+ "currency": "USD",
+ "value": 2000.00
+ },
+ "billedAmount": {
+ "currency": "USD",
+ "value": 2000.00
+ },
+ "invoicePeriodStartDate": "2018-02-01T17:32:28Z",
+ "invoicePeriodEndDate": "2018-02-30T17:32:28Z",
+ "invoiceType": "AzureMarketplace",
+ "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/11000000-0000-0000-0000-000000000000",
+ "billingProfileDisplayName": "Contoso Operations Billing",
+ "purchaseOrderNumber": "123456",
+ "documents": [
+ {
+ "kind": "Invoice",
+ "url": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingSubscriptions/11000000-0000-0000-0000-000000000000/invoices/1383724/download",
+ "source": "DRS"
+ }
+ ],
+ "payments": [
+ {
+ "date": "2018-01-14T17:32:28Z",
+ "paymentType": "credited",
+ "amount": {
+ "currency": "USD",
+ "value": 2000.00
+ },
+ "paymentMethodFamily": "CreditCard",
+ "paymentMethodType": "visa"
+ }
+ ],
+ "subscriptionId": "55000000-0000-0000-0000-000000000011"
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingSubscriptionsListByBillingAccount.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingSubscriptionsListByBillingAccount.json
new file mode 100644
index 000000000000..93283f3627e2
--- /dev/null
+++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingSubscriptionsListByBillingAccount.json
@@ -0,0 +1,89 @@
+{
+ "parameters": {
+ "api-version": "2020-05-01",
+ "billingAccountName": "{billingAccountName}"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "/providers/Microsoft.Billing/BillingAccounts/{billingAccountName}/billingSubscriptions/90000000-0000-0000-0000-000000000000",
+ "name": "90000000-0000-0000-0000-000000000000",
+ "type": "Microsoft.Billing/billingAccounts/billingSubscriptions",
+ "properties": {
+ "displayName": "My subscription",
+ "subscriptionId": "6b96d3f2-9008-4a9d-912f-f87744185aa3",
+ "subscriptionBillingStatus": "Active",
+ "lastMonthCharges": {
+ "currency": "USD",
+ "value": 5000.00
+ },
+ "monthToDateCharges": {
+ "currency": "USD",
+ "value": 600
+ },
+ "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/22000000-0000-0000-0000-000000000000",
+ "invoiceSectionDisplayName": "Contoso operations invoiceSection",
+ "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/11000000-0000-0000-0000-000000000000",
+ "billingProfileDisplayName": "Contoso operations billing",
+ "costCenter": "ABC1234",
+ "skuId": "0001",
+ "skuDescription": "Microsoft Azure Plan"
+ }
+ },
+ {
+ "id": "/providers/Microsoft.Billing/BillingAccounts/{billingAccountName}/billingSubscriptions/90000000-0000-0000-0000-000000000001",
+ "name": "90000000-0000-0000-0000-000000000001",
+ "type": "Microsoft.Billing/billingAccounts/billingSubscriptions",
+ "properties": {
+ "displayName": "Test subscription",
+ "subscriptionId": "6b96d3f2-9008-4a9d-912f-6b96d3f2",
+ "subscriptionBillingStatus": "Active",
+ "lastMonthCharges": {
+ "currency": "USD",
+ "value": 1000.00
+ },
+ "monthToDateCharges": {
+ "currency": "USD",
+ "value": 400
+ },
+ "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/22000000-0000-0000-0000-000000000000",
+ "invoiceSectionDisplayName": "Contoso operations invoiceSection",
+ "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/11000000-0000-0000-0000-000000000000",
+ "billingProfileDisplayName": "Contoso operations billing",
+ "costCenter": "ABC1234",
+ "skuId": "0001",
+ "skuDescription": "Microsoft Azure Plan"
+ }
+ },
+ {
+ "id": "/providers/Microsoft.Billing/BillingAccounts/{billingAccountName}/billingSubscriptions/90000000-0000-0000-0000-000000000002",
+ "name": "90000000-0000-0000-0000-000000000002",
+ "type": "Microsoft.Billing/billingAccounts/billingSubscriptions",
+ "properties": {
+ "displayName": "Dev Subscription",
+ "subscriptionId": "6b96d3f2-4a9d-9008-912f-f87744185aa3",
+ "subscriptionBillingStatus": "Active",
+ "lastMonthCharges": {
+ "currency": "USD",
+ "value": 6000.00
+ },
+ "monthToDateCharges": {
+ "currency": "USD",
+ "value": 900
+ },
+ "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/22000000-0000-0000-0000-000000000000",
+ "invoiceSectionDisplayName": "Contoso operations invoiceSection",
+ "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/11000000-0000-0000-0000-000000000000",
+ "billingProfileDisplayName": "Contoso operations billing",
+ "costCenter": "ABC1234",
+ "skuId": "0001",
+ "skuDescription": "Microsoft Azure Plan"
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingSubscriptionsListByBillingProfile.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingSubscriptionsListByBillingProfile.json
new file mode 100644
index 000000000000..ac88af9bc396
--- /dev/null
+++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingSubscriptionsListByBillingProfile.json
@@ -0,0 +1,90 @@
+{
+ "parameters": {
+ "api-version": "2020-05-01",
+ "billingAccountName": "{billingAccountName}",
+ "billingProfileName": "{billingProfileName}"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "/providers/Microsoft.Billing/BillingAccounts/{billingAccountName}/billingSubscriptions/billinSubscriptionId1",
+ "name": "billingSubscriptionId1",
+ "type": "Microsoft.Billing/billingAccounts/billingSubscriptions",
+ "properties": {
+ "displayName": "My subscription",
+ "subscriptionId": "6b96d3f2-9008-4a9d-912f-f87744185aa3",
+ "subscriptionBillingStatus": "Active",
+ "lastMonthCharges": {
+ "currency": "USD",
+ "value": 5000.00
+ },
+ "monthToDateCharges": {
+ "currency": "USD",
+ "value": 600
+ },
+ "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/22000000-0000-0000-0000-000000000000",
+ "invoiceSectionDisplayName": "Contoso operations invoiceSection",
+ "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}",
+ "billingProfileDisplayName": "Contoso operations billing",
+ "costCenter": "ABC1234",
+ "skuId": "0001",
+ "skuDescription": "Microsoft Azure Plan"
+ }
+ },
+ {
+ "id": "/providers/Microsoft.Billing/BillingAccounts/{billingAccountName}/billingSubscriptions/billinSubscriptionId2",
+ "name": "billingSubscriptionId2",
+ "type": "Microsoft.Billing/billingAccounts/billingSubscriptions",
+ "properties": {
+ "displayName": "Test subscription",
+ "subscriptionId": "6b96d3f2-9008-4a9d-912f-6b96d3f2",
+ "subscriptionBillingStatus": "Active",
+ "lastMonthCharges": {
+ "currency": "USD",
+ "value": 1000.00
+ },
+ "monthToDateCharges": {
+ "currency": "USD",
+ "value": 400
+ },
+ "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/22000000-0000-0000-0000-000000000000",
+ "invoiceSectionDisplayName": "Contoso operations invoiceSection",
+ "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}",
+ "billingProfileDisplayName": "Contoso operations billing",
+ "costCenter": "ABC1234",
+ "skuId": "0001",
+ "skuDescription": "Microsoft Azure Plan"
+ }
+ },
+ {
+ "id": "/providers/Microsoft.Billing/BillingAccounts/{billingAccountName}/billingSubscriptions/billinSubscriptionId3",
+ "name": "billingSubscriptionId3",
+ "type": "Microsoft.Billing/billingAccounts/billingSubscriptions",
+ "properties": {
+ "displayName": "Dev Subscription",
+ "subscriptionId": "6b96d3f2-4a9d-9008-912f-f87744185aa3",
+ "subscriptionBillingStatus": "Active",
+ "lastMonthCharges": {
+ "currency": "USD",
+ "value": 6000.00
+ },
+ "monthToDateCharges": {
+ "currency": "USD",
+ "value": 900
+ },
+ "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/22000000-0000-0000-0000-000000000000",
+ "invoiceSectionDisplayName": "Contoso operations invoiceSection",
+ "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}",
+ "billingProfileDisplayName": "Contoso operations billing",
+ "costCenter": "ABC1234",
+ "skuId": "0001",
+ "skuDescription": "Microsoft Azure Plan"
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingSubscriptionsListByCustomer.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingSubscriptionsListByCustomer.json
new file mode 100644
index 000000000000..966ab091b901
--- /dev/null
+++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingSubscriptionsListByCustomer.json
@@ -0,0 +1,69 @@
+{
+ "parameters": {
+ "api-version": "2020-05-01",
+ "billingAccountName": "{billingAccountName}",
+ "customerName": "{customerName}"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "/providers/Microsoft.Billing/BillingAccounts/{billingAccountName}/billingSubscriptions/billinSubscriptionId1",
+ "name": "billingSubscriptionId1",
+ "type": "Microsoft.Billing/billingAccounts/billingSubscriptions",
+ "properties": {
+ "displayName": "My subscription",
+ "subscriptionId": "6b96d3f2-9008-4a9d-912f-f87744185aa3",
+ "subscriptionBillingStatus": "Active",
+ "lastMonthCharges": {
+ "currency": "USD",
+ "value": 5000.00
+ },
+ "monthToDateCharges": {
+ "currency": "USD",
+ "value": 600.00
+ },
+ "costCenter": "ABC1234",
+ "customerId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/customers/{customerName}",
+ "customerDisplayName": "Customer1",
+ "reseller": {
+ "resellerId": "89e87bdf-a2a2-4687-925f-4c18b27bccfd",
+ "description": "Reseller1"
+ },
+ "skuId": "0002",
+ "skuDescription": "Microsoft Azure Plan for DevTest"
+ }
+ },
+ {
+ "id": "/providers/Microsoft.Billing/BillingAccounts/{billingAccountName}/billingSubscriptions/billinSubscriptionId2",
+ "name": "billingSubscriptionId2",
+ "type": "Microsoft.Billing/billingAccounts/billingSubscriptions",
+ "properties": {
+ "displayName": "Test subscription",
+ "subscriptionId": "6b96d3f2-9008-4a9d-912f-6b96d3f2",
+ "subscriptionBillingStatus": "Active",
+ "lastMonthCharges": {
+ "currency": "USD",
+ "value": 1000.00
+ },
+ "monthToDateCharges": {
+ "currency": "USD",
+ "value": 400
+ },
+ "costCenter": "ABC1234",
+ "customerId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/customers/{customerName}",
+ "customerDisplayName": "Customer1",
+ "reseller": {
+ "resellerId": "3b65b5a8-bd4f-4084-90e9-e1bd667a2b19",
+ "description": "Reseller3"
+ },
+ "skuId": "0002",
+ "skuDescription": "Microsoft Azure Plan for DevTest"
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingSubscriptionsListByInvoiceSection.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingSubscriptionsListByInvoiceSection.json
new file mode 100644
index 000000000000..b2f82cede0d2
--- /dev/null
+++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingSubscriptionsListByInvoiceSection.json
@@ -0,0 +1,91 @@
+{
+ "parameters": {
+ "api-version": "2020-05-01",
+ "billingAccountName": "{billingAccountName}",
+ "billingProfileName": "{billingProfileName}",
+ "invoiceSectionName": "{invoiceSectionName}"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "/providers/Microsoft.Billing/BillingAccounts/{billingAccountName}/billingSubscriptions/billinSubscriptionId1",
+ "name": "billingSubscriptionId1",
+ "type": "Microsoft.Billing/billingAccounts/billingSubscriptions",
+ "properties": {
+ "displayName": "My subscription",
+ "subscriptionId": "6b96d3f2-9008-4a9d-912f-f87744185aa3",
+ "subscriptionBillingStatus": "Active",
+ "lastMonthCharges": {
+ "currency": "USD",
+ "value": 5000.00
+ },
+ "monthToDateCharges": {
+ "currency": "USD",
+ "value": 600
+ },
+ "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}",
+ "invoiceSectionDisplayName": "Contoso operations invoiceSection",
+ "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/11000000-0000-0000-0000-000000000000",
+ "billingProfileDisplayName": "Contoso operations billing",
+ "costCenter": "ABC1234",
+ "skuId": "0001",
+ "skuDescription": "Microsoft Azure Plan"
+ }
+ },
+ {
+ "id": "/providers/Microsoft.Billing/BillingAccounts/{billingAccountName}/billingSubscriptions/billinSubscriptionId2",
+ "name": "billingSubscriptionId2",
+ "type": "Microsoft.Billing/billingAccounts/billingSubscriptions",
+ "properties": {
+ "displayName": "Test subscription",
+ "subscriptionId": "6b96d3f2-9008-4a9d-912f-6b96d3f2",
+ "subscriptionBillingStatus": "Active",
+ "lastMonthCharges": {
+ "currency": "USD",
+ "value": 1000.00
+ },
+ "monthToDateCharges": {
+ "currency": "USD",
+ "value": 400
+ },
+ "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}",
+ "invoiceSectionDisplayName": "Contoso operations invoiceSection",
+ "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/11000000-0000-0000-0000-000000000000",
+ "billingProfileDisplayName": "Contoso operations billing",
+ "costCenter": "ABC1234",
+ "skuId": "0001",
+ "skuDescription": "Microsoft Azure Plan"
+ }
+ },
+ {
+ "id": "/providers/Microsoft.Billing/BillingAccounts/{billingAccountName}/billingSubscriptions/billinSubscriptionId3",
+ "name": "billingSubscriptionId3",
+ "type": "Microsoft.Billing/billingAccounts/billingSubscriptions",
+ "properties": {
+ "displayName": "Dev Subscription",
+ "subscriptionId": "6b96d3f2-4a9d-9008-912f-f87744185aa3",
+ "subscriptionBillingStatus": "Active",
+ "lastMonthCharges": {
+ "currency": "USD",
+ "value": 6000.00
+ },
+ "monthToDateCharges": {
+ "currency": "USD",
+ "value": 900
+ },
+ "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}",
+ "invoiceSectionDisplayName": "Contoso operations invoiceSection",
+ "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/11000000-0000-0000-0000-000000000000",
+ "billingProfileDisplayName": "Contoso operations billing",
+ "costCenter": "ABC1234",
+ "skuId": "0001",
+ "skuDescription": "Microsoft Azure Plan"
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/Customer.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/Customer.json
new file mode 100644
index 000000000000..69251765abd1
--- /dev/null
+++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/Customer.json
@@ -0,0 +1,21 @@
+{
+ "parameters": {
+ "api-version": "2020-05-01",
+ "billingAccountName": "{billingAccountName}",
+ "customerName": "{customerName}"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/customers/{customerName}",
+ "name": "{customerName}",
+ "type": "Microsoft.Billing/billingAccounts/customers",
+ "properties": {
+ "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/11000000-0000-0000-0000-000000000000",
+ "billingProfileDisplayName": "Contoso Operations Billing",
+ "displayName": "customer1"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/CustomerPermissionsList.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/CustomerPermissionsList.json
new file mode 100644
index 000000000000..9227b211a749
--- /dev/null
+++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/CustomerPermissionsList.json
@@ -0,0 +1,27 @@
+{
+ "parameters": {
+ "api-version": "2020-05-01",
+ "billingAccountName": "{billingAccountName}",
+ "customerName": "{customerName}"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "actions": [
+ "30000000-aaaa-bbbb-cccc-200000000007",
+ "30000000-aaaa-bbbb-cccc-200000000004",
+ "30000000-aaaa-bbbb-cccc-200000000015",
+ "30000000-aaaa-bbbb-cccc-200000000009",
+ "30000000-aaaa-bbbb-cccc-200000000000",
+ "30000000-aaaa-bbbb-cccc-200000000010",
+ "30000000-aaaa-bbbb-cccc-200000000001"
+ ],
+ "notActions": []
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/CustomerPolicy.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/CustomerPolicy.json
new file mode 100644
index 000000000000..601f3d77477e
--- /dev/null
+++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/CustomerPolicy.json
@@ -0,0 +1,19 @@
+{
+ "parameters": {
+ "api-version": "2020-05-01",
+ "billingAccountName": "{billingAccountName}",
+ "customerName": "{customerName}"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/customers/{customerName}/policies/default",
+ "name": "default",
+ "type": "Microsoft.Billing/billingAccounts/customers/policies",
+ "properties": {
+ "viewCharges": "Allowed"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/CustomerWithExpand.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/CustomerWithExpand.json
new file mode 100644
index 000000000000..59bb6cd2dc4d
--- /dev/null
+++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/CustomerWithExpand.json
@@ -0,0 +1,38 @@
+{
+ "parameters": {
+ "api-version": "2020-05-01",
+ "billingAccountName": "{billingAccountName}",
+ "customerName": "{customerName}",
+ "$expand": "enabledAzurePlans,resellers"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/customers/{customerName}",
+ "name": "{customerName}",
+ "type": "Microsoft.Billing/billingAccounts/customers",
+ "properties": {
+ "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/11000000-0000-0000-0000-000000000000",
+ "billingProfileDisplayName": "Contoso Operations Billing",
+ "displayName": "customerName1",
+ "enabledAzurePlans": [
+ {
+ "skuId": "0002",
+ "skuDescription": "Microsoft Azure Plan for DevTest"
+ }
+ ],
+ "resellers": [
+ {
+ "resellerId": "89e87bdf-a2a2-4687-925f-4c18b27bccfd",
+ "description": "Reseller1"
+ },
+ {
+ "resellerId": "3b65b5a8-bd4f-4084-90e9-e1bd667a2b19",
+ "description": "Reseller2"
+ }
+ ]
+ }
+ }
+ }
+ }
+}
diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/CustomersListByBillingAccount.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/CustomersListByBillingAccount.json
new file mode 100644
index 000000000000..5cf414465d11
--- /dev/null
+++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/CustomersListByBillingAccount.json
@@ -0,0 +1,34 @@
+{
+ "parameters": {
+ "api-version": "2020-05-01",
+ "billingAccountName": "{billingAccountName}"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/customers/22000000-0000-0000-0000-000000000000",
+ "name": "22000000-0000-0000-0000-000000000000",
+ "type": "Microsoft.Billing/billingAccounts/customers",
+ "properties": {
+ "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/11000000-0000-0000-0000-000000000000",
+ "billingProfileDisplayName": "Contoso Operations Billing",
+ "displayName": "customer1"
+ }
+ },
+ {
+ "id": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/customers/22000000-0000-0000-0000-000000000011",
+ "name": "22000000-0000-0000-0000-000000000011",
+ "type": "Microsoft.Billing/billingAccounts/customers",
+ "properties": {
+ "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/11000000-0000-0000-0000-000000000000",
+ "billingProfileDisplayName": "Contoso Operations Billing",
+ "displayName": "customer2"
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/CustomersListByBillingProfile.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/CustomersListByBillingProfile.json
new file mode 100644
index 000000000000..a7eb9a6bd73e
--- /dev/null
+++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/CustomersListByBillingProfile.json
@@ -0,0 +1,35 @@
+{
+ "parameters": {
+ "api-version": "2020-05-01",
+ "billingAccountName": "{billingAccountName}",
+ "billingProfileName": "{billingProfileName}"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/customers/22000000-0000-0000-0000-000000000000",
+ "name": "22000000-0000-0000-0000-000000000000",
+ "type": "Microsoft.Billing/billingAccounts/customers",
+ "properties": {
+ "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/11000000-0000-0000-0000-000000000000",
+ "billingProfileDisplayName": "Contoso Operations Billing",
+ "displayName": "customer1"
+ }
+ },
+ {
+ "id": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/customers/22000000-0000-0000-0000-000000000011",
+ "name": "22000000-0000-0000-0000-000000000011",
+ "type": "Microsoft.Billing/billingAccounts/customers",
+ "properties": {
+ "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/11000000-0000-0000-0000-000000000000",
+ "billingProfileDisplayName": "Contoso Operations Billing",
+ "displayName": "customer2"
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/Instruction.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/Instruction.json
new file mode 100644
index 000000000000..9b4093430abe
--- /dev/null
+++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/Instruction.json
@@ -0,0 +1,22 @@
+{
+ "parameters": {
+ "api-version": "2020-05-01",
+ "billingAccountName": "{billingAccountName}",
+ "billingProfileName": "{billingProfileName}",
+ "instructionName": "{instructionName}"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/instructions/{instructionName}",
+ "name": "{instructionName}",
+ "type": "Microsoft.Billing/billingAccounts/billingProfiles/instructions",
+ "properties": {
+ "amount": 5000.0,
+ "startDate": "2019-12-30T21:26:47.997Z",
+ "endDate": "2020-12-30T21:26:47.997Z"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/InstructionsListByBillingProfile.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/InstructionsListByBillingProfile.json
new file mode 100644
index 000000000000..ab48e69d2cb5
--- /dev/null
+++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/InstructionsListByBillingProfile.json
@@ -0,0 +1,35 @@
+{
+ "parameters": {
+ "api-version": "2020-05-01",
+ "billingAccountName": "{billingAccountName}",
+ "billingProfileName": "{billingProfileName}"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/instructions/TO1:CLIN001",
+ "name": "TO1:CLIN001",
+ "type": "Microsoft.Billing/billingAccounts/billingProfiles/instructions",
+ "properties": {
+ "amount": 5000.0,
+ "startDate": "2019-12-30T21:26:47.997Z",
+ "endDate": "2020-12-30T21:26:47.997Z"
+ }
+ },
+ {
+ "id": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/instructions/TO1:CLIN002",
+ "name": "TO1:CLIN002",
+ "type": "Microsoft.Billing/billingAccounts/billingProfiles/instructions",
+ "properties": {
+ "amount": 2000.0,
+ "startDate": "2019-12-30T21:26:47.997Z",
+ "endDate": "2020-12-30T21:26:47.997Z"
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/Invoice.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/Invoice.json
new file mode 100644
index 000000000000..a956b6a06d95
--- /dev/null
+++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/Invoice.json
@@ -0,0 +1,83 @@
+{
+ "parameters": {
+ "api-version": "2020-05-01",
+ "billingAccountName": "{billingAccountName}",
+ "invoiceName": "{invoiceName}"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoices/{invoiceName}",
+ "name": "{invoiceName}",
+ "type": "Microsoft.Billing/billingAccounts/invoices",
+ "properties": {
+ "dueDate": "2018-01-16T17:32:28Z",
+ "invoiceDate": "2018-01-01T17:32:28Z",
+ "status": "Due",
+ "amountDue": {
+ "currency": "USD",
+ "value": 16.53
+ },
+ "billedAmount": {
+ "currency": "USD",
+ "value": 33.99
+ },
+ "azurePrepaymentApplied": {
+ "currency": "USD",
+ "value": 15.46
+ },
+ "creditAmount": {
+ "currency": "USD",
+ "value": 2.00
+ },
+ "freeAzureCreditApplied": {
+ "currency": "USD",
+ "value": 0.00
+ },
+ "subTotal": {
+ "currency": "USD",
+ "value": 33.99
+ },
+ "taxAmount": {
+ "currency": "USD",
+ "value": 0.00
+ },
+ "totalAmount": {
+ "currency": "USD",
+ "value": 16.53
+ },
+ "invoicePeriodStartDate": "2018-01-01T17:32:28Z",
+ "invoicePeriodEndDate": "2018-01-15T17:32:28Z",
+ "isMonthlyInvoice": false,
+ "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}",
+ "billingProfileDisplayName": "Contoso Operations Billing",
+ "purchaseOrderNumber": "123456",
+ "documents": [
+ {
+ "kind": "Invoice",
+ "url": "https://microsoft.com/invoice.pdf",
+ "source": "DRS"
+ },
+ {
+ "kind": "TaxReceipt",
+ "url": "https://microsoft.com/taxDoc.pdf",
+ "source": "DRS"
+ }
+ ],
+ "payments": [
+ {
+ "date": "2018-01-14T17:32:28Z",
+ "paymentType": "credited",
+ "amount": {
+ "currency": "USD",
+ "value": 2.00
+ },
+ "paymentMethodFamily": "CreditCard",
+ "paymentMethodType": "visa"
+ }
+ ]
+ }
+ }
+ }
+ }
+}
diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/InvoiceById.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/InvoiceById.json
new file mode 100644
index 000000000000..54b50a2366a0
--- /dev/null
+++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/InvoiceById.json
@@ -0,0 +1,82 @@
+{
+ "parameters": {
+ "api-version": "2020-05-01",
+ "invoiceName": "{invoiceName}"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoices/{invoiceName}",
+ "name": "{invoiceName}",
+ "type": "Microsoft.Billing/billingAccounts/invoices",
+ "properties": {
+ "dueDate": "2018-01-16T17:32:28Z",
+ "invoiceDate": "2018-01-01T17:32:28Z",
+ "status": "Due",
+ "amountDue": {
+ "currency": "USD",
+ "value": 16.53
+ },
+ "billedAmount": {
+ "currency": "USD",
+ "value": 33.99
+ },
+ "azurePrepaymentApplied": {
+ "currency": "USD",
+ "value": 15.46
+ },
+ "creditAmount": {
+ "currency": "USD",
+ "value": 2.00
+ },
+ "freeAzureCreditApplied": {
+ "currency": "USD",
+ "value": 0.00
+ },
+ "subTotal": {
+ "currency": "USD",
+ "value": 33.99
+ },
+ "taxAmount": {
+ "currency": "USD",
+ "value": 0.00
+ },
+ "totalAmount": {
+ "currency": "USD",
+ "value": 16.53
+ },
+ "invoicePeriodStartDate": "2018-01-01T17:32:28Z",
+ "invoicePeriodEndDate": "2018-01-15T17:32:28Z",
+ "isMonthlyInvoice": false,
+ "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}",
+ "billingProfileDisplayName": "Contoso Operations Billing",
+ "purchaseOrderNumber": "123456",
+ "documents": [
+ {
+ "kind": "Invoice",
+ "url": "https://microsoft.com/invoice.pdf",
+ "source": "DRS"
+ },
+ {
+ "kind": "TaxReceipt",
+ "url": "https://microsoft.com/taxDoc.pdf",
+ "source": "DRS"
+ }
+ ],
+ "payments": [
+ {
+ "date": "2018-01-14T17:32:28Z",
+ "paymentType": "credited",
+ "amount": {
+ "currency": "USD",
+ "value": 2.00
+ },
+ "paymentMethodFamily": "CreditCard",
+ "paymentMethodType": "visa"
+ }
+ ]
+ }
+ }
+ }
+ }
+}
diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/InvoiceDownload.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/InvoiceDownload.json
new file mode 100644
index 000000000000..9bf994a947cb
--- /dev/null
+++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/InvoiceDownload.json
@@ -0,0 +1,21 @@
+{
+ "parameters": {
+ "api-version": "2020-05-01",
+ "billingAccountName": "{billingAccountName}",
+ "invoiceName": "{invoiceName}",
+ "downloadToken": "DRS_12345"
+ },
+ "responses": {
+ "202": {
+ "headers": {
+ "Location": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoices/{invoiceName}/operationResults/invoiceDownload_11000000-0000-0000-0000-000000000000?api-version=2020-05-01",
+ "Retry-After": "10"
+ }
+ },
+ "200": {
+ "body": {
+ "url": "https://myaccount.blob.core.windows.net/invoices/1383724.pdf?sv=2019-02-02&sr=b&sp=r"
+ }
+ }
+ }
+}
diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/InvoiceSection.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/InvoiceSection.json
new file mode 100644
index 000000000000..c751111a6438
--- /dev/null
+++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/InvoiceSection.json
@@ -0,0 +1,25 @@
+{
+ "parameters": {
+ "api-version": "2020-05-01",
+ "billingAccountName": "{billingAccountName}",
+ "billingProfileName": "{billingProfileName}",
+ "invoiceSectionName": "{invoiceSectionName}"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}",
+ "name": "{invoiceSectionName}",
+ "type": "Microsoft.Billing/billingAccounts/billingProfiles/invoiceSections",
+ "properties": {
+ "displayName": "invoiceSection1",
+ "labels": {
+ "pcCode": "A123456",
+ "costCategory": "Support"
+ },
+ "systemId": "XX1X-XXAA-XXX-ZZZ"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/InvoiceSectionPermissionsList.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/InvoiceSectionPermissionsList.json
new file mode 100644
index 000000000000..d948b9bf01b4
--- /dev/null
+++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/InvoiceSectionPermissionsList.json
@@ -0,0 +1,41 @@
+{
+ "parameters": {
+ "api-version": "2020-05-01",
+ "billingAccountName": "{billingAccountName}",
+ "billingProfileName": "{billingProfileName}",
+ "invoiceSectionName": "{invoiceSectionName}"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "actions": [
+ "10000000-aaaa-bbbb-cccc-200000000006",
+ "10000000-aaaa-bbbb-cccc-200000000003",
+ "10000000-aaaa-bbbb-cccc-200000000002",
+ "10000000-aaaa-bbbb-cccc-200000000001",
+ "10000000-aaaa-bbbb-cccc-200000000000",
+ "30000000-aaaa-bbbb-cccc-200000000007",
+ "30000000-aaaa-bbbb-cccc-200000000004",
+ "30000000-aaaa-bbbb-cccc-200000000015",
+ "20000000-aaaa-bbbb-cccc-200000000002",
+ "30000000-aaaa-bbbb-cccc-200000000009",
+ "40000000-aaaa-bbbb-cccc-200000000000",
+ "30000000-aaaa-bbbb-cccc-200000000000",
+ "20000000-aaaa-bbbb-cccc-200000000000",
+ "10000000-aaaa-bbbb-cccc-200000000008",
+ "10000000-aaaa-bbbb-cccc-200000000007",
+ "40000000-aaaa-bbbb-cccc-200000000008",
+ "40000000-aaaa-bbbb-cccc-200000000006",
+ "40000000-aaaa-bbbb-cccc-200000000007",
+ "30000000-aaaa-bbbb-cccc-200000000010",
+ "30000000-aaaa-bbbb-cccc-200000000001"
+ ],
+ "notActions": []
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/InvoiceSectionRoleAssignment.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/InvoiceSectionRoleAssignment.json
new file mode 100644
index 000000000000..d5788f6c9243
--- /dev/null
+++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/InvoiceSectionRoleAssignment.json
@@ -0,0 +1,27 @@
+{
+ "parameters": {
+ "api-version": "2020-05-01",
+ "billingAccountName": "{billingAccountName}",
+ "billingProfileName": "{billingProfileName}",
+ "invoiceSectionName": "{invoiceSectionName}",
+ "billingRoleAssignmentName": "{billingRoleAssignmentName}"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/10000000-aaaa-bbbb-cccc-100000000000_6fd330f6-7d26-4aff-b9cf-7bd699f965b9",
+ "name": "10000000-aaaa-bbbb-cccc-100000000000_6fd330f6-7d26-4aff-b9cf-7bd699f965b9",
+ "properties": {
+ "createdOn": "2018-06-21T21:34:12.2363515+00:00",
+ "scope": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}",
+ "createdByPrincipalTenantId": "7ca289b9-c32d-4f01-8566-7ff93261d76f",
+ "createdByPrincipalId": "10000000-aaaa-bbbb-cccc-3fd5ff9d6aa1",
+ "principalId": "6fd330f6-7d26-4aff-b9cf-7bd699f965b9",
+ "principalTenantId": "10000000-aaaa-bbbb-cccc-2d7cd011db47",
+ "roleDefinitionId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingRoleDefinitions/50000000-aaaa-bbbb-cccc-100000000002"
+ },
+ "type": "Microsoft.Billing/billingAccounts/billingProfiles/invoiceSections/billingRoleAssignments"
+ }
+ }
+ }
+}
diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/InvoiceSectionRoleAssignmentDelete.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/InvoiceSectionRoleAssignmentDelete.json
new file mode 100644
index 000000000000..d5788f6c9243
--- /dev/null
+++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/InvoiceSectionRoleAssignmentDelete.json
@@ -0,0 +1,27 @@
+{
+ "parameters": {
+ "api-version": "2020-05-01",
+ "billingAccountName": "{billingAccountName}",
+ "billingProfileName": "{billingProfileName}",
+ "invoiceSectionName": "{invoiceSectionName}",
+ "billingRoleAssignmentName": "{billingRoleAssignmentName}"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/10000000-aaaa-bbbb-cccc-100000000000_6fd330f6-7d26-4aff-b9cf-7bd699f965b9",
+ "name": "10000000-aaaa-bbbb-cccc-100000000000_6fd330f6-7d26-4aff-b9cf-7bd699f965b9",
+ "properties": {
+ "createdOn": "2018-06-21T21:34:12.2363515+00:00",
+ "scope": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}",
+ "createdByPrincipalTenantId": "7ca289b9-c32d-4f01-8566-7ff93261d76f",
+ "createdByPrincipalId": "10000000-aaaa-bbbb-cccc-3fd5ff9d6aa1",
+ "principalId": "6fd330f6-7d26-4aff-b9cf-7bd699f965b9",
+ "principalTenantId": "10000000-aaaa-bbbb-cccc-2d7cd011db47",
+ "roleDefinitionId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingRoleDefinitions/50000000-aaaa-bbbb-cccc-100000000002"
+ },
+ "type": "Microsoft.Billing/billingAccounts/billingProfiles/invoiceSections/billingRoleAssignments"
+ }
+ }
+ }
+}
diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/InvoiceSectionRoleAssignmentList.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/InvoiceSectionRoleAssignmentList.json
new file mode 100644
index 000000000000..bc1c0400589f
--- /dev/null
+++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/InvoiceSectionRoleAssignmentList.json
@@ -0,0 +1,44 @@
+{
+ "parameters": {
+ "api-version": "2020-05-01",
+ "billingAccountName": "{billingAccountName}",
+ "billingProfileName": "{billingProfileName}",
+ "invoiceSectionName": "{invoiceSectionName}"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/10000000-aaaa-bbbb-cccc-100000000000_6fd330f6-7d26-4aff-b9cf-7bd699f965b9",
+ "name": "10000000-aaaa-bbbb-cccc-100000000000_6fd330f6-7d26-4aff-b9cf-7bd699f965b9",
+ "properties": {
+ "createdOn": "2018-06-21T21:34:12.2363515+00:00",
+ "scope": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}",
+ "createdByPrincipalTenantId": "7ca289b9-c32d-4f01-8566-7ff93261d76f",
+ "createdByPrincipalId": "10000000-aaaa-bbbb-cccc-3fd5ff9d6aa1",
+ "principalId": "6fd330f6-7d26-4aff-b9cf-7bd699f965b9",
+ "principalTenantId": "10000000-aaaa-bbbb-cccc-2d7cd011db47",
+ "roleDefinitionId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingRoleDefinitions/50000000-aaaa-bbbb-cccc-100000000002"
+ },
+ "type": "Microsoft.Billing/billingAccounts/billingProfiles/invoiceSections/billingRoleAssignments"
+ },
+ {
+ "id": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/10000000-aaaa-bbbb-cccc-100000000000_b1839933-b3ac-42ca-8112-d29c43f3ab47",
+ "name": "10000000-aaaa-bbbb-cccc-100000000000_b1839933-b3ac-42ca-8112-d29c43f3ab47",
+ "properties": {
+ "createdOn": "2018-06-21T21:58:19.9073876+00:00",
+ "scope": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}",
+ "createdByPrincipalTenantId": "7ca289b9-c32d-4f01-8566-7ff93261d76f",
+ "createdByPrincipalId": "10000000-aaaa-bbbb-cccc-3fd5ff9d6aa1",
+ "principalId": "6fd330f6-7d26-4aff-b9cf-7bd699f965b9",
+ "principalTenantId": "10000000-aaaa-bbbb-cccc-2d7cd011db47",
+ "roleDefinitionId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingRoleDefinitions/50000000-aaaa-bbbb-cccc-100000000002"
+ },
+ "type": "Microsoft.Billing/billingAccounts/billingProfiles/invoiceSections/billingRoleAssignments"
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/InvoiceSectionRoleDefinition.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/InvoiceSectionRoleDefinition.json
new file mode 100644
index 000000000000..47ebe75b139f
--- /dev/null
+++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/InvoiceSectionRoleDefinition.json
@@ -0,0 +1,49 @@
+{
+ "parameters": {
+ "api-version": "2020-05-01",
+ "billingAccountName": "{billingAccountName}",
+ "billingProfileName": "{billingProfileName}",
+ "invoiceSectionName": "{invoiceSectionName}",
+ "billingRoleDefinitionName": "{billingRoleDefinitionName}"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/billingRoleDefinitions/{billingRoleDefinitionName}",
+ "name": "{billingRoleDefinitionName}",
+ "properties": {
+ "description": "The Owner role gives the user all permissions including access management rights to the invoice section.",
+ "permissions": [
+ {
+ "actions": [
+ "10000000-aaaa-bbbb-cccc-200000000000",
+ "10000000-aaaa-bbbb-cccc-200000000008",
+ "10000000-aaaa-bbbb-cccc-200000000001",
+ "10000000-aaaa-bbbb-cccc-200000000002",
+ "10000000-aaaa-bbbb-cccc-200000000003",
+ "10000000-aaaa-bbbb-cccc-200000000006",
+ "10000000-aaaa-bbbb-cccc-200000000007",
+ "20000000-aaaa-bbbb-cccc-200000000000",
+ "30000000-aaaa-bbbb-cccc-200000000000",
+ "40000000-aaaa-bbbb-cccc-200000000000",
+ "30000000-aaaa-bbbb-cccc-200000000009",
+ "20000000-aaaa-bbbb-cccc-200000000002",
+ "30000000-aaaa-bbbb-cccc-200000000015",
+ "30000000-aaaa-bbbb-cccc-200000000004",
+ "30000000-aaaa-bbbb-cccc-200000000007",
+ "30000000-aaaa-bbbb-cccc-200000000001",
+ "30000000-aaaa-bbbb-cccc-200000000010",
+ "40000000-aaaa-bbbb-cccc-200000000007",
+ "40000000-aaaa-bbbb-cccc-200000000006",
+ "40000000-aaaa-bbbb-cccc-200000000008"
+ ],
+ "notActions": []
+ }
+ ],
+ "roleName": "Invoice section owner"
+ },
+ "type": "Microsoft.Billing/billingAccounts/billingProfiles/invoiceSections/billingRoleDefinitions"
+ }
+ }
+ }
+}
diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/InvoiceSectionRoleDefinitionsList.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/InvoiceSectionRoleDefinitionsList.json
new file mode 100644
index 000000000000..735412e49a6b
--- /dev/null
+++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/InvoiceSectionRoleDefinitionsList.json
@@ -0,0 +1,84 @@
+{
+ "parameters": {
+ "api-version": "2020-05-01",
+ "billingAccountName": "{billingAccountName}",
+ "billingProfileName": "{billingProfileName}",
+ "invoiceSectionName": "{invoiceSectionName}"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/billingRoleDefinitions/10000000-aaaa-bbbb-cccc-100000000000",
+ "name": "10000000-aaaa-bbbb-cccc-100000000000",
+ "properties": {
+ "description": "The Owner role gives the user all permissions including access management rights to the invoice section.",
+ "permissions": [
+ {
+ "actions": [
+ "10000000-aaaa-bbbb-cccc-200000000000",
+ "10000000-aaaa-bbbb-cccc-200000000008",
+ "10000000-aaaa-bbbb-cccc-200000000001",
+ "10000000-aaaa-bbbb-cccc-200000000002",
+ "10000000-aaaa-bbbb-cccc-200000000003",
+ "10000000-aaaa-bbbb-cccc-200000000006",
+ "10000000-aaaa-bbbb-cccc-200000000007",
+ "20000000-aaaa-bbbb-cccc-200000000000",
+ "30000000-aaaa-bbbb-cccc-200000000000",
+ "40000000-aaaa-bbbb-cccc-200000000000",
+ "30000000-aaaa-bbbb-cccc-200000000009",
+ "20000000-aaaa-bbbb-cccc-200000000002",
+ "30000000-aaaa-bbbb-cccc-200000000015",
+ "30000000-aaaa-bbbb-cccc-200000000004",
+ "30000000-aaaa-bbbb-cccc-200000000007",
+ "30000000-aaaa-bbbb-cccc-200000000001",
+ "30000000-aaaa-bbbb-cccc-200000000010",
+ "40000000-aaaa-bbbb-cccc-200000000007",
+ "40000000-aaaa-bbbb-cccc-200000000006",
+ "40000000-aaaa-bbbb-cccc-200000000008"
+ ],
+ "notActions": []
+ }
+ ],
+ "roleName": "Invoice section owner"
+ },
+ "type": "Microsoft.Billing/billingAccounts/billingProfiles/invoiceSections/billingRoleDefinitions"
+ },
+ {
+ "id": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/billingRoleDefinitions/10000000-aaaa-bbbb-cccc-100000000001",
+ "name": "10000000-aaaa-bbbb-cccc-100000000001",
+ "properties": {
+ "description": "The Contributor role give the user all permissions except access management rights to the invoice section.",
+ "permissions": [
+ {
+ "actions": [
+ "10000000-aaaa-bbbb-cccc-200000000008",
+ "10000000-aaaa-bbbb-cccc-200000000001",
+ "10000000-aaaa-bbbb-cccc-200000000002",
+ "10000000-aaaa-bbbb-cccc-200000000003",
+ "10000000-aaaa-bbbb-cccc-200000000006",
+ "10000000-aaaa-bbbb-cccc-200000000007",
+ "30000000-aaaa-bbbb-cccc-200000000009",
+ "20000000-aaaa-bbbb-cccc-200000000002",
+ "30000000-aaaa-bbbb-cccc-200000000015",
+ "30000000-aaaa-bbbb-cccc-200000000004",
+ "30000000-aaaa-bbbb-cccc-200000000007",
+ "30000000-aaaa-bbbb-cccc-200000000001",
+ "30000000-aaaa-bbbb-cccc-200000000010",
+ "40000000-aaaa-bbbb-cccc-200000000007",
+ "40000000-aaaa-bbbb-cccc-200000000006",
+ "40000000-aaaa-bbbb-cccc-200000000008"
+ ],
+ "notActions": []
+ }
+ ],
+ "roleName": "Invoice section contributor"
+ },
+ "type": "Microsoft.Billing/billingAccounts/billingProfiles/invoiceSections/billingRoleDefinitions"
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/InvoiceSectionsListByBillingProfile.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/InvoiceSectionsListByBillingProfile.json
new file mode 100644
index 000000000000..e3bda0d87fb7
--- /dev/null
+++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/InvoiceSectionsListByBillingProfile.json
@@ -0,0 +1,41 @@
+{
+ "parameters": {
+ "api-version": "2020-05-01",
+ "billingAccountName": "{billingAccountName}",
+ "billingProfileName": "{billingProfileName}"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/22000000-0000-0000-0000-000000000000",
+ "name": "22000000-0000-0000-0000-000000000000",
+ "type": "Microsoft.Billing/billingAccounts/billingProfiles/invoiceSections",
+ "properties": {
+ "displayName": "invoiceSection1",
+ "labels": {
+ "pcCode": "A123456",
+ "costCategory": "Support"
+ },
+ "systemId": "XX1X-XXAA-XXX-ZZZ"
+ }
+ },
+ {
+ "id": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/22000000-0000-0000-0000-000000000011",
+ "name": "22000000-0000-0000-0000-000000000011",
+ "type": "Microsoft.Billing/billingAccounts/billingProfiles/invoiceSections",
+ "properties": {
+ "displayName": "invoiceSection2",
+ "labels": {
+ "pcCode": "Z223456",
+ "costCategory": "Marketing"
+ },
+ "systemId": "YY1X-BBAA-XXX-ZZZ"
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/InvoiceSectionsListWithCreateSubPermission.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/InvoiceSectionsListWithCreateSubPermission.json
new file mode 100644
index 000000000000..26aea84f6b4b
--- /dev/null
+++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/InvoiceSectionsListWithCreateSubPermission.json
@@ -0,0 +1,35 @@
+{
+ "parameters": {
+ "api-version": "2020-05-01",
+ "billingAccountName": "{billingAccountName}"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/11000000-0000-0000-0000-000000000000/invoiceSections/22000000-0000-0000-0000-000000000000",
+ "invoiceSectionDisplayName": "invoiceSection1",
+ "invoiceSectionSystemId": "9XXX-11XX-XX1-XXXX-XXX",
+ "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/11000000-0000-0000-0000-000000000000",
+ "billingProfileDisplayName": "Contoso operations billing",
+ "billingProfileStatus": "Warned",
+ "billingProfileStatusReasonCode": "PastDue",
+ "billingProfileSpendingLimit": "On",
+ "billingProfileSystemId": "1XXX-11XX-XX1-XXXX-XXX",
+ "enabledAzurePlans": [
+ {
+ "skuId": "0001",
+ "skuDescription": "Microsoft Azure Plan"
+ },
+ {
+ "skuId": "0002",
+ "skuDescription": "Microsoft Azure Plan for DevTest"
+ }
+ ]
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/InvoicesListByBillingProfile.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/InvoicesListByBillingProfile.json
new file mode 100644
index 000000000000..f2dd0ffc9c42
--- /dev/null
+++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/InvoicesListByBillingProfile.json
@@ -0,0 +1,161 @@
+{
+ "parameters": {
+ "api-version": "2020-05-01",
+ "billingAccountName": "{billingAccountName}",
+ "billingProfileName": "{billingProfileName}",
+ "periodStartDate": "2018-01-01",
+ "periodEndDate": "2018-06-30"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoices/1383723",
+ "name": "1383723",
+ "type": "Microsoft.Billing/billingAccounts/invoices",
+ "properties": {
+ "dueDate": "2018-01-16T17:32:28Z",
+ "invoiceDate": "2018-01-01T17:32:28Z",
+ "status": "Due",
+ "amountDue": {
+ "currency": "USD",
+ "value": 8.53
+ },
+ "billedAmount": {
+ "currency": "USD",
+ "value": 33.99
+ },
+ "azurePrepaymentApplied": {
+ "currency": "USD",
+ "value": 25.46
+ },
+ "creditAmount": {
+ "currency": "USD",
+ "value": 1.00
+ },
+ "freeAzureCreditApplied": {
+ "currency": "USD",
+ "value": 0.00
+ },
+ "subTotal": {
+ "currency": "USD",
+ "value": 33.99
+ },
+ "taxAmount": {
+ "currency": "USD",
+ "value": 0.00
+ },
+ "totalAmount": {
+ "currency": "USD",
+ "value": 7.53
+ },
+ "invoicePeriodStartDate": "2018-01-01T17:32:28Z",
+ "invoicePeriodEndDate": "2018-01-15T17:32:28Z",
+ "isMonthlyInvoice": false,
+ "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}",
+ "billingProfileDisplayName": "Contoso Operations Billing",
+ "purchaseOrderNumber": "123456",
+ "documents": [
+ {
+ "kind": "Invoice",
+ "url": "https://microsoft.com/invoice.pdf",
+ "source": "DRS"
+ },
+ {
+ "kind": "TaxReceipt",
+ "url": "https://microsoft.com/taxDoc.pdf",
+ "source": "DRS"
+ }
+ ],
+ "payments": [
+ {
+ "date": "2018-01-14T17:32:28Z",
+ "paymentType": "credited",
+ "amount": {
+ "currency": "USD",
+ "value": 1.00
+ },
+ "paymentMethodFamily": "CreditCard",
+ "paymentMethodType": "visa"
+ }
+ ]
+ }
+ },
+ {
+ "id": "providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoices/1383724",
+ "name": "1383724",
+ "type": "Microsoft.Billing/billingAccounts/invoices",
+ "properties": {
+ "dueDate": "2018-03-01T17:32:28Z",
+ "invoiceDate": "2018-01-01T17:32:28Z",
+ "status": "Due",
+ "amountDue": {
+ "currency": "USD",
+ "value": 16.53
+ },
+ "billedAmount": {
+ "currency": "USD",
+ "value": 33.99
+ },
+ "azurePrepaymentApplied": {
+ "currency": "USD",
+ "value": 15.46
+ },
+ "creditAmount": {
+ "currency": "USD",
+ "value": 2.00
+ },
+ "freeAzureCreditApplied": {
+ "currency": "USD",
+ "value": 0.00
+ },
+ "subTotal": {
+ "currency": "USD",
+ "value": 33.99
+ },
+ "taxAmount": {
+ "currency": "USD",
+ "value": 0.00
+ },
+ "totalAmount": {
+ "currency": "USD",
+ "value": 16.53
+ },
+ "invoicePeriodStartDate": "2018-02-01T17:32:28Z",
+ "invoicePeriodEndDate": "2018-02-28T17:32:28Z",
+ "isMonthlyInvoice": true,
+ "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}",
+ "billingProfileDisplayName": "Contoso Operations Billing",
+ "purchaseOrderNumber": "123456",
+ "documents": [
+ {
+ "kind": "Invoice",
+ "url": "https://microsoft.com/invoice.pdf",
+ "source": "DRS"
+ },
+ {
+ "kind": "TaxReceipt",
+ "url": "https://microsoft.com/taxDoc.pdf",
+ "source": "DRS"
+ }
+ ],
+ "payments": [
+ {
+ "date": "2018-01-14T17:32:28Z",
+ "paymentType": "credited",
+ "amount": {
+ "currency": "USD",
+ "value": 2.00
+ },
+ "paymentMethodFamily": "CreditCard",
+ "paymentMethodType": "visa"
+ }
+ ]
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/MoveBillingSubscription.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/MoveBillingSubscription.json
new file mode 100644
index 000000000000..91fbf144a862
--- /dev/null
+++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/MoveBillingSubscription.json
@@ -0,0 +1,42 @@
+{
+ "parameters": {
+ "api-version": "2020-05-01",
+ "billingAccountName": "{billingAccountName}",
+ "subscriptionId": "{subscriptionId}",
+ "parameters": {
+ "destinationInvoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{newInvoiceSectionName}"
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "properties": {
+ "displayName": "My Subscription",
+ "subscriptionId": "6b96d3f2-9008-4a9d-912f-f87744185aa3",
+ "subscriptionBillingStatus": "Active",
+ "lastMonthCharges": {
+ "currency": "USD",
+ "value": 5000.00
+ },
+ "monthToDateCharges": {
+ "currency": "USD",
+ "value": 600
+ },
+ "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/11000000-0000-0000-0000-000000000000/invoiceSections/22000000-0000-0000-0000-000000000000",
+ "invoiceSectionDisplayName": "Contoso operations invoiceSection",
+ "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/11000000-0000-0000-0000-000000000000",
+ "billingProfileDisplayName": "Contoso operations billing",
+ "costCenter": "ABC1234",
+ "skuId": "0001",
+ "skuDescription": "Microsoft Azure Plan"
+ }
+ }
+ },
+ "202": {
+ "headers": {
+ "Location": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/operationResults/moveBillingSubscription_11000000-0000-0000-0000-000000000000:22000000-0000-0000-0000-000000000000:{subscriptionId}:44000000-0000-0000-0000-000000000055:10000000-0000-0000-0000-000000000001?api-version=2020-05-01",
+ "Retry-After": "30"
+ }
+ }
+ }
+}
diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/MoveProduct.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/MoveProduct.json
new file mode 100644
index 000000000000..78387257995c
--- /dev/null
+++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/MoveProduct.json
@@ -0,0 +1,49 @@
+{
+ "parameters": {
+ "api-version": "2020-05-01",
+ "billingAccountName": "{billingAccountName}",
+ "productName": "{productName}",
+ "parameters": {
+ "destinationInvoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{newInvoiceSectionName}"
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/providers/Microsoft.Billing/BillingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{newInvoiceSectionName}/products/{productName}",
+ "name": "{productName}",
+ "type": "Microsoft.Billing/billingAccounts/products",
+ "properties": {
+ "autoRenew": "On",
+ "productTypeId": "A12345",
+ "productType": "Subscription",
+ "displayName": "Test Product",
+ "status": "Active",
+ "purchaseDate": "2018-05-01T17:32:28Z",
+ "lastCharge": {
+ "currency": "USD",
+ "value": 5000.00
+ },
+ "lastChargeDate": "2018-06-15T17:32:28Z",
+ "billingFrequency": "Monthly",
+ "quantity": 4,
+ "skuId": "0001",
+ "skuDescription": "Enterprise Agreement Development",
+ "tenantId": "515a6d36-aaf8-4ca2-a5e8-c45deb0c5cce",
+ "availabilityId": "AvailabilityId1",
+ "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{newBillingProfileName}/invoiceSections/{newInvoiceSectionName}",
+ "invoiceSectionDisplayName": "Contoso operations invoiceSection",
+ "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/11000000-0000-0000-0000-000000000000",
+ "billingProfileDisplayName": "Contoso operations billing"
+ }
+ }
+ },
+ "202": {
+ "headers": {
+ "Location": "https://management.azure.com/providers/Microsoft.Billing/operationResults/44000000-0000-0000-0000-000000000000?api-version=2020-05-01",
+ "Retry-After": "60",
+ "OData-EntityId": "44000000-0000-0000-0000-000000000000"
+ }
+ }
+ }
+}
diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/Policy.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/Policy.json
new file mode 100644
index 000000000000..f625de03e3d1
--- /dev/null
+++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/Policy.json
@@ -0,0 +1,21 @@
+{
+ "parameters": {
+ "api-version": "2020-05-01",
+ "billingAccountName": "{billingAccountName}",
+ "billingProfileName": "{billingProfileName}"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/policies/default",
+ "name": "default",
+ "type": "Microsoft.Billing/billingAccounts/billingProfiles/policies",
+ "properties": {
+ "marketplacePurchases": "AllAllowed",
+ "reservationPurchases": "Allowed",
+ "viewCharges": "Allowed"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/Product.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/Product.json
new file mode 100644
index 000000000000..5a2061c7b298
--- /dev/null
+++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/Product.json
@@ -0,0 +1,39 @@
+{
+ "parameters": {
+ "api-version": "2020-05-01",
+ "billingAccountName": "{billingAccountName}",
+ "productName": "{productName}"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/providers/Microsoft.Billing/BillingAccounts/{billingAccountName}/products/{productName}",
+ "name": "{productName}",
+ "type": "Microsoft.Billing/billingAccounts/products",
+ "properties": {
+ "autoRenew": "On",
+ "productTypeId": "A12345",
+ "productType": "Subscription",
+ "displayName": "AIP Dev",
+ "status": "Active",
+ "purchaseDate": "2018-05-01T17:32:28Z",
+ "lastCharge": {
+ "currency": "USD",
+ "value": 5000.00
+ },
+ "lastChargeDate": "2018-06-15T17:32:28Z",
+ "billingFrequency": "Monthly",
+ "quantity": 4,
+ "skuId": "0001",
+ "skuDescription": "Enterprise Agreement Development",
+ "tenantId": "515a6d36-aaf8-4ca2-a5e8-c45deb0c5cce",
+ "availabilityId": "AvailabilityId1",
+ "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}",
+ "invoiceSectionDisplayName": "Contoso operations invoiceSection",
+ "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/11000000-0000-0000-0000-000000000000",
+ "billingProfileDisplayName": "Contoso operations billing"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/ProductsListByBillingAccount.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/ProductsListByBillingAccount.json
new file mode 100644
index 000000000000..764393d75c29
--- /dev/null
+++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/ProductsListByBillingAccount.json
@@ -0,0 +1,70 @@
+{
+ "parameters": {
+ "api-version": "2020-05-01",
+ "billingAccountName": "{billingAccountName}"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "/providers/Microsoft.Billing/BillingAccounts/{billingAccountName}/products/00000000-0000-0000-0000-000000000000",
+ "name": "00000000-0000-0000-0000-000000000000",
+ "type": "Microsoft.Billing/billingAccounts/products",
+ "properties": {
+ "autoRenew": "On",
+ "productTypeId": "A12345",
+ "productType": "Reservation",
+ "displayName": "Eng Reservation (1a13s21awe)",
+ "status": "Active",
+ "purchaseDate": "2018-05-01T17:32:28Z",
+ "lastCharge": {
+ "currency": "USD",
+ "value": 5000.00
+ },
+ "lastChargeDate": "2018-06-15T17:32:28Z",
+ "quantity": 4,
+ "skuId": "0001",
+ "skuDescription": "Enterprise Agreement Development",
+ "tenantId": "515a6d36-aaf8-4ca2-a5e8-c45deb0c5cce",
+ "availabilityId": "AvailabilityId1",
+ "billingFrequency": "OneTime",
+ "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/22000000-0000-0000-0000-000000000000",
+ "invoiceSectionDisplayName": "Contoso operations invoiceSection",
+ "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/11000000-0000-0000-0000-000000000000",
+ "billingProfileDisplayName": "Contoso operations billing"
+ }
+ },
+ {
+ "id": "/providers/Microsoft.Billing/BillingAccounts/{billingAccountName}/products/10000000-0000-0000-0000-000000000001",
+ "name": "10000000-0000-0000-0000-000000000001",
+ "type": "Microsoft.Billing/billingAccounts/products",
+ "properties": {
+ "autoRenew": "On",
+ "productTypeId": "A12345",
+ "productType": "Azure subscription",
+ "displayName": "Engineering Email",
+ "status": "Active",
+ "purchaseDate": "2018-04-01T17:32:28Z",
+ "lastCharge": {
+ "currency": "USD",
+ "value": 5000.00
+ },
+ "lastChargeDate": "2018-06-15T17:32:28Z",
+ "quantity": 4,
+ "skuId": "0001",
+ "skuDescription": "Enterprise Agreement Development",
+ "tenantId": "515a6d36-aaf8-4ca2-a5e8-c45deb0c5cce",
+ "availabilityId": "AvailabilityId1",
+ "billingFrequency": "Monthly",
+ "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/22000000-0000-0000-0000-000000000000",
+ "invoiceSectionDisplayName": "Contoso operations invoiceSection",
+ "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/11000000-0000-0000-0000-000000000000",
+ "billingProfileDisplayName": "Contoso operations billing"
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/ProductsListByBillingProfile.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/ProductsListByBillingProfile.json
new file mode 100644
index 000000000000..67a72146df6b
--- /dev/null
+++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/ProductsListByBillingProfile.json
@@ -0,0 +1,71 @@
+{
+ "parameters": {
+ "api-version": "2020-05-01",
+ "billingAccountName": "{billingAccountName}",
+ "billingProfileName": "{billingProfileName}"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "/providers/Microsoft.Billing/BillingAccounts/{billingAccountName}/products/00000000-0000-0000-0000-000000000000",
+ "name": "00000000-0000-0000-0000-000000000000",
+ "type": "Microsoft.Billing/billingAccounts/products",
+ "properties": {
+ "autoRenew": "On",
+ "productTypeId": "A12345",
+ "productType": "Reservation",
+ "displayName": "Eng Reservation (1a13s21awe)",
+ "status": "Active",
+ "purchaseDate": "2018-05-01T17:32:28Z",
+ "lastCharge": {
+ "currency": "USD",
+ "value": 5000.00
+ },
+ "lastChargeDate": "2018-06-15T17:32:28Z",
+ "quantity": 4,
+ "skuId": "0001",
+ "skuDescription": "Enterprise Agreement Development",
+ "tenantId": "515a6d36-aaf8-4ca2-a5e8-c45deb0c5cce",
+ "availabilityId": "AvailabilityId1",
+ "billingFrequency": "OneTime",
+ "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/22000000-0000-0000-0000-000000000000",
+ "invoiceSectionDisplayName": "Contoso operations invoiceSection",
+ "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/11000000-0000-0000-0000-000000000000",
+ "billingProfileDisplayName": "Contoso operations billing"
+ }
+ },
+ {
+ "id": "/providers/Microsoft.Billing/BillingAccounts/{billingAccountName}/products/10000000-0000-0000-0000-000000000001",
+ "name": "10000000-0000-0000-0000-000000000001",
+ "type": "Microsoft.Billing/billingAccounts/products",
+ "properties": {
+ "autoRenew": "On",
+ "productTypeId": "A12345",
+ "productType": "Azure subscription",
+ "displayName": "Engineering Email",
+ "status": "Active",
+ "purchaseDate": "2018-04-01T17:32:28Z",
+ "lastCharge": {
+ "currency": "USD",
+ "value": 5000.00
+ },
+ "lastChargeDate": "2018-06-15T17:32:28Z",
+ "quantity": 4,
+ "skuId": "0001",
+ "skuDescription": "Enterprise Agreement Development",
+ "tenantId": "515a6d36-aaf8-4ca2-a5e8-c45deb0c5cce",
+ "availabilityId": "AvailabilityId1",
+ "billingFrequency": "Monthly",
+ "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/22000000-0000-0000-0000-000000000000",
+ "invoiceSectionDisplayName": "Contoso operations invoiceSection",
+ "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/11000000-0000-0000-0000-000000000000",
+ "billingProfileDisplayName": "Contoso operations billing"
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/ProductsListByCustomer.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/ProductsListByCustomer.json
new file mode 100644
index 000000000000..ff18e2fdfe07
--- /dev/null
+++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/ProductsListByCustomer.json
@@ -0,0 +1,75 @@
+{
+ "parameters": {
+ "api-version": "2020-05-01",
+ "billingAccountName": "{billingAccountName}",
+ "customerName": "{customerName}"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "/providers/Microsoft.Billing/BillingAccounts/{billingAccountName}/products/00000000-0000-0000-0000-000000000000",
+ "name": "00000000-0000-0000-0000-000000000000",
+ "type": "Microsoft.Billing/billingAccounts/products",
+ "properties": {
+ "autoRenew": "On",
+ "productTypeId": "A12345",
+ "productType": "Reservation",
+ "displayName": "Eng Reservation (1a13s21awe)",
+ "status": "Active",
+ "purchaseDate": "2018-05-01T17:32:28Z",
+ "lastCharge": {
+ "currency": "USD",
+ "value": 5000.00
+ },
+ "lastChargeDate": "2018-06-15T17:32:28Z",
+ "billingFrequency": "OneTime",
+ "quantity": 4,
+ "skuId": "0001",
+ "skuDescription": "Enterprise Agreement Development",
+ "tenantId": "515a6d36-aaf8-4ca2-a5e8-c45deb0c5cce",
+ "availabilityId": "AvailabilityId1",
+ "customerId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/customers/{customerName}",
+ "customerDisplayName": "Customer 1",
+ "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/11000000-0000-0000-0000-000000000000",
+ "billingProfileDisplayName": "Contoso operations billing",
+ "reseller": {
+ "resellerId": "2c917292-b7bc-42f2-99a2-e498b9087c06",
+ "description": "Reseller1"
+ }
+ }
+ },
+ {
+ "id": "/providers/Microsoft.Billing/BillingAccounts/{billingAccountName}/products/10000000-0000-0000-0000-000000000001",
+ "name": "10000000-0000-0000-0000-000000000001",
+ "type": "Microsoft.Billing/billingAccounts/products",
+ "properties": {
+ "autoRenew": "On",
+ "productTypeId": "A12345",
+ "productType": "Azure subscription",
+ "displayName": "Engineering Email",
+ "status": "Active",
+ "purchaseDate": "2018-04-01T17:32:28Z",
+ "lastCharge": {
+ "currency": "USD",
+ "value": 500.00
+ },
+ "lastChargeDate": "2018-06-15T17:32:28Z",
+ "billingFrequency": "Monthly",
+ "quantity": 4,
+ "skuId": "0001",
+ "skuDescription": "Enterprise Agreement Development",
+ "tenantId": "515a6d36-aaf8-4ca2-a5e8-c45deb0c5cce",
+ "availabilityId": "AvailabilityId1",
+ "customerId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/customers/{customerName}",
+ "customerDisplayName": "Customer 1",
+ "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/11000000-0000-0000-0000-000000000000",
+ "billingProfileDisplayName": "Contoso operations billing"
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/ProductsListByInvoiceSection.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/ProductsListByInvoiceSection.json
new file mode 100644
index 000000000000..d2a538072eea
--- /dev/null
+++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/ProductsListByInvoiceSection.json
@@ -0,0 +1,71 @@
+{
+ "parameters": {
+ "api-version": "2020-05-01",
+ "billingAccountName": "{billingAccountName}",
+ "billingProfileName": "{billingProfileName}",
+ "invoiceSectionName": "{invoiceSectionName}"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "/providers/Microsoft.Billing/BillingAccounts/{billingAccountName}/products/00000000-0000-0000-0000-000000000000",
+ "name": "00000000-0000-0000-0000-000000000000",
+ "type": "Microsoft.Billing/billingAccounts/products",
+ "properties": {
+ "autoRenew": "On",
+ "productTypeId": "A12345",
+ "productType": "Reservation",
+ "displayName": "Eng Reservation (1a13s21awe)",
+ "status": "Active",
+ "purchaseDate": "2018-05-01T17:32:28Z",
+ "lastCharge": {
+ "currency": "USD",
+ "value": 5000.00
+ },
+ "lastChargeDate": "2018-06-15T17:32:28Z",
+ "billingFrequency": "OneTime",
+ "quantity": 4,
+ "skuId": "0001",
+ "skuDescription": "Enterprise Agreement Development",
+ "tenantId": "515a6d36-aaf8-4ca2-a5e8-c45deb0c5cce",
+ "availabilityId": "AvailabilityId1",
+ "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}",
+ "invoiceSectionDisplayName": "Contoso operations invoiceSection",
+ "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/11000000-0000-0000-0000-000000000000",
+ "billingProfileDisplayName": "Contoso operations billing"
+ }
+ },
+ {
+ "id": "/providers/Microsoft.Billing/BillingAccounts/{billingAccountName}/products/10000000-0000-0000-0000-000000000001",
+ "name": "10000000-0000-0000-0000-000000000001",
+ "type": "Microsoft.Billing/billingAccounts/products",
+ "properties": {
+ "autoRenew": "On",
+ "productTypeId": "A12345",
+ "productType": "Azure subscription",
+ "displayName": "Engineering Email",
+ "status": "Active",
+ "purchaseDate": "2018-04-01T17:32:28Z",
+ "lastCharge": {
+ "currency": "USD",
+ "value": 500.00
+ },
+ "lastChargeDate": "2018-06-15T17:32:28Z",
+ "billingFrequency": "Monthly",
+ "quantity": 4,
+ "skuId": "0001",
+ "skuDescription": "Enterprise Agreement Development",
+ "availabilityId": "AvailabilityId1",
+ "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}",
+ "invoiceSectionDisplayName": "Contoso operations invoiceSection",
+ "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/11000000-0000-0000-0000-000000000000",
+ "billingProfileDisplayName": "Contoso operations billing"
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/PutBillingProfile.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/PutBillingProfile.json
new file mode 100644
index 000000000000..34cd9b1a3b3a
--- /dev/null
+++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/PutBillingProfile.json
@@ -0,0 +1,76 @@
+{
+ "parameters": {
+ "api-version": "2020-05-01",
+ "billingAccountName": "{billingAccountName}",
+ "billingProfileName": "{billingProfileName}",
+ "parameters": {
+ "properties": {
+ "displayName": "Finance",
+ "billTo": {
+ "firstName": "Test",
+ "lastName": "User",
+ "addressLine1": "Test Address 1",
+ "city": "Redmond",
+ "postalCode": "12345",
+ "region": "WA",
+ "country": "US"
+ },
+ "enabledAzurePlans": [
+ {
+ "skuId": "0001"
+ },
+ {
+ "skuId": "0002"
+ }
+ ],
+ "invoiceEmailOptIn": true,
+ "poNumber": "ABC12345"
+ }
+ }
+ },
+ "responses": {
+ "202": {
+ "headers": {
+ "Location": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/operationResults/putBillingProfile_00000000-0000-0000-0000-000000000000?api-version=2020-05-01",
+ "Retry-After": "60"
+ }
+ },
+ "200": {
+ "body": {
+ "id": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/billingProfileId1",
+ "name": "billingProfileId1",
+ "type": "Microsoft.Billing/billingAccounts/billingProfiles",
+ "properties": {
+ "displayName": "Finance",
+ "billTo": {
+ "firstName": "Test",
+ "lastName": "User",
+ "addressLine1": "Test Address 1",
+ "city": "Redmond",
+ "postalCode": "12345",
+ "region": "WA",
+ "country": "US"
+ },
+ "currency": "USD",
+ "enabledAzurePlans": [
+ {
+ "skuId": "0001",
+ "skuDescription": "Microsoft Azure Plan"
+ },
+ {
+ "skuId": "0002",
+ "skuDescription": "Microsoft Azure Plan for DevTest"
+ }
+ ],
+ "invoiceDay": 5,
+ "invoiceEmailOptIn": true,
+ "poNumber": "ABC12345",
+ "hasReadAccess": true,
+ "systemId": "1XXX-11XX-XX1-XXXX-XXX",
+ "status": "Active",
+ "spendingLimit": "Off"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/PutInstruction.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/PutInstruction.json
new file mode 100644
index 000000000000..a140f1b32e61
--- /dev/null
+++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/PutInstruction.json
@@ -0,0 +1,29 @@
+{
+ "parameters": {
+ "api-version": "2020-05-01",
+ "billingAccountName": "{billingAccountName}",
+ "billingProfileName": "{billingProfileName}",
+ "instructionName": "{instructionName}",
+ "parameters": {
+ "properties": {
+ "amount": 5000.0,
+ "startDate": "2019-12-30T21:26:47.997Z",
+ "endDate": "2020-12-30T21:26:47.997Z"
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/instructions/{instructionName}",
+ "name": "{instructionName}",
+ "type": "Microsoft.Billing/billingAccounts/billingProfiles/instructions",
+ "properties": {
+ "amount": 5000.0,
+ "startDate": "2019-12-30T21:26:47.997Z",
+ "endDate": "2020-12-30T21:26:47.997Z"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/PutInvoiceSection.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/PutInvoiceSection.json
new file mode 100644
index 000000000000..363ccd587a07
--- /dev/null
+++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/PutInvoiceSection.json
@@ -0,0 +1,40 @@
+{
+ "parameters": {
+ "api-version": "2020-05-01",
+ "billingAccountName": "{billingAccountName}",
+ "billingProfileName": "{billingProfileName}",
+ "invoiceSectionName": "{invoiceSectionName}",
+ "parameters": {
+ "properties": {
+ "displayName": "invoiceSection1",
+ "labels": {
+ "pcCode": "A123456",
+ "costCategory": "Support"
+ }
+ }
+ }
+ },
+ "responses": {
+ "202": {
+ "headers": {
+ "Location": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/operationResults/putInvoiceSection_00000000-0000-0000-0000-000000000000?api-version=2020-05-01",
+ "Retry-After": "60"
+ }
+ },
+ "200": {
+ "body": {
+ "id": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}",
+ "name": "{invoiceSectionName}",
+ "type": "Microsoft.Billing/billingAccounts/billingProfiles/invoiceSections",
+ "properties": {
+ "displayName": "invoiceSection1",
+ "labels": {
+ "pcCode": "A123456",
+ "costCategory": "Support"
+ },
+ "systemId": "XX1X-XXAA-XXX-ZZZ"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/TransactionsListByInvoice.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/TransactionsListByInvoice.json
new file mode 100644
index 000000000000..3cd3d055db94
--- /dev/null
+++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/TransactionsListByInvoice.json
@@ -0,0 +1,124 @@
+{
+ "parameters": {
+ "api-version": "2020-05-01",
+ "billingAccountName": "{billingAccountName}",
+ "invoiceName": "{invoiceName}"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "/providers/Microsoft.Billing/BillingAccounts/{billingAccountName}/transactions/41000000-0000-0000-0000-000000000000",
+ "name": "41000000-0000-0000-0000-000000000000",
+ "type": "Microsoft.Billing/billingAccounts/transactions",
+ "properties": {
+ "kind": "all",
+ "date": "2018-05-01T00:00:00Z",
+ "invoice": "2344233",
+ "invoiceId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoices/2344233",
+ "productFamily": "Storage",
+ "productTypeId": "A12345",
+ "productType": "VM Instance",
+ "productDescription": "Standard D1, US West 3",
+ "transactionType": "Purchase",
+ "transactionAmount": {
+ "currency": "USD",
+ "value": 5000.00
+ },
+ "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/22000000-0000-0000-0000-000000000000",
+ "invoiceSectionDisplayName": "Contoso operations invoiceSection",
+ "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}",
+ "billingProfileDisplayName": "Contoso operations billing",
+ "azurePlan": "Microsoft Azure Plan for DevTest",
+ "azureCreditApplied": {
+ "currency": "USD",
+ "value": 2000.00
+ },
+ "billingCurrency": "USD",
+ "discount": 0.1,
+ "effectivePrice": {
+ "currency": "USD",
+ "value": 10.00
+ },
+ "exchangeRate": 1,
+ "marketPrice": {
+ "currency": "USD",
+ "value": 20.00
+ },
+ "pricingCurrency": "USD",
+ "quantity": 1,
+ "servicePeriodStartDate": "2018-05-01T00:00:00Z",
+ "servicePeriodEndDate": "2018-09-30T00:00:00Z",
+ "subTotal": {
+ "currency": "USD",
+ "value": 4500.00
+ },
+ "tax": {
+ "currency": "USD",
+ "value": 500.00
+ },
+ "unitOfMeasure": "1 Minute",
+ "units": 11.25,
+ "unitType": "1 Runtime Minute"
+ }
+ },
+ {
+ "id": "/providers/Microsoft.Billing/BillingAccounts/{billingAccountName}/transactions/51000000-0000-0000-0000-000000000000",
+ "name": "51000000-0000-0000-0000-000000000000",
+ "type": "Microsoft.Billing/billingAccounts/transactions",
+ "properties": {
+ "kind": "all",
+ "date": "2018-04-01T00:00:00Z",
+ "invoice": "pending",
+ "productFamily": "Storage",
+ "productTypeId": "A12345",
+ "productType": "VM Instance",
+ "productDescription": "Standard Support",
+ "transactionType": "Cancel",
+ "transactionAmount": {
+ "currency": "USD",
+ "value": 50.00
+ },
+ "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/22000000-0000-0000-0000-000000000000",
+ "invoiceSectionDisplayName": "Contoso operations invoiceSection",
+ "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}",
+ "billingProfileDisplayName": "Contoso operations billing",
+ "azurePlan": "Microsoft Azure Plan for DevTest",
+ "azureCreditApplied": {
+ "currency": "USD",
+ "value": 20.00
+ },
+ "billingCurrency": "USD",
+ "discount": 0.1,
+ "effectivePrice": {
+ "currency": "USD",
+ "value": 10.00
+ },
+ "exchangeRate": 1,
+ "marketPrice": {
+ "currency": "USD",
+ "value": 20.00
+ },
+ "pricingCurrency": "USD",
+ "quantity": 1,
+ "servicePeriodStartDate": "2018-05-01T00:00:00Z",
+ "servicePeriodEndDate": "2018-09-30T00:00:00Z",
+ "subTotal": {
+ "currency": "USD",
+ "value": 45.00
+ },
+ "tax": {
+ "currency": "USD",
+ "value": 5.00
+ },
+ "unitOfMeasure": "1 Minute",
+ "units": 1.25,
+ "unitType": "1 Runtime Minute"
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/UpdateBillingAccount.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/UpdateBillingAccount.json
new file mode 100644
index 000000000000..fa0dca4f26c5
--- /dev/null
+++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/UpdateBillingAccount.json
@@ -0,0 +1,53 @@
+{
+ "parameters": {
+ "api-version": "2020-05-01",
+ "billingAccountName": "{billingAccountName}",
+ "parameters": {
+ "properties": {
+ "displayName": "Test Account",
+ "soldTo": {
+ "companyName": "Contoso",
+ "firstName": "Test",
+ "lastName": "User",
+ "addressLine1": "Test Address 1",
+ "city": "Redmond",
+ "postalCode": "12345",
+ "region": "WA",
+ "country": "US"
+ }
+ }
+ }
+ },
+ "responses": {
+ "202": {
+ "headers": {
+ "Location": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/operationStatus/65e1f2bf-c31c-4b89-a599-25d9d4172af9?api-version=2020-05-01",
+ "Retry-After": "10"
+ }
+ },
+ "200": {
+ "body": {
+ "id": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}",
+ "name": "{billingAccountName}",
+ "type": "Microsoft.Billing/billingAccounts",
+ "properties": {
+ "displayName": "Test Account",
+ "agreementType": "MicrosoftCustomerAgreement",
+ "accountStatus": "Active",
+ "accountType": "Enterprise",
+ "hasReadAccess": true,
+ "soldTo": {
+ "companyName": "Contoso",
+ "firstName": "Test",
+ "lastName": "User",
+ "addressLine1": "Test Address 1",
+ "city": "Redmond",
+ "postalCode": "12345",
+ "region": "WA",
+ "country": "US"
+ }
+ }
+ }
+ }
+ }
+}
diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/UpdateBillingProperty.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/UpdateBillingProperty.json
new file mode 100644
index 000000000000..564cea55db9e
--- /dev/null
+++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/UpdateBillingProperty.json
@@ -0,0 +1,39 @@
+{
+ "parameters": {
+ "api-version": "2020-05-01",
+ "subscriptionId": "{subscriptionId}",
+ "parameters": {
+ "properties": {
+ "costCenter": "1010"
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/{subscriptionId}/providers/Microsoft.Billing/billingProperty/default",
+ "name": "default",
+ "type": "Microsoft.Billing/billingProperty",
+ "properties": {
+ "accountAdminNotificationEmailAddress": "test@contoso.com",
+ "billingTenantId": "90000000-0000-0000-0000-000000000011",
+ "billingAccountId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000_00000000-0000-0000-0000-000000000000",
+ "billingAccountDisplayName": "My Account",
+ "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000_00000000-0000-0000-0000-000000000000/billingProfiles/11000000-0000-0000-0000-000000000000",
+ "billingProfileDisplayName": "Contoso operations billing",
+ "billingProfileStatus": "Warned",
+ "billingProfileStatusReasonCode": "PastDue",
+ "billingProfileSpendingLimit": "On",
+ "costCenter": "1010",
+ "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000_00000000-0000-0000-0000-000000000000/invoiceSections/22000000-0000-0000-0000-000000000000",
+ "invoiceSectionDisplayName": "Contoso operations invoice section",
+ "isAccountAdmin": true,
+ "productId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000_00000000-0000-0000-0000-000000000000/invoiceSections/22000000-0000-0000-0000-000000000000/products/44000000-0000-0000-0000-000000000000",
+ "productName": "Standard Dev",
+ "skuId": "0001",
+ "skuDescription": "Microsoft Azure Plan for DevTest"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/UpdateBillingSubscription.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/UpdateBillingSubscription.json
new file mode 100644
index 000000000000..9b4bc71b63f3
--- /dev/null
+++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/UpdateBillingSubscription.json
@@ -0,0 +1,41 @@
+{
+ "parameters": {
+ "api-version": "2020-05-01",
+ "billingAccountName": "{billingAccountName}",
+ "subscriptionId": "{subscriptionId}",
+ "parameters": {
+ "properties": {
+ "costCenter": "ABC1234"
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/providers/Microsoft.Billing/BillingAccounts/{billingAccountName}/billingSubscriptions/{subscriptionId}",
+ "name": "{subscriptionId}",
+ "type": "Microsoft.Billing/billingAccounts/billingSubscriptions",
+ "properties": {
+ "displayName": "My Subscription",
+ "subscriptionId": "6b96d3f2-9008-4a9d-912f-f87744185aa3",
+ "subscriptionBillingStatus": "Active",
+ "lastMonthCharges": {
+ "currency": "USD",
+ "value": 5000.00
+ },
+ "monthToDateCharges": {
+ "currency": "USD",
+ "value": 600
+ },
+ "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/11000000-0000-0000-0000-000000000000/invoiceSections/22000000-0000-0000-0000-000000000000",
+ "invoiceSectionDisplayName": "Contoso operations invoiceSection",
+ "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/11000000-0000-0000-0000-000000000000",
+ "billingProfileDisplayName": "Contoso operations billing",
+ "costCenter": "ABC1234",
+ "skuId": "0001",
+ "skuDescription": "Microsoft Azure Plan"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/UpdateCustomerPolicy.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/UpdateCustomerPolicy.json
new file mode 100644
index 000000000000..c014d2859aaa
--- /dev/null
+++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/UpdateCustomerPolicy.json
@@ -0,0 +1,24 @@
+{
+ "parameters": {
+ "api-version": "2020-05-01",
+ "billingAccountName": "{billingAccountName}",
+ "customerName": "{customerName}",
+ "parameters": {
+ "properties": {
+ "viewCharges": "NotAllowed"
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/customers/{customerName}/policies/default",
+ "name": "default",
+ "type": "Microsoft.Billing/billingAccounts/customers/policies",
+ "properties": {
+ "viewCharges": "NotAllowed"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/UpdatePolicy.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/UpdatePolicy.json
new file mode 100644
index 000000000000..c85677e85d94
--- /dev/null
+++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/UpdatePolicy.json
@@ -0,0 +1,28 @@
+{
+ "parameters": {
+ "api-version": "2020-05-01",
+ "billingAccountName": "{billingAccountName}",
+ "billingProfileName": "{billingProfileName}",
+ "parameters": {
+ "properties": {
+ "marketplacePurchases": "OnlyFreeAllowed",
+ "reservationPurchases": "NotAllowed",
+ "viewCharges": "Allowed"
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/policies/default",
+ "name": "default",
+ "type": "Microsoft.Billing/billingAccounts/billingProfiles/policies",
+ "properties": {
+ "marketplacePurchases": "OnlyFreeAllowed",
+ "reservationPurchases": "NotAllowed",
+ "viewCharges": "Allowed"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/UpdateProduct.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/UpdateProduct.json
new file mode 100644
index 000000000000..5d1beb7bafc5
--- /dev/null
+++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/UpdateProduct.json
@@ -0,0 +1,44 @@
+{
+ "parameters": {
+ "api-version": "2020-05-01",
+ "billingAccountName": "{billingAccountName}",
+ "productName": "{productName}",
+ "parameters": {
+ "properties": {
+ "autoRenew": "Off"
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/providers/Microsoft.Billing/BillingAccounts/{billingAccountName}/products/{productName}",
+ "name": "{productName}",
+ "type": "Microsoft.Billing/billingAccounts/products",
+ "properties": {
+ "autoRenew": "Off",
+ "productTypeId": "A12345",
+ "productType": "Subscription",
+ "displayName": "AIP Dev",
+ "status": "Active",
+ "purchaseDate": "2018-05-01T17:32:28Z",
+ "lastCharge": {
+ "currency": "USD",
+ "value": 5000.00
+ },
+ "lastChargeDate": "2018-06-15T17:32:28Z",
+ "billingFrequency": "Monthly",
+ "quantity": 4,
+ "skuId": "0001",
+ "skuDescription": "Enterprise Agreement Development",
+ "tenantId": "515a6d36-aaf8-4ca2-a5e8-c45deb0c5cce",
+ "availabilityId": "AvailabilityId1",
+ "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}",
+ "invoiceSectionDisplayName": "Contoso operations invoiceSection",
+ "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/11000000-0000-0000-0000-000000000000",
+ "billingProfileDisplayName": "Contoso operations billing"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/ValidateProductMoveFailure.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/ValidateProductMoveFailure.json
new file mode 100644
index 000000000000..bd75b901d431
--- /dev/null
+++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/ValidateProductMoveFailure.json
@@ -0,0 +1,21 @@
+{
+ "parameters": {
+ "api-version": "2020-05-01",
+ "billingAccountName": "{billingAccountName}",
+ "productName": "{productName}",
+ "parameters": {
+ "destinationInvoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{newInvoiceSectionName}"
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "isMoveEligible": false,
+ "errorDetails": {
+ "code": "ProductTypeNotSupported",
+ "message": "Product '{productName}' is not allowed to be transferred."
+ }
+ }
+ }
+ }
+}
diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/ValidateProductMoveSuccess.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/ValidateProductMoveSuccess.json
new file mode 100644
index 000000000000..12669b188250
--- /dev/null
+++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/ValidateProductMoveSuccess.json
@@ -0,0 +1,17 @@
+{
+ "parameters": {
+ "api-version": "2020-05-01",
+ "billingAccountName": "{billingAccountName}",
+ "productName": "{productName}",
+ "parameters": {
+ "destinationInvoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{newInvoiceSectionName}"
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "isMoveEligible": true
+ }
+ }
+ }
+}
diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/ValidateSubscriptionMoveFailure.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/ValidateSubscriptionMoveFailure.json
new file mode 100644
index 000000000000..baadfc3441da
--- /dev/null
+++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/ValidateSubscriptionMoveFailure.json
@@ -0,0 +1,21 @@
+{
+ "parameters": {
+ "api-version": "2020-05-01",
+ "billingAccountName": "{billingAccountName}",
+ "subscriptionId": "{subscriptionId}",
+ "parameters": {
+ "destinationInvoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{newInvoiceSectionName}"
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "isMoveEligible": false,
+ "errorDetails": {
+ "code": "SubscriptionNotActive",
+ "message": "Invoice Sections can only be changed for active subscriptions."
+ }
+ }
+ }
+ }
+}
diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/ValidateSubscriptionMoveSuccess.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/ValidateSubscriptionMoveSuccess.json
new file mode 100644
index 000000000000..7fe8119fa29f
--- /dev/null
+++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/ValidateSubscriptionMoveSuccess.json
@@ -0,0 +1,17 @@
+{
+ "parameters": {
+ "api-version": "2020-05-01",
+ "billingAccountName": "{billingAccountName}",
+ "subscriptionId": "{subscriptionId}",
+ "parameters": {
+ "destinationInvoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{newInvoiceSectionName}"
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "isMoveEligible": true
+ }
+ }
+ }
+}
diff --git a/specification/billing/resource-manager/readme.go.md b/specification/billing/resource-manager/readme.go.md
index 73acea981762..f6bf507cb97e 100644
--- a/specification/billing/resource-manager/readme.go.md
+++ b/specification/billing/resource-manager/readme.go.md
@@ -13,12 +13,22 @@ go:
### Go multi-api
``` yaml $(go) && $(multiapi)
batch:
+ - tag: package-2020-05
- tag: package-2018-11-preview
- tag: package-2018-03-preview
- tag: package-2017-04-preview
- tag: package-2017-02-preview
```
+### Tag: package-2020-05 and go
+
+These settings apply only when `--tag=package-2020-05 --go` is specified on the command line.
+Please also specify `--go-sdk-folder=`.
+
+``` yaml $(tag) == 'package-2020-05' && $(go)
+output-folder: $(go-sdk-folder)/services/preview/$(namespace)/mgmt/2020-05-01-preview/$(namespace)
+```
+
### Tag: package-2018-11-preview and go
These settings apply only when `--tag=package-2018-11-preview --go` is specified on the command line.
diff --git a/specification/billing/resource-manager/readme.md b/specification/billing/resource-manager/readme.md
index 8bb331f5cb59..31988a610128 100644
--- a/specification/billing/resource-manager/readme.md
+++ b/specification/billing/resource-manager/readme.md
@@ -26,7 +26,16 @@ These are the global settings for the Billing API.
``` yaml
openapi-type: arm
-tag: package-2019-10-preview
+tag: package-2020-05
+```
+
+### Tag: package-2020-05
+
+These settings apply only when `--tag=package-2020-05` is specified on the command line.
+
+``` yaml $(tag) == 'package-2020-05'
+input-file:
+- Microsoft.Billing/stable/2020-05-01/billing.json
```
### Tag: package-2019-10-preview
@@ -133,6 +142,7 @@ output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-billing
``` yaml $(java) && $(multiapi)
batch:
+ - tag: package-2020-05
- tag: package-2019-10-preview
- tag: package-2018-11-preview
- tag: package-2018-03-preview
@@ -140,6 +150,19 @@ batch:
- tag: package-2017-02-preview
```
+### Tag: package-2020-05 and java
+
+These settings apply only when `--tag=package-2020-05 --java` is specified on the command line.
+Please also specify `--azure-libraries-for-java=`.
+
+``` yaml $(tag) == 'package-2020-05' && $(java) && $(multiapi)
+java:
+ namespace: com.microsoft.azure.management.billing.v2020_05_01
+ output-folder: $(azure-libraries-for-java-folder)/sdk/billing/mgmt-v2020_05_01
+regenerate-manager: true
+generate-interface: true
+```
+
### Tag: package-2019-10-preview and java
These settings apply only when `--tag=package-2019-10-preview --java` is specified on the command line.
@@ -219,6 +242,7 @@ require: $(this-folder)/../../../profiles/readme.md
# all the input files across all versions
input-file:
+ - $(this-folder)/Microsoft.Billing/stable/2020-05-01/billing.json
- $(this-folder)/Microsoft.Billing/preview/2019-10-01-preview/billing.json
- $(this-folder)/Microsoft.Billing/preview/2018-11-01-preview/billing.json
- $(this-folder)/Microsoft.Billing/preview/2018-03-01-preview/billing.json
diff --git a/specification/billing/resource-manager/readme.ruby.md b/specification/billing/resource-manager/readme.ruby.md
index 1aa6339d90ab..fcb9843607a5 100644
--- a/specification/billing/resource-manager/readme.ruby.md
+++ b/specification/billing/resource-manager/readme.ruby.md
@@ -16,6 +16,16 @@ batch:
- tag: package-2017-02-preview
```
+### Tag: package-2020-05 and ruby
+
+These settings apply only when `--tag=package-2020-05 --ruby` is specified on the command line.
+Please also specify `--ruby-sdks-folder=`.
+
+``` yaml $(tag) == 'package-2020-05' && $(ruby)
+namespace: "Azure::Billing::Mgmt::V2020_05"
+output-folder: $(ruby-sdks-folder)/management/azure_mgmt_billing/lib
+```
+
### Tag: package-2017-04-preview and ruby
These settings apply only when `--tag=package-2017-04-preview --ruby` is specified on the command line.
diff --git a/specification/blockchain/resource-manager/Microsoft.Blockchain/preview/2018-06-01-preview/examples/BlockchainMembers_Create.json b/specification/blockchain/resource-manager/Microsoft.Blockchain/preview/2018-06-01-preview/examples/BlockchainMembers_Create.json
index dc0b961b6ca7..9fcbc4debcd5 100644
--- a/specification/blockchain/resource-manager/Microsoft.Blockchain/preview/2018-06-01-preview/examples/BlockchainMembers_Create.json
+++ b/specification/blockchain/resource-manager/Microsoft.Blockchain/preview/2018-06-01-preview/examples/BlockchainMembers_Create.json
@@ -11,9 +11,9 @@
"capacity": 2
},
"protocol": "Quorum",
- "password": "$@123_34#&",
+ "password": "1234abcdEFG1",
"consortium": "ContoseConsortium",
- "consortiumManagementAccountPassword": "$@123_34#&"
+ "consortiumManagementAccountPassword": "1234abcdEFG1"
}
}
},
diff --git a/specification/blockchain/resource-manager/Microsoft.Blockchain/preview/2018-06-01-preview/examples/BlockchainMembers_Update.json b/specification/blockchain/resource-manager/Microsoft.Blockchain/preview/2018-06-01-preview/examples/BlockchainMembers_Update.json
index 0e5b08b2ba45..14f07b1e8bb6 100644
--- a/specification/blockchain/resource-manager/Microsoft.Blockchain/preview/2018-06-01-preview/examples/BlockchainMembers_Update.json
+++ b/specification/blockchain/resource-manager/Microsoft.Blockchain/preview/2018-06-01-preview/examples/BlockchainMembers_Update.json
@@ -6,8 +6,8 @@
"api-version": "2018-06-01-preview",
"blockchainMember": {
"properties": {
- "password": "$@123_34#&",
- "consortiumManagementAccountPassword": "$@123_34#&",
+ "password": "1234abcdEFG1",
+ "consortiumManagementAccountPassword": "1234abcdEFG1",
"firewallRules": null
},
"tags": null
diff --git a/specification/blockchain/resource-manager/Microsoft.Blockchain/preview/2018-06-01-preview/examples/TransactionNodes_Create.json b/specification/blockchain/resource-manager/Microsoft.Blockchain/preview/2018-06-01-preview/examples/TransactionNodes_Create.json
index c67f8c60f4f6..458faaa40e4d 100644
--- a/specification/blockchain/resource-manager/Microsoft.Blockchain/preview/2018-06-01-preview/examples/TransactionNodes_Create.json
+++ b/specification/blockchain/resource-manager/Microsoft.Blockchain/preview/2018-06-01-preview/examples/TransactionNodes_Create.json
@@ -8,7 +8,7 @@
"transactionNode": {
"location": "southeastasia",
"properties": {
- "password": "$@123_34#&"
+ "password": "1234abcdEFG1"
}
}
},
diff --git a/specification/blockchain/resource-manager/Microsoft.Blockchain/preview/2018-06-01-preview/examples/TransactionNodes_Update.json b/specification/blockchain/resource-manager/Microsoft.Blockchain/preview/2018-06-01-preview/examples/TransactionNodes_Update.json
index 4db7bf67ace2..4c336035493c 100644
--- a/specification/blockchain/resource-manager/Microsoft.Blockchain/preview/2018-06-01-preview/examples/TransactionNodes_Update.json
+++ b/specification/blockchain/resource-manager/Microsoft.Blockchain/preview/2018-06-01-preview/examples/TransactionNodes_Update.json
@@ -7,7 +7,7 @@
"api-version": "2018-06-01-preview",
"transactionNode": {
"properties": {
- "password": "$@123_34#&"
+ "password": "1234abcdEFG1"
}
}
},
diff --git a/specification/blockchain/resource-manager/readme.az.md b/specification/blockchain/resource-manager/readme.az.md
new file mode 100644
index 000000000000..a299cae2b674
--- /dev/null
+++ b/specification/blockchain/resource-manager/readme.az.md
@@ -0,0 +1,12 @@
+## AZ
+
+These settings apply only when `--az` is specified on the command line.
+
+``` yaml $(az)
+az:
+ extensions: blockchain
+ namespace: azure.mgmt.blockchain
+ package-name: azure-mgmt-blockchain
+az-output-folder: $(azure-cli-extension-folder)/src/blockchain
+python-sdk-output-folder: "$(az-output-folder)/azext_blockchain/vendored_sdks/blockchain"
+```
diff --git a/specification/blockchain/resource-manager/readme.cli.md b/specification/blockchain/resource-manager/readme.cli.md
index 643f6a056659..3b953b2334e9 100644
--- a/specification/blockchain/resource-manager/readme.cli.md
+++ b/specification/blockchain/resource-manager/readme.cli.md
@@ -1,8 +1,6 @@
-
-# Dns
-This directory contains the Cli common model for the Blockchain service.
+## CLI
-> Metadata
+These settings apply only when `--cli` is specified on the command line.
``` yaml
# Migrated from Powershell's readme
@@ -29,18 +27,4 @@ cli:
operationGroup: 'locations'
operation: 'listConsortiums'
name: 'list'
- - select: 'operationGroup'
- where:
- operationGroup: 'blockchainMemberOperationResults'
- hidden: true
- - select: 'operation'
- where:
- operationGroup: 'blockchainMembers'
- operation: '(create|update)'
- hidden: true
- - select: 'operation'
- where:
- operationGroup: 'transactionNodes'
- operation: '(create|update)'
- hidden: true
```
\ No newline at end of file
diff --git a/specification/blockchain/resource-manager/readme.md b/specification/blockchain/resource-manager/readme.md
index d0aa094d899f..806fc6ac3e2d 100644
--- a/specification/blockchain/resource-manager/readme.md
+++ b/specification/blockchain/resource-manager/readme.md
@@ -58,6 +58,7 @@ swagger-to-sdk:
- repo: azure-sdk-for-ruby
after_scripts:
- bundle install && rake arm:regen_all_profiles['azure_mgmt_blockchain']
+ - repo: azure-cli-extensions
```
## C#
diff --git a/specification/blockchain/resource-manager/readme.python.md b/specification/blockchain/resource-manager/readme.python.md
index 5e36652a4068..50680aec44a9 100644
--- a/specification/blockchain/resource-manager/readme.python.md
+++ b/specification/blockchain/resource-manager/readme.python.md
@@ -5,7 +5,7 @@ Please also specify `--python-sdks-folder= `autorest`
@@ -15,20 +15,29 @@ To build the SDK for BotService, simply [Install AutoRest](https://aka.ms/autore
To see additional help and options, run:
> `autorest --help`
+
---
## Configuration
-
-
### Basic Information
+
These are the global settings for the BotService API.
``` yaml
openapi-type: arm
-tag: package-2018-07-12
+tag: package-2020-06-02
```
+
+### Tag: package-2020-06-02
+
+These settings apply only when `--tag=package-2020-06-02` is specified on the command line.
+
+```yaml $(tag) == 'package-2020-06-02'
+input-file:
+ - Microsoft.BotService/stable/2020-06-02/botservice.json
+```
### Tag: package-2018-07-12
These settings apply only when `--tag=package-2018-07-12` is specified on the command line.
@@ -72,7 +81,9 @@ directive:
from: botservice.json
reason: The path as-is is quite descriptive.
```
+
---
+
# Code Generation
## Swagger to SDK
@@ -113,7 +124,7 @@ See configuration in [readme.java.md](./readme.java.md)
See readme.python.md file.
-## Multi-API/Profile support for AutoRest v3 generators
+## Multi-API/Profile support for AutoRest v3 generators
AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files.
@@ -130,11 +141,10 @@ input-file:
```
-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.
+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/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 0972a7347200..a67766220370 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
@@ -3921,7 +3921,7 @@
"@odata.type": {
"type": "string",
"enum": [
- "#Microsoft.Azure.Cdn.Models.OriginGroupOverrideActionParameters"
+ "#Microsoft.Azure.Cdn.Models.DeliveryRuleOriginGroupOverrideActionParameters"
]
},
"originGroup": {
diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-03-31/cdnwebapplicationfirewall.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-03-31/cdnwebapplicationfirewall.json
index 8c308c75542c..f38723617aa7 100644
--- a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-03-31/cdnwebapplicationfirewall.json
+++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-03-31/cdnwebapplicationfirewall.json
@@ -1,7 +1,7 @@
{
"swagger": "2.0",
"info": {
- "version": "2019-06-15-preview",
+ "version": "2020-03-31",
"title": "Azure CDN WebApplicationFirewallManagement",
"description": "APIs to manage web application firewall rules for Azure CDN"
},
@@ -463,10 +463,13 @@
"defaultCustomBlockResponseStatusCode": {
"description": "If the action type is block, this field defines the default customer overridable http response status code.",
"type": "integer",
- "maximum": 599,
- "exclusiveMaximum": false,
- "minimum": 200,
- "exclusiveMinimum": false
+ "enum": [
+ 200,
+ 403,
+ 405,
+ 406,
+ 429
+ ]
},
"defaultCustomBlockResponseBody": {
"description": "If the action type is block, customer can override the response body. The body must be specified in base64 encoding.",
@@ -614,7 +617,7 @@
}
},
"selector": {
- "description": "Selector can used to match a specific key for QueryString, RequestUri, RequestHeaders or RequestBody.",
+ "description": "Selector can used to match a specific key for QueryString, Cookies, RequestHeader or PostArgs.",
"type": "string"
},
"operator": {
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
new file mode 100644
index 000000000000..72cf5b68f35b
--- /dev/null
+++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/cdn.json
@@ -0,0 +1,5518 @@
+{
+ "swagger": "2.0",
+ "info": {
+ "version": "2020-04-15",
+ "title": "CdnManagementClient",
+ "description": "Use these APIs to manage Azure CDN resources through the Azure Resource Manager. You must make sure that requests made to these resources are secure."
+ },
+ "host": "management.azure.com",
+ "schemes": [
+ "https"
+ ],
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "security": [
+ {
+ "azure_auth": [
+ "user_impersonation"
+ ]
+ }
+ ],
+ "securityDefinitions": {
+ "azure_auth": {
+ "type": "oauth2",
+ "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize",
+ "flow": "implicit",
+ "description": "Azure Active Directory OAuth2 Flow.",
+ "scopes": {
+ "user_impersonation": "impersonate your user account"
+ }
+ }
+ },
+ "paths": {
+ "/subscriptions/{subscriptionId}/providers/Microsoft.Cdn/profiles": {
+ "get": {
+ "tags": [
+ "Profiles"
+ ],
+ "description": "Lists all of the CDN profiles within an Azure subscription.",
+ "operationId": "Profiles_List",
+ "x-ms-examples": {
+ "Profiles_List": {
+ "$ref": "./examples/Profiles_List.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK. The request has succeeded.",
+ "schema": {
+ "$ref": "#/definitions/ProfileListResult"
+ }
+ },
+ "default": {
+ "description": "CDN error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles": {
+ "get": {
+ "tags": [
+ "Profiles"
+ ],
+ "description": "Lists all of the CDN profiles within a resource group.",
+ "operationId": "Profiles_ListByResourceGroup",
+ "x-ms-examples": {
+ "Profiles_ListByResourceGroup": {
+ "$ref": "./examples/Profiles_ListByResourceGroup.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK. The request has succeeded.",
+ "schema": {
+ "$ref": "#/definitions/ProfileListResult"
+ }
+ },
+ "default": {
+ "description": "CDN error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}": {
+ "get": {
+ "tags": [
+ "Profiles"
+ ],
+ "description": "Gets a CDN profile with the specified profile name under the specified subscription and resource group.",
+ "operationId": "Profiles_Get",
+ "x-ms-examples": {
+ "Profiles_Get": {
+ "$ref": "./examples/Profiles_Get.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "profileName",
+ "in": "path",
+ "description": "Name of the CDN profile which is unique within the resource group.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK. The request has succeeded.",
+ "schema": {
+ "$ref": "#/definitions/Profile"
+ }
+ },
+ "default": {
+ "description": "CDN error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "Profiles"
+ ],
+ "description": "Creates a new CDN profile with a profile name under the specified subscription and resource group.",
+ "operationId": "Profiles_Create",
+ "x-ms-examples": {
+ "Profiles_Create": {
+ "$ref": "./examples/Profiles_Create.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "profileName",
+ "in": "path",
+ "description": "Name of the CDN profile which is unique within the resource group.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "description": "Profile properties needed to create a new profile.",
+ "in": "body",
+ "name": "profile",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/Profile"
+ }
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK. The request has succeeded.",
+ "schema": {
+ "$ref": "#/definitions/Profile"
+ }
+ },
+ "201": {
+ "description": "Created. The request has been fulfilled and a new profile has been created.",
+ "schema": {
+ "$ref": "#/definitions/Profile"
+ }
+ },
+ "202": {
+ "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously.",
+ "schema": {
+ "$ref": "#/definitions/Profile"
+ }
+ },
+ "default": {
+ "description": "CDN error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true
+ },
+ "patch": {
+ "tags": [
+ "Profiles"
+ ],
+ "description": "Updates an existing CDN profile with the specified profile name under the specified subscription and resource group.",
+ "operationId": "Profiles_Update",
+ "x-ms-examples": {
+ "Profiles_Update": {
+ "$ref": "./examples/Profiles_Update.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "profileName",
+ "in": "path",
+ "description": "Name of the CDN profile which is unique within the resource group.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "profileUpdateParameters",
+ "in": "body",
+ "description": "Profile properties needed to update an existing profile.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/ProfileUpdateParameters"
+ }
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK. The request has succeeded.",
+ "schema": {
+ "$ref": "#/definitions/Profile"
+ }
+ },
+ "202": {
+ "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously.",
+ "schema": {
+ "$ref": "#/definitions/Profile"
+ }
+ },
+ "default": {
+ "description": "CDN error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true
+ },
+ "delete": {
+ "tags": [
+ "Profiles"
+ ],
+ "description": "Deletes an existing CDN profile with the specified parameters. Deleting a profile will result in the deletion of all of the sub-resources including endpoints, origins and custom domains.",
+ "operationId": "Profiles_Delete",
+ "x-ms-examples": {
+ "Profiles_Delete": {
+ "$ref": "./examples/Profiles_Delete.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "profileName",
+ "in": "path",
+ "description": "Name of the CDN profile which is unique within the resource group.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "202": {
+ "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously."
+ },
+ "204": {
+ "description": "No Content. The request has been accepted but the profile was not found."
+ },
+ "default": {
+ "description": "CDN error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/generateSsoUri": {
+ "post": {
+ "tags": [
+ "Profiles"
+ ],
+ "description": "Generates a dynamic SSO URI used to sign in to the CDN supplemental portal. Supplemental portal is used to configure advanced feature capabilities that are not yet available in the Azure portal, such as core reports in a standard profile; rules engine, advanced HTTP reports, and real-time stats and alerts in a premium profile. The SSO URI changes approximately every 10 minutes.",
+ "operationId": "Profiles_GenerateSsoUri",
+ "x-ms-examples": {
+ "Profiles_GenerateSsoUri": {
+ "$ref": "./examples/Profiles_GenerateSsoUri.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "profileName",
+ "in": "path",
+ "description": "Name of the CDN profile which is unique within the resource group.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK. The request has succeeded.",
+ "schema": {
+ "$ref": "#/definitions/SsoUri"
+ }
+ },
+ "default": {
+ "description": "CDN error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/getSupportedOptimizationTypes": {
+ "post": {
+ "tags": [
+ "Profiles"
+ ],
+ "description": "Gets the supported optimization types for the current profile. A user can create an endpoint with an optimization type from the listed values.",
+ "operationId": "Profiles_ListSupportedOptimizationTypes",
+ "x-ms-examples": {
+ "Profiles_ListSupportedOptimizationTypes": {
+ "$ref": "./examples/Profiles_ListSupportedOptimizationTypes.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "profileName",
+ "in": "path",
+ "description": "Name of the CDN profile which is unique within the resource group.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK. The request has succeeded.",
+ "schema": {
+ "$ref": "#/definitions/SupportedOptimizationTypesListResult"
+ }
+ },
+ "default": {
+ "description": "CDN error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/checkResourceUsage": {
+ "post": {
+ "tags": [
+ "Profiles"
+ ],
+ "description": "Checks the quota and actual usage of endpoints under the given CDN profile.",
+ "operationId": "Profiles_ListResourceUsage",
+ "x-ms-examples": {
+ "Profiles_ListResourceUsage": {
+ "$ref": "./examples/Profiles_ListResourceUsage.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "profileName",
+ "in": "path",
+ "description": "Name of the CDN profile which is unique within the resource group.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK. The request has succeeded.",
+ "schema": {
+ "$ref": "#/definitions/ResourceUsageListResult"
+ }
+ },
+ "default": {
+ "description": "CDN error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints": {
+ "get": {
+ "tags": [
+ "Endpoints"
+ ],
+ "description": "Lists existing CDN endpoints.",
+ "operationId": "Endpoints_ListByProfile",
+ "x-ms-examples": {
+ "Endpoints_ListByProfile": {
+ "$ref": "./examples/Endpoints_ListByProfile.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "profileName",
+ "in": "path",
+ "description": "Name of the CDN profile which is unique within the resource group.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK. The request has succeeded.",
+ "schema": {
+ "$ref": "#/definitions/EndpointListResult"
+ }
+ },
+ "default": {
+ "description": "CDN error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}": {
+ "get": {
+ "tags": [
+ "Endpoints"
+ ],
+ "description": "Gets an existing CDN endpoint with the specified endpoint name under the specified subscription, resource group and profile.",
+ "operationId": "Endpoints_Get",
+ "x-ms-examples": {
+ "Endpoints_Get": {
+ "$ref": "./examples/Endpoints_Get.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "profileName",
+ "in": "path",
+ "description": "Name of the CDN profile which is unique within the resource group.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "endpointName",
+ "in": "path",
+ "description": "Name of the endpoint under the profile which is unique globally.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK. The request has succeeded.",
+ "schema": {
+ "$ref": "#/definitions/Endpoint"
+ }
+ },
+ "default": {
+ "description": "CDN error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "Endpoints"
+ ],
+ "description": "Creates a new CDN endpoint with the specified endpoint name under the specified subscription, resource group and profile.",
+ "operationId": "Endpoints_Create",
+ "x-ms-examples": {
+ "Endpoints_Create": {
+ "$ref": "./examples/Endpoints_Create.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "profileName",
+ "in": "path",
+ "description": "Name of the CDN profile which is unique within the resource group.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "endpointName",
+ "in": "path",
+ "description": "Name of the endpoint under the profile which is unique globally.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "endpoint",
+ "in": "body",
+ "description": "Endpoint properties",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/Endpoint"
+ }
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK. The request has succeeded.",
+ "schema": {
+ "$ref": "#/definitions/Endpoint"
+ }
+ },
+ "201": {
+ "description": "Created. The request has been fulfilled and a new endpoint has been created.",
+ "schema": {
+ "$ref": "#/definitions/Endpoint"
+ }
+ },
+ "202": {
+ "description": "Accepted and the operation will complete asynchronously.",
+ "schema": {
+ "$ref": "#/definitions/Endpoint"
+ }
+ },
+ "default": {
+ "description": "CDN error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true
+ },
+ "patch": {
+ "tags": [
+ "Endpoints"
+ ],
+ "description": "Updates an existing CDN endpoint with the specified endpoint name under the specified subscription, resource group and profile. Only tags can be updated after creating an endpoint. To update origins, use the Update Origin operation. To update origin groups, use the Update Origin group operation. To update custom domains, use the Update Custom Domain operation.",
+ "operationId": "Endpoints_Update",
+ "x-ms-examples": {
+ "Endpoints_Update": {
+ "$ref": "./examples/Endpoints_Update.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "profileName",
+ "in": "path",
+ "description": "Name of the CDN profile which is unique within the resource group.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "endpointName",
+ "in": "path",
+ "description": "Name of the endpoint under the profile which is unique globally.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "endpointUpdateProperties",
+ "in": "body",
+ "description": "Endpoint update properties",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/EndpointUpdateParameters"
+ }
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK. The request has succeeded.",
+ "schema": {
+ "$ref": "#/definitions/Endpoint"
+ }
+ },
+ "202": {
+ "description": "Accepted and the operation will complete asynchronously",
+ "schema": {
+ "$ref": "#/definitions/Endpoint"
+ }
+ },
+ "default": {
+ "description": "CDN error response describing why the operation failed",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true
+ },
+ "delete": {
+ "tags": [
+ "Endpoints"
+ ],
+ "description": "Deletes an existing CDN endpoint with the specified endpoint name under the specified subscription, resource group and profile.",
+ "operationId": "Endpoints_Delete",
+ "x-ms-examples": {
+ "Endpoints_Delete": {
+ "$ref": "./examples/Endpoints_Delete.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "profileName",
+ "in": "path",
+ "description": "Name of the CDN profile which is unique within the resource group.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "endpointName",
+ "in": "path",
+ "description": "Name of the endpoint under the profile which is unique globally.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "202": {
+ "description": "Accepted and the operation will complete asynchronously."
+ },
+ "204": {
+ "description": "No Content. The request has been accepted but the endpoint was not found."
+ },
+ "default": {
+ "description": "CDN error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/start": {
+ "post": {
+ "tags": [
+ "Endpoints"
+ ],
+ "description": "Starts an existing CDN endpoint that is on a stopped state.",
+ "operationId": "Endpoints_Start",
+ "x-ms-examples": {
+ "Endpoints_Start": {
+ "$ref": "./examples/Endpoints_Start.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "profileName",
+ "in": "path",
+ "description": "Name of the CDN profile which is unique within the resource group.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "endpointName",
+ "in": "path",
+ "description": "Name of the endpoint under the profile which is unique globally.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK. The request has succeeded.",
+ "schema": {
+ "$ref": "#/definitions/Endpoint"
+ }
+ },
+ "202": {
+ "description": "Accepted and the operation will complete asynchronously.",
+ "schema": {
+ "$ref": "#/definitions/Endpoint"
+ }
+ },
+ "default": {
+ "description": "CDN error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/stop": {
+ "post": {
+ "tags": [
+ "Endpoints"
+ ],
+ "description": "Stops an existing running CDN endpoint.",
+ "operationId": "Endpoints_Stop",
+ "x-ms-examples": {
+ "Endpoints_Stop": {
+ "$ref": "./examples/Endpoints_Stop.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "profileName",
+ "in": "path",
+ "description": "Name of the CDN profile which is unique within the resource group.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "endpointName",
+ "in": "path",
+ "description": "Name of the endpoint under the profile which is unique globally.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK. The request has succeeded.",
+ "schema": {
+ "$ref": "#/definitions/Endpoint"
+ }
+ },
+ "202": {
+ "description": "Accepted and the operation will complete asynchronously.",
+ "schema": {
+ "$ref": "#/definitions/Endpoint"
+ }
+ },
+ "default": {
+ "description": "CDN error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/purge": {
+ "post": {
+ "tags": [
+ "Endpoints"
+ ],
+ "description": "Removes a content from CDN.",
+ "operationId": "Endpoints_PurgeContent",
+ "x-ms-examples": {
+ "Endpoints_PurgeContent": {
+ "$ref": "./examples/Endpoints_PurgeContent.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "profileName",
+ "in": "path",
+ "description": "Name of the CDN profile which is unique within the resource group.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "endpointName",
+ "in": "path",
+ "description": "Name of the endpoint under the profile which is unique globally.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "contentFilePaths",
+ "in": "body",
+ "description": "The path to the content to be purged. Path can be a full URL, e.g. '/pictures/city.png' which removes a single file, or a directory with a wildcard, e.g. '/pictures/*' which removes all folders and files in the directory.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/PurgeParameters"
+ }
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK. The request has succeeded."
+ },
+ "202": {
+ "description": "Accepted and the operation will complete asynchronously."
+ },
+ "default": {
+ "description": "CDN error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/load": {
+ "post": {
+ "tags": [
+ "Endpoints"
+ ],
+ "description": "Pre-loads a content to CDN. Available for Verizon Profiles.",
+ "operationId": "Endpoints_LoadContent",
+ "x-ms-examples": {
+ "Endpoints_LoadContent": {
+ "$ref": "./examples/Endpoints_LoadContent.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "profileName",
+ "in": "path",
+ "description": "Name of the CDN profile which is unique within the resource group.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "endpointName",
+ "in": "path",
+ "description": "Name of the endpoint under the profile which is unique globally.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "contentFilePaths",
+ "in": "body",
+ "description": "The path to the content to be loaded. Path should be a full URL, e.g. ‘/pictures/city.png' which loads a single file ",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/LoadParameters"
+ }
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK. The request has succeeded."
+ },
+ "202": {
+ "description": "Accepted and the operation will complete asynchronously."
+ },
+ "default": {
+ "description": "CDN error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/validateCustomDomain": {
+ "post": {
+ "tags": [
+ "Endpoints"
+ ],
+ "description": "Validates the custom domain mapping to ensure it maps to the correct CDN endpoint in DNS.",
+ "operationId": "Endpoints_ValidateCustomDomain",
+ "x-ms-examples": {
+ "Endpoints_ValidateCustomDomain": {
+ "$ref": "./examples/Endpoints_ValidateCustomDomain.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "profileName",
+ "in": "path",
+ "description": "Name of the CDN profile which is unique within the resource group.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "endpointName",
+ "in": "path",
+ "description": "Name of the endpoint under the profile which is unique globally.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "customDomainProperties",
+ "in": "body",
+ "description": "Custom domain to be validated.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/ValidateCustomDomainInput"
+ }
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK. The request has succeeded.",
+ "schema": {
+ "$ref": "#/definitions/ValidateCustomDomainOutput"
+ }
+ },
+ "default": {
+ "description": "CDN error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/checkResourceUsage": {
+ "post": {
+ "tags": [
+ "Endpoints"
+ ],
+ "description": "Checks the quota and usage of geo filters and custom domains under the given endpoint.",
+ "operationId": "Endpoints_ListResourceUsage",
+ "x-ms-examples": {
+ "Endpoints_ListResourceUsage": {
+ "$ref": "./examples/Endpoints_ListResourceUsage.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "profileName",
+ "in": "path",
+ "description": "Name of the CDN profile which is unique within the resource group.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "endpointName",
+ "in": "path",
+ "description": "Name of the endpoint under the profile which is unique globally.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK. The request has succeeded.",
+ "schema": {
+ "$ref": "#/definitions/ResourceUsageListResult"
+ }
+ },
+ "default": {
+ "description": "CDN error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/origins": {
+ "get": {
+ "tags": [
+ "Origins"
+ ],
+ "description": "Lists all of the existing origins within an endpoint.",
+ "operationId": "Origins_ListByEndpoint",
+ "x-ms-examples": {
+ "Origins_ListByEndpoint": {
+ "$ref": "./examples/Origins_ListByEndpoint.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "profileName",
+ "in": "path",
+ "description": "Name of the CDN profile which is unique within the resource group.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "endpointName",
+ "in": "path",
+ "description": "Name of the endpoint under the profile which is unique globally.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK. The request has succeeded.",
+ "schema": {
+ "$ref": "#/definitions/OriginListResult"
+ }
+ },
+ "default": {
+ "description": "CDN error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/origins/{originName}": {
+ "get": {
+ "tags": [
+ "Origins"
+ ],
+ "description": "Gets an existing origin within an endpoint.",
+ "operationId": "Origins_Get",
+ "x-ms-examples": {
+ "Origins_Get": {
+ "$ref": "./examples/Origins_Get.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "profileName",
+ "in": "path",
+ "description": "Name of the CDN profile which is unique within the resource group.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "endpointName",
+ "in": "path",
+ "description": "Name of the endpoint under the profile which is unique globally.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "originName",
+ "in": "path",
+ "description": "Name of the origin which is unique within the endpoint.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK. The request has succeeded.",
+ "schema": {
+ "$ref": "#/definitions/Origin"
+ }
+ },
+ "default": {
+ "description": "CDN error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "Origins"
+ ],
+ "description": "Creates a new origin within the specified endpoint.",
+ "operationId": "Origins_Create",
+ "x-ms-examples": {
+ "Origins_Create": {
+ "$ref": "./examples/Origins_Create.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "profileName",
+ "in": "path",
+ "description": "Name of the CDN profile which is unique within the resource group.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "endpointName",
+ "in": "path",
+ "description": "Name of the endpoint under the profile which is unique globally.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "originName",
+ "in": "path",
+ "description": "Name of the origin that is unique within the endpoint.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "origin",
+ "in": "body",
+ "description": "Origin properties",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/Origin"
+ }
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK. The request has succeeded.",
+ "schema": {
+ "$ref": "#/definitions/Origin"
+ }
+ },
+ "201": {
+ "description": "Created. The request has been fulfilled and a new origin has been created.",
+ "schema": {
+ "$ref": "#/definitions/Origin"
+ }
+ },
+ "202": {
+ "description": "Accepted and the operation will complete asynchronously.",
+ "schema": {
+ "$ref": "#/definitions/Origin"
+ }
+ },
+ "default": {
+ "description": "CDN error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true
+ },
+ "patch": {
+ "tags": [
+ "Origins"
+ ],
+ "description": "Updates an existing origin within an endpoint.",
+ "operationId": "Origins_Update",
+ "x-ms-examples": {
+ "Origins_Update": {
+ "$ref": "./examples/Origins_Update.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "profileName",
+ "in": "path",
+ "description": "Name of the CDN profile which is unique within the resource group.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "endpointName",
+ "in": "path",
+ "description": "Name of the endpoint under the profile which is unique globally.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "originName",
+ "in": "path",
+ "description": "Name of the origin which is unique within the endpoint.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "originUpdateProperties",
+ "in": "body",
+ "description": "Origin properties",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/OriginUpdateParameters"
+ }
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK. The request has succeeded.",
+ "schema": {
+ "$ref": "#/definitions/Origin"
+ }
+ },
+ "202": {
+ "description": "Accepted and the operation will complete asynchronously.",
+ "schema": {
+ "$ref": "#/definitions/Origin"
+ }
+ },
+ "default": {
+ "description": "CDN error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true
+ },
+ "delete": {
+ "tags": [
+ "Origins"
+ ],
+ "description": "Deletes an existing origin within an endpoint.",
+ "operationId": "Origins_Delete",
+ "x-ms-examples": {
+ "Origins_Delete": {
+ "$ref": "./examples/Origins_Delete.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "profileName",
+ "in": "path",
+ "description": "Name of the CDN profile which is unique within the resource group.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "endpointName",
+ "in": "path",
+ "description": "Name of the endpoint under the profile which is unique globally.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "originName",
+ "in": "path",
+ "description": "Name of the origin which is unique within the endpoint.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "202": {
+ "description": "Accepted and the operation will complete asynchronously."
+ },
+ "204": {
+ "description": "No Content. The request has been accepted but the origin was not found."
+ },
+ "default": {
+ "description": "CDN error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/originGroups": {
+ "get": {
+ "tags": [
+ "OriginGroups"
+ ],
+ "description": "Lists all of the existing origin groups within an endpoint.",
+ "operationId": "OriginGroups_ListByEndpoint",
+ "x-ms-examples": {
+ "OriginsGroups_ListByEndpoint": {
+ "$ref": "./examples/OriginGroups_ListByEndpoint.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "profileName",
+ "in": "path",
+ "description": "Name of the CDN profile which is unique within the resource group.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "endpointName",
+ "in": "path",
+ "description": "Name of the endpoint under the profile which is unique globally.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK. The request has succeeded.",
+ "schema": {
+ "$ref": "#/definitions/OriginGroupListResult"
+ }
+ },
+ "default": {
+ "description": "CDN error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/originGroups/{originGroupName}": {
+ "get": {
+ "tags": [
+ "OriginGroups"
+ ],
+ "description": "Gets an existing origin group within an endpoint.",
+ "operationId": "OriginGroups_Get",
+ "x-ms-examples": {
+ "OriginGroups_Get": {
+ "$ref": "./examples/OriginGroups_Get.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "profileName",
+ "in": "path",
+ "description": "Name of the CDN profile which is unique within the resource group.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "endpointName",
+ "in": "path",
+ "description": "Name of the endpoint under the profile which is unique globally.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "originGroupName",
+ "in": "path",
+ "description": "Name of the origin group which is unique within the endpoint.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK. The request has succeeded.",
+ "schema": {
+ "$ref": "#/definitions/OriginGroup"
+ }
+ },
+ "default": {
+ "description": "CDN error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "OriginGroups"
+ ],
+ "description": "Creates a new origin group within the specified endpoint.",
+ "operationId": "OriginGroups_Create",
+ "x-ms-examples": {
+ "OriginGroups_Create": {
+ "$ref": "./examples/OriginGroups_Create.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "profileName",
+ "in": "path",
+ "description": "Name of the CDN profile which is unique within the resource group.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "endpointName",
+ "in": "path",
+ "description": "Name of the endpoint under the profile which is unique globally.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "originGroupName",
+ "in": "path",
+ "description": "Name of the origin group which is unique within the endpoint.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "originGroup",
+ "in": "body",
+ "description": "Origin group properties",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/OriginGroup"
+ }
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK. The request has succeeded.",
+ "schema": {
+ "$ref": "#/definitions/OriginGroup"
+ }
+ },
+ "201": {
+ "description": "Created. The request has been fulfilled and a new origin group has been created.",
+ "schema": {
+ "$ref": "#/definitions/OriginGroup"
+ }
+ },
+ "202": {
+ "description": "Accepted and the operation will complete asynchronously.",
+ "schema": {
+ "$ref": "#/definitions/OriginGroup"
+ }
+ },
+ "default": {
+ "description": "CDN error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true
+ },
+ "patch": {
+ "tags": [
+ "OriginGroups"
+ ],
+ "description": "Updates an existing origin group within an endpoint.",
+ "operationId": "OriginGroups_Update",
+ "x-ms-examples": {
+ "OriginGroups_Update": {
+ "$ref": "./examples/OriginGroups_Update.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "profileName",
+ "in": "path",
+ "description": "Name of the CDN profile which is unique within the resource group.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "endpointName",
+ "in": "path",
+ "description": "Name of the endpoint under the profile which is unique globally.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "originGroupName",
+ "in": "path",
+ "description": "Name of the origin group which is unique within the endpoint.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "originGroupUpdateProperties",
+ "in": "body",
+ "description": "Origin group properties",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/OriginGroupUpdateParameters"
+ }
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK. The request has succeeded.",
+ "schema": {
+ "$ref": "#/definitions/OriginGroup"
+ }
+ },
+ "202": {
+ "description": "Accepted and the operation will complete asynchronously.",
+ "schema": {
+ "$ref": "#/definitions/OriginGroup"
+ }
+ },
+ "default": {
+ "description": "CDN error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true
+ },
+ "delete": {
+ "tags": [
+ "OriginGroups"
+ ],
+ "description": "Deletes an existing origin group within an endpoint.",
+ "operationId": "OriginGroups_Delete",
+ "x-ms-examples": {
+ "OriginGroups_Delete": {
+ "$ref": "./examples/OriginGroups_Delete.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "profileName",
+ "in": "path",
+ "description": "Name of the CDN profile which is unique within the resource group.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "endpointName",
+ "in": "path",
+ "description": "Name of the endpoint under the profile which is unique globally.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "originGroupName",
+ "in": "path",
+ "description": "Name of the origin group which is unique within the endpoint.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "202": {
+ "description": "Accepted and the operation will complete asynchronously."
+ },
+ "204": {
+ "description": "No Content. The request has been accepted but the origin was not found."
+ },
+ "default": {
+ "description": "CDN error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/customDomains": {
+ "get": {
+ "tags": [
+ "CustomDomains"
+ ],
+ "description": "Lists all of the existing custom domains within an endpoint.",
+ "operationId": "CustomDomains_ListByEndpoint",
+ "x-ms-examples": {
+ "CustomDomains_ListByEndpoint": {
+ "$ref": "./examples/CustomDomains_ListByEndpoint.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "profileName",
+ "in": "path",
+ "description": "Name of the CDN profile which is unique within the resource group.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "endpointName",
+ "in": "path",
+ "description": "Name of the endpoint under the profile which is unique globally.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK. The request has succeeded.",
+ "schema": {
+ "$ref": "#/definitions/CustomDomainListResult"
+ }
+ },
+ "default": {
+ "description": "CDN error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/customDomains/{customDomainName}": {
+ "get": {
+ "tags": [
+ "CustomDomains"
+ ],
+ "description": "Gets an existing custom domain within an endpoint.",
+ "operationId": "CustomDomains_Get",
+ "x-ms-examples": {
+ "CustomDomains_Get": {
+ "$ref": "./examples/CustomDomains_Get.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "profileName",
+ "in": "path",
+ "description": "Name of the CDN profile which is unique within the resource group.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "endpointName",
+ "in": "path",
+ "description": "Name of the endpoint under the profile which is unique globally.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "customDomainName",
+ "in": "path",
+ "description": "Name of the custom domain within an endpoint.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK. The request has succeeded.",
+ "schema": {
+ "$ref": "#/definitions/CustomDomain"
+ }
+ },
+ "default": {
+ "description": "CDN error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "CustomDomains"
+ ],
+ "description": "Creates a new custom domain within an endpoint.",
+ "operationId": "CustomDomains_Create",
+ "x-ms-examples": {
+ "CustomDomains_Create": {
+ "$ref": "./examples/CustomDomains_Create.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "profileName",
+ "in": "path",
+ "description": "Name of the CDN profile which is unique within the resource group.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "endpointName",
+ "in": "path",
+ "description": "Name of the endpoint under the profile which is unique globally.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "customDomainName",
+ "in": "path",
+ "description": "Name of the custom domain within an endpoint.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "customDomainProperties",
+ "in": "body",
+ "description": "Properties required to create a new custom domain.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/CustomDomainParameters"
+ }
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK. The request has succeeded.",
+ "schema": {
+ "$ref": "#/definitions/CustomDomain"
+ }
+ },
+ "201": {
+ "description": "Created. The request has been fulfilled and a new custom domain has been created.",
+ "schema": {
+ "$ref": "#/definitions/CustomDomain"
+ }
+ },
+ "202": {
+ "description": "Accepted and the operation will complete asynchronously.",
+ "schema": {
+ "$ref": "#/definitions/CustomDomain"
+ }
+ },
+ "default": {
+ "description": "CDN error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true
+ },
+ "delete": {
+ "tags": [
+ "CustomDomains"
+ ],
+ "description": "Deletes an existing custom domain within an endpoint.",
+ "operationId": "CustomDomains_Delete",
+ "x-ms-examples": {
+ "CustomDomains_Delete": {
+ "$ref": "./examples/CustomDomains_Delete.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "profileName",
+ "in": "path",
+ "description": "Name of the CDN profile which is unique within the resource group.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "endpointName",
+ "in": "path",
+ "description": "Name of the endpoint under the profile which is unique globally.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "customDomainName",
+ "in": "path",
+ "description": "Name of the custom domain within an endpoint.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK. The request has succeeded."
+ },
+ "202": {
+ "description": "Accepted and the operation will complete asynchronously.",
+ "schema": {
+ "$ref": "#/definitions/CustomDomain"
+ }
+ },
+ "204": {
+ "description": "No Content. The request has been accepted but the custom domain was not found"
+ },
+ "default": {
+ "description": "CDN error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/customDomains/{customDomainName}/disableCustomHttps": {
+ "post": {
+ "tags": [
+ "CustomDomains"
+ ],
+ "description": "Disable https delivery of the custom domain.",
+ "operationId": "CustomDomains_DisableCustomHttps",
+ "x-ms-examples": {
+ "CustomDomains_DisableCustomHttps": {
+ "$ref": "./examples/CustomDomains_DisableCustomHttps.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "profileName",
+ "in": "path",
+ "description": "Name of the CDN profile which is unique within the resource group.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "endpointName",
+ "in": "path",
+ "description": "Name of the endpoint under the profile which is unique globally.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "customDomainName",
+ "in": "path",
+ "description": "Name of the custom domain within an endpoint.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK. The request has succeeded."
+ },
+ "202": {
+ "description": "Accepted and the operation will complete asynchronously.",
+ "schema": {
+ "$ref": "#/definitions/CustomDomain"
+ }
+ },
+ "default": {
+ "description": "CDN error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/customDomains/{customDomainName}/enableCustomHttps": {
+ "post": {
+ "tags": [
+ "CustomDomains"
+ ],
+ "description": "Enable https delivery of the custom domain.",
+ "operationId": "CustomDomains_EnableCustomHttps",
+ "x-ms-examples": {
+ "CustomDomains_EnableCustomHttpsUsingYourOwnCertificate": {
+ "$ref": "./examples/CustomDomains_EnableCustomHttpsUsingBYOC.json"
+ },
+ "CustomDomains_EnableCustomHttpsUsingCDNManagedCertificate": {
+ "$ref": "./examples/CustomDomains_EnableCustomHttpsUsingCDNManagedCertificate.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "profileName",
+ "in": "path",
+ "description": "Name of the CDN profile which is unique within the resource group.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "endpointName",
+ "in": "path",
+ "description": "Name of the endpoint under the profile which is unique globally.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "customDomainName",
+ "in": "path",
+ "description": "Name of the custom domain within an endpoint.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "customDomainHttpsParameters",
+ "in": "body",
+ "description": "The configuration specifying how to enable HTTPS for the custom domain - using CDN managed certificate or user's own certificate. If not specified, enabling ssl uses CDN managed certificate by default.",
+ "required": false,
+ "schema": {
+ "$ref": "#/definitions/CustomDomainHttpsParameters"
+ }
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK. The request has succeeded."
+ },
+ "202": {
+ "description": "Accepted and the operation will complete asynchronously.",
+ "schema": {
+ "$ref": "#/definitions/CustomDomain"
+ }
+ },
+ "default": {
+ "description": "CDN error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/providers/Microsoft.Cdn/checkNameAvailability": {
+ "post": {
+ "tags": [
+ "CheckNameAvailability"
+ ],
+ "description": "Check the availability of a resource name. This is needed for resources where name is globally unique, such as a CDN endpoint.",
+ "operationId": "CheckNameAvailability",
+ "x-ms-examples": {
+ "CheckNameAvailability": {
+ "$ref": "./examples/CheckNameAvailability.json"
+ }
+ },
+ "parameters": [
+ {
+ "name": "checkNameAvailabilityInput",
+ "in": "body",
+ "description": "Input to check.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/CheckNameAvailabilityInput"
+ }
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK. The request has succeeded.",
+ "schema": {
+ "$ref": "#/definitions/CheckNameAvailabilityOutput"
+ }
+ },
+ "default": {
+ "description": "CDN error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/providers/Microsoft.Cdn/checkNameAvailability": {
+ "post": {
+ "tags": [
+ "CheckNameAvailabilityWithSubscription"
+ ],
+ "description": "Check the availability of a resource name. This is needed for resources where name is globally unique, such as a CDN endpoint.",
+ "operationId": "CheckNameAvailabilityWithSubscription",
+ "x-ms-examples": {
+ "CheckNameAvailabilityWithSubscription": {
+ "$ref": "./examples/CheckNameAvailabilityWithSubscription.json"
+ }
+ },
+ "parameters": [
+ {
+ "name": "checkNameAvailabilityInput",
+ "in": "body",
+ "description": "Input to check.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/CheckNameAvailabilityInput"
+ }
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK. The request has succeeded.",
+ "schema": {
+ "$ref": "#/definitions/CheckNameAvailabilityOutput"
+ }
+ },
+ "default": {
+ "description": "CDN error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/providers/Microsoft.Cdn/validateProbe": {
+ "post": {
+ "tags": [
+ "ValidateProbe"
+ ],
+ "description": "Check if the probe path is a valid path and the file can be accessed. Probe path is the path to a file hosted on the origin server to help accelerate the delivery of dynamic content via the CDN endpoint. This path is relative to the origin path specified in the endpoint configuration.",
+ "operationId": "ValidateProbe",
+ "x-ms-examples": {
+ "ValidateProbe": {
+ "$ref": "./examples/ValidateProbe.json"
+ }
+ },
+ "parameters": [
+ {
+ "name": "validateProbeInput",
+ "in": "body",
+ "description": "Input to check.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/ValidateProbeInput"
+ }
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK. The request has succeeded.",
+ "schema": {
+ "$ref": "#/definitions/ValidateProbeOutput"
+ }
+ },
+ "default": {
+ "description": "CDN error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/providers/Microsoft.Cdn/checkResourceUsage": {
+ "post": {
+ "tags": [
+ "CheckResourceUsage"
+ ],
+ "description": "Check the quota and actual usage of the CDN profiles under the given subscription.",
+ "operationId": "ResourceUsage_List",
+ "x-ms-examples": {
+ "ResourceUsage_List": {
+ "$ref": "./examples/ResourceUsage_List.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK. The request has succeeded.",
+ "schema": {
+ "$ref": "#/definitions/ResourceUsageListResult"
+ }
+ },
+ "default": {
+ "description": "CDN error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/providers/Microsoft.Cdn/operations": {
+ "get": {
+ "tags": [
+ "Operations"
+ ],
+ "description": "Lists all of the available CDN REST API operations.",
+ "operationId": "Operations_List",
+ "x-ms-examples": {
+ "Operations_List": {
+ "$ref": "./examples/Operations_List.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK. The request has succeeded.",
+ "schema": {
+ "$ref": "#/definitions/OperationsListResult"
+ }
+ },
+ "default": {
+ "description": "CDN error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/providers/Microsoft.Cdn/edgenodes": {
+ "get": {
+ "tags": [
+ "Edgenodes"
+ ],
+ "description": "Edgenodes are the global Point of Presence (POP) locations used to deliver CDN content to end users.",
+ "operationId": "EdgeNodes_List",
+ "x-ms-examples": {
+ "EdgeNodes_List": {
+ "$ref": "./examples/EdgeNodes_List.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK. The request has succeeded.",
+ "schema": {
+ "$ref": "#/definitions/EdgenodeResult"
+ }
+ },
+ "default": {
+ "description": "CDN error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ }
+ },
+ "definitions": {
+ "Profile": {
+ "description": "CDN profile is a logical grouping of endpoints that share the same settings, such as CDN provider and pricing tier.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/TrackedResource"
+ }
+ ],
+ "properties": {
+ "sku": {
+ "description": "The pricing tier (defines a CDN provider, feature list and rate) of the CDN profile.",
+ "$ref": "#/definitions/Sku"
+ },
+ "properties": {
+ "x-ms-client-flatten": true,
+ "$ref": "#/definitions/ProfileProperties"
+ }
+ },
+ "required": [
+ "sku"
+ ]
+ },
+ "ProfileProperties": {
+ "description": "The JSON object that contains the properties required to create a profile.",
+ "properties": {
+ "resourceState": {
+ "description": "Resource status of the profile.",
+ "readOnly": true,
+ "enum": [
+ "Creating",
+ "Active",
+ "Deleting",
+ "Disabled"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "ProfileResourceState",
+ "modelAsString": true
+ }
+ },
+ "provisioningState": {
+ "readOnly": true,
+ "description": "Provisioning status of the profile.",
+ "type": "string"
+ }
+ }
+ },
+ "ProfileListResult": {
+ "description": "Result of the request to list profiles. It contains a list of profile objects and a URL link to get the next set of results.",
+ "properties": {
+ "value": {
+ "type": "array",
+ "readOnly": true,
+ "items": {
+ "$ref": "#/definitions/Profile"
+ },
+ "description": "List of CDN profiles within a resource group."
+ },
+ "nextLink": {
+ "type": "string",
+ "description": "URL to get the next set of profile objects if there are any."
+ }
+ }
+ },
+ "ProfileUpdateParameters": {
+ "type": "object",
+ "description": "Properties required to update a profile.",
+ "properties": {
+ "tags": {
+ "description": "Profile tags",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ }
+ },
+ "x-ms-azure-resource": true
+ },
+ "SsoUri": {
+ "description": "The URI required to login to the supplemental portal from the Azure portal.",
+ "type": "object",
+ "properties": {
+ "ssoUriValue": {
+ "description": "The URI used to login to the supplemental portal.",
+ "readOnly": true,
+ "type": "string"
+ }
+ }
+ },
+ "SupportedOptimizationTypesListResult": {
+ "description": "The result of the GetSupportedOptimizationTypes API",
+ "type": "object",
+ "properties": {
+ "supportedOptimizationTypes": {
+ "description": "Supported optimization types for a profile.",
+ "readOnly": true,
+ "items": {
+ "$ref": "#/definitions/OptimizationType"
+ },
+ "type": "array"
+ }
+ }
+ },
+ "Endpoint": {
+ "description": "CDN endpoint is the entity within a CDN profile containing configuration information such as origin, protocol, content caching and delivery behavior. The CDN endpoint uses the URL format .azureedge.net.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/TrackedResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "x-ms-client-flatten": true,
+ "$ref": "#/definitions/EndpointProperties"
+ }
+ }
+ },
+ "EndpointProperties": {
+ "description": "The JSON object that contains the properties required to create an endpoint.",
+ "required": [
+ "origins"
+ ],
+ "allOf": [
+ {
+ "$ref": "#/definitions/EndpointPropertiesUpdateParameters"
+ }
+ ],
+ "properties": {
+ "hostName": {
+ "description": "The host name of the endpoint structured as {endpointName}.{DNSZone}, e.g. contoso.azureedge.net",
+ "type": "string",
+ "readOnly": true
+ },
+ "origins": {
+ "description": "The source of the content being delivered via CDN.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/DeepCreatedOrigin"
+ }
+ },
+ "originGroups": {
+ "description": "The origin groups comprising of origins that are used for load balancing the traffic based on availability.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/DeepCreatedOriginGroup"
+ }
+ },
+ "resourceState": {
+ "description": "Resource status of the endpoint.",
+ "readOnly": true,
+ "enum": [
+ "Creating",
+ "Deleting",
+ "Running",
+ "Starting",
+ "Stopped",
+ "Stopping"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "EndpointResourceState",
+ "modelAsString": true
+ }
+ },
+ "provisioningState": {
+ "readOnly": true,
+ "description": "Provisioning status of the endpoint.",
+ "type": "string"
+ }
+ }
+ },
+ "EndpointListResult": {
+ "description": "Result of the request to list endpoints. It contains a list of endpoint objects and a URL link to get the next set of results.",
+ "properties": {
+ "value": {
+ "type": "array",
+ "readOnly": true,
+ "items": {
+ "$ref": "#/definitions/Endpoint"
+ },
+ "description": "List of CDN endpoints within a profile"
+ },
+ "nextLink": {
+ "type": "string",
+ "description": "URL to get the next set of endpoint objects if there is any."
+ }
+ }
+ },
+ "EndpointUpdateParameters": {
+ "type": "object",
+ "description": "Properties required to create or update an endpoint.",
+ "properties": {
+ "tags": {
+ "description": "Endpoint tags.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "properties": {
+ "x-ms-client-flatten": true,
+ "$ref": "#/definitions/EndpointPropertiesUpdateParameters"
+ }
+ },
+ "x-ms-azure-resource": true
+ },
+ "EndpointPropertiesUpdateParameters": {
+ "description": "The JSON object containing endpoint update parameters.",
+ "properties": {
+ "originPath": {
+ "description": "A directory path on the origin that CDN can use to retrieve content from, e.g. contoso.cloudapp.net/originpath.",
+ "type": "string"
+ },
+ "contentTypesToCompress": {
+ "description": "List of content types on which compression applies. The value should be a valid MIME type.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "originHostHeader": {
+ "description": "The host header value sent to the origin with each request. This property at Endpoint is only allowed when endpoint uses single origin and can be overridden by the same property specified at origin.If you leave this blank, the request hostname determines this value. Azure CDN origins, such as Web Apps, Blob Storage, and Cloud Services require this host header value to match the origin hostname by default.",
+ "type": "string"
+ },
+ "isCompressionEnabled": {
+ "description": "Indicates whether content compression is enabled on CDN. Default value is false. If compression is enabled, content will be served as compressed if user requests for a compressed version. Content won't be compressed on CDN when requested content is smaller than 1 byte or larger than 1 MB.",
+ "type": "boolean"
+ },
+ "isHttpAllowed": {
+ "description": "Indicates whether HTTP traffic is allowed on the endpoint. Default value is true. At least one protocol (HTTP or HTTPS) must be allowed.",
+ "type": "boolean"
+ },
+ "isHttpsAllowed": {
+ "description": "Indicates whether HTTPS traffic is allowed on the endpoint. Default value is true. At least one protocol (HTTP or HTTPS) must be allowed.",
+ "type": "boolean"
+ },
+ "queryStringCachingBehavior": {
+ "description": "Defines how CDN caches requests that include query strings. You can ignore any query strings when caching, bypass caching to prevent requests that contain query strings from being cached, or cache every request with a unique URL.",
+ "$ref": "#/definitions/QueryStringCachingBehavior"
+ },
+ "optimizationType": {
+ "description": "Specifies what scenario the customer wants this CDN endpoint to optimize for, e.g. Download, Media services. With this information, CDN can apply scenario driven optimization.",
+ "$ref": "#/definitions/OptimizationType"
+ },
+ "probePath": {
+ "description": "Path to a file hosted on the origin which helps accelerate delivery of the dynamic content and calculate the most optimal routes for the CDN. This is relative to the origin path. This property is only relevant when using a single origin.",
+ "type": "string"
+ },
+ "geoFilters": {
+ "description": "List of rules defining the user's geo access within a CDN endpoint. Each geo filter defines an access rule to a specified path or content, e.g. block APAC for path /pictures/",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/GeoFilter"
+ }
+ },
+ "defaultOriginGroup": {
+ "description": "A reference to the origin group.",
+ "type": "object",
+ "$ref": "#/definitions/ResourceReference"
+ },
+ "urlSigningKeys": {
+ "description": "List of keys used to validate the signed URL hashes.",
+ "type": "array",
+ "$ref": "#/definitions/UrlSigningKey"
+ },
+ "deliveryPolicy": {
+ "description": "A policy that specifies the delivery rules to be used for an endpoint.",
+ "type": "object",
+ "required": [
+ "rules"
+ ],
+ "properties": {
+ "description": {
+ "description": "User-friendly description of the policy.",
+ "type": "string"
+ },
+ "rules": {
+ "description": "A list of the delivery rules.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/DeliveryRule"
+ }
+ }
+ }
+ },
+ "webApplicationFirewallPolicyLink": {
+ "description": "Defines the Web Application Firewall policy for the endpoint (if applicable)",
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "Resource ID."
+ }
+ }
+ }
+ }
+ },
+ "DeliveryRule": {
+ "description": "A rule that specifies a set of actions and conditions",
+ "type": "object",
+ "required": [
+ "order",
+ "actions"
+ ],
+ "properties": {
+ "name": {
+ "description": "Name of the rule",
+ "type": "string"
+ },
+ "order": {
+ "description": "The order in which the rules are applied for the endpoint. Possible values {0,1,2,3,………}. A rule with a lesser order will be applied before a rule with a greater order. Rule with order 0 is a special rule. It does not require any condition and actions listed in it will always be applied.",
+ "type": "integer"
+ },
+ "conditions": {
+ "description": "A list of conditions that must be matched for the actions to be executed",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/DeliveryRuleCondition"
+ }
+ },
+ "actions": {
+ "description": "A list of actions that are executed when all the conditions of a rule are satisfied.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/DeliveryRuleAction"
+ }
+ }
+ }
+ },
+ "DeliveryRuleCondition": {
+ "description": "A condition for the delivery rule.",
+ "discriminator": "name",
+ "required": [
+ "name"
+ ],
+ "properties": {
+ "name": {
+ "description": "The name of the condition for the delivery rule.",
+ "type": "string",
+ "enum": [
+ "RemoteAddress",
+ "RequestMethod",
+ "QueryString",
+ "PostArgs",
+ "RequestUri",
+ "RequestHeader",
+ "RequestBody",
+ "RequestScheme",
+ "UrlPath",
+ "UrlFileExtension",
+ "UrlFileName",
+ "HttpVersion",
+ "Cookies",
+ "IsDevice"
+ ],
+ "x-ms-enum": {
+ "name": "MatchVariable",
+ "modelAsString": true
+ }
+ }
+ }
+ },
+ "DeliveryRuleRemoteAddressCondition": {
+ "description": "Defines the RemoteAddress condition for the delivery rule.",
+ "x-ms-discriminator-value": "RemoteAddress",
+ "allOf": [
+ {
+ "$ref": "#/definitions/DeliveryRuleCondition"
+ }
+ ],
+ "required": [
+ "parameters"
+ ],
+ "properties": {
+ "parameters": {
+ "description": "Defines the parameters for the condition.",
+ "$ref": "#/definitions/RemoteAddressMatchConditionParameters"
+ }
+ }
+ },
+ "DeliveryRuleRequestMethodCondition": {
+ "description": "Defines the RequestMethod condition for the delivery rule.",
+ "x-ms-discriminator-value": "RequestMethod",
+ "allOf": [
+ {
+ "$ref": "#/definitions/DeliveryRuleCondition"
+ }
+ ],
+ "required": [
+ "parameters"
+ ],
+ "properties": {
+ "parameters": {
+ "description": "Defines the parameters for the condition.",
+ "$ref": "#/definitions/RequestMethodMatchConditionParameters"
+ }
+ }
+ },
+ "DeliveryRuleQueryStringCondition": {
+ "description": "Defines the QueryString condition for the delivery rule.",
+ "x-ms-discriminator-value": "QueryString",
+ "allOf": [
+ {
+ "$ref": "#/definitions/DeliveryRuleCondition"
+ }
+ ],
+ "required": [
+ "parameters"
+ ],
+ "properties": {
+ "parameters": {
+ "description": "Defines the parameters for the condition.",
+ "$ref": "#/definitions/QueryStringMatchConditionParameters"
+ }
+ }
+ },
+ "DeliveryRulePostArgsCondition": {
+ "description": "Defines the PostArgs condition for the delivery rule.",
+ "x-ms-discriminator-value": "PostArgs",
+ "allOf": [
+ {
+ "$ref": "#/definitions/DeliveryRuleCondition"
+ }
+ ],
+ "required": [
+ "parameters"
+ ],
+ "properties": {
+ "parameters": {
+ "description": "Defines the parameters for the condition.",
+ "$ref": "#/definitions/PostArgsMatchConditionParameters"
+ }
+ }
+ },
+ "DeliveryRuleRequestUriCondition": {
+ "description": "Defines the RequestUri condition for the delivery rule.",
+ "x-ms-discriminator-value": "RequestUri",
+ "allOf": [
+ {
+ "$ref": "#/definitions/DeliveryRuleCondition"
+ }
+ ],
+ "required": [
+ "parameters"
+ ],
+ "properties": {
+ "parameters": {
+ "description": "Defines the parameters for the condition.",
+ "$ref": "#/definitions/RequestUriMatchConditionParameters"
+ }
+ }
+ },
+ "DeliveryRuleRequestHeaderCondition": {
+ "description": "Defines the RequestHeader condition for the delivery rule.",
+ "x-ms-discriminator-value": "RequestHeader",
+ "allOf": [
+ {
+ "$ref": "#/definitions/DeliveryRuleCondition"
+ }
+ ],
+ "required": [
+ "parameters"
+ ],
+ "properties": {
+ "parameters": {
+ "description": "Defines the parameters for the condition.",
+ "$ref": "#/definitions/RequestHeaderMatchConditionParameters"
+ }
+ }
+ },
+ "DeliveryRuleRequestBodyCondition": {
+ "description": "Defines the RequestBody condition for the delivery rule.",
+ "x-ms-discriminator-value": "RequestBody",
+ "allOf": [
+ {
+ "$ref": "#/definitions/DeliveryRuleCondition"
+ }
+ ],
+ "required": [
+ "parameters"
+ ],
+ "properties": {
+ "parameters": {
+ "description": "Defines the parameters for the condition.",
+ "$ref": "#/definitions/RequestBodyMatchConditionParameters"
+ }
+ }
+ },
+ "DeliveryRuleRequestSchemeCondition": {
+ "description": "Defines the RequestScheme condition for the delivery rule.",
+ "x-ms-discriminator-value": "RequestScheme",
+ "allOf": [
+ {
+ "$ref": "#/definitions/DeliveryRuleCondition"
+ }
+ ],
+ "required": [
+ "parameters"
+ ],
+ "properties": {
+ "parameters": {
+ "description": "Defines the parameters for the condition.",
+ "$ref": "#/definitions/RequestSchemeMatchConditionParameters"
+ }
+ }
+ },
+ "DeliveryRuleUrlPathCondition": {
+ "description": "Defines the UrlPath condition for the delivery rule.",
+ "x-ms-discriminator-value": "UrlPath",
+ "allOf": [
+ {
+ "$ref": "#/definitions/DeliveryRuleCondition"
+ }
+ ],
+ "required": [
+ "parameters"
+ ],
+ "properties": {
+ "parameters": {
+ "description": "Defines the parameters for the condition.",
+ "$ref": "#/definitions/UrlPathMatchConditionParameters"
+ }
+ }
+ },
+ "DeliveryRuleUrlFileExtensionCondition": {
+ "description": "Defines the UrlFileExtension condition for the delivery rule.",
+ "x-ms-discriminator-value": "UrlFileExtension",
+ "allOf": [
+ {
+ "$ref": "#/definitions/DeliveryRuleCondition"
+ }
+ ],
+ "required": [
+ "parameters"
+ ],
+ "properties": {
+ "parameters": {
+ "description": "Defines the parameters for the condition.",
+ "$ref": "#/definitions/UrlFileExtensionMatchConditionParameters"
+ }
+ }
+ },
+ "DeliveryRuleUrlFileNameCondition": {
+ "description": "Defines the UrlFileName condition for the delivery rule.",
+ "x-ms-discriminator-value": "UrlFileName",
+ "allOf": [
+ {
+ "$ref": "#/definitions/DeliveryRuleCondition"
+ }
+ ],
+ "required": [
+ "parameters"
+ ],
+ "properties": {
+ "parameters": {
+ "description": "Defines the parameters for the condition.",
+ "$ref": "#/definitions/UrlFileNameMatchConditionParameters"
+ }
+ }
+ },
+ "DeliveryRuleHttpVersionCondition": {
+ "description": "Defines the HttpVersion condition for the delivery rule.",
+ "x-ms-discriminator-value": "HttpVersion",
+ "allOf": [
+ {
+ "$ref": "#/definitions/DeliveryRuleCondition"
+ }
+ ],
+ "required": [
+ "parameters"
+ ],
+ "properties": {
+ "parameters": {
+ "description": "Defines the parameters for the condition.",
+ "$ref": "#/definitions/HttpVersionMatchConditionParameters"
+ }
+ }
+ },
+ "DeliveryRuleCookiesCondition": {
+ "description": "Defines the Cookies condition for the delivery rule.",
+ "x-ms-discriminator-value": "Cookies",
+ "allOf": [
+ {
+ "$ref": "#/definitions/DeliveryRuleCondition"
+ }
+ ],
+ "required": [
+ "parameters"
+ ],
+ "properties": {
+ "parameters": {
+ "description": "Defines the parameters for the condition.",
+ "$ref": "#/definitions/CookiesMatchConditionParameters"
+ }
+ }
+ },
+ "DeliveryRuleIsDeviceCondition": {
+ "description": "Defines the IsDevice condition for the delivery rule.",
+ "x-ms-discriminator-value": "IsDevice",
+ "allOf": [
+ {
+ "$ref": "#/definitions/DeliveryRuleCondition"
+ }
+ ],
+ "required": [
+ "parameters"
+ ],
+ "properties": {
+ "parameters": {
+ "description": "Defines the parameters for the condition.",
+ "$ref": "#/definitions/IsDeviceMatchConditionParameters"
+ }
+ }
+ },
+ "RemoteAddressMatchConditionParameters": {
+ "description": "Defines the parameters for RemoteAddress match conditions",
+ "required": [
+ "operator",
+ "matchValues",
+ "@odata.type"
+ ],
+ "properties": {
+ "@odata.type": {
+ "type": "string",
+ "enum": [
+ "#Microsoft.Azure.Cdn.Models.DeliveryRuleRemoteAddressConditionParameters"
+ ]
+ },
+ "operator": {
+ "description": "Describes operator to be matched",
+ "type": "string",
+ "enum": [
+ "Any",
+ "IPMatch",
+ "GeoMatch"
+ ],
+ "x-ms-enum": {
+ "name": "RemoteAddressOperator",
+ "modelAsString": true
+ }
+ },
+ "negateCondition": {
+ "description": "Describes if this is negate condition or not",
+ "type": "boolean"
+ },
+ "matchValues": {
+ "description": "Match values to match against. The operator will apply to each value in here with OR semantics. If any of them match the variable with the given operator this match condition is considered a match.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "transforms": {
+ "description": "List of transforms",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/transform"
+ }
+ }
+ }
+ },
+ "RequestMethodMatchConditionParameters": {
+ "description": "Defines the parameters for RequestMethod match conditions",
+ "required": [
+ "operator",
+ "matchValues",
+ "@odata.type"
+ ],
+ "properties": {
+ "@odata.type": {
+ "type": "string",
+ "enum": [
+ "#Microsoft.Azure.Cdn.Models.DeliveryRuleRequestMethodConditionParameters"
+ ]
+ },
+ "operator": {
+ "description": "Describes operator to be matched",
+ "type": "string",
+ "enum": [
+ "Equal"
+ ],
+ "x-ms-enum": {
+ "name": "RequestMethodOperator",
+ "modelAsString": true
+ }
+ },
+ "negateCondition": {
+ "description": "Describes if this is negate condition or not",
+ "type": "boolean"
+ },
+ "matchValues": {
+ "description": "The match value for the condition of the delivery rule",
+ "type": "array",
+ "items": {
+ "type": "string",
+ "enum": [
+ "GET",
+ "HEAD",
+ "POST",
+ "PUT",
+ "DELETE",
+ "OPTIONS",
+ "TRACE"
+ ]
+ }
+ }
+ }
+ },
+ "QueryStringMatchConditionParameters": {
+ "description": "Defines the parameters for QueryString match conditions",
+ "required": [
+ "operator",
+ "matchValues",
+ "@odata.type"
+ ],
+ "properties": {
+ "@odata.type": {
+ "type": "string",
+ "enum": [
+ "#Microsoft.Azure.Cdn.Models.DeliveryRuleQueryStringConditionParameters"
+ ]
+ },
+ "operator": {
+ "description": "Describes operator to be matched",
+ "type": "string",
+ "enum": [
+ "Any",
+ "Equal",
+ "Contains",
+ "BeginsWith",
+ "EndsWith",
+ "LessThan",
+ "LessThanOrEqual",
+ "GreaterThan",
+ "GreaterThanOrEqual"
+ ],
+ "x-ms-enum": {
+ "name": "QueryStringOperator",
+ "modelAsString": true
+ }
+ },
+ "negateCondition": {
+ "description": "Describes if this is negate condition or not",
+ "type": "boolean"
+ },
+ "matchValues": {
+ "description": "The match value for the condition of the delivery rule",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "transforms": {
+ "description": "List of transforms",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/transform"
+ }
+ }
+ }
+ },
+ "PostArgsMatchConditionParameters": {
+ "description": "Defines the parameters for PostArgs match conditions",
+ "required": [
+ "operator",
+ "matchValues",
+ "selector",
+ "@odata.type"
+ ],
+ "properties": {
+ "@odata.type": {
+ "type": "string",
+ "enum": [
+ "#Microsoft.Azure.Cdn.Models.DeliveryRulePostArgsConditionParameters"
+ ]
+ },
+ "selector": {
+ "description": "Name of PostArg to be matched",
+ "type": "string"
+ },
+ "operator": {
+ "description": "Describes operator to be matched",
+ "type": "string",
+ "enum": [
+ "Any",
+ "Equal",
+ "Contains",
+ "BeginsWith",
+ "EndsWith",
+ "LessThan",
+ "LessThanOrEqual",
+ "GreaterThan",
+ "GreaterThanOrEqual"
+ ],
+ "x-ms-enum": {
+ "name": "PostArgsOperator",
+ "modelAsString": true
+ }
+ },
+ "negateCondition": {
+ "description": "Describes if this is negate condition or not",
+ "type": "boolean"
+ },
+ "matchValues": {
+ "description": "The match value for the condition of the delivery rule",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "transforms": {
+ "description": "List of transforms",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/transform"
+ }
+ }
+ }
+ },
+ "RequestUriMatchConditionParameters": {
+ "description": "Defines the parameters for RequestUri match conditions",
+ "required": [
+ "operator",
+ "matchValues",
+ "@odata.type"
+ ],
+ "properties": {
+ "@odata.type": {
+ "type": "string",
+ "enum": [
+ "#Microsoft.Azure.Cdn.Models.DeliveryRuleRequestUriConditionParameters"
+ ]
+ },
+ "operator": {
+ "description": "Describes operator to be matched",
+ "type": "string",
+ "enum": [
+ "Any",
+ "Equal",
+ "Contains",
+ "BeginsWith",
+ "EndsWith",
+ "LessThan",
+ "LessThanOrEqual",
+ "GreaterThan",
+ "GreaterThanOrEqual"
+ ],
+ "x-ms-enum": {
+ "name": "RequestUriOperator",
+ "modelAsString": true
+ }
+ },
+ "negateCondition": {
+ "description": "Describes if this is negate condition or not",
+ "type": "boolean"
+ },
+ "matchValues": {
+ "description": "The match value for the condition of the delivery rule",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "transforms": {
+ "description": "List of transforms",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/transform"
+ }
+ }
+ }
+ },
+ "RequestHeaderMatchConditionParameters": {
+ "description": "Defines the parameters for RequestHeader match conditions",
+ "required": [
+ "operator",
+ "matchValues",
+ "selector",
+ "@odata.type"
+ ],
+ "properties": {
+ "@odata.type": {
+ "type": "string",
+ "enum": [
+ "#Microsoft.Azure.Cdn.Models.DeliveryRuleRequestHeaderConditionParameters"
+ ]
+ },
+ "selector": {
+ "description": "Name of Header to be matched",
+ "type": "string"
+ },
+ "operator": {
+ "description": "Describes operator to be matched",
+ "type": "string",
+ "enum": [
+ "Any",
+ "Equal",
+ "Contains",
+ "BeginsWith",
+ "EndsWith",
+ "LessThan",
+ "LessThanOrEqual",
+ "GreaterThan",
+ "GreaterThanOrEqual"
+ ],
+ "x-ms-enum": {
+ "name": "RequestHeaderOperator",
+ "modelAsString": true
+ }
+ },
+ "negateCondition": {
+ "description": "Describes if this is negate condition or not",
+ "type": "boolean"
+ },
+ "matchValues": {
+ "description": "The match value for the condition of the delivery rule",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "transforms": {
+ "description": "List of transforms",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/transform"
+ }
+ }
+ }
+ },
+ "RequestBodyMatchConditionParameters": {
+ "description": "Defines the parameters for RequestBody match conditions",
+ "required": [
+ "operator",
+ "matchValues",
+ "@odata.type"
+ ],
+ "properties": {
+ "@odata.type": {
+ "type": "string",
+ "enum": [
+ "#Microsoft.Azure.Cdn.Models.DeliveryRuleRequestBodyConditionParameters"
+ ]
+ },
+ "operator": {
+ "description": "Describes operator to be matched",
+ "type": "string",
+ "enum": [
+ "Any",
+ "Equal",
+ "Contains",
+ "BeginsWith",
+ "EndsWith",
+ "LessThan",
+ "LessThanOrEqual",
+ "GreaterThan",
+ "GreaterThanOrEqual"
+ ],
+ "x-ms-enum": {
+ "name": "RequestBodyOperator",
+ "modelAsString": true
+ }
+ },
+ "negateCondition": {
+ "description": "Describes if this is negate condition or not",
+ "type": "boolean"
+ },
+ "matchValues": {
+ "description": "The match value for the condition of the delivery rule",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "transforms": {
+ "description": "List of transforms",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/transform"
+ }
+ }
+ }
+ },
+ "RequestSchemeMatchConditionParameters": {
+ "description": "Defines the parameters for RequestScheme match conditions ",
+ "required": [
+ "operator",
+ "matchValues",
+ "@odata.type"
+ ],
+ "properties": {
+ "@odata.type": {
+ "type": "string",
+ "enum": [
+ "#Microsoft.Azure.Cdn.Models.DeliveryRuleRequestSchemeConditionParameters"
+ ]
+ },
+ "operator": {
+ "description": "Describes operator to be matched",
+ "type": "string",
+ "enum": [
+ "Equal"
+ ]
+ },
+ "negateCondition": {
+ "description": "Describes if this is negate condition or not",
+ "type": "boolean"
+ },
+ "matchValues": {
+ "description": "The match value for the condition of the delivery rule",
+ "type": "array",
+ "items": {
+ "type": "string",
+ "enum": [
+ "HTTP",
+ "HTTPS"
+ ]
+ }
+ }
+ }
+ },
+ "UrlPathMatchConditionParameters": {
+ "description": "Defines the parameters for UrlPath match conditions",
+ "required": [
+ "operator",
+ "matchValues",
+ "@odata.type"
+ ],
+ "properties": {
+ "@odata.type": {
+ "type": "string",
+ "enum": [
+ "#Microsoft.Azure.Cdn.Models.DeliveryRuleUrlPathMatchConditionParameters"
+ ]
+ },
+ "operator": {
+ "description": "Describes operator to be matched",
+ "type": "string",
+ "enum": [
+ "Any",
+ "Equal",
+ "Contains",
+ "BeginsWith",
+ "EndsWith",
+ "LessThan",
+ "LessThanOrEqual",
+ "GreaterThan",
+ "GreaterThanOrEqual",
+ "Wildcard"
+ ],
+ "x-ms-enum": {
+ "name": "UrlPathOperator",
+ "modelAsString": true
+ }
+ },
+ "negateCondition": {
+ "description": "Describes if this is negate condition or not",
+ "type": "boolean"
+ },
+ "matchValues": {
+ "description": "The match value for the condition of the delivery rule",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "transforms": {
+ "description": "List of transforms",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/transform"
+ }
+ }
+ }
+ },
+ "UrlFileExtensionMatchConditionParameters": {
+ "description": "Defines the parameters for UrlFileExtension match conditions",
+ "required": [
+ "operator",
+ "matchValues",
+ "@odata.type"
+ ],
+ "properties": {
+ "@odata.type": {
+ "type": "string",
+ "enum": [
+ "#Microsoft.Azure.Cdn.Models.DeliveryRuleUrlFileExtensionMatchConditionParameters"
+ ]
+ },
+ "operator": {
+ "description": "Describes operator to be matched",
+ "type": "string",
+ "enum": [
+ "Any",
+ "Equal",
+ "Contains",
+ "BeginsWith",
+ "EndsWith",
+ "LessThan",
+ "LessThanOrEqual",
+ "GreaterThan",
+ "GreaterThanOrEqual"
+ ],
+ "x-ms-enum": {
+ "name": "UrlFileExtensionOperator",
+ "modelAsString": true
+ }
+ },
+ "negateCondition": {
+ "description": "Describes if this is negate condition or not",
+ "type": "boolean"
+ },
+ "matchValues": {
+ "description": "The match value for the condition of the delivery rule",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "transforms": {
+ "description": "List of transforms",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/transform"
+ }
+ }
+ }
+ },
+ "UrlFileNameMatchConditionParameters": {
+ "description": "Defines the parameters for UrlFilename match conditions",
+ "required": [
+ "operator",
+ "matchValues",
+ "@odata.type"
+ ],
+ "properties": {
+ "@odata.type": {
+ "type": "string",
+ "enum": [
+ "#Microsoft.Azure.Cdn.Models.DeliveryRuleUrlFilenameConditionParameters"
+ ]
+ },
+ "operator": {
+ "description": "Describes operator to be matched",
+ "type": "string",
+ "enum": [
+ "Any",
+ "Equal",
+ "Contains",
+ "BeginsWith",
+ "EndsWith",
+ "LessThan",
+ "LessThanOrEqual",
+ "GreaterThan",
+ "GreaterThanOrEqual"
+ ],
+ "x-ms-enum": {
+ "name": "UrlFileNameOperator",
+ "modelAsString": true
+ }
+ },
+ "negateCondition": {
+ "description": "Describes if this is negate condition or not",
+ "type": "boolean"
+ },
+ "matchValues": {
+ "description": "The match value for the condition of the delivery rule",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "transforms": {
+ "description": "List of transforms",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/transform"
+ }
+ }
+ }
+ },
+ "HttpVersionMatchConditionParameters": {
+ "description": "Defines the parameters for HttpVersion match conditions",
+ "required": [
+ "operator",
+ "matchValues",
+ "@odata.type"
+ ],
+ "properties": {
+ "@odata.type": {
+ "type": "string",
+ "enum": [
+ "#Microsoft.Azure.Cdn.Models.DeliveryRuleHttpVersionConditionParameters"
+ ]
+ },
+ "operator": {
+ "description": "Describes operator to be matched",
+ "type": "string",
+ "enum": [
+ "Equal"
+ ],
+ "x-ms-enum": {
+ "name": "HttpVersionOperator",
+ "modelAsString": true
+ }
+ },
+ "negateCondition": {
+ "description": "Describes if this is negate condition or not",
+ "type": "boolean"
+ },
+ "matchValues": {
+ "description": "The match value for the condition of the delivery rule",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "CookiesMatchConditionParameters": {
+ "description": "Defines the parameters for Cookies match conditions",
+ "required": [
+ "operator",
+ "matchValues",
+ "selector",
+ "@odata.type"
+ ],
+ "properties": {
+ "@odata.type": {
+ "type": "string",
+ "enum": [
+ "#Microsoft.Azure.Cdn.Models.DeliveryRuleCookiesConditionParameters"
+ ]
+ },
+ "selector": {
+ "description": "Name of Cookies to be matched",
+ "type": "string"
+ },
+ "operator": {
+ "description": "Describes operator to be matched",
+ "type": "string",
+ "enum": [
+ "Any",
+ "Equal",
+ "Contains",
+ "BeginsWith",
+ "EndsWith",
+ "LessThan",
+ "LessThanOrEqual",
+ "GreaterThan",
+ "GreaterThanOrEqual"
+ ],
+ "x-ms-enum": {
+ "name": "CookiesOperator",
+ "modelAsString": true
+ }
+ },
+ "negateCondition": {
+ "description": "Describes if this is negate condition or not",
+ "type": "boolean"
+ },
+ "matchValues": {
+ "description": "The match value for the condition of the delivery rule",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "transforms": {
+ "description": "List of transforms",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/transform"
+ }
+ }
+ }
+ },
+ "IsDeviceMatchConditionParameters": {
+ "description": "Defines the parameters for IsDevice match conditions",
+ "required": [
+ "operator",
+ "matchValues",
+ "@odata.type"
+ ],
+ "properties": {
+ "@odata.type": {
+ "type": "string",
+ "enum": [
+ "#Microsoft.Azure.Cdn.Models.DeliveryRuleIsDeviceConditionParameters"
+ ]
+ },
+ "operator": {
+ "description": "Describes operator to be matched",
+ "type": "string",
+ "enum": [
+ "Equal"
+ ],
+ "x-ms-enum": {
+ "name": "IsDeviceOperator",
+ "modelAsString": true
+ }
+ },
+ "negateCondition": {
+ "description": "Describes if this is negate condition or not",
+ "type": "boolean"
+ },
+ "matchValues": {
+ "description": "The match value for the condition of the delivery rule",
+ "type": "array",
+ "items": {
+ "type": "string",
+ "enum": [
+ "Mobile",
+ "Desktop"
+ ]
+ }
+ },
+ "transforms": {
+ "description": "List of transforms",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/transform"
+ }
+ }
+ }
+ },
+ "DeliveryRuleAction": {
+ "description": "An action for the delivery rule.",
+ "discriminator": "name",
+ "required": [
+ "name"
+ ],
+ "properties": {
+ "name": {
+ "description": "The name of the action for the delivery rule.",
+ "type": "string",
+ "enum": [
+ "CacheExpiration",
+ "CacheKeyQueryString",
+ "ModifyRequestHeader",
+ "ModifyResponseHeader",
+ "UrlRedirect",
+ "UrlRewrite",
+ "UrlSigning"
+ ],
+ "x-ms-enum": {
+ "name": "DeliveryRuleAction",
+ "modelAsString": true
+ }
+ }
+ }
+ },
+ "UrlRedirectAction": {
+ "description": "Defines the url redirect action for the delivery rule.",
+ "x-ms-discriminator-value": "UrlRedirect",
+ "allOf": [
+ {
+ "$ref": "#/definitions/DeliveryRuleAction"
+ }
+ ],
+ "required": [
+ "parameters"
+ ],
+ "properties": {
+ "parameters": {
+ "description": "Defines the parameters for the action.",
+ "$ref": "#/definitions/UrlRedirectActionParameters"
+ }
+ }
+ },
+ "UrlRedirectActionParameters": {
+ "description": "Defines the parameters for the url redirect action.",
+ "required": [
+ "redirectType",
+ "@odata.type"
+ ],
+ "properties": {
+ "@odata.type": {
+ "type": "string",
+ "enum": [
+ "#Microsoft.Azure.Cdn.Models.DeliveryRuleUrlRedirectActionParameters"
+ ]
+ },
+ "redirectType": {
+ "description": "The redirect type the rule will use when redirecting traffic.",
+ "type": "string",
+ "enum": [
+ "Moved",
+ "Found",
+ "TemporaryRedirect",
+ "PermanentRedirect"
+ ],
+ "x-ms-enum": {
+ "name": "RedirectType",
+ "modelAsString": true
+ }
+ },
+ "destinationProtocol": {
+ "description": "Protocol to use for the redirect. The default value is MatchRequest",
+ "type": "string",
+ "enum": [
+ "MatchRequest",
+ "Http",
+ "Https"
+ ],
+ "x-ms-enum": {
+ "name": "DestinationProtocol",
+ "modelAsString": true
+ }
+ },
+ "customPath": {
+ "description": "The full path to redirect. Path cannot be empty and must start with /. Leave empty to use the incoming path as destination path.",
+ "type": "string"
+ },
+ "customHostname": {
+ "description": "Host to redirect. Leave empty to use the incoming host as the destination host.",
+ "type": "string"
+ },
+ "customQueryString": {
+ "description": "The set of query strings to be placed in the redirect URL. Setting this value would replace any existing query string; leave empty to preserve the incoming query string. Query string must be in = format. ? and & will be added automatically so do not include them.",
+ "type": "string"
+ },
+ "customFragment": {
+ "type": "string",
+ "description": "Fragment to add to the redirect URL. Fragment is the part of the URL that comes after #. Do not include the #."
+ }
+ }
+ },
+ "UrlSigningActionParameters": {
+ "description": "Defines the parameters for the Url Signing action.",
+ "required": [
+ "keyId"
+ ],
+ "properties": {
+ "keyId": {
+ "description": "Id reference of the key to be used to verify the hash and should be defined in UrlSigningKeys",
+ "type": "string"
+ },
+ "algorithm": {
+ "description": "Algorithm to use for URL signing",
+ "type": "string",
+ "enum": [
+ "SHA256"
+ ]
+ },
+ "parameterNameOverride": {
+ "description": "Defines which query string parameters in the url to be considered for expires, key id etc. ",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/UrlSigningParamIdentifier"
+ }
+ },
+ "ipSubnets": {
+ "description": "Match values to match against. Supports CIDR ranges (both IPv4 and IPv6).",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "UrlSigningParamIdentifier": {
+ "description": "Defines how to identify a parameter for a specific purpose e.g. expires",
+ "required": [
+ "paramIndicator",
+ "paramName"
+ ],
+ "properties": {
+ "paramIndicator": {
+ "description": "Indicates the purpose of the parameter",
+ "type": "string",
+ "enum": [
+ "expires",
+ "keyId",
+ "signature"
+ ]
+ },
+ "paramName": {
+ "description": "Parameter name",
+ "type": "string"
+ }
+ }
+ },
+ "UrlRewriteAction": {
+ "description": "Defines the url rewrite action for the delivery rule.",
+ "x-ms-discriminator-value": "UrlRewrite",
+ "allOf": [
+ {
+ "$ref": "#/definitions/DeliveryRuleAction"
+ }
+ ],
+ "required": [
+ "parameters"
+ ],
+ "properties": {
+ "parameters": {
+ "description": "Defines the parameters for the action.",
+ "$ref": "#/definitions/UrlRewriteActionParameters"
+ }
+ }
+ },
+ "UrlRewriteActionParameters": {
+ "description": "Defines the parameters for the url rewrite action.",
+ "required": [
+ "sourcePattern",
+ "destination",
+ "@odata.type"
+ ],
+ "properties": {
+ "@odata.type": {
+ "type": "string",
+ "enum": [
+ "#Microsoft.Azure.Cdn.Models.DeliveryRuleUrlRewriteActionParameters"
+ ]
+ },
+ "sourcePattern": {
+ "description": "define a request URI pattern that identifies the type of requests that may be rewritten. If value is blank, all strings are matched.",
+ "type": "string"
+ },
+ "destination": {
+ "description": "Define the relative URL to which the above requests will be rewritten by.",
+ "type": "string"
+ },
+ "preserveUnmatchedPath": {
+ "description": "Whether to preserve unmatched path. Default value is true.",
+ "type": "boolean"
+ }
+ }
+ },
+ "DeliveryRuleRequestHeaderAction": {
+ "description": "Defines the request header action for the delivery rule.",
+ "x-ms-discriminator-value": "ModifyRequestHeader",
+ "allOf": [
+ {
+ "$ref": "#/definitions/DeliveryRuleAction"
+ }
+ ],
+ "required": [
+ "parameters"
+ ],
+ "properties": {
+ "parameters": {
+ "description": "Defines the parameters for the action.",
+ "$ref": "#/definitions/HeaderActionParameters"
+ }
+ }
+ },
+ "DeliveryRuleResponseHeaderAction": {
+ "description": "Defines the response header action for the delivery rule.",
+ "x-ms-discriminator-value": "ModifyResponseHeader",
+ "allOf": [
+ {
+ "$ref": "#/definitions/DeliveryRuleAction"
+ }
+ ],
+ "required": [
+ "parameters"
+ ],
+ "properties": {
+ "parameters": {
+ "description": "Defines the parameters for the action.",
+ "$ref": "#/definitions/HeaderActionParameters"
+ }
+ }
+ },
+ "HeaderActionParameters": {
+ "description": "Defines the parameters for the request header action.",
+ "required": [
+ "headerAction",
+ "headerName",
+ "@odata.type"
+ ],
+ "properties": {
+ "@odata.type": {
+ "type": "string",
+ "enum": [
+ "#Microsoft.Azure.Cdn.Models.DeliveryRuleHeaderActionParameters"
+ ]
+ },
+ "headerAction": {
+ "description": "Action to perform",
+ "type": "string",
+ "enum": [
+ "Append",
+ "Overwrite",
+ "Delete"
+ ],
+ "x-ms-enum": {
+ "name": "HeaderAction",
+ "modelAsString": true
+ }
+ },
+ "headerName": {
+ "description": "Name of the header to modify",
+ "type": "string"
+ },
+ "value": {
+ "description": "Value for the specified action",
+ "type": "string"
+ }
+ }
+ },
+ "DeliveryRuleCacheExpirationAction": {
+ "description": "Defines the cache expiration action for the delivery rule.",
+ "x-ms-discriminator-value": "CacheExpiration",
+ "allOf": [
+ {
+ "$ref": "#/definitions/DeliveryRuleAction"
+ }
+ ],
+ "required": [
+ "parameters"
+ ],
+ "properties": {
+ "parameters": {
+ "description": "Defines the parameters for the action.",
+ "$ref": "#/definitions/CacheExpirationActionParameters"
+ }
+ }
+ },
+ "CacheExpirationActionParameters": {
+ "description": "Defines the parameters for the cache expiration action.",
+ "required": [
+ "cacheBehavior",
+ "cacheType",
+ "@odata.type"
+ ],
+ "properties": {
+ "@odata.type": {
+ "type": "string",
+ "enum": [
+ "#Microsoft.Azure.Cdn.Models.DeliveryRuleCacheExpirationActionParameters"
+ ]
+ },
+ "cacheBehavior": {
+ "description": "Caching behavior for the requests",
+ "type": "string",
+ "enum": [
+ "BypassCache",
+ "Override",
+ "SetIfMissing"
+ ],
+ "x-ms-enum": {
+ "name": "cacheBehavior",
+ "modelAsString": true
+ }
+ },
+ "cacheType": {
+ "description": "The level at which the content needs to be cached.",
+ "type": "string",
+ "enum": [
+ "All"
+ ],
+ "x-ms-enum": {
+ "name": "CacheType",
+ "modelAsString": true
+ }
+ },
+ "cacheDuration": {
+ "description": "The duration for which the content needs to be cached. Allowed format is [d.]hh:mm:ss",
+ "type": "string",
+ "x-nullable": true
+ }
+ }
+ },
+ "DeliveryRuleCacheKeyQueryStringAction": {
+ "description": "Defines the cache-key query string action for the delivery rule.",
+ "x-ms-discriminator-value": "CacheKeyQueryString",
+ "allOf": [
+ {
+ "$ref": "#/definitions/DeliveryRuleAction"
+ }
+ ],
+ "required": [
+ "parameters"
+ ],
+ "properties": {
+ "parameters": {
+ "description": "Defines the parameters for the action.",
+ "$ref": "#/definitions/CacheKeyQueryStringActionParameters"
+ }
+ }
+ },
+ "CacheKeyQueryStringActionParameters": {
+ "description": "Defines the parameters for the cache-key query string action.",
+ "required": [
+ "queryStringBehavior",
+ "@odata.type"
+ ],
+ "properties": {
+ "@odata.type": {
+ "type": "string",
+ "enum": [
+ "#Microsoft.Azure.Cdn.Models.DeliveryRuleCacheKeyQueryStringBehaviorActionParameters"
+ ]
+ },
+ "queryStringBehavior": {
+ "description": "Caching behavior for the requests",
+ "type": "string",
+ "enum": [
+ "Include",
+ "IncludeAll",
+ "Exclude",
+ "ExcludeAll"
+ ],
+ "x-ms-enum": {
+ "name": "queryStringBehavior",
+ "modelAsString": true
+ }
+ },
+ "queryParameters": {
+ "description": "query parameters to include or exclude (comma separated).",
+ "type": "string",
+ "x-nullable": true
+ }
+ }
+ },
+ "transform": {
+ "description": "Describes what transforms are applied before matching",
+ "type": "string",
+ "enum": [
+ "Lowercase",
+ "Uppercase"
+ ],
+ "x-ms-enum": {
+ "name": "transform",
+ "modelAsString": true
+ }
+ },
+ "DeepCreatedOrigin": {
+ "description": "The main origin of CDN content which is added when creating a CDN endpoint.",
+ "type": "object",
+ "required": [
+ "name"
+ ],
+ "properties": {
+ "name": {
+ "description": "Origin name which must be unique within the endpoint. ",
+ "type": "string"
+ },
+ "properties": {
+ "x-ms-client-flatten": true,
+ "$ref": "#/definitions/DeepCreatedOriginProperties"
+ }
+ },
+ "x-ms-azure-resource": true
+ },
+ "DeepCreatedOriginProperties": {
+ "description": "Properties of the origin created on the CDN endpoint.",
+ "type": "object",
+ "required": [
+ "hostName"
+ ],
+ "properties": {
+ "hostName": {
+ "description": "The address of the origin. It can be a domain name, IPv4 address, or IPv6 address. This should be unique across all origins in an endpoint.",
+ "type": "string"
+ },
+ "httpPort": {
+ "description": "The value of the HTTP port. Must be between 1 and 65535.",
+ "type": "integer",
+ "maximum": 65535,
+ "exclusiveMaximum": false,
+ "minimum": 1,
+ "exclusiveMinimum": false
+ },
+ "httpsPort": {
+ "description": "The value of the HTTPS port. Must be between 1 and 65535.",
+ "type": "integer",
+ "maximum": 65535,
+ "exclusiveMaximum": false,
+ "minimum": 1,
+ "exclusiveMinimum": false
+ },
+ "originHostHeader": {
+ "description": "The host header value sent to the origin with each request. If you leave this blank, the request hostname determines this value. Azure CDN origins, such as Web Apps, Blob Storage, and Cloud Services require this host header value to match the origin hostname by default.",
+ "type": "string"
+ },
+ "priority": {
+ "description": "Priority of origin in given origin group for load balancing. Higher priorities will not be used for load balancing if any lower priority origin is healthy.Must be between 1 and 5.",
+ "type": "integer",
+ "maximum": 5,
+ "minimum": 1
+ },
+ "weight": {
+ "description": "Weight of the origin in given origin group for load balancing. Must be between 1 and 1000",
+ "type": "integer",
+ "maximum": 1000,
+ "minimum": 1
+ },
+ "enabled": {
+ "description": "Origin is enabled for load balancing or not. By default, origin is always enabled.",
+ "type": "boolean"
+ }
+ },
+ "x-ms-azure-resource": true
+ },
+ "DeepCreatedOriginGroup": {
+ "description": "The origin group for CDN content which is added when creating a CDN endpoint. Traffic is sent to the origins within the origin group based on origin health.",
+ "type": "object",
+ "required": [
+ "name"
+ ],
+ "properties": {
+ "name": {
+ "description": "Origin group name which must be unique within the endpoint.",
+ "type": "string"
+ },
+ "properties": {
+ "x-ms-client-flatten": true,
+ "$ref": "#/definitions/DeepCreatedOriginGroupProperties"
+ }
+ },
+ "x-ms-azure-resource": true
+ },
+ "DeepCreatedOriginGroupProperties": {
+ "description": "Properties of the origin group created on the CDN endpoint.",
+ "type": "object",
+ "required": [
+ "origins"
+ ],
+ "properties": {
+ "healthProbeSettings": {
+ "description": "Health probe settings to the origin that is used to determine the health of the origin.",
+ "type": "object",
+ "$ref": "#/definitions/HealthProbeParameters"
+ },
+ "origins": {
+ "description": "The source of the content being delivered via CDN within given origin group.",
+ "type": "array",
+ "items": {
+ "description": "A reference to a origin.",
+ "$ref": "#/definitions/ResourceReference"
+ }
+ },
+ "trafficRestorationTimeToHealedOrNewEndpointsInMinutes": {
+ "description": "Time in minutes to shift the traffic to the endpoint gradually when an unhealthy endpoint comes healthy or a new endpoint is added. Default is 10 mins. This property is currently not supported.",
+ "type": "integer",
+ "maximum": 50,
+ "minimum": 0
+ },
+ "responseBasedOriginErrorDetectionSettings": {
+ "description": "The JSON object that contains the properties to determine origin health using real requests/responses.This property is currently not supported.",
+ "type": "object",
+ "$ref": "#/definitions/ResponseBasedOriginErrorDetectionParameters"
+ }
+ },
+ "x-ms-azure-resource": true
+ },
+ "ResourceReference": {
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "Resource ID."
+ }
+ },
+ "description": "Reference to another resource.",
+ "x-ms-azure-resource": true
+ },
+ "GeoFilter": {
+ "description": "Rules defining user's geo access within a CDN endpoint.",
+ "type": "object",
+ "required": [
+ "relativePath",
+ "action",
+ "countryCodes"
+ ],
+ "properties": {
+ "relativePath": {
+ "description": "Relative path applicable to geo filter. (e.g. '/mypictures', '/mypicture/kitty.jpg', and etc.)",
+ "type": "string"
+ },
+ "action": {
+ "description": "Action of the geo filter, i.e. allow or block access.",
+ "enum": [
+ "Block",
+ "Allow"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "GeoFilterActions",
+ "modelAsString": false
+ }
+ },
+ "countryCodes": {
+ "description": "Two letter country codes defining user country access in a geo filter, e.g. AU, MX, US.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "PurgeParameters": {
+ "type": "object",
+ "description": "Parameters required for content purge.",
+ "required": [
+ "contentPaths"
+ ],
+ "properties": {
+ "contentPaths": {
+ "description": "The path to the content to be purged. Can describe a file path or a wild card directory.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "UrlSigningKey": {
+ "description": "Url signing key",
+ "required": [
+ "keyId",
+ "keySourceParameters"
+ ],
+ "properties": {
+ "keyId": {
+ "description": "Defines the customer defined key Id. This id will exist in the incoming request to indicate the key used to form the hash.",
+ "type": "string"
+ },
+ "keySourceParameters": {
+ "description": "Defines the parameters for using customer key vault for Url Signing Key.",
+ "$ref": "#/definitions/KeyVaultSigningKeyParameters"
+ }
+ }
+ },
+ "KeyVaultSigningKeyParameters": {
+ "description": "Describes the parameters for using a user's KeyVault for URL Signing Key.",
+ "required": [
+ "@odata.type",
+ "subscriptionId",
+ "resourceGroupName",
+ "vaultName",
+ "secretName",
+ "secretVersion"
+ ],
+ "properties": {
+ "@odata.type": {
+ "type": "string",
+ "enum": [
+ "#Microsoft.Azure.Cdn.Models.KeyVaultSigningKeyParameters"
+ ]
+ },
+ "subscriptionId": {
+ "description": "Subscription Id of the user's Key Vault containing the secret",
+ "type": "string"
+ },
+ "resourceGroupName": {
+ "description": "Resource group of the user's Key Vault containing the secret",
+ "type": "string"
+ },
+ "vaultName": {
+ "description": "The name of the user's Key Vault containing the secret",
+ "type": "string"
+ },
+ "secretName": {
+ "description": "The name of secret in Key Vault.",
+ "type": "string"
+ },
+ "secretVersion": {
+ "description": "The version(GUID) of secret in Key Vault.",
+ "type": "string"
+ }
+ }
+ },
+ "LoadParameters": {
+ "type": "object",
+ "description": "Parameters required for content load.",
+ "required": [
+ "contentPaths"
+ ],
+ "properties": {
+ "contentPaths": {
+ "description": "The path to the content to be loaded. Path should be a relative file URL of the origin.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "Origin": {
+ "description": "CDN origin is the source of the content being delivered via CDN. When the edge nodes represented by an endpoint do not have the requested content cached, they attempt to fetch it from one or more of the configured origins.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/TrackedResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "x-ms-client-flatten": true,
+ "$ref": "#/definitions/OriginProperties"
+ }
+ }
+ },
+ "OriginProperties": {
+ "description": "The JSON object that contains the properties of the origin.",
+ "required": [
+ "hostName"
+ ],
+ "allOf": [
+ {
+ "$ref": "#/definitions/OriginUpdatePropertiesParameters"
+ }
+ ],
+ "properties": {
+ "resourceState": {
+ "description": "Resource status of the origin.",
+ "readOnly": true,
+ "enum": [
+ "Creating",
+ "Active",
+ "Deleting"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "OriginResourceState",
+ "modelAsString": true
+ }
+ },
+ "provisioningState": {
+ "readOnly": true,
+ "description": "Provisioning status of the origin.",
+ "type": "string"
+ },
+ "privateEndpointStatus": {
+ "description": "The approval status for the connection to the Private Link",
+ "type": "string",
+ "readOnly": true,
+ "enum": [
+ "Pending",
+ "Approved",
+ "Rejected",
+ "Disconnected",
+ "Timeout"
+ ],
+ "x-ms-enum": {
+ "name": "PrivateEndpointStatus",
+ "modelAsString": true
+ }
+ }
+ }
+ },
+ "OriginUpdateParameters": {
+ "type": "object",
+ "description": "Origin properties needed for origin update.",
+ "properties": {
+ "tags": {
+ "description": "Origin tags.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "properties": {
+ "x-ms-client-flatten": true,
+ "$ref": "#/definitions/OriginUpdatePropertiesParameters"
+ }
+ },
+ "x-ms-azure-resource": true
+ },
+ "OriginUpdatePropertiesParameters": {
+ "description": "The JSON object that contains the properties of the origin.",
+ "properties": {
+ "hostName": {
+ "description": "The address of the origin. Domain names, IPv4 addresses, and IPv6 addresses are supported.This should be unique across all origins in an endpoint.",
+ "type": "string"
+ },
+ "httpPort": {
+ "description": "The value of the HTTP port. Must be between 1 and 65535.",
+ "type": "integer",
+ "maximum": 65535,
+ "exclusiveMaximum": false,
+ "minimum": 1,
+ "exclusiveMinimum": false
+ },
+ "httpsPort": {
+ "description": "The value of the HTTPS port. Must be between 1 and 65535.",
+ "type": "integer",
+ "maximum": 65535,
+ "exclusiveMaximum": false,
+ "minimum": 1,
+ "exclusiveMinimum": false
+ },
+ "originHostHeader": {
+ "description": "The host header value sent to the origin with each request. If you leave this blank, the request hostname determines this value. Azure CDN origins, such as Web Apps, Blob Storage, and Cloud Services require this host header value to match the origin hostname by default. This overrides the host header defined at Endpoint",
+ "type": "string"
+ },
+ "priority": {
+ "description": "Priority of origin in given origin group for load balancing. Higher priorities will not be used for load balancing if any lower priority origin is healthy.Must be between 1 and 5",
+ "type": "integer",
+ "maximum": 5,
+ "minimum": 1
+ },
+ "weight": {
+ "description": "Weight of the origin in given origin group for load balancing. Must be between 1 and 1000",
+ "type": "integer",
+ "maximum": 1000,
+ "minimum": 1
+ },
+ "enabled": {
+ "description": "Origin is enabled for load balancing or not",
+ "type": "boolean"
+ },
+ "privateLinkAlias": {
+ "description": "The Alias of the Private Link resource. Populating this optional field indicates that this origin is 'Private'",
+ "type": "string"
+ },
+ "privateLinkResourceId": {
+ "description": "The Resource Id of the Private Link resource. Populating this optional field indicates that this backend is 'Private'",
+ "type": "string"
+ },
+ "privateLinkLocation": {
+ "description": "The location of the Private Link resource. Required only if 'privateLinkResourceId' is populated",
+ "type": "string"
+ },
+ "privateLinkApprovalMessage": {
+ "description": "A custom message to be included in the approval request to connect to the Private Link.",
+ "type": "string"
+ }
+ }
+ },
+ "OriginListResult": {
+ "description": "Result of the request to list origins. It contains a list of origin objects and a URL link to get the next set of results.",
+ "properties": {
+ "value": {
+ "type": "array",
+ "readOnly": true,
+ "items": {
+ "$ref": "#/definitions/Origin"
+ },
+ "description": "List of CDN origins within an endpoint"
+ },
+ "nextLink": {
+ "type": "string",
+ "description": "URL to get the next set of origin objects if there are any."
+ }
+ }
+ },
+ "OriginGroup": {
+ "description": "Origin group comprising of origins is used for load balancing to origins when the content cannot be served from CDN.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ProxyResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "x-ms-client-flatten": true,
+ "$ref": "#/definitions/OriginGroupProperties"
+ }
+ }
+ },
+ "OriginGroupProperties": {
+ "description": "The JSON object that contains the properties of the origin group.",
+ "type": "object",
+ "required": [
+ "origins"
+ ],
+ "allOf": [
+ {
+ "$ref": "#/definitions/OriginGroupUpdatePropertiesParameters"
+ }
+ ],
+ "properties": {
+ "resourceState": {
+ "description": "Resource status of the origin group.",
+ "readOnly": true,
+ "enum": [
+ "Creating",
+ "Active",
+ "Deleting"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "OriginGroupResourceState",
+ "modelAsString": true
+ }
+ },
+ "provisioningState": {
+ "readOnly": true,
+ "description": "Provisioning status of the origin group.",
+ "type": "string"
+ }
+ }
+ },
+ "OriginGroupUpdateParameters": {
+ "type": "object",
+ "description": "Origin group properties needed for origin group creation or update.",
+ "properties": {
+ "properties": {
+ "x-ms-client-flatten": true,
+ "$ref": "#/definitions/OriginGroupUpdatePropertiesParameters"
+ }
+ },
+ "x-ms-azure-resource": true
+ },
+ "OriginGroupUpdatePropertiesParameters": {
+ "description": "The JSON object that contains the properties of the origin group.",
+ "properties": {
+ "healthProbeSettings": {
+ "description": "Health probe settings to the origin that is used to determine the health of the origin.",
+ "type": "object",
+ "$ref": "#/definitions/HealthProbeParameters"
+ },
+ "origins": {
+ "description": "The source of the content being delivered via CDN within given origin group.",
+ "type": "array",
+ "items": {
+ "description": "A reference to a origin.",
+ "$ref": "#/definitions/ResourceReference"
+ }
+ },
+ "trafficRestorationTimeToHealedOrNewEndpointsInMinutes": {
+ "description": "Time in minutes to shift the traffic to the endpoint gradually when an unhealthy endpoint comes healthy or a new endpoint is added. Default is 10 mins. This property is currently not supported.",
+ "type": "integer",
+ "maximum": 50,
+ "minimum": 0
+ },
+ "responseBasedOriginErrorDetectionSettings": {
+ "description": "The JSON object that contains the properties to determine origin health using real requests/responses. This property is currently not supported.",
+ "type": "object",
+ "$ref": "#/definitions/ResponseBasedOriginErrorDetectionParameters"
+ }
+ }
+ },
+ "HealthProbeParameters": {
+ "description": "The JSON object that contains the properties to send health probes to origin.",
+ "properties": {
+ "probePath": {
+ "description": "The path relative to the origin that is used to determine the health of the origin.",
+ "type": "string"
+ },
+ "probeRequestType": {
+ "description": "The type of health probe request that is made.",
+ "enum": [
+ "NotSet",
+ "GET",
+ "HEAD"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "HealthProbeRequestType",
+ "modelAsString": false
+ }
+ },
+ "probeProtocol": {
+ "description": "Protocol to use for health probe.",
+ "type": "string",
+ "enum": [
+ "NotSet",
+ "Http",
+ "Https"
+ ],
+ "x-ms-enum": {
+ "name": "ProbeProtocol",
+ "modelAsString": false
+ }
+ },
+ "probeIntervalInSeconds": {
+ "description": "The number of seconds between health probes.Default is 240sec.",
+ "type": "integer",
+ "maximum": 255,
+ "minimum": 1
+ }
+ }
+ },
+ "ResponseBasedOriginErrorDetectionParameters": {
+ "description": "The JSON object that contains the properties to determine origin health using real requests/responses.",
+ "properties": {
+ "responseBasedDetectedErrorTypes": {
+ "description": "Type of response errors for real user requests for which origin will be deemed unhealthy",
+ "type": "string",
+ "enum": [
+ "None",
+ "TcpErrorsOnly",
+ "TcpAndHttpErrors"
+ ],
+ "x-ms-enum": {
+ "name": "ResponseBasedDetectedErrorTypes",
+ "modelAsString": false
+ }
+ },
+ "responseBasedFailoverThresholdPercentage": {
+ "description": "The percentage of failed requests in the sample where failover should trigger.",
+ "type": "integer",
+ "maximum": 100,
+ "minimum": 0
+ },
+ "httpErrorRanges": {
+ "description": "The list of Http status code ranges that are considered as server errors for origin and it is marked as unhealthy.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/HttpErrorRangeParameters"
+ }
+ }
+ }
+ },
+ "HttpErrorRangeParameters": {
+ "description": "The JSON object that represents the range for http status codes",
+ "properties": {
+ "begin": {
+ "description": "The inclusive start of the http status code range.",
+ "type": "integer",
+ "maximum": 999,
+ "minimum": 100
+ },
+ "end": {
+ "description": "The inclusive end of the http status code range.",
+ "type": "integer",
+ "maximum": 999,
+ "minimum": 100
+ }
+ }
+ },
+ "OriginGroupListResult": {
+ "description": "Result of the request to list origin groups. It contains a list of origin groups objects and a URL link to get the next set of results.",
+ "properties": {
+ "value": {
+ "type": "array",
+ "readOnly": true,
+ "items": {
+ "$ref": "#/definitions/OriginGroup"
+ },
+ "description": "List of CDN origin groups within an endpoint"
+ },
+ "nextLink": {
+ "type": "string",
+ "description": "URL to get the next set of origin objects if there are any."
+ }
+ }
+ },
+ "CustomDomain": {
+ "description": "Friendly domain name mapping to the endpoint hostname that the customer provides for branding purposes, e.g. www.contoso.com.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ProxyResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "x-ms-client-flatten": true,
+ "$ref": "#/definitions/CustomDomainProperties"
+ }
+ }
+ },
+ "CustomDomainProperties": {
+ "description": "The JSON object that contains the properties of the custom domain to create.",
+ "required": [
+ "hostName"
+ ],
+ "properties": {
+ "hostName": {
+ "description": "The host name of the custom domain. Must be a domain name.",
+ "type": "string"
+ },
+ "resourceState": {
+ "description": "Resource status of the custom domain.",
+ "readOnly": true,
+ "enum": [
+ "Creating",
+ "Active",
+ "Deleting"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "CustomDomainResourceState",
+ "modelAsString": true
+ }
+ },
+ "customHttpsProvisioningState": {
+ "description": "Provisioning status of Custom Https of the custom domain.",
+ "readOnly": true,
+ "enum": [
+ "Enabling",
+ "Enabled",
+ "Disabling",
+ "Disabled",
+ "Failed"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "CustomHttpsProvisioningState",
+ "modelAsString": true
+ }
+ },
+ "customHttpsProvisioningSubstate": {
+ "description": "Provisioning substate shows the progress of custom HTTPS enabling/disabling process step by step.",
+ "readOnly": true,
+ "enum": [
+ "SubmittingDomainControlValidationRequest",
+ "PendingDomainControlValidationREquestApproval",
+ "DomainControlValidationRequestApproved",
+ "DomainControlValidationRequestRejected",
+ "DomainControlValidationRequestTimedOut",
+ "IssuingCertificate",
+ "DeployingCertificate",
+ "CertificateDeployed",
+ "DeletingCertificate",
+ "CertificateDeleted"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "CustomHttpsProvisioningSubstate",
+ "modelAsString": true
+ }
+ },
+ "validationData": {
+ "description": "Special validation or data may be required when delivering CDN to some regions due to local compliance reasons. E.g. ICP license number of a custom domain is required to deliver content in China.",
+ "type": "string"
+ },
+ "provisioningState": {
+ "readOnly": true,
+ "description": "Provisioning status of the custom domain.",
+ "type": "string"
+ }
+ }
+ },
+ "CustomDomainParameters": {
+ "description": "The customDomain JSON object required for custom domain creation or update.",
+ "type": "object",
+ "properties": {
+ "properties": {
+ "x-ms-client-flatten": true,
+ "$ref": "#/definitions/CustomDomainPropertiesParameters"
+ }
+ }
+ },
+ "CustomDomainPropertiesParameters": {
+ "description": "The JSON object that contains the properties of the custom domain to create.",
+ "required": [
+ "hostName"
+ ],
+ "properties": {
+ "hostName": {
+ "description": "The host name of the custom domain. Must be a domain name.",
+ "type": "string"
+ }
+ }
+ },
+ "CustomDomainHttpsParameters": {
+ "description": "The JSON object that contains the properties to secure a custom domain.",
+ "discriminator": "certificateSource",
+ "required": [
+ "certificateSource",
+ "protocolType"
+ ],
+ "properties": {
+ "certificateSource": {
+ "description": "Defines the source of the SSL certificate.",
+ "enum": [
+ "AzureKeyVault",
+ "Cdn"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "CertificateSource",
+ "modelAsString": true
+ }
+ },
+ "protocolType": {
+ "description": "Defines the TLS extension protocol that is used for secure delivery.",
+ "enum": [
+ "ServerNameIndication",
+ "IPBased"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "ProtocolType",
+ "modelAsString": true
+ }
+ },
+ "minimumTlsVersion": {
+ "description": "TLS protocol version that will be used for Https",
+ "enum": [
+ "None",
+ "TLS10",
+ "TLS12"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "MinimumTlsVersion",
+ "modelAsString": false
+ }
+ }
+ }
+ },
+ "CdnManagedHttpsParameters": {
+ "description": "Defines the certificate source parameters using CDN managed certificate for enabling SSL.",
+ "x-ms-discriminator-value": "Cdn",
+ "allOf": [
+ {
+ "$ref": "#/definitions/CustomDomainHttpsParameters"
+ }
+ ],
+ "required": [
+ "certificateSourceParameters"
+ ],
+ "properties": {
+ "certificateSourceParameters": {
+ "description": "Defines the certificate source parameters using CDN managed certificate for enabling SSL.",
+ "$ref": "#/definitions/CdnCertificateSourceParameters"
+ }
+ }
+ },
+ "CdnCertificateSourceParameters": {
+ "description": "Defines the parameters for using CDN managed certificate for securing custom domain.",
+ "required": [
+ "@odata.type",
+ "certificateType"
+ ],
+ "properties": {
+ "@odata.type": {
+ "type": "string",
+ "enum": [
+ "#Microsoft.Azure.Cdn.Models.CdnCertificateSourceParameters"
+ ]
+ },
+ "certificateType": {
+ "description": "Type of certificate used",
+ "enum": [
+ "Shared",
+ "Dedicated"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "CertificateType",
+ "modelAsString": true
+ }
+ }
+ }
+ },
+ "UserManagedHttpsParameters": {
+ "description": "Defines the certificate source parameters using user's keyvault certificate for enabling SSL.",
+ "x-ms-discriminator-value": "AzureKeyVault",
+ "allOf": [
+ {
+ "$ref": "#/definitions/CustomDomainHttpsParameters"
+ }
+ ],
+ "required": [
+ "certificateSourceParameters"
+ ],
+ "properties": {
+ "certificateSourceParameters": {
+ "description": "Defines the certificate source parameters using user's keyvault certificate for enabling SSL.",
+ "$ref": "#/definitions/KeyVaultCertificateSourceParameters"
+ }
+ }
+ },
+ "KeyVaultCertificateSourceParameters": {
+ "description": "Describes the parameters for using a user's KeyVault certificate for securing custom domain.",
+ "required": [
+ "@odata.type",
+ "subscriptionId",
+ "resourceGroupName",
+ "vaultName",
+ "secretName",
+ "secretVersion",
+ "updateRule",
+ "deleteRule"
+ ],
+ "properties": {
+ "@odata.type": {
+ "type": "string",
+ "enum": [
+ "#Microsoft.Azure.Cdn.Models.KeyVaultCertificateSourceParameters"
+ ]
+ },
+ "subscriptionId": {
+ "description": "Subscription Id of the user's Key Vault containing the SSL certificate",
+ "type": "string"
+ },
+ "resourceGroupName": {
+ "description": "Resource group of the user's Key Vault containing the SSL certificate",
+ "type": "string"
+ },
+ "vaultName": {
+ "description": "The name of the user's Key Vault containing the SSL certificate",
+ "type": "string"
+ },
+ "secretName": {
+ "description": "The name of Key Vault Secret (representing the full certificate PFX) in Key Vault.",
+ "type": "string"
+ },
+ "secretVersion": {
+ "description": "The version(GUID) of Key Vault Secret in Key Vault.",
+ "type": "string"
+ },
+ "updateRule": {
+ "description": "Describes the action that shall be taken when the certificate is updated in Key Vault.",
+ "type": "string",
+ "enum": [
+ "NoAction"
+ ],
+ "x-ms-enum": {
+ "name": "UpdateRule",
+ "modelAsString": true
+ }
+ },
+ "deleteRule": {
+ "description": "Describes the action that shall be taken when the certificate is removed from Key Vault.",
+ "type": "string",
+ "enum": [
+ "NoAction"
+ ],
+ "x-ms-enum": {
+ "name": "DeleteRule",
+ "modelAsString": true
+ }
+ }
+ }
+ },
+ "CustomDomainListResult": {
+ "description": "Result of the request to list custom domains. It contains a list of custom domain objects and a URL link to get the next set of results.",
+ "properties": {
+ "value": {
+ "type": "array",
+ "readOnly": true,
+ "items": {
+ "$ref": "#/definitions/CustomDomain"
+ },
+ "description": "List of CDN CustomDomains within an endpoint."
+ },
+ "nextLink": {
+ "type": "string",
+ "description": "URL to get the next set of custom domain objects if there are any."
+ }
+ }
+ },
+ "ValidateCustomDomainInput": {
+ "description": "Input of the custom domain to be validated for DNS mapping.",
+ "type": "object",
+ "required": [
+ "hostName"
+ ],
+ "properties": {
+ "hostName": {
+ "description": "The host name of the custom domain. Must be a domain name.",
+ "type": "string"
+ }
+ }
+ },
+ "ValidateCustomDomainOutput": {
+ "description": "Output of custom domain validation.",
+ "type": "object",
+ "properties": {
+ "customDomainValidated": {
+ "description": "Indicates whether the custom domain is valid or not.",
+ "readOnly": true,
+ "type": "boolean"
+ },
+ "reason": {
+ "description": "The reason why the custom domain is not valid.",
+ "readOnly": true,
+ "type": "string"
+ },
+ "message": {
+ "description": "Error message describing why the custom domain is not valid.",
+ "readOnly": true,
+ "type": "string"
+ }
+ }
+ },
+ "CheckNameAvailabilityInput": {
+ "description": "Input of CheckNameAvailability API.",
+ "type": "object",
+ "required": [
+ "name",
+ "type"
+ ],
+ "properties": {
+ "name": {
+ "description": "The resource name to validate.",
+ "type": "string"
+ },
+ "type": {
+ "description": "The type of the resource whose name is to be validated.",
+ "$ref": "#/definitions/ResourceType"
+ }
+ }
+ },
+ "CheckNameAvailabilityOutput": {
+ "description": "Output of check name availability API.",
+ "type": "object",
+ "properties": {
+ "nameAvailable": {
+ "description": "Indicates whether the name is available.",
+ "readOnly": true,
+ "type": "boolean"
+ },
+ "reason": {
+ "description": "The reason why the name is not available.",
+ "readOnly": true,
+ "type": "string"
+ },
+ "message": {
+ "description": "The detailed error message describing why the name is not available.",
+ "readOnly": true,
+ "type": "string"
+ }
+ }
+ },
+ "ValidateProbeInput": {
+ "description": "Input of the validate probe API.",
+ "properties": {
+ "probeURL": {
+ "description": "The probe URL to validate.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "probeURL"
+ ],
+ "type": "object"
+ },
+ "ValidateProbeOutput": {
+ "description": "Output of the validate probe API.",
+ "properties": {
+ "isValid": {
+ "description": "Indicates whether the probe URL is accepted or not.",
+ "readOnly": true,
+ "type": "boolean"
+ },
+ "errorCode": {
+ "description": "Specifies the error code when the probe url is not accepted.",
+ "readOnly": true,
+ "type": "string"
+ },
+ "message": {
+ "description": "The detailed error message describing why the probe URL is not accepted.",
+ "readOnly": true,
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ResourceUsageListResult": {
+ "description": "Output of check resource usage API.",
+ "properties": {
+ "value": {
+ "type": "array",
+ "readOnly": true,
+ "items": {
+ "$ref": "#/definitions/ResourceUsage"
+ },
+ "description": "List of resource usages."
+ },
+ "nextLink": {
+ "type": "string",
+ "description": "URL to get the next set of custom domain objects if there are any."
+ }
+ }
+ },
+ "ResourceUsage": {
+ "description": "Output of check resource usage API.",
+ "type": "object",
+ "properties": {
+ "resourceType": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Resource type for which the usage is provided."
+ },
+ "unit": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Unit of the usage. e.g. Count."
+ },
+ "currentValue": {
+ "type": "integer",
+ "readOnly": true,
+ "description": "Actual value of usage on the specified resource type."
+ },
+ "limit": {
+ "type": "integer",
+ "readOnly": true,
+ "description": "Quota of the specified resource type."
+ }
+ }
+ },
+ "ResourceType": {
+ "description": "Type of CDN resource used in CheckNameAvailability.",
+ "enum": [
+ "Microsoft.Cdn/Profiles/Endpoints"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "ResourceType",
+ "modelAsString": false
+ }
+ },
+ "Operation": {
+ "description": "CDN REST API operation",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "Operation name: {provider}/{resource}/{operation}",
+ "readOnly": true,
+ "type": "string"
+ },
+ "display": {
+ "description": "The object that represents the operation.",
+ "properties": {
+ "provider": {
+ "description": "Service provider: Microsoft.Cdn",
+ "readOnly": true,
+ "type": "string"
+ },
+ "resource": {
+ "description": "Resource on which the operation is performed: Profile, endpoint, etc.",
+ "readOnly": true,
+ "type": "string"
+ },
+ "operation": {
+ "description": "Operation type: Read, write, delete, etc.",
+ "readOnly": true,
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "OperationsListResult": {
+ "description": "Result of the request to list CDN operations. It contains a list of operations and a URL link to get the next set of results.",
+ "properties": {
+ "value": {
+ "type": "array",
+ "readOnly": true,
+ "items": {
+ "$ref": "#/definitions/Operation"
+ },
+ "description": "List of CDN operations supported by the CDN resource provider."
+ },
+ "nextLink": {
+ "type": "string",
+ "description": "URL to get the next set of operation list results if there are any."
+ }
+ }
+ },
+ "EdgenodeResult": {
+ "description": "Result of the request to list CDN edgenodes. It contains a list of ip address group and a URL link to get the next set of results.",
+ "properties": {
+ "value": {
+ "type": "array",
+ "readOnly": true,
+ "items": {
+ "$ref": "#/definitions/EdgeNode"
+ },
+ "description": "Edge node of CDN service."
+ },
+ "nextLink": {
+ "type": "string",
+ "description": "URL to get the next set of edgenode list results if there are any."
+ }
+ }
+ },
+ "EdgeNode": {
+ "description": "Edgenode is a global Point of Presence (POP) location used to deliver CDN content to end users.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ProxyResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "x-ms-client-flatten": true,
+ "$ref": "#/definitions/EdgeNodeProperties"
+ }
+ }
+ },
+ "EdgeNodeProperties": {
+ "description": "The JSON object that contains the properties required to create an edgenode.",
+ "required": [
+ "ipAddressGroups"
+ ],
+ "properties": {
+ "ipAddressGroups": {
+ "description": "List of ip address groups.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/IpAddressGroup"
+ }
+ }
+ }
+ },
+ "IpAddressGroup": {
+ "description": "CDN Ip address group",
+ "type": "object",
+ "properties": {
+ "deliveryRegion": {
+ "description": "The delivery region of the ip address group",
+ "type": "string"
+ },
+ "ipv4Addresses": {
+ "description": "The list of ip v4 addresses.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/cidrIpAddress"
+ }
+ },
+ "ipv6Addresses": {
+ "description": "The list of ip v6 addresses.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/cidrIpAddress"
+ }
+ }
+ }
+ },
+ "cidrIpAddress": {
+ "description": "CIDR Ip address",
+ "type": "object",
+ "properties": {
+ "baseIpAddress": {
+ "description": "Ip address itself.",
+ "type": "string"
+ },
+ "prefixLength": {
+ "description": "The length of the prefix of the ip address.",
+ "type": "integer"
+ }
+ }
+ },
+ "Resource": {
+ "description": "The core properties of ARM resources",
+ "properties": {
+ "id": {
+ "description": "Resource ID.",
+ "readOnly": true,
+ "type": "string"
+ },
+ "name": {
+ "description": "Resource name.",
+ "readOnly": true,
+ "type": "string"
+ },
+ "type": {
+ "description": "Resource type.",
+ "readOnly": true,
+ "type": "string"
+ }
+ },
+ "x-ms-azure-resource": true
+ },
+ "TrackedResource": {
+ "description": "The resource model definition for a ARM tracked top level resource.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/Resource"
+ }
+ ],
+ "properties": {
+ "location": {
+ "type": "string",
+ "description": "Resource location."
+ },
+ "tags": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ },
+ "x-ms-mutability": [
+ "read",
+ "create",
+ "update"
+ ],
+ "description": "Resource tags."
+ }
+ },
+ "required": [
+ "location"
+ ]
+ },
+ "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"
+ }
+ ]
+ },
+ "QueryStringCachingBehavior": {
+ "description": "Defines how CDN caches requests that include query strings. You can ignore any query strings when caching, bypass caching to prevent requests that contain query strings from being cached, or cache every request with a unique URL.",
+ "enum": [
+ "IgnoreQueryString",
+ "BypassCaching",
+ "UseQueryString",
+ "NotSet"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "QueryStringCachingBehavior",
+ "modelAsString": false
+ }
+ },
+ "Sku": {
+ "description": "The pricing tier (defines a CDN provider, feature list and rate) of the CDN profile.",
+ "properties": {
+ "name": {
+ "description": "Name of the pricing tier.",
+ "enum": [
+ "Standard_Verizon",
+ "Premium_Verizon",
+ "Custom_Verizon",
+ "Standard_Akamai",
+ "Standard_ChinaCdn",
+ "Standard_Microsoft",
+ "Premium_ChinaCdn"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "SkuName",
+ "modelAsString": true
+ }
+ }
+ },
+ "type": "object"
+ },
+ "OptimizationType": {
+ "description": "Specifies what scenario the customer wants this CDN endpoint to optimize, e.g. Download, Media services. With this information we can apply scenario driven optimization.",
+ "enum": [
+ "GeneralWebDelivery",
+ "GeneralMediaStreaming",
+ "VideoOnDemandMediaStreaming",
+ "LargeFileDownload",
+ "DynamicSiteAcceleration"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "OptimizationType",
+ "modelAsString": true
+ }
+ },
+ "ErrorResponse": {
+ "description": "Error response indicates CDN service is not able to process the incoming request. The reason is provided in the error message.",
+ "type": "object",
+ "properties": {
+ "code": {
+ "description": "Error code.",
+ "readOnly": true,
+ "type": "string"
+ },
+ "message": {
+ "description": "Error message indicating why the operation failed.",
+ "readOnly": true,
+ "type": "string"
+ }
+ }
+ }
+ },
+ "parameters": {
+ "subscriptionIdParameter": {
+ "name": "subscriptionId",
+ "in": "path",
+ "description": "Azure Subscription ID.",
+ "required": true,
+ "type": "string"
+ },
+ "apiVersionParameter": {
+ "name": "api-version",
+ "in": "query",
+ "required": true,
+ "type": "string",
+ "description": "Version of the API to be used with the client request. Current version is 2017-04-02."
+ },
+ "resourceGroupNameParameter": {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "pattern": "^[-\\w\\._\\(\\)]+$",
+ "minLength": 1,
+ "maxLength": 90,
+ "x-ms-parameter-location": "method",
+ "description": "Name of the Resource group within the Azure subscription."
+ }
+ }
+}
diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/cdnwebapplicationfirewall.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/cdnwebapplicationfirewall.json
new file mode 100644
index 000000000000..776e38b9d7eb
--- /dev/null
+++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/cdnwebapplicationfirewall.json
@@ -0,0 +1,926 @@
+{
+ "swagger": "2.0",
+ "info": {
+ "version": "2020-04-15",
+ "title": "Azure CDN WebApplicationFirewallManagement",
+ "description": "APIs to manage web application firewall rules for Azure CDN"
+ },
+ "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.Cdn/CdnWebApplicationFirewallPolicies": {
+ "get": {
+ "tags": [
+ "WebApplicationFirewallPolicies"
+ ],
+ "description": "Lists all of the protection policies within a resource group.",
+ "operationId": "Policies_List",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK. The request has succeeded.",
+ "schema": {
+ "$ref": "#/definitions/CdnWebApplicationFirewallPolicyList"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "./cdn.json#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-examples": {
+ "List Policies in a Resource Group": {
+ "$ref": "./examples/WafListPolicies.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/CdnWebApplicationFirewallPolicies/{policyName}": {
+ "get": {
+ "tags": [
+ "WebApplicationFirewallPolicies"
+ ],
+ "description": "Retrieve protection policy with specified name within a resource group.",
+ "operationId": "Policies_Get",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/PolicyNameParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK. The request has succeeded.",
+ "schema": {
+ "$ref": "#/definitions/CdnWebApplicationFirewallPolicy"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "./cdn.json#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Get Policy": {
+ "$ref": "./examples/WafPolicyGet.json"
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "WebApplicationFirewallPolicies"
+ ],
+ "description": "Create or update policy with specified rule set name within a resource group.",
+ "operationId": "Policies_CreateOrUpdate",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/PolicyNameParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "description": "Policy to be created.",
+ "in": "body",
+ "name": "cdnWebApplicationFirewallPolicy",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/CdnWebApplicationFirewallPolicy"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK. The request has succeeded.",
+ "schema": {
+ "$ref": "#/definitions/CdnWebApplicationFirewallPolicy"
+ }
+ },
+ "201": {
+ "description": "Created. The request has been fulfilled and a new protection policy has been created.",
+ "schema": {
+ "$ref": "#/definitions/CdnWebApplicationFirewallPolicy"
+ }
+ },
+ "202": {
+ "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously.",
+ "schema": {
+ "$ref": "#/definitions/CdnWebApplicationFirewallPolicy"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "./cdn.json#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Creates specific policy": {
+ "$ref": "./examples/WafPolicyCreateOrUpdate.json"
+ }
+ },
+ "x-ms-long-running-operation": true
+ },
+ "patch": {
+ "tags": [
+ "WebApplicationFirewallPolicies"
+ ],
+ "description": "Update an existing CdnWebApplicationFirewallPolicy with the specified policy name under the specified subscription and resource group",
+ "operationId": "Policies_Update",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/PolicyNameParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "description": "CdnWebApplicationFirewallPolicy parameters to be patched.",
+ "in": "body",
+ "name": "cdnWebApplicationFirewallPolicyPatchParameters",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/CdnWebApplicationFirewallPolicyPatchParameters"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK. The request has succeeded.",
+ "schema": {
+ "$ref": "#/definitions/CdnWebApplicationFirewallPolicy"
+ }
+ },
+ "202": {
+ "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously.",
+ "schema": {
+ "$ref": "#/definitions/CdnWebApplicationFirewallPolicy"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "./cdn.json#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Creates specific policy": {
+ "$ref": "./examples/WafPatchPolicy.json"
+ }
+ },
+ "x-ms-long-running-operation": true
+ },
+ "delete": {
+ "tags": [
+ "WebApplicationFirewallPolicies"
+ ],
+ "description": "Deletes Policy",
+ "operationId": "Policies_Delete",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/PolicyNameParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Delete successful."
+ },
+ "204": {
+ "description": "No Content. The request has been accepted but the policy was not found."
+ }
+ },
+ "x-ms-examples": {
+ "Delete protection policy": {
+ "$ref": "./examples/WafPolicyDelete.json"
+ }
+ },
+ "x-ms-long-running-operation": false
+ }
+ },
+ "/subscriptions/{subscriptionId}/providers/Microsoft.Cdn/CdnWebApplicationFirewallManagedRuleSets": {
+ "get": {
+ "tags": [
+ "WebApplicationFirewallManagedRuleSets"
+ ],
+ "description": "Lists all available managed rule sets.",
+ "operationId": "ManagedRuleSets_List",
+ "parameters": [
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success. The operation returns a list of all available web application firewall managed rule sets.",
+ "schema": {
+ "$ref": "#/definitions/ManagedRuleSetDefinitionList"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "./cdn.json#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-examples": {
+ "List Policies in a Resource Group": {
+ "$ref": "./examples/WafListManagedRuleSets.json"
+ }
+ }
+ }
+ }
+ },
+ "definitions": {
+ "CdnWebApplicationFirewallPolicyList": {
+ "description": "Defines a list of WebApplicationFirewallPolicies for Azure CDN. It contains a list of WebApplicationFirewallPolicy objects and a URL link to get the next set of results.",
+ "properties": {
+ "value": {
+ "type": "array",
+ "readOnly": true,
+ "items": {
+ "$ref": "#/definitions/CdnWebApplicationFirewallPolicy"
+ },
+ "description": "List of Azure CDN WebApplicationFirewallPolicies within a resource group."
+ },
+ "nextLink": {
+ "type": "string",
+ "description": "URL to get the next set of WebApplicationFirewallPolicy objects if there are any."
+ }
+ }
+ },
+ "CdnWebApplicationFirewallPolicy": {
+ "description": "Defines web application firewall policy for Azure CDN.",
+ "properties": {
+ "properties": {
+ "x-ms-client-flatten": true,
+ "description": "Properties of the web application firewall policy.",
+ "$ref": "#/definitions/CdnWebApplicationFirewallPolicyProperties"
+ },
+ "etag": {
+ "type": "string",
+ "description": "Gets a unique read-only string that changes whenever the resource is updated."
+ },
+ "sku": {
+ "description": "The pricing tier (defines a CDN provider, feature list and rate) of the CdnWebApplicationFirewallPolicy.",
+ "$ref": "./cdn.json#/definitions/Sku"
+ }
+ },
+ "required": [
+ "sku"
+ ],
+ "allOf": [
+ {
+ "$ref": "./cdn.json#/definitions/TrackedResource"
+ }
+ ]
+ },
+ "CdnWebApplicationFirewallPolicyPatchParameters": {
+ "type": "object",
+ "description": "Properties required to update a CdnWebApplicationFirewallPolicy.",
+ "properties": {
+ "tags": {
+ "description": "CdnWebApplicationFirewallPolicy tags",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ }
+ },
+ "x-ms-azure-resource": true
+ },
+ "CdnWebApplicationFirewallPolicyProperties": {
+ "description": "Defines CDN web application firewall policy properties.",
+ "properties": {
+ "policySettings": {
+ "description": "Describes policySettings for policy",
+ "$ref": "#/definitions/policySettings"
+ },
+ "rateLimitRules": {
+ "description": "Describes rate limit rules inside the policy.",
+ "$ref": "#/definitions/RateLimitRuleList"
+ },
+ "customRules": {
+ "description": "Describes custom rules inside the policy.",
+ "$ref": "#/definitions/CustomRuleList"
+ },
+ "managedRules": {
+ "description": "Describes managed rules inside the policy.",
+ "$ref": "#/definitions/ManagedRuleSetList"
+ },
+ "endpointLinks": {
+ "description": "Describes Azure CDN endpoints associated with this Web Application Firewall policy.",
+ "type": "array",
+ "readOnly": true,
+ "items": {
+ "$ref": "#/definitions/CdnEndpoint"
+ }
+ },
+ "provisioningState": {
+ "readOnly": true,
+ "type": "string",
+ "description": "Provisioning state of the WebApplicationFirewallPolicy.",
+ "enum": [
+ "Creating",
+ "Succeeded",
+ "Failed"
+ ],
+ "x-ms-enum": {
+ "name": "ProvisioningState",
+ "modelAsString": true
+ }
+ },
+ "resourceState": {
+ "title": "Resource status of the policy.",
+ "readOnly": true,
+ "enum": [
+ "Creating",
+ "Enabling",
+ "Enabled",
+ "Disabling",
+ "Disabled",
+ "Deleting"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "PolicyResourceState",
+ "modelAsString": true
+ }
+ }
+ }
+ },
+ "policySettings": {
+ "description": "Defines contents of a web application firewall global configuration",
+ "properties": {
+ "enabledState": {
+ "description": "describes if the policy is in enabled state or disabled state",
+ "type": "string",
+ "enum": [
+ "Disabled",
+ "Enabled"
+ ],
+ "x-ms-enum": {
+ "name": "PolicyEnabledState",
+ "modelAsString": true
+ }
+ },
+ "mode": {
+ "description": "Describes if it is in detection mode or prevention mode at policy level.",
+ "type": "string",
+ "enum": [
+ "Prevention",
+ "Detection"
+ ],
+ "x-ms-enum": {
+ "name": "PolicyMode",
+ "modelAsString": true
+ }
+ },
+ "defaultRedirectUrl": {
+ "description": "If action type is redirect, this field represents the default redirect URL for the client.",
+ "type": "string"
+ },
+ "defaultCustomBlockResponseStatusCode": {
+ "description": "If the action type is block, this field defines the default customer overridable http response status code.",
+ "type": "integer",
+ "enum": [
+ 200,
+ 403,
+ 405,
+ 406,
+ 429
+ ]
+ },
+ "defaultCustomBlockResponseBody": {
+ "description": "If the action type is block, customer can override the response body. The body must be specified in base64 encoding.",
+ "type": "string",
+ "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$"
+ }
+ }
+ },
+ "CdnEndpoint": {
+ "description": "Defines the ARM Resource ID for the linked endpoints",
+ "type": "object",
+ "readOnly": true,
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "ARM Resource ID string."
+ }
+ }
+ },
+ "CustomRuleList": {
+ "description": "Defines contents of custom rules",
+ "properties": {
+ "rules": {
+ "description": "List of rules",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/CustomRule"
+ }
+ }
+ }
+ },
+ "CustomRule": {
+ "description": "Defines the common attributes for a custom rule that can be included in a waf policy",
+ "type": "object",
+ "required": [
+ "name",
+ "priority",
+ "matchConditions",
+ "action"
+ ],
+ "properties": {
+ "name": {
+ "description": "Defines the name of the custom rule",
+ "type": "string"
+ },
+ "enabledState": {
+ "description": "Describes if the custom rule is in enabled or disabled state. Defaults to Enabled if not specified.",
+ "type": "string",
+ "enum": [
+ "Disabled",
+ "Enabled"
+ ],
+ "x-ms-enum": {
+ "name": "CustomRuleEnabledState",
+ "modelAsString": true
+ }
+ },
+ "priority": {
+ "description": "Defines in what order this rule be evaluated in the overall list of custom rules",
+ "type": "integer",
+ "maximum": 1000,
+ "exclusiveMaximum": false,
+ "minimum": 0,
+ "exclusiveMinimum": false
+ },
+ "matchConditions": {
+ "description": "List of match conditions.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/MatchCondition"
+ }
+ },
+ "action": {
+ "description": "Describes what action to be applied when rule matches",
+ "$ref": "#/definitions/ActionType"
+ }
+ }
+ },
+ "RateLimitRuleList": {
+ "description": "Defines contents of rate limit rules",
+ "properties": {
+ "rules": {
+ "description": "List of rules",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/RateLimitRule"
+ }
+ }
+ }
+ },
+ "RateLimitRule": {
+ "description": "Defines a rate limiting rule that can be included in a waf policy",
+ "type": "object",
+ "required": [
+ "rateLimitThreshold",
+ "rateLimitDurationInMinutes"
+ ],
+ "properties": {
+ "rateLimitThreshold": {
+ "description": "Defines rate limit threshold.",
+ "type": "integer",
+ "minimum": 0,
+ "exclusiveMinimum": false
+ },
+ "rateLimitDurationInMinutes": {
+ "description": "Defines rate limit duration. Default is 1 minute.",
+ "type": "integer",
+ "maximum": 60,
+ "exclusiveMaximum": false,
+ "minimum": 0,
+ "exclusiveMinimum": false
+ }
+ },
+ "allOf": [
+ {
+ "$ref": "#/definitions/CustomRule"
+ }
+ ]
+ },
+ "MatchCondition": {
+ "description": "Define match conditions",
+ "required": [
+ "matchVariable",
+ "operator",
+ "matchValue"
+ ],
+ "properties": {
+ "matchVariable": {
+ "description": "Match variable to compare against.",
+ "type": "string",
+ "enum": [
+ "RemoteAddr",
+ "SocketAddr",
+ "RequestMethod",
+ "RequestHeader",
+ "RequestUri",
+ "QueryString",
+ "RequestBody",
+ "Cookies",
+ "PostArgs"
+ ],
+ "x-ms-enum": {
+ "name": "MatchVariable",
+ "modelAsString": true
+ }
+ },
+ "selector": {
+ "description": "Selector can used to match a specific key for QueryString, Cookies, RequestHeader or PostArgs.",
+ "type": "string"
+ },
+ "operator": {
+ "description": "Describes operator to be matched",
+ "type": "string",
+ "enum": [
+ "Any",
+ "IPMatch",
+ "GeoMatch",
+ "Equal",
+ "Contains",
+ "LessThan",
+ "GreaterThan",
+ "LessThanOrEqual",
+ "GreaterThanOrEqual",
+ "BeginsWith",
+ "EndsWith",
+ "RegEx"
+ ],
+ "x-ms-enum": {
+ "name": "operator",
+ "modelAsString": true
+ }
+ },
+ "negateCondition": {
+ "description": "Describes if the result of this condition should be negated.",
+ "type": "boolean"
+ },
+ "matchValue": {
+ "description": "List of possible match values.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "transforms": {
+ "description": "List of transforms.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/TransformType"
+ }
+ }
+ }
+ },
+ "TransformType": {
+ "description": "Describes what transforms were applied before matching.",
+ "type": "string",
+ "enum": [
+ "Lowercase",
+ "Uppercase",
+ "Trim",
+ "UrlDecode",
+ "UrlEncode",
+ "RemoveNulls"
+ ],
+ "x-ms-enum": {
+ "name": "TransformType",
+ "modelAsString": true
+ }
+ },
+ "ManagedRuleSetList": {
+ "description": "Defines the list of managed rule sets for the policy.",
+ "properties": {
+ "managedRuleSets": {
+ "description": "List of rule sets.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ManagedRuleSet"
+ }
+ }
+ }
+ },
+ "ManagedRuleSet": {
+ "type": "object",
+ "description": "Defines a managed rule set.",
+ "required": [
+ "ruleSetType",
+ "ruleSetVersion"
+ ],
+ "properties": {
+ "ruleSetType": {
+ "description": "Defines the rule set type to use.",
+ "type": "string"
+ },
+ "ruleSetVersion": {
+ "description": "Defines the version of the rule set to use.",
+ "type": "string"
+ },
+ "anomalyScore": {
+ "description": "Verizon only : If the rule set supports anomaly detection mode, this describes the threshold for blocking requests.",
+ "type": "integer",
+ "maximum": 20,
+ "exclusiveMaximum": false,
+ "minimum": 0,
+ "exclusiveMinimum": false
+ },
+ "ruleGroupOverrides": {
+ "description": "Defines the rule overrides to apply to the rule set.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ManagedRuleGroupOverride"
+ }
+ }
+ }
+ },
+ "ManagedRuleGroupOverride": {
+ "description": "Defines a managed rule group override setting.",
+ "required": [
+ "ruleGroupName"
+ ],
+ "properties": {
+ "ruleGroupName": {
+ "description": "Describes the managed rule group within the rule set to override",
+ "type": "string"
+ },
+ "rules": {
+ "description": "List of rules that will be disabled. If none specified, all rules in the group will be disabled.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ManagedRuleOverride"
+ }
+ }
+ }
+ },
+ "ManagedRuleOverride": {
+ "description": "Defines a managed rule group override setting.",
+ "required": [
+ "ruleId"
+ ],
+ "properties": {
+ "ruleId": {
+ "description": "Identifier for the managed rule.",
+ "type": "string"
+ },
+ "enabledState": {
+ "description": "Describes if the managed rule is in enabled or disabled state. Defaults to Disabled if not specified.",
+ "type": "string",
+ "enum": [
+ "Disabled",
+ "Enabled"
+ ],
+ "x-ms-enum": {
+ "name": "ManagedRuleEnabledState",
+ "modelAsString": true
+ }
+ },
+ "action": {
+ "description": "Describes the override action to be applied when rule matches.",
+ "$ref": "#/definitions/ActionType"
+ }
+ }
+ },
+ "ManagedRuleSetDefinitionList": {
+ "description": "List of managed rule set definitions available for use in a policy.",
+ "properties": {
+ "value": {
+ "description": "List of managed rule set definitions.",
+ "readOnly": true,
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ManagedRuleSetDefinition"
+ }
+ },
+ "nextLink": {
+ "type": "string",
+ "description": "URL to retrieve next set of managed rule set definitions."
+ }
+ }
+ },
+ "ManagedRuleSetDefinition": {
+ "description": "Describes a managed rule set definition.",
+ "properties": {
+ "properties": {
+ "description": "Describes managed rule set definition properties.",
+ "x-ms-client-flatten": true,
+ "$ref": "#/definitions/ManagedRuleSetDefinitionProperties"
+ },
+ "sku": {
+ "description": "The pricing tier (defines a CDN provider, feature list and rate) of the CdnWebApplicationFirewallPolicy.",
+ "$ref": "./cdn.json#/definitions/Sku"
+ }
+ },
+ "allOf": [
+ {
+ "$ref": "./cdn.json#/definitions/Resource"
+ }
+ ]
+ },
+ "ManagedRuleSetDefinitionProperties": {
+ "description": "Properties for a managed rule set definition.",
+ "properties": {
+ "provisioningState": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Provisioning state of the managed rule set."
+ },
+ "ruleSetType": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Type of the managed rule set."
+ },
+ "ruleSetVersion": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Version of the managed rule set type."
+ },
+ "ruleGroups": {
+ "type": "array",
+ "readOnly": true,
+ "items": {
+ "$ref": "#/definitions/ManagedRuleGroupDefinition"
+ },
+ "description": "Rule groups of the managed rule set."
+ }
+ }
+ },
+ "ManagedRuleGroupDefinition": {
+ "description": "Describes a managed rule group.",
+ "properties": {
+ "ruleGroupName": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Name of the managed rule group."
+ },
+ "description": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Description of the managed rule group."
+ },
+ "rules": {
+ "type": "array",
+ "readOnly": true,
+ "items": {
+ "$ref": "#/definitions/ManagedRuleDefinition"
+ },
+ "description": "List of rules within the managed rule group."
+ }
+ }
+ },
+ "ManagedRuleDefinition": {
+ "description": "Describes a managed rule definition.",
+ "properties": {
+ "ruleId": {
+ "description": "Identifier for the managed rule.",
+ "readOnly": true,
+ "type": "string"
+ },
+ "description": {
+ "description": "Describes the functionality of the managed rule.",
+ "readOnly": true,
+ "type": "string"
+ }
+ }
+ },
+ "ActionType": {
+ "description": "Defines the action to take on rule match.",
+ "type": "string",
+ "enum": [
+ "Allow",
+ "Block",
+ "Log",
+ "Redirect"
+ ],
+ "x-ms-enum": {
+ "name": "ActionType",
+ "modelAsString": true
+ }
+ }
+ },
+ "parameters": {
+ "SubscriptionIdParameter": {
+ "name": "subscriptionId",
+ "in": "path",
+ "description": "Azure Subscription ID.",
+ "required": true,
+ "type": "string"
+ },
+ "ApiVersionParameter": {
+ "name": "api-version",
+ "in": "query",
+ "required": true,
+ "type": "string",
+ "description": "Version of the API to be used with the client request. Current version is 2017-04-02."
+ },
+ "PolicyNameParameter": {
+ "name": "policyName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "maxLength": 128,
+ "x-ms-parameter-location": "method",
+ "description": "The name of the CdnWebApplicationFirewallPolicy."
+ },
+ "ResourceGroupNameParameter": {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9_\\-\\(\\)\\.]*[^\\.]$",
+ "minLength": 1,
+ "maxLength": 80,
+ "x-ms-parameter-location": "method",
+ "description": "Name of the Resource group within the Azure subscription."
+ }
+ }
+}
diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/examples/CheckNameAvailability.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/examples/CheckNameAvailability.json
new file mode 100644
index 000000000000..a48e0e034f1f
--- /dev/null
+++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/examples/CheckNameAvailability.json
@@ -0,0 +1,18 @@
+{
+ "parameters": {
+ "api-version": "2020-04-15",
+ "checkNameAvailabilityInput": {
+ "name": "sampleName",
+ "type": "Microsoft.Cdn/Profiles/Endpoints"
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "nameAvailable": false,
+ "reason": "Name is already in use",
+ "message": "Name not available"
+ }
+ }
+ }
+}
diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/examples/CheckNameAvailabilityWithSubscription.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/examples/CheckNameAvailabilityWithSubscription.json
new file mode 100644
index 000000000000..666805d4482d
--- /dev/null
+++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/examples/CheckNameAvailabilityWithSubscription.json
@@ -0,0 +1,19 @@
+{
+ "parameters": {
+ "api-version": "2020-04-15",
+ "subscriptionId": "subid",
+ "checkNameAvailabilityInput": {
+ "name": "sampleName",
+ "type": "Microsoft.Cdn/Profiles/Endpoints"
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "nameAvailable": false,
+ "reason": "Name is already in use",
+ "message": "Name not available"
+ }
+ }
+ }
+}
diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/examples/CustomDomains_Create.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/examples/CustomDomains_Create.json
new file mode 100644
index 000000000000..e234364eee5c
--- /dev/null
+++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/examples/CustomDomains_Create.json
@@ -0,0 +1,62 @@
+{
+ "parameters": {
+ "api-version": "2020-04-15",
+ "subscriptionId": "subid",
+ "resourceGroupName": "RG",
+ "profileName": "profile1",
+ "endpointName": "endpoint1",
+ "customDomainName": "www-someDomain-net",
+ "customDomainProperties": {
+ "properties": {
+ "hostName": "www.someDomain.net"
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "name": "www-someDomain-net",
+ "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/customdomains/www-someDomain-net",
+ "type": "Microsoft.Cdn/profiles/endpoints/customdomains",
+ "properties": {
+ "provisioningState": "Succeeded",
+ "resourceState": "Active",
+ "hostName": "www.someDomain.net",
+ "customHttpsProvisioningState": "Enabling",
+ "customHttpsProvisioningSubstate": "PendingDomainControlValidationREquestApproval",
+ "validationData": null
+ }
+ }
+ },
+ "201": {
+ "body": {
+ "name": "www-someDomain-net",
+ "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/customdomains/www-someDomain-net",
+ "type": "Microsoft.Cdn/profiles/endpoints/customdomains",
+ "properties": {
+ "provisioningState": "Succeeded",
+ "resourceState": "Active",
+ "hostName": "www.someDomain.net",
+ "customHttpsProvisioningState": "Enabling",
+ "customHttpsProvisioningSubstate": "PendingDomainControlValidationREquestApproval",
+ "validationData": null
+ }
+ }
+ },
+ "202": {
+ "body": {
+ "name": "www-someDomain-net",
+ "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/customdomains/www-someDomain-net",
+ "type": "Microsoft.Cdn/profiles/endpoints/customdomains",
+ "properties": {
+ "provisioningState": "Succeeded",
+ "resourceState": "Active",
+ "hostName": "www.someDomain.net",
+ "customHttpsProvisioningState": "Enabling",
+ "customHttpsProvisioningSubstate": "PendingDomainControlValidationREquestApproval",
+ "validationData": null
+ }
+ }
+ }
+ }
+}
diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/examples/CustomDomains_Delete.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/examples/CustomDomains_Delete.json
new file mode 100644
index 000000000000..69f13bb1ddca
--- /dev/null
+++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/examples/CustomDomains_Delete.json
@@ -0,0 +1,29 @@
+{
+ "parameters": {
+ "api-version": "2020-04-15",
+ "subscriptionId": "subid",
+ "resourceGroupName": "RG",
+ "profileName": "profile1",
+ "endpointName": "endpoint1",
+ "customDomainName": "www-someDomain-net"
+ },
+ "responses": {
+ "200": {},
+ "202": {
+ "body": {
+ "name": "www-someDomain-net",
+ "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/customdomains/www-someDomain-net",
+ "type": "Microsoft.Cdn/profiles/endpoints/customdomains",
+ "properties": {
+ "provisioningState": "Succeeded",
+ "resourceState": "Active",
+ "hostName": "www.someDomain.net",
+ "customHttpsProvisioningState": "Enabling",
+ "customHttpsProvisioningSubstate": "PendingDomainControlValidationREquestApproval",
+ "validationData": null
+ }
+ }
+ },
+ "204": {}
+ }
+}
diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/examples/CustomDomains_DisableCustomHttps.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/examples/CustomDomains_DisableCustomHttps.json
new file mode 100644
index 000000000000..53dc7228bc25
--- /dev/null
+++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/examples/CustomDomains_DisableCustomHttps.json
@@ -0,0 +1,28 @@
+{
+ "parameters": {
+ "api-version": "2020-04-15",
+ "subscriptionId": "subid",
+ "resourceGroupName": "RG",
+ "profileName": "profile1",
+ "endpointName": "endpoint1",
+ "customDomainName": "www-someDomain-net"
+ },
+ "responses": {
+ "200": {},
+ "202": {
+ "body": {
+ "name": "www-someDomain-net",
+ "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/customdomains/www-someDomain-net",
+ "type": "Microsoft.Cdn/profiles/endpoints/customdomains",
+ "properties": {
+ "provisioningState": "Succeeded",
+ "resourceState": "Active",
+ "hostName": "www.someDomain.net",
+ "customHttpsProvisioningState": "Enabling",
+ "customHttpsProvisioningSubstate": "PendingDomainControlValidationREquestApproval",
+ "validationData": null
+ }
+ }
+ }
+ }
+}
diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/examples/CustomDomains_EnableCustomHttpsUsingBYOC.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/examples/CustomDomains_EnableCustomHttpsUsingBYOC.json
new file mode 100644
index 000000000000..f1fc807c6e01
--- /dev/null
+++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/examples/CustomDomains_EnableCustomHttpsUsingBYOC.json
@@ -0,0 +1,43 @@
+{
+ "parameters": {
+ "api-version": "2020-04-15",
+ "subscriptionId": "subid",
+ "resourceGroupName": "RG",
+ "profileName": "profile1",
+ "endpointName": "endpoint1",
+ "customDomainName": "www-someDomain-net",
+ "customHttpsParameters": {
+ "MinimumTLSVersion": "TLS12",
+ "certificateSource": "AzureKeyVault",
+ "protocolType": "ServerNameIndication",
+ "certificateSourceParameters": {
+ "OData.type": "#Microsoft.Azure.Cdn.Models.KeyVaultCertificateSourceParameters",
+ "subscriptionId": "subid",
+ "resourceGroupName": "RG",
+ "vaultName": "kv",
+ "secretName": "secret1",
+ "secretVersion": "00000000-0000-0000-0000-000000000000",
+ "updateRule": "NoAction",
+ "deleteRule": "NoAction"
+ }
+ }
+ },
+ "responses": {
+ "200": {},
+ "202": {
+ "body": {
+ "name": "www-someDomain-net",
+ "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/customdomains/www-someDomain-net",
+ "type": "Microsoft.Cdn/profiles/endpoints/customdomains",
+ "properties": {
+ "provisioningState": "Succeeded",
+ "resourceState": "Active",
+ "hostName": "www.someDomain.net",
+ "customHttpsProvisioningState": "Enabling",
+ "customHttpsProvisioningSubstate": "PendingDomainControlValidationREquestApproval",
+ "validationData": "validationdata"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/examples/CustomDomains_EnableCustomHttpsUsingCDNManagedCertificate.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/examples/CustomDomains_EnableCustomHttpsUsingCDNManagedCertificate.json
new file mode 100644
index 000000000000..fd81626a2431
--- /dev/null
+++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/examples/CustomDomains_EnableCustomHttpsUsingCDNManagedCertificate.json
@@ -0,0 +1,37 @@
+{
+ "parameters": {
+ "api-version": "2020-04-15",
+ "subscriptionId": "subid",
+ "resourceGroupName": "RG",
+ "profileName": "profile1",
+ "endpointName": "endpoint1",
+ "customDomainName": "www-someDomain-net",
+ "customHttpsParameters": {
+ "MinimumTLSVersion": "TLS12",
+ "certificateSource": "Cdn",
+ "protocolType": "ServerNameIndication",
+ "certificateSourceParameters": {
+ "OData.type": "#Microsoft.Azure.Cdn.Models.CdnCertificateSourceParameters",
+ "certificateType": "Shared"
+ }
+ }
+ },
+ "responses": {
+ "200": {},
+ "202": {
+ "body": {
+ "name": "www-someDomain-net",
+ "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/customdomains/www-someDomain-net",
+ "type": "Microsoft.Cdn/profiles/endpoints/customdomains",
+ "properties": {
+ "provisioningState": "Succeeded",
+ "resourceState": "Active",
+ "hostName": "www.someDomain.net",
+ "customHttpsProvisioningState": "Enabling",
+ "customHttpsProvisioningSubstate": "PendingDomainControlValidationREquestApproval",
+ "validationData": "validationdata"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/examples/CustomDomains_Get.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/examples/CustomDomains_Get.json
new file mode 100644
index 000000000000..6d1b1d65a899
--- /dev/null
+++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/examples/CustomDomains_Get.json
@@ -0,0 +1,27 @@
+{
+ "parameters": {
+ "api-version": "2020-04-15",
+ "subscriptionId": "subid",
+ "resourceGroupName": "RG",
+ "profileName": "profile1",
+ "endpointName": "endpoint1",
+ "customDomainName": "www-someDomain-net"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "name": "www-someDomain-net",
+ "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/customdomains/www-someDomain-net",
+ "type": "Microsoft.Cdn/profiles/endpoints/customdomains",
+ "properties": {
+ "provisioningState": "Succeeded",
+ "resourceState": "Active",
+ "hostName": "www.someDomain.net",
+ "customHttpsProvisioningState": "Disabled",
+ "customHttpsProvisioningSubstate": "None",
+ "validationData": null
+ }
+ }
+ }
+ }
+}
diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/examples/CustomDomains_ListByEndpoint.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/examples/CustomDomains_ListByEndpoint.json
new file mode 100644
index 000000000000..98d69cfe24dd
--- /dev/null
+++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/examples/CustomDomains_ListByEndpoint.json
@@ -0,0 +1,30 @@
+{
+ "parameters": {
+ "api-version": "2020-04-15",
+ "subscriptionId": "subid",
+ "resourceGroupName": "RG",
+ "profileName": "profile1",
+ "endpointName": "endpoint1"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "name": "www-someDomain-net",
+ "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/customdomains/www-someDomain-net",
+ "type": "Microsoft.Cdn/profiles/endpoints/customdomains",
+ "properties": {
+ "provisioningState": "Succeeded",
+ "resourceState": "Active",
+ "hostName": "www.someDomain.net",
+ "customHttpsProvisioningState": "Disabled",
+ "customHttpsProvisioningSubstate": "None",
+ "validationData": null
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/examples/EdgeNodes_List.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/examples/EdgeNodes_List.json
new file mode 100644
index 000000000000..85de12808f14
--- /dev/null
+++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/examples/EdgeNodes_List.json
@@ -0,0 +1,107 @@
+{
+ "parameters": {
+ "api-version": "2020-04-15"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "name": "Standard_Verizon",
+ "id": "/providers/Microsoft.Cdn/edgenodes/Standard_Verizon",
+ "type": "Microsoft.Cdn/edgenodes",
+ "properties": {
+ "ipAddressGroups": [
+ {
+ "deliveryRegion": "All",
+ "ipv4Addresses": [
+ {
+ "baseIpAddress": "192.229.176.0",
+ "prefixLength": 24
+ },
+ {
+ "baseIpAddress": "180.240.184.128",
+ "prefixLength": 25
+ },
+ {
+ "baseIpAddress": "152.195.27.0",
+ "prefixLength": 24
+ }
+ ],
+ "ipv6Addresses": [
+ {
+ "baseIpAddress": "2606:2800:60f2::",
+ "prefixLength": 48
+ },
+ {
+ "baseIpAddress": "2606:2800:700c::",
+ "prefixLength": 48
+ }
+ ]
+ }
+ ]
+ }
+ },
+ {
+ "name": "Premium_Verizon",
+ "id": "/providers/Microsoft.Cdn/edgenodes/Premium_Verizon",
+ "type": "Microsoft.Cdn/edgenodes",
+ "properties": {
+ "ipAddressGroups": [
+ {
+ "deliveryRegion": "All",
+ "ipv4Addresses": [
+ {
+ "baseIpAddress": "192.229.176.0",
+ "prefixLength": 24
+ },
+ {
+ "baseIpAddress": "152.195.27.0",
+ "prefixLength": 24
+ }
+ ],
+ "ipv6Addresses": [
+ {
+ "baseIpAddress": "2606:2800:60f2::",
+ "prefixLength": 48
+ },
+ {
+ "baseIpAddress": "2606:2800:700c::",
+ "prefixLength": 48
+ }
+ ]
+ }
+ ]
+ }
+ },
+ {
+ "name": "Custom_Verizon",
+ "id": "/providers/Microsoft.Cdn/edgenodes/Custom_Verizon",
+ "type": "Microsoft.Cdn/edgenodes",
+ "properties": {
+ "ipAddressGroups": [
+ {
+ "deliveryRegion": "All",
+ "ipv4Addresses": [
+ {
+ "baseIpAddress": "192.229.176.0",
+ "prefixLength": 24
+ },
+ {
+ "baseIpAddress": "2606:2800:420b::",
+ "prefixLength": 48
+ },
+ {
+ "baseIpAddress": "2606:2800:700c::",
+ "prefixLength": 48
+ }
+ ]
+ }
+ ]
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/examples/Endpoints_Create.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/examples/Endpoints_Create.json
new file mode 100644
index 000000000000..81fce9324123
--- /dev/null
+++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/examples/Endpoints_Create.json
@@ -0,0 +1,543 @@
+{
+ "parameters": {
+ "api-version": "2020-04-15",
+ "subscriptionId": "subid",
+ "resourceGroupName": "RG",
+ "profileName": "profile1",
+ "endpointName": "endpoint1",
+ "endpoint": {
+ "location": "WestUs",
+ "tags": {
+ "key1": "value1"
+ },
+ "properties": {
+ "originHostHeader": "www.bing.com",
+ "originPath": "/photos",
+ "contentTypesToCompress": [
+ "text/html",
+ "application/octet-stream"
+ ],
+ "isCompressionEnabled": true,
+ "isHttpAllowed": true,
+ "isHttpsAllowed": true,
+ "queryStringCachingBehavior": "BypassCaching",
+ "defaultOriginGroup": {
+ "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/originGroups/originGroup1"
+ },
+ "deliveryPolicy": {
+ "description": "Test description for a policy.",
+ "rules": [
+ {
+ "name": "rule1",
+ "order": 1,
+ "conditions": [
+ {
+ "name": "RemoteAddress",
+ "parameters": {
+ "operator": "IPMatch",
+ "negateCondition": true,
+ "matchValues": [
+ "192.168.1.0/24",
+ "10.0.0.0/24"
+ ],
+ "@odata.type": "#Microsoft.Azure.Cdn.Models.DeliveryRuleRemoteAddressConditionParameters"
+ }
+ }
+ ],
+ "actions": [
+ {
+ "name": "CacheExpiration",
+ "parameters": {
+ "cacheBehavior": "Override",
+ "cacheDuration": "10:10:09",
+ "@odata.type": "#Microsoft.Azure.Cdn.Models.DeliveryRuleCacheExpirationActionParameters",
+ "cacheType": "All"
+ }
+ },
+ {
+ "name": "ModifyResponseHeader",
+ "parameters": {
+ "headerAction": "Overwrite",
+ "headerName": "Access-Control-Allow-Origin",
+ "value": "*",
+ "@odata.type": "#Microsoft.Azure.Cdn.Models.DeliveryRuleHeaderActionParameters"
+ }
+ },
+ {
+ "name": "ModifyRequestHeader",
+ "parameters": {
+ "headerAction": "Overwrite",
+ "headerName": "Accept-Encoding",
+ "value": "gzip",
+ "@odata.type": "#Microsoft.Azure.Cdn.Models.DeliveryRuleHeaderActionParameters"
+ }
+ }
+ ]
+ }
+ ]
+ },
+ "origins": [
+ {
+ "name": "origin1",
+ "properties": {
+ "hostName": "www.someDomain1.net",
+ "httpPort": 80,
+ "httpsPort": 443,
+ "originHostHeader": "www.someDomain1.net",
+ "priority": 1,
+ "weight": 50,
+ "enabled": true
+ }
+ },
+ {
+ "name": "origin2",
+ "properties": {
+ "hostName": "www.someDomain2.net",
+ "httpPort": 80,
+ "httpsPort": 443,
+ "originHostHeader": "www.someDomain2.net",
+ "priority": 2,
+ "weight": 50,
+ "enabled": true
+ }
+ }
+ ],
+ "originGroups": [
+ {
+ "name": "originGroup1",
+ "properties": {
+ "healthProbeSettings": {
+ "probePath": "/health.aspx",
+ "probeRequestType": "GET",
+ "probeProtocol": "Http",
+ "probeIntervalInSeconds": 120
+ },
+ "origins": [
+ {
+ "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/origin1"
+ },
+ {
+ "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/origin2"
+ }
+ ],
+ "responseBasedOriginErrorDetectionSettings": {
+ "responseBasedDetectedErrorTypes": "TcpErrorsOnly",
+ "responseBasedFailoverThresholdPercentage": 10
+ }
+ }
+ }
+ ]
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "name": "endpoint4899",
+ "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1",
+ "type": "Microsoft.Cdn/profiles/endpoints",
+ "tags": {
+ "kay1": "value1"
+ },
+ "location": "WestUs",
+ "properties": {
+ "hostName": "endpoint4899.azureedge-test.net",
+ "originHostHeader": "www.bing.com",
+ "provisioningState": "Creating",
+ "resourceState": "Creating",
+ "isHttpAllowed": true,
+ "isHttpsAllowed": true,
+ "queryStringCachingBehavior": "BypassCaching",
+ "originPath": "/photos",
+ "defaultOriginGroup": {
+ "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/originGroups/originGroup1"
+ },
+ "origins": [
+ {
+ "name": "origin1",
+ "properties": {
+ "hostName": "www.someDomain1.net",
+ "httpPort": 80,
+ "httpsPort": 443,
+ "originHostHeader": "www.someDomain1.net",
+ "priority": 1,
+ "weight": 50,
+ "enabled": true
+ }
+ },
+ {
+ "name": "origin2",
+ "properties": {
+ "hostName": "www.someDomain2.net",
+ "httpPort": 80,
+ "httpsPort": 443,
+ "originHostHeader": "www.someDomain2.net",
+ "priority": 2,
+ "weight": 50,
+ "enabled": true
+ }
+ }
+ ],
+ "originGroups": [
+ {
+ "name": "originGroup1",
+ "properties": {
+ "healthProbeSettings": {
+ "probePath": "/health.aspx",
+ "probeRequestType": "GET",
+ "probeProtocol": "Http",
+ "probeIntervalInSeconds": 120
+ },
+ "origins": [
+ {
+ "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/origin1"
+ },
+ {
+ "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/origin2"
+ }
+ ],
+ "responseBasedOriginErrorDetectionSettings": {
+ "responseBasedDetectedErrorTypes": "TcpErrorsOnly",
+ "responseBasedFailoverThresholdPercentage": 10
+ }
+ }
+ }
+ ],
+ "contentTypesToCompress": [
+ "text/html",
+ "application/octet-stream"
+ ],
+ "isCompressionEnabled": true,
+ "optimizationType": null,
+ "probePath": null,
+ "geoFilters": [],
+ "deliveryPolicy": {
+ "description": "Test description for a policy.",
+ "rules": [
+ {
+ "name": "rule1",
+ "order": 1,
+ "conditions": [
+ {
+ "name": "RemoteAddress",
+ "parameters": {
+ "@odata.type": "#Microsoft.Azure.Cdn.Models.DeliveryRuleRemoteAddressConditionParameters",
+ "operator": "IPMatch",
+ "negateCondition": true,
+ "matchValues": [
+ "192.168.1.0/24",
+ "10.0.0.0/24"
+ ],
+ "transforms": []
+ }
+ }
+ ],
+ "actions": [
+ {
+ "name": "CacheExpiration",
+ "parameters": {
+ "@odata.type": "#Microsoft.Azure.Cdn.Models.DeliveryRuleCacheExpirationActionParameters",
+ "cacheBehavior": "Override",
+ "cacheDuration": "10:10:09",
+ "cacheType": "All"
+ }
+ },
+ {
+ "name": "ModifyResponseHeader",
+ "parameters": {
+ "@odata.type": "#Microsoft.Azure.Cdn.Models.DeliveryRuleHeaderActionParameters",
+ "headerAction": "Overwrite",
+ "headerName": "Access-Control-Allow-Origin",
+ "value": "*"
+ }
+ },
+ {
+ "name": "ModifyRequestHeader",
+ "parameters": {
+ "@odata.type": "#Microsoft.Azure.Cdn.Models.DeliveryRuleHeaderActionParameters",
+ "headerAction": "Overwrite",
+ "headerName": "Accept-Encoding",
+ "value": "gzip"
+ }
+ }
+ ]
+ }
+ ]
+ }
+ }
+ }
+ },
+ "201": {
+ "body": {
+ "name": "endpoint4899",
+ "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1",
+ "type": "Microsoft.Cdn/profiles/endpoints",
+ "tags": {
+ "kay1": "value1"
+ },
+ "location": "WestUs",
+ "properties": {
+ "hostName": "endpoint4899.azureedge-test.net",
+ "originHostHeader": "www.bing.com",
+ "provisioningState": "Creating",
+ "resourceState": "Creating",
+ "isHttpAllowed": true,
+ "isHttpsAllowed": true,
+ "queryStringCachingBehavior": "BypassCaching",
+ "originPath": "/photos",
+ "defaultOriginGroup": {
+ "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/originGroups/originGroup1"
+ },
+ "origins": [
+ {
+ "name": "origin1",
+ "properties": {
+ "hostName": "www.someDomain1.net",
+ "httpPort": 80,
+ "httpsPort": 443,
+ "originHostHeader": "www.someDomain1.net",
+ "priority": 1,
+ "weight": 50,
+ "enabled": true
+ }
+ },
+ {
+ "name": "origin2",
+ "properties": {
+ "hostName": "www.someDomain2.net",
+ "httpPort": 80,
+ "httpsPort": 443,
+ "originHostHeader": "www.someDomain2.net",
+ "priority": 2,
+ "weight": 50,
+ "enabled": true
+ }
+ }
+ ],
+ "originGroups": [
+ {
+ "name": "originGroup1",
+ "properties": {
+ "healthProbeSettings": {
+ "probePath": "/health.aspx",
+ "probeRequestType": "GET",
+ "probeProtocol": "Http",
+ "probeIntervalInSeconds": 120
+ },
+ "origins": [
+ {
+ "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/origin1"
+ },
+ {
+ "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/origin2"
+ }
+ ],
+ "responseBasedOriginErrorDetectionSettings": {
+ "responseBasedDetectedErrorTypes": "TcpErrorsOnly",
+ "responseBasedFailoverThresholdPercentage": 10
+ }
+ }
+ }
+ ],
+ "contentTypesToCompress": [
+ "text/html",
+ "application/octet-stream"
+ ],
+ "isCompressionEnabled": true,
+ "optimizationType": null,
+ "probePath": null,
+ "geoFilters": [],
+ "deliveryPolicy": {
+ "description": "Test description for a policy.",
+ "rules": [
+ {
+ "name": "rule1",
+ "order": 1,
+ "conditions": [
+ {
+ "name": "RemoteAddress",
+ "parameters": {
+ "@odata.type": "#Microsoft.Azure.Cdn.Models.DeliveryRuleRemoteAddressConditionParameters",
+ "operator": "IPMatch",
+ "negateCondition": true,
+ "matchValues": [
+ "192.168.1.0/24",
+ "10.0.0.0/24"
+ ],
+ "transforms": []
+ }
+ }
+ ],
+ "actions": [
+ {
+ "name": "CacheExpiration",
+ "parameters": {
+ "@odata.type": "#Microsoft.Azure.Cdn.Models.DeliveryRuleCacheExpirationActionParameters",
+ "cacheBehavior": "Override",
+ "cacheDuration": "10:10:09",
+ "cacheType": "All"
+ }
+ },
+ {
+ "name": "ModifyResponseHeader",
+ "parameters": {
+ "@odata.type": "#Microsoft.Azure.Cdn.Models.DeliveryRuleHeaderActionParameters",
+ "headerAction": "Overwrite",
+ "headerName": "Access-Control-Allow-Origin",
+ "value": "*"
+ }
+ },
+ {
+ "name": "ModifyRequestHeader",
+ "parameters": {
+ "@odata.type": "#Microsoft.Azure.Cdn.Models.DeliveryRuleHeaderActionParameters",
+ "headerAction": "Overwrite",
+ "headerName": "Accept-Encoding",
+ "value": "gzip"
+ }
+ }
+ ]
+ }
+ ]
+ }
+ }
+ }
+ },
+ "202": {
+ "body": {
+ "name": "endpoint4899",
+ "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1",
+ "type": "Microsoft.Cdn/profiles/endpoints",
+ "tags": {
+ "kay1": "value1"
+ },
+ "location": "WestUs",
+ "properties": {
+ "hostName": "endpoint4899.azureedge-test.net",
+ "originHostHeader": "www.bing.com",
+ "provisioningState": "Creating",
+ "resourceState": "Creating",
+ "isHttpAllowed": true,
+ "isHttpsAllowed": true,
+ "queryStringCachingBehavior": "BypassCaching",
+ "originPath": "/photos",
+ "defaultOriginGroup": {
+ "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/originGroups/originGroup1"
+ },
+ "origins": [
+ {
+ "name": "origin1",
+ "properties": {
+ "hostName": "www.someDomain1.net",
+ "httpPort": 80,
+ "httpsPort": 443,
+ "originHostHeader": "www.someDomain1.net",
+ "priority": 1,
+ "weight": 50,
+ "enabled": true
+ }
+ },
+ {
+ "name": "origin2",
+ "properties": {
+ "hostName": "www.someDomain2.net",
+ "httpPort": 80,
+ "httpsPort": 443,
+ "originHostHeader": "www.someDomain2.net",
+ "priority": 2,
+ "weight": 50,
+ "enabled": true
+ }
+ }
+ ],
+ "originGroups": [
+ {
+ "name": "originGroup1",
+ "properties": {
+ "healthProbeSettings": {
+ "probePath": "/health.aspx",
+ "probeRequestType": "GET",
+ "probeProtocol": "Http",
+ "probeIntervalInSeconds": 120
+ },
+ "origins": [
+ {
+ "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/origin1"
+ },
+ {
+ "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/origin2"
+ }
+ ],
+ "responseBasedOriginErrorDetectionSettings": {
+ "responseBasedDetectedErrorTypes": "TcpErrorsOnly",
+ "responseBasedFailoverThresholdPercentage": 10
+ }
+ }
+ }
+ ],
+ "contentTypesToCompress": [
+ "text/html",
+ "application/octet-stream"
+ ],
+ "isCompressionEnabled": true,
+ "optimizationType": null,
+ "probePath": null,
+ "geoFilters": [],
+ "deliveryPolicy": {
+ "description": "Test description for a policy.",
+ "rules": [
+ {
+ "name": "rule1",
+ "order": 1,
+ "conditions": [
+ {
+ "name": "RemoteAddress",
+ "parameters": {
+ "@odata.type": "#Microsoft.Azure.Cdn.Models.DeliveryRuleRemoteAddressConditionParameters",
+ "operator": "IPMatch",
+ "negateCondition": true,
+ "matchValues": [
+ "192.168.1.0/24",
+ "10.0.0.0/24"
+ ],
+ "transforms": []
+ }
+ }
+ ],
+ "actions": [
+ {
+ "name": "CacheExpiration",
+ "parameters": {
+ "@odata.type": "#Microsoft.Azure.Cdn.Models.DeliveryRuleCacheExpirationActionParameters",
+ "cacheBehavior": "Override",
+ "cacheDuration": "10:10:09",
+ "cacheType": "All"
+ }
+ },
+ {
+ "name": "ModifyResponseHeader",
+ "parameters": {
+ "@odata.type": "#Microsoft.Azure.Cdn.Models.DeliveryRuleHeaderActionParameters",
+ "headerAction": "Overwrite",
+ "headerName": "Access-Control-Allow-Origin",
+ "value": "*"
+ }
+ },
+ {
+ "name": "ModifyRequestHeader",
+ "parameters": {
+ "@odata.type": "#Microsoft.Azure.Cdn.Models.DeliveryRuleHeaderActionParameters",
+ "headerAction": "Overwrite",
+ "headerName": "Accept-Encoding",
+ "value": "gzip"
+ }
+ }
+ ]
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+}
diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/examples/Endpoints_Delete.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/examples/Endpoints_Delete.json
new file mode 100644
index 000000000000..4b0bc371a510
--- /dev/null
+++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/examples/Endpoints_Delete.json
@@ -0,0 +1,13 @@
+{
+ "parameters": {
+ "api-version": "2020-04-15",
+ "subscriptionId": "subid",
+ "resourceGroupName": "RG",
+ "profileName": "profile1",
+ "endpointName": "endpoint1"
+ },
+ "responses": {
+ "202": {},
+ "204": {}
+ }
+}
diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/examples/Endpoints_Get.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/examples/Endpoints_Get.json
new file mode 100644
index 000000000000..039687fc7b8d
--- /dev/null
+++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/examples/Endpoints_Get.json
@@ -0,0 +1,70 @@
+{
+ "parameters": {
+ "api-version": "2020-04-15",
+ "subscriptionId": "subid",
+ "resourceGroupName": "RG",
+ "profileName": "profile1",
+ "endpointName": "endpoint1"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "name": "endpoint1",
+ "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1",
+ "type": "Microsoft.Cdn/profiles/endpoints",
+ "tags": {},
+ "location": "CentralUs",
+ "properties": {
+ "hostName": "endpoint1.azureedge.net",
+ "originHostHeader": "www.bing.com",
+ "provisioningState": "Succeeded",
+ "resourceState": "Running",
+ "isHttpAllowed": true,
+ "isHttpsAllowed": true,
+ "queryStringCachingBehavior": "NotSet",
+ "originPath": null,
+ "origins": [
+ {
+ "name": "www-bing-com",
+ "properties": {
+ "hostName": "www.bing.com",
+ "httpPort": 80,
+ "httpsPort": 443,
+ "originHostHeader": "www.someDomain2.net",
+ "priority": 2,
+ "weight": 50,
+ "enabled": true
+ }
+ }
+ ],
+ "originGroups": [
+ {
+ "name": "originGroup1",
+ "properties": {
+ "healthProbeSettings": {
+ "probePath": "/health.aspx",
+ "probeRequestType": "GET",
+ "probeProtocol": "Http",
+ "probeIntervalInSeconds": 120
+ },
+ "origins": [
+ {
+ "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/www-bing-com"
+ }
+ ]
+ }
+ }
+ ],
+ "contentTypesToCompress": [],
+ "isCompressionEnabled": false,
+ "optimizationType": "DynamicSiteAcceleration",
+ "probePath": "/image",
+ "geoFilters": [],
+ "defaultOriginGroup": {
+ "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/originGroups/originGroup1"
+ }
+ }
+ }
+ }
+ }
+}
diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/examples/Endpoints_ListByProfile.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/examples/Endpoints_ListByProfile.json
new file mode 100644
index 000000000000..f5cb3c0f6fe2
--- /dev/null
+++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/examples/Endpoints_ListByProfile.json
@@ -0,0 +1,77 @@
+{
+ "parameters": {
+ "api-version": "2020-04-15",
+ "subscriptionId": "subid",
+ "resourceGroupName": "RG",
+ "profileName": "profile1"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "name": "endpoint1",
+ "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1",
+ "type": "Microsoft.Cdn/profiles/endpoints",
+ "tags": {},
+ "location": "CentralUs",
+ "properties": {
+ "hostName": "endpoint1.azureedge.net",
+ "originHostHeader": "www.bing.com",
+ "provisioningState": "Succeeded",
+ "resourceState": "Running",
+ "isHttpAllowed": true,
+ "isHttpsAllowed": true,
+ "queryStringCachingBehavior": "NotSet",
+ "originPath": null,
+ "origins": [
+ {
+ "name": "www-bing-com",
+ "properties": {
+ "hostName": "www.bing.com",
+ "httpPort": 80,
+ "httpsPort": 443,
+ "originHostHeader": "www.someDomain2.net",
+ "priority": 2,
+ "weight": 50,
+ "enabled": true
+ }
+ }
+ ],
+ "originGroups": [
+ {
+ "name": "originGroup1",
+ "properties": {
+ "healthProbeSettings": {
+ "probePath": "/health.aspx",
+ "probeRequestType": "GET",
+ "probeProtocol": "Http",
+ "probeIntervalInSeconds": 120
+ },
+ "origins": [
+ {
+ "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/www-bing-com"
+ }
+ ],
+ "responseBasedOriginErrorDetectionSettings": {
+ "responseBasedDetectedErrorTypes": "TcpErrorsOnly",
+ "responseBasedFailoverThresholdPercentage": 10
+ }
+ }
+ }
+ ],
+ "contentTypesToCompress": [],
+ "isCompressionEnabled": false,
+ "optimizationType": "DynamicSiteAcceleration",
+ "probePath": "/image",
+ "geoFilters": [],
+ "defaultOriginGroup": {
+ "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/originGroups/originGroup1"
+ }
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/examples/Endpoints_ListResourceUsage.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/examples/Endpoints_ListResourceUsage.json
new file mode 100644
index 000000000000..b3c53e02be22
--- /dev/null
+++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/examples/Endpoints_ListResourceUsage.json
@@ -0,0 +1,29 @@
+{
+ "parameters": {
+ "api-version": "2020-04-15",
+ "subscriptionId": "subid",
+ "resourceGroupName": "RG",
+ "profileName": "profile1",
+ "endpointName": "endpoint1"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "resourceType": "customdomain",
+ "unit": "count",
+ "currentValue": 1,
+ "limit": 20
+ },
+ {
+ "resourceType": "geofilter",
+ "unit": "count",
+ "currentValue": 0,
+ "limit": 25
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/examples/Endpoints_LoadContent.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/examples/Endpoints_LoadContent.json
new file mode 100644
index 000000000000..5daeb6e31202
--- /dev/null
+++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/examples/Endpoints_LoadContent.json
@@ -0,0 +1,18 @@
+{
+ "parameters": {
+ "api-version": "2020-04-15",
+ "subscriptionId": "subid",
+ "resourceGroupName": "RG",
+ "profileName": "profile1",
+ "endpointName": "endpoint1",
+ "contentFilePaths": {
+ "contentPaths": [
+ "/folder1"
+ ]
+ }
+ },
+ "responses": {
+ "200": {},
+ "202": {}
+ }
+}
diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/examples/Endpoints_PurgeContent.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/examples/Endpoints_PurgeContent.json
new file mode 100644
index 000000000000..5daeb6e31202
--- /dev/null
+++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/examples/Endpoints_PurgeContent.json
@@ -0,0 +1,18 @@
+{
+ "parameters": {
+ "api-version": "2020-04-15",
+ "subscriptionId": "subid",
+ "resourceGroupName": "RG",
+ "profileName": "profile1",
+ "endpointName": "endpoint1",
+ "contentFilePaths": {
+ "contentPaths": [
+ "/folder1"
+ ]
+ }
+ },
+ "responses": {
+ "200": {},
+ "202": {}
+ }
+}
diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/examples/Endpoints_Start.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/examples/Endpoints_Start.json
new file mode 100644
index 000000000000..94310c51922f
--- /dev/null
+++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/examples/Endpoints_Start.json
@@ -0,0 +1,83 @@
+{
+ "parameters": {
+ "api-version": "2020-04-15",
+ "subscriptionId": "subid",
+ "resourceGroupName": "RG",
+ "profileName": "profile1",
+ "endpointName": "endpoint1"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "name": "endpoint4899",
+ "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1",
+ "type": "Microsoft.Cdn/profiles/endpoints",
+ "tags": {
+ "kay1": "value1"
+ },
+ "location": "WestUs",
+ "properties": {
+ "hostName": "endpoint1.azureedge.net",
+ "originHostHeader": "www.bing.com",
+ "provisioningState": "Succeeded",
+ "resourceState": "Starting",
+ "isHttpAllowed": true,
+ "isHttpsAllowed": true,
+ "queryStringCachingBehavior": "NotSet",
+ "originPath": null,
+ "origins": [
+ {
+ "name": "www-bing-com",
+ "properties": {
+ "hostName": "www.bing.com",
+ "httpPort": 80,
+ "httpsPort": 443
+ }
+ }
+ ],
+ "contentTypesToCompress": [],
+ "isCompressionEnabled": false,
+ "optimizationType": "DynamicSiteAcceleration",
+ "probePath": "/image",
+ "geoFilters": []
+ }
+ }
+ },
+ "202": {
+ "body": {
+ "name": "endpoint4899",
+ "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1",
+ "type": "Microsoft.Cdn/profiles/endpoints",
+ "tags": {
+ "kay1": "value1"
+ },
+ "location": "WestUs",
+ "properties": {
+ "hostName": "endpoint1.azureedge.net",
+ "originHostHeader": "www.bing.com",
+ "provisioningState": "Succeeded",
+ "resourceState": "Starting",
+ "isHttpAllowed": true,
+ "isHttpsAllowed": true,
+ "queryStringCachingBehavior": "NotSet",
+ "originPath": null,
+ "origins": [
+ {
+ "name": "www-bing-com",
+ "properties": {
+ "hostName": "www.bing.com",
+ "httpPort": 80,
+ "httpsPort": 443
+ }
+ }
+ ],
+ "contentTypesToCompress": [],
+ "isCompressionEnabled": false,
+ "optimizationType": "DynamicSiteAcceleration",
+ "probePath": "/image",
+ "geoFilters": []
+ }
+ }
+ }
+ }
+}
diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/examples/Endpoints_Stop.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/examples/Endpoints_Stop.json
new file mode 100644
index 000000000000..0bf457363066
--- /dev/null
+++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/examples/Endpoints_Stop.json
@@ -0,0 +1,83 @@
+{
+ "parameters": {
+ "api-version": "2020-04-15",
+ "subscriptionId": "subid",
+ "resourceGroupName": "RG",
+ "profileName": "profile1",
+ "endpointName": "endpoint1"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "name": "endpoint4899",
+ "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1",
+ "type": "Microsoft.Cdn/profiles/endpoints",
+ "tags": {
+ "kay1": "value1"
+ },
+ "location": "WestUs",
+ "properties": {
+ "hostName": "endpoint1.azureedge.net",
+ "originHostHeader": "www.bing.com",
+ "provisioningState": "Succeeded",
+ "resourceState": "Stopping",
+ "isHttpAllowed": true,
+ "isHttpsAllowed": true,
+ "queryStringCachingBehavior": "NotSet",
+ "originPath": null,
+ "origins": [
+ {
+ "name": "www-bing-com",
+ "properties": {
+ "hostName": "www.bing.com",
+ "httpPort": 80,
+ "httpsPort": 443
+ }
+ }
+ ],
+ "contentTypesToCompress": [],
+ "isCompressionEnabled": false,
+ "optimizationType": "DynamicSiteAcceleration",
+ "probePath": "/image",
+ "geoFilters": []
+ }
+ }
+ },
+ "202": {
+ "body": {
+ "name": "endpoint4899",
+ "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1",
+ "type": "Microsoft.Cdn/profiles/endpoints",
+ "tags": {
+ "kay1": "value1"
+ },
+ "location": "WestUs",
+ "properties": {
+ "hostName": "endpoint1.azureedge.net",
+ "originHostHeader": "www.bing.com",
+ "provisioningState": "Succeeded",
+ "resourceState": "Stopping",
+ "isHttpAllowed": true,
+ "isHttpsAllowed": true,
+ "queryStringCachingBehavior": "NotSet",
+ "originPath": null,
+ "origins": [
+ {
+ "name": "www-bing-com",
+ "properties": {
+ "hostName": "www.bing.com",
+ "httpPort": 80,
+ "httpsPort": 443
+ }
+ }
+ ],
+ "contentTypesToCompress": [],
+ "isCompressionEnabled": false,
+ "optimizationType": "DynamicSiteAcceleration",
+ "probePath": "/image",
+ "geoFilters": []
+ }
+ }
+ }
+ }
+}
diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/examples/Endpoints_Update.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/examples/Endpoints_Update.json
new file mode 100644
index 000000000000..bad861f930d3
--- /dev/null
+++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/examples/Endpoints_Update.json
@@ -0,0 +1,138 @@
+{
+ "parameters": {
+ "api-version": "2020-04-15",
+ "subscriptionId": "subid",
+ "resourceGroupName": "RG",
+ "profileName": "profile1",
+ "endpointName": "endpoint1",
+ "endpointUpdateProperties": {
+ "tags": {
+ "additionalProperties": "Tag1"
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "name": "endpoint1",
+ "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1",
+ "type": "Microsoft.Cdn/profiles/endpoints",
+ "tags": {
+ "additionalProperties": "Tag1"
+ },
+ "location": "WestCentralUs",
+ "properties": {
+ "hostName": "endpoint1.azureedge.net",
+ "originHostHeader": null,
+ "provisioningState": "Creating",
+ "resourceState": "Creating",
+ "isHttpAllowed": true,
+ "isHttpsAllowed": true,
+ "queryStringCachingBehavior": "IgnoreQueryString",
+ "originPath": null,
+ "origins": [
+ {
+ "name": "www-bing-com",
+ "properties": {
+ "hostName": "www.bing.com",
+ "httpPort": 80,
+ "httpsPort": 443,
+ "originHostHeader": "www.someDomain2.net",
+ "priority": 2,
+ "weight": 50,
+ "enabled": true
+ }
+ }
+ ],
+ "originGroups": [
+ {
+ "name": "originGroup1",
+ "properties": {
+ "healthProbeSettings": {
+ "probePath": "/health.aspx",
+ "probeRequestType": "GET",
+ "probeProtocol": "Http",
+ "probeIntervalInSeconds": 120
+ },
+ "origins": [
+ {
+ "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/www-bing-com"
+ }
+ ]
+ }
+ }
+ ],
+ "defaultOriginGroup": {
+ "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/originGroups/originGroup1"
+ },
+ "contentTypesToCompress": [],
+ "isCompressionEnabled": false,
+ "optimizationType": null,
+ "probePath": null,
+ "geoFilters": []
+ }
+ }
+ },
+ "202": {
+ "body": {
+ "name": "endpoint1",
+ "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1",
+ "type": "Microsoft.Cdn/profiles/endpoints",
+ "tags": {
+ "additionalProperties": "Tag1"
+ },
+ "location": "WestCentralUs",
+ "properties": {
+ "hostName": "endpoint1.azureedge.net",
+ "originHostHeader": null,
+ "provisioningState": "Creating",
+ "resourceState": "Creating",
+ "isHttpAllowed": true,
+ "isHttpsAllowed": true,
+ "queryStringCachingBehavior": "IgnoreQueryString",
+ "originPath": null,
+ "origins": [
+ {
+ "name": "www-bing-com",
+ "properties": {
+ "hostName": "www.bing.com",
+ "httpPort": 80,
+ "httpsPort": 443,
+ "originHostHeader": "www.someDomain2.net",
+ "priority": 2,
+ "weight": 50,
+ "enabled": true
+ }
+ }
+ ],
+ "originGroups": [
+ {
+ "name": "originGroup1",
+ "properties": {
+ "healthProbeSettings": {
+ "probePath": "/health.aspx",
+ "probeRequestType": "GET",
+ "probeProtocol": "Http",
+ "probeIntervalInSeconds": 120
+ },
+ "origins": [
+ {
+ "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/www-bing-com"
+ }
+ ]
+ }
+ }
+ ],
+ "contentTypesToCompress": [],
+ "isCompressionEnabled": false,
+ "optimizationType": null,
+ "probePath": null,
+ "geoFilters": [],
+ "defaultOriginGroup": {
+ "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/originGroups/originGroup1"
+ }
+ }
+ }
+ }
+ }
+}
diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/examples/Endpoints_ValidateCustomDomain.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/examples/Endpoints_ValidateCustomDomain.json
new file mode 100644
index 000000000000..e57bad007e46
--- /dev/null
+++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/examples/Endpoints_ValidateCustomDomain.json
@@ -0,0 +1,21 @@
+{
+ "parameters": {
+ "api-version": "2020-04-15",
+ "subscriptionId": "subid",
+ "resourceGroupName": "RG",
+ "profileName": "profile1",
+ "endpointName": "endpoint1",
+ "customDomainProperties": {
+ "hostName": "www.someDomain.com"
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "customDomainValidated": true,
+ "message": null,
+ "reason": null
+ }
+ }
+ }
+}
diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/examples/Operations_List.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/examples/Operations_List.json
new file mode 100644
index 000000000000..e971f958b00e
--- /dev/null
+++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/examples/Operations_List.json
@@ -0,0 +1,93 @@
+{
+ "parameters": {
+ "api-version": "2020-04-15"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "name": "Microsoft.Cdn/register/action",
+ "display": {
+ "provider": "Microsoft.Cdn",
+ "resource": "Microsoft.Cdn Resource Provider",
+ "operation": "Registers the Microsoft.Cdn Resource Provider"
+ }
+ },
+ {
+ "name": "Microsoft.Cdn/edgenodes/read",
+ "display": {
+ "provider": "Microsoft.Cdn",
+ "resource": "EdgeNode",
+ "operation": "read"
+ }
+ },
+ {
+ "name": "Microsoft.Cdn/edgenodes/write",
+ "display": {
+ "provider": "Microsoft.Cdn",
+ "resource": "EdgeNode",
+ "operation": "write"
+ }
+ },
+ {
+ "name": "Microsoft.Cdn/edgenodes/delete",
+ "display": {
+ "provider": "Microsoft.Cdn",
+ "resource": "EdgeNode",
+ "operation": "delete"
+ }
+ },
+ {
+ "name": "Microsoft.Cdn/profiles/read",
+ "display": {
+ "provider": "Microsoft.Cdn",
+ "resource": "Profile",
+ "operation": "read"
+ }
+ },
+ {
+ "name": "Microsoft.Cdn/profiles/write",
+ "display": {
+ "provider": "Microsoft.Cdn",
+ "resource": "Profile",
+ "operation": "write"
+ }
+ },
+ {
+ "name": "Microsoft.Cdn/operationresults/profileresults/write",
+ "display": {
+ "provider": "Microsoft.Cdn",
+ "resource": "Profile",
+ "operation": "write"
+ }
+ },
+ {
+ "name": "Microsoft.Cdn/operationresults/profileresults/delete",
+ "display": {
+ "provider": "Microsoft.Cdn",
+ "resource": "Profile",
+ "operation": "delete"
+ }
+ },
+ {
+ "name": "Microsoft.Cdn/operationresults/profileresults/CheckResourceUsage/action",
+ "display": {
+ "provider": "Microsoft.Cdn",
+ "resource": "Profile",
+ "operation": "CheckResourceUsage"
+ }
+ },
+ {
+ "name": "Microsoft.Cdn/operationresults/profileresults/GenerateSsoUri/action",
+ "display": {
+ "provider": "Microsoft.Cdn",
+ "resource": "Profile",
+ "operation": "GenerateSsoUri"
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/examples/OriginGroups_Create.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/examples/OriginGroups_Create.json
new file mode 100644
index 000000000000..78c047669ba4
--- /dev/null
+++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/examples/OriginGroups_Create.json
@@ -0,0 +1,109 @@
+{
+ "parameters": {
+ "api-version": "2020-04-15",
+ "subscriptionId": "subid",
+ "resourceGroupName": "RG",
+ "profileName": "profile1",
+ "endpointName": "endpoint1",
+ "originGroupName": "origingroup1",
+ "originGroup": {
+ "properties": {
+ "healthProbeSettings": {
+ "probePath": "/health.aspx",
+ "probeRequestType": "GET",
+ "probeProtocol": "Http",
+ "probeIntervalInSeconds": 120
+ },
+ "origins": [
+ {
+ "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/origin1"
+ }
+ ],
+ "responseBasedOriginErrorDetectionSettings": {
+ "responseBasedDetectedErrorTypes": "TcpErrorsOnly",
+ "responseBasedFailoverThresholdPercentage": 10
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "name": "origingroup1",
+ "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/originGroups/originGroup1",
+ "type": "Microsoft.Cdn/profiles/endpoints/origingroups",
+ "properties": {
+ "provisioningState": "Succeeded",
+ "resourceState": "Active",
+ "healthProbeSettings": {
+ "probePath": "/health.aspx",
+ "probeRequestType": "GET",
+ "probeProtocol": "Http",
+ "probeIntervalInSeconds": 120
+ },
+ "origins": [
+ {
+ "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/origin1"
+ }
+ ],
+ "responseBasedOriginErrorDetectionSettings": {
+ "responseBasedDetectedErrorTypes": "TcpErrorsOnly",
+ "responseBasedFailoverThresholdPercentage": 10
+ }
+ }
+ }
+ },
+ "201": {
+ "body": {
+ "name": "origingroup1",
+ "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/originGroups/originGroup1",
+ "type": "Microsoft.Cdn/profiles/endpoints/origingroups",
+ "properties": {
+ "provisioningState": "Succeeded",
+ "resourceState": "Active",
+ "healthProbeSettings": {
+ "probePath": "/health.aspx",
+ "probeRequestType": "GET",
+ "probeProtocol": "Http",
+ "probeIntervalInSeconds": 120
+ },
+ "origins": [
+ {
+ "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/origin1"
+ }
+ ],
+ "responseBasedOriginErrorDetectionSettings": {
+ "responseBasedDetectedErrorTypes": "TcpErrorsOnly",
+ "responseBasedFailoverThresholdPercentage": 10
+ }
+ }
+ }
+ },
+ "202": {
+ "body": {
+ "name": "originGroup1",
+ "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/originGroups/originGroup1",
+ "type": "Microsoft.Cdn/profiles/endpoints/origingroups",
+ "properties": {
+ "provisioningState": "Succeeded",
+ "resourceState": "Active",
+ "healthProbeSettings": {
+ "probePath": "/health.aspx",
+ "probeRequestType": "GET",
+ "probeProtocol": "Http",
+ "probeIntervalInSeconds": 120
+ },
+ "origins": [
+ {
+ "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/origin1"
+ }
+ ],
+ "responseBasedOriginErrorDetectionSettings": {
+ "responseBasedDetectedErrorTypes": "TcpErrorsOnly",
+ "responseBasedFailoverThresholdPercentage": 10
+ }
+ }
+ }
+ }
+ }
+}
diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/examples/OriginGroups_Delete.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/examples/OriginGroups_Delete.json
new file mode 100644
index 000000000000..30b340bc1eb9
--- /dev/null
+++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/examples/OriginGroups_Delete.json
@@ -0,0 +1,14 @@
+{
+ "parameters": {
+ "api-version": "2020-04-15",
+ "subscriptionId": "subid",
+ "resourceGroupName": "RG",
+ "profileName": "profile1",
+ "endpointName": "endpoint1",
+ "originGroupName": "originGroup1"
+ },
+ "responses": {
+ "202": {},
+ "204": {}
+ }
+}
diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/examples/OriginGroups_Get.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/examples/OriginGroups_Get.json
new file mode 100644
index 000000000000..c6f28a99a3b9
--- /dev/null
+++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/examples/OriginGroups_Get.json
@@ -0,0 +1,44 @@
+{
+ "parameters": {
+ "api-version": "2020-04-15",
+ "subscriptionId": "subid",
+ "resourceGroupName": "RG",
+ "profileName": "profile1",
+ "endpointName": "endpoint1",
+ "originGroupName": "originGroup1"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "name": "origingroup1",
+ "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/originGroups/originGroup1",
+ "type": "Microsoft.Cdn/profiles/endpoints/origingroups",
+ "properties": {
+ "provisioningState": "Succeeded",
+ "resourceState": "Active",
+ "healthProbeSettings": {
+ "probePath": "/health.aspx",
+ "probeRequestType": "GET",
+ "probeProtocol": "Http",
+ "probeIntervalInSeconds": 120
+ },
+ "origins": [
+ {
+ "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/origin1"
+ }
+ ],
+ "responseBasedOriginErrorDetectionSettings": {
+ "responseBasedDetectedErrorTypes": "TcpAndHttpErrors",
+ "responseBasedFailoverThresholdPercentage": 10,
+ "httpErrorRanges": [
+ {
+ "begin": 500,
+ "end": 505
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+}
diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/examples/OriginGroups_ListByEndpoint.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/examples/OriginGroups_ListByEndpoint.json
new file mode 100644
index 000000000000..491319268648
--- /dev/null
+++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/examples/OriginGroups_ListByEndpoint.json
@@ -0,0 +1,41 @@
+{
+ "parameters": {
+ "api-version": "2020-04-15",
+ "subscriptionId": "subid",
+ "resourceGroupName": "RG",
+ "profileName": "profile1",
+ "endpointName": "endpoint1"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "name": "origingroup1",
+ "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/originGroups/originGroup1",
+ "type": "Microsoft.Cdn/profiles/endpoints/origingroups",
+ "properties": {
+ "provisioningState": "Succeeded",
+ "resourceState": "Active",
+ "healthProbeSettings": {
+ "probePath": "/health.aspx",
+ "probeRequestType": "GET",
+ "probeProtocol": "Http",
+ "probeIntervalInSeconds": 120
+ },
+ "origins": [
+ {
+ "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/origin1"
+ }
+ ],
+ "responseBasedOriginErrorDetectionSettings": {
+ "responseBasedDetectedErrorTypes": "TcpErrorsOnly",
+ "responseBasedFailoverThresholdPercentage": 10
+ }
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/examples/OriginGroups_Update.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/examples/OriginGroups_Update.json
new file mode 100644
index 000000000000..8c7b87fe8999
--- /dev/null
+++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/examples/OriginGroups_Update.json
@@ -0,0 +1,71 @@
+{
+ "parameters": {
+ "api-version": "2020-04-15",
+ "subscriptionId": "subid",
+ "resourceGroupName": "RG",
+ "profileName": "profile1",
+ "endpointName": "endpoint1",
+ "originGroupName": "originGroup1",
+ "originGroupUpdateProperties": {
+ "properties": {
+ "healthProbeSettings": {
+ "probePath": "/health.aspx",
+ "probeRequestType": "GET",
+ "probeProtocol": "Http",
+ "probeIntervalInSeconds": 120
+ },
+ "origins": [
+ {
+ "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/origin2"
+ }
+ ]
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "name": "www-someDomain-net",
+ "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/www-someDomain-net",
+ "type": "Microsoft.Cdn/profiles/endpoints/origins",
+ "properties": {
+ "provisioningState": "Succeeded",
+ "resourceState": "Active",
+ "healthProbeSettings": {
+ "probePath": "/health.aspx",
+ "probeRequestType": "GET",
+ "probeProtocol": "Http",
+ "probeIntervalInSeconds": 120
+ },
+ "origins": [
+ {
+ "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/origin2"
+ }
+ ]
+ }
+ }
+ },
+ "202": {
+ "body": {
+ "name": "www-someDomain-net",
+ "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/www-someDomain-net",
+ "type": "Microsoft.Cdn/profiles/endpoints/origins",
+ "properties": {
+ "provisioningState": "Succeeded",
+ "resourceState": "Active",
+ "healthProbeSettings": {
+ "probePath": "/health.aspx",
+ "probeRequestType": "GET",
+ "probeProtocol": "Http",
+ "probeIntervalInSeconds": 120
+ },
+ "origins": [
+ {
+ "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/origin2"
+ }
+ ]
+ }
+ }
+ }
+ }
+}
diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/examples/Origins_Create.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/examples/Origins_Create.json
new file mode 100644
index 000000000000..31ad52dc4aaa
--- /dev/null
+++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/examples/Origins_Create.json
@@ -0,0 +1,108 @@
+{
+ "parameters": {
+ "api-version": "2020-04-15",
+ "subscriptionId": "subid",
+ "resourceGroupName": "RG",
+ "profileName": "profile1",
+ "endpointName": "endpoint1",
+ "originName": "www-someDomain-net",
+ "origin": {
+ "location": "WestUs",
+ "tags": {
+ "key1": "value1"
+ },
+ "properties": {
+ "hostName": "www.someDomain.net",
+ "httpPort": 80,
+ "httpsPort": 443,
+ "originHostHeader": "www.someDomain.net",
+ "priority": 1,
+ "weight": 50,
+ "enabled": true,
+ "privateLinkResourceId": "/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.Network/privateLinkServices/pls1",
+ "privateLinkLocation": "eastus",
+ "privateLinkApprovalMessage": "Please approve the connection request for this Private Link"
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "name": "www-someDomain-net",
+ "location": "WestUs",
+ "tags": {
+ "key1": "value1"
+ },
+ "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/www-someDomain-net",
+ "type": "Microsoft.Cdn/profiles/endpoints/origins",
+ "properties": {
+ "provisioningState": "Succeeded",
+ "resourceState": "Active",
+ "hostName": "www.someDomain.net",
+ "httpPort": 80,
+ "httpsPort": 443,
+ "originHostHeader": "www.someDomain.net",
+ "priority": 1,
+ "weight": 50,
+ "enabled": true,
+ "privateEndpointStatus": "Pending",
+ "privateLinkResourceId": "/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.Network/privateLinkServices/pls1",
+ "privateLinkLocation": "eastus",
+ "privateLinkApprovalMessage": "Please approve the connection request for this Private Link"
+ }
+ }
+ },
+ "201": {
+ "body": {
+ "name": "www-someDomain-net",
+ "location": "WestUs",
+ "tags": {
+ "key1": "value1"
+ },
+ "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/www-someDomain-net",
+ "type": "Microsoft.Cdn/profiles/endpoints/origins",
+ "properties": {
+ "provisioningState": "Succeeded",
+ "resourceState": "Active",
+ "hostName": "www.someDomain.net",
+ "httpPort": 80,
+ "httpsPort": 443,
+ "originHostHeader": "www.someDomain.net",
+ "priority": 1,
+ "weight": 50,
+ "enabled": true,
+ "privateEndpointStatus": "Pending",
+ "privateLinkApprovalMessage": "",
+ "privateLinkResourceId": "/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.Network/privateLinkServices/pls1",
+ "privateLinkLocation": "eastus"
+ }
+ }
+ },
+ "202": {
+ "body": {
+ "name": "www-someDomain-net",
+ "location": "WestUs",
+ "tags": {
+ "key1": "value1"
+ },
+ "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/www-someDomain-net",
+ "type": "Microsoft.Cdn/profiles/endpoints/origins",
+ "properties": {
+ "provisioningState": "Succeeded",
+ "resourceState": "Active",
+ "hostName": "www.someDomain.net",
+ "httpPort": 80,
+ "httpsPort": 443,
+ "originHostHeader": "www.someDomain.net",
+ "priority": 1,
+ "weight": 50,
+ "enabled": true,
+ "privateEndpointStatus": "Pending",
+ "privateLinkApprovalMessage": "",
+ "privateLinkResourceId": "/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.Network/privateLinkServices/pls1",
+ "privateLinkLocation": "eastus"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/examples/Origins_Delete.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/examples/Origins_Delete.json
new file mode 100644
index 000000000000..4a270df6853f
--- /dev/null
+++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/examples/Origins_Delete.json
@@ -0,0 +1,14 @@
+{
+ "parameters": {
+ "api-version": "2020-04-15",
+ "subscriptionId": "subid",
+ "resourceGroupName": "RG",
+ "profileName": "profile1",
+ "endpointName": "endpoint1",
+ "originName": "origin1"
+ },
+ "responses": {
+ "202": {},
+ "204": {}
+ }
+}
diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/examples/Origins_Get.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/examples/Origins_Get.json
new file mode 100644
index 000000000000..89a514a4d173
--- /dev/null
+++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/examples/Origins_Get.json
@@ -0,0 +1,37 @@
+{
+ "parameters": {
+ "api-version": "2020-04-15",
+ "subscriptionId": "subid",
+ "resourceGroupName": "RG",
+ "profileName": "profile1",
+ "endpointName": "endpoint1",
+ "originName": "www-someDomain-net"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "name": "www-someDomain-net",
+ "location": "WestUs",
+ "tags": {
+ "key1": "value1"
+ },
+ "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/www-someDomain-net",
+ "type": "Microsoft.Cdn/profiles/endpoints/origins",
+ "properties": {
+ "provisioningState": "Succeeded",
+ "resourceState": "Active",
+ "hostName": "www.someDomain.net",
+ "httpPort": null,
+ "httpsPort": null,
+ "originHostHeader": "www.someDomain.net",
+ "priority": 1,
+ "weight": 50,
+ "enabled": true,
+ "privateEndpointStatus": "Pending",
+ "privateLinkApprovalMessage": "Please approve the connection request for this Private Link",
+ "privateLinkAlias": "APPSERVER.d84e61f0-0870-4d24-9746-7438fa0019d1.westus2.azure.privatelinkservice"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/examples/Origins_ListByEndpoint.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/examples/Origins_ListByEndpoint.json
new file mode 100644
index 000000000000..13aae31ac89f
--- /dev/null
+++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/examples/Origins_ListByEndpoint.json
@@ -0,0 +1,40 @@
+{
+ "parameters": {
+ "api-version": "2020-04-15",
+ "subscriptionId": "subid",
+ "resourceGroupName": "RG",
+ "profileName": "profile1",
+ "endpointName": "endpoint1"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "name": "www-someDomain-net",
+ "location": "WestUs",
+ "tags": {
+ "key1": "value1"
+ },
+ "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/www-someDomain-net",
+ "type": "Microsoft.Cdn/profiles/endpoints/origins",
+ "properties": {
+ "provisioningState": "Succeeded",
+ "resourceState": "Active",
+ "hostName": "www.someDomain.net",
+ "httpPort": null,
+ "httpsPort": null,
+ "originHostHeader": "www.someDomain.net",
+ "priority": 1,
+ "weight": 50,
+ "enabled": true,
+ "privateEndpointStatus": "Pending",
+ "privateLinkApprovalMessage": "Please approve the connection request for this Private Link",
+ "privateLinkAlias": "APPSERVER.d84e61f0-0870-4d24-9746-7438fa0019d1.westus2.azure.privatelinkservice"
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/examples/Origins_Update.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/examples/Origins_Update.json
new file mode 100644
index 000000000000..f6e79f729785
--- /dev/null
+++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/examples/Origins_Update.json
@@ -0,0 +1,76 @@
+{
+ "parameters": {
+ "api-version": "2020-04-15",
+ "subscriptionId": "subid",
+ "resourceGroupName": "RG",
+ "profileName": "profile1",
+ "endpointName": "endpoint1",
+ "originName": "www-someDomain-net",
+ "originUpdateProperties": {
+ "tags": {
+ "key1": "value1"
+ },
+ "properties": {
+ "httpPort": 42,
+ "httpsPort": 43,
+ "originHostHeader": "www.someDomain2.net",
+ "priority": 1,
+ "weight": 50,
+ "enabled": true,
+ "privateLinkAlias": "APPSERVER.d84e61f0-0870-4d24-9746-7438fa0019d1.westus2.azure.privatelinkservice"
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "name": "www-someDomain-net",
+ "location": "WestUs",
+ "tags": {
+ "key1": "value1"
+ },
+ "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/www-someDomain-net",
+ "type": "Microsoft.Cdn/profiles/endpoints/origins",
+ "properties": {
+ "provisioningState": "Succeeded",
+ "resourceState": "Active",
+ "hostName": "www.someDomain.net",
+ "httpPort": 42,
+ "httpsPort": 43,
+ "originHostHeader": "www.someDomain2.net",
+ "priority": 1,
+ "weight": 50,
+ "enabled": true,
+ "privateEndpointStatus": "Pending",
+ "privateLinkApprovalMessage": "Please approve the connection request for this Private Link",
+ "privateLinkAlias": "APPSERVER.d84e61f0-0870-4d24-9746-7438fa0019d1.westus2.azure.privatelinkservice"
+ }
+ }
+ },
+ "202": {
+ "body": {
+ "name": "www-someDomain-net",
+ "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/www-someDomain-net",
+ "location": "WestUs",
+ "tags": {
+ "key1": "value1"
+ },
+ "type": "Microsoft.Cdn/profiles/endpoints/origins",
+ "properties": {
+ "provisioningState": "Succeeded",
+ "resourceState": "Active",
+ "hostName": "www.someDomain.net",
+ "httpPort": 42,
+ "httpsPort": 43,
+ "originHostHeader": "www.someDomain2.net",
+ "priority": 1,
+ "weight": 50,
+ "enabled": true,
+ "privateEndpointStatus": "Pending",
+ "privateLinkApprovalMessage": "Please approve the connection request for this Private Link",
+ "privateLinkAlias": "APPSERVER.d84e61f0-0870-4d24-9746-7438fa0019d1.westus2.azure.privatelinkservice"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/examples/Profiles_Create.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/examples/Profiles_Create.json
new file mode 100644
index 000000000000..8ed2a4b03dd2
--- /dev/null
+++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/examples/Profiles_Create.json
@@ -0,0 +1,64 @@
+{
+ "parameters": {
+ "api-version": "2020-04-15",
+ "subscriptionId": "subid",
+ "resourceGroupName": "RG",
+ "profileName": "profile1",
+ "profile": {
+ "location": "WestCentralUs",
+ "sku": {
+ "name": "Standard_Verizon"
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "name": "profile1",
+ "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1",
+ "type": "Microsoft.Cdn/profiles",
+ "tags": {},
+ "location": "WestCentralUs",
+ "sku": {
+ "name": "Standard_Verizon"
+ },
+ "properties": {
+ "provisioningState": "Creating",
+ "resourceState": "Creating"
+ }
+ }
+ },
+ "201": {
+ "body": {
+ "name": "profile1",
+ "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1",
+ "type": "Microsoft.Cdn/profiles",
+ "tags": {},
+ "location": "WestCentralUs",
+ "sku": {
+ "name": "Standard_Verizon"
+ },
+ "properties": {
+ "provisioningState": "Creating",
+ "resourceState": "Creating"
+ }
+ }
+ },
+ "202": {
+ "body": {
+ "name": "profile1",
+ "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1",
+ "type": "Microsoft.Cdn/profiles",
+ "tags": {},
+ "location": "WestCentralUs",
+ "sku": {
+ "name": "Standard_Verizon"
+ },
+ "properties": {
+ "provisioningState": "Creating",
+ "resourceState": "Creating"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/examples/Profiles_Delete.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/examples/Profiles_Delete.json
new file mode 100644
index 000000000000..22bbf70debdd
--- /dev/null
+++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/examples/Profiles_Delete.json
@@ -0,0 +1,12 @@
+{
+ "parameters": {
+ "api-version": "2020-04-15",
+ "subscriptionId": "subid",
+ "resourceGroupName": "RG",
+ "profileName": "profile1"
+ },
+ "responses": {
+ "202": {},
+ "204": {}
+ }
+}
diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/examples/Profiles_GenerateSsoUri.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/examples/Profiles_GenerateSsoUri.json
new file mode 100644
index 000000000000..aefe1ea2bf3e
--- /dev/null
+++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/examples/Profiles_GenerateSsoUri.json
@@ -0,0 +1,15 @@
+{
+ "parameters": {
+ "api-version": "2020-04-15",
+ "subscriptionId": "subid",
+ "resourceGroupName": "RG",
+ "profileName": "profile1"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "ssoUriValue": "https://someuri.com"
+ }
+ }
+ }
+}
diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/examples/Profiles_Get.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/examples/Profiles_Get.json
new file mode 100644
index 000000000000..d9ea670565db
--- /dev/null
+++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/examples/Profiles_Get.json
@@ -0,0 +1,26 @@
+{
+ "parameters": {
+ "api-version": "2020-04-15",
+ "subscriptionId": "subid",
+ "resourceGroupName": "RG",
+ "profileName": "profile1"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "name": "profile1",
+ "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1",
+ "type": "Microsoft.Cdn/profiles",
+ "tags": {},
+ "location": "WestCentralUs",
+ "sku": {
+ "name": "Standard_Akamai"
+ },
+ "properties": {
+ "provisioningState": "Succeeded",
+ "resourceState": "Active"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/examples/Profiles_List.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/examples/Profiles_List.json
new file mode 100644
index 000000000000..b50921e0621b
--- /dev/null
+++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/examples/Profiles_List.json
@@ -0,0 +1,42 @@
+{
+ "parameters": {
+ "api-version": "2020-04-15",
+ "subscriptionId": "subid"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "name": "profile1",
+ "id": "/subscriptions/subid/resourcegroups/RG1/providers/Microsoft.Cdn/profiles/profile1",
+ "type": "Microsoft.Cdn/profiles",
+ "tags": {},
+ "location": "WestCentralUs",
+ "sku": {
+ "name": "Standard_Akamai"
+ },
+ "properties": {
+ "provisioningState": "Succeeded",
+ "resourceState": "Active"
+ }
+ },
+ {
+ "name": "profile2",
+ "id": "/subscriptions/subid/resourcegroups/RG1/providers/Microsoft.Cdn/profiles/profile2",
+ "type": "Microsoft.Cdn/profiles",
+ "tags": {},
+ "location": "WestCentralUs",
+ "sku": {
+ "name": "Standard_Akamai"
+ },
+ "properties": {
+ "provisioningState": "Succeeded",
+ "resourceState": "Active"
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/examples/Profiles_ListByResourceGroup.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/examples/Profiles_ListByResourceGroup.json
new file mode 100644
index 000000000000..63a2179d74c0
--- /dev/null
+++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/examples/Profiles_ListByResourceGroup.json
@@ -0,0 +1,43 @@
+{
+ "parameters": {
+ "api-version": "2020-04-15",
+ "subscriptionId": "subid",
+ "resourceGroupName": "RG"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "name": "profile1",
+ "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1",
+ "type": "Microsoft.Cdn/profiles",
+ "tags": {},
+ "location": "WestCentralUs",
+ "sku": {
+ "name": "Standard_Akamai"
+ },
+ "properties": {
+ "provisioningState": "Succeeded",
+ "resourceState": "Active"
+ }
+ },
+ {
+ "name": "profile2",
+ "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile2",
+ "type": "Microsoft.Cdn/profiles",
+ "tags": {},
+ "location": "WestCentralUs",
+ "sku": {
+ "name": "Standard_Akamai"
+ },
+ "properties": {
+ "provisioningState": "Succeeded",
+ "resourceState": "Active"
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/examples/Profiles_ListResourceUsage.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/examples/Profiles_ListResourceUsage.json
new file mode 100644
index 000000000000..3830380800be
--- /dev/null
+++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/examples/Profiles_ListResourceUsage.json
@@ -0,0 +1,22 @@
+{
+ "parameters": {
+ "api-version": "2020-04-15",
+ "subscriptionId": "subid",
+ "resourceGroupName": "RG",
+ "profileName": "profile1"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "resourceType": "endpoint",
+ "unit": "count",
+ "currentValue": 0,
+ "limit": 25
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/examples/Profiles_ListSupportedOptimizationTypes.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/examples/Profiles_ListSupportedOptimizationTypes.json
new file mode 100644
index 000000000000..c3f7aecedd99
--- /dev/null
+++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/examples/Profiles_ListSupportedOptimizationTypes.json
@@ -0,0 +1,18 @@
+{
+ "parameters": {
+ "api-version": "2020-04-15",
+ "subscriptionId": "subid",
+ "resourceGroupName": "RG",
+ "profileName": "profile1"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "supportedOptimizationTypes": [
+ "GeneralWebDelivery",
+ "DynamicSiteAcceleration"
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/examples/Profiles_Update.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/examples/Profiles_Update.json
new file mode 100644
index 000000000000..8b626338de52
--- /dev/null
+++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/examples/Profiles_Update.json
@@ -0,0 +1,51 @@
+{
+ "parameters": {
+ "api-version": "2020-04-15",
+ "subscriptionId": "subid",
+ "resourceGroupName": "RG",
+ "profileName": "profile1",
+ "profileUpdateParameters": {
+ "tags": {
+ "additionalProperties": "Tag1"
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "name": "profile1",
+ "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1",
+ "type": "Microsoft.Cdn/profiles",
+ "tags": {
+ "additionalProperties": "Tag1"
+ },
+ "location": "WestCentralUs",
+ "sku": {
+ "name": "Standard_Verizon"
+ },
+ "properties": {
+ "provisioningState": "Succeeded",
+ "resourceState": "Active"
+ }
+ }
+ },
+ "202": {
+ "body": {
+ "name": "profile1",
+ "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1",
+ "type": "Microsoft.Cdn/profiles",
+ "tags": {
+ "additionalProperties": "Tag1"
+ },
+ "location": "WestCentralUs",
+ "sku": {
+ "name": "Standard_Verizon"
+ },
+ "properties": {
+ "provisioningState": "Succeeded",
+ "resourceState": "Active"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/examples/ResourceUsage_List.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/examples/ResourceUsage_List.json
new file mode 100644
index 000000000000..e392d79f386d
--- /dev/null
+++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/examples/ResourceUsage_List.json
@@ -0,0 +1,20 @@
+{
+ "parameters": {
+ "api-version": "2020-04-15",
+ "subscriptionId": "subid"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "resourceType": "profile",
+ "unit": "count",
+ "currentValue": 31,
+ "limit": 200
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/examples/ValidateProbe.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/examples/ValidateProbe.json
new file mode 100644
index 000000000000..cf8a858664ca
--- /dev/null
+++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/examples/ValidateProbe.json
@@ -0,0 +1,18 @@
+{
+ "parameters": {
+ "api-version": "2020-04-15",
+ "subscriptionId": "subid",
+ "validateProbeInput": {
+ "probeURL": "https://www.bing.com/image"
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "isValid": true,
+ "errorCode": "None",
+ "message": null
+ }
+ }
+ }
+}
diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/examples/WafListManagedRuleSets.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/examples/WafListManagedRuleSets.json
new file mode 100644
index 000000000000..92cca78b4f3b
--- /dev/null
+++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/examples/WafListManagedRuleSets.json
@@ -0,0 +1,53 @@
+{
+ "parameters": {
+ "api-version": "2020-04-15",
+ "subscriptionId": "subid"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "name": "DefaultRuleSet_1.0",
+ "id": "/subscriptions/subid/providers/Microsoft.Cdn/CdnWebApplicationFirewallManagedRuleSets",
+ "type": "Microsoft.Cdn/cdnwebapplicationfirewallmanagedrulesets",
+ "sku": {
+ "name": "Standard_Microsoft"
+ },
+ "properties": {
+ "provisioningState": "Succeeded",
+ "ruleSetType": "DefaultRuleSet",
+ "ruleSetVersion": "preview-1.0",
+ "ruleGroups": [
+ {
+ "ruleGroupName": "Group1",
+ "description": "Description for rule group 1.",
+ "rules": [
+ {
+ "ruleId": "GROUP1-0001",
+ "description": "Generic managed web application firewall rule."
+ },
+ {
+ "ruleId": "GROUP1-0002",
+ "description": "Generic managed web application firewall rule."
+ }
+ ]
+ },
+ {
+ "ruleGroupName": "Group2",
+ "description": "Description for rule group 2.",
+ "rules": [
+ {
+ "ruleId": "GROUP2-0001",
+ "description": "Generic managed web application firewall rule."
+ }
+ ]
+ }
+ ]
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/examples/WafListPolicies.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/examples/WafListPolicies.json
new file mode 100644
index 000000000000..68f6d96c8893
--- /dev/null
+++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/examples/WafListPolicies.json
@@ -0,0 +1,265 @@
+{
+ "parameters": {
+ "api-version": "2020-04-15",
+ "subscriptionId": "subid",
+ "resourceGroupName": "rg1"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "name": "MicrosoftCdnWafPolicy",
+ "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cdn/CdnWebApplicationFirewallPolicies/MicrosoftCdnWafPolicy",
+ "type": "Microsoft.Cdn/cdnwebapplicationfirewallpolicies",
+ "tags": {
+ "key1": "value1",
+ "key2": "value2"
+ },
+ "location": "WestUs",
+ "sku": {
+ "name": "Standard_Microsoft"
+ },
+ "properties": {
+ "resourceState": "Enabled",
+ "provisioningState": "Succeeded",
+ "policySettings": {
+ "enabledState": "Enabled",
+ "mode": "Prevention",
+ "defaultRedirectUrl": "http://www.bing.com",
+ "defaultCustomBlockResponseStatusCode": 429,
+ "defaultCustomBlockResponseBody": "PGh0bWw+CjxoZWFkZXI+PHRpdGxlPkhlbGxvPC90aXRsZT48L2hlYWRlcj4KPGJvZHk+CkhlbGxvIHdvcmxkCjwvYm9keT4KPC9odG1sPg=="
+ },
+ "rateLimitRules": {
+ "rules": [
+ {
+ "name": "RateLimitRule1",
+ "priority": 1,
+ "enabledState": "Enabled",
+ "rateLimitDurationInMinutes": 0,
+ "rateLimitThreshold": 1000,
+ "matchConditions": [
+ {
+ "matchVariable": "RemoteAddr",
+ "selector": null,
+ "operator": "IPMatch",
+ "negateCondition": false,
+ "transforms": [],
+ "matchValue": [
+ "192.168.1.0/24",
+ "10.0.0.0/24"
+ ]
+ }
+ ],
+ "action": "Block"
+ }
+ ]
+ },
+ "customRules": {
+ "rules": [
+ {
+ "name": "CustomRule1",
+ "priority": 2,
+ "enabledState": "Enabled",
+ "matchConditions": [
+ {
+ "matchVariable": "RemoteAddr",
+ "selector": null,
+ "operator": "GeoMatch",
+ "negateCondition": false,
+ "transforms": [],
+ "matchValue": [
+ "CH"
+ ]
+ },
+ {
+ "matchVariable": "RequestHeader",
+ "selector": "UserAgent",
+ "operator": "Contains",
+ "negateCondition": false,
+ "transforms": [],
+ "matchValue": [
+ "windows"
+ ]
+ },
+ {
+ "matchVariable": "QueryString",
+ "selector": "search",
+ "operator": "Contains",
+ "negateCondition": false,
+ "transforms": [
+ "UrlDecode",
+ "Lowercase"
+ ],
+ "matchValue": [
+ ""
+ ]
+ }
+ ],
+ "action": "Block"
+ }
+ ]
+ },
+ "managedRules": {
+ "managedRuleSets": [
+ {
+ "ruleSetType": "DefaultRuleSet",
+ "ruleSetVersion": "preview-1.0",
+ "ruleGroupOverrides": [
+ {
+ "ruleGroupName": "Group1",
+ "rules": [
+ {
+ "ruleId": "GROUP1-0001",
+ "enabledState": "Enabled",
+ "action": "Redirect"
+ },
+ {
+ "ruleId": "GROUP1-0002",
+ "enabledState": "Disabled"
+ }
+ ]
+ }
+ ]
+ }
+ ]
+ },
+ "endpointLinks": [
+ {
+ "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cdn/profiles/profile1/endpoints/testEndpoint1"
+ },
+ {
+ "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cdn/profiles/profile1/endpoints/testEndpoint2"
+ }
+ ]
+ }
+ },
+ {
+ "name": "VerizonStandardCdnWafPolicy",
+ "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cdn/CdnWebApplicationFirewallPolicies/VerizonStandardCdnWafPolicy",
+ "type": "Microsoft.Cdn/cdnwebapplicationfirewallpolicies",
+ "tags": {
+ "key1": "value1",
+ "key2": "value2"
+ },
+ "location": "WestUs",
+ "sku": {
+ "name": "Standard_Verizon"
+ },
+ "properties": {
+ "resourceState": "Enabled",
+ "provisioningState": "Succeeded",
+ "policySettings": {
+ "enabledState": "Enabled",
+ "mode": "Prevention",
+ "defaultRedirectUrl": "http://www.bing.com",
+ "defaultCustomBlockResponseStatusCode": 429,
+ "defaultCustomBlockResponseBody": "PGh0bWw+CjxoZWFkZXI+PHRpdGxlPkhlbGxvPC90aXRsZT48L2hlYWRlcj4KPGJvZHk+CkhlbGxvIHdvcmxkCjwvYm9keT4KPC9odG1sPg=="
+ },
+ "rateLimitRules": {
+ "rules": [
+ {
+ "name": "RateLimitRule1",
+ "priority": 1,
+ "enabledState": "Enabled",
+ "rateLimitDurationInMinutes": 0,
+ "rateLimitThreshold": 1000,
+ "matchConditions": [
+ {
+ "matchVariable": "RemoteAddr",
+ "selector": null,
+ "operator": "IPMatch",
+ "negateCondition": false,
+ "transforms": [],
+ "matchValue": [
+ "192.168.1.0/24",
+ "10.0.0.0/24"
+ ]
+ }
+ ],
+ "action": "Block"
+ }
+ ]
+ },
+ "customRules": {
+ "rules": [
+ {
+ "name": "CustomRule1",
+ "priority": 2,
+ "enabledState": "Enabled",
+ "matchConditions": [
+ {
+ "matchVariable": "RemoteAddr",
+ "selector": null,
+ "operator": "GeoMatch",
+ "negateCondition": false,
+ "transforms": [],
+ "matchValue": [
+ "CH"
+ ]
+ },
+ {
+ "matchVariable": "RequestHeader",
+ "selector": "UserAgent",
+ "operator": "Contains",
+ "negateCondition": false,
+ "matchValue": [
+ "windows"
+ ]
+ },
+ {
+ "matchVariable": "QueryString",
+ "selector": "search",
+ "operator": "Contains",
+ "negateCondition": false,
+ "transforms": [
+ "UrlDecode",
+ "Lowercase"
+ ],
+ "matchValue": [
+ ""
+ ]
+ }
+ ],
+ "action": "Block"
+ }
+ ]
+ },
+ "managedRules": {
+ "managedRuleSets": [
+ {
+ "ruleSetType": "ECRS",
+ "ruleSetVersion": "2018-11-2",
+ "ruleGroupOverrides": [
+ {
+ "ruleGroupName": "XSS",
+ "rules": [
+ {
+ "ruleId": "XSS-0001",
+ "enabledState": "Enabled",
+ "action": "Redirect"
+ },
+ {
+ "ruleId": "XSS-0002",
+ "enabledState": "Disabled"
+ }
+ ]
+ }
+ ]
+ }
+ ]
+ },
+ "endpointLinks": [
+ {
+ "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cdn/profiles/profile1/endpoints/testEndpoint3"
+ }
+ ]
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/examples/WafPatchPolicy.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/examples/WafPatchPolicy.json
new file mode 100644
index 000000000000..7e8c7d3e05ee
--- /dev/null
+++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/examples/WafPatchPolicy.json
@@ -0,0 +1,272 @@
+{
+ "parameters": {
+ "api-version": "2020-04-15",
+ "subscriptionId": "subid",
+ "resourceGroupName": "rg1",
+ "policyName": "MicrosoftCdnWafPolicy",
+ "cdnWebApplicationFirewallPolicyPatchParameters": {
+ "tags": {
+ "foo": "bar"
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "name": "MicrosoftCdnWafPolicy",
+ "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cdn/CdnWebApplicationFirewallPolicies/MicrosoftCdnWafPolicy",
+ "type": "Microsoft.Cdn/cdnwebapplicationfirewallpolicies",
+ "tags": {
+ "foo": "bar"
+ },
+ "location": "WestUs",
+ "sku": {
+ "name": "Standard_Microsoft"
+ },
+ "properties": {
+ "resourceState": "Enabled",
+ "provisioningState": "Succeeded",
+ "policySettings": {
+ "enabledState": "Enabled",
+ "mode": "Prevention",
+ "defaultRedirectUrl": "http://www.bing.com",
+ "defaultCustomBlockResponseStatusCode": 403,
+ "defaultCustomBlockResponseBody": "PGh0bWw+CjxoZWFkZXI+PHRpdGxlPkhlbGxvPC90aXRsZT48L2hlYWRlcj4KPGJvZHk+CkhlbGxvIHdvcmxkCjwvYm9keT4KPC9odG1sPg=="
+ },
+ "rateLimitRules": {
+ "rules": [
+ {
+ "name": "RateLimitRule1",
+ "priority": 1,
+ "enabledState": "Enabled",
+ "rateLimitDurationInMinutes": 0,
+ "rateLimitThreshold": 1000,
+ "matchConditions": [
+ {
+ "matchVariable": "RemoteAddr",
+ "selector": null,
+ "operator": "IPMatch",
+ "negateCondition": false,
+ "transforms": [],
+ "matchValue": [
+ "192.168.1.0/24",
+ "10.0.0.0/24"
+ ]
+ }
+ ],
+ "action": "Block"
+ }
+ ]
+ },
+ "customRules": {
+ "rules": [
+ {
+ "name": "CustomRule1",
+ "priority": 2,
+ "enabledState": "Enabled",
+ "matchConditions": [
+ {
+ "matchVariable": "RemoteAddr",
+ "selector": null,
+ "operator": "GeoMatch",
+ "negateCondition": false,
+ "transforms": [],
+ "matchValue": [
+ "CH"
+ ]
+ },
+ {
+ "matchVariable": "RequestHeader",
+ "selector": "UserAgent",
+ "operator": "Contains",
+ "negateCondition": false,
+ "transforms": [],
+ "matchValue": [
+ "windows"
+ ]
+ },
+ {
+ "matchVariable": "QueryString",
+ "selector": "search",
+ "operator": "Contains",
+ "negateCondition": false,
+ "transforms": [
+ "UrlDecode",
+ "Lowercase"
+ ],
+ "matchValue": [
+ ""
+ ]
+ }
+ ],
+ "action": "Block"
+ }
+ ]
+ },
+ "managedRules": {
+ "managedRuleSets": [
+ {
+ "ruleSetType": "DefaultRuleSet",
+ "ruleSetVersion": "preview-1.0",
+ "ruleGroupOverrides": [
+ {
+ "ruleGroupName": "Group1",
+ "rules": [
+ {
+ "ruleId": "GROUP1-0001",
+ "enabledState": "Enabled",
+ "action": "Redirect"
+ },
+ {
+ "ruleId": "GROUP1-0002",
+ "enabledState": "Disabled"
+ }
+ ]
+ }
+ ]
+ }
+ ]
+ },
+ "endpointLinks": [
+ {
+ "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cdn/profiles/profile1/endpoints/testEndpoint1"
+ },
+ {
+ "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cdn/profiles/profile1/endpoints/testEndpoint2"
+ }
+ ]
+ }
+ }
+ },
+ "202": {
+ "body": {
+ "name": "MicrosoftCdnWafPolicy",
+ "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cdn/CdnWebApplicationFirewallPolicies/MicrosoftCdnWafPolicy",
+ "type": "Microsoft.Cdn/cdnwebapplicationfirewallpolicies",
+ "tags": {
+ "key1": "value1",
+ "key2": "value2"
+ },
+ "location": "WestUs",
+ "sku": {
+ "name": "Standard_Microsoft"
+ },
+ "properties": {
+ "resourceState": "Creating",
+ "provisioningState": "Succeeded",
+ "policySettings": {
+ "enabledState": "Enabled",
+ "mode": "Prevention",
+ "defaultRedirectUrl": "http://www.bing.com",
+ "defaultCustomBlockResponseStatusCode": 403,
+ "defaultCustomBlockResponseBody": "PGh0bWw+CjxoZWFkZXI+PHRpdGxlPkhlbGxvPC90aXRsZT48L2hlYWRlcj4KPGJvZHk+CkhlbGxvIHdvcmxkCjwvYm9keT4KPC9odG1sPg=="
+ },
+ "rateLimitRules": {
+ "rules": [
+ {
+ "name": "RateLimitRule1",
+ "priority": 1,
+ "enabledState": "Enabled",
+ "rateLimitDurationInMinutes": 0,
+ "rateLimitThreshold": 1000,
+ "matchConditions": [
+ {
+ "matchVariable": "RemoteAddr",
+ "selector": null,
+ "operator": "IPMatch",
+ "negateCondition": false,
+ "transforms": [],
+ "matchValue": [
+ "192.168.1.0/24",
+ "10.0.0.0/24"
+ ]
+ }
+ ],
+ "action": "Block"
+ }
+ ]
+ },
+ "customRules": {
+ "rules": [
+ {
+ "name": "CustomRule1",
+ "priority": 2,
+ "enabledState": "Enabled",
+ "matchConditions": [
+ {
+ "matchVariable": "RemoteAddr",
+ "selector": null,
+ "operator": "GeoMatch",
+ "negateCondition": false,
+ "transforms": [],
+ "matchValue": [
+ "CH"
+ ]
+ },
+ {
+ "matchVariable": "RequestHeader",
+ "selector": "UserAgent",
+ "operator": "Contains",
+ "negateCondition": false,
+ "transforms": [],
+ "matchValue": [
+ "windows"
+ ]
+ },
+ {
+ "matchVariable": "QueryString",
+ "selector": "search",
+ "operator": "Contains",
+ "negateCondition": false,
+ "transforms": [
+ "UrlDecode",
+ "Lowercase"
+ ],
+ "matchValue": [
+ ""
+ ]
+ }
+ ],
+ "action": "Block"
+ }
+ ]
+ },
+ "managedRules": {
+ "managedRuleSets": [
+ {
+ "ruleSetType": "DefaultRuleSet",
+ "ruleSetVersion": "preview-1.0",
+ "ruleGroupOverrides": [
+ {
+ "ruleGroupName": "Group1",
+ "rules": [
+ {
+ "ruleId": "GROUP1-0001",
+ "enabledState": "Enabled",
+ "action": "Redirect"
+ },
+ {
+ "ruleId": "GROUP1-0002",
+ "enabledState": "Disabled"
+ }
+ ]
+ }
+ ]
+ }
+ ]
+ },
+ "endpointLinks": [
+ {
+ "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cdn/profiles/profile1/endpoints/testEndpoint1"
+ },
+ {
+ "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cdn/profiles/profile1/endpoints/testEndpoint2"
+ }
+ ]
+ }
+ }
+ }
+ }
+}
diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/examples/WafPolicyCreateOrUpdate.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/examples/WafPolicyCreateOrUpdate.json
new file mode 100644
index 000000000000..c0fb68fe3c69
--- /dev/null
+++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/examples/WafPolicyCreateOrUpdate.json
@@ -0,0 +1,505 @@
+{
+ "parameters": {
+ "api-version": "2020-04-15",
+ "subscriptionId": "subid",
+ "resourceGroupName": "rg1",
+ "policyName": "MicrosoftCdnWafPolicy",
+ "cdnWebApplicationFirewallPolicy": {
+ "location": "WestUs",
+ "sku": {
+ "name": "Standard_Microsoft"
+ },
+ "properties": {
+ "policySettings": {
+ "defaultRedirectUrl": "http://www.bing.com",
+ "defaultCustomBlockResponseStatusCode": 200,
+ "defaultCustomBlockResponseBody": "PGh0bWw+CjxoZWFkZXI+PHRpdGxlPkhlbGxvPC90aXRsZT48L2hlYWRlcj4KPGJvZHk+CkhlbGxvIHdvcmxkCjwvYm9keT4KPC9odG1sPg=="
+ },
+ "rateLimitRules": {
+ "rules": [
+ {
+ "name": "RateLimitRule1",
+ "priority": 1,
+ "enabledState": "Enabled",
+ "rateLimitDurationInMinutes": 0,
+ "rateLimitThreshold": 1000,
+ "matchConditions": [
+ {
+ "matchVariable": "RemoteAddr",
+ "selector": null,
+ "operator": "IPMatch",
+ "negateCondition": false,
+ "transforms": [],
+ "matchValue": [
+ "192.168.1.0/24",
+ "10.0.0.0/24"
+ ]
+ }
+ ],
+ "action": "Block"
+ }
+ ]
+ },
+ "customRules": {
+ "rules": [
+ {
+ "name": "CustomRule1",
+ "priority": 2,
+ "enabledState": "Enabled",
+ "matchConditions": [
+ {
+ "matchVariable": "RemoteAddr",
+ "selector": null,
+ "operator": "GeoMatch",
+ "negateCondition": false,
+ "transforms": [],
+ "matchValue": [
+ "CH"
+ ]
+ },
+ {
+ "matchVariable": "RequestHeader",
+ "selector": "UserAgent",
+ "operator": "Contains",
+ "negateCondition": false,
+ "transforms": [],
+ "matchValue": [
+ "windows"
+ ]
+ },
+ {
+ "matchVariable": "QueryString",
+ "selector": "search",
+ "operator": "Contains",
+ "negateCondition": false,
+ "transforms": [
+ "UrlDecode",
+ "Lowercase"
+ ],
+ "matchValue": [
+ ""
+ ]
+ }
+ ],
+ "action": "Block"
+ }
+ ]
+ },
+ "managedRules": {
+ "managedRuleSets": [
+ {
+ "ruleSetType": "DefaultRuleSet",
+ "ruleSetVersion": "preview-1.0",
+ "ruleGroupOverrides": [
+ {
+ "ruleGroupName": "Group1",
+ "rules": [
+ {
+ "ruleId": "GROUP1-0001",
+ "enabledState": "Enabled",
+ "action": "Redirect"
+ },
+ {
+ "ruleId": "GROUP1-0002",
+ "enabledState": "Disabled"
+ }
+ ]
+ }
+ ]
+ }
+ ]
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "name": "MicrosoftCdnWafPolicy",
+ "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cdn/CdnWebApplicationFirewallPolicies/MicrosoftCdnWafPolicy",
+ "type": "Microsoft.Cdn/cdnwebapplicationfirewallpolicies",
+ "tags": {
+ "key1": "value1",
+ "key2": "value2"
+ },
+ "location": "WestUs",
+ "sku": {
+ "name": "Standard_Microsoft"
+ },
+ "properties": {
+ "resourceState": "Enabled",
+ "provisioningState": "Succeeded",
+ "policySettings": {
+ "enabledState": "Enabled",
+ "mode": "Prevention",
+ "defaultRedirectUrl": "http://www.bing.com",
+ "defaultCustomBlockResponseStatusCode": 200,
+ "defaultCustomBlockResponseBody": "PGh0bWw+CjxoZWFkZXI+PHRpdGxlPkhlbGxvPC90aXRsZT48L2hlYWRlcj4KPGJvZHk+CkhlbGxvIHdvcmxkCjwvYm9keT4KPC9odG1sPg=="
+ },
+ "rateLimitRules": {
+ "rules": [
+ {
+ "name": "RateLimitRule1",
+ "priority": 1,
+ "enabledState": "Enabled",
+ "rateLimitDurationInMinutes": 0,
+ "rateLimitThreshold": 1000,
+ "matchConditions": [
+ {
+ "matchVariable": "RemoteAddr",
+ "selector": null,
+ "operator": "IPMatch",
+ "negateCondition": false,
+ "transforms": [],
+ "matchValue": [
+ "192.168.1.0/24",
+ "10.0.0.0/24"
+ ]
+ }
+ ],
+ "action": "Block"
+ }
+ ]
+ },
+ "customRules": {
+ "rules": [
+ {
+ "name": "CustomRule1",
+ "priority": 2,
+ "enabledState": "Enabled",
+ "matchConditions": [
+ {
+ "matchVariable": "RemoteAddr",
+ "selector": null,
+ "operator": "GeoMatch",
+ "negateCondition": false,
+ "transforms": [],
+ "matchValue": [
+ "CH"
+ ]
+ },
+ {
+ "matchVariable": "RequestHeader",
+ "selector": "UserAgent",
+ "operator": "Contains",
+ "negateCondition": false,
+ "transforms": [],
+ "matchValue": [
+ "windows"
+ ]
+ },
+ {
+ "matchVariable": "QueryString",
+ "selector": "search",
+ "operator": "Contains",
+ "negateCondition": false,
+ "transforms": [
+ "UrlDecode",
+ "Lowercase"
+ ],
+ "matchValue": [
+ ""
+ ]
+ }
+ ],
+ "action": "Block"
+ }
+ ]
+ },
+ "managedRules": {
+ "managedRuleSets": [
+ {
+ "ruleSetType": "DefaultRuleSet",
+ "ruleSetVersion": "preview-1.0",
+ "ruleGroupOverrides": [
+ {
+ "ruleGroupName": "Group1",
+ "rules": [
+ {
+ "ruleId": "GROUP1-0001",
+ "enabledState": "Enabled",
+ "action": "Redirect"
+ },
+ {
+ "ruleId": "GROUP1-0002",
+ "enabledState": "Disabled"
+ }
+ ]
+ }
+ ]
+ }
+ ]
+ },
+ "endpointLinks": [
+ {
+ "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cdn/profiles/profile1/endpoints/testEndpoint1"
+ },
+ {
+ "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cdn/profiles/profile1/endpoints/testEndpoint2"
+ }
+ ]
+ }
+ }
+ },
+ "201": {
+ "body": {
+ "name": "MicrosoftCdnWafPolicy",
+ "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cdn/CdnWebApplicationFirewallPolicies/MicrosoftCdnWafPolicy",
+ "type": "Microsoft.Cdn/cdnwebapplicationfirewallpolicies",
+ "tags": {
+ "key1": "value1",
+ "key2": "value2"
+ },
+ "location": "WestUs",
+ "sku": {
+ "name": "Standard_Microsoft"
+ },
+ "properties": {
+ "resourceState": "Enabled",
+ "provisioningState": "Succeeded",
+ "policySettings": {
+ "enabledState": "Enabled",
+ "mode": "Prevention",
+ "defaultRedirectUrl": "http://www.bing.com",
+ "defaultCustomBlockResponseStatusCode": 200,
+ "defaultCustomBlockResponseBody": "PGh0bWw+CjxoZWFkZXI+PHRpdGxlPkhlbGxvPC90aXRsZT48L2hlYWRlcj4KPGJvZHk+CkhlbGxvIHdvcmxkCjwvYm9keT4KPC9odG1sPg=="
+ },
+ "rateLimitRules": {
+ "rules": [
+ {
+ "name": "RateLimitRule1",
+ "priority": 1,
+ "enabledState": "Enabled",
+ "rateLimitDurationInMinutes": 0,
+ "rateLimitThreshold": 1000,
+ "matchConditions": [
+ {
+ "matchVariable": "RemoteAddr",
+ "selector": null,
+ "operator": "IPMatch",
+ "negateCondition": false,
+ "transforms": [],
+ "matchValue": [
+ "192.168.1.0/24",
+ "10.0.0.0/24"
+ ]
+ }
+ ],
+ "action": "Block"
+ }
+ ]
+ },
+ "customRules": {
+ "rules": [
+ {
+ "name": "CustomRule1",
+ "priority": 2,
+ "enabledState": "Enabled",
+ "matchConditions": [
+ {
+ "matchVariable": "RemoteAddr",
+ "selector": null,
+ "operator": "GeoMatch",
+ "negateCondition": false,
+ "transforms": [],
+ "matchValue": [
+ "CH"
+ ]
+ },
+ {
+ "matchVariable": "RequestHeader",
+ "selector": "UserAgent",
+ "operator": "Contains",
+ "negateCondition": false,
+ "transforms": [],
+ "matchValue": [
+ "windows"
+ ]
+ },
+ {
+ "matchVariable": "QueryString",
+ "selector": "search",
+ "operator": "Contains",
+ "negateCondition": false,
+ "transforms": [
+ "UrlDecode",
+ "Lowercase"
+ ],
+ "matchValue": [
+ ""
+ ]
+ }
+ ],
+ "action": "Block"
+ }
+ ]
+ },
+ "managedRules": {
+ "managedRuleSets": [
+ {
+ "ruleSetType": "DefaultRuleSet",
+ "ruleSetVersion": "preview-1.0",
+ "ruleGroupOverrides": [
+ {
+ "ruleGroupName": "Group1",
+ "rules": [
+ {
+ "ruleId": "GROUP1-0001",
+ "enabledState": "Enabled",
+ "action": "Redirect"
+ },
+ {
+ "ruleId": "GROUP1-0002",
+ "enabledState": "Disabled"
+ }
+ ]
+ }
+ ]
+ }
+ ]
+ },
+ "endpointLinks": [
+ {
+ "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cdn/profiles/profile1/endpoints/testEndpoint1"
+ },
+ {
+ "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cdn/profiles/profile1/endpoints/testEndpoint2"
+ }
+ ]
+ }
+ }
+ },
+ "202": {
+ "body": {
+ "name": "MicrosoftCdnWafPolicy",
+ "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cdn/CdnWebApplicationFirewallPolicies/MicrosoftCdnWafPolicy",
+ "type": "Microsoft.Cdn/cdnwebapplicationfirewallpolicies",
+ "tags": {
+ "key1": "value1",
+ "key2": "value2"
+ },
+ "location": "WestUs",
+ "sku": {
+ "name": "Standard_Microsoft"
+ },
+ "properties": {
+ "resourceState": "Creating",
+ "provisioningState": "Succeeded",
+ "policySettings": {
+ "enabledState": "Enabled",
+ "mode": "Prevention",
+ "defaultRedirectUrl": "http://www.bing.com",
+ "defaultCustomBlockResponseStatusCode": 200,
+ "defaultCustomBlockResponseBody": "PGh0bWw+CjxoZWFkZXI+PHRpdGxlPkhlbGxvPC90aXRsZT48L2hlYWRlcj4KPGJvZHk+CkhlbGxvIHdvcmxkCjwvYm9keT4KPC9odG1sPg=="
+ },
+ "rateLimitRules": {
+ "rules": [
+ {
+ "name": "RateLimitRule1",
+ "priority": 1,
+ "enabledState": "Enabled",
+ "rateLimitDurationInMinutes": 0,
+ "rateLimitThreshold": 1000,
+ "matchConditions": [
+ {
+ "matchVariable": "RemoteAddr",
+ "selector": null,
+ "operator": "IPMatch",
+ "negateCondition": false,
+ "transforms": [],
+ "matchValue": [
+ "192.168.1.0/24",
+ "10.0.0.0/24"
+ ]
+ }
+ ],
+ "action": "Block"
+ }
+ ]
+ },
+ "customRules": {
+ "rules": [
+ {
+ "name": "CustomRule1",
+ "priority": 3,
+ "enabledState": "Enabled",
+ "matchConditions": [
+ {
+ "matchVariable": "RemoteAddr",
+ "selector": null,
+ "operator": "GeoMatch",
+ "negateCondition": false,
+ "transforms": [],
+ "matchValue": [
+ "CH"
+ ]
+ },
+ {
+ "matchVariable": "RequestHeader",
+ "selector": "UserAgent",
+ "operator": "Contains",
+ "negateCondition": false,
+ "transforms": [],
+ "matchValue": [
+ "windows"
+ ]
+ },
+ {
+ "matchVariable": "QueryString",
+ "selector": "search",
+ "operator": "Contains",
+ "negateCondition": false,
+ "transforms": [
+ "UrlDecode",
+ "Lowercase"
+ ],
+ "matchValue": [
+ ""
+ ]
+ }
+ ],
+ "action": "Block"
+ }
+ ]
+ },
+ "managedRules": {
+ "managedRuleSets": [
+ {
+ "ruleSetType": "DefaultRuleSet",
+ "ruleSetVersion": "preview-1.0",
+ "ruleGroupOverrides": [
+ {
+ "ruleGroupName": "Group1",
+ "rules": [
+ {
+ "ruleId": "GROUP1-0001",
+ "enabledState": "Enabled",
+ "action": "Redirect"
+ },
+ {
+ "ruleId": "GROUP1-0002",
+ "enabledState": "Disabled"
+ }
+ ]
+ }
+ ]
+ }
+ ]
+ },
+ "endpointLinks": [
+ {
+ "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cdn/profiles/profile1/endpoints/testEndpoint1"
+ },
+ {
+ "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cdn/profiles/profile1/endpoints/testEndpoint2"
+ }
+ ]
+ }
+ }
+ }
+ }
+}
diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/examples/WafPolicyDelete.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/examples/WafPolicyDelete.json
new file mode 100644
index 000000000000..1a88912550cf
--- /dev/null
+++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/examples/WafPolicyDelete.json
@@ -0,0 +1,12 @@
+{
+ "parameters": {
+ "api-version": "2020-04-15",
+ "subscriptionId": "subid",
+ "resourceGroupName": "rg1",
+ "policyName": "Policy1"
+ },
+ "responses": {
+ "200": {},
+ "204": {}
+ }
+}
diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/examples/WafPolicyGet.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/examples/WafPolicyGet.json
new file mode 100644
index 000000000000..086cbc0e512d
--- /dev/null
+++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/examples/WafPolicyGet.json
@@ -0,0 +1,139 @@
+{
+ "parameters": {
+ "api-version": "2020-04-15",
+ "subscriptionId": "subid",
+ "resourceGroupName": "rg1",
+ "policyName": "MicrosoftCdnWafPolicy"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "name": "MicrosoftCdnWafPolicy",
+ "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cdn/CdnWebApplicationFirewallPolicies/MicrosoftCdnWafPolicy",
+ "type": "Microsoft.Cdn/cdnwebapplicationfirewallpolicies",
+ "tags": {
+ "key1": "value1",
+ "key2": "value2"
+ },
+ "location": "WestUs",
+ "sku": {
+ "name": "Standard_Microsoft"
+ },
+ "properties": {
+ "resourceState": "Enabled",
+ "provisioningState": "Succeeded",
+ "policySettings": {
+ "enabledState": "Enabled",
+ "mode": "Prevention",
+ "defaultRedirectUrl": "http://www.bing.com",
+ "defaultCustomBlockResponseStatusCode": 429,
+ "defaultCustomBlockResponseBody": "PGh0bWw+CjxoZWFkZXI+PHRpdGxlPkhlbGxvPC90aXRsZT48L2hlYWRlcj4KPGJvZHk+CkhlbGxvIHdvcmxkCjwvYm9keT4KPC9odG1sPg=="
+ },
+ "rateLimitRules": {
+ "rules": [
+ {
+ "name": "RateLimitRule1",
+ "priority": 1,
+ "enabledState": "Enabled",
+ "rateLimitDurationInMinutes": 0,
+ "rateLimitThreshold": 1000,
+ "matchConditions": [
+ {
+ "matchVariable": "RemoteAddr",
+ "selector": null,
+ "operator": "IPMatch",
+ "negateCondition": false,
+ "transforms": [],
+ "matchValue": [
+ "192.168.1.0/24",
+ "10.0.0.0/24"
+ ]
+ }
+ ],
+ "action": "Block"
+ }
+ ]
+ },
+ "customRules": {
+ "rules": [
+ {
+ "name": "CustomRule1",
+ "priority": 2,
+ "enabledState": "Enabled",
+ "matchConditions": [
+ {
+ "matchVariable": "RemoteAddr",
+ "selector": null,
+ "operator": "GeoMatch",
+ "negateCondition": false,
+ "transforms": [],
+ "matchValue": [
+ "CH"
+ ]
+ },
+ {
+ "matchVariable": "RequestHeader",
+ "selector": "UserAgent",
+ "operator": "Contains",
+ "negateCondition": false,
+ "transforms": [],
+ "matchValue": [
+ "windows"
+ ]
+ },
+ {
+ "matchVariable": "QueryString",
+ "selector": "search",
+ "operator": "Contains",
+ "negateCondition": false,
+ "transforms": [
+ "UrlDecode",
+ "Lowercase"
+ ],
+ "matchValue": [
+ ""
+ ]
+ }
+ ],
+ "action": "Block"
+ }
+ ]
+ },
+ "managedRules": {
+ "managedRuleSets": [
+ {
+ "ruleSetType": "DefaultRuleSet",
+ "ruleSetVersion": "preview-1.0",
+ "ruleGroupOverrides": [
+ {
+ "ruleGroupName": "Group1",
+ "rules": [
+ {
+ "ruleId": "GROUP1-0001",
+ "enabledState": "Enabled",
+ "action": "Redirect"
+ },
+ {
+ "ruleId": "GROUP1-0002",
+ "enabledState": "Disabled"
+ }
+ ]
+ }
+ ]
+ }
+ ]
+ },
+ "endpointLinks": [
+ {
+ "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cdn/profiles/profile1/endpoints/testEndpoint1"
+ },
+ {
+ "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cdn/profiles/profile1/endpoints/testEndpoint2"
+ }
+ ]
+ }
+ }
+ }
+ }
+}
diff --git a/specification/cdn/resource-manager/readme.go.md b/specification/cdn/resource-manager/readme.go.md
index 2700f6d89157..b53dccbfb0c7 100644
--- a/specification/cdn/resource-manager/readme.go.md
+++ b/specification/cdn/resource-manager/readme.go.md
@@ -13,6 +13,7 @@ go:
``` yaml $(go) && $(multiapi)
batch:
+ - tag: package-2020-04
- tag: package-2019-06
- tag: package-2019-04
- tag: package-2017-10
@@ -22,13 +23,13 @@ batch:
- tag: package-2015-06
```
-### Tag: package-2019-06 and go
+### Tag: package-2020-04 and go
-These settings apply only when `--tag=package-2019-06 --go` is specified on the command line.
+These settings apply only when `--tag=package-2020-04 --go` is specified on the command line.
Please also specify `--go-sdk-folder=`.
-``` yaml $(tag) == 'package-2019-06' && $(go)
-output-folder: $(go-sdk-folder)/services/preview/$(namespace)/mgmt/2019-06-15-preview/$(namespace)
+``` yaml $(tag) == 'package-2020-04' && $(go)
+output-folder: $(go-sdk-folder)/services/preview/$(namespace)/mgmt/2020-04-15/$(namespace)
```
### Tag: package-2019-04 and go
diff --git a/specification/cdn/resource-manager/readme.md b/specification/cdn/resource-manager/readme.md
index 6e48071bcdf2..58ca149dc55d 100644
--- a/specification/cdn/resource-manager/readme.md
+++ b/specification/cdn/resource-manager/readme.md
@@ -31,6 +31,16 @@ openapi-type: arm
tag: package-2019-06
```
+### Tag: package-2020-04
+
+These settings apply only when `--tag=package-2020-04` is specified on the command line.
+
+``` yaml $(tag) == 'package-2020-04'
+input-file:
+- Microsoft.Cdn/stable/2020-04-15/cdn.json
+- Microsoft.Cdn/stable/2020-04-15/cdnwebapplicationfirewall.json
+```
+
### Tag: package-2019-12
These settings apply only when `--tag=package-2019-12` is specified on the command line.
@@ -177,6 +187,8 @@ require: $(this-folder)/../../../profiles/readme.md
# all the input files across all versions
input-file:
+ - $(this-folder)/Microsoft.Cdn/stable/2020-04-15/cdn.json
+ - $(this-folder)/Microsoft.Cdn/stable/2020-04-15/cdnwebapplicationfirewall.json
- $(this-folder)/Microsoft.Cdn/stable/2019-12-31/cdn.json
- $(this-folder)/Microsoft.Cdn/stable/2019-06-15/cdn.json
- $(this-folder)/Microsoft.Cdn/stable/2019-06-15/cdnwebapplicationfirewall.json
diff --git a/specification/cdn/resource-manager/readme.ruby.md b/specification/cdn/resource-manager/readme.ruby.md
index 7d3f03852d62..f1c42770c4fa 100644
--- a/specification/cdn/resource-manager/readme.ruby.md
+++ b/specification/cdn/resource-manager/readme.ruby.md
@@ -21,6 +21,16 @@ batch:
- tag: package-2015-06
```
+### Tag: package-2020-04 and ruby
+
+These settings apply only when `--tag=package-2020-04 --ruby` is specified on the command line.
+Please also specify `--ruby-sdks-folder=`.
+
+``` yaml $(tag) == 'package-2020-04' && $(ruby)
+namespace: "Azure::CDN::Mgmt::V2020_04_15"
+output-folder: $(ruby-sdks-folder)/management/azure_mgmt_cdn/lib
+```
+
### Tag: package-2019-06 and ruby
These settings apply only when `--tag=package-2019-06 --ruby` is specified on the command line.
diff --git a/specification/changeanalysis/resource-manager/Microsoft.ChangeAnalysis/preview/2020-04-01-preview/changeanalysis.json b/specification/changeanalysis/resource-manager/Microsoft.ChangeAnalysis/preview/2020-04-01-preview/changeanalysis.json
new file mode 100644
index 000000000000..5e9311a95e5a
--- /dev/null
+++ b/specification/changeanalysis/resource-manager/Microsoft.ChangeAnalysis/preview/2020-04-01-preview/changeanalysis.json
@@ -0,0 +1,519 @@
+{
+ "swagger": "2.0",
+ "info": {
+ "title": "AzureChangeAnalysisManagementClient",
+ "version": "2020-04-01-preview"
+ },
+ "host": "management.azure.com",
+ "schemes": [
+ "https"
+ ],
+ "paths": {
+ "/subscriptions/{subscriptionId}/providers/Microsoft.ChangeAnalysis/profile/{profileName}": {
+ "get": {
+ "tags": [
+ "ConfigurationProfile"
+ ],
+ "summary": "Gets the configuration profile for the Microsoft.ChangeAnalysis resource provider. The profile name should be always set to 'default'.",
+ "operationId": "ConfigurationProfile_Get",
+ "produces": [
+ "application/json",
+ "default"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/ProfileNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The request was successful; the request was well-formed and received properly.",
+ "schema": {
+ "$ref": "#/definitions/ConfigurationProfileResource"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed",
+ "schema": {
+ "$ref": "#/definitions/Error"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "ConfigurationProfile_Get": {
+ "$ref": "./examples/ConfigurationProfileGet.json"
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "ConfigurationProfile"
+ ],
+ "summary": "Updates configuration profile for for the Microsoft.ChangeAnalysis resource provider. The profile name should be always set to 'default'.",
+ "operationId": "ConfigurationProfile_Create",
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json",
+ "default"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/ProfileNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "in": "body",
+ "name": "body",
+ "description": "Request body containing new configuration profile.",
+ "schema": {
+ "$ref": "#/definitions/ConfigurationProfileResource"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The request was successful; the request was well-formed and received properly.",
+ "schema": {
+ "$ref": "#/definitions/ConfigurationProfileResource"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed",
+ "schema": {
+ "$ref": "#/definitions/Error"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "ConfigurationProfile_Create": {
+ "$ref": "./examples/ConfigurationProfileCreate.json"
+ },
+ "ConfigurationProfile_CreateWithIdentity": {
+ "$ref": "./examples/ConfigurationProfileCreateWithIdentity.json"
+ }
+ }
+ },
+ "patch": {
+ "tags": [
+ "ConfigurationProfile"
+ ],
+ "summary": "Updates a configuration profile with the specified parameters. The profile name should be always set to 'default'",
+ "operationId": "ConfigurationProfile_Update",
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json",
+ "default"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/ProfileNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "in": "body",
+ "name": "body",
+ "description": "The parameters for updating a configuration store.",
+ "schema": {
+ "$ref": "#/definitions/ConfigurationProfileResource"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The request was successful; the request was well-formed and received properly.",
+ "schema": {
+ "$ref": "#/definitions/ConfigurationProfileResource"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed",
+ "schema": {
+ "$ref": "#/definitions/Error"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "ConfigurationProfile_Update": {
+ "$ref": "./examples/ConfigurationProfileUpdate.json"
+ },
+ "ConfigurationProfile_UpdateWithIdentity": {
+ "$ref": "./examples/ConfigurationProfileUpdateWithIdentity.json"
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "ConfigurationProfile"
+ ],
+ "summary": "Deletes existing configuration profile. The profile name should be always set to 'default'",
+ "operationId": "ConfigurationProfile_Delete",
+ "produces": [
+ "default"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/ProfileNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The request was successful; the request was well-formed and received properly."
+ },
+ "204": {
+ "description": "No Content - the specified resource was not found."
+ },
+ "default": {
+ "description": "Error response describing why the operation failed",
+ "schema": {
+ "$ref": "#/definitions/Error"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "ConfigurationProfile_Delete": {
+ "$ref": "./examples/ConfigurationProfileDelete.json"
+ }
+ }
+ }
+ },
+ "/providers/Microsoft.ChangeAnalysis/operations": {
+ "get": {
+ "tags": [
+ "Operations"
+ ],
+ "summary": "Lists all the supported operations by the Microsoft.ChangeAnalysis resource provider along with their descriptions.",
+ "operationId": "Operations_List",
+ "produces": [
+ "application/json",
+ "default"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "in": "query",
+ "name": "$skipToken",
+ "description": "A skip token is used to continue retrieving items after an operation returns a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skipToken parameter that specifies a starting point to use for subsequent calls.",
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The request was successful; the request was well-formed and received properly.",
+ "schema": {
+ "$ref": "#/definitions/ResourceProviderOperationList"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed",
+ "schema": {
+ "$ref": "#/definitions/Error"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-examples": {
+ "Operations_List": {
+ "$ref": "./examples/OperationsList.json"
+ }
+ }
+ }
+ }
+ },
+ "definitions": {
+ "ResourceIdentity": {
+ "description": "The identity block returned by ARM resource that supports managed identity.",
+ "type": "object",
+ "properties": {
+ "type": {
+ "description": "The type of managed identity used. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user-assigned identities. The type 'None' will remove any identities.",
+ "enum": [
+ "None",
+ "SystemAssigned"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "ManagedIdentityTypes",
+ "modelAsString": true
+ }
+ },
+ "principalId": {
+ "format": "uuid",
+ "description": "The principal id of the identity. This property will only be provided for a system-assigned identity.",
+ "type": "string",
+ "readOnly": true
+ },
+ "tenantId": {
+ "format": "uuid",
+ "description": "The tenant id associated with the resource's identity. This property will only be provided for a system-assigned identity.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "AzureMonitorWorkspaceProperties": {
+ "description": "Configuration properties of an Azure Monitor workspace that receives change notifications.",
+ "type": "object",
+ "properties": {
+ "workspaceId": {
+ "description": "The Azure Monitor workspace ID - the unique identifier for the Log Analytics workspace.",
+ "type": "string"
+ },
+ "workspaceResourceId": {
+ "description": "The Azure Monitor workspace ARM Resource ID. The resource ID should be in the following format: /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}",
+ "type": "string"
+ }
+ }
+ },
+ "NotificationsState": {
+ "description": "The state of notifications feature.",
+ "enum": [
+ "None",
+ "Enabled",
+ "Disabled"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "NotificationsState",
+ "modelAsString": true
+ }
+ },
+ "NotificationSettings": {
+ "description": "Settings of change notification configuration for a subscription.",
+ "type": "object",
+ "properties": {
+ "azureMonitorWorkspaceProperties": {
+ "$ref": "#/definitions/AzureMonitorWorkspaceProperties"
+ },
+ "activationState": {
+ "$ref": "#/definitions/NotificationsState"
+ }
+ }
+ },
+ "ConfigurationProfileResourceProperties": {
+ "description": "The properties of a configuration profile.",
+ "type": "object",
+ "properties": {
+ "notifications": {
+ "$ref": "#/definitions/NotificationSettings"
+ }
+ }
+ },
+ "SystemData": {
+ "description": "Top level metadata https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-contracts.md#system-metadata-for-all-azure-resources",
+ "type": "object",
+ "properties": {
+ "createdBy": {
+ "description": "A string identifier for the identity that created the resource",
+ "type": "string",
+ "readOnly": true
+ },
+ "createdByType": {
+ "description": "The type of identity that created the resource: user, application, managedIdentity, key",
+ "type": "string",
+ "readOnly": true
+ },
+ "createdAt": {
+ "format": "date-time",
+ "description": "The timestamp of resource creation (UTC)",
+ "type": "string",
+ "readOnly": true
+ },
+ "lastModifiedBy": {
+ "description": "A string identifier for the identity that last modified the resource",
+ "type": "string",
+ "readOnly": true
+ },
+ "lastModifiedByType": {
+ "description": "The type of identity that last modified the resource: user, application, managedIdentity, key",
+ "type": "string",
+ "readOnly": true
+ },
+ "lastModifiedAt": {
+ "format": "date-time",
+ "description": "The timestamp of resource last modification (UTC)",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "ConfigurationProfileResource": {
+ "description": "A profile object that contains change analysis configuration, such as notification settings, for this subscription",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ProxyResource"
+ }
+ ],
+ "properties": {
+ "identity": {
+ "$ref": "#/definitions/ResourceIdentity"
+ },
+ "properties": {
+ "$ref": "#/definitions/ConfigurationProfileResourceProperties"
+ }
+ }
+ },
+ "ProxyResource": {
+ "description": "An Azure resource.",
+ "properties": {
+ "id": {
+ "description": "Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.",
+ "type": "string",
+ "readOnly": true
+ },
+ "name": {
+ "description": "The name of the resource.",
+ "type": "string",
+ "readOnly": true
+ },
+ "type": {
+ "description": "The type of the resource.",
+ "type": "string",
+ "readOnly": true
+ },
+ "systemData": {
+ "$ref": "#/definitions/SystemData"
+ }
+ },
+ "x-ms-azure-resource": true
+ },
+ "ResourceProviderOperationDisplay": {
+ "description": "The resource provider operation details.",
+ "type": "object",
+ "properties": {
+ "provider": {
+ "description": "Name of the resource provider.",
+ "type": "string"
+ },
+ "resource": {
+ "description": "Name of the resource type.",
+ "type": "string"
+ },
+ "operation": {
+ "description": "Name of the resource provider operation.",
+ "type": "string"
+ },
+ "description": {
+ "description": "Description of the resource provider operation.",
+ "type": "string"
+ }
+ }
+ },
+ "ResourceProviderOperationDefinition": {
+ "description": "The resource provider operation definition.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "The resource provider operation name.",
+ "type": "string"
+ },
+ "display": {
+ "$ref": "#/definitions/ResourceProviderOperationDisplay"
+ }
+ }
+ },
+ "ResourceProviderOperationList": {
+ "description": "The resource provider operation list.",
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "Resource provider operations list.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ResourceProviderOperationDefinition"
+ }
+ },
+ "nextLink": {
+ "description": "The URI that can be used to request the next page for list of Azure operations.",
+ "type": "string"
+ }
+ }
+ },
+ "Error": {
+ "description": "Unexpected Microsoft.ChangeAnalysis Resource Provider Error.",
+ "properties": {
+ "code": {
+ "description": "Error code.",
+ "type": "string"
+ },
+ "message": {
+ "description": "Error message.",
+ "type": "string"
+ }
+ }
+ }
+ },
+ "parameters": {
+ "ProfileNameParameter": {
+ "in": "path",
+ "name": "profileName",
+ "description": "The name of the configuration profile. The profile name should be set to 'default', all other names will be overwritten.",
+ "required": true,
+ "type": "string",
+ "pattern": "^(?!.*-$)[^-][a-zA-Z0-9-]*$",
+ "x-ms-parameter-location": "method"
+ },
+ "SubscriptionIdParameter": {
+ "in": "path",
+ "name": "subscriptionId",
+ "description": "The Microsoft Azure subscription ID.",
+ "required": true,
+ "type": "string"
+ },
+ "ApiVersionParameter": {
+ "in": "query",
+ "name": "api-version",
+ "description": "The resource provider API version.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "securityDefinitions": {
+ "azure_auth": {
+ "type": "oauth2",
+ "flow": "implicit",
+ "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize",
+ "scopes": {
+ "user_impersonation": "impersonate your user account"
+ },
+ "description": "Azure Active Directory OAuth2 Flow"
+ }
+ },
+ "security": [
+ {
+ "azure_auth": [
+ "user_impersonation"
+ ]
+ }
+ ]
+}
diff --git a/specification/changeanalysis/resource-manager/Microsoft.ChangeAnalysis/preview/2020-04-01-preview/examples/ConfigurationProfileCreate.json b/specification/changeanalysis/resource-manager/Microsoft.ChangeAnalysis/preview/2020-04-01-preview/examples/ConfigurationProfileCreate.json
new file mode 100644
index 000000000000..bd24d84d7d07
--- /dev/null
+++ b/specification/changeanalysis/resource-manager/Microsoft.ChangeAnalysis/preview/2020-04-01-preview/examples/ConfigurationProfileCreate.json
@@ -0,0 +1,26 @@
+{
+ "parameters": {
+ "subscriptionId": "c80fb759-c965-4c6a-9110-9b2b2d038882",
+ "profileName": "default",
+ "api-version": "2020-04-01-preview",
+ "resource": {}
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "type": "Microsoft.AppConfiguration/profile",
+ "properties": {
+ "notifications": {
+ "azureMonitorWorkspaceProperties": {
+ "workspaceId": null,
+ "workspaceResourceId": null
+ },
+ "activationState": "None"
+ }
+ },
+ "id": "/subscriptions/c80fb759-c965-4c6a-9110-9b2b2d038882/providers/Microsoft.ChangeAnalysis/profile/default",
+ "name": "default"
+ }
+ }
+ }
+}
diff --git a/specification/changeanalysis/resource-manager/Microsoft.ChangeAnalysis/preview/2020-04-01-preview/examples/ConfigurationProfileCreateWithIdentity.json b/specification/changeanalysis/resource-manager/Microsoft.ChangeAnalysis/preview/2020-04-01-preview/examples/ConfigurationProfileCreateWithIdentity.json
new file mode 100644
index 000000000000..09c9f23cba8d
--- /dev/null
+++ b/specification/changeanalysis/resource-manager/Microsoft.ChangeAnalysis/preview/2020-04-01-preview/examples/ConfigurationProfileCreateWithIdentity.json
@@ -0,0 +1,35 @@
+{
+ "parameters": {
+ "subscriptionId": "c80fb759-c965-4c6a-9110-9b2b2d038882",
+ "profileName": "default",
+ "api-version": "2020-04-01-preview",
+ "resource": {
+ "identity": {
+ "type": "SystemAssigned"
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "type": "Microsoft.ChangeAnalysis/profile",
+ "properties": {
+ "notifications": {
+ "azureMonitorWorkspaceProperties": {
+ "workspaceId": null,
+ "workspaceResourceId": null
+ },
+ "activationState": "None"
+ }
+ },
+ "identity": {
+ "principalId": "AAAAAAAA-AAAA-AAAA-AAAA-AAAAAAAAAAAA",
+ "tenantId": "BBBBBBBB-BBBB-BBBB-BBBB-BBBBBBBBBBBB",
+ "type": "SystemAssigned"
+ },
+ "id": "/subscriptions/c80fb759-c965-4c6a-9110-9b2b2d038882/providers/Microsoft.ChangeAnalysis/profile/default",
+ "name": "default"
+ }
+ }
+ }
+}
diff --git a/specification/changeanalysis/resource-manager/Microsoft.ChangeAnalysis/preview/2020-04-01-preview/examples/ConfigurationProfileDelete.json b/specification/changeanalysis/resource-manager/Microsoft.ChangeAnalysis/preview/2020-04-01-preview/examples/ConfigurationProfileDelete.json
new file mode 100644
index 000000000000..a30a48f30bf0
--- /dev/null
+++ b/specification/changeanalysis/resource-manager/Microsoft.ChangeAnalysis/preview/2020-04-01-preview/examples/ConfigurationProfileDelete.json
@@ -0,0 +1,11 @@
+{
+ "parameters": {
+ "subscriptionId": "c80fb759-c965-4c6a-9110-9b2b2d038882",
+ "profileName": "default",
+ "api-version": "2020-04-01-preview"
+ },
+ "responses": {
+ "200": {},
+ "204": {}
+ }
+}
diff --git a/specification/changeanalysis/resource-manager/Microsoft.ChangeAnalysis/preview/2020-04-01-preview/examples/ConfigurationProfileGet.json b/specification/changeanalysis/resource-manager/Microsoft.ChangeAnalysis/preview/2020-04-01-preview/examples/ConfigurationProfileGet.json
new file mode 100644
index 000000000000..9cc400f02bac
--- /dev/null
+++ b/specification/changeanalysis/resource-manager/Microsoft.ChangeAnalysis/preview/2020-04-01-preview/examples/ConfigurationProfileGet.json
@@ -0,0 +1,30 @@
+{
+ "parameters": {
+ "subscriptionId": "c80fb759-c965-4c6a-9110-9b2b2d038882",
+ "profileName": "default",
+ "api-version": "2020-04-01-preview"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "type": "Microsoft.ChangeAnalysis/profile",
+ "properties": {
+ "notifications": {
+ "azureMonitorWorkspaceProperties": {
+ "workspaceId": null,
+ "workspaceResourceId": null
+ },
+ "activationState": "None"
+ }
+ },
+ "identity": {
+ "principalId": "AAAAAAAA-AAAA-AAAA-AAAA-AAAAAAAAAAAA",
+ "tenantId": "BBBBBBBB-BBBB-BBBB-BBBB-BBBBBBBBBBBB",
+ "type": "SystemAssigned"
+ },
+ "id": "/subscriptions/c80fb759-c965-4c6a-9110-9b2b2d038882/providers/Microsoft.ChangeAnalysis/profile/default",
+ "name": "default"
+ }
+ }
+ }
+}
diff --git a/specification/changeanalysis/resource-manager/Microsoft.ChangeAnalysis/preview/2020-04-01-preview/examples/ConfigurationProfileUpdate.json b/specification/changeanalysis/resource-manager/Microsoft.ChangeAnalysis/preview/2020-04-01-preview/examples/ConfigurationProfileUpdate.json
new file mode 100644
index 000000000000..000c465f20ca
--- /dev/null
+++ b/specification/changeanalysis/resource-manager/Microsoft.ChangeAnalysis/preview/2020-04-01-preview/examples/ConfigurationProfileUpdate.json
@@ -0,0 +1,36 @@
+{
+ "parameters": {
+ "subscriptionId": "c80fb759-c965-4c6a-9110-9b2b2d038882",
+ "profileName": "default",
+ "api-version": "2020-04-01-preview",
+ "resource": {
+ "properties": {
+ "notifications": {
+ "azureMonitorWorkspaceProperties": {
+ "workspaceId": "workspaceIdValue",
+ "workspaceResourceId": "workspace resource Id"
+ },
+ "activationState": "Enabled"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "type": "Microsoft.ChangeAnalysis/profile",
+ "properties": {
+ "notifications": {
+ "azureMonitorWorkspaceProperties": {
+ "workspaceId": "workspaceIdValue",
+ "workspaceResourceId": "workspace resource Id"
+ },
+ "activationState": "Enabled"
+ }
+ }
+ },
+ "id": "/subscriptions/c80fb759-c965-4c6a-9110-9b2b2d038882/providers/Microsoft.ChangeAnalysis/profile/default",
+ "name": "default"
+ }
+ }
+}
diff --git a/specification/changeanalysis/resource-manager/Microsoft.ChangeAnalysis/preview/2020-04-01-preview/examples/ConfigurationProfileUpdateWithIdentity.json b/specification/changeanalysis/resource-manager/Microsoft.ChangeAnalysis/preview/2020-04-01-preview/examples/ConfigurationProfileUpdateWithIdentity.json
new file mode 100644
index 000000000000..3b06d6733ce9
--- /dev/null
+++ b/specification/changeanalysis/resource-manager/Microsoft.ChangeAnalysis/preview/2020-04-01-preview/examples/ConfigurationProfileUpdateWithIdentity.json
@@ -0,0 +1,44 @@
+{
+ "parameters": {
+ "subscriptionId": "c80fb759-c965-4c6a-9110-9b2b2d038882",
+ "profileName": "default",
+ "api-version": "2020-04-01-preview",
+ "resource": {
+ "properties": {
+ "notifications": {
+ "azureMonitorWorkspaceProperties": {
+ "workspaceId": "workspaceIdValue",
+ "workspaceResourceId": "workspace resource Id"
+ },
+ "activationState": "Enabled"
+ }
+ },
+ "identity": {
+ "type": "SystemAssigned"
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "type": "Microsoft.ChangeAnalysis/profile",
+ "properties": {
+ "notifications": {
+ "azureMonitorWorkspaceProperties": {
+ "workspaceId": "workspaceIdValue",
+ "workspaceResourceId": "workspace resource Id"
+ },
+ "activationState": "Enabled"
+ }
+ },
+ "identity": {
+ "principalId": "AAAAAAAA-AAAA-AAAA-AAAA-AAAAAAAAAAAA",
+ "tenantId": "BBBBBBBB-BBBB-BBBB-BBBB-BBBBBBBBBBBB",
+ "type": "SystemAssigned"
+ },
+ "id": "/subscriptions/c80fb759-c965-4c6a-9110-9b2b2d038882/providers/Microsoft.ChangeAnalysis/profile/default",
+ "name": "default"
+ }
+ }
+ }
+}
diff --git a/specification/changeanalysis/resource-manager/Microsoft.ChangeAnalysis/preview/2020-04-01-preview/examples/OperationsList.json b/specification/changeanalysis/resource-manager/Microsoft.ChangeAnalysis/preview/2020-04-01-preview/examples/OperationsList.json
new file mode 100644
index 000000000000..2d2000363115
--- /dev/null
+++ b/specification/changeanalysis/resource-manager/Microsoft.ChangeAnalysis/preview/2020-04-01-preview/examples/OperationsList.json
@@ -0,0 +1,37 @@
+{
+ "parameters": {
+ "api-version": "2020-04-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "name": "Microsoft.ChangeAnalysis/profile/read",
+ "display": {
+ "provider": "Microsoft Change Analysis",
+ "resource": "Azure Application Change Analysis Service Configuration Profile",
+ "operation": "Read Azure Application Change Analysis Servie Configuration Profile"
+ }
+ },
+ {
+ "name": "Microsoft.ChangeAnalysis/profile/write",
+ "display": {
+ "provider": "Microsoft Change Analysis",
+ "resource": "Azure Application Change Analysis Service Configuration Profile",
+ "operation": "Create or Update Azure Application Change Analysis Servie Configuration Profile Properties"
+ }
+ },
+ {
+ "name": "Microsoft.ChangeAnalysis/register/action",
+ "display": {
+ "provider": "Microsoft Change Analysis",
+ "resource": "",
+ "operation": "Register Microsoft Change Analysis resource provider with a subscriptions"
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/changeanalysis/resource-manager/readme.csharp.md b/specification/changeanalysis/resource-manager/readme.csharp.md
new file mode 100644
index 000000000000..8e5139845e12
--- /dev/null
+++ b/specification/changeanalysis/resource-manager/readme.csharp.md
@@ -0,0 +1,15 @@
+## C
+
+These settings apply only when `--csharp` is specified on the command line.
+Please also specify `--csharp-sdks-folder=`.
+
+```yaml $(csharp)
+csharp:
+ azure-arm: true
+ license-header: MICROSOFT_MIT_NO_VERSION
+ payload-flattening-threshold: 1
+ clear-output-folder: true
+ client-side-validation: false
+ namespace: Microsoft.ChangeAnalysis
+ output-folder: $(csharp-sdks-folder)/changeanalysis/management/Microsoft.ChangeAnalysis/GeneratedProtocol
+```
diff --git a/specification/changeanalysis/resource-manager/readme.go.md b/specification/changeanalysis/resource-manager/readme.go.md
new file mode 100644
index 000000000000..c2b2c0df4332
--- /dev/null
+++ b/specification/changeanalysis/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
+ clear-output-folder: true
+```
+
+### Tag: package-2020-04-01-preview and go
+
+These settings apply only when `--tag=package-2020-04-01-preview --go` is specified on the command line.
+Please also specify `--go-sdks-folder=`.
+
+```yaml $(tag) == 'package-2020-04-01-preview' && $(go)
+namespace: Microsoft.ChangeAnalysis
+output-folder: $(go-sdks-folder)/changeanalysis/Generated
+```
diff --git a/specification/changeanalysis/resource-manager/readme.md b/specification/changeanalysis/resource-manager/readme.md
new file mode 100644
index 000000000000..82bb9acfa298
--- /dev/null
+++ b/specification/changeanalysis/resource-manager/readme.md
@@ -0,0 +1,140 @@
+# changeanalysis
+
+> see https://aka.ms/autorest
+
+This is the AutoRest configuration file for changeanalysis.
+
+## 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 changeanalysis.
+
+``` yaml
+openapi-type: arm
+tag: package-2020-04-01-preview
+```
+
+### Tag: package-2020-04-01-preview
+
+These settings apply only when `--tag=package-2020-04-01-preview` is specified on the command line.
+
+``` yaml $(tag) == 'package-2020-04-01-preview'
+input-file:
+ - Microsoft.ChangeAnalysis/preview/2020-04-01-preview/changeanalysis.json
+
+```
+
+---
+
+# Code Generation
+
+## Swagger to SDK
+
+This section describes what SDK should be generated by the automatic system.
+This is not used by Autorest itself.
+
+``` yaml $(swagger-to-sdk)
+swagger-to-sdk:
+ - repo: azure-sdk-for-python
+ - repo: azure-sdk-for-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_changeanalysis']
+```
+
+## 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)
+
+## Suppression
+
+``` yaml
+directive:
+ - suppress: BodyTopLevelProperties
+ where: $.definitions.ConfigurationProfileResource.properties
+ from: changeanalysis.json
+ reason: |-
+ https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-contracts.md#system-metadata-for-all-azure-resources
+
+ The systemData should be top level element based on the new requirement:
+ {
+ "id": "/subscriptions/{id}/resourceGroups/{group}/providers/{rpns}/{type}/{name}",
+ "name": "{name}",
+ "type": "{resourceProviderNamespace}/{resourceType}",
+ "location": "North US",
+ "systemData":{
+ "createdBy": "",
+ "createdByType": "",
+ "createdAt": "",
+ "lastModifiedBy": "",
+ "lastModifiedByType": "",
+ "lastModifiedAt": ""
+ },
+ "tags": {
+ "key1": "value 1",
+ "key2": "value 2"
+ },
+ "kind": "resource kind",
+ "properties": {
+ "comment": "Resource defined structure"
+ }
+ }
+```
+
+## 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.ChangeAnalysis/preview/2020-04-01-preview/changeanalysis.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/changeanalysis/resource-manager/readme.python.md b/specification/changeanalysis/resource-manager/readme.python.md
new file mode 100644
index 000000000000..5bfa3618bd78
--- /dev/null
+++ b/specification/changeanalysis/resource-manager/readme.python.md
@@ -0,0 +1,21 @@
+## Python
+
+These settings apply only when `--python` is specified on the command line.
+Please also specify `--python-sdks-folder=`.
+
+```yaml $(python)
+python:
+ azure-arm: true
+ license-header: MICROSOFT_MIT_NO_VERSION
+ payload-flattening-threshold: 2
+ namespace: Microsoft.ChangeAnalysis
+ package-name: changeanalysis
+ package-version: 2020-04-01-preview
+ clear-output-folder: true
+```
+
+```yaml $(python)
+python:
+ no-namespace-folders: true
+ output-folder: $(python-sdks-folder)/azure-mgmt/changeanalysis
+```
diff --git a/specification/changeanalysis/resource-manager/readme.ruby.md b/specification/changeanalysis/resource-manager/readme.ruby.md
new file mode 100644
index 000000000000..7b7265a1b2ca
--- /dev/null
+++ b/specification/changeanalysis/resource-manager/readme.ruby.md
@@ -0,0 +1,19 @@
+## Ruby
+
+These settings apply only when `--ruby` is specified on the command line.
+
+```yaml
+package-name: azure_mgmt_changeanalysis
+package-version: 2020-04-01-preview
+azure-arm: true
+```
+
+### Tag: package-2020-04-01-preview and ruby
+
+These settings apply only when `--tag=package-2020-04-01-preview --ruby` is specified on the command line.
+Please also specify `--ruby-sdks-folder=`.
+
+```yaml $(tag) == 'package-2020-04-01-preview' && $(ruby)
+namespace: Microsoft.ChangeAnalysis
+output-folder: $(ruby-sdks-folder)/changeanalysis
+```
diff --git a/specification/changeanalysis/resource-manager/readme.typescript.md b/specification/changeanalysis/resource-manager/readme.typescript.md
new file mode 100644
index 000000000000..63e73c265818
--- /dev/null
+++ b/specification/changeanalysis/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: "changeanalysis"
+ output-folder: "$(typescript-sdks-folder)/packages/changeanalysis"
+ payload-flattening-threshold: 1
+ generate-metadata: true
+```
diff --git a/specification/cognitiveservices/data-plane/AnomalyDetector/preview/v1.0/AnomalyDetector.json b/specification/cognitiveservices/data-plane/AnomalyDetector/preview/v1.0/AnomalyDetector.json
index 8a3f2b3797fc..ac5d89494132 100644
--- a/specification/cognitiveservices/data-plane/AnomalyDetector/preview/v1.0/AnomalyDetector.json
+++ b/specification/cognitiveservices/data-plane/AnomalyDetector/preview/v1.0/AnomalyDetector.json
@@ -188,7 +188,7 @@
},
"Granularity": {
"type": "string",
- "description": "Can only be one of yearly, monthly, weekly, daily, hourly or minutely. Granularity is used for verify whether input series is valid.",
+ "description": "Can only be one of yearly, monthly, weekly, daily, hourly, minutely or secondly. Granularity is used for verify whether input series is valid.",
"x-nullable": false,
"x-ms-enum": {
"name": "Granularity",
@@ -200,7 +200,8 @@
"weekly",
"daily",
"hourly",
- "minutely"
+ "minutely",
+ "secondly"
]
},
"CustomInterval": {
@@ -404,7 +405,7 @@
},
"granularity": {
"$ref": "#/definitions/Granularity",
- "description": "Can only be one of yearly, monthly, weekly, daily, hourly or minutely. Granularity is used for verify whether input series is valid."
+ "description": "Can only be one of yearly, monthly, weekly, daily, hourly, minutely or secondly. Granularity is used for verify whether input series is valid."
},
"customInterval": {
"description": "Custom Interval is used to set non-standard time interval, for example, if the series is 5 minutes, request can be set as {\"granularity\":\"minutely\", \"customInterval\":5}.",
diff --git a/specification/cognitiveservices/data-plane/ComputerVision/readme.go.md b/specification/cognitiveservices/data-plane/ComputerVision/readme.go.md
index 3696b8eb182f..8fb795822422 100644
--- a/specification/cognitiveservices/data-plane/ComputerVision/readme.go.md
+++ b/specification/cognitiveservices/data-plane/ComputerVision/readme.go.md
@@ -42,5 +42,5 @@ These settings apply only when `--tag=release_3_0 --go` is specified on the comm
Please also specify `--go-sdk-folder=`.
``` yaml $(tag) == 'release_3_0' && $(go)
-output-folder: $(go-sdk-folder)/services/preview/cognitiveservices/v3.0-preview/$(namespace)
+output-folder: $(go-sdk-folder)/services/cognitiveservices/v3.0/$(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 31c01fd4644b..020fca003e1d 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_2_1`.
+The current release is `release_3_0`.
``` yaml
-tag: release_2_1
+tag: release_3_0
add-credentials: true
openapi-type: data-plane
```
@@ -32,12 +32,21 @@ input-file:
- stable/v2.1/Ocr.json
```
+### Release 3.0-preview
+These settings apply only when `--tag=release_3_0_preview` is specified on the command line.
+
+``` yaml $(tag) == 'release_3_0_preview'
+input-file:
+ - preview/v3.0-preview/Ocr.json
+```
+
### Release 3.0
These settings apply only when `--tag=release_3_0` is specified on the command line.
``` yaml $(tag) == 'release_3_0'
input-file:
- - preview/v3.0-preview/Ocr.json
+ - stable/v3.0/ComputerVision.json
+ - stable/v3.0/Ocr.json
```
## Swagger to SDK
@@ -155,6 +164,8 @@ input-file:
- $(this-folder)/stable/v2.1/ComputerVision.json
- $(this-folder)/stable/v2.1/Ocr.json
- $(this-folder)/preview/v3.0-preview/Ocr.json
+ - $(this-folder)/stable/v3.0/ComputerVision.json
+ - $(this-folder)/stable/v3.0/Ocr.json
```
diff --git a/specification/cognitiveservices/data-plane/ComputerVision/readme.ruby.md b/specification/cognitiveservices/data-plane/ComputerVision/readme.ruby.md
index 543dbe567e1d..019525023fad 100644
--- a/specification/cognitiveservices/data-plane/ComputerVision/readme.ruby.md
+++ b/specification/cognitiveservices/data-plane/ComputerVision/readme.ruby.md
@@ -31,3 +31,14 @@ namespace: "Azure::CognitiveServices::ComputerVision::V2_1"
output-folder: $(ruby-sdks-folder)/data/azure_cognitiveservices_computervision/lib
title: "ComputerVisionClient"
```
+
+### Tag: release_3_0 and ruby
+
+These settings apply only when `--tag=release_3_0 --ruby` is specified on the command line.
+Please also specify `--ruby-sdks-folder=`.
+
+``` yaml $(tag) == 'release_3_0' && $(ruby)
+namespace: "Azure::CognitiveServices::ComputerVision::V3_0"
+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.0/ComputerVision.json b/specification/cognitiveservices/data-plane/ComputerVision/stable/v3.0/ComputerVision.json
new file mode 100644
index 000000000000..4ffa82212a66
--- /dev/null
+++ b/specification/cognitiveservices/data-plane/ComputerVision/stable/v3.0/ComputerVision.json
@@ -0,0 +1,1840 @@
+{
+ "swagger": "2.0",
+ "info": {
+ "version": "3.0",
+ "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.0",
+ "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.0/Ocr.json b/specification/cognitiveservices/data-plane/ComputerVision/stable/v3.0/Ocr.json
new file mode 100644
index 000000000000..2017f16c1671
--- /dev/null
+++ b/specification/cognitiveservices/data-plane/ComputerVision/stable/v3.0/Ocr.json
@@ -0,0 +1,452 @@
+{
+ "swagger": "2.0",
+ "info": {
+ "version": "3.0",
+ "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.0",
+ "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 multilanguage 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.0/examples/SuccessfulAnalyzeImageByDomainWithStream.json b/specification/cognitiveservices/data-plane/ComputerVision/stable/v3.0/examples/SuccessfulAnalyzeImageByDomainWithStream.json
new file mode 100644
index 000000000000..a3cd00555cc6
--- /dev/null
+++ b/specification/cognitiveservices/data-plane/ComputerVision/stable/v3.0/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.0/examples/SuccessfulAnalyzeImageByDomainWithUrl.json b/specification/cognitiveservices/data-plane/ComputerVision/stable/v3.0/examples/SuccessfulAnalyzeImageByDomainWithUrl.json
new file mode 100644
index 000000000000..92ead72b5f8f
--- /dev/null
+++ b/specification/cognitiveservices/data-plane/ComputerVision/stable/v3.0/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.0/examples/SuccessfulAnalyzeImageWithStream.json b/specification/cognitiveservices/data-plane/ComputerVision/stable/v3.0/examples/SuccessfulAnalyzeImageWithStream.json
new file mode 100644
index 000000000000..ba86791a7e36
--- /dev/null
+++ b/specification/cognitiveservices/data-plane/ComputerVision/stable/v3.0/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.0/examples/SuccessfulAnalyzeImageWithUrl.json b/specification/cognitiveservices/data-plane/ComputerVision/stable/v3.0/examples/SuccessfulAnalyzeImageWithUrl.json
new file mode 100644
index 000000000000..be78226e0e16
--- /dev/null
+++ b/specification/cognitiveservices/data-plane/ComputerVision/stable/v3.0/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.0/examples/SuccessfulDescribeImageWithStream.json b/specification/cognitiveservices/data-plane/ComputerVision/stable/v3.0/examples/SuccessfulDescribeImageWithStream.json
new file mode 100644
index 000000000000..071248140600
--- /dev/null
+++ b/specification/cognitiveservices/data-plane/ComputerVision/stable/v3.0/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.0/examples/SuccessfulDescribeImageWithUrl.json b/specification/cognitiveservices/data-plane/ComputerVision/stable/v3.0/examples/SuccessfulDescribeImageWithUrl.json
new file mode 100644
index 000000000000..087ac0515231
--- /dev/null
+++ b/specification/cognitiveservices/data-plane/ComputerVision/stable/v3.0/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.0/examples/SuccessfulDetectObjectsWithStream.json b/specification/cognitiveservices/data-plane/ComputerVision/stable/v3.0/examples/SuccessfulDetectObjectsWithStream.json
new file mode 100644
index 000000000000..8f4ad7fd73aa
--- /dev/null
+++ b/specification/cognitiveservices/data-plane/ComputerVision/stable/v3.0/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.0/examples/SuccessfulDetectObjectsWithUrl.json b/specification/cognitiveservices/data-plane/ComputerVision/stable/v3.0/examples/SuccessfulDetectObjectsWithUrl.json
new file mode 100644
index 000000000000..7ea387eb41be
--- /dev/null
+++ b/specification/cognitiveservices/data-plane/ComputerVision/stable/v3.0/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.0/examples/SuccessfulGenerateThumbnailWithStream.json b/specification/cognitiveservices/data-plane/ComputerVision/stable/v3.0/examples/SuccessfulGenerateThumbnailWithStream.json
new file mode 100644
index 000000000000..22d52fbe7644
--- /dev/null
+++ b/specification/cognitiveservices/data-plane/ComputerVision/stable/v3.0/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.0/examples/SuccessfulGenerateThumbnailWithUrl.json b/specification/cognitiveservices/data-plane/ComputerVision/stable/v3.0/examples/SuccessfulGenerateThumbnailWithUrl.json
new file mode 100644
index 000000000000..28744179ecb8
--- /dev/null
+++ b/specification/cognitiveservices/data-plane/ComputerVision/stable/v3.0/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.0/examples/SuccessfulGetAreaOfInterestWithStream.json b/specification/cognitiveservices/data-plane/ComputerVision/stable/v3.0/examples/SuccessfulGetAreaOfInterestWithStream.json
new file mode 100644
index 000000000000..ae32a21a551e
--- /dev/null
+++ b/specification/cognitiveservices/data-plane/ComputerVision/stable/v3.0/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.0/examples/SuccessfulGetAreaOfInterestWithUrl.json b/specification/cognitiveservices/data-plane/ComputerVision/stable/v3.0/examples/SuccessfulGetAreaOfInterestWithUrl.json
new file mode 100644
index 000000000000..7d6d08208836
--- /dev/null
+++ b/specification/cognitiveservices/data-plane/ComputerVision/stable/v3.0/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.0/examples/SuccessfulGetReadResult.json b/specification/cognitiveservices/data-plane/ComputerVision/stable/v3.0/examples/SuccessfulGetReadResult.json
new file mode 100644
index 000000000000..aaaa9df00c50
--- /dev/null
+++ b/specification/cognitiveservices/data-plane/ComputerVision/stable/v3.0/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.0",
+ "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.0/examples/SuccessfulListModels.json b/specification/cognitiveservices/data-plane/ComputerVision/stable/v3.0/examples/SuccessfulListModels.json
new file mode 100644
index 000000000000..54e72d376431
--- /dev/null
+++ b/specification/cognitiveservices/data-plane/ComputerVision/stable/v3.0/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.0/examples/SuccessfulReadWithStream.json b/specification/cognitiveservices/data-plane/ComputerVision/stable/v3.0/examples/SuccessfulReadWithStream.json
new file mode 100644
index 000000000000..a901d16abba0
--- /dev/null
+++ b/specification/cognitiveservices/data-plane/ComputerVision/stable/v3.0/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.0/read/e56ffa6e-1ee4-4042-bc07-993db706c95f"
+ }
+ }
+ }
+}
diff --git a/specification/cognitiveservices/data-plane/ComputerVision/stable/v3.0/examples/SuccessfulReadWithUrl.json b/specification/cognitiveservices/data-plane/ComputerVision/stable/v3.0/examples/SuccessfulReadWithUrl.json
new file mode 100644
index 000000000000..642e44b140c0
--- /dev/null
+++ b/specification/cognitiveservices/data-plane/ComputerVision/stable/v3.0/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.0/read/e56ffa6e-1ee4-4042-bc07-993db706c95f"
+ }
+ }
+ }
+}
diff --git a/specification/cognitiveservices/data-plane/ComputerVision/stable/v3.0/examples/SuccessfulRecognizePrintedTextWithStream.json b/specification/cognitiveservices/data-plane/ComputerVision/stable/v3.0/examples/SuccessfulRecognizePrintedTextWithStream.json
new file mode 100644
index 000000000000..201d0fe48254
--- /dev/null
+++ b/specification/cognitiveservices/data-plane/ComputerVision/stable/v3.0/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.0/examples/SuccessfulRecognizePrintedTextWithUrl.json b/specification/cognitiveservices/data-plane/ComputerVision/stable/v3.0/examples/SuccessfulRecognizePrintedTextWithUrl.json
new file mode 100644
index 000000000000..a0b8bc84e37b
--- /dev/null
+++ b/specification/cognitiveservices/data-plane/ComputerVision/stable/v3.0/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.0/examples/SuccessfulTagImageWithStream.json b/specification/cognitiveservices/data-plane/ComputerVision/stable/v3.0/examples/SuccessfulTagImageWithStream.json
new file mode 100644
index 000000000000..813a645d0086
--- /dev/null
+++ b/specification/cognitiveservices/data-plane/ComputerVision/stable/v3.0/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.0/examples/SuccessfulTagImageWithUrl.json b/specification/cognitiveservices/data-plane/ComputerVision/stable/v3.0/examples/SuccessfulTagImageWithUrl.json
new file mode 100644
index 000000000000..0dcf0304a33a
--- /dev/null
+++ b/specification/cognitiveservices/data-plane/ComputerVision/stable/v3.0/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/CustomVision/Prediction/readme.go.md b/specification/cognitiveservices/data-plane/CustomVision/Prediction/readme.go.md
index 279452db4ec0..33b14c7856fe 100644
--- a/specification/cognitiveservices/data-plane/CustomVision/Prediction/readme.go.md
+++ b/specification/cognitiveservices/data-plane/CustomVision/Prediction/readme.go.md
@@ -15,6 +15,7 @@ go:
batch:
- tag: release_1_0
- tag: release_3_0
+ - tag: release_3_1
```
### Tag: release_1_0 and go
@@ -34,3 +35,12 @@ Please also specify `--go-sdk-folder=`.
+
+``` yaml $(tag) == 'release_3_0' && $(go)
+output-folder: $(go-sdk-folder)/services/cognitiveservices/v3.1/customvision/$(namespace)
+```
diff --git a/specification/cognitiveservices/data-plane/CustomVision/Prediction/readme.md b/specification/cognitiveservices/data-plane/CustomVision/Prediction/readme.md
index 74cffe566389..1441a4a7fcad 100644
--- a/specification/cognitiveservices/data-plane/CustomVision/Prediction/readme.md
+++ b/specification/cognitiveservices/data-plane/CustomVision/Prediction/readme.md
@@ -4,11 +4,11 @@
Configuration for generating Custom Vision Prediction SDK.
-The current release is `release_3_0`.
+The current release is `release_3_1`.
``` yaml
-tag: release_3_0
+tag: release_3_1
openapi-type: data-plane
```
# Releases
@@ -28,6 +28,14 @@ input-file: stable/v3.0/Prediction.json
add-credentials: true
```
+### 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/Prediction.json
+add-credentials: true
+```
+
# Validation
## Suppression
diff --git a/specification/cognitiveservices/data-plane/CustomVision/Prediction/readme.ruby.md b/specification/cognitiveservices/data-plane/CustomVision/Prediction/readme.ruby.md
index 3adbf19106d6..4e7d49eafbb3 100644
--- a/specification/cognitiveservices/data-plane/CustomVision/Prediction/readme.ruby.md
+++ b/specification/cognitiveservices/data-plane/CustomVision/Prediction/readme.ruby.md
@@ -14,6 +14,7 @@ azure-arm: true
batch:
- tag: release_1_0
- tag: release_3_0
+ - tag: release_3_1
```
### Tag: release_1_0 and ruby
@@ -37,3 +38,14 @@ namespace: "Azure::CognitiveServices::CustomVision::Prediction::V3_0"
output-folder: $(ruby-sdks-folder)/data/azure_cognitiveservices_customvisionprediction/lib
title: "PredictionClient"
```
+
+### Tag: release_3_1 and ruby
+
+These settings apply only when `--tag=release_3_1 --ruby` is specified on the command line.
+Please also specify `--ruby-sdks-folder=`.
+
+``` yaml $(tag) == 'release_1_0' && $(ruby)
+namespace: "Azure::CognitiveServices::CustomVision::Prediction::V3_1"
+output-folder: $(ruby-sdks-folder)/data/azure_cognitiveservices_customvisionprediction/lib
+title: "PredictionClient"
+```
\ No newline at end of file
diff --git a/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.1/Prediction.json b/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.1/Prediction.json
new file mode 100644
index 000000000000..4f5dca22f52d
--- /dev/null
+++ b/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.1/Prediction.json
@@ -0,0 +1,922 @@
+{
+ "swagger": "2.0",
+ "info": {
+ "version": "3.1",
+ "title": "Custom Vision Prediction Client"
+ },
+ "host": "southcentralus.api.cognitive.microsoft.com",
+ "basePath": "/customvision/v3.1/prediction",
+ "schemes": [
+ "https"
+ ],
+ "paths": {
+ "/{projectId}/classify/iterations/{publishedName}/image": {
+ "post": {
+ "tags": [
+ "ImagePredictionApi"
+ ],
+ "summary": "Classify an image and saves the result.",
+ "operationId": "ClassifyImage",
+ "consumes": [
+ "multipart/form-data",
+ "application/octet-stream"
+ ],
+ "produces": [
+ "application/json",
+ "application/xml",
+ "text/xml"
+ ],
+ "parameters": [
+ {
+ "name": "projectId",
+ "in": "path",
+ "description": "The project id.",
+ "required": true,
+ "type": "string",
+ "format": "uuid",
+ "x-nullable": false
+ },
+ {
+ "name": "publishedName",
+ "in": "path",
+ "description": "Specifies the name of the model to evaluate against.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "application",
+ "in": "query",
+ "description": "Optional. Specifies the name of application using the endpoint.",
+ "required": false,
+ "type": "string",
+ "x-nullable": true
+ },
+ {
+ "name": "imageData",
+ "in": "formData",
+ "description": "Binary image data. Supported formats are JPEG, GIF, PNG, and BMP. Supports images up to 4MB.",
+ "required": true,
+ "type": "file"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/ImagePrediction"
+ }
+ },
+ "default": {
+ "description": "Error response",
+ "schema": {
+ "$ref": "#/definitions/CustomVisionError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Successful ClassifyImage request": {
+ "$ref": "./examples/ClassifyImage.json"
+ }
+ }
+ }
+ },
+ "/{projectId}/classify/iterations/{publishedName}/image/nostore": {
+ "post": {
+ "tags": [
+ "ImagePredictionApi"
+ ],
+ "summary": "Classify an image without saving the result.",
+ "operationId": "ClassifyImageWithNoStore",
+ "consumes": [
+ "multipart/form-data",
+ "application/octet-stream"
+ ],
+ "produces": [
+ "application/json",
+ "application/xml",
+ "text/xml"
+ ],
+ "parameters": [
+ {
+ "name": "projectId",
+ "in": "path",
+ "description": "The project id.",
+ "required": true,
+ "type": "string",
+ "format": "uuid",
+ "x-nullable": false
+ },
+ {
+ "name": "publishedName",
+ "in": "path",
+ "description": "Specifies the name of the model to evaluate against.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "application",
+ "in": "query",
+ "description": "Optional. Specifies the name of application using the endpoint.",
+ "required": false,
+ "type": "string",
+ "x-nullable": true
+ },
+ {
+ "name": "imageData",
+ "in": "formData",
+ "description": "Binary image data. Supported formats are JPEG, GIF, PNG, and BMP. Supports images up to 4MB.",
+ "required": true,
+ "type": "file"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/ImagePrediction"
+ }
+ },
+ "default": {
+ "description": "Error response",
+ "schema": {
+ "$ref": "#/definitions/CustomVisionError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Successful ClassifyImageWithNoStore request": {
+ "$ref": "./examples/ClassifyImageWithNoStore.json"
+ }
+ }
+ }
+ },
+ "/{projectId}/classify/iterations/{publishedName}/url": {
+ "post": {
+ "tags": [
+ "ImagePredictionApi"
+ ],
+ "summary": "Classify an image url and saves the result.",
+ "operationId": "ClassifyImageUrl",
+ "consumes": [
+ "application/json",
+ "application/xml",
+ "text/xml",
+ "application/x-www-form-urlencoded"
+ ],
+ "produces": [
+ "application/json",
+ "application/xml",
+ "text/xml"
+ ],
+ "parameters": [
+ {
+ "name": "projectId",
+ "in": "path",
+ "description": "The project id.",
+ "required": true,
+ "type": "string",
+ "format": "uuid",
+ "x-nullable": false
+ },
+ {
+ "name": "publishedName",
+ "in": "path",
+ "description": "Specifies the name of the model to evaluate against.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "imageUrl",
+ "in": "body",
+ "description": "An ImageUrl that contains the url of the image to be evaluated.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/ImageUrl"
+ }
+ },
+ {
+ "name": "application",
+ "in": "query",
+ "description": "Optional. Specifies the name of application using the endpoint.",
+ "required": false,
+ "type": "string",
+ "x-nullable": true
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/ImagePrediction"
+ }
+ },
+ "default": {
+ "description": "Error response",
+ "schema": {
+ "$ref": "#/definitions/CustomVisionError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Successful ClassifyImageUrl request": {
+ "$ref": "./examples/ClassifyImageUrl.json"
+ }
+ }
+ }
+ },
+ "/{projectId}/classify/iterations/{publishedName}/url/nostore": {
+ "post": {
+ "tags": [
+ "ImagePredictionApi"
+ ],
+ "summary": "Classify an image url without saving the result.",
+ "operationId": "ClassifyImageUrlWithNoStore",
+ "consumes": [
+ "application/json",
+ "application/xml",
+ "text/xml",
+ "application/x-www-form-urlencoded"
+ ],
+ "produces": [
+ "application/json",
+ "application/xml",
+ "text/xml"
+ ],
+ "parameters": [
+ {
+ "name": "projectId",
+ "in": "path",
+ "description": "The project id.",
+ "required": true,
+ "type": "string",
+ "format": "uuid",
+ "x-nullable": false
+ },
+ {
+ "name": "publishedName",
+ "in": "path",
+ "description": "Specifies the name of the model to evaluate against.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "imageUrl",
+ "in": "body",
+ "description": "An {Iris.Web.Api.Models.ImageUrl} that contains the url of the image to be evaluated.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/ImageUrl"
+ }
+ },
+ {
+ "name": "application",
+ "in": "query",
+ "description": "Optional. Specifies the name of application using the endpoint.",
+ "required": false,
+ "type": "string",
+ "x-nullable": true
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/ImagePrediction"
+ }
+ },
+ "default": {
+ "description": "Error response",
+ "schema": {
+ "$ref": "#/definitions/CustomVisionError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Successful ClassifyImageUrlWithNoStore request": {
+ "$ref": "./examples/ClassifyImageUrlWithNoStore.json"
+ }
+ }
+ }
+ },
+ "/{projectId}/detect/iterations/{publishedName}/image": {
+ "post": {
+ "tags": [
+ "ImagePredictionApi"
+ ],
+ "summary": "Detect objects in an image and saves the result.",
+ "operationId": "DetectImage",
+ "consumes": [
+ "multipart/form-data",
+ "application/octet-stream"
+ ],
+ "produces": [
+ "application/json",
+ "application/xml",
+ "text/xml"
+ ],
+ "parameters": [
+ {
+ "name": "projectId",
+ "in": "path",
+ "description": "The project id.",
+ "required": true,
+ "type": "string",
+ "format": "uuid",
+ "x-nullable": false
+ },
+ {
+ "name": "publishedName",
+ "in": "path",
+ "description": "Specifies the name of the model to evaluate against.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "application",
+ "in": "query",
+ "description": "Optional. Specifies the name of application using the endpoint.",
+ "required": false,
+ "type": "string",
+ "x-nullable": true
+ },
+ {
+ "name": "imageData",
+ "in": "formData",
+ "description": "Binary image data. Supported formats are JPEG, GIF, PNG, and BMP. Supports images up to 4MB.",
+ "required": true,
+ "type": "file"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/ImagePrediction"
+ }
+ },
+ "default": {
+ "description": "Error response",
+ "schema": {
+ "$ref": "#/definitions/CustomVisionError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Successful DetectImage request": {
+ "$ref": "./examples/DetectImage.json"
+ }
+ }
+ }
+ },
+ "/{projectId}/detect/iterations/{publishedName}/image/nostore": {
+ "post": {
+ "tags": [
+ "ImagePredictionApi"
+ ],
+ "summary": "Detect objects in an image without saving the result.",
+ "operationId": "DetectImageWithNoStore",
+ "consumes": [
+ "multipart/form-data",
+ "application/octet-stream"
+ ],
+ "produces": [
+ "application/json",
+ "application/xml",
+ "text/xml"
+ ],
+ "parameters": [
+ {
+ "name": "projectId",
+ "in": "path",
+ "description": "The project id.",
+ "required": true,
+ "type": "string",
+ "format": "uuid",
+ "x-nullable": false
+ },
+ {
+ "name": "publishedName",
+ "in": "path",
+ "description": "Specifies the name of the model to evaluate against.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "application",
+ "in": "query",
+ "description": "Optional. Specifies the name of application using the endpoint.",
+ "required": false,
+ "type": "string",
+ "x-nullable": true
+ },
+ {
+ "name": "imageData",
+ "in": "formData",
+ "description": "Binary image data. Supported formats are JPEG, GIF, PNG, and BMP. Supports images up to 4MB.",
+ "required": true,
+ "type": "file"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/ImagePrediction"
+ }
+ },
+ "default": {
+ "description": "Error response",
+ "schema": {
+ "$ref": "#/definitions/CustomVisionError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Successful DetectImageWithNoStore request": {
+ "$ref": "./examples/DetectImageWithNoStore.json"
+ }
+ }
+ }
+ },
+ "/{projectId}/detect/iterations/{publishedName}/url": {
+ "post": {
+ "tags": [
+ "ImagePredictionApi"
+ ],
+ "summary": "Detect objects in an image url and saves the result.",
+ "operationId": "DetectImageUrl",
+ "consumes": [
+ "application/json",
+ "application/xml",
+ "text/xml",
+ "application/x-www-form-urlencoded"
+ ],
+ "produces": [
+ "application/json",
+ "application/xml",
+ "text/xml"
+ ],
+ "parameters": [
+ {
+ "name": "projectId",
+ "in": "path",
+ "description": "The project id.",
+ "required": true,
+ "type": "string",
+ "format": "uuid",
+ "x-nullable": false
+ },
+ {
+ "name": "publishedName",
+ "in": "path",
+ "description": "Specifies the name of the model to evaluate against.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "imageUrl",
+ "in": "body",
+ "description": "An ImageUrl that contains the url of the image to be evaluated.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/ImageUrl"
+ }
+ },
+ {
+ "name": "application",
+ "in": "query",
+ "description": "Optional. Specifies the name of application using the endpoint.",
+ "required": false,
+ "type": "string",
+ "x-nullable": true
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/ImagePrediction"
+ }
+ },
+ "default": {
+ "description": "Error response",
+ "schema": {
+ "$ref": "#/definitions/CustomVisionError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Successful DetectImageUrl request": {
+ "$ref": "./examples/DetectImageUrl.json"
+ }
+ }
+ }
+ },
+ "/{projectId}/detect/iterations/{publishedName}/url/nostore": {
+ "post": {
+ "tags": [
+ "ImagePredictionApi"
+ ],
+ "summary": "Detect objects in an image url without saving the result.",
+ "operationId": "DetectImageUrlWithNoStore",
+ "consumes": [
+ "application/json",
+ "application/xml",
+ "text/xml",
+ "application/x-www-form-urlencoded"
+ ],
+ "produces": [
+ "application/json",
+ "application/xml",
+ "text/xml"
+ ],
+ "parameters": [
+ {
+ "name": "projectId",
+ "in": "path",
+ "description": "The project id.",
+ "required": true,
+ "type": "string",
+ "format": "uuid",
+ "x-nullable": false
+ },
+ {
+ "name": "publishedName",
+ "in": "path",
+ "description": "Specifies the name of the model to evaluate against.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "imageUrl",
+ "in": "body",
+ "description": "An {Iris.Web.Api.Models.ImageUrl} that contains the url of the image to be evaluated.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/ImageUrl"
+ }
+ },
+ {
+ "name": "application",
+ "in": "query",
+ "description": "Optional. Specifies the name of application using the endpoint.",
+ "required": false,
+ "type": "string",
+ "x-nullable": true
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/ImagePrediction"
+ }
+ },
+ "default": {
+ "description": "Error response",
+ "schema": {
+ "$ref": "#/definitions/CustomVisionError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Successful DetectImageUrlWithNoStore request": {
+ "$ref": "./examples/DetectImageUrlWithNoStore.json"
+ }
+ }
+ }
+ }
+ },
+ "definitions": {
+ "BoundingBox": {
+ "description": "Bounding box that defines a region of an image.",
+ "required": [
+ "left",
+ "top",
+ "width",
+ "height"
+ ],
+ "type": "object",
+ "properties": {
+ "left": {
+ "format": "float",
+ "description": "Coordinate of the left boundary.",
+ "type": "number",
+ "readOnly": false,
+ "x-nullable": false
+ },
+ "top": {
+ "format": "float",
+ "description": "Coordinate of the top boundary.",
+ "type": "number",
+ "readOnly": false,
+ "x-nullable": false
+ },
+ "width": {
+ "format": "float",
+ "description": "Width.",
+ "type": "number",
+ "readOnly": false,
+ "x-nullable": false
+ },
+ "height": {
+ "format": "float",
+ "description": "Height.",
+ "type": "number",
+ "readOnly": false,
+ "x-nullable": false
+ }
+ }
+ },
+ "CustomVisionError": {
+ "required": [
+ "code",
+ "message"
+ ],
+ "type": "object",
+ "properties": {
+ "code": {
+ "description": "The error code.",
+ "enum": [
+ "NoError",
+ "BadRequest",
+ "BadRequestExceededBatchSize",
+ "BadRequestNotSupported",
+ "BadRequestInvalidIds",
+ "BadRequestProjectName",
+ "BadRequestProjectNameNotUnique",
+ "BadRequestProjectDescription",
+ "BadRequestProjectUnknownDomain",
+ "BadRequestProjectUnknownClassification",
+ "BadRequestProjectUnsupportedDomainTypeChange",
+ "BadRequestProjectUnsupportedExportPlatform",
+ "BadRequestProjectImagePreprocessingSettings",
+ "BadRequestProjectDuplicated",
+ "BadRequestIterationName",
+ "BadRequestIterationNameNotUnique",
+ "BadRequestIterationDescription",
+ "BadRequestIterationIsNotTrained",
+ "BadRequestIterationValidationFailed",
+ "BadRequestWorkspaceCannotBeModified",
+ "BadRequestWorkspaceNotDeletable",
+ "BadRequestTagName",
+ "BadRequestTagNameNotUnique",
+ "BadRequestTagDescription",
+ "BadRequestTagType",
+ "BadRequestMultipleNegativeTag",
+ "BadRequestMultipleGeneralProductTag",
+ "BadRequestImageTags",
+ "BadRequestImageRegions",
+ "BadRequestNegativeAndRegularTagOnSameImage",
+ "BadRequestUnsupportedDomain",
+ "BadRequestRequiredParamIsNull",
+ "BadRequestIterationIsPublished",
+ "BadRequestInvalidPublishName",
+ "BadRequestInvalidPublishTarget",
+ "BadRequestUnpublishFailed",
+ "BadRequestIterationNotPublished",
+ "BadRequestSubscriptionApi",
+ "BadRequestExceedProjectLimit",
+ "BadRequestExceedIterationPerProjectLimit",
+ "BadRequestExceedTagPerProjectLimit",
+ "BadRequestExceedTagPerImageLimit",
+ "BadRequestExceededQuota",
+ "BadRequestCannotMigrateProjectWithName",
+ "BadRequestNotLimitedTrial",
+ "BadRequestImageBatch",
+ "BadRequestImageStream",
+ "BadRequestImageUrl",
+ "BadRequestImageFormat",
+ "BadRequestImageSizeBytes",
+ "BadRequestImageDimensions",
+ "BadRequestImageExceededCount",
+ "BadRequestTrainingNotNeeded",
+ "BadRequestTrainingNotNeededButTrainingPipelineUpdated",
+ "BadRequestTrainingValidationFailed",
+ "BadRequestClassificationTrainingValidationFailed",
+ "BadRequestMultiClassClassificationTrainingValidationFailed",
+ "BadRequestMultiLabelClassificationTrainingValidationFailed",
+ "BadRequestDetectionTrainingValidationFailed",
+ "BadRequestTrainingAlreadyInProgress",
+ "BadRequestDetectionTrainingNotAllowNegativeTag",
+ "BadRequestInvalidEmailAddress",
+ "BadRequestDomainNotSupportedForAdvancedTraining",
+ "BadRequestExportPlatformNotSupportedForAdvancedTraining",
+ "BadRequestReservedBudgetInHoursNotEnoughForAdvancedTraining",
+ "BadRequestExportValidationFailed",
+ "BadRequestExportAlreadyInProgress",
+ "BadRequestPredictionIdsMissing",
+ "BadRequestPredictionIdsExceededCount",
+ "BadRequestPredictionTagsExceededCount",
+ "BadRequestPredictionResultsExceededCount",
+ "BadRequestPredictionInvalidApplicationName",
+ "BadRequestPredictionInvalidQueryParameters",
+ "BadRequestInvalidImportToken",
+ "BadRequestExportWhileTraining",
+ "BadRequestImageMetadataKey",
+ "BadRequestImageMetadataValue",
+ "BadRequestOperationNotSupported",
+ "BadRequestInvalidArtifactUri",
+ "BadRequestCustomerManagedKeyRevoked",
+ "BadRequestInvalid",
+ "UnsupportedMediaType",
+ "Forbidden",
+ "ForbiddenUser",
+ "ForbiddenUserResource",
+ "ForbiddenUserSignupDisabled",
+ "ForbiddenUserSignupAllowanceExceeded",
+ "ForbiddenUserDoesNotExist",
+ "ForbiddenUserDisabled",
+ "ForbiddenUserInsufficientCapability",
+ "ForbiddenDRModeEnabled",
+ "ForbiddenInvalid",
+ "NotFound",
+ "NotFoundProject",
+ "NotFoundProjectDefaultIteration",
+ "NotFoundIteration",
+ "NotFoundIterationPerformance",
+ "NotFoundTag",
+ "NotFoundImage",
+ "NotFoundDomain",
+ "NotFoundApimSubscription",
+ "NotFoundInvalid",
+ "Conflict",
+ "ConflictInvalid",
+ "ErrorUnknown",
+ "ErrorIterationCopyFailed",
+ "ErrorPreparePerformanceMigrationFailed",
+ "ErrorProjectInvalidWorkspace",
+ "ErrorProjectInvalidPipelineConfiguration",
+ "ErrorProjectInvalidDomain",
+ "ErrorProjectTrainingRequestFailed",
+ "ErrorProjectImportRequestFailed",
+ "ErrorProjectExportRequestFailed",
+ "ErrorFeaturizationServiceUnavailable",
+ "ErrorFeaturizationQueueTimeout",
+ "ErrorFeaturizationInvalidFeaturizer",
+ "ErrorFeaturizationAugmentationUnavailable",
+ "ErrorFeaturizationUnrecognizedJob",
+ "ErrorFeaturizationAugmentationError",
+ "ErrorExporterInvalidPlatform",
+ "ErrorExporterInvalidFeaturizer",
+ "ErrorExporterInvalidClassifier",
+ "ErrorPredictionServiceUnavailable",
+ "ErrorPredictionModelNotFound",
+ "ErrorPredictionModelNotCached",
+ "ErrorPrediction",
+ "ErrorPredictionStorage",
+ "ErrorRegionProposal",
+ "ErrorUnknownBaseModel",
+ "ErrorInvalid"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "CustomVisionErrorCodes",
+ "modelAsString": true
+ }
+ },
+ "message": {
+ "description": "A message explaining the error reported by the service.",
+ "type": "string"
+ }
+ }
+ },
+ "ImagePrediction": {
+ "description": "Result of an image prediction request.",
+ "type": "object",
+ "properties": {
+ "id": {
+ "format": "uuid",
+ "description": "Prediction Id.",
+ "type": "string",
+ "readOnly": true,
+ "x-nullable": false
+ },
+ "project": {
+ "format": "uuid",
+ "description": "Project Id.",
+ "type": "string",
+ "readOnly": true,
+ "x-nullable": false
+ },
+ "iteration": {
+ "format": "uuid",
+ "description": "Iteration Id.",
+ "type": "string",
+ "readOnly": true,
+ "x-nullable": false
+ },
+ "created": {
+ "format": "date-time",
+ "description": "Date this prediction was created.",
+ "type": "string",
+ "readOnly": true,
+ "x-nullable": false
+ },
+ "predictions": {
+ "description": "List of predictions.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/Prediction",
+ "x-nullable": false
+ },
+ "readOnly": true
+ }
+ }
+ },
+ "ImageUrl": {
+ "description": "Image url.",
+ "required": [
+ "url"
+ ],
+ "type": "object",
+ "properties": {
+ "url": {
+ "description": "Url of the image.",
+ "type": "string",
+ "readOnly": false,
+ "x-nullable": false
+ }
+ }
+ },
+ "Prediction": {
+ "description": "Prediction result.",
+ "type": "object",
+ "properties": {
+ "probability": {
+ "format": "float",
+ "description": "Probability of the tag.",
+ "type": "number",
+ "readOnly": true,
+ "x-nullable": false
+ },
+ "tagId": {
+ "format": "uuid",
+ "description": "Id of the predicted tag.",
+ "type": "string",
+ "readOnly": true,
+ "x-nullable": false
+ },
+ "tagName": {
+ "description": "Name of the predicted tag.",
+ "type": "string",
+ "readOnly": true,
+ "x-nullable": true
+ },
+ "boundingBox": {
+ "$ref": "#/definitions/BoundingBox",
+ "description": "Bounding box of the prediction.",
+ "readOnly": true,
+ "x-nullable": true
+ },
+ "tagType": {
+ "description": "Type of the predicted tag.",
+ "enum": [
+ "Regular",
+ "Negative",
+ "GeneralProduct"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-nullable": true,
+ "x-ms-enum": {
+ "name": "TagType",
+ "modelAsString": 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
+ }
+ },
+ "securityDefinitions": {
+ "apim_key": {
+ "type": "apiKey",
+ "name": "Prediction-Key",
+ "in": "header"
+ }
+ },
+ "security": [
+ {
+ "apim_key": []
+ }
+ ],
+ "x-ms-parameterized-host": {
+ "hostTemplate": "{Endpoint}",
+ "useSchemePrefix": false,
+ "parameters": [
+ {
+ "$ref": "#/parameters/Endpoint"
+ }
+ ]
+ }
+}
diff --git a/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.1/examples/ClassifyImage.json b/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.1/examples/ClassifyImage.json
new file mode 100644
index 000000000000..92c8f66b7eec
--- /dev/null
+++ b/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.1/examples/ClassifyImage.json
@@ -0,0 +1,33 @@
+{
+ "parameters": {
+ "Endpoint": "https://westus.api.cognitive.microsoft.com",
+ "Content-Type": "application/json",
+ "Prediction-Key": "{API Key}",
+ "projectId": "64b822c5-8082-4b36-a426-27225f4aa18c",
+ "publishedName": "MyModel1",
+ "imageData": "multipart-form-data"
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": {
+ "id": "951098b2-9b69-427b-bddb-d5cb618874e3",
+ "project": "64b822c5-8082-4b36-a426-27225f4aa18c",
+ "iteration": "fe1e83c4-6f50-4899-9544-6bb08cf0e15a",
+ "created": "2019-03-06T02:15:00Z",
+ "predictions": [
+ {
+ "tagId": "e31ff107-5505-4753-be42-b369b21b026c",
+ "tagName": "Hemlock",
+ "probability": 0.05149666
+ },
+ {
+ "tagId": "349d72ac-0948-4d51-b1e4-c14a1f9b848a",
+ "tagName": "Japanese Cherry",
+ "probability": 0.000193528482
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.1/examples/ClassifyImageUrl.json b/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.1/examples/ClassifyImageUrl.json
new file mode 100644
index 000000000000..a73984bd908b
--- /dev/null
+++ b/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.1/examples/ClassifyImageUrl.json
@@ -0,0 +1,35 @@
+{
+ "parameters": {
+ "Endpoint": "https://westus.api.cognitive.microsoft.com",
+ "Content-Type": "application/json",
+ "Prediction-Key": "{API Key}",
+ "projectId": "64b822c5-8082-4b36-a426-27225f4aa18c",
+ "publishedName": "MyModel1",
+ "imageUrl": {
+ "url": "{Image URL}"
+ }
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": {
+ "id": "951098b2-9b69-427b-bddb-d5cb618874e3",
+ "project": "64b822c5-8082-4b36-a426-27225f4aa18c",
+ "iteration": "fe1e83c4-6f50-4899-9544-6bb08cf0e15a",
+ "created": "2019-03-06T02:15:00Z",
+ "predictions": [
+ {
+ "tagId": "e31ff107-5505-4753-be42-b369b21b026c",
+ "tagName": "Hemlock",
+ "probability": 0.05149666
+ },
+ {
+ "tagId": "349d72ac-0948-4d51-b1e4-c14a1f9b848a",
+ "tagName": "Japanese Cherry",
+ "probability": 0.000193528482
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.1/examples/ClassifyImageUrlWithNoStore.json b/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.1/examples/ClassifyImageUrlWithNoStore.json
new file mode 100644
index 000000000000..a73984bd908b
--- /dev/null
+++ b/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.1/examples/ClassifyImageUrlWithNoStore.json
@@ -0,0 +1,35 @@
+{
+ "parameters": {
+ "Endpoint": "https://westus.api.cognitive.microsoft.com",
+ "Content-Type": "application/json",
+ "Prediction-Key": "{API Key}",
+ "projectId": "64b822c5-8082-4b36-a426-27225f4aa18c",
+ "publishedName": "MyModel1",
+ "imageUrl": {
+ "url": "{Image URL}"
+ }
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": {
+ "id": "951098b2-9b69-427b-bddb-d5cb618874e3",
+ "project": "64b822c5-8082-4b36-a426-27225f4aa18c",
+ "iteration": "fe1e83c4-6f50-4899-9544-6bb08cf0e15a",
+ "created": "2019-03-06T02:15:00Z",
+ "predictions": [
+ {
+ "tagId": "e31ff107-5505-4753-be42-b369b21b026c",
+ "tagName": "Hemlock",
+ "probability": 0.05149666
+ },
+ {
+ "tagId": "349d72ac-0948-4d51-b1e4-c14a1f9b848a",
+ "tagName": "Japanese Cherry",
+ "probability": 0.000193528482
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.1/examples/ClassifyImageWithNoStore.json b/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.1/examples/ClassifyImageWithNoStore.json
new file mode 100644
index 000000000000..92c8f66b7eec
--- /dev/null
+++ b/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.1/examples/ClassifyImageWithNoStore.json
@@ -0,0 +1,33 @@
+{
+ "parameters": {
+ "Endpoint": "https://westus.api.cognitive.microsoft.com",
+ "Content-Type": "application/json",
+ "Prediction-Key": "{API Key}",
+ "projectId": "64b822c5-8082-4b36-a426-27225f4aa18c",
+ "publishedName": "MyModel1",
+ "imageData": "multipart-form-data"
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": {
+ "id": "951098b2-9b69-427b-bddb-d5cb618874e3",
+ "project": "64b822c5-8082-4b36-a426-27225f4aa18c",
+ "iteration": "fe1e83c4-6f50-4899-9544-6bb08cf0e15a",
+ "created": "2019-03-06T02:15:00Z",
+ "predictions": [
+ {
+ "tagId": "e31ff107-5505-4753-be42-b369b21b026c",
+ "tagName": "Hemlock",
+ "probability": 0.05149666
+ },
+ {
+ "tagId": "349d72ac-0948-4d51-b1e4-c14a1f9b848a",
+ "tagName": "Japanese Cherry",
+ "probability": 0.000193528482
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.1/examples/DetectImage.json b/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.1/examples/DetectImage.json
new file mode 100644
index 000000000000..53c02746507d
--- /dev/null
+++ b/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.1/examples/DetectImage.json
@@ -0,0 +1,45 @@
+{
+ "parameters": {
+ "Endpoint": "https://westus.api.cognitive.microsoft.com",
+ "Content-Type": "application/json",
+ "Prediction-Key": "{API Key}",
+ "projectId": "64b822c5-8082-4b36-a426-27225f4aa18c",
+ "publishedName": "MyModel1",
+ "imageData": "multipart-form-data"
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": {
+ "id": "64615ba1-b53f-e911-b05b-f8633f7a2ef1",
+ "project": "fb5bc587-b53f-e911-b05b-f8633f7a2ef1",
+ "iteration": "45c79472-7198-46e1-8ed7-bad2ca111957",
+ "created": "2019-03-10T06:10:28Z",
+ "predictions": [
+ {
+ "tagId": "7e703b80-3c7a-4c3c-bf48-9673c6891a75",
+ "tagName": "Tag 1",
+ "probability": 0.05149666,
+ "boundingBox": {
+ "left": 0.955476165,
+ "top": 0,
+ "width": 0.0412225723,
+ "height": 0.156851858
+ }
+ },
+ {
+ "tagId": "a0d06a54-18e4-4787-a9f9-27a9c13a91e8",
+ "tagName": "Tag 2",
+ "probability": 0.000193528482,
+ "boundingBox": {
+ "left": 0.062178582,
+ "top": 0,
+ "width": 0.9378114,
+ "height": 0.6830492
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.1/examples/DetectImageUrl.json b/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.1/examples/DetectImageUrl.json
new file mode 100644
index 000000000000..2b133a020f80
--- /dev/null
+++ b/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.1/examples/DetectImageUrl.json
@@ -0,0 +1,47 @@
+{
+ "parameters": {
+ "Endpoint": "https://westus.api.cognitive.microsoft.com",
+ "Content-Type": "application/json",
+ "Prediction-Key": "{API Key}",
+ "projectId": "64b822c5-8082-4b36-a426-27225f4aa18c",
+ "publishedName": "MyModel1",
+ "imageUrl": {
+ "url": "{Image URL}"
+ }
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": {
+ "id": "64615ba1-b53f-e911-b05b-f8633f7a2ef1",
+ "project": "fb5bc587-b53f-e911-b05b-f8633f7a2ef1",
+ "iteration": "45c79472-7198-46e1-8ed7-bad2ca111957",
+ "created": "2019-03-10T06:10:28Z",
+ "predictions": [
+ {
+ "tagId": "7e703b80-3c7a-4c3c-bf48-9673c6891a75",
+ "tagName": "Tag 1",
+ "probability": 0.05149666,
+ "boundingBox": {
+ "left": 0.955476165,
+ "top": 0,
+ "width": 0.0412225723,
+ "height": 0.156851858
+ }
+ },
+ {
+ "tagId": "a0d06a54-18e4-4787-a9f9-27a9c13a91e8",
+ "tagName": "Tag 2",
+ "probability": 0.000193528482,
+ "boundingBox": {
+ "left": 0.062178582,
+ "top": 0,
+ "width": 0.9378114,
+ "height": 0.6830492
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.1/examples/DetectImageUrlWithNoStore.json b/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.1/examples/DetectImageUrlWithNoStore.json
new file mode 100644
index 000000000000..2b133a020f80
--- /dev/null
+++ b/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.1/examples/DetectImageUrlWithNoStore.json
@@ -0,0 +1,47 @@
+{
+ "parameters": {
+ "Endpoint": "https://westus.api.cognitive.microsoft.com",
+ "Content-Type": "application/json",
+ "Prediction-Key": "{API Key}",
+ "projectId": "64b822c5-8082-4b36-a426-27225f4aa18c",
+ "publishedName": "MyModel1",
+ "imageUrl": {
+ "url": "{Image URL}"
+ }
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": {
+ "id": "64615ba1-b53f-e911-b05b-f8633f7a2ef1",
+ "project": "fb5bc587-b53f-e911-b05b-f8633f7a2ef1",
+ "iteration": "45c79472-7198-46e1-8ed7-bad2ca111957",
+ "created": "2019-03-10T06:10:28Z",
+ "predictions": [
+ {
+ "tagId": "7e703b80-3c7a-4c3c-bf48-9673c6891a75",
+ "tagName": "Tag 1",
+ "probability": 0.05149666,
+ "boundingBox": {
+ "left": 0.955476165,
+ "top": 0,
+ "width": 0.0412225723,
+ "height": 0.156851858
+ }
+ },
+ {
+ "tagId": "a0d06a54-18e4-4787-a9f9-27a9c13a91e8",
+ "tagName": "Tag 2",
+ "probability": 0.000193528482,
+ "boundingBox": {
+ "left": 0.062178582,
+ "top": 0,
+ "width": 0.9378114,
+ "height": 0.6830492
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.1/examples/DetectImageWithNoStore.json b/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.1/examples/DetectImageWithNoStore.json
new file mode 100644
index 000000000000..53c02746507d
--- /dev/null
+++ b/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.1/examples/DetectImageWithNoStore.json
@@ -0,0 +1,45 @@
+{
+ "parameters": {
+ "Endpoint": "https://westus.api.cognitive.microsoft.com",
+ "Content-Type": "application/json",
+ "Prediction-Key": "{API Key}",
+ "projectId": "64b822c5-8082-4b36-a426-27225f4aa18c",
+ "publishedName": "MyModel1",
+ "imageData": "multipart-form-data"
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": {
+ "id": "64615ba1-b53f-e911-b05b-f8633f7a2ef1",
+ "project": "fb5bc587-b53f-e911-b05b-f8633f7a2ef1",
+ "iteration": "45c79472-7198-46e1-8ed7-bad2ca111957",
+ "created": "2019-03-10T06:10:28Z",
+ "predictions": [
+ {
+ "tagId": "7e703b80-3c7a-4c3c-bf48-9673c6891a75",
+ "tagName": "Tag 1",
+ "probability": 0.05149666,
+ "boundingBox": {
+ "left": 0.955476165,
+ "top": 0,
+ "width": 0.0412225723,
+ "height": 0.156851858
+ }
+ },
+ {
+ "tagId": "a0d06a54-18e4-4787-a9f9-27a9c13a91e8",
+ "tagName": "Tag 2",
+ "probability": 0.000193528482,
+ "boundingBox": {
+ "left": 0.062178582,
+ "top": 0,
+ "width": 0.9378114,
+ "height": 0.6830492
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/readme.go.md b/specification/cognitiveservices/data-plane/CustomVision/Training/readme.go.md
index 14bda8dd8dca..c61b06fde524 100644
--- a/specification/cognitiveservices/data-plane/CustomVision/Training/readme.go.md
+++ b/specification/cognitiveservices/data-plane/CustomVision/Training/readme.go.md
@@ -19,6 +19,8 @@ batch:
- tag: release_2_2
- tag: release_3_0
- tag: release_3_1
+ - tag: release_3_2
+ - tag: release_3_3
```
### Tag: release_1_0 and go
@@ -73,4 +75,13 @@ Please also specify `--go-sdk-folder=`.
+
+``` yaml $(tag) == 'release_3_3' && $(go)
+output-folder: $(go-sdk-folder)/services/cognitiveservices/v3.3/customvision/$(namespace)
```
\ No newline at end of file
diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/readme.md b/specification/cognitiveservices/data-plane/CustomVision/Training/readme.md
index c27680fff689..c24589d79dc3 100644
--- a/specification/cognitiveservices/data-plane/CustomVision/Training/readme.md
+++ b/specification/cognitiveservices/data-plane/CustomVision/Training/readme.md
@@ -4,11 +4,11 @@
Configuration for generating Custom Vision Training SDK.
-The current release is `release_3_2`.
+The current release is `release_3_3`.
``` yaml
-tag: release_3_2
+tag: release_3_3
openapi-type: data-plane
```
# Releases
@@ -56,6 +56,14 @@ input-file: stable/v3.2/Training.json
add-credentials: true
```
+### Release 3.3
+These settings apply only when `--tag=release_3_3` is specified on the command line.
+
+``` yaml $(tag) == 'release_3_3'
+input-file: stable/v3.3/Training.json
+add-credentials: true
+```
+
# Validation
## Suppression
@@ -163,7 +171,7 @@ input-file:
- $(this-folder)/stable/v3.0/Training.json
- $(this-folder)/stable/v3.1/Training.json
- $(this-folder)/stable/v3.2/Training.json
-
+ - $(this-folder)/stable/v3.3/Training.json
```
If there are files that should not be in the `all-api-versions` set,
diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/readme.ruby.md b/specification/cognitiveservices/data-plane/CustomVision/Training/readme.ruby.md
index 65b84d38d255..517819d1250a 100644
--- a/specification/cognitiveservices/data-plane/CustomVision/Training/readme.ruby.md
+++ b/specification/cognitiveservices/data-plane/CustomVision/Training/readme.ruby.md
@@ -16,6 +16,7 @@ batch:
- tag: release_3_0
- tag: release_3_1
- tag: release_3_2
+ - tag: release_3_3
```
### Tag: release_1_0 and ruby
@@ -62,3 +63,13 @@ output-folder: $(ruby-sdks-folder)/data/azure_cognitiveservices_customvisiontrai
title: "TrainingClient"
```
+### Tag: release_3_3 and ruby
+
+These settings apply only when `--tag=release_3_3 --ruby` is specified on the command line.
+Please also specify `--ruby-sdks-folder=`.
+
+``` yaml $(tag) == 'release_3_3' && $(ruby)
+namespace: "Azure::CognitiveServices::CustomVision::Training::V3_3"
+output-folder: $(ruby-sdks-folder)/data/azure_cognitiveservices_customvisiontraining/lib
+title: "TrainingClient"
+```
diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/Training.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/Training.json
new file mode 100644
index 000000000000..90ef38fb562b
--- /dev/null
+++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/Training.json
@@ -0,0 +1,5606 @@
+{
+ "swagger": "2.0",
+ "info": {
+ "version": "3.3",
+ "title": "Custom Vision Training Client"
+ },
+ "host": "southcentralus.api.cognitive.microsoft.com",
+ "basePath": "/customvision/v3.3/training",
+ "schemes": [
+ "https"
+ ],
+ "paths": {
+ "/domains": {
+ "get": {
+ "tags": [
+ "DomainsApi"
+ ],
+ "summary": "Get a list of the available domains.",
+ "operationId": "GetDomains",
+ "consumes": [],
+ "produces": [
+ "application/json",
+ "application/xml",
+ "text/xml"
+ ],
+ "parameters": [],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/Domain"
+ }
+ }
+ },
+ "default": {
+ "description": "Error response",
+ "schema": {
+ "$ref": "#/definitions/CustomVisionError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Successful GetDomains request": {
+ "$ref": "./examples/GetDomains.json"
+ }
+ }
+ }
+ },
+ "/domains/{domainId}": {
+ "get": {
+ "tags": [
+ "DomainsApi"
+ ],
+ "summary": "Get information about a specific domain.",
+ "operationId": "GetDomain",
+ "consumes": [],
+ "produces": [
+ "application/json",
+ "application/xml",
+ "text/xml"
+ ],
+ "parameters": [
+ {
+ "name": "domainId",
+ "in": "path",
+ "description": "The id of the domain to get information about.",
+ "required": true,
+ "type": "string",
+ "format": "uuid",
+ "x-nullable": false
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/Domain"
+ }
+ },
+ "default": {
+ "description": "Error response",
+ "schema": {
+ "$ref": "#/definitions/CustomVisionError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Successful GetDomain request": {
+ "$ref": "./examples/GetDomain.json"
+ }
+ }
+ }
+ },
+ "/projects": {
+ "get": {
+ "tags": [
+ "ProjectApi"
+ ],
+ "summary": "Get your projects.",
+ "operationId": "GetProjects",
+ "consumes": [],
+ "produces": [
+ "application/json",
+ "application/xml",
+ "text/xml"
+ ],
+ "parameters": [],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/Project"
+ }
+ }
+ },
+ "default": {
+ "description": "Error response",
+ "schema": {
+ "$ref": "#/definitions/CustomVisionError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Successful GetProjects request": {
+ "$ref": "./examples/GetProjects.json"
+ }
+ }
+ },
+ "post": {
+ "tags": [
+ "ProjectApi"
+ ],
+ "summary": "Create a project.",
+ "operationId": "CreateProject",
+ "consumes": [],
+ "produces": [
+ "application/json",
+ "application/xml",
+ "text/xml"
+ ],
+ "parameters": [
+ {
+ "name": "name",
+ "in": "query",
+ "description": "Name of the project.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "description",
+ "in": "query",
+ "description": "The description of the project.",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "name": "domainId",
+ "in": "query",
+ "description": "The id of the domain to use for this project. Defaults to General.",
+ "required": false,
+ "type": "string",
+ "format": "uuid"
+ },
+ {
+ "name": "classificationType",
+ "in": "query",
+ "description": "The type of classifier to create for this project.",
+ "required": false,
+ "type": "string",
+ "enum": [
+ "Multiclass",
+ "Multilabel"
+ ]
+ },
+ {
+ "name": "targetExportPlatforms",
+ "in": "query",
+ "description": "List of platforms the trained model is intending exporting to.",
+ "required": false,
+ "type": "array",
+ "items": {
+ "type": "string",
+ "enum": [
+ "CoreML",
+ "TensorFlow",
+ "DockerFile",
+ "ONNX",
+ "VAIDK"
+ ]
+ },
+ "collectionFormat": "csv"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/Project"
+ }
+ },
+ "default": {
+ "description": "Error response",
+ "schema": {
+ "$ref": "#/definitions/CustomVisionError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Successful CreateProject request": {
+ "$ref": "./examples/CreateProject.json"
+ }
+ }
+ }
+ },
+ "/projects/{projectId}": {
+ "get": {
+ "tags": [
+ "ProjectApi"
+ ],
+ "summary": "Get a specific project.",
+ "operationId": "GetProject",
+ "consumes": [],
+ "produces": [
+ "application/json",
+ "application/xml",
+ "text/xml"
+ ],
+ "parameters": [
+ {
+ "name": "projectId",
+ "in": "path",
+ "description": "The id of the project to get.",
+ "required": true,
+ "type": "string",
+ "format": "uuid",
+ "x-nullable": false
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/Project"
+ }
+ },
+ "default": {
+ "description": "Error response",
+ "schema": {
+ "$ref": "#/definitions/CustomVisionError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Successful GetProject request": {
+ "$ref": "./examples/GetProject.json"
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "ProjectApi"
+ ],
+ "summary": "Delete a specific project.",
+ "operationId": "DeleteProject",
+ "consumes": [],
+ "produces": [],
+ "parameters": [
+ {
+ "name": "projectId",
+ "in": "path",
+ "description": "The project id.",
+ "required": true,
+ "type": "string",
+ "format": "uuid",
+ "x-nullable": false
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "No Content"
+ },
+ "default": {
+ "description": "Error response",
+ "schema": {
+ "$ref": "#/definitions/CustomVisionError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Successful DeleteProject request": {
+ "$ref": "./examples/DeleteProject.json"
+ }
+ }
+ },
+ "patch": {
+ "tags": [
+ "ProjectApi"
+ ],
+ "summary": "Update a specific project.",
+ "operationId": "UpdateProject",
+ "consumes": [
+ "application/json",
+ "application/xml",
+ "text/xml",
+ "application/x-www-form-urlencoded"
+ ],
+ "produces": [
+ "application/json",
+ "application/xml",
+ "text/xml"
+ ],
+ "parameters": [
+ {
+ "name": "projectId",
+ "in": "path",
+ "description": "The id of the project to update.",
+ "required": true,
+ "type": "string",
+ "format": "uuid",
+ "x-nullable": false
+ },
+ {
+ "name": "updatedProject",
+ "in": "body",
+ "description": "The updated project model.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/Project"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/Project"
+ }
+ },
+ "default": {
+ "description": "Error response",
+ "schema": {
+ "$ref": "#/definitions/CustomVisionError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Successful UpdateProject request": {
+ "$ref": "./examples/UpdateProject.json"
+ }
+ }
+ }
+ },
+ "/projects/{projectId}/artifacts": {
+ "get": {
+ "tags": [
+ "ProjectApi"
+ ],
+ "summary": "Get artifact content from blob storage, based on artifact relative path in the blob.",
+ "operationId": "GetArtifact",
+ "consumes": [],
+ "produces": [
+ "application/octet-stream"
+ ],
+ "parameters": [
+ {
+ "name": "projectId",
+ "in": "path",
+ "description": "The project id.",
+ "required": true,
+ "type": "string",
+ "format": "uuid",
+ "x-nullable": false
+ },
+ {
+ "name": "path",
+ "in": "query",
+ "description": "The relative path for artifact.",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "type": "file"
+ }
+ },
+ "default": {
+ "description": "Error response",
+ "schema": {
+ "$ref": "#/definitions/CustomVisionError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Successful GetArtifact request": {
+ "$ref": "./examples/GetArtifact.json"
+ }
+ }
+ }
+ },
+ "/projects/{projectId}/export": {
+ "get": {
+ "tags": [
+ "ProjectApi"
+ ],
+ "summary": "Exports a project.",
+ "operationId": "ExportProject",
+ "consumes": [],
+ "produces": [
+ "application/json",
+ "application/xml",
+ "text/xml"
+ ],
+ "parameters": [
+ {
+ "name": "projectId",
+ "in": "path",
+ "description": "The project id of the project to export.",
+ "required": true,
+ "type": "string",
+ "format": "uuid",
+ "x-nullable": false
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/ProjectExport"
+ }
+ },
+ "default": {
+ "description": "Error response",
+ "schema": {
+ "$ref": "#/definitions/CustomVisionError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Successful ExportProject request": {
+ "$ref": "./examples/ExportProject.json"
+ }
+ }
+ }
+ },
+ "/projects/{projectId}/images": {
+ "get": {
+ "tags": [
+ "ImageApi"
+ ],
+ "summary": "Get images for a given project iteration or workspace.",
+ "description": "This API supports batching and range selection. By default it will only return first 50 images matching images.\r\nUse the {take} and {skip} parameters to control how many images to return in a given batch.\r\nThe filtering is on an and/or relationship. For example, if the provided tag ids are for the \"Dog\" and\r\n\"Cat\" tags, then only images tagged with Dog and/or Cat will be returned",
+ "operationId": "GetImages",
+ "consumes": [],
+ "produces": [
+ "application/json",
+ "application/xml",
+ "text/xml"
+ ],
+ "parameters": [
+ {
+ "name": "projectId",
+ "in": "path",
+ "description": "The project id.",
+ "required": true,
+ "type": "string",
+ "format": "uuid",
+ "x-nullable": false
+ },
+ {
+ "name": "iterationId",
+ "in": "query",
+ "description": "The iteration id. Defaults to workspace.",
+ "required": false,
+ "type": "string",
+ "format": "uuid"
+ },
+ {
+ "name": "tagIds",
+ "in": "query",
+ "description": "A list of tags ids to filter the images. Defaults to all tagged images when null. Limited to 20.",
+ "required": false,
+ "type": "array",
+ "items": {
+ "type": "string",
+ "format": "uuid",
+ "x-nullable": false
+ },
+ "collectionFormat": "csv",
+ "maxItems": 20,
+ "minItems": 0
+ },
+ {
+ "name": "taggingStatus",
+ "in": "query",
+ "description": "The tagging status filter. It can be 'All', 'Tagged', or 'Untagged'. Defaults to 'All'.",
+ "required": false,
+ "type": "string",
+ "enum": [
+ "All",
+ "Tagged",
+ "Untagged"
+ ]
+ },
+ {
+ "name": "$filter",
+ "in": "query",
+ "description": "An expression to filter the images against image metadata. Only images where the expression evaluates to true are included in the response.\r\nThe expression supports eq (Equal), ne (Not equal), and (Logical and), or (Logical or) operators.\r\nHere is an example, metadata=key1 eq 'value1' and key2 ne 'value2'.",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "name": "orderBy",
+ "in": "query",
+ "description": "The ordering. Defaults to newest.",
+ "required": false,
+ "type": "string",
+ "enum": [
+ "Newest",
+ "Oldest"
+ ]
+ },
+ {
+ "name": "take",
+ "in": "query",
+ "description": "Maximum number of images to return. Defaults to 50, limited to 256.",
+ "required": false,
+ "type": "integer",
+ "format": "int32",
+ "default": 50,
+ "maximum": 256,
+ "minimum": 0
+ },
+ {
+ "name": "skip",
+ "in": "query",
+ "description": "Number of images to skip before beginning the image batch. Defaults to 0.",
+ "required": false,
+ "type": "integer",
+ "format": "int32",
+ "default": 0
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/Image"
+ }
+ }
+ },
+ "default": {
+ "description": "Error response",
+ "schema": {
+ "$ref": "#/definitions/CustomVisionError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Successful GetImages request": {
+ "$ref": "./examples/GetImages.json"
+ }
+ }
+ },
+ "post": {
+ "tags": [
+ "ImageApi"
+ ],
+ "summary": "Add the provided images to the set of training images.",
+ "description": "This API accepts body content as multipart/form-data and application/octet-stream. When using multipart\r\nmultiple image files can be sent at once, with a maximum of 64 files.\r\nIf all images are successful created, 200(OK) status code will be returned.\r\nOtherwise, 207 (Multi-Status) status code will be returned and detail status for each image will be listed in the response payload.",
+ "operationId": "CreateImagesFromData",
+ "consumes": [
+ "multipart/form-data",
+ "application/octet-stream"
+ ],
+ "produces": [
+ "application/json",
+ "application/xml",
+ "text/xml"
+ ],
+ "parameters": [
+ {
+ "name": "projectId",
+ "in": "path",
+ "description": "The project id.",
+ "required": true,
+ "type": "string",
+ "format": "uuid",
+ "x-nullable": false
+ },
+ {
+ "name": "tagIds",
+ "in": "query",
+ "description": "The tags ids with which to tag each image. Limited to 20.",
+ "required": false,
+ "type": "array",
+ "items": {
+ "type": "string",
+ "format": "uuid",
+ "x-nullable": false
+ },
+ "collectionFormat": "csv",
+ "maxItems": 20,
+ "minItems": 0
+ },
+ {
+ "name": "imageData",
+ "in": "formData",
+ "description": "Binary image data. Supported formats are JPEG, GIF, PNG, and BMP. Supports images up to 6MB.",
+ "required": true,
+ "type": "file"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/ImageCreateSummary"
+ }
+ },
+ "207": {
+ "description": "207",
+ "schema": {
+ "$ref": "#/definitions/ImageCreateSummary"
+ }
+ },
+ "default": {
+ "description": "Error response",
+ "schema": {
+ "$ref": "#/definitions/CustomVisionError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Successful CreateImagesFromData request": {
+ "$ref": "./examples/CreateImagesFromData.json"
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "ImageApi"
+ ],
+ "summary": "Delete images from the set of training images.",
+ "operationId": "DeleteImages",
+ "consumes": [],
+ "produces": [
+ "application/json",
+ "application/xml",
+ "text/xml"
+ ],
+ "parameters": [
+ {
+ "name": "projectId",
+ "in": "path",
+ "description": "The project id.",
+ "required": true,
+ "type": "string",
+ "format": "uuid",
+ "x-nullable": false
+ },
+ {
+ "name": "imageIds",
+ "in": "query",
+ "description": "Ids of the images to be deleted. Limited to 256 images per batch.",
+ "required": false,
+ "type": "array",
+ "items": {
+ "type": "string",
+ "format": "uuid",
+ "x-nullable": false
+ },
+ "collectionFormat": "csv",
+ "maxItems": 256,
+ "minItems": 0
+ },
+ {
+ "name": "allImages",
+ "in": "query",
+ "description": "Flag to specify delete all images, specify this flag or a list of images. Using this flag will return a 202 response to indicate the images are being deleted.",
+ "required": false,
+ "type": "boolean"
+ },
+ {
+ "name": "allIterations",
+ "in": "query",
+ "description": "Removes these images from all iterations, not just the current workspace. Using this flag will return a 202 response to indicate the images are being deleted.",
+ "required": false,
+ "type": "boolean"
+ }
+ ],
+ "responses": {
+ "202": {
+ "description": "Accepted"
+ },
+ "204": {
+ "description": "No Content"
+ },
+ "default": {
+ "description": "Error response",
+ "schema": {
+ "$ref": "#/definitions/CustomVisionError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Successful DeleteImages request": {
+ "$ref": "./examples/DeleteImages.json"
+ }
+ }
+ }
+ },
+ "/projects/{projectId}/images/{imageId}/regionproposals": {
+ "post": {
+ "tags": [
+ "ImageRegionProposalApi"
+ ],
+ "summary": "Get region proposals for an image. Returns empty array if no proposals are found.",
+ "description": "This API will get region proposals for an image along with confidences for the region. It returns an empty array if no proposals are found.",
+ "operationId": "GetImageRegionProposals",
+ "consumes": [],
+ "produces": [
+ "application/json",
+ "application/xml",
+ "text/xml"
+ ],
+ "parameters": [
+ {
+ "name": "projectId",
+ "in": "path",
+ "description": "The project id.",
+ "required": true,
+ "type": "string",
+ "format": "uuid",
+ "x-nullable": false
+ },
+ {
+ "name": "imageId",
+ "in": "path",
+ "description": "The image id.",
+ "required": true,
+ "type": "string",
+ "format": "uuid",
+ "x-nullable": false
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/ImageRegionProposal"
+ }
+ },
+ "default": {
+ "description": "Error response",
+ "schema": {
+ "$ref": "#/definitions/CustomVisionError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Successful GetImageRegionProposals request": {
+ "$ref": "./examples/GetImageRegionProposals.json"
+ }
+ }
+ }
+ },
+ "/projects/{projectId}/images/count": {
+ "get": {
+ "tags": [
+ "ImageApi"
+ ],
+ "summary": "Get the number of images.",
+ "description": "The filtering is on an and/or relationship. For example, if the provided tag ids are for the \"Dog\" and\r\n\"Cat\" tags, then only images tagged with Dog and/or Cat will be returned",
+ "operationId": "GetImageCount",
+ "consumes": [],
+ "produces": [
+ "application/json",
+ "application/xml",
+ "text/xml"
+ ],
+ "parameters": [
+ {
+ "name": "projectId",
+ "in": "path",
+ "description": "The project id.",
+ "required": true,
+ "type": "string",
+ "format": "uuid",
+ "x-nullable": false
+ },
+ {
+ "name": "iterationId",
+ "in": "query",
+ "description": "The iteration id. Defaults to workspace.",
+ "required": false,
+ "type": "string",
+ "format": "uuid"
+ },
+ {
+ "name": "taggingStatus",
+ "in": "query",
+ "description": "The tagging status filter. It can be 'All', 'Tagged', or 'Untagged'. Defaults to 'All'.",
+ "required": false,
+ "type": "string",
+ "enum": [
+ "All",
+ "Tagged",
+ "Untagged"
+ ]
+ },
+ {
+ "name": "$filter",
+ "in": "query",
+ "description": "An expression to filter the images against image metadata. Only images where the expression evaluates to true are included in the response.\r\nThe expression supports eq (Equal), ne (Not equal), and (Logical and), or (Logical or) operators.\r\nHere is an example, metadata=key1 eq 'value1' and key2 ne 'value2'.",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "name": "tagIds",
+ "in": "query",
+ "description": "A list of tags ids to filter the images to count. Defaults to all tags when null.",
+ "required": false,
+ "type": "array",
+ "items": {
+ "type": "string",
+ "format": "uuid",
+ "x-nullable": false
+ },
+ "collectionFormat": "csv"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "default": {
+ "description": "Error response",
+ "schema": {
+ "$ref": "#/definitions/CustomVisionError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Successful GetImageCount request": {
+ "$ref": "./examples/GetImageCount.json"
+ }
+ }
+ }
+ },
+ "/projects/{projectId}/images/files": {
+ "post": {
+ "tags": [
+ "ImageApi"
+ ],
+ "summary": "Add the provided batch of images to the set of training images.",
+ "description": "This API accepts a batch of files, and optionally tags, to create images. There is a limit of 64 images and 20 tags.\r\nIf all images are successful created, 200(OK) status code will be returned.\r\nOtherwise, 207 (Multi-Status) status code will be returned and detail status for each image will be listed in the response payload.",
+ "operationId": "CreateImagesFromFiles",
+ "consumes": [
+ "application/json",
+ "application/xml",
+ "text/xml",
+ "application/x-www-form-urlencoded"
+ ],
+ "produces": [
+ "application/json",
+ "application/xml",
+ "text/xml"
+ ],
+ "parameters": [
+ {
+ "name": "projectId",
+ "in": "path",
+ "description": "The project id.",
+ "required": true,
+ "type": "string",
+ "format": "uuid",
+ "x-nullable": false
+ },
+ {
+ "name": "batch",
+ "in": "body",
+ "description": "The batch of image files to add. Limited to 64 images and 20 tags per batch.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/ImageFileCreateBatch"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/ImageCreateSummary"
+ }
+ },
+ "207": {
+ "description": "207",
+ "schema": {
+ "$ref": "#/definitions/ImageCreateSummary"
+ }
+ },
+ "default": {
+ "description": "Error response",
+ "schema": {
+ "$ref": "#/definitions/CustomVisionError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Successful CreateImagesFromFiles request": {
+ "$ref": "./examples/CreateImagesFromFiles.json"
+ }
+ }
+ }
+ },
+ "/projects/{projectId}/images/id": {
+ "get": {
+ "tags": [
+ "ImageApi"
+ ],
+ "summary": "Get images by id for a given project iteration.",
+ "description": "This API will return a set of Images for the specified tags and optionally iteration. If no iteration is specified the\r\ncurrent workspace is used.",
+ "operationId": "GetImagesByIds",
+ "consumes": [],
+ "produces": [
+ "application/json",
+ "application/xml",
+ "text/xml"
+ ],
+ "parameters": [
+ {
+ "name": "projectId",
+ "in": "path",
+ "description": "The project id.",
+ "required": true,
+ "type": "string",
+ "format": "uuid",
+ "x-nullable": false
+ },
+ {
+ "name": "imageIds",
+ "in": "query",
+ "description": "The list of image ids to retrieve. Limited to 256.",
+ "required": false,
+ "type": "array",
+ "items": {
+ "type": "string",
+ "format": "uuid",
+ "x-nullable": false
+ },
+ "collectionFormat": "csv",
+ "maxItems": 256,
+ "minItems": 0
+ },
+ {
+ "name": "iterationId",
+ "in": "query",
+ "description": "The iteration id. Defaults to workspace.",
+ "required": false,
+ "type": "string",
+ "format": "uuid"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/Image"
+ }
+ }
+ },
+ "default": {
+ "description": "Error response",
+ "schema": {
+ "$ref": "#/definitions/CustomVisionError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Successful GetImagesByIds request": {
+ "$ref": "./examples/GetImagesByIds.json"
+ }
+ }
+ }
+ },
+ "/projects/{projectId}/images/metadata": {
+ "post": {
+ "tags": [
+ "ImageApi"
+ ],
+ "summary": "Update metadata of images.",
+ "description": "This API accepts a batch of image Ids, and metadata, to update images. There is a limit of 64 images.",
+ "operationId": "UpdateImageMetadata",
+ "consumes": [
+ "application/json",
+ "application/xml",
+ "text/xml",
+ "application/x-www-form-urlencoded"
+ ],
+ "produces": [
+ "application/json",
+ "application/xml",
+ "text/xml"
+ ],
+ "parameters": [
+ {
+ "name": "projectId",
+ "in": "path",
+ "description": "The project id.",
+ "required": true,
+ "type": "string",
+ "format": "uuid",
+ "x-nullable": false
+ },
+ {
+ "name": "imageIds",
+ "in": "query",
+ "description": "The list of image ids to update. Limited to 64.",
+ "required": true,
+ "type": "array",
+ "items": {
+ "type": "string",
+ "format": "uuid",
+ "x-nullable": false
+ },
+ "collectionFormat": "csv",
+ "maxItems": 256,
+ "minItems": 0
+ },
+ {
+ "name": "metadata",
+ "in": "body",
+ "description": "The metadata to be updated to the specified images. Limited to 50 key-value pairs per image. The length of key is limited to 256. The length of value is limited to 512.",
+ "required": true,
+ "schema": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/ImageMetadataUpdateSummary"
+ }
+ },
+ "207": {
+ "description": "207",
+ "schema": {
+ "$ref": "#/definitions/ImageMetadataUpdateSummary"
+ }
+ },
+ "default": {
+ "description": "Error response",
+ "schema": {
+ "$ref": "#/definitions/CustomVisionError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Successful UpdateImageMetadata request": {
+ "$ref": "./examples/UpdateImageMetadata.json"
+ }
+ }
+ }
+ },
+ "/projects/{projectId}/images/predictions": {
+ "post": {
+ "tags": [
+ "ImageApi"
+ ],
+ "summary": "Add the specified predicted images to the set of training images.",
+ "description": "This API creates a batch of images from predicted images specified. There is a limit of 64 images and 20 tags.\r\nIf all images are successful created, 200(OK) status code will be returned.\r\nOtherwise, 207 (Multi-Status) status code will be returned and detail status for each image will be listed in the response payload.",
+ "operationId": "CreateImagesFromPredictions",
+ "consumes": [
+ "application/json",
+ "application/xml",
+ "text/xml",
+ "application/x-www-form-urlencoded"
+ ],
+ "produces": [
+ "application/json",
+ "application/xml",
+ "text/xml"
+ ],
+ "parameters": [
+ {
+ "name": "projectId",
+ "in": "path",
+ "description": "The project id.",
+ "required": true,
+ "type": "string",
+ "format": "uuid",
+ "x-nullable": false
+ },
+ {
+ "name": "batch",
+ "in": "body",
+ "description": "Image, tag ids, and metadata. Limited to 64 images and 20 tags per batch.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/ImageIdCreateBatch"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/ImageCreateSummary"
+ }
+ },
+ "207": {
+ "description": "207",
+ "schema": {
+ "$ref": "#/definitions/ImageCreateSummary"
+ }
+ },
+ "default": {
+ "description": "Error response",
+ "schema": {
+ "$ref": "#/definitions/CustomVisionError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Successful CreateImagesFromPredictions request": {
+ "$ref": "./examples/CreateImagesFromPredictions.json"
+ }
+ }
+ }
+ },
+ "/projects/{projectId}/images/regions": {
+ "post": {
+ "tags": [
+ "ImageApi"
+ ],
+ "summary": "Create a set of image regions.",
+ "description": "This API accepts a batch of image regions, and optionally tags, to update existing images with region information.\r\nThere is a limit of 64 entries in the batch.\r\nIf all regions are successful created, 200(OK) status code will be returned.\r\nOtherwise, 207 (Multi-Status) status code will be returned and detail status for each region will be listed in the response payload.",
+ "operationId": "CreateImageRegions",
+ "consumes": [
+ "application/json",
+ "application/xml",
+ "text/xml",
+ "application/x-www-form-urlencoded"
+ ],
+ "produces": [
+ "application/json",
+ "application/xml",
+ "text/xml"
+ ],
+ "parameters": [
+ {
+ "name": "projectId",
+ "in": "path",
+ "description": "The project id.",
+ "required": true,
+ "type": "string",
+ "format": "uuid",
+ "x-nullable": false
+ },
+ {
+ "name": "batch",
+ "in": "body",
+ "description": "Batch of image regions which include a tag and bounding box. Limited to 64.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/ImageRegionCreateBatch"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/ImageRegionCreateSummary"
+ }
+ },
+ "207": {
+ "description": "207",
+ "schema": {
+ "$ref": "#/definitions/ImageRegionCreateSummary"
+ }
+ },
+ "default": {
+ "description": "Error response",
+ "schema": {
+ "$ref": "#/definitions/CustomVisionError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Successful CreateImageRegions request": {
+ "$ref": "./examples/CreateImageRegions.json"
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "ImageApi"
+ ],
+ "summary": "Delete a set of image regions.",
+ "operationId": "DeleteImageRegions",
+ "consumes": [],
+ "produces": [],
+ "parameters": [
+ {
+ "name": "projectId",
+ "in": "path",
+ "description": "The project id.",
+ "required": true,
+ "type": "string",
+ "format": "uuid",
+ "x-nullable": false
+ },
+ {
+ "name": "regionIds",
+ "in": "query",
+ "description": "Regions to delete. Limited to 64.",
+ "required": true,
+ "type": "array",
+ "items": {
+ "type": "string",
+ "format": "uuid",
+ "x-nullable": false
+ },
+ "collectionFormat": "csv",
+ "maxItems": 64,
+ "minItems": 0
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "No Content"
+ },
+ "default": {
+ "description": "Error response",
+ "schema": {
+ "$ref": "#/definitions/CustomVisionError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Successful DeleteImageRegions request": {
+ "$ref": "./examples/DeleteImageRegions.json"
+ }
+ }
+ }
+ },
+ "/projects/{projectId}/images/suggested": {
+ "post": {
+ "tags": [
+ "ImageApi"
+ ],
+ "summary": "Get untagged images whose suggested tags match given tags. Returns empty array if no images are found.",
+ "description": "This API will fetch untagged images filtered by suggested tags Ids. It returns an empty array if no images are found.",
+ "operationId": "QuerySuggestedImages",
+ "consumes": [
+ "application/json",
+ "application/xml",
+ "text/xml",
+ "application/x-www-form-urlencoded"
+ ],
+ "produces": [
+ "application/json",
+ "application/xml",
+ "text/xml"
+ ],
+ "parameters": [
+ {
+ "name": "projectId",
+ "in": "path",
+ "description": "The project id.",
+ "required": true,
+ "type": "string",
+ "format": "uuid",
+ "x-nullable": false
+ },
+ {
+ "name": "iterationId",
+ "in": "query",
+ "description": "IterationId to use for the suggested tags and regions.",
+ "required": true,
+ "type": "string",
+ "format": "uuid",
+ "x-nullable": false
+ },
+ {
+ "name": "query",
+ "in": "body",
+ "description": "Contains properties we need to query suggested images.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/SuggestedTagAndRegionQueryToken"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/SuggestedTagAndRegionQuery"
+ }
+ },
+ "default": {
+ "description": "Error response",
+ "schema": {
+ "$ref": "#/definitions/CustomVisionError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Successful QuerySuggestedImages request": {
+ "$ref": "./examples/QuerySuggestedImages.json"
+ }
+ }
+ }
+ },
+ "/projects/{projectId}/images/suggested/count": {
+ "post": {
+ "tags": [
+ "ImageApi"
+ ],
+ "summary": "Get count of images whose suggested tags match given tags and their probabilities are greater than or equal to the given threshold. Returns count as 0 if none found.",
+ "description": "This API takes in tagIds to get count of untagged images per suggested tags for a given threshold.",
+ "operationId": "QuerySuggestedImageCount",
+ "consumes": [
+ "application/json",
+ "application/xml",
+ "text/xml",
+ "application/x-www-form-urlencoded"
+ ],
+ "produces": [
+ "application/json",
+ "application/xml",
+ "text/xml"
+ ],
+ "parameters": [
+ {
+ "name": "projectId",
+ "in": "path",
+ "description": "The project id.",
+ "required": true,
+ "type": "string",
+ "format": "uuid",
+ "x-nullable": false
+ },
+ {
+ "name": "iterationId",
+ "in": "query",
+ "description": "IterationId to use for the suggested tags and regions.",
+ "required": true,
+ "type": "string",
+ "format": "uuid",
+ "x-nullable": false
+ },
+ {
+ "name": "query",
+ "in": "body",
+ "description": "Model that contains tagIds, threshold and projectType to query by.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/TagFilter"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "type": "object",
+ "additionalProperties": {
+ "format": "int32",
+ "type": "integer"
+ }
+ }
+ },
+ "default": {
+ "description": "Error response",
+ "schema": {
+ "$ref": "#/definitions/CustomVisionError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Successful QuerySuggestedImageCount request": {
+ "$ref": "./examples/QuerySuggestedImageCount.json"
+ }
+ }
+ }
+ },
+ "/projects/{projectId}/images/tagged": {
+ "get": {
+ "tags": [
+ "ImageApi"
+ ],
+ "summary": "Get tagged images for a given project iteration.",
+ "description": "This API supports batching and range selection. By default it will only return first 50 images matching images.\r\nUse the {take} and {skip} parameters to control how many images to return in a given batch.\r\nThe filtering is on an and/or relationship. For example, if the provided tag ids are for the \"Dog\" and\r\n\"Cat\" tags, then only images tagged with Dog and/or Cat will be returned",
+ "operationId": "GetTaggedImages",
+ "consumes": [],
+ "produces": [
+ "application/json",
+ "application/xml",
+ "text/xml"
+ ],
+ "parameters": [
+ {
+ "name": "projectId",
+ "in": "path",
+ "description": "The project id.",
+ "required": true,
+ "type": "string",
+ "format": "uuid",
+ "x-nullable": false
+ },
+ {
+ "name": "iterationId",
+ "in": "query",
+ "description": "The iteration id. Defaults to workspace.",
+ "required": false,
+ "type": "string",
+ "format": "uuid"
+ },
+ {
+ "name": "tagIds",
+ "in": "query",
+ "description": "A list of tags ids to filter the images. Defaults to all tagged images when null. Limited to 20.",
+ "required": false,
+ "type": "array",
+ "items": {
+ "type": "string",
+ "format": "uuid",
+ "x-nullable": false
+ },
+ "collectionFormat": "csv",
+ "maxItems": 20,
+ "minItems": 0
+ },
+ {
+ "name": "orderBy",
+ "in": "query",
+ "description": "The ordering. Defaults to newest.",
+ "required": false,
+ "type": "string",
+ "enum": [
+ "Newest",
+ "Oldest"
+ ]
+ },
+ {
+ "name": "take",
+ "in": "query",
+ "description": "Maximum number of images to return. Defaults to 50, limited to 256.",
+ "required": false,
+ "type": "integer",
+ "format": "int32",
+ "default": 50,
+ "maximum": 256,
+ "minimum": 0
+ },
+ {
+ "name": "skip",
+ "in": "query",
+ "description": "Number of images to skip before beginning the image batch. Defaults to 0.",
+ "required": false,
+ "type": "integer",
+ "format": "int32",
+ "default": 0
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/Image"
+ }
+ }
+ },
+ "default": {
+ "description": "Error response",
+ "schema": {
+ "$ref": "#/definitions/CustomVisionError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Successful GetTaggedImages request": {
+ "$ref": "./examples/GetTaggedImages.json"
+ }
+ }
+ }
+ },
+ "/projects/{projectId}/images/tagged/count": {
+ "get": {
+ "tags": [
+ "ImageApi"
+ ],
+ "summary": "Gets the number of images tagged with the provided {tagIds}.",
+ "description": "The filtering is on an and/or relationship. For example, if the provided tag ids are for the \"Dog\" and\r\n\"Cat\" tags, then only images tagged with Dog and/or Cat will be returned",
+ "operationId": "GetTaggedImageCount",
+ "consumes": [],
+ "produces": [
+ "application/json",
+ "application/xml",
+ "text/xml"
+ ],
+ "parameters": [
+ {
+ "name": "projectId",
+ "in": "path",
+ "description": "The project id.",
+ "required": true,
+ "type": "string",
+ "format": "uuid",
+ "x-nullable": false
+ },
+ {
+ "name": "iterationId",
+ "in": "query",
+ "description": "The iteration id. Defaults to workspace.",
+ "required": false,
+ "type": "string",
+ "format": "uuid"
+ },
+ {
+ "name": "tagIds",
+ "in": "query",
+ "description": "A list of tags ids to filter the images to count. Defaults to all tags when null.",
+ "required": false,
+ "type": "array",
+ "items": {
+ "type": "string",
+ "format": "uuid",
+ "x-nullable": false
+ },
+ "collectionFormat": "csv"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "default": {
+ "description": "Error response",
+ "schema": {
+ "$ref": "#/definitions/CustomVisionError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Successful GetTaggedImageCount request": {
+ "$ref": "./examples/GetTaggedImageCount.json"
+ }
+ }
+ }
+ },
+ "/projects/{projectId}/images/tags": {
+ "post": {
+ "tags": [
+ "ImageApi"
+ ],
+ "summary": "Associate a set of images with a set of tags.",
+ "operationId": "CreateImageTags",
+ "consumes": [
+ "application/json",
+ "application/xml",
+ "text/xml",
+ "application/x-www-form-urlencoded"
+ ],
+ "produces": [
+ "application/json",
+ "application/xml",
+ "text/xml"
+ ],
+ "parameters": [
+ {
+ "name": "projectId",
+ "in": "path",
+ "description": "The project id.",
+ "required": true,
+ "type": "string",
+ "format": "uuid",
+ "x-nullable": false
+ },
+ {
+ "name": "batch",
+ "in": "body",
+ "description": "Batch of image tags. Limited to 128 tags per batch.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/ImageTagCreateBatch"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/ImageTagCreateSummary"
+ }
+ },
+ "default": {
+ "description": "Error response",
+ "schema": {
+ "$ref": "#/definitions/CustomVisionError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Successful CreateImageTags request": {
+ "$ref": "./examples/CreateImageTags.json"
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "ImageApi"
+ ],
+ "summary": "Remove a set of tags from a set of images.",
+ "operationId": "DeleteImageTags",
+ "consumes": [],
+ "produces": [],
+ "parameters": [
+ {
+ "name": "projectId",
+ "in": "path",
+ "description": "The project id.",
+ "required": true,
+ "type": "string",
+ "format": "uuid",
+ "x-nullable": false
+ },
+ {
+ "name": "imageIds",
+ "in": "query",
+ "description": "Image ids. Limited to 64 images.",
+ "required": true,
+ "type": "array",
+ "items": {
+ "type": "string",
+ "format": "uuid",
+ "x-nullable": false
+ },
+ "collectionFormat": "csv",
+ "maxItems": 64,
+ "minItems": 0
+ },
+ {
+ "name": "tagIds",
+ "in": "query",
+ "description": "Tags to be deleted from the specified images. Limited to 20 tags.",
+ "required": true,
+ "type": "array",
+ "items": {
+ "type": "string",
+ "format": "uuid",
+ "x-nullable": false
+ },
+ "collectionFormat": "csv",
+ "maxItems": 20,
+ "minItems": 0
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "No Content"
+ },
+ "default": {
+ "description": "Error response",
+ "schema": {
+ "$ref": "#/definitions/CustomVisionError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Successful DeleteImageTags request": {
+ "$ref": "./examples/DeleteImageTags.json"
+ }
+ }
+ }
+ },
+ "/projects/{projectId}/images/untagged": {
+ "get": {
+ "tags": [
+ "ImageApi"
+ ],
+ "summary": "Get untagged images for a given project iteration.",
+ "description": "This API supports batching and range selection. By default it will only return first 50 images matching images.\r\nUse the {take} and {skip} parameters to control how many images to return in a given batch.",
+ "operationId": "GetUntaggedImages",
+ "consumes": [],
+ "produces": [
+ "application/json",
+ "application/xml",
+ "text/xml"
+ ],
+ "parameters": [
+ {
+ "name": "projectId",
+ "in": "path",
+ "description": "The project id.",
+ "required": true,
+ "type": "string",
+ "format": "uuid",
+ "x-nullable": false
+ },
+ {
+ "name": "iterationId",
+ "in": "query",
+ "description": "The iteration id. Defaults to workspace.",
+ "required": false,
+ "type": "string",
+ "format": "uuid"
+ },
+ {
+ "name": "orderBy",
+ "in": "query",
+ "description": "The ordering. Defaults to newest.",
+ "required": false,
+ "type": "string",
+ "enum": [
+ "Newest",
+ "Oldest"
+ ]
+ },
+ {
+ "name": "take",
+ "in": "query",
+ "description": "Maximum number of images to return. Defaults to 50, limited to 256.",
+ "required": false,
+ "type": "integer",
+ "format": "int32",
+ "default": 50,
+ "maximum": 256,
+ "minimum": 0
+ },
+ {
+ "name": "skip",
+ "in": "query",
+ "description": "Number of images to skip before beginning the image batch. Defaults to 0.",
+ "required": false,
+ "type": "integer",
+ "format": "int32",
+ "default": 0
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/Image"
+ }
+ }
+ },
+ "default": {
+ "description": "Error response",
+ "schema": {
+ "$ref": "#/definitions/CustomVisionError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Successful GetUntaggedImages request": {
+ "$ref": "./examples/GetUntaggedImages.json"
+ }
+ }
+ }
+ },
+ "/projects/{projectId}/images/untagged/count": {
+ "get": {
+ "tags": [
+ "ImageApi"
+ ],
+ "summary": "Gets the number of untagged images.",
+ "description": "This API returns the images which have no tags for a given project and optionally an iteration. If no iteration is specified the\r\ncurrent workspace is used.",
+ "operationId": "GetUntaggedImageCount",
+ "consumes": [],
+ "produces": [
+ "application/json",
+ "application/xml",
+ "text/xml"
+ ],
+ "parameters": [
+ {
+ "name": "projectId",
+ "in": "path",
+ "description": "The project id.",
+ "required": true,
+ "type": "string",
+ "format": "uuid",
+ "x-nullable": false
+ },
+ {
+ "name": "iterationId",
+ "in": "query",
+ "description": "The iteration id. Defaults to workspace.",
+ "required": false,
+ "type": "string",
+ "format": "uuid"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "default": {
+ "description": "Error response",
+ "schema": {
+ "$ref": "#/definitions/CustomVisionError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Successful GetUntaggedImageCount request": {
+ "$ref": "./examples/GetUntaggedImageCount.json"
+ }
+ }
+ }
+ },
+ "/projects/{projectId}/images/urls": {
+ "post": {
+ "tags": [
+ "ImageApi"
+ ],
+ "summary": "Add the provided images urls to the set of training images.",
+ "description": "This API accepts a batch of urls, and optionally tags, to create images. There is a limit of 64 images and 20 tags.\r\nIf all images are successful created, 200(OK) status code will be returned.\r\nOtherwise, 207 (Multi-Status) status code will be returned and detail status for each image will be listed in the response payload.",
+ "operationId": "CreateImagesFromUrls",
+ "consumes": [
+ "application/json",
+ "application/xml",
+ "text/xml",
+ "application/x-www-form-urlencoded"
+ ],
+ "produces": [
+ "application/json",
+ "application/xml",
+ "text/xml"
+ ],
+ "parameters": [
+ {
+ "name": "projectId",
+ "in": "path",
+ "description": "The project id.",
+ "required": true,
+ "type": "string",
+ "format": "uuid",
+ "x-nullable": false
+ },
+ {
+ "name": "batch",
+ "in": "body",
+ "description": "Image urls, tag ids, and metadata. Limited to 64 images and 20 tags per batch.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/ImageUrlCreateBatch"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/ImageCreateSummary"
+ }
+ },
+ "207": {
+ "description": "207",
+ "schema": {
+ "$ref": "#/definitions/ImageCreateSummary"
+ }
+ },
+ "default": {
+ "description": "Error response",
+ "schema": {
+ "$ref": "#/definitions/CustomVisionError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Successful CreateImagesFromUrls request": {
+ "$ref": "./examples/CreateImagesFromUrls.json"
+ }
+ }
+ }
+ },
+ "/projects/{projectId}/iterations": {
+ "get": {
+ "tags": [
+ "ProjectApi"
+ ],
+ "summary": "Get iterations for the project.",
+ "operationId": "GetIterations",
+ "consumes": [],
+ "produces": [
+ "application/json",
+ "application/xml",
+ "text/xml"
+ ],
+ "parameters": [
+ {
+ "name": "projectId",
+ "in": "path",
+ "description": "The project id.",
+ "required": true,
+ "type": "string",
+ "format": "uuid",
+ "x-nullable": false
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/Iteration"
+ }
+ }
+ },
+ "default": {
+ "description": "Error response",
+ "schema": {
+ "$ref": "#/definitions/CustomVisionError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Successful GetIterations request": {
+ "$ref": "./examples/GetIterations.json"
+ }
+ }
+ }
+ },
+ "/projects/{projectId}/iterations/{iterationId}": {
+ "get": {
+ "tags": [
+ "ProjectApi"
+ ],
+ "summary": "Get a specific iteration.",
+ "operationId": "GetIteration",
+ "consumes": [],
+ "produces": [
+ "application/json",
+ "application/xml",
+ "text/xml"
+ ],
+ "parameters": [
+ {
+ "name": "projectId",
+ "in": "path",
+ "description": "The id of the project the iteration belongs to.",
+ "required": true,
+ "type": "string",
+ "format": "uuid",
+ "x-nullable": false
+ },
+ {
+ "name": "iterationId",
+ "in": "path",
+ "description": "The id of the iteration to get.",
+ "required": true,
+ "type": "string",
+ "format": "uuid",
+ "x-nullable": false
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/Iteration"
+ }
+ },
+ "default": {
+ "description": "Error response",
+ "schema": {
+ "$ref": "#/definitions/CustomVisionError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Successful GetIteration request": {
+ "$ref": "./examples/GetIteration.json"
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "ProjectApi"
+ ],
+ "summary": "Delete a specific iteration of a project.",
+ "operationId": "DeleteIteration",
+ "consumes": [],
+ "produces": [],
+ "parameters": [
+ {
+ "name": "projectId",
+ "in": "path",
+ "description": "The project id.",
+ "required": true,
+ "type": "string",
+ "format": "uuid",
+ "x-nullable": false
+ },
+ {
+ "name": "iterationId",
+ "in": "path",
+ "description": "The iteration id.",
+ "required": true,
+ "type": "string",
+ "format": "uuid",
+ "x-nullable": false
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "No Content"
+ },
+ "default": {
+ "description": "Error response",
+ "schema": {
+ "$ref": "#/definitions/CustomVisionError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Successful DeleteIteration request": {
+ "$ref": "./examples/DeleteIteration.json"
+ }
+ }
+ },
+ "patch": {
+ "tags": [
+ "ProjectApi"
+ ],
+ "summary": "Update a specific iteration.",
+ "operationId": "UpdateIteration",
+ "consumes": [
+ "application/json",
+ "application/xml",
+ "text/xml",
+ "application/x-www-form-urlencoded"
+ ],
+ "produces": [
+ "application/json",
+ "application/xml",
+ "text/xml"
+ ],
+ "parameters": [
+ {
+ "name": "projectId",
+ "in": "path",
+ "description": "Project id.",
+ "required": true,
+ "type": "string",
+ "format": "uuid",
+ "x-nullable": false
+ },
+ {
+ "name": "iterationId",
+ "in": "path",
+ "description": "Iteration id.",
+ "required": true,
+ "type": "string",
+ "format": "uuid",
+ "x-nullable": false
+ },
+ {
+ "name": "updatedIteration",
+ "in": "body",
+ "description": "The updated iteration model.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/Iteration"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/Iteration"
+ }
+ },
+ "default": {
+ "description": "Error response",
+ "schema": {
+ "$ref": "#/definitions/CustomVisionError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Successful UpdateIteration request": {
+ "$ref": "./examples/UpdateIteration.json"
+ }
+ }
+ }
+ },
+ "/projects/{projectId}/iterations/{iterationId}/export": {
+ "get": {
+ "tags": [
+ "ProjectApi"
+ ],
+ "summary": "Get the list of exports for a specific iteration.",
+ "operationId": "GetExports",
+ "consumes": [],
+ "produces": [
+ "application/json",
+ "application/xml",
+ "text/xml"
+ ],
+ "parameters": [
+ {
+ "name": "projectId",
+ "in": "path",
+ "description": "The project id.",
+ "required": true,
+ "type": "string",
+ "format": "uuid",
+ "x-nullable": false
+ },
+ {
+ "name": "iterationId",
+ "in": "path",
+ "description": "The iteration id.",
+ "required": true,
+ "type": "string",
+ "format": "uuid",
+ "x-nullable": false
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/Export"
+ }
+ }
+ },
+ "default": {
+ "description": "Error response",
+ "schema": {
+ "$ref": "#/definitions/CustomVisionError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Successful GetExports request": {
+ "$ref": "./examples/GetExports.json"
+ }
+ }
+ },
+ "post": {
+ "tags": [
+ "ProjectApi"
+ ],
+ "summary": "Export a trained iteration.",
+ "operationId": "ExportIteration",
+ "consumes": [],
+ "produces": [
+ "application/json",
+ "application/xml",
+ "text/xml"
+ ],
+ "parameters": [
+ {
+ "name": "projectId",
+ "in": "path",
+ "description": "The project id.",
+ "required": true,
+ "type": "string",
+ "format": "uuid",
+ "x-nullable": false
+ },
+ {
+ "name": "iterationId",
+ "in": "path",
+ "description": "The iteration id.",
+ "required": true,
+ "type": "string",
+ "format": "uuid",
+ "x-nullable": false
+ },
+ {
+ "name": "platform",
+ "in": "query",
+ "description": "The target platform.",
+ "required": true,
+ "type": "string",
+ "enum": [
+ "CoreML",
+ "TensorFlow",
+ "DockerFile",
+ "ONNX",
+ "VAIDK"
+ ]
+ },
+ {
+ "name": "flavor",
+ "in": "query",
+ "description": "The flavor of the target platform.",
+ "required": false,
+ "type": "string",
+ "enum": [
+ "Linux",
+ "Windows",
+ "ONNX10",
+ "ONNX12",
+ "ARM",
+ "TensorFlowNormal",
+ "TensorFlowLite"
+ ]
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/Export"
+ }
+ },
+ "default": {
+ "description": "Error response",
+ "schema": {
+ "$ref": "#/definitions/CustomVisionError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Successful ExportIteration request": {
+ "$ref": "./examples/ExportIteration.json"
+ }
+ }
+ }
+ },
+ "/projects/{projectId}/iterations/{iterationId}/performance": {
+ "get": {
+ "tags": [
+ "ProjectApi"
+ ],
+ "summary": "Get detailed performance information about an iteration.",
+ "operationId": "GetIterationPerformance",
+ "consumes": [],
+ "produces": [
+ "application/json",
+ "application/xml",
+ "text/xml"
+ ],
+ "parameters": [
+ {
+ "name": "projectId",
+ "in": "path",
+ "description": "The id of the project the iteration belongs to.",
+ "required": true,
+ "type": "string",
+ "format": "uuid",
+ "x-nullable": false
+ },
+ {
+ "name": "iterationId",
+ "in": "path",
+ "description": "The id of the iteration to get.",
+ "required": true,
+ "type": "string",
+ "format": "uuid",
+ "x-nullable": false
+ },
+ {
+ "name": "threshold",
+ "in": "query",
+ "description": "The threshold used to determine true predictions.",
+ "required": false,
+ "type": "number",
+ "format": "float"
+ },
+ {
+ "name": "overlapThreshold",
+ "in": "query",
+ "description": "If applicable, the bounding box overlap threshold used to determine true predictions.",
+ "required": false,
+ "type": "number",
+ "format": "float"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/IterationPerformance"
+ }
+ },
+ "default": {
+ "description": "Error response",
+ "schema": {
+ "$ref": "#/definitions/CustomVisionError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Successful GetIterationPerformance request": {
+ "$ref": "./examples/GetIterationPerformance.json"
+ }
+ }
+ }
+ },
+ "/projects/{projectId}/iterations/{iterationId}/performance/images": {
+ "get": {
+ "tags": [
+ "ProjectApi"
+ ],
+ "summary": "Get image with its prediction for a given project iteration.",
+ "description": "This API supports batching and range selection. By default it will only return first 50 images matching images.\r\nUse the {take} and {skip} parameters to control how many images to return in a given batch.\r\nThe filtering is on an and/or relationship. For example, if the provided tag ids are for the \"Dog\" and\r\n\"Cat\" tags, then only images tagged with Dog and/or Cat will be returned",
+ "operationId": "GetImagePerformances",
+ "consumes": [],
+ "produces": [
+ "application/json",
+ "application/xml",
+ "text/xml"
+ ],
+ "parameters": [
+ {
+ "name": "projectId",
+ "in": "path",
+ "description": "The project id.",
+ "required": true,
+ "type": "string",
+ "format": "uuid",
+ "x-nullable": false
+ },
+ {
+ "name": "iterationId",
+ "in": "path",
+ "description": "The iteration id. Defaults to workspace.",
+ "required": true,
+ "type": "string",
+ "format": "uuid",
+ "x-nullable": false
+ },
+ {
+ "name": "tagIds",
+ "in": "query",
+ "description": "A list of tags ids to filter the images. Defaults to all tagged images when null. Limited to 20.",
+ "required": false,
+ "type": "array",
+ "items": {
+ "type": "string",
+ "format": "uuid",
+ "x-nullable": false
+ },
+ "collectionFormat": "csv",
+ "maxItems": 20,
+ "minItems": 0
+ },
+ {
+ "name": "orderBy",
+ "in": "query",
+ "description": "The ordering. Defaults to newest.",
+ "required": false,
+ "type": "string",
+ "enum": [
+ "Newest",
+ "Oldest"
+ ]
+ },
+ {
+ "name": "take",
+ "in": "query",
+ "description": "Maximum number of images to return. Defaults to 50, limited to 256.",
+ "required": false,
+ "type": "integer",
+ "format": "int32",
+ "default": 50,
+ "maximum": 256,
+ "minimum": 0
+ },
+ {
+ "name": "skip",
+ "in": "query",
+ "description": "Number of images to skip before beginning the image batch. Defaults to 0.",
+ "required": false,
+ "type": "integer",
+ "format": "int32",
+ "default": 0
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ImagePerformance"
+ }
+ }
+ },
+ "default": {
+ "description": "Error response",
+ "schema": {
+ "$ref": "#/definitions/CustomVisionError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Successful GetImagePerformances request": {
+ "$ref": "./examples/GetImagePerformances.json"
+ }
+ }
+ }
+ },
+ "/projects/{projectId}/iterations/{iterationId}/performance/images/count": {
+ "get": {
+ "tags": [
+ "ProjectApi"
+ ],
+ "summary": "Gets the number of images tagged with the provided {tagIds} that have prediction results from\r\ntraining for the provided iteration {iterationId}.",
+ "description": "The filtering is on an and/or relationship. For example, if the provided tag ids are for the \"Dog\" and\r\n\"Cat\" tags, then only images tagged with Dog and/or Cat will be returned",
+ "operationId": "GetImagePerformanceCount",
+ "consumes": [],
+ "produces": [
+ "application/json",
+ "application/xml",
+ "text/xml"
+ ],
+ "parameters": [
+ {
+ "name": "projectId",
+ "in": "path",
+ "description": "The project id.",
+ "required": true,
+ "type": "string",
+ "format": "uuid",
+ "x-nullable": false
+ },
+ {
+ "name": "iterationId",
+ "in": "path",
+ "description": "The iteration id. Defaults to workspace.",
+ "required": true,
+ "type": "string",
+ "format": "uuid",
+ "x-nullable": false
+ },
+ {
+ "name": "tagIds",
+ "in": "query",
+ "description": "A list of tags ids to filter the images to count. Defaults to all tags when null.",
+ "required": false,
+ "type": "array",
+ "items": {
+ "type": "string",
+ "format": "uuid",
+ "x-nullable": false
+ },
+ "collectionFormat": "csv"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "default": {
+ "description": "Error response",
+ "schema": {
+ "$ref": "#/definitions/CustomVisionError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Successful GetImagePerformanceCount request": {
+ "$ref": "./examples/GetImagePerformanceCount.json"
+ }
+ }
+ }
+ },
+ "/projects/{projectId}/iterations/{iterationId}/publish": {
+ "post": {
+ "tags": [
+ "ProjectApi"
+ ],
+ "summary": "Publish a specific iteration.",
+ "operationId": "PublishIteration",
+ "consumes": [],
+ "produces": [
+ "application/json",
+ "application/xml",
+ "text/xml"
+ ],
+ "parameters": [
+ {
+ "name": "projectId",
+ "in": "path",
+ "description": "The project id.",
+ "required": true,
+ "type": "string",
+ "format": "uuid",
+ "x-nullable": false
+ },
+ {
+ "name": "iterationId",
+ "in": "path",
+ "description": "The iteration id.",
+ "required": true,
+ "type": "string",
+ "format": "uuid",
+ "x-nullable": false
+ },
+ {
+ "name": "publishName",
+ "in": "query",
+ "description": "The name to give the published iteration.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "predictionId",
+ "in": "query",
+ "description": "The id of the prediction resource to publish to.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "overwrite",
+ "in": "query",
+ "description": "Whether to overwrite the published model with the given name (default: false).",
+ "required": false,
+ "type": "boolean"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "type": "boolean"
+ }
+ },
+ "default": {
+ "description": "Error response",
+ "schema": {
+ "$ref": "#/definitions/CustomVisionError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Successful PublishIteration request": {
+ "$ref": "./examples/PublishIteration.json"
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "ProjectApi"
+ ],
+ "summary": "Unpublish a specific iteration.",
+ "operationId": "UnpublishIteration",
+ "consumes": [],
+ "produces": [],
+ "parameters": [
+ {
+ "name": "projectId",
+ "in": "path",
+ "description": "The project id.",
+ "required": true,
+ "type": "string",
+ "format": "uuid",
+ "x-nullable": false
+ },
+ {
+ "name": "iterationId",
+ "in": "path",
+ "description": "The iteration id.",
+ "required": true,
+ "type": "string",
+ "format": "uuid",
+ "x-nullable": false
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "No Content"
+ },
+ "default": {
+ "description": "Error response",
+ "schema": {
+ "$ref": "#/definitions/CustomVisionError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Successful UnpublishIteration request": {
+ "$ref": "./examples/UnpublishIteration.json"
+ }
+ }
+ }
+ },
+ "/projects/{projectId}/predictions": {
+ "delete": {
+ "tags": [
+ "PredictionsApi"
+ ],
+ "summary": "Delete a set of predicted images and their associated prediction results.",
+ "operationId": "DeletePrediction",
+ "consumes": [],
+ "produces": [],
+ "parameters": [
+ {
+ "name": "projectId",
+ "in": "path",
+ "description": "The project id.",
+ "required": true,
+ "type": "string",
+ "format": "uuid",
+ "x-nullable": false
+ },
+ {
+ "name": "ids",
+ "in": "query",
+ "description": "The prediction ids. Limited to 64.",
+ "required": true,
+ "type": "array",
+ "items": {
+ "type": "string",
+ "format": "uuid",
+ "x-nullable": false
+ },
+ "collectionFormat": "csv",
+ "maxItems": 64,
+ "minItems": 0
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "No Content"
+ },
+ "default": {
+ "description": "Error response",
+ "schema": {
+ "$ref": "#/definitions/CustomVisionError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Successful DeletePrediction request": {
+ "$ref": "./examples/DeletePrediction.json"
+ }
+ }
+ }
+ },
+ "/projects/{projectId}/predictions/query": {
+ "post": {
+ "tags": [
+ "PredictionsApi"
+ ],
+ "summary": "Get images that were sent to your prediction endpoint.",
+ "operationId": "QueryPredictions",
+ "consumes": [
+ "application/json",
+ "application/xml",
+ "text/xml",
+ "application/x-www-form-urlencoded"
+ ],
+ "produces": [
+ "application/json",
+ "application/xml",
+ "text/xml"
+ ],
+ "parameters": [
+ {
+ "name": "projectId",
+ "in": "path",
+ "description": "The project id.",
+ "required": true,
+ "type": "string",
+ "format": "uuid",
+ "x-nullable": false
+ },
+ {
+ "name": "query",
+ "in": "body",
+ "description": "Parameters used to query the predictions. Limited to combining 2 tags.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/PredictionQueryToken"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/PredictionQueryResult"
+ }
+ },
+ "default": {
+ "description": "Error response",
+ "schema": {
+ "$ref": "#/definitions/CustomVisionError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Successful QueryPredictions request": {
+ "$ref": "./examples/QueryPredictions.json"
+ }
+ }
+ }
+ },
+ "/projects/{projectId}/quicktest/image": {
+ "post": {
+ "tags": [
+ "PredictionsApi"
+ ],
+ "summary": "Quick test an image.",
+ "operationId": "QuickTestImage",
+ "consumes": [
+ "multipart/form-data",
+ "application/octet-stream"
+ ],
+ "produces": [
+ "application/json",
+ "application/xml",
+ "text/xml"
+ ],
+ "parameters": [
+ {
+ "name": "projectId",
+ "in": "path",
+ "description": "The project id.",
+ "required": true,
+ "type": "string",
+ "format": "uuid",
+ "x-nullable": false
+ },
+ {
+ "name": "iterationId",
+ "in": "query",
+ "description": "Optional. Specifies the id of a particular iteration to evaluate against.\r\n The default iteration for the project will be used when not specified.",
+ "required": false,
+ "type": "string",
+ "format": "uuid"
+ },
+ {
+ "name": "store",
+ "in": "query",
+ "description": "Optional. Specifies whether or not to store the result of this prediction. The default is true, to store.",
+ "required": false,
+ "type": "boolean",
+ "default": true
+ },
+ {
+ "name": "imageData",
+ "in": "formData",
+ "description": "Binary image data. Supported formats are JPEG, GIF, PNG, and BMP. Supports images up to 6MB.",
+ "required": true,
+ "type": "file"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/ImagePrediction"
+ }
+ },
+ "default": {
+ "description": "Error response",
+ "schema": {
+ "$ref": "#/definitions/CustomVisionError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Successful QuickTestImage request": {
+ "$ref": "./examples/QuickTestImage.json"
+ }
+ }
+ }
+ },
+ "/projects/{projectId}/quicktest/url": {
+ "post": {
+ "tags": [
+ "PredictionsApi"
+ ],
+ "summary": "Quick test an image url.",
+ "operationId": "QuickTestImageUrl",
+ "consumes": [
+ "application/json",
+ "application/xml",
+ "text/xml",
+ "application/x-www-form-urlencoded"
+ ],
+ "produces": [
+ "application/json",
+ "application/xml",
+ "text/xml"
+ ],
+ "parameters": [
+ {
+ "name": "projectId",
+ "in": "path",
+ "description": "The project to evaluate against.",
+ "required": true,
+ "type": "string",
+ "format": "uuid",
+ "x-nullable": false
+ },
+ {
+ "name": "imageUrl",
+ "in": "body",
+ "description": "An ImageUrl that contains the url of the image to be evaluated.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/ImageUrl"
+ }
+ },
+ {
+ "name": "iterationId",
+ "in": "query",
+ "description": "Optional. Specifies the id of a particular iteration to evaluate against.\r\n The default iteration for the project will be used when not specified.",
+ "required": false,
+ "type": "string",
+ "format": "uuid"
+ },
+ {
+ "name": "store",
+ "in": "query",
+ "description": "Optional. Specifies whether or not to store the result of this prediction. The default is true, to store.",
+ "required": false,
+ "type": "boolean",
+ "default": true
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/ImagePrediction"
+ }
+ },
+ "default": {
+ "description": "Error response",
+ "schema": {
+ "$ref": "#/definitions/CustomVisionError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Successful QuickTestImageUrl request": {
+ "$ref": "./examples/QuickTestImageUrl.json"
+ }
+ }
+ }
+ },
+ "/projects/{projectId}/tags": {
+ "get": {
+ "tags": [
+ "TagsApi"
+ ],
+ "summary": "Get the tags for a given project and iteration.",
+ "operationId": "GetTags",
+ "consumes": [],
+ "produces": [
+ "application/json",
+ "application/xml",
+ "text/xml"
+ ],
+ "parameters": [
+ {
+ "name": "projectId",
+ "in": "path",
+ "description": "The project id.",
+ "required": true,
+ "type": "string",
+ "format": "uuid",
+ "x-nullable": false
+ },
+ {
+ "name": "iterationId",
+ "in": "query",
+ "description": "The iteration id. Defaults to workspace.",
+ "required": false,
+ "type": "string",
+ "format": "uuid"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/Tag"
+ }
+ }
+ },
+ "default": {
+ "description": "Error response",
+ "schema": {
+ "$ref": "#/definitions/CustomVisionError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Successful GetTags request": {
+ "$ref": "./examples/GetTags.json"
+ }
+ }
+ },
+ "post": {
+ "tags": [
+ "TagsApi"
+ ],
+ "summary": "Create a tag for the project.",
+ "operationId": "CreateTag",
+ "consumes": [],
+ "produces": [
+ "application/json",
+ "application/xml",
+ "text/xml"
+ ],
+ "parameters": [
+ {
+ "name": "projectId",
+ "in": "path",
+ "description": "The project id.",
+ "required": true,
+ "type": "string",
+ "format": "uuid",
+ "x-nullable": false
+ },
+ {
+ "name": "name",
+ "in": "query",
+ "description": "The tag name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "description",
+ "in": "query",
+ "description": "Optional description for the tag.",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "name": "type",
+ "in": "query",
+ "description": "Optional type for the tag.",
+ "required": false,
+ "type": "string",
+ "enum": [
+ "Regular",
+ "Negative",
+ "GeneralProduct"
+ ]
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/Tag"
+ }
+ },
+ "default": {
+ "description": "Error response",
+ "schema": {
+ "$ref": "#/definitions/CustomVisionError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Successful CreateTag request": {
+ "$ref": "./examples/CreateTag.json"
+ }
+ }
+ }
+ },
+ "/projects/{projectId}/tags/{tagId}": {
+ "get": {
+ "tags": [
+ "TagsApi"
+ ],
+ "summary": "Get information about a specific tag.",
+ "operationId": "GetTag",
+ "consumes": [],
+ "produces": [
+ "application/json",
+ "application/xml",
+ "text/xml"
+ ],
+ "parameters": [
+ {
+ "name": "projectId",
+ "in": "path",
+ "description": "The project this tag belongs to.",
+ "required": true,
+ "type": "string",
+ "format": "uuid",
+ "x-nullable": false
+ },
+ {
+ "name": "tagId",
+ "in": "path",
+ "description": "The tag id.",
+ "required": true,
+ "type": "string",
+ "format": "uuid",
+ "x-nullable": false
+ },
+ {
+ "name": "iterationId",
+ "in": "query",
+ "description": "The iteration to retrieve this tag from. Optional, defaults to current training set.",
+ "required": false,
+ "type": "string",
+ "format": "uuid"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/Tag"
+ }
+ },
+ "default": {
+ "description": "Error response",
+ "schema": {
+ "$ref": "#/definitions/CustomVisionError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Successful GetTag request": {
+ "$ref": "./examples/GetTag.json"
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "TagsApi"
+ ],
+ "summary": "Delete a tag from the project.",
+ "operationId": "DeleteTag",
+ "consumes": [],
+ "produces": [],
+ "parameters": [
+ {
+ "name": "projectId",
+ "in": "path",
+ "description": "The project id.",
+ "required": true,
+ "type": "string",
+ "format": "uuid",
+ "x-nullable": false
+ },
+ {
+ "name": "tagId",
+ "in": "path",
+ "description": "Id of the tag to be deleted.",
+ "required": true,
+ "type": "string",
+ "format": "uuid",
+ "x-nullable": false
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "No Content"
+ },
+ "default": {
+ "description": "Error response",
+ "schema": {
+ "$ref": "#/definitions/CustomVisionError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Successful DeleteTag request": {
+ "$ref": "./examples/DeleteTag.json"
+ }
+ }
+ },
+ "patch": {
+ "tags": [
+ "TagsApi"
+ ],
+ "summary": "Update a tag.",
+ "operationId": "UpdateTag",
+ "consumes": [
+ "application/json",
+ "application/xml",
+ "text/xml",
+ "application/x-www-form-urlencoded"
+ ],
+ "produces": [
+ "application/json",
+ "application/xml",
+ "text/xml"
+ ],
+ "parameters": [
+ {
+ "name": "projectId",
+ "in": "path",
+ "description": "The project id.",
+ "required": true,
+ "type": "string",
+ "format": "uuid",
+ "x-nullable": false
+ },
+ {
+ "name": "tagId",
+ "in": "path",
+ "description": "The id of the target tag.",
+ "required": true,
+ "type": "string",
+ "format": "uuid",
+ "x-nullable": false
+ },
+ {
+ "name": "updatedTag",
+ "in": "body",
+ "description": "The updated tag model.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/Tag"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/Tag"
+ }
+ },
+ "default": {
+ "description": "Error response",
+ "schema": {
+ "$ref": "#/definitions/CustomVisionError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Successful UpdateTag request": {
+ "$ref": "./examples/UpdateTag.json"
+ }
+ }
+ }
+ },
+ "/projects/{projectId}/tagsandregions/suggestions": {
+ "post": {
+ "tags": [
+ "SuggestTagsAndRegionsApi"
+ ],
+ "summary": "Suggest tags and regions for an array/batch of untagged images. Returns empty array if no tags are found.",
+ "description": "This API will get suggested tags and regions for an array/batch of untagged images along with confidences for the tags. It returns an empty array if no tags are found.\r\nThere is a limit of 64 images in the batch.",
+ "operationId": "SuggestTagsAndRegions",
+ "consumes": [],
+ "produces": [
+ "application/json",
+ "application/xml",
+ "text/xml"
+ ],
+ "parameters": [
+ {
+ "name": "projectId",
+ "in": "path",
+ "description": "The project id.",
+ "required": true,
+ "type": "string",
+ "format": "uuid",
+ "x-nullable": false
+ },
+ {
+ "name": "iterationId",
+ "in": "query",
+ "description": "IterationId to use for tag and region suggestion.",
+ "required": true,
+ "type": "string",
+ "format": "uuid",
+ "x-nullable": false
+ },
+ {
+ "name": "imageIds",
+ "in": "query",
+ "description": "Array of image ids tag suggestion are needed for. Use GetUntaggedImages API to get imageIds.",
+ "required": true,
+ "type": "array",
+ "items": {
+ "type": "string",
+ "format": "uuid",
+ "x-nullable": false
+ },
+ "collectionFormat": "csv",
+ "maxItems": 64,
+ "minItems": 0
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/SuggestedTagAndRegion"
+ }
+ }
+ },
+ "default": {
+ "description": "Error response",
+ "schema": {
+ "$ref": "#/definitions/CustomVisionError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Successful SuggestTagsAndRegions request": {
+ "$ref": "./examples/SuggestTagsAndRegions.json"
+ }
+ }
+ }
+ },
+ "/projects/{projectId}/train": {
+ "post": {
+ "tags": [
+ "ProjectApi"
+ ],
+ "summary": "Queues project for training.",
+ "operationId": "TrainProject",
+ "consumes": [
+ "application/json",
+ "application/xml",
+ "text/xml",
+ "application/x-www-form-urlencoded"
+ ],
+ "produces": [
+ "application/json",
+ "application/xml",
+ "text/xml"
+ ],
+ "parameters": [
+ {
+ "name": "projectId",
+ "in": "path",
+ "description": "The project id.",
+ "required": true,
+ "type": "string",
+ "format": "uuid",
+ "x-nullable": false
+ },
+ {
+ "name": "trainingType",
+ "in": "query",
+ "description": "The type of training to use to train the project (default: Regular).",
+ "required": false,
+ "type": "string",
+ "enum": [
+ "Regular",
+ "Advanced"
+ ]
+ },
+ {
+ "name": "reservedBudgetInHours",
+ "in": "query",
+ "description": "The number of hours reserved as budget for training (if applicable).",
+ "required": false,
+ "type": "integer",
+ "format": "int32",
+ "default": 0
+ },
+ {
+ "name": "forceTrain",
+ "in": "query",
+ "description": "Whether to force train even if dataset and configuration does not change (default: false).",
+ "required": false,
+ "type": "boolean",
+ "default": false
+ },
+ {
+ "name": "notificationEmailAddress",
+ "in": "query",
+ "description": "The email address to send notification to when training finishes (default: null).",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "name": "trainingParameters",
+ "in": "body",
+ "description": "Additional training parameters passed in to control how the project is trained.",
+ "required": false,
+ "schema": {
+ "$ref": "#/definitions/TrainingParameters"
+ },
+ "x-nullable": true
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/Iteration"
+ }
+ },
+ "default": {
+ "description": "Error response",
+ "schema": {
+ "$ref": "#/definitions/CustomVisionError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Successful TrainProject request": {
+ "$ref": "./examples/TrainProject.json"
+ }
+ }
+ }
+ },
+ "/projects/import": {
+ "post": {
+ "tags": [
+ "ProjectApi"
+ ],
+ "summary": "Imports a project.",
+ "operationId": "ImportProject",
+ "consumes": [],
+ "produces": [
+ "application/json",
+ "application/xml",
+ "text/xml"
+ ],
+ "parameters": [
+ {
+ "name": "token",
+ "in": "query",
+ "description": "Token generated from the export project call.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "name",
+ "in": "query",
+ "description": "Optional, name of the project to use instead of auto-generated name.",
+ "required": false,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/Project"
+ }
+ },
+ "default": {
+ "description": "Error response",
+ "schema": {
+ "$ref": "#/definitions/CustomVisionError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Successful ImportProject request": {
+ "$ref": "./examples/ImportProject.json"
+ }
+ }
+ }
+ }
+ },
+ "definitions": {
+ "BoundingBox": {
+ "description": "Bounding box that defines a region of an image.",
+ "required": [
+ "left",
+ "top",
+ "width",
+ "height"
+ ],
+ "type": "object",
+ "properties": {
+ "left": {
+ "format": "float",
+ "description": "Coordinate of the left boundary.",
+ "type": "number",
+ "readOnly": false,
+ "x-nullable": false
+ },
+ "top": {
+ "format": "float",
+ "description": "Coordinate of the top boundary.",
+ "type": "number",
+ "readOnly": false,
+ "x-nullable": false
+ },
+ "width": {
+ "format": "float",
+ "description": "Width.",
+ "type": "number",
+ "readOnly": false,
+ "x-nullable": false
+ },
+ "height": {
+ "format": "float",
+ "description": "Height.",
+ "type": "number",
+ "readOnly": false,
+ "x-nullable": false
+ }
+ }
+ },
+ "CustomVisionError": {
+ "required": [
+ "code",
+ "message"
+ ],
+ "type": "object",
+ "properties": {
+ "code": {
+ "description": "The error code.",
+ "enum": [
+ "NoError",
+ "BadRequest",
+ "BadRequestExceededBatchSize",
+ "BadRequestNotSupported",
+ "BadRequestInvalidIds",
+ "BadRequestProjectName",
+ "BadRequestProjectNameNotUnique",
+ "BadRequestProjectDescription",
+ "BadRequestProjectUnknownDomain",
+ "BadRequestProjectUnknownClassification",
+ "BadRequestProjectUnsupportedDomainTypeChange",
+ "BadRequestProjectUnsupportedExportPlatform",
+ "BadRequestProjectImagePreprocessingSettings",
+ "BadRequestProjectDuplicated",
+ "BadRequestIterationName",
+ "BadRequestIterationNameNotUnique",
+ "BadRequestIterationDescription",
+ "BadRequestIterationIsNotTrained",
+ "BadRequestIterationValidationFailed",
+ "BadRequestWorkspaceCannotBeModified",
+ "BadRequestWorkspaceNotDeletable",
+ "BadRequestTagName",
+ "BadRequestTagNameNotUnique",
+ "BadRequestTagDescription",
+ "BadRequestTagType",
+ "BadRequestMultipleNegativeTag",
+ "BadRequestMultipleGeneralProductTag",
+ "BadRequestImageTags",
+ "BadRequestImageRegions",
+ "BadRequestNegativeAndRegularTagOnSameImage",
+ "BadRequestUnsupportedDomain",
+ "BadRequestRequiredParamIsNull",
+ "BadRequestIterationIsPublished",
+ "BadRequestInvalidPublishName",
+ "BadRequestInvalidPublishTarget",
+ "BadRequestUnpublishFailed",
+ "BadRequestIterationNotPublished",
+ "BadRequestSubscriptionApi",
+ "BadRequestExceedProjectLimit",
+ "BadRequestExceedIterationPerProjectLimit",
+ "BadRequestExceedTagPerProjectLimit",
+ "BadRequestExceedTagPerImageLimit",
+ "BadRequestExceededQuota",
+ "BadRequestCannotMigrateProjectWithName",
+ "BadRequestNotLimitedTrial",
+ "BadRequestImageBatch",
+ "BadRequestImageStream",
+ "BadRequestImageUrl",
+ "BadRequestImageFormat",
+ "BadRequestImageSizeBytes",
+ "BadRequestImageDimensions",
+ "BadRequestImageExceededCount",
+ "BadRequestTrainingNotNeeded",
+ "BadRequestTrainingNotNeededButTrainingPipelineUpdated",
+ "BadRequestTrainingValidationFailed",
+ "BadRequestClassificationTrainingValidationFailed",
+ "BadRequestMultiClassClassificationTrainingValidationFailed",
+ "BadRequestMultiLabelClassificationTrainingValidationFailed",
+ "BadRequestDetectionTrainingValidationFailed",
+ "BadRequestTrainingAlreadyInProgress",
+ "BadRequestDetectionTrainingNotAllowNegativeTag",
+ "BadRequestInvalidEmailAddress",
+ "BadRequestDomainNotSupportedForAdvancedTraining",
+ "BadRequestExportPlatformNotSupportedForAdvancedTraining",
+ "BadRequestReservedBudgetInHoursNotEnoughForAdvancedTraining",
+ "BadRequestExportValidationFailed",
+ "BadRequestExportAlreadyInProgress",
+ "BadRequestPredictionIdsMissing",
+ "BadRequestPredictionIdsExceededCount",
+ "BadRequestPredictionTagsExceededCount",
+ "BadRequestPredictionResultsExceededCount",
+ "BadRequestPredictionInvalidApplicationName",
+ "BadRequestPredictionInvalidQueryParameters",
+ "BadRequestInvalidImportToken",
+ "BadRequestExportWhileTraining",
+ "BadRequestImageMetadataKey",
+ "BadRequestImageMetadataValue",
+ "BadRequestOperationNotSupported",
+ "BadRequestInvalidArtifactUri",
+ "BadRequestCustomerManagedKeyRevoked",
+ "BadRequestInvalid",
+ "UnsupportedMediaType",
+ "Forbidden",
+ "ForbiddenUser",
+ "ForbiddenUserResource",
+ "ForbiddenUserSignupDisabled",
+ "ForbiddenUserSignupAllowanceExceeded",
+ "ForbiddenUserDoesNotExist",
+ "ForbiddenUserDisabled",
+ "ForbiddenUserInsufficientCapability",
+ "ForbiddenDRModeEnabled",
+ "ForbiddenInvalid",
+ "NotFound",
+ "NotFoundProject",
+ "NotFoundProjectDefaultIteration",
+ "NotFoundIteration",
+ "NotFoundIterationPerformance",
+ "NotFoundTag",
+ "NotFoundImage",
+ "NotFoundDomain",
+ "NotFoundApimSubscription",
+ "NotFoundInvalid",
+ "Conflict",
+ "ConflictInvalid",
+ "ErrorUnknown",
+ "ErrorIterationCopyFailed",
+ "ErrorPreparePerformanceMigrationFailed",
+ "ErrorProjectInvalidWorkspace",
+ "ErrorProjectInvalidPipelineConfiguration",
+ "ErrorProjectInvalidDomain",
+ "ErrorProjectTrainingRequestFailed",
+ "ErrorProjectImportRequestFailed",
+ "ErrorProjectExportRequestFailed",
+ "ErrorFeaturizationServiceUnavailable",
+ "ErrorFeaturizationQueueTimeout",
+ "ErrorFeaturizationInvalidFeaturizer",
+ "ErrorFeaturizationAugmentationUnavailable",
+ "ErrorFeaturizationUnrecognizedJob",
+ "ErrorFeaturizationAugmentationError",
+ "ErrorExporterInvalidPlatform",
+ "ErrorExporterInvalidFeaturizer",
+ "ErrorExporterInvalidClassifier",
+ "ErrorPredictionServiceUnavailable",
+ "ErrorPredictionModelNotFound",
+ "ErrorPredictionModelNotCached",
+ "ErrorPrediction",
+ "ErrorPredictionStorage",
+ "ErrorRegionProposal",
+ "ErrorUnknownBaseModel",
+ "ErrorInvalid"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "CustomVisionErrorCodes",
+ "modelAsString": true
+ }
+ },
+ "message": {
+ "description": "A message explaining the error reported by the service.",
+ "type": "string"
+ }
+ }
+ },
+ "Domain": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "format": "uuid",
+ "type": "string",
+ "readOnly": true,
+ "example": "00000000-0000-0000-0000-000000000000",
+ "x-nullable": false
+ },
+ "name": {
+ "type": "string",
+ "readOnly": true,
+ "x-nullable": false
+ },
+ "type": {
+ "enum": [
+ "Classification",
+ "ObjectDetection"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-nullable": false,
+ "x-ms-enum": {
+ "name": "DomainType",
+ "modelAsString": true
+ }
+ },
+ "exportable": {
+ "type": "boolean",
+ "readOnly": true,
+ "x-nullable": false
+ },
+ "enabled": {
+ "type": "boolean",
+ "readOnly": true,
+ "x-nullable": false
+ }
+ }
+ },
+ "Export": {
+ "type": "object",
+ "properties": {
+ "platform": {
+ "description": "Platform of the export.",
+ "enum": [
+ "CoreML",
+ "TensorFlow",
+ "DockerFile",
+ "ONNX",
+ "VAIDK"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-nullable": false,
+ "x-ms-enum": {
+ "name": "ExportPlatform",
+ "modelAsString": true
+ }
+ },
+ "status": {
+ "description": "Status of the export.",
+ "enum": [
+ "Exporting",
+ "Failed",
+ "Done"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-nullable": false,
+ "x-ms-enum": {
+ "name": "ExportStatus",
+ "modelAsString": true
+ }
+ },
+ "downloadUri": {
+ "description": "URI used to download the model. If VNET feature is enabled this will be a relative path to be used with GetArtifact, otherwise this will be an absolute URI to the resource.",
+ "type": "string",
+ "readOnly": true
+ },
+ "flavor": {
+ "description": "Flavor of the export. These are specializations of the export platform.\r\nDocker platform has valid flavors: Linux, Windows, ARM.\r\nTensorflow platform has valid flavors: TensorFlowNormal, TensorFlowLite.\r\nONNX platform has valid flavors: ONNX10, ONNX12.",
+ "enum": [
+ "Linux",
+ "Windows",
+ "ONNX10",
+ "ONNX12",
+ "ARM",
+ "TensorFlowNormal",
+ "TensorFlowLite"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-nullable": true,
+ "x-ms-enum": {
+ "name": "ExportFlavor",
+ "modelAsString": true
+ }
+ },
+ "newerVersionAvailable": {
+ "description": "Indicates an updated version of the export package is available and should be re-exported for the latest changes.",
+ "type": "boolean",
+ "readOnly": true,
+ "x-nullable": false
+ }
+ }
+ },
+ "Image": {
+ "description": "Image model to be sent as JSON.",
+ "type": "object",
+ "properties": {
+ "id": {
+ "format": "uuid",
+ "description": "Id of the image.",
+ "type": "string",
+ "readOnly": true,
+ "example": "00000000-0000-0000-0000-000000000000",
+ "x-nullable": false
+ },
+ "created": {
+ "format": "date-time",
+ "description": "Date the image was created.",
+ "type": "string",
+ "readOnly": true,
+ "x-nullable": false
+ },
+ "width": {
+ "format": "int32",
+ "description": "Width of the image.",
+ "type": "integer",
+ "readOnly": true,
+ "x-nullable": false
+ },
+ "height": {
+ "format": "int32",
+ "description": "Height of the image.",
+ "type": "integer",
+ "readOnly": true,
+ "x-nullable": false
+ },
+ "resizedImageUri": {
+ "description": "The URI to the (resized) image used for training. If VNET feature is enabled this will be a relative path to be used with GetArtifact, otherwise this will be an absolute URI to the resource.",
+ "type": "string",
+ "readOnly": true
+ },
+ "thumbnailUri": {
+ "description": "The URI to the thumbnail of the original image. If VNET feature is enabled this will be a relative path to be used with GetArtifact, otherwise this will be an absolute URI to the resource.",
+ "type": "string",
+ "readOnly": true
+ },
+ "originalImageUri": {
+ "description": "The URI to the original uploaded image. If VNET feature is enabled this will be a relative path to be used with GetArtifact, otherwise this will be an absolute URI to the resource.",
+ "type": "string",
+ "readOnly": true
+ },
+ "tags": {
+ "description": "Tags associated with this image.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ImageTag"
+ },
+ "readOnly": true,
+ "x-nullable": true
+ },
+ "regions": {
+ "description": "Regions associated with this image.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ImageRegion"
+ },
+ "readOnly": true,
+ "x-nullable": true
+ },
+ "metadata": {
+ "description": "Metadata associated with this image.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ },
+ "readOnly": true,
+ "x-nullable": true
+ }
+ }
+ },
+ "ImageCreateResult": {
+ "type": "object",
+ "properties": {
+ "sourceUrl": {
+ "description": "Source URL of the image.",
+ "type": "string",
+ "readOnly": true,
+ "x-nullable": false
+ },
+ "status": {
+ "description": "Status of the image creation.",
+ "enum": [
+ "OK",
+ "OKDuplicate",
+ "ErrorSource",
+ "ErrorImageFormat",
+ "ErrorImageSize",
+ "ErrorStorage",
+ "ErrorLimitExceed",
+ "ErrorTagLimitExceed",
+ "ErrorRegionLimitExceed",
+ "ErrorUnknown",
+ "ErrorNegativeAndRegularTagOnSameImage"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-nullable": false,
+ "x-ms-enum": {
+ "name": "ImageCreateStatus",
+ "modelAsString": true
+ }
+ },
+ "image": {
+ "$ref": "#/definitions/Image",
+ "description": "The image.",
+ "readOnly": true
+ }
+ }
+ },
+ "ImageCreateSummary": {
+ "type": "object",
+ "properties": {
+ "isBatchSuccessful": {
+ "description": "True if all of the images in the batch were created successfully, otherwise false.",
+ "type": "boolean",
+ "readOnly": true,
+ "x-nullable": false
+ },
+ "images": {
+ "description": "List of the image creation results.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ImageCreateResult",
+ "x-nullable": false
+ },
+ "readOnly": true
+ }
+ }
+ },
+ "ImageFileCreateBatch": {
+ "type": "object",
+ "properties": {
+ "images": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ImageFileCreateEntry",
+ "x-nullable": false
+ },
+ "readOnly": false
+ },
+ "tagIds": {
+ "type": "array",
+ "items": {
+ "format": "uuid",
+ "type": "string",
+ "example": "00000000-0000-0000-0000-000000000000",
+ "x-nullable": false
+ },
+ "readOnly": false
+ },
+ "metadata": {
+ "description": "The metadata of image. Limited to 50 key-value pairs per image. The length of key is limited to 256. The length of value is limited to 512.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ },
+ "readOnly": false,
+ "x-nullable": true
+ }
+ }
+ },
+ "ImageFileCreateEntry": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "readOnly": false,
+ "x-nullable": false
+ },
+ "contents": {
+ "format": "byte",
+ "type": "string",
+ "readOnly": false
+ },
+ "tagIds": {
+ "type": "array",
+ "items": {
+ "format": "uuid",
+ "type": "string",
+ "example": "00000000-0000-0000-0000-000000000000",
+ "x-nullable": false
+ },
+ "readOnly": false
+ },
+ "regions": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/Region",
+ "x-nullable": false
+ },
+ "readOnly": false
+ }
+ }
+ },
+ "ImageIdCreateBatch": {
+ "type": "object",
+ "properties": {
+ "images": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ImageIdCreateEntry",
+ "x-nullable": false
+ },
+ "readOnly": false
+ },
+ "tagIds": {
+ "type": "array",
+ "items": {
+ "format": "uuid",
+ "type": "string",
+ "x-nullable": false
+ },
+ "readOnly": false
+ },
+ "metadata": {
+ "description": "The metadata of image. Limited to 50 key-value pairs per image. The length of key is limited to 256. The length of value is limited to 512.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ },
+ "readOnly": false,
+ "x-nullable": true
+ }
+ }
+ },
+ "ImageIdCreateEntry": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "format": "uuid",
+ "description": "Id of the image.",
+ "type": "string",
+ "readOnly": false,
+ "x-nullable": false
+ },
+ "tagIds": {
+ "type": "array",
+ "items": {
+ "format": "uuid",
+ "type": "string",
+ "x-nullable": false
+ },
+ "readOnly": false
+ },
+ "regions": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/Region",
+ "x-nullable": false
+ },
+ "readOnly": false
+ }
+ }
+ },
+ "ImageMetadataUpdateEntry": {
+ "description": "Entry associating a metadata to an image.",
+ "type": "object",
+ "properties": {
+ "imageId": {
+ "format": "uuid",
+ "description": "Id of the image.",
+ "type": "string",
+ "readOnly": false,
+ "x-nullable": false
+ },
+ "status": {
+ "description": "Status of the metadata update.",
+ "enum": [
+ "OK",
+ "ErrorImageNotFound",
+ "ErrorLimitExceed",
+ "ErrorUnknown"
+ ],
+ "type": "string",
+ "readOnly": false,
+ "x-nullable": false,
+ "x-ms-enum": {
+ "name": "ImageMetadataUpdateStatus",
+ "modelAsString": true
+ }
+ },
+ "metadata": {
+ "description": "Metadata of the image.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ },
+ "readOnly": false,
+ "x-nullable": true
+ }
+ }
+ },
+ "ImageMetadataUpdateSummary": {
+ "type": "object",
+ "properties": {
+ "isBatchSuccessful": {
+ "type": "boolean",
+ "readOnly": true,
+ "x-nullable": false
+ },
+ "images": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ImageMetadataUpdateEntry",
+ "x-nullable": false
+ },
+ "readOnly": true
+ }
+ }
+ },
+ "ImagePerformance": {
+ "description": "Image performance model.",
+ "type": "object",
+ "properties": {
+ "predictions": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/Prediction"
+ },
+ "readOnly": true,
+ "x-nullable": true
+ },
+ "id": {
+ "format": "uuid",
+ "type": "string",
+ "readOnly": true,
+ "x-nullable": false
+ },
+ "created": {
+ "format": "date-time",
+ "type": "string",
+ "readOnly": true,
+ "x-nullable": false
+ },
+ "width": {
+ "format": "int32",
+ "type": "integer",
+ "readOnly": true,
+ "x-nullable": false
+ },
+ "height": {
+ "format": "int32",
+ "type": "integer",
+ "readOnly": true,
+ "x-nullable": false
+ },
+ "imageUri": {
+ "type": "string",
+ "readOnly": true
+ },
+ "thumbnailUri": {
+ "type": "string",
+ "readOnly": true
+ },
+ "tags": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ImageTag"
+ },
+ "readOnly": true,
+ "x-nullable": true
+ },
+ "regions": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ImageRegion"
+ },
+ "readOnly": true,
+ "x-nullable": true
+ }
+ }
+ },
+ "ImagePrediction": {
+ "description": "Result of an image prediction request.",
+ "type": "object",
+ "properties": {
+ "id": {
+ "format": "uuid",
+ "description": "Prediction Id.",
+ "type": "string",
+ "readOnly": true,
+ "x-nullable": false
+ },
+ "project": {
+ "format": "uuid",
+ "description": "Project Id.",
+ "type": "string",
+ "readOnly": true,
+ "x-nullable": false
+ },
+ "iteration": {
+ "format": "uuid",
+ "description": "Iteration Id.",
+ "type": "string",
+ "readOnly": true,
+ "x-nullable": false
+ },
+ "created": {
+ "format": "date-time",
+ "description": "Date this prediction was created.",
+ "type": "string",
+ "readOnly": true,
+ "x-nullable": false
+ },
+ "predictions": {
+ "description": "List of predictions.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/Prediction",
+ "x-nullable": false
+ },
+ "readOnly": true
+ }
+ }
+ },
+ "ImageProcessingSettings": {
+ "description": "Represents image preprocessing settings used by image augmentation.",
+ "type": "object",
+ "properties": {
+ "augmentationMethods": {
+ "description": "Gets or sets enabled image transforms. The key corresponds to the transform name. If value is set to true, then correspondent transform is enabled. Otherwise this transform will not be used.\r\nAugmentation will be uniformly distributed among enabled transforms.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "boolean"
+ },
+ "readOnly": false,
+ "x-nullable": true
+ }
+ }
+ },
+ "ImageRegion": {
+ "required": [
+ "tagId",
+ "left",
+ "top",
+ "width",
+ "height"
+ ],
+ "type": "object",
+ "properties": {
+ "regionId": {
+ "format": "uuid",
+ "type": "string",
+ "readOnly": true,
+ "x-nullable": false
+ },
+ "tagName": {
+ "type": "string",
+ "readOnly": true,
+ "x-nullable": false
+ },
+ "created": {
+ "format": "date-time",
+ "type": "string",
+ "readOnly": true,
+ "x-nullable": false
+ },
+ "tagId": {
+ "format": "uuid",
+ "description": "Id of the tag associated with this region.",
+ "type": "string",
+ "readOnly": false,
+ "x-nullable": false
+ },
+ "left": {
+ "format": "float",
+ "description": "Coordinate of the left boundary.",
+ "type": "number",
+ "readOnly": false,
+ "x-nullable": false
+ },
+ "top": {
+ "format": "float",
+ "description": "Coordinate of the top boundary.",
+ "type": "number",
+ "readOnly": false,
+ "x-nullable": false
+ },
+ "width": {
+ "format": "float",
+ "description": "Width.",
+ "type": "number",
+ "readOnly": false,
+ "x-nullable": false
+ },
+ "height": {
+ "format": "float",
+ "description": "Height.",
+ "type": "number",
+ "readOnly": false,
+ "x-nullable": false
+ }
+ }
+ },
+ "ImageRegionCreateBatch": {
+ "description": "Batch of image region information to create.",
+ "type": "object",
+ "properties": {
+ "regions": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ImageRegionCreateEntry",
+ "x-nullable": false
+ },
+ "readOnly": false
+ }
+ }
+ },
+ "ImageRegionCreateEntry": {
+ "description": "Entry associating a region to an image.",
+ "required": [
+ "imageId",
+ "tagId",
+ "left",
+ "top",
+ "width",
+ "height"
+ ],
+ "type": "object",
+ "properties": {
+ "imageId": {
+ "format": "uuid",
+ "description": "Id of the image.",
+ "type": "string",
+ "readOnly": false,
+ "x-nullable": false
+ },
+ "tagId": {
+ "format": "uuid",
+ "description": "Id of the tag associated with this region.",
+ "type": "string",
+ "readOnly": false,
+ "x-nullable": false
+ },
+ "left": {
+ "format": "float",
+ "description": "Coordinate of the left boundary.",
+ "type": "number",
+ "readOnly": false,
+ "x-nullable": false
+ },
+ "top": {
+ "format": "float",
+ "description": "Coordinate of the top boundary.",
+ "type": "number",
+ "readOnly": false,
+ "x-nullable": false
+ },
+ "width": {
+ "format": "float",
+ "description": "Width.",
+ "type": "number",
+ "readOnly": false,
+ "x-nullable": false
+ },
+ "height": {
+ "format": "float",
+ "description": "Height.",
+ "type": "number",
+ "readOnly": false,
+ "x-nullable": false
+ }
+ }
+ },
+ "ImageRegionCreateResult": {
+ "required": [
+ "tagId",
+ "left",
+ "top",
+ "width",
+ "height"
+ ],
+ "type": "object",
+ "properties": {
+ "imageId": {
+ "format": "uuid",
+ "type": "string",
+ "readOnly": true,
+ "x-nullable": false
+ },
+ "regionId": {
+ "format": "uuid",
+ "type": "string",
+ "readOnly": true,
+ "x-nullable": false
+ },
+ "tagName": {
+ "type": "string",
+ "readOnly": true,
+ "x-nullable": false
+ },
+ "created": {
+ "format": "date-time",
+ "type": "string",
+ "readOnly": true,
+ "x-nullable": false
+ },
+ "tagId": {
+ "format": "uuid",
+ "description": "Id of the tag associated with this region.",
+ "type": "string",
+ "readOnly": false,
+ "x-nullable": false
+ },
+ "left": {
+ "format": "float",
+ "description": "Coordinate of the left boundary.",
+ "type": "number",
+ "readOnly": false,
+ "x-nullable": false
+ },
+ "top": {
+ "format": "float",
+ "description": "Coordinate of the top boundary.",
+ "type": "number",
+ "readOnly": false,
+ "x-nullable": false
+ },
+ "width": {
+ "format": "float",
+ "description": "Width.",
+ "type": "number",
+ "readOnly": false,
+ "x-nullable": false
+ },
+ "height": {
+ "format": "float",
+ "description": "Height.",
+ "type": "number",
+ "readOnly": false,
+ "x-nullable": false
+ }
+ }
+ },
+ "ImageRegionCreateSummary": {
+ "type": "object",
+ "properties": {
+ "created": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ImageRegionCreateResult"
+ },
+ "readOnly": false,
+ "x-nullable": true
+ },
+ "duplicated": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ImageRegionCreateEntry"
+ },
+ "readOnly": false,
+ "x-nullable": true
+ },
+ "exceeded": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ImageRegionCreateEntry"
+ },
+ "readOnly": false,
+ "x-nullable": true
+ }
+ }
+ },
+ "ImageRegionProposal": {
+ "type": "object",
+ "properties": {
+ "projectId": {
+ "format": "uuid",
+ "type": "string",
+ "readOnly": true,
+ "x-nullable": false
+ },
+ "imageId": {
+ "format": "uuid",
+ "type": "string",
+ "readOnly": true,
+ "x-nullable": false
+ },
+ "proposals": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/RegionProposal",
+ "x-nullable": false
+ },
+ "readOnly": true
+ }
+ }
+ },
+ "ImageTag": {
+ "type": "object",
+ "properties": {
+ "tagId": {
+ "format": "uuid",
+ "type": "string",
+ "readOnly": true,
+ "x-nullable": false
+ },
+ "tagName": {
+ "type": "string",
+ "readOnly": true,
+ "x-nullable": false
+ },
+ "created": {
+ "format": "date-time",
+ "type": "string",
+ "readOnly": true,
+ "x-nullable": false
+ }
+ }
+ },
+ "ImageTagCreateBatch": {
+ "description": "Batch of image tags.",
+ "type": "object",
+ "properties": {
+ "tags": {
+ "description": "Image Tag entries to include in this batch.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ImageTagCreateEntry",
+ "x-nullable": false
+ },
+ "readOnly": false
+ }
+ }
+ },
+ "ImageTagCreateEntry": {
+ "description": "Entry associating a tag to an image.",
+ "type": "object",
+ "properties": {
+ "imageId": {
+ "format": "uuid",
+ "description": "Id of the image.",
+ "type": "string",
+ "readOnly": false,
+ "x-nullable": false
+ },
+ "tagId": {
+ "format": "uuid",
+ "description": "Id of the tag.",
+ "type": "string",
+ "readOnly": false,
+ "x-nullable": false
+ }
+ }
+ },
+ "ImageTagCreateSummary": {
+ "type": "object",
+ "properties": {
+ "created": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ImageTagCreateEntry"
+ },
+ "readOnly": false,
+ "x-nullable": true
+ },
+ "duplicated": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ImageTagCreateEntry"
+ },
+ "readOnly": false,
+ "x-nullable": true
+ },
+ "exceeded": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ImageTagCreateEntry"
+ },
+ "readOnly": false,
+ "x-nullable": true
+ }
+ }
+ },
+ "ImageUrl": {
+ "description": "Image url.",
+ "required": [
+ "url"
+ ],
+ "type": "object",
+ "properties": {
+ "url": {
+ "description": "Url of the image.",
+ "type": "string",
+ "readOnly": false,
+ "x-nullable": false
+ }
+ }
+ },
+ "ImageUrlCreateBatch": {
+ "type": "object",
+ "properties": {
+ "images": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ImageUrlCreateEntry",
+ "x-nullable": false
+ },
+ "readOnly": false
+ },
+ "tagIds": {
+ "type": "array",
+ "items": {
+ "format": "uuid",
+ "type": "string",
+ "x-nullable": false
+ },
+ "readOnly": false
+ },
+ "metadata": {
+ "description": "The metadata of image. Limited to 50 key-value pairs per image. The length of key is limited to 256. The length of value is limited to 512.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ },
+ "readOnly": false,
+ "x-nullable": true
+ }
+ }
+ },
+ "ImageUrlCreateEntry": {
+ "required": [
+ "url"
+ ],
+ "type": "object",
+ "properties": {
+ "url": {
+ "description": "Url of the image.",
+ "type": "string",
+ "readOnly": false,
+ "x-nullable": false
+ },
+ "tagIds": {
+ "type": "array",
+ "items": {
+ "format": "uuid",
+ "type": "string",
+ "x-nullable": false
+ },
+ "readOnly": false
+ },
+ "regions": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/Region",
+ "x-nullable": false
+ },
+ "readOnly": false
+ }
+ }
+ },
+ "Iteration": {
+ "description": "Iteration model to be sent over JSON.",
+ "required": [
+ "name"
+ ],
+ "type": "object",
+ "properties": {
+ "id": {
+ "format": "uuid",
+ "description": "Gets the id of the iteration.",
+ "type": "string",
+ "readOnly": true,
+ "x-nullable": false
+ },
+ "name": {
+ "description": "Gets or sets the name of the iteration.",
+ "type": "string",
+ "readOnly": false,
+ "x-nullable": false
+ },
+ "status": {
+ "description": "Gets the current iteration status.",
+ "type": "string",
+ "readOnly": true,
+ "x-nullable": false
+ },
+ "created": {
+ "format": "date-time",
+ "description": "Gets the time this iteration was completed.",
+ "type": "string",
+ "readOnly": true,
+ "x-nullable": false
+ },
+ "lastModified": {
+ "format": "date-time",
+ "description": "Gets the time this iteration was last modified.",
+ "type": "string",
+ "readOnly": true,
+ "x-nullable": false
+ },
+ "trainedAt": {
+ "format": "date-time",
+ "description": "Gets the time this iteration was last modified.",
+ "type": "string",
+ "readOnly": true,
+ "x-nullable": true
+ },
+ "projectId": {
+ "format": "uuid",
+ "description": "Gets the project id of the iteration.",
+ "type": "string",
+ "readOnly": true,
+ "x-nullable": false
+ },
+ "exportable": {
+ "description": "Whether the iteration can be exported to another format for download.",
+ "type": "boolean",
+ "readOnly": true,
+ "x-nullable": false
+ },
+ "exportableTo": {
+ "description": "A set of platforms this iteration can export to.",
+ "type": "array",
+ "items": {
+ "enum": [
+ "CoreML",
+ "TensorFlow",
+ "DockerFile",
+ "ONNX",
+ "VAIDK"
+ ],
+ "type": "string",
+ "x-nullable": false
+ },
+ "readOnly": true
+ },
+ "domainId": {
+ "format": "uuid",
+ "description": "Get or sets a guid of the domain the iteration has been trained on.",
+ "type": "string",
+ "readOnly": true,
+ "x-nullable": true
+ },
+ "classificationType": {
+ "description": "Gets the classification type of the project.",
+ "enum": [
+ "Multiclass",
+ "Multilabel"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-nullable": true,
+ "x-ms-enum": {
+ "name": "Classifier",
+ "modelAsString": true
+ }
+ },
+ "trainingType": {
+ "description": "Gets the training type of the iteration.",
+ "enum": [
+ "Regular",
+ "Advanced"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-nullable": false,
+ "x-ms-enum": {
+ "name": "TrainingType",
+ "modelAsString": true
+ }
+ },
+ "reservedBudgetInHours": {
+ "format": "int32",
+ "description": "Gets the reserved advanced training budget for the iteration.",
+ "type": "integer",
+ "readOnly": true,
+ "x-nullable": false
+ },
+ "trainingTimeInMinutes": {
+ "format": "int32",
+ "description": "Gets the training time for the iteration.",
+ "type": "integer",
+ "readOnly": true,
+ "x-nullable": false
+ },
+ "publishName": {
+ "description": "Name of the published model.",
+ "type": "string",
+ "readOnly": true,
+ "x-nullable": false
+ },
+ "originalPublishResourceId": {
+ "description": "Resource Provider Id this iteration was originally published to.",
+ "type": "string",
+ "readOnly": true,
+ "x-nullable": false
+ }
+ }
+ },
+ "IterationPerformance": {
+ "description": "Represents the detailed performance data for a trained iteration.",
+ "type": "object",
+ "properties": {
+ "perTagPerformance": {
+ "description": "Gets the per-tag performance details for this iteration.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/TagPerformance",
+ "x-nullable": false
+ },
+ "readOnly": true
+ },
+ "precision": {
+ "format": "float",
+ "description": "Gets the precision.",
+ "type": "number",
+ "readOnly": true,
+ "x-nullable": false
+ },
+ "precisionStdDeviation": {
+ "format": "float",
+ "description": "Gets the standard deviation for the precision.",
+ "type": "number",
+ "readOnly": true,
+ "x-nullable": false
+ },
+ "recall": {
+ "format": "float",
+ "description": "Gets the recall.",
+ "type": "number",
+ "readOnly": true,
+ "x-nullable": false
+ },
+ "recallStdDeviation": {
+ "format": "float",
+ "description": "Gets the standard deviation for the recall.",
+ "type": "number",
+ "readOnly": true,
+ "x-nullable": false
+ },
+ "averagePrecision": {
+ "format": "float",
+ "description": "Gets the average precision when applicable.",
+ "type": "number",
+ "readOnly": true,
+ "x-nullable": true
+ }
+ }
+ },
+ "Prediction": {
+ "description": "Prediction result.",
+ "type": "object",
+ "properties": {
+ "probability": {
+ "format": "float",
+ "description": "Probability of the tag.",
+ "type": "number",
+ "readOnly": true,
+ "x-nullable": false
+ },
+ "tagId": {
+ "format": "uuid",
+ "description": "Id of the predicted tag.",
+ "type": "string",
+ "readOnly": true,
+ "x-nullable": false
+ },
+ "tagName": {
+ "description": "Name of the predicted tag.",
+ "type": "string",
+ "readOnly": true,
+ "x-nullable": true
+ },
+ "boundingBox": {
+ "$ref": "#/definitions/BoundingBox",
+ "description": "Bounding box of the prediction.",
+ "readOnly": true,
+ "x-nullable": true
+ },
+ "tagType": {
+ "description": "Type of the predicted tag.",
+ "enum": [
+ "Regular",
+ "Negative",
+ "GeneralProduct"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-nullable": true,
+ "x-ms-enum": {
+ "name": "TagType",
+ "modelAsString": true
+ }
+ }
+ }
+ },
+ "PredictionQueryResult": {
+ "description": "Query result of the prediction images that were sent to your prediction endpoint.",
+ "type": "object",
+ "properties": {
+ "token": {
+ "$ref": "#/definitions/PredictionQueryToken",
+ "description": "Prediction Query Token.",
+ "readOnly": false
+ },
+ "results": {
+ "description": "Result of an image prediction request.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/StoredImagePrediction",
+ "x-nullable": false
+ },
+ "readOnly": true
+ }
+ }
+ },
+ "PredictionQueryTag": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "format": "uuid",
+ "type": "string",
+ "readOnly": false,
+ "x-nullable": false
+ },
+ "minThreshold": {
+ "format": "float",
+ "type": "number",
+ "readOnly": false,
+ "x-nullable": false
+ },
+ "maxThreshold": {
+ "format": "float",
+ "type": "number",
+ "readOnly": false,
+ "x-nullable": false
+ }
+ }
+ },
+ "PredictionQueryToken": {
+ "type": "object",
+ "properties": {
+ "session": {
+ "type": "string",
+ "readOnly": false,
+ "x-nullable": false
+ },
+ "continuation": {
+ "type": "string",
+ "readOnly": false,
+ "x-nullable": false
+ },
+ "maxCount": {
+ "format": "int32",
+ "type": "integer",
+ "readOnly": false,
+ "x-nullable": false
+ },
+ "orderBy": {
+ "enum": [
+ "Newest",
+ "Oldest",
+ "Suggested"
+ ],
+ "type": "string",
+ "readOnly": false,
+ "x-nullable": false,
+ "x-ms-enum": {
+ "name": "OrderBy",
+ "modelAsString": true
+ }
+ },
+ "tags": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/PredictionQueryTag",
+ "x-nullable": false
+ },
+ "readOnly": false
+ },
+ "iterationId": {
+ "format": "uuid",
+ "type": "string",
+ "readOnly": false,
+ "x-nullable": true
+ },
+ "startTime": {
+ "format": "date-time",
+ "type": "string",
+ "readOnly": false,
+ "x-nullable": true
+ },
+ "endTime": {
+ "format": "date-time",
+ "type": "string",
+ "readOnly": false,
+ "x-nullable": true
+ },
+ "application": {
+ "type": "string",
+ "readOnly": false,
+ "x-nullable": false
+ }
+ }
+ },
+ "Project": {
+ "description": "Represents a project.",
+ "required": [
+ "name",
+ "description",
+ "settings"
+ ],
+ "type": "object",
+ "properties": {
+ "id": {
+ "format": "uuid",
+ "description": "Gets the project id.",
+ "type": "string",
+ "readOnly": true,
+ "x-nullable": false
+ },
+ "name": {
+ "description": "Gets or sets the name of the project.",
+ "type": "string",
+ "readOnly": false,
+ "x-nullable": false
+ },
+ "description": {
+ "description": "Gets or sets the description of the project.",
+ "type": "string",
+ "readOnly": false,
+ "x-nullable": true
+ },
+ "settings": {
+ "$ref": "#/definitions/ProjectSettings",
+ "description": "Gets or sets the project settings.",
+ "readOnly": false
+ },
+ "created": {
+ "format": "date-time",
+ "description": "Gets the date this project was created.",
+ "type": "string",
+ "readOnly": true,
+ "x-nullable": false
+ },
+ "lastModified": {
+ "format": "date-time",
+ "description": "Gets the date this project was last modified.",
+ "type": "string",
+ "readOnly": true,
+ "x-nullable": false
+ },
+ "thumbnailUri": {
+ "description": "Gets the thumbnail url representing the image. If VNET feature is enabled this will be a relative path to be used with GetArtifact, otherwise this will be an absolute URI to the resource.",
+ "type": "string",
+ "readOnly": true
+ },
+ "drModeEnabled": {
+ "description": "Gets if the Disaster Recovery (DR) mode is on, indicating the project is temporarily read-only.",
+ "type": "boolean",
+ "readOnly": true,
+ "x-nullable": true
+ },
+ "status": {
+ "description": "Gets the status of the project.",
+ "enum": [
+ "Succeeded",
+ "Importing",
+ "Failed"
+ ],
+ "type": "string",
+ "readOnly": false,
+ "x-nullable": false,
+ "x-ms-enum": {
+ "name": "ProjectStatus",
+ "modelAsString": true
+ }
+ }
+ }
+ },
+ "ProjectExport": {
+ "description": "Represents information about a project export.",
+ "type": "object",
+ "properties": {
+ "iterationCount": {
+ "format": "int32",
+ "description": "Count of iterations that will be exported.",
+ "type": "integer",
+ "readOnly": true,
+ "x-nullable": false
+ },
+ "imageCount": {
+ "format": "int32",
+ "description": "Count of images that will be exported.",
+ "type": "integer",
+ "readOnly": true,
+ "x-nullable": false
+ },
+ "tagCount": {
+ "format": "int32",
+ "description": "Count of tags that will be exported.",
+ "type": "integer",
+ "readOnly": true,
+ "x-nullable": false
+ },
+ "regionCount": {
+ "format": "int32",
+ "description": "Count of regions that will be exported.",
+ "type": "integer",
+ "readOnly": true,
+ "x-nullable": false
+ },
+ "estimatedImportTimeInMS": {
+ "format": "int32",
+ "description": "Estimated time this project will take to import, can change based on network connectivity and load between\r\nsource and destination regions.",
+ "type": "integer",
+ "readOnly": true,
+ "x-nullable": false
+ },
+ "token": {
+ "description": "Opaque token that should be passed to ImportProject to perform the import. This token grants access to import this\r\nproject to all that have the token.",
+ "type": "string",
+ "readOnly": true,
+ "x-nullable": false
+ }
+ }
+ },
+ "ProjectSettings": {
+ "description": "Represents settings associated with a project.",
+ "type": "object",
+ "properties": {
+ "domainId": {
+ "format": "uuid",
+ "description": "Gets or sets the id of the Domain to use with this project.",
+ "type": "string",
+ "readOnly": false,
+ "x-nullable": false
+ },
+ "classificationType": {
+ "description": "Gets or sets the classification type of the project.",
+ "enum": [
+ "Multiclass",
+ "Multilabel"
+ ],
+ "type": "string",
+ "readOnly": false,
+ "x-nullable": true,
+ "x-ms-enum": {
+ "name": "Classifier",
+ "modelAsString": true
+ }
+ },
+ "targetExportPlatforms": {
+ "description": "A list of ExportPlatform that the trained model should be able to support.",
+ "type": "array",
+ "items": {
+ "enum": [
+ "CoreML",
+ "TensorFlow",
+ "DockerFile",
+ "ONNX",
+ "VAIDK"
+ ],
+ "type": "string",
+ "x-nullable": false
+ },
+ "readOnly": false
+ },
+ "useNegativeSet": {
+ "description": "Indicates if negative set is being used.",
+ "type": "boolean",
+ "readOnly": true,
+ "x-nullable": true
+ },
+ "detectionParameters": {
+ "description": "Detection parameters in use, if any.",
+ "type": "string",
+ "readOnly": true,
+ "x-nullable": false
+ },
+ "imageProcessingSettings": {
+ "$ref": "#/definitions/ImageProcessingSettings",
+ "description": "Gets or sets image preprocessing settings.",
+ "readOnly": false
+ }
+ }
+ },
+ "Region": {
+ "required": [
+ "tagId",
+ "left",
+ "top",
+ "width",
+ "height"
+ ],
+ "type": "object",
+ "properties": {
+ "tagId": {
+ "format": "uuid",
+ "description": "Id of the tag associated with this region.",
+ "type": "string",
+ "readOnly": false,
+ "x-nullable": false
+ },
+ "left": {
+ "format": "float",
+ "description": "Coordinate of the left boundary.",
+ "type": "number",
+ "readOnly": false,
+ "x-nullable": false
+ },
+ "top": {
+ "format": "float",
+ "description": "Coordinate of the top boundary.",
+ "type": "number",
+ "readOnly": false,
+ "x-nullable": false
+ },
+ "width": {
+ "format": "float",
+ "description": "Width.",
+ "type": "number",
+ "readOnly": false,
+ "x-nullable": false
+ },
+ "height": {
+ "format": "float",
+ "description": "Height.",
+ "type": "number",
+ "readOnly": false,
+ "x-nullable": false
+ }
+ }
+ },
+ "RegionProposal": {
+ "type": "object",
+ "properties": {
+ "confidence": {
+ "format": "float",
+ "type": "number",
+ "readOnly": true,
+ "x-nullable": false
+ },
+ "boundingBox": {
+ "$ref": "#/definitions/BoundingBox",
+ "readOnly": true
+ }
+ }
+ },
+ "StoredImagePrediction": {
+ "description": "Result of an image prediction request.",
+ "type": "object",
+ "properties": {
+ "resizedImageUri": {
+ "description": "The URI to the (resized) prediction image. If VNET feature is enabled this will be a relative path to be used with GetArtifact, otherwise this will be an absolute URI to the resource.",
+ "type": "string",
+ "readOnly": true
+ },
+ "thumbnailUri": {
+ "description": "The URI to the thumbnail of the original prediction image. If VNET feature is enabled this will be a relative path to be used with GetArtifact, otherwise this will be an absolute URI to the resource.",
+ "type": "string",
+ "readOnly": true
+ },
+ "originalImageUri": {
+ "description": "The URI to the original prediction image. If VNET feature is enabled this will be a relative path to be used with GetArtifact, otherwise this will be an absolute URI to the resource.",
+ "type": "string",
+ "readOnly": true
+ },
+ "domain": {
+ "format": "uuid",
+ "description": "Domain used for the prediction.",
+ "type": "string",
+ "readOnly": true,
+ "x-nullable": false
+ },
+ "id": {
+ "format": "uuid",
+ "description": "Prediction Id.",
+ "type": "string",
+ "readOnly": true,
+ "x-nullable": false
+ },
+ "project": {
+ "format": "uuid",
+ "description": "Project Id.",
+ "type": "string",
+ "readOnly": true,
+ "x-nullable": false
+ },
+ "iteration": {
+ "format": "uuid",
+ "description": "Iteration Id.",
+ "type": "string",
+ "readOnly": true,
+ "x-nullable": false
+ },
+ "created": {
+ "format": "date-time",
+ "description": "Date this prediction was created.",
+ "type": "string",
+ "readOnly": true,
+ "x-nullable": false
+ },
+ "predictions": {
+ "description": "List of predictions.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/Prediction",
+ "x-nullable": false
+ },
+ "readOnly": true
+ }
+ }
+ },
+ "StoredSuggestedTagAndRegion": {
+ "description": "Result of a suggested tags and regions request of the untagged image.",
+ "type": "object",
+ "properties": {
+ "width": {
+ "format": "int32",
+ "description": "Width of the resized image.",
+ "type": "integer",
+ "readOnly": true,
+ "x-nullable": false
+ },
+ "height": {
+ "format": "int32",
+ "description": "Height of the resized image.",
+ "type": "integer",
+ "readOnly": true,
+ "x-nullable": false
+ },
+ "resizedImageUri": {
+ "description": "The URI to the (resized) prediction image. If VNET feature is enabled this will be a relative path to be used with GetArtifact, otherwise this will be an absolute URI to the resource.",
+ "type": "string",
+ "readOnly": true
+ },
+ "thumbnailUri": {
+ "description": "The URI to the thumbnail of the original prediction image. If VNET feature is enabled this will be a relative path to be used with GetArtifact, otherwise this will be an absolute URI to the resource.",
+ "type": "string",
+ "readOnly": true
+ },
+ "originalImageUri": {
+ "description": "The URI to the original prediction image. If VNET feature is enabled this will be a relative path to be used with GetArtifact, otherwise this will be an absolute URI to the resource.",
+ "type": "string",
+ "readOnly": true
+ },
+ "domain": {
+ "format": "uuid",
+ "description": "Domain used for the prediction.",
+ "type": "string",
+ "readOnly": true,
+ "x-nullable": false
+ },
+ "id": {
+ "format": "uuid",
+ "description": "Prediction Id.",
+ "type": "string",
+ "readOnly": true,
+ "x-nullable": false
+ },
+ "project": {
+ "format": "uuid",
+ "description": "Project Id.",
+ "type": "string",
+ "readOnly": true,
+ "x-nullable": false
+ },
+ "iteration": {
+ "format": "uuid",
+ "description": "Iteration Id.",
+ "type": "string",
+ "readOnly": true,
+ "x-nullable": false
+ },
+ "created": {
+ "format": "date-time",
+ "description": "Date this prediction was created.",
+ "type": "string",
+ "readOnly": true,
+ "x-nullable": false
+ },
+ "predictions": {
+ "description": "List of predictions.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/Prediction",
+ "x-nullable": false
+ },
+ "readOnly": true
+ },
+ "predictionUncertainty": {
+ "format": "double",
+ "description": "Uncertainty (entropy) of suggested tags or regions per image.",
+ "type": "number",
+ "readOnly": true,
+ "x-nullable": false
+ }
+ }
+ },
+ "SuggestedTagAndRegion": {
+ "description": "Result of a suggested tags and regions request.",
+ "type": "object",
+ "properties": {
+ "id": {
+ "format": "uuid",
+ "description": "Prediction Id.",
+ "type": "string",
+ "readOnly": true,
+ "x-nullable": false
+ },
+ "project": {
+ "format": "uuid",
+ "description": "Project Id.",
+ "type": "string",
+ "readOnly": true,
+ "x-nullable": false
+ },
+ "iteration": {
+ "format": "uuid",
+ "description": "Iteration Id.",
+ "type": "string",
+ "readOnly": true,
+ "x-nullable": false
+ },
+ "created": {
+ "format": "date-time",
+ "description": "Date this prediction was created.",
+ "type": "string",
+ "readOnly": true,
+ "x-nullable": false
+ },
+ "predictions": {
+ "description": "List of predictions.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/Prediction",
+ "x-nullable": false
+ },
+ "readOnly": true
+ },
+ "predictionUncertainty": {
+ "format": "double",
+ "description": "Uncertainty (entropy) of suggested tags or regions per image.",
+ "type": "number",
+ "readOnly": true,
+ "x-nullable": false
+ }
+ }
+ },
+ "SuggestedTagAndRegionQuery": {
+ "description": "The array of result images and token containing session and continuation Ids for the next query.",
+ "type": "object",
+ "properties": {
+ "token": {
+ "$ref": "#/definitions/SuggestedTagAndRegionQueryToken",
+ "description": "Contains properties we need to fetch suggested tags for.",
+ "readOnly": false
+ },
+ "results": {
+ "description": "Result of a suggested tags and regions request of the untagged image.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/StoredSuggestedTagAndRegion",
+ "x-nullable": false
+ },
+ "readOnly": true
+ }
+ }
+ },
+ "SuggestedTagAndRegionQueryToken": {
+ "description": "Contains properties we need to fetch suggested tags for. For the first call, Session and continuation set to null.\r\nThen on subsequent calls, uses the session/continuation from the previous SuggestedTagAndRegionQuery result to fetch additional results.",
+ "type": "object",
+ "properties": {
+ "tagIds": {
+ "description": "Existing TagIds in project to filter suggested tags on.",
+ "type": "array",
+ "items": {
+ "format": "uuid",
+ "type": "string",
+ "x-nullable": false
+ },
+ "readOnly": false
+ },
+ "threshold": {
+ "format": "double",
+ "description": "Confidence threshold to filter suggested tags on.",
+ "type": "number",
+ "readOnly": false,
+ "x-nullable": false
+ },
+ "session": {
+ "description": "SessionId for database query. Initially set to null but later used to paginate.",
+ "type": "string",
+ "readOnly": false,
+ "x-nullable": false
+ },
+ "continuation": {
+ "description": "Continuation Id for database pagination. Initially null but later used to paginate.",
+ "type": "string",
+ "readOnly": false,
+ "x-nullable": false
+ },
+ "maxCount": {
+ "format": "int32",
+ "description": "Maximum number of results you want to be returned in the response.",
+ "type": "integer",
+ "readOnly": false,
+ "x-nullable": false
+ },
+ "sortBy": {
+ "description": "OrderBy. Ordering mechanism for your results.",
+ "enum": [
+ "UncertaintyAscending",
+ "UncertaintyDescending"
+ ],
+ "type": "string",
+ "readOnly": false,
+ "x-nullable": false,
+ "x-ms-enum": {
+ "name": "SortBy",
+ "modelAsString": true
+ }
+ }
+ }
+ },
+ "Tag": {
+ "description": "Represents a Tag.",
+ "required": [
+ "name",
+ "description",
+ "type"
+ ],
+ "type": "object",
+ "properties": {
+ "id": {
+ "format": "uuid",
+ "description": "Gets the Tag ID.",
+ "type": "string",
+ "readOnly": true,
+ "x-nullable": false
+ },
+ "name": {
+ "description": "Gets or sets the name of the tag.",
+ "type": "string",
+ "readOnly": false,
+ "x-nullable": false
+ },
+ "description": {
+ "description": "Gets or sets the description of the tag.",
+ "type": "string",
+ "readOnly": false,
+ "x-nullable": true
+ },
+ "type": {
+ "description": "Gets or sets the type of the tag.",
+ "enum": [
+ "Regular",
+ "Negative",
+ "GeneralProduct"
+ ],
+ "type": "string",
+ "readOnly": false,
+ "x-nullable": false,
+ "x-ms-enum": {
+ "name": "TagType",
+ "modelAsString": true
+ }
+ },
+ "imageCount": {
+ "format": "int32",
+ "description": "Gets the number of images with this tag.",
+ "type": "integer",
+ "readOnly": true,
+ "x-nullable": false
+ }
+ }
+ },
+ "TagFilter": {
+ "description": "Model that query for counting of images whose suggested tags match given tags and their probability are greater than or equal to the given threshold.",
+ "type": "object",
+ "properties": {
+ "tagIds": {
+ "description": "Existing TagIds in project to get suggested tags count for.",
+ "type": "array",
+ "items": {
+ "format": "uuid",
+ "type": "string",
+ "x-nullable": false
+ },
+ "readOnly": false
+ },
+ "threshold": {
+ "format": "double",
+ "description": "Confidence threshold to filter suggested tags on.",
+ "type": "number",
+ "readOnly": false,
+ "x-nullable": false
+ }
+ }
+ },
+ "TagPerformance": {
+ "description": "Represents performance data for a particular tag in a trained iteration.",
+ "type": "object",
+ "properties": {
+ "id": {
+ "format": "uuid",
+ "type": "string",
+ "readOnly": true,
+ "x-nullable": false
+ },
+ "name": {
+ "type": "string",
+ "readOnly": true,
+ "x-nullable": false
+ },
+ "precision": {
+ "format": "float",
+ "description": "Gets the precision.",
+ "type": "number",
+ "readOnly": true,
+ "x-nullable": false
+ },
+ "precisionStdDeviation": {
+ "format": "float",
+ "description": "Gets the standard deviation for the precision.",
+ "type": "number",
+ "readOnly": true,
+ "x-nullable": false
+ },
+ "recall": {
+ "format": "float",
+ "description": "Gets the recall.",
+ "type": "number",
+ "readOnly": true,
+ "x-nullable": false
+ },
+ "recallStdDeviation": {
+ "format": "float",
+ "description": "Gets the standard deviation for the recall.",
+ "type": "number",
+ "readOnly": true,
+ "x-nullable": false
+ },
+ "averagePrecision": {
+ "format": "float",
+ "description": "Gets the average precision when applicable.",
+ "type": "number",
+ "readOnly": true,
+ "x-nullable": true
+ }
+ }
+ },
+ "TrainingParameters": {
+ "description": "Parameters used for training.",
+ "type": "object",
+ "properties": {
+ "selectedTags": {
+ "description": "List of tags selected for this training session, other tags in the project will be ignored.",
+ "type": "array",
+ "items": {
+ "format": "uuid",
+ "type": "string",
+ "x-nullable": false
+ },
+ "readOnly": false
+ }
+ }
+ }
+ },
+ "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
+ }
+ },
+ "securityDefinitions": {
+ "apim_key": {
+ "type": "apiKey",
+ "name": "Training-Key",
+ "in": "header"
+ }
+ },
+ "security": [
+ {
+ "apim_key": []
+ }
+ ],
+ "x-ms-parameterized-host": {
+ "hostTemplate": "{Endpoint}",
+ "useSchemePrefix": false,
+ "parameters": [
+ {
+ "$ref": "#/parameters/Endpoint"
+ }
+ ]
+ }
+}
diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/CreateImageRegions.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/CreateImageRegions.json
new file mode 100644
index 000000000000..9f554c49071c
--- /dev/null
+++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/CreateImageRegions.json
@@ -0,0 +1,81 @@
+{
+ "parameters": {
+ "Endpoint": "https://westus.api.cognitive.microsoft.com",
+ "Content-Type": "application/json",
+ "Training-Key": "{API Key}",
+ "projectId": "bc3f7dad-5544-468c-8573-3ef04d55463e",
+ "batch": {
+ "regions": [
+ {
+ "imageId": "4d6eb844-42ee-42bc-bd6f-c32455ef07c9",
+ "tagId": "b607964f-7bd6-4a3b-a869-6791fb6aab87",
+ "left": 0.25,
+ "top": 0.25,
+ "width": 0.25,
+ "height": 0.25
+ },
+ {
+ "imageId": "4d6eb844-42ee-42bc-bd6f-c32455ef07c9",
+ "tagId": "b607964f-7bd6-4a3b-a869-6791fb6aab87",
+ "left": 0.35,
+ "top": 0.35,
+ "width": 0.25,
+ "height": 0.25
+ }
+ ]
+ }
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": {
+ "created": [
+ {
+ "imageId": "4d6eb844-42ee-42bc-bd6f-c32455ef07c9",
+ "tagId": "b607964f-7bd6-4a3b-a869-6791fb6aab87",
+ "left": 0.25,
+ "top": 0.25,
+ "width": 0.25,
+ "height": 0.25
+ },
+ {
+ "imageId": "4d6eb844-42ee-42bc-bd6f-c32455ef07c9",
+ "tagId": "b607964f-7bd6-4a3b-a869-6791fb6aab87",
+ "left": 0.35,
+ "top": 0.35,
+ "width": 0.25,
+ "height": 0.25
+ }
+ ],
+ "duplicated": [],
+ "exceeded": []
+ }
+ },
+ "207": {
+ "headers": {},
+ "body": {
+ "created": [
+ {
+ "imageId": "4d6eb844-42ee-42bc-bd6f-c32455ef07c9",
+ "tagId": "b607964f-7bd6-4a3b-a869-6791fb6aab87",
+ "left": 0.25,
+ "top": 0.25,
+ "width": 0.25,
+ "height": 0.25
+ }
+ ],
+ "duplicated": [],
+ "exceeded": [
+ {
+ "imageId": "4d6eb844-42ee-42bc-bd6f-c32455ef07c9",
+ "tagId": "b607964f-7bd6-4a3b-a869-6791fb6aab87",
+ "left": 0.35,
+ "top": 0.35,
+ "width": 0.25,
+ "height": 0.25
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/CreateImageTags.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/CreateImageTags.json
new file mode 100644
index 000000000000..5b7395424693
--- /dev/null
+++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/CreateImageTags.json
@@ -0,0 +1,31 @@
+{
+ "parameters": {
+ "Endpoint": "https://westus.api.cognitive.microsoft.com",
+ "Content-Type": "application/json",
+ "Training-Key": "{API Key}",
+ "projectId": "bc3f7dad-5544-468c-8573-3ef04d55463e",
+ "batch": {
+ "tags": [
+ {
+ "imageId": "e31a14ab-5d78-4f7b-a267-3a1e4fd8a758",
+ "tagId": "349d72ac-0948-4d51-b1e4-c14a1f9b848a"
+ }
+ ]
+ }
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": {
+ "created": [
+ {
+ "imageId": "e31a14ab-5d78-4f7b-a267-3a1e4fd8a758",
+ "tagId": "349d72ac-0948-4d51-b1e4-c14a1f9b848a"
+ }
+ ],
+ "duplicated": null,
+ "exceeded": null
+ }
+ }
+ }
+}
diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/CreateImagesFromData.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/CreateImagesFromData.json
new file mode 100644
index 000000000000..05b0b07590b5
--- /dev/null
+++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/CreateImagesFromData.json
@@ -0,0 +1,94 @@
+{
+ "parameters": {
+ "Endpoint": "https://westus.api.cognitive.microsoft.com",
+ "Content-Type": "application/json",
+ "Training-Key": "{API Key}",
+ "projectId": "64b822c5-8082-4b36-a426-27225f4aa18c",
+ "tagIds": [
+ "b607964f-7bd6-4a3b-a869-6791fb6aab87"
+ ],
+ "imageData": "multipart data"
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": {
+ "isBatchSuccessful": true,
+ "images": [
+ {
+ "sourceUrl": "\"hemlock_10.jpg\"",
+ "status": "OK",
+ "image": {
+ "id": "4d6eb844-42ee-42bc-bd6f-c32455ef07c9",
+ "created": "2017-12-19T15:56:10Z",
+ "width": 1095,
+ "height": 900,
+ "resizedImageUri": "{Resized Image Uri}",
+ "originalImageUri": "{Image Uri}",
+ "thumbnailUri": "{Thumbnail Uri}",
+ "tags": [
+ {
+ "tagId": "b607964f-7bd6-4a3b-a869-6791fb6aab87",
+ "created": "2017-12-19T15:56:09Z",
+ "tagName": "tag 1"
+ }
+ ]
+ }
+ },
+ {
+ "sourceUrl": "\"hemlock_6.jpg\"",
+ "status": "OK",
+ "image": {
+ "id": "f1855a92-b873-47e7-b513-f07a667ceda1",
+ "created": "2017-12-19T15:56:10Z",
+ "width": 900,
+ "height": 1531,
+ "resizedImageUri": "{Resized Image Uri}",
+ "originalImageUri": "{Image Uri}",
+ "thumbnailUri": "{Thumbnail Uri}",
+ "tags": [
+ {
+ "tagId": "b607964f-7bd6-4a3b-a869-6791fb6aab87",
+ "created": "2017-12-19T15:56:09Z",
+ "tagName": "tag 1"
+ }
+ ]
+ }
+ }
+ ]
+ }
+ },
+ "207": {
+ "headers": {},
+ "body": {
+ "isBatchSuccessful": false,
+ "images": [
+ {
+ "sourceUrl": "\"hemlock_10.jpg\"",
+ "status": "OK",
+ "image": {
+ "id": "4d6eb844-42ee-42bc-bd6f-c32455ef07c9",
+ "created": "2017-12-19T15:56:10Z",
+ "width": 1095,
+ "height": 900,
+ "resizedImageUri": "{Resized Image Uri}",
+ "originalImageUri": "{Image Uri}",
+ "thumbnailUri": "{Thumbnail Uri}",
+ "tags": [
+ {
+ "tagId": "b607964f-7bd6-4a3b-a869-6791fb6aab87",
+ "created": "2017-12-19T15:56:09Z",
+ "tagName": "tag 1"
+ }
+ ]
+ }
+ },
+ {
+ "sourceUrl": "\"hemlock_6.jpg\"",
+ "status": "ErrorLimitExceed"
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/CreateImagesFromFiles.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/CreateImagesFromFiles.json
new file mode 100644
index 000000000000..6853f6ab1401
--- /dev/null
+++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/CreateImagesFromFiles.json
@@ -0,0 +1,82 @@
+{
+ "parameters": {
+ "Endpoint": "https://westus.api.cognitive.microsoft.com",
+ "Content-Type": "application/json",
+ "Training-Key": "{API Key}",
+ "projectId": "64b822c5-8082-4b36-a426-27225f4aa18c",
+ "tagIds": "b607964f-7bd6-4a3b-a869-6791fb6aab87",
+ "batch": {
+ "images": [
+ {
+ "name": "hemlock_10.jpg",
+ "contents": "{image contents}"
+ }
+ ],
+ "tagIds": [
+ "b607964f-7bd6-4a3b-a869-6791fb6aab87"
+ ]
+ }
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": {
+ "isBatchSuccessful": true,
+ "images": [
+ {
+ "sourceUrl": "\"hemlock_10.jpg\"",
+ "status": "OK",
+ "image": {
+ "id": "4d6eb844-42ee-42bc-bd6f-c32455ef07c9",
+ "created": "2017-12-19T15:56:10Z",
+ "width": 1095,
+ "height": 900,
+ "resizedImageUri": "{Resized Image Uri}",
+ "originalImageUri": "{Image Uri}",
+ "thumbnailUri": "{Thumbnail Uri}",
+ "tags": [
+ {
+ "tagId": "b607964f-7bd6-4a3b-a869-6791fb6aab87",
+ "created": "2017-12-19T15:56:09Z",
+ "tagName": "tag 1"
+ }
+ ]
+ }
+ }
+ ]
+ }
+ },
+ "207": {
+ "headers": {},
+ "body": {
+ "isBatchSuccessful": false,
+ "images": [
+ {
+ "sourceUrl": "\"hemlock_10.jpg\"",
+ "status": "OK",
+ "image": {
+ "id": "4d6eb844-42ee-42bc-bd6f-c32455ef07c9",
+ "created": "2017-12-19T15:56:10Z",
+ "width": 1095,
+ "height": 900,
+ "resizedImageUri": "{Resized Image Uri}",
+ "originalImageUri": "{Image Uri}",
+ "thumbnailUri": "{Thumbnail Uri}",
+ "tags": [
+ {
+ "tagId": "b607964f-7bd6-4a3b-a869-6791fb6aab87",
+ "created": "2017-12-19T15:56:09Z",
+ "tagName": "tag 1"
+ }
+ ]
+ }
+ },
+ {
+ "sourceUrl": "{url}",
+ "status": "ErrorLimitExceed"
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/CreateImagesFromPredictions.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/CreateImagesFromPredictions.json
new file mode 100644
index 000000000000..1970c61d0d39
--- /dev/null
+++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/CreateImagesFromPredictions.json
@@ -0,0 +1,81 @@
+{
+ "parameters": {
+ "Endpoint": "https://westus.api.cognitive.microsoft.com",
+ "Content-Type": "application/json",
+ "Training-Key": "{API Key}",
+ "projectId": "64b822c5-8082-4b36-a426-27225f4aa18c",
+ "tagIds": "b607964f-7bd6-4a3b-a869-6791fb6aab87",
+ "batch": {
+ "images": [
+ {
+ "id": "4d6eb844-42ee-42bc-bd6f-c32455ef07c9"
+ }
+ ],
+ "tagIds": [
+ "b607964f-7bd6-4a3b-a869-6791fb6aab87"
+ ]
+ }
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": {
+ "isBatchSuccessful": true,
+ "images": [
+ {
+ "sourceUrl": "\"hemlock_10.jpg\"",
+ "status": "OK",
+ "image": {
+ "id": "4d6eb844-42ee-42bc-bd6f-c32455ef07c9",
+ "created": "2017-12-19T15:56:10Z",
+ "width": 1095,
+ "height": 900,
+ "resizedImageUri": "{Resized Image Uri}",
+ "originalImageUri": "{Image Uri}",
+ "thumbnailUri": "{Thumbnail Uri}",
+ "tags": [
+ {
+ "tagId": "b607964f-7bd6-4a3b-a869-6791fb6aab87",
+ "created": "2017-12-19T15:56:09Z",
+ "tagName": "tag 1"
+ }
+ ]
+ }
+ }
+ ]
+ }
+ },
+ "207": {
+ "headers": {},
+ "body": {
+ "isBatchSuccessful": false,
+ "images": [
+ {
+ "sourceUrl": "\"hemlock_10.jpg\"",
+ "status": "OK",
+ "image": {
+ "id": "4d6eb844-42ee-42bc-bd6f-c32455ef07c9",
+ "created": "2017-12-19T15:56:10Z",
+ "width": 1095,
+ "height": 900,
+ "resizedImageUri": "{Resized Image Uri}",
+ "originalImageUri": "{Image Uri}",
+ "thumbnailUri": "{Thumbnail Uri}",
+ "tags": [
+ {
+ "tagId": "b607964f-7bd6-4a3b-a869-6791fb6aab87",
+ "created": "2017-12-19T15:56:09Z",
+ "tagName": "tag 1"
+ }
+ ]
+ }
+ },
+ {
+ "sourceUrl": "{url}",
+ "status": "ErrorLimitExceed"
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/CreateImagesFromUrls.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/CreateImagesFromUrls.json
new file mode 100644
index 000000000000..a3ecd489a1f7
--- /dev/null
+++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/CreateImagesFromUrls.json
@@ -0,0 +1,82 @@
+{
+ "parameters": {
+ "Endpoint": "https://westus.api.cognitive.microsoft.com",
+ "Content-Type": "application/json",
+ "Training-Key": "{API Key}",
+ "projectId": "64b822c5-8082-4b36-a426-27225f4aa18c",
+ "tagIds": "b607964f-7bd6-4a3b-a869-6791fb6aab87",
+ "batch": {
+ "images": [
+ {
+ "url": "{url to image}"
+ }
+ ],
+ "tagIds": [
+ "b607964f-7bd6-4a3b-a869-6791fb6aab87"
+ ]
+ }
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": {
+ "isBatchSuccessful": true,
+ "images": [
+ {
+ "sourceUrl": "{url to image}",
+ "status": "OK",
+ "image": {
+ "id": "4d6eb844-42ee-42bc-bd6f-c32455ef07c9",
+ "created": "2017-12-19T15:56:10Z",
+ "width": 1095,
+ "height": 900,
+ "resizedImageUri": "{Resized Image Uri}",
+ "originalImageUri": "{Image Uri}",
+ "thumbnailUri": "{Thumbnail Uri}",
+ "tags": [
+ {
+ "tagId": "b607964f-7bd6-4a3b-a869-6791fb6aab87",
+ "created": "2017-12-19T15:56:09Z",
+ "tagName": "tag name"
+ }
+ ]
+ }
+ }
+ ]
+ }
+ },
+ "207": {
+ "headers": {},
+ "body": {
+ "isBatchSuccessful": false,
+ "images": [
+ {
+ "sourceUrl": "{url to image}",
+ "status": "OK",
+ "image": {
+ "id": "4d6eb844-42ee-42bc-bd6f-c32455ef07c9",
+ "created": "2017-12-19T15:56:10Z",
+ "width": 1095,
+ "height": 900,
+ "resizedImageUri": "{Resized Image Uri}",
+ "originalImageUri": "{Image Uri}",
+ "thumbnailUri": "{Thumbnail Uri}",
+ "tags": [
+ {
+ "tagId": "b607964f-7bd6-4a3b-a869-6791fb6aab87",
+ "created": "2017-12-19T15:56:09Z",
+ "tagName": "tag name"
+ }
+ ]
+ }
+ },
+ {
+ "sourceUrl": "{url to image}",
+ "status": "ErrorSource",
+ "image": null
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/CreateProject.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/CreateProject.json
new file mode 100644
index 000000000000..88f852ced738
--- /dev/null
+++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/CreateProject.json
@@ -0,0 +1,26 @@
+{
+ "parameters": {
+ "Endpoint": "https://westus.api.cognitive.microsoft.com",
+ "Content-Type": "application/json",
+ "Training-Key": "{API Key}",
+ "name": "My New Project",
+ "description": "A test project",
+ "domainId": "ee85a74c-405e-4adc-bb47-ffa8ca0c9f31"
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": {
+ "id": "bc3f7dad-5544-468c-8573-3ef04d55463e",
+ "name": "My New Project",
+ "description": "A test project",
+ "settings": {
+ "domainId": "ee85a74c-405e-4adc-bb47-ffa8ca0c9f31"
+ },
+ "created": "2017-12-18T05:43:18Z",
+ "lastModified": "2017-12-18T05:43:18Z",
+ "thumbnailUri": ""
+ }
+ }
+ }
+}
diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/CreateTag.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/CreateTag.json
new file mode 100644
index 000000000000..ed19817462ae
--- /dev/null
+++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/CreateTag.json
@@ -0,0 +1,23 @@
+{
+ "parameters": {
+ "Endpoint": "https://westus.api.cognitive.microsoft.com",
+ "Content-Type": "application/json",
+ "Training-Key": "{API Key}",
+ "projectId": "bc3f7dad-5544-468c-8573-3ef04d55463e",
+ "name": "Tag1",
+ "description": "Description of Tag1",
+ "body": ""
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": {
+ "id": "9e27bc1b-7ae7-4e3b-a4e5-36153479dc01",
+ "name": "Tag1",
+ "description": "Description of Tag1",
+ "type": "Regular",
+ "imageCount": 0
+ }
+ }
+ }
+}
diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/DeleteImageRegions.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/DeleteImageRegions.json
new file mode 100644
index 000000000000..8931d4e2629e
--- /dev/null
+++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/DeleteImageRegions.json
@@ -0,0 +1,14 @@
+{
+ "parameters": {
+ "Endpoint": "https://westus.api.cognitive.microsoft.com",
+ "Content-Type": "application/json",
+ "Training-Key": "{API Key}",
+ "projectId": "bc3f7dad-5544-468c-8573-3ef04d55463e",
+ "regionIds": [
+ ""
+ ]
+ },
+ "responses": {
+ "204": {}
+ }
+}
diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/DeleteImageTags.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/DeleteImageTags.json
new file mode 100644
index 000000000000..d6a188454e9b
--- /dev/null
+++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/DeleteImageTags.json
@@ -0,0 +1,19 @@
+{
+ "parameters": {
+ "Endpoint": "https://westus.api.cognitive.microsoft.com",
+ "Content-Type": "application/json",
+ "Training-Key": "{API Key}",
+ "projectId": "64b822c5-8082-4b36-a426-27225f4aa18c",
+ "imageIds": [
+ "e31a14ab-5d78-4f7b-a267-3a1e4fd8a758",
+ "cf0f83fb-ebaa-4b25-8e34-613a6a0b8a12"
+ ],
+ "tagIds": [
+ "e31a14ab-5d78-4f7b-a267-3a1e4fd8a758",
+ "cf0f83fb-ebaa-4b25-8e34-613a6a0b8a12"
+ ]
+ },
+ "responses": {
+ "204": {}
+ }
+}
diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/DeleteImages.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/DeleteImages.json
new file mode 100644
index 000000000000..ccc479209fd2
--- /dev/null
+++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/DeleteImages.json
@@ -0,0 +1,16 @@
+{
+ "parameters": {
+ "Endpoint": "https://westus.api.cognitive.microsoft.com",
+ "Content-Type": "application/json",
+ "Training-Key": "{API Key}",
+ "projectId": "64b822c5-8082-4b36-a426-27225f4aa18c",
+ "imageIds": [
+ "e31a14ab-5d78-4f7b-a267-3a1e4fd8a758",
+ "cf0f83fb-ebaa-4b25-8e34-613a6a0b8a12"
+ ]
+ },
+ "responses": {
+ "204": {},
+ "202": {}
+ }
+}
diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/DeleteIteration.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/DeleteIteration.json
new file mode 100644
index 000000000000..d1f9b7629958
--- /dev/null
+++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/DeleteIteration.json
@@ -0,0 +1,12 @@
+{
+ "parameters": {
+ "Endpoint": "https://westus.api.cognitive.microsoft.com",
+ "Content-Type": "application/json",
+ "Training-Key": "{API Key}",
+ "projectId": "64b822c5-8082-4b36-a426-27225f4aa18c",
+ "iterationId": "e31a14ab-5d78-4f7b-a267-3a1e4fd8a758"
+ },
+ "responses": {
+ "204": {}
+ }
+}
diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/DeletePrediction.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/DeletePrediction.json
new file mode 100644
index 000000000000..c6b2d5c0bc58
--- /dev/null
+++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/DeletePrediction.json
@@ -0,0 +1,15 @@
+{
+ "parameters": {
+ "Endpoint": "https://westus.api.cognitive.microsoft.com",
+ "Content-Type": "application/json",
+ "Training-Key": "{API Key}",
+ "projectId": "64b822c5-8082-4b36-a426-27225f4aa18c",
+ "ids": [
+ "e31a14ab-5d78-4f7b-a267-3a1e4fd8a758",
+ "cf0f83fb-ebaa-4b25-8e34-613a6a0b8a12"
+ ]
+ },
+ "responses": {
+ "204": {}
+ }
+}
diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/DeleteProject.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/DeleteProject.json
new file mode 100644
index 000000000000..2b4cb5723a6a
--- /dev/null
+++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/DeleteProject.json
@@ -0,0 +1,11 @@
+{
+ "parameters": {
+ "Endpoint": "https://westus.api.cognitive.microsoft.com",
+ "Content-Type": "application/json",
+ "Training-Key": "{API Key}",
+ "projectId": "bc3f7dad-5544-468c-8573-3ef04d55463e"
+ },
+ "responses": {
+ "204": {}
+ }
+}
diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/DeleteTag.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/DeleteTag.json
new file mode 100644
index 000000000000..e9f802505a09
--- /dev/null
+++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/DeleteTag.json
@@ -0,0 +1,12 @@
+{
+ "parameters": {
+ "Endpoint": "https://westus.api.cognitive.microsoft.com",
+ "Content-Type": "application/json",
+ "Training-Key": "{API Key}",
+ "projectId": "bc3f7dad-5544-468c-8573-3ef04d55463e",
+ "tagId": "9e27bc1b-7ae7-4e3b-a4e5-36153479dc01"
+ },
+ "responses": {
+ "204": {}
+ }
+}
diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/ExportIteration.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/ExportIteration.json
new file mode 100644
index 000000000000..1bbfa05a5d86
--- /dev/null
+++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/ExportIteration.json
@@ -0,0 +1,21 @@
+{
+ "parameters": {
+ "Endpoint": "https://westus.api.cognitive.microsoft.com",
+ "Content-Type": "application/json",
+ "Training-Key": "{API Key}",
+ "projectId": "64b822c5-8082-4b36-a426-27225f4aa18c",
+ "iterationId": "e31a14ab-5d78-4f7b-a267-3a1e4fd8a758",
+ "platform": "TensorFlow"
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": {
+ "platform": "TensorFlow",
+ "status": "Exporting",
+ "downloadUri": "",
+ "newerVersionAvailable": false
+ }
+ }
+ }
+}
diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/ExportProject.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/ExportProject.json
new file mode 100644
index 000000000000..8d59acb577d1
--- /dev/null
+++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/ExportProject.json
@@ -0,0 +1,16 @@
+{
+ "parameters": {
+ "Endpoint": "https://westus.api.cognitive.microsoft.com",
+ "Content-Type": "application/json",
+ "Training-Key": "{API Key}",
+ "projectId": "bc3f7dad-5544-468c-8573-3ef04d55463e"
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": {
+ "token": ""
+ }
+ }
+ }
+}
diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/GetArtifact.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/GetArtifact.json
new file mode 100644
index 000000000000..e48a4cf6fd86
--- /dev/null
+++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/GetArtifact.json
@@ -0,0 +1,14 @@
+{
+ "parameters": {
+ "Endpoint": "https://westus.api.cognitive.microsoft.com",
+ "Content-Type": "application/json",
+ "Training-Key": "{API Key}",
+ "projectId": "bc3f7dad-5544-468c-8573-3ef04d55463e",
+ "path": "i-40b66b39b86b4583be8c0fe223aa9ec5/t-5c882c62ca2b4458b39a2041b111dd73"
+ },
+ "responses": {
+ "200": {
+ "body": "{file}"
+ }
+ }
+}
diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/GetDomain.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/GetDomain.json
new file mode 100644
index 000000000000..c6702b3a8f29
--- /dev/null
+++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/GetDomain.json
@@ -0,0 +1,20 @@
+{
+ "parameters": {
+ "Endpoint": "https://westus.api.cognitive.microsoft.com",
+ "Content-Type": "application/json",
+ "Training-Key": "{API Key}",
+ "domainId": "b30a91ae-e3c1-4f73-a81e-c270bff27c39"
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": {
+ "id": "b30a91ae-e3c1-4f73-a81e-c270bff27c39",
+ "name": "Retail",
+ "type": "Classification",
+ "exportable": false,
+ "enabled": true
+ }
+ }
+ }
+}
diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/GetDomains.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/GetDomains.json
new file mode 100644
index 000000000000..a10887726fcb
--- /dev/null
+++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/GetDomains.json
@@ -0,0 +1,70 @@
+{
+ "parameters": {
+ "Endpoint": "https://westus.api.cognitive.microsoft.com",
+ "Content-Type": "application/json",
+ "Training-Key": "{API Key}"
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": [
+ {
+ "id": "ee85a74c-405e-4adc-bb47-ffa8ca0c9f31",
+ "name": "General",
+ "type": "Classification",
+ "exportable": false,
+ "enabled": true
+ },
+ {
+ "id": "c151d5b5-dd07-472a-acc8-15d29dea8518",
+ "name": "Food",
+ "type": "Classification",
+ "exportable": false,
+ "enabled": true
+ },
+ {
+ "id": "ca455789-012d-4b50-9fec-5bb63841c793",
+ "name": "Landmarks",
+ "type": "Classification",
+ "exportable": false,
+ "enabled": true
+ },
+ {
+ "id": "b30a91ae-e3c1-4f73-a81e-c270bff27c39",
+ "name": "Retail",
+ "type": "Classification",
+ "exportable": false,
+ "enabled": true
+ },
+ {
+ "id": "45badf75-3591-4f26-a705-45678d3e9f5f",
+ "name": "Adult",
+ "type": "Classification",
+ "exportable": false,
+ "enabled": true
+ },
+ {
+ "id": "0732100f-1a38-4e49-a514-c9b44c697ab5",
+ "name": "General (compact)",
+ "type": "Classification",
+ "exportable": false,
+ "enabled": true
+ },
+ {
+ "id": "b5cfd229-2ac7-4b2b-8d0a-2b0661344894",
+ "name": "Landmarks (compact)",
+ "type": "Classification",
+ "exportable": false,
+ "enabled": true
+ },
+ {
+ "id": "6b4faeda-8396-481b-9f8b-177b9fa3097f",
+ "name": "Retail (compact)",
+ "type": "Classification",
+ "exportable": false,
+ "enabled": true
+ }
+ ]
+ }
+ }
+}
diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/GetExports.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/GetExports.json
new file mode 100644
index 000000000000..1267168dbb4c
--- /dev/null
+++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/GetExports.json
@@ -0,0 +1,22 @@
+{
+ "parameters": {
+ "Endpoint": "https://westus.api.cognitive.microsoft.com",
+ "Content-Type": "application/json",
+ "Training-Key": "{API Key}",
+ "projectId": "64b822c5-8082-4b36-a426-27225f4aa18c",
+ "iterationId": "e31a14ab-5d78-4f7b-a267-3a1e4fd8a758"
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": [
+ {
+ "platform": "TensorFlow",
+ "status": "Done",
+ "newerVersionAvailable": false,
+ "downloadUri": "{Download URI}"
+ }
+ ]
+ }
+ }
+}
diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/GetImageCount.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/GetImageCount.json
new file mode 100644
index 000000000000..ee6e4980eefa
--- /dev/null
+++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/GetImageCount.json
@@ -0,0 +1,14 @@
+{
+ "parameters": {
+ "Endpoint": "https://westus.api.cognitive.microsoft.com",
+ "Content-Type": "application/json",
+ "Training-Key": "{API Key}",
+ "projectId": "bc3f7dad-5544-468c-8573-3ef04d55463e"
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": 12
+ }
+ }
+}
diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/GetImagePerformanceCount.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/GetImagePerformanceCount.json
new file mode 100644
index 000000000000..c57ffd50669b
--- /dev/null
+++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/GetImagePerformanceCount.json
@@ -0,0 +1,18 @@
+{
+ "parameters": {
+ "Endpoint": "https://westus.api.cognitive.microsoft.com",
+ "Content-Type": "application/json",
+ "Training-Key": "{API Key}",
+ "projectId": "bc3f7dad-5544-468c-8573-3ef04d55463e",
+ "iterationId": "cf0f83fb-ebaa-4b25-8e34-613a6a0b8a12",
+ "tagIds": [
+ "b5f7e6a2-a481-49a6-afec-a7cef1af3544"
+ ]
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": "1"
+ }
+ }
+}
diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/GetImagePerformances.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/GetImagePerformances.json
new file mode 100644
index 000000000000..dfe6eb5a7208
--- /dev/null
+++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/GetImagePerformances.json
@@ -0,0 +1,43 @@
+{
+ "parameters": {
+ "Endpoint": "https://westus.api.cognitive.microsoft.com",
+ "Content-Type": "application/json",
+ "Training-Key": "{API Key}",
+ "projectId": "bc3f7dad-5544-468c-8573-3ef04d55463e",
+ "iterationId": "b7b9d99c-a2c6-4658-9900-a98d2ff5bc66",
+ "tagIds": [
+ ""
+ ],
+ "orderBy": "Newest"
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": [
+ {
+ "id": "dfd2d346-3ed5-4e1e-857d-af4e32cec042",
+ "created": "2018-01-31T20:18:26Z",
+ "predictions": [
+ {
+ "tagId": "b5f7e6a2-a481-49a6-afec-a7cef1af3544",
+ "tagName": "Tag 1",
+ "probability": 1.0,
+ "boundingBox": {
+ "left": 0.25,
+ "top": 0.25,
+ "width": 0.25,
+ "height": 0.25
+ }
+ }
+ ],
+ "width": 600,
+ "height": 1600,
+ "imageUri": "",
+ "thumbnailUri": "",
+ "tags": [],
+ "regions": []
+ }
+ ]
+ }
+ }
+}
diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/GetImageRegionProposals.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/GetImageRegionProposals.json
new file mode 100644
index 000000000000..7638215aae62
--- /dev/null
+++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/GetImageRegionProposals.json
@@ -0,0 +1,29 @@
+{
+ "parameters": {
+ "Endpoint": "https://westus.api.cognitive.microsoft.com",
+ "Content-Type": "application/json",
+ "Training-Key": "{API Key}",
+ "projectId": "bc3f7dad-5544-468c-8573-3ef04d55463e",
+ "imageId": "4d6eb844-42ee-42bc-bd6f-c32455ef07c9"
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": {
+ "projectId": "bc3f7dad-5544-468c-8573-3ef04d55463e",
+ "imageId": "4d6eb844-42ee-42bc-bd6f-c32455ef07c9",
+ "proposals": [
+ {
+ "confidence": 0.25,
+ "boundingBox": {
+ "left": 0.25,
+ "top": 0.25,
+ "width": 0.25,
+ "height": 0.25
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/GetImages.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/GetImages.json
new file mode 100644
index 000000000000..d02bd9b585ef
--- /dev/null
+++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/GetImages.json
@@ -0,0 +1,47 @@
+{
+ "parameters": {
+ "Endpoint": "https://westus.api.cognitive.microsoft.com",
+ "Content-Type": "application/json",
+ "Training-Key": "{API Key}",
+ "projectId": "bc3f7dad-5544-468c-8573-3ef04d55463e"
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": [
+ {
+ "id": "4d6eb844-42ee-42bc-bd6f-c32455ef07c9",
+ "created": "2017-12-19T15:56:10Z",
+ "width": 1095,
+ "height": 900,
+ "resizedImageUri": "{Resized Image Uri}",
+ "originalImageUri": "{Image Uri}",
+ "thumbnailUri": "{Thumbnail Uri}",
+ "tags": [
+ {
+ "tagId": "b607964f-7bd6-4a3b-a869-6791fb6aab87",
+ "created": "2017-12-19T15:56:09Z",
+ "tagName": "tag 1"
+ }
+ ]
+ },
+ {
+ "id": "f1855a92-b873-47e7-b513-f07a667ceda1",
+ "created": "2017-12-19T15:56:10Z",
+ "width": 900,
+ "height": 1531,
+ "resizedImageUri": "{Resized Image Uri}",
+ "originalImageUri": "{Image Uri}",
+ "thumbnailUri": "{Thumbnail Uri}",
+ "tags": [
+ {
+ "tagId": "b607964f-7bd6-4a3b-a869-6791fb6aab87",
+ "created": "2017-12-19T15:56:09Z",
+ "tagName": "tag 1"
+ }
+ ]
+ }
+ ]
+ }
+ }
+}
diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/GetImagesByIds.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/GetImagesByIds.json
new file mode 100644
index 000000000000..037118bc9d41
--- /dev/null
+++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/GetImagesByIds.json
@@ -0,0 +1,15 @@
+{
+ "parameters": {
+ "Endpoint": "https://westus.api.cognitive.microsoft.com",
+ "Content-Type": "application/json",
+ "Training-Key": "{API Key}",
+ "projectId": "bc3f7dad-5544-468c-8573-3ef04d55463e",
+ "iterationId": "cf0f83fb-ebaa-4b25-8e34-613a6a0b8a12"
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": []
+ }
+ }
+}
diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/GetIteration.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/GetIteration.json
new file mode 100644
index 000000000000..2383a6c6f910
--- /dev/null
+++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/GetIteration.json
@@ -0,0 +1,34 @@
+{
+ "parameters": {
+ "Endpoint": "https://westus.api.cognitive.microsoft.com",
+ "Content-Type": "application/json",
+ "Training-Key": "{API Key}",
+ "projectId": "64b822c5-8082-4b36-a426-27225f4aa18c",
+ "iterationId": "e31a14ab-5d78-4f7b-a267-3a1e4fd8a758"
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": {
+ "id": "e31a14ab-5d78-4f7b-a267-3a1e4fd8a758",
+ "name": "Iteration 2",
+ "status": "Completed",
+ "created": "2017-12-18T22:40:36Z",
+ "lastModified": "2017-12-19T15:47:02Z",
+ "trainedAt": "2017-12-19T15:47:02Z",
+ "projectId": "64b822c5-8082-4b36-a426-27225f4aa18c",
+ "exportable": false,
+ "domainId": "ee85a74c-405e-4adc-bb47-ffa8ca0c9f31",
+ "exportableTo": [
+ "ONNX",
+ "DockerFile",
+ "TensorFlow",
+ "CoreML"
+ ],
+ "trainingType": "Regular",
+ "reservedBudgetInHours": 0,
+ "publishName": ""
+ }
+ }
+ }
+}
diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/GetIterationPerformance.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/GetIterationPerformance.json
new file mode 100644
index 000000000000..323173c03a51
--- /dev/null
+++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/GetIterationPerformance.json
@@ -0,0 +1,39 @@
+{
+ "parameters": {
+ "Endpoint": "https://westus.api.cognitive.microsoft.com",
+ "Content-Type": "application/json",
+ "Training-Key": "{API Key}",
+ "projectId": "bc3f7dad-5544-468c-8573-3ef04d55463e",
+ "iterationId": "fe1e83c4-6f50-4899-9544-6bb08cf0e15a",
+ "threshold": 0.9
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": {
+ "perTagPerformance": [
+ {
+ "id": "e31ff107-5505-4753-be42-b369b21b026c",
+ "name": "Hemlock",
+ "precision": 1.0,
+ "precisionStdDeviation": 0.0,
+ "recall": 1.0,
+ "recallStdDeviation": 0.0
+ },
+ {
+ "id": "349d72ac-0948-4d51-b1e4-c14a1f9b848a",
+ "name": "Japanese Cherry",
+ "precision": 1.0,
+ "precisionStdDeviation": 0.0,
+ "recall": 1.0,
+ "recallStdDeviation": 0.0
+ }
+ ],
+ "precision": 1.0,
+ "precisionStdDeviation": 0.0,
+ "recall": 1.0,
+ "recallStdDeviation": 0.0
+ }
+ }
+ }
+}
diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/GetIterations.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/GetIterations.json
new file mode 100644
index 000000000000..ac0c78134a80
--- /dev/null
+++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/GetIterations.json
@@ -0,0 +1,74 @@
+{
+ "parameters": {
+ "Endpoint": "https://westus.api.cognitive.microsoft.com",
+ "Content-Type": "application/json",
+ "Training-Key": "{API Key}",
+ "projectId": "64b822c5-8082-4b36-a426-27225f4aa18c"
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": [
+ {
+ "id": "fe1e83c4-6f50-4899-9544-6bb08cf0e15a",
+ "name": "Iteration 1",
+ "status": "Completed",
+ "created": "2017-12-18T22:40:29Z",
+ "lastModified": "2017-12-18T22:40:41Z",
+ "trainedAt": "2017-12-18T22:40:41Z",
+ "projectId": "64b822c5-8082-4b36-a426-27225f4aa18c",
+ "exportable": false,
+ "domainId": "ee85a74c-405e-4adc-bb47-ffa8ca0c9f31",
+ "exportableTo": [
+ "ONNX",
+ "DockerFile",
+ "TensorFlow",
+ "CoreML"
+ ],
+ "trainingType": "Regular",
+ "reservedBudgetInHours": 0,
+ "publishName": ""
+ },
+ {
+ "id": "e31a14ab-5d78-4f7b-a267-3a1e4fd8a758",
+ "name": "Iteration 2",
+ "status": "Completed",
+ "created": "2017-12-18T22:40:36Z",
+ "lastModified": "2017-12-19T15:47:02Z",
+ "trainedAt": "2017-12-19T15:47:02Z",
+ "projectId": "64b822c5-8082-4b36-a426-27225f4aa18c",
+ "exportable": false,
+ "domainId": "ee85a74c-405e-4adc-bb47-ffa8ca0c9f31",
+ "exportableTo": [
+ "ONNX",
+ "DockerFile",
+ "TensorFlow",
+ "CoreML"
+ ],
+ "trainingType": "Regular",
+ "reservedBudgetInHours": 5,
+ "publishName": "model1"
+ },
+ {
+ "id": "3adaf7b2-18fc-4376-9da4-b5ea160a7cf5",
+ "name": "Iteration 3",
+ "status": "New",
+ "created": "2017-12-19T15:46:59Z",
+ "lastModified": "2017-12-19T15:46:59Z",
+ "projectId": "64b822c5-8082-4b36-a426-27225f4aa18c",
+ "exportable": false,
+ "domainId": null,
+ "exportableTo": [
+ "ONNX",
+ "DockerFile",
+ "TensorFlow",
+ "CoreML"
+ ],
+ "trainingType": "Regular",
+ "reservedBudgetInHours": 0,
+ "publishName": ""
+ }
+ ]
+ }
+ }
+}
diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/GetProject.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/GetProject.json
new file mode 100644
index 000000000000..4b68bf1ea390
--- /dev/null
+++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/GetProject.json
@@ -0,0 +1,24 @@
+{
+ "parameters": {
+ "Endpoint": "https://westus.api.cognitive.microsoft.com",
+ "Content-Type": "application/json",
+ "Training-Key": "{API Key}",
+ "projectId": "bc3f7dad-5544-468c-8573-3ef04d55463e"
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": {
+ "id": "bc3f7dad-5544-468c-8573-3ef04d55463e",
+ "name": "My New Project",
+ "description": "A test project",
+ "settings": {
+ "domainId": "ee85a74c-405e-4adc-bb47-ffa8ca0c9f31"
+ },
+ "created": "2017-12-18T05:43:18Z",
+ "lastModified": "2017-12-18T05:43:18Z",
+ "thumbnailUri": ""
+ }
+ }
+ }
+}
diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/GetProjects.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/GetProjects.json
new file mode 100644
index 000000000000..b5166555936f
--- /dev/null
+++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/GetProjects.json
@@ -0,0 +1,25 @@
+{
+ "parameters": {
+ "Endpoint": "https://westus.api.cognitive.microsoft.com",
+ "Content-Type": "application/json",
+ "Training-Key": "{API Key}"
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": [
+ {
+ "id": "bc3f7dad-5544-468c-8573-3ef04d55463e",
+ "name": "My New Project",
+ "description": "",
+ "settings": {
+ "domainId": "ee85a74c-405e-4adc-bb47-ffa8ca0c9f31"
+ },
+ "created": "2017-12-18T05:43:18Z",
+ "lastModified": "2017-12-18T05:43:18Z",
+ "thumbnailUri": ""
+ }
+ ]
+ }
+ }
+}
diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/GetTag.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/GetTag.json
new file mode 100644
index 000000000000..4ad3135822ae
--- /dev/null
+++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/GetTag.json
@@ -0,0 +1,21 @@
+{
+ "parameters": {
+ "Endpoint": "https://westus.api.cognitive.microsoft.com",
+ "Content-Type": "application/json",
+ "Training-Key": "{API Key}",
+ "projectId": "bc3f7dad-5544-468c-8573-3ef04d55463e",
+ "tagId": "9e27bc1b-7ae7-4e3b-a4e5-36153479dc01"
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": {
+ "id": "9e27bc1b-7ae7-4e3b-a4e5-36153479dc01",
+ "name": "Tag1",
+ "description": "Description of Tag1",
+ "type": "Regular",
+ "imageCount": 0
+ }
+ }
+ }
+}
diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/GetTaggedImageCount.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/GetTaggedImageCount.json
new file mode 100644
index 000000000000..c0ed09aa6ae9
--- /dev/null
+++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/GetTaggedImageCount.json
@@ -0,0 +1,15 @@
+{
+ "parameters": {
+ "Endpoint": "https://westus.api.cognitive.microsoft.com",
+ "Content-Type": "application/json",
+ "Training-Key": "{API Key}",
+ "projectId": "bc3f7dad-5544-468c-8573-3ef04d55463e",
+ "iterationId": "cf0f83fb-ebaa-4b25-8e34-613a6a0b8a12"
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": "10"
+ }
+ }
+}
diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/GetTaggedImages.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/GetTaggedImages.json
new file mode 100644
index 000000000000..037118bc9d41
--- /dev/null
+++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/GetTaggedImages.json
@@ -0,0 +1,15 @@
+{
+ "parameters": {
+ "Endpoint": "https://westus.api.cognitive.microsoft.com",
+ "Content-Type": "application/json",
+ "Training-Key": "{API Key}",
+ "projectId": "bc3f7dad-5544-468c-8573-3ef04d55463e",
+ "iterationId": "cf0f83fb-ebaa-4b25-8e34-613a6a0b8a12"
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": []
+ }
+ }
+}
diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/GetTags.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/GetTags.json
new file mode 100644
index 000000000000..6ad8ea76c689
--- /dev/null
+++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/GetTags.json
@@ -0,0 +1,22 @@
+{
+ "parameters": {
+ "Endpoint": "https://westus.api.cognitive.microsoft.com",
+ "Content-Type": "application/json",
+ "Training-Key": "{API Key}",
+ "projectId": "bc3f7dad-5544-468c-8573-3ef04d55463e"
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": [
+ {
+ "id": "9e27bc1b-7ae7-4e3b-a4e5-36153479dc01",
+ "name": "Tag1",
+ "description": "Description of Tag1",
+ "type": "Regular",
+ "imageCount": 0
+ }
+ ]
+ }
+ }
+}
diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/GetUntaggedImageCount.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/GetUntaggedImageCount.json
new file mode 100644
index 000000000000..c0ed09aa6ae9
--- /dev/null
+++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/GetUntaggedImageCount.json
@@ -0,0 +1,15 @@
+{
+ "parameters": {
+ "Endpoint": "https://westus.api.cognitive.microsoft.com",
+ "Content-Type": "application/json",
+ "Training-Key": "{API Key}",
+ "projectId": "bc3f7dad-5544-468c-8573-3ef04d55463e",
+ "iterationId": "cf0f83fb-ebaa-4b25-8e34-613a6a0b8a12"
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": "10"
+ }
+ }
+}
diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/GetUntaggedImages.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/GetUntaggedImages.json
new file mode 100644
index 000000000000..037118bc9d41
--- /dev/null
+++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/GetUntaggedImages.json
@@ -0,0 +1,15 @@
+{
+ "parameters": {
+ "Endpoint": "https://westus.api.cognitive.microsoft.com",
+ "Content-Type": "application/json",
+ "Training-Key": "{API Key}",
+ "projectId": "bc3f7dad-5544-468c-8573-3ef04d55463e",
+ "iterationId": "cf0f83fb-ebaa-4b25-8e34-613a6a0b8a12"
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": []
+ }
+ }
+}
diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/ImportProject.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/ImportProject.json
new file mode 100644
index 000000000000..87702da27426
--- /dev/null
+++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/ImportProject.json
@@ -0,0 +1,25 @@
+{
+ "parameters": {
+ "Endpoint": "https://westus.api.cognitive.microsoft.com",
+ "Content-Type": "application/json",
+ "Training-Key": "{API Key}",
+ "token": "token"
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": {
+ "id": "bc3f7dad-5544-468c-8573-3ef04d55463e",
+ "name": "Import Project",
+ "description": "",
+ "settings": {
+ "domainId": "ee85a74c-405e-4adc-bb47-ffa8ca0c9f31"
+ },
+ "created": "2019-10-06T05:43:18Z",
+ "lastModified": "2019-10-06T05:43:18Z",
+ "thumbnailUri": "",
+ "status": "Importing"
+ }
+ }
+ }
+}
diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/PublishIteration.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/PublishIteration.json
new file mode 100644
index 000000000000..67d6ad03e29f
--- /dev/null
+++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/PublishIteration.json
@@ -0,0 +1,17 @@
+{
+ "parameters": {
+ "Endpoint": "https://westus.api.cognitive.microsoft.com",
+ "Content-Type": "application/json",
+ "Training-Key": "{API Key}",
+ "projectId": "64b822c5-8082-4b36-a426-27225f4aa18c",
+ "iterationId": "e31a14ab-5d78-4f7b-a267-3a1e4fd8a758",
+ "publishName": "Model1",
+ "predictionId": "/subscriptions/{subscription}/resourceGroups/{resource group name}/providers/Microsoft.CognitiveServices/accounts/{resource name}"
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": true
+ }
+ }
+}
diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/QueryPredictions.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/QueryPredictions.json
new file mode 100644
index 000000000000..0bd19d6b7980
--- /dev/null
+++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/QueryPredictions.json
@@ -0,0 +1,66 @@
+{
+ "parameters": {
+ "Endpoint": "https://westus.api.cognitive.microsoft.com",
+ "Content-Type": "application/json",
+ "Training-Key": "{API Key}",
+ "projectId": "bc3f7dad-5544-468c-8573-3ef04d55463e",
+ "query": {
+ "orderBy": "Newest",
+ "tags": [
+ {
+ "id": "b5f7e6a2-a481-49a6-afec-a7cef1af3544",
+ "maxThreshold": 1,
+ "minThreshold": 0.9
+ }
+ ]
+ }
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": {
+ "results": [
+ {
+ "id": "dfd2d346-3ed5-4e1e-857d-af4e32cec042",
+ "project": "8988643a-ae70-447d-9a22-15c4255e5ecb",
+ "iteration": "b7b9d99c-a2c6-4658-9900-a98d2ff5bc66",
+ "created": "2018-01-31T20:18:26Z",
+ "predictions": [
+ {
+ "tagId": "b5f7e6a2-a481-49a6-afec-a7cef1af3544",
+ "tagName": "Tag 1",
+ "probability": 1.0
+ },
+ {
+ "tagId": "45619cda-d1c9-4bc8-a3e1-87c5d81adbc3",
+ "tagName": "Tag 2",
+ "probability": 3.60627153E-12
+ }
+ ],
+ "originalImageUri": "",
+ "thumbnailUri": "",
+ "resizedImageUri": "",
+ "domain": "b30a91ae-e3c1-4f73-a81e-c270bff27c39"
+ }
+ ],
+ "token": {
+ "session": "1:286613",
+ "continuation": "",
+ "maxCount": 0,
+ "orderBy": "Newest",
+ "tags": [
+ {
+ "id": "b5f7e6a2-a481-49a6-afec-a7cef1af3544",
+ "minThreshold": 0.9,
+ "maxThreshold": 1.0
+ }
+ ],
+ "iterationId": null,
+ "startTime": null,
+ "endTime": null,
+ "application": ""
+ }
+ }
+ }
+ }
+}
diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/QuerySuggestedImageCount.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/QuerySuggestedImageCount.json
new file mode 100644
index 000000000000..bfe12dad0540
--- /dev/null
+++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/QuerySuggestedImageCount.json
@@ -0,0 +1,22 @@
+{
+ "parameters": {
+ "Endpoint": "https://westus.api.cognitive.microsoft.com",
+ "Content-Type": "application/json",
+ "Training-Key": "{API Key}",
+ "projectId": "bc3f7dad-5544-468c-8573-3ef04d55463e",
+ "iterationId": "b7b9d99c-a2c6-4658-9900-a98d2ff5bc66",
+ "query": {
+ "tagIds": [
+ "b5f7e6a2-a481-49a6-afec-a7cef1af3544"
+ ]
+ }
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": {
+ "b5f7e6a2-a481-49a6-afec-a7cef1af3544": 1
+ }
+ }
+ }
+}
diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/QuerySuggestedImages.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/QuerySuggestedImages.json
new file mode 100644
index 000000000000..c42db2bc784f
--- /dev/null
+++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/QuerySuggestedImages.json
@@ -0,0 +1,54 @@
+{
+ "parameters": {
+ "Endpoint": "https://westus.api.cognitive.microsoft.com",
+ "Content-Type": "application/json",
+ "Training-Key": "{API Key}",
+ "projectId": "bc3f7dad-5544-468c-8573-3ef04d55463e",
+ "iterationId": "b7b9d99c-a2c6-4658-9900-a98d2ff5bc66",
+ "query": {
+ "tagIds": [
+ "b5f7e6a2-a481-49a6-afec-a7cef1af3544"
+ ]
+ }
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": {
+ "results": [
+ {
+ "id": "dfd2d346-3ed5-4e1e-857d-af4e32cec042",
+ "project": "8988643a-ae70-447d-9a22-15c4255e5ecb",
+ "iteration": "b7b9d99c-a2c6-4658-9900-a98d2ff5bc66",
+ "created": "2018-01-31T20:18:26Z",
+ "predictions": [
+ {
+ "tagId": "b5f7e6a2-a481-49a6-afec-a7cef1af3544",
+ "tagName": "Tag 1",
+ "probability": 1.0
+ },
+ {
+ "tagId": "45619cda-d1c9-4bc8-a3e1-87c5d81adbc3",
+ "tagName": "Tag 2",
+ "probability": 3.60627153E-12
+ }
+ ],
+ "originalImageUri": "",
+ "thumbnailUri": "",
+ "resizedImageUri": "",
+ "domain": "b30a91ae-e3c1-4f73-a81e-c270bff27c39"
+ }
+ ],
+ "token": {
+ "session": "1:286613",
+ "continuation": "",
+ "maxCount": 0,
+ "sortBy": "Newest",
+ "tagIds": [
+ "b5f7e6a2-a481-49a6-afec-a7cef1af3544"
+ ]
+ }
+ }
+ }
+ }
+}
diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/QuickTestImage.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/QuickTestImage.json
new file mode 100644
index 000000000000..489852dc79df
--- /dev/null
+++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/QuickTestImage.json
@@ -0,0 +1,33 @@
+{
+ "parameters": {
+ "Endpoint": "https://westus.api.cognitive.microsoft.com",
+ "Content-Type": "application/json",
+ "Training-Key": "{API Key}",
+ "projectId": "64b822c5-8082-4b36-a426-27225f4aa18c",
+ "iterationId": "fe1e83c4-6f50-4899-9544-6bb08cf0e15a",
+ "imageData": "multipart-form-data"
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": {
+ "id": "951098b2-9b69-427b-bddb-d5cb618874e3",
+ "project": "64b822c5-8082-4b36-a426-27225f4aa18c",
+ "iteration": "fe1e83c4-6f50-4899-9544-6bb08cf0e15a",
+ "created": "2017-12-19T14:21:41Z",
+ "predictions": [
+ {
+ "tagId": "e31ff107-5505-4753-be42-b369b21b026c",
+ "tagName": "Hemlock",
+ "probability": 0.05149666
+ },
+ {
+ "tagId": "349d72ac-0948-4d51-b1e4-c14a1f9b848a",
+ "tagName": "Japanese Cherry",
+ "probability": 0.00
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/QuickTestImageUrl.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/QuickTestImageUrl.json
new file mode 100644
index 000000000000..dc904ef6f116
--- /dev/null
+++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/QuickTestImageUrl.json
@@ -0,0 +1,35 @@
+{
+ "parameters": {
+ "Endpoint": "https://westus.api.cognitive.microsoft.com",
+ "Content-Type": "application/json",
+ "Training-Key": "{API Key}",
+ "projectId": "64b822c5-8082-4b36-a426-27225f4aa18c",
+ "iterationId": "fe1e83c4-6f50-4899-9544-6bb08cf0e15a",
+ "imageUrl": {
+ "url": "{Image URL}"
+ }
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": {
+ "id": "951098b2-9b69-427b-bddb-d5cb618874e3",
+ "project": "64b822c5-8082-4b36-a426-27225f4aa18c",
+ "iteration": "fe1e83c4-6f50-4899-9544-6bb08cf0e15a",
+ "created": "2017-12-19T14:21:41Z",
+ "predictions": [
+ {
+ "tagId": "e31ff107-5505-4753-be42-b369b21b026c",
+ "tagName": "Hemlock",
+ "probability": 0.05149666
+ },
+ {
+ "tagId": "349d72ac-0948-4d51-b1e4-c14a1f9b848a",
+ "tagName": "Japanese Cherry",
+ "probability": 0.00
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/SuggestTagsAndRegions.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/SuggestTagsAndRegions.json
new file mode 100644
index 000000000000..175a0a2a01e0
--- /dev/null
+++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/SuggestTagsAndRegions.json
@@ -0,0 +1,39 @@
+{
+ "parameters": {
+ "Endpoint": "https://westus.api.cognitive.microsoft.com",
+ "Content-Type": "application/json",
+ "Training-Key": "{API Key}",
+ "projectId": "bc3f7dad-5544-468c-8573-3ef04d55463e",
+ "iterationId": "4d6eb844-42ee-42bc-bd6f-c32455ef07c9",
+ "imageIds": [
+ "e7f08c23-9e54-49f7-b609-69a0240ba306",
+ "ce632666-4b66-4adb-aa0a-ad8b7c32df06"
+ ]
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": [
+ {
+ "id": "8497e814-23cc-47d7-b24b-691cef0bcec9",
+ "project": "bc3f7dad-5544-468c-8573-3ef04d55463e",
+ "iteration": "ce271ee4-cc13-460f-b66f-993f8005522d",
+ "created": "2019-07-08T13:43:18Z",
+ "predictions": [
+ {
+ "tagId": "b5f7e6a2-a481-49a6-afec-a7cef1af3544",
+ "tagName": "Tag 1",
+ "probability": 1.0
+ },
+ {
+ "tagId": "45619cda-d1c9-4bc8-a3e1-87c5d81adbc3",
+ "tagName": "Tag 2",
+ "probability": 3.60627153E-12
+ }
+ ],
+ "predictionUncertainty": 0.32
+ }
+ ]
+ }
+ }
+}
diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/TrainProject.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/TrainProject.json
new file mode 100644
index 000000000000..dd3deca15afb
--- /dev/null
+++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/TrainProject.json
@@ -0,0 +1,33 @@
+{
+ "parameters": {
+ "Endpoint": "https://westus.api.cognitive.microsoft.com",
+ "Content-Type": "application/json",
+ "Training-Key": "{API Key}",
+ "projectId": "64b822c5-8082-4b36-a426-27225f4aa18c",
+ "trainingParameters": {}
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": {
+ "id": "e31a14ab-5d78-4f7b-a267-3a1e4fd8a758",
+ "name": "Iteration 2",
+ "status": "Training",
+ "created": "2017-12-18T22:40:36Z",
+ "lastModified": "2017-12-19T15:46:58Z",
+ "projectId": "64b822c5-8082-4b36-a426-27225f4aa18c",
+ "exportable": false,
+ "domainId": null,
+ "exportableTo": [
+ "ONNX",
+ "DockerFile",
+ "TensorFlow",
+ "CoreML"
+ ],
+ "trainingType": "Regular",
+ "reservedBudgetInHours": 0,
+ "publishName": ""
+ }
+ }
+ }
+}
diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/UnpublishIteration.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/UnpublishIteration.json
new file mode 100644
index 000000000000..d1f9b7629958
--- /dev/null
+++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/UnpublishIteration.json
@@ -0,0 +1,12 @@
+{
+ "parameters": {
+ "Endpoint": "https://westus.api.cognitive.microsoft.com",
+ "Content-Type": "application/json",
+ "Training-Key": "{API Key}",
+ "projectId": "64b822c5-8082-4b36-a426-27225f4aa18c",
+ "iterationId": "e31a14ab-5d78-4f7b-a267-3a1e4fd8a758"
+ },
+ "responses": {
+ "204": {}
+ }
+}
diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/UpdateImageMetadata.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/UpdateImageMetadata.json
new file mode 100644
index 000000000000..54ac8a7a0725
--- /dev/null
+++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/UpdateImageMetadata.json
@@ -0,0 +1,43 @@
+{
+ "parameters": {
+ "Endpoint": "https://westus.api.cognitive.microsoft.com",
+ "Content-Type": "application/json",
+ "Training-Key": "{API Key}",
+ "projectId": "bc3f7dad-5544-468c-8573-3ef04d55463e",
+ "imageIds": [
+ "4d6eb844-42ee-42bc-bd6f-c32455ef07c9"
+ ],
+ "metadata": {
+ "tag": "value"
+ }
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": {
+ "isBatchSuccessful": true,
+ "images": [
+ {
+ "imageId": "4d6eb844-42ee-42bc-bd6f-c32455ef07c9",
+ "status": "OK",
+ "metadata": {
+ "tag": "value"
+ }
+ }
+ ]
+ }
+ },
+ "207": {
+ "headers": {},
+ "body": {
+ "isBatchSuccessful": false,
+ "images": [
+ {
+ "imageId": "4d6eb844-42ee-42bc-bd6f-c32455ef07c9",
+ "status": "ErrorLimitExceed"
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/UpdateIteration.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/UpdateIteration.json
new file mode 100644
index 000000000000..a965deb8aa0f
--- /dev/null
+++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/UpdateIteration.json
@@ -0,0 +1,37 @@
+{
+ "parameters": {
+ "Endpoint": "https://westus.api.cognitive.microsoft.com",
+ "Content-Type": "application/json",
+ "Training-Key": "{API Key}",
+ "projectId": "64b822c5-8082-4b36-a426-27225f4aa18c",
+ "iterationId": "e31a14ab-5d78-4f7b-a267-3a1e4fd8a758",
+ "updatedIteration": {
+ "name": "Best Iteration"
+ }
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": {
+ "id": "e31a14ab-5d78-4f7b-a267-3a1e4fd8a758",
+ "name": "Best Iteration",
+ "status": "Completed",
+ "created": "2017-12-18T22:40:36Z",
+ "lastModified": "2017-12-19T15:53:07Z",
+ "trainedAt": "2017-12-19T15:47:02Z",
+ "projectId": "64b822c5-8082-4b36-a426-27225f4aa18c",
+ "exportable": false,
+ "exportableTo": [
+ "ONNX",
+ "DockerFile",
+ "TensorFlow",
+ "CoreML"
+ ],
+ "domainId": "ee85a74c-405e-4adc-bb47-ffa8ca0c9f31",
+ "trainingType": "Regular",
+ "reservedBudgetInHours": 0,
+ "publishName": ""
+ }
+ }
+ }
+}
diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/UpdateProject.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/UpdateProject.json
new file mode 100644
index 000000000000..e19735364b5e
--- /dev/null
+++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/UpdateProject.json
@@ -0,0 +1,31 @@
+{
+ "parameters": {
+ "Endpoint": "https://westus.api.cognitive.microsoft.com",
+ "Content-Type": "application/json",
+ "Training-Key": "{API Key}",
+ "projectId": "bc3f7dad-5544-468c-8573-3ef04d55463e",
+ "updatedProject": {
+ "name": "New Project Name",
+ "description": "A new Description",
+ "settings": {
+ "domainId": "ee85a74c-405e-4adc-bb47-ffa8ca0c9f31"
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": {
+ "id": "bc3f7dad-5544-468c-8573-3ef04d55463e",
+ "name": "New Project Name",
+ "description": "A new Description",
+ "settings": {
+ "domainId": "ee85a74c-405e-4adc-bb47-ffa8ca0c9f31"
+ },
+ "created": "2017-12-18T05:43:18Z",
+ "lastModified": "2017-12-18T05:43:19Z",
+ "thumbnailUri": ""
+ }
+ }
+ }
+}
diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/UpdateTag.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/UpdateTag.json
new file mode 100644
index 000000000000..51e0ee680aab
--- /dev/null
+++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/UpdateTag.json
@@ -0,0 +1,26 @@
+{
+ "parameters": {
+ "Endpoint": "https://westus.api.cognitive.microsoft.com",
+ "Content-Type": "application/json",
+ "Training-Key": "{API Key}",
+ "projectId": "bc3f7dad-5544-468c-8573-3ef04d55463e",
+ "tagId": "9e27bc1b-7ae7-4e3b-a4e5-36153479dc01",
+ "updatedTag": {
+ "name": "Better Tag Name",
+ "type": "Regular",
+ "description": "Better description"
+ }
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": {
+ "id": "9e27bc1b-7ae7-4e3b-a4e5-36153479dc01",
+ "name": "Better Tag Name",
+ "description": "Better description",
+ "type": "Regular",
+ "imageCount": 0
+ }
+ }
+ }
+}
diff --git a/specification/cognitiveservices/data-plane/Face/stable/v1.0/Face.json b/specification/cognitiveservices/data-plane/Face/stable/v1.0/Face.json
index ee3b92700a83..c1ffa742a19a 100644
--- a/specification/cognitiveservices/data-plane/Face/stable/v1.0/Face.json
+++ b/specification/cognitiveservices/data-plane/Face/stable/v1.0/Face.json
@@ -29,7 +29,7 @@
"paths": {
"/findsimilars": {
"post": {
- "description": "Given query face's faceId, to search the similar-looking faces from a faceId array, a face list or a large face list. faceId array contains the faces created by [Face - Detect](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395236), which will expire 24 hours after creation. A \"faceListId\" is created by [FaceList - Create](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f3039524b) containing persistedFaceIds that will not expire. And a \"largeFaceListId\" is created by [LargeFaceList - Create](/docs/services/563879b61984550e40cbbe8d/operations/5a157b68d2de3616c086f2cc) containing persistedFaceIds that will also not expire. Depending on the input the returned similar faces list contains faceIds or persistedFaceIds ranked by similarity.\n Find similar has two working modes, \"matchPerson\" and \"matchFace\". \"matchPerson\" is the default mode that it tries to find faces of the same person as possible by using internal same-person thresholds. It is useful to find a known person's other photos. Note that an empty list will be returned if no faces pass the internal thresholds. \"matchFace\" mode ignores same-person thresholds and returns ranked similar faces anyway, even the similarity is low. It can be used in the cases like searching celebrity-looking faces.\n The 'recognitionModel' associated with the query face's faceId should be the same as the 'recognitionModel' used by the target faceId array, face list or large face list.\n",
+ "description": "Given query face's faceId, to search the similar-looking faces from a faceId array, a face list or a large face list. faceId array contains the faces created by [Face - Detect](https://docs.microsoft.com/rest/api/cognitiveservices/face/face/detectwithurl), which will expire 24 hours after creation. A \"faceListId\" is created by [FaceList - Create](https://docs.microsoft.com/rest/api/cognitiveservices/face/facelist/create) containing persistedFaceIds that will not expire. And a \"largeFaceListId\" is created by [LargeFaceList - Create](https://docs.microsoft.com/rest/api/cognitiveservices/face/largefacelist/create) containing persistedFaceIds that will also not expire. Depending on the input the returned similar faces list contains faceIds or persistedFaceIds ranked by similarity.\n Find similar has two working modes, \"matchPerson\" and \"matchFace\". \"matchPerson\" is the default mode that it tries to find faces of the same person as possible by using internal same-person thresholds. It is useful to find a known person's other photos. Note that an empty list will be returned if no faces pass the internal thresholds. \"matchFace\" mode ignores same-person thresholds and returns ranked similar faces anyway, even the similarity is low. It can be used in the cases like searching celebrity-looking faces.\n The 'recognitionModel' associated with the query face's faceId should be the same as the 'recognitionModel' used by the target faceId array, face list or large face list.\n",
"operationId": "Face_FindSimilar",
"parameters": [
{
@@ -72,7 +72,7 @@
},
"/group": {
"post": {
- "description": "Divide candidate faces into groups based on face similarity. \n* The output is one or more disjointed face groups and a messyGroup. A face group contains faces that have similar looking, often of the same person. Face groups are ranked by group size, i.e. number of faces. Notice that faces belonging to a same person might be split into several groups in the result.\n* MessyGroup is a special face group containing faces that cannot find any similar counterpart face from original faces. The messyGroup will not appear in the result if all faces found their counterparts.\n* Group API needs at least 2 candidate faces and 1000 at most. We suggest to try [Face - Verify](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f3039523a) when you only have 2 candidate faces.\n* The 'recognitionModel' associated with the query faces' faceIds should be the same.\n",
+ "description": "Divide candidate faces into groups based on face similarity. \n* The output is one or more disjointed face groups and a messyGroup. A face group contains faces that have similar looking, often of the same person. Face groups are ranked by group size, i.e. number of faces. Notice that faces belonging to a same person might be split into several groups in the result.\n* MessyGroup is a special face group containing faces that cannot find any similar counterpart face from original faces. The messyGroup will not appear in the result if all faces found their counterparts.\n* Group API needs at least 2 candidate faces and 1000 at most. We suggest to try [Face - Verify](https://docs.microsoft.com/rest/api/cognitiveservices/face/face/verifyfacetoface) when you only have 2 candidate faces.\n* The 'recognitionModel' associated with the query faces' faceIds should be the same.\n",
"operationId": "Face_Group",
"parameters": [
{
@@ -115,7 +115,7 @@
},
"/identify": {
"post": {
- "description": "1-to-many identification to find the closest matches of the specific query person face from a person group or large person group.\n For each face in the faceIds array, Face Identify will compute similarities between the query face and all the faces in the person group (given by personGroupId) or large person group (given by largePersonGroupId), and return candidate person(s) for that face ranked by similarity confidence. The person group/large person group should be trained to make it ready for identification. See more in [PersonGroup - Train](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395249) and [LargePersonGroup - Train](/docs/services/563879b61984550e40cbbe8d/operations/599ae2d16ac60f11b48b5aa4).\n \n \nRemarks: \n* The algorithm allows more than one face to be identified independently at the same request, but no more than 10 faces.\n* Each person in the person group/large person group could have more than one face, but no more than 248 faces.\n* Higher face image quality means better identification precision. Please consider high-quality faces: frontal, clear, and face size is 200x200 pixels (100 pixels between eyes) or bigger.\n* Number of candidates returned is restricted by maxNumOfCandidatesReturned and confidenceThreshold. If no person is identified, the returned candidates will be an empty array.\n* Try [Face - Find Similar](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395237) when you need to find similar faces from a face list/large face list instead of a person group/large person group.\n* The 'recognitionModel' associated with the query faces' faceIds should be the same as the 'recognitionModel' used by the target person group or large person group.\n",
+ "description": "1-to-many identification to find the closest matches of the specific query person face from a person group or large person group.\n For each face in the faceIds array, Face Identify will compute similarities between the query face and all the faces in the person group (given by personGroupId) or large person group (given by largePersonGroupId), and return candidate person(s) for that face ranked by similarity confidence. The person group/large person group should be trained to make it ready for identification. See more in [PersonGroup - Train](https://docs.microsoft.com/rest/api/cognitiveservices/face/persongroup/train) and [LargePersonGroup - Train](https://docs.microsoft.com/rest/api/cognitiveservices/face/largepersongroup/train).\n \n \nRemarks: \n* The algorithm allows more than one face to be identified independently at the same request, but no more than 10 faces.\n* Each person in the person group/large person group could have more than one face, but no more than 248 faces.\n* Higher face image quality means better identification precision. Please consider high-quality faces: frontal, clear, and face size is 200x200 pixels (100 pixels between eyes) or bigger.\n* Number of candidates returned is restricted by maxNumOfCandidatesReturned and confidenceThreshold. If no person is identified, the returned candidates will be an empty array.\n* Try [Face - Find Similar](https://docs.microsoft.com/rest/api/cognitiveservices/face/face/findsimilar) when you need to find similar faces from a face list/large face list instead of a person group/large person group.\n* The 'recognitionModel' associated with the query faces' faceIds should be the same as the 'recognitionModel' used by the target person group or large person group.\n",
"operationId": "Face_Identify",
"parameters": [
{
@@ -467,7 +467,7 @@
}
},
"patch": {
- "description": "Add a face to a person into a person group for face identification or verification. To deal with an image contains multiple faces, input face can be specified as an image with a targetFace rectangle. It returns a persistedFaceId representing the added face. No image will be stored. Only the extracted face feature will be stored on server until [PersonGroup PersonFace - Delete](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f3039523e), [PersonGroup Person - Delete](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f3039523d) or [PersonGroup - Delete](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395245) is called.\n Note persistedFaceId is different from faceId generated by [Face - Detect](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395236).\n* Higher face image quality means better recognition precision. Please consider high-quality faces: frontal, clear, and face size is 200x200 pixels (100 pixels between eyes) or bigger.\n* Each person entry can hold up to 248 faces.\n* JPEG, PNG, GIF (the first frame), and BMP format are supported. The allowed image file size is from 1KB to 6MB.\n* \"targetFace\" rectangle should contain one face. Zero or multiple faces will be regarded as an error. If the provided \"targetFace\" rectangle is not returned from [Face - Detect](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395236), there’s no guarantee to detect and add the face successfully.\n* Out of detectable face size (36x36 - 4096x4096 pixels), large head-pose, or large occlusions will cause failures.\n* Adding/deleting faces to/from a same person will be processed sequentially. Adding/deleting faces to/from different persons are processed in parallel.",
+ "description": "Add a face to a person into a person group for face identification or verification. To deal with an image contains multiple faces, input face can be specified as an image with a targetFace rectangle. It returns a persistedFaceId representing the added face. No image will be stored. Only the extracted face feature will be stored on server until [PersonGroup PersonFace - Delete](https://docs.microsoft.com/rest/api/cognitiveservices/face/persongroupperson/deleteface), [PersonGroup Person - Delete](https://docs.microsoft.com/rest/api/cognitiveservices/face/persongroupperson/delete) or [PersonGroup - Delete](https://docs.microsoft.com/rest/api/cognitiveservices/face/persongroup/delete) is called.\n Note persistedFaceId is different from faceId generated by [Face - Detect](https://docs.microsoft.com/rest/api/cognitiveservices/face/face/detectwithurl).\n* Higher face image quality means better recognition precision. Please consider high-quality faces: frontal, clear, and face size is 200x200 pixels (100 pixels between eyes) or bigger.\n* Each person entry can hold up to 248 faces.\n* JPEG, PNG, GIF (the first frame), and BMP format are supported. The allowed image file size is from 1KB to 6MB.\n* \"targetFace\" rectangle should contain one face. Zero or multiple faces will be regarded as an error. If the provided \"targetFace\" rectangle is not returned from [Face - Detect](https://docs.microsoft.com/rest/api/cognitiveservices/face/face/detectwithurl), there’s no guarantee to detect and add the face successfully.\n* Out of detectable face size (36x36 - 4096x4096 pixels), large head-pose, or large occlusions will cause failures.\n* Adding/deleting faces to/from a same person will be processed sequentially. Adding/deleting faces to/from different persons are processed in parallel.",
"operationId": "PersonGroupPerson_UpdateFace",
"parameters": [
{
@@ -513,7 +513,7 @@
},
"/persongroups/{personGroupId}": {
"put": {
- "description": "Create a new person group with specified personGroupId, name, user-provided userData and recognitionModel.\n A person group is the container of the uploaded person data, including face recognition features.\n After creation, use [PersonGroup Person - Create](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f3039523c) to add persons into the group, and then call [PersonGroup - Train](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395249) to get this group ready for [Face - Identify](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395239).\n No image will be stored. Only the person's extracted face features and userData will be stored on server until [PersonGroup Person - Delete](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f3039523d) or [PersonGroup - Delete](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395245) is called.\n 'recognitionModel' should be specified to associate with this person group. The default value for 'recognitionModel' is 'recognition_01', if the latest model needed, please explicitly specify the model you need in this parameter. New faces that are added to an existing person group will use the recognition model that's already associated with the collection. Existing face features in a person group can't be updated to features extracted by another version of recognition model.\n* 'recognition_01': The default recognition model for [PersonGroup - Create](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395244). All those person groups created before 2019 March are bonded with this recognition model.\n* 'recognition_02': Recognition model released in 2019 March. 'recognition_02' is recommended since its overall accuracy is improved compared with 'recognition_01'.\n\nPerson group quota:\n* Free-tier subscription quota: 1,000 person groups. Each holds up to 1,000 persons.\n* S0-tier subscription quota: 1,000,000 person groups. Each holds up to 10,000 persons.\n* to handle larger scale face identification problem, please consider using [LargePersonGroup](/docs/services/563879b61984550e40cbbe8d/operations/599acdee6ac60f11b48b5a9d).",
+ "description": "Create a new person group with specified personGroupId, name, user-provided userData and recognitionModel.\n A person group is the container of the uploaded person data, including face recognition features.\n After creation, use [PersonGroup Person - Create](https://docs.microsoft.com/rest/api/cognitiveservices/face/persongroupperson/create) to add persons into the group, and then call [PersonGroup - Train](https://docs.microsoft.com/rest/api/cognitiveservices/face/persongroup/train) to get this group ready for [Face - Identify](https://docs.microsoft.com/rest/api/cognitiveservices/face/face/identify).\n No image will be stored. Only the person's extracted face features and userData will be stored on server until [PersonGroup Person - Delete](https://docs.microsoft.com/rest/api/cognitiveservices/face/persongroupperson/delete) or [PersonGroup - Delete](https://docs.microsoft.com/rest/api/cognitiveservices/face/persongroup/delete) is called.\n 'recognitionModel' should be specified to associate with this person group. The default value for 'recognitionModel' is 'recognition_01', if the latest model needed, please explicitly specify the model you need in this parameter. New faces that are added to an existing person group will use the recognition model that's already associated with the collection. Existing face features in a person group can't be updated to features extracted by another version of recognition model.\n* 'recognition_01': The default recognition model for [PersonGroup - Create](https://docs.microsoft.com/rest/api/cognitiveservices/face/persongroup/create). All those person groups created before 2019 March are bonded with this recognition model.\n* 'recognition_02': Recognition model released in 2019 March. 'recognition_02' is recommended since its overall accuracy is improved compared with 'recognition_01'.\n\nPerson group quota:\n* Free-tier subscription quota: 1,000 person groups. Each holds up to 1,000 persons.\n* S0-tier subscription quota: 1,000,000 person groups. Each holds up to 10,000 persons.\n* to handle larger scale face identification problem, please consider using [LargePersonGroup](https://docs.microsoft.com/rest/api/cognitiveservices/face/largepersongroup).",
"operationId": "PersonGroup_Create",
"parameters": [
{
@@ -576,7 +576,7 @@
}
},
"get": {
- "description": "Retrieve person group name, userData and recognitionModel. To get person information under this personGroup, use [PersonGroup Person - List](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395241).",
+ "description": "Retrieve person group name, userData and recognitionModel. To get person information under this personGroup, use [PersonGroup Person - List](https://docs.microsoft.com/rest/api/cognitiveservices/face/persongroupperson/list).",
"operationId": "PersonGroup_Get",
"parameters": [
{
@@ -764,7 +764,7 @@
},
"/facelists/{faceListId}": {
"put": {
- "description": "Create an empty face list with user-specified faceListId, name, an optional userData and recognitionModel. Up to 64 face lists are allowed in one subscription.\n Face list is a list of faces, up to 1,000 faces, and used by [Face - Find Similar](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395237).\n After creation, user should use [FaceList - Add Face](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395250) to import the faces. No image will be stored. Only the extracted face features are stored on server until [FaceList - Delete](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f3039524f) is called.\n Find Similar is used for scenario like finding celebrity-like faces, similar face filtering, or as a light way face identification. But if the actual use is to identify person, please use [PersonGroup](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395244) / [LargePersonGroup](/docs/services/563879b61984550e40cbbe8d/operations/599acdee6ac60f11b48b5a9d) and [Face - Identify](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395239).\n Please consider [LargeFaceList](/docs/services/563879b61984550e40cbbe8d/operations/5a157b68d2de3616c086f2cc) when the face number is large. It can support up to 1,000,000 faces.\n 'recognitionModel' should be specified to associate with this face list. The default value for 'recognitionModel' is 'recognition_01', if the latest model needed, please explicitly specify the model you need in this parameter. New faces that are added to an existing face list will use the recognition model that's already associated with the collection. Existing face features in a face list can't be updated to features extracted by another version of recognition model.\n* 'recognition_01': The default recognition model for [FaceList- Create](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f3039524b). All those face lists created before 2019 March are bonded with this recognition model.\n* 'recognition_02': Recognition model released in 2019 March. 'recognition_02' is recommended since its overall accuracy is improved compared with 'recognition_01'.",
+ "description": "Create an empty face list with user-specified faceListId, name, an optional userData and recognitionModel. Up to 64 face lists are allowed in one subscription.\n Face list is a list of faces, up to 1,000 faces, and used by [Face - Find Similar](https://docs.microsoft.com/rest/api/cognitiveservices/face/face/findsimilar).\n After creation, user should use [FaceList - Add Face](https://docs.microsoft.com/rest/api/cognitiveservices/face/facelist/addfacefromurl) to import the faces. No image will be stored. Only the extracted face features are stored on server until [FaceList - Delete](https://docs.microsoft.com/rest/api/cognitiveservices/face/facelist/delete) is called.\n Find Similar is used for scenario like finding celebrity-like faces, similar face filtering, or as a light way face identification. But if the actual use is to identify person, please use [PersonGroup](https://docs.microsoft.com/rest/api/cognitiveservices/face/persongroup) / [LargePersonGroup](https://docs.microsoft.com/rest/api/cognitiveservices/face/largepersongroup) and [Face - Identify](https://docs.microsoft.com/rest/api/cognitiveservices/face/face/identify).\n Please consider [LargeFaceList](https://docs.microsoft.com/rest/api/cognitiveservices/face/largefacelist) when the face number is large. It can support up to 1,000,000 faces.\n 'recognitionModel' should be specified to associate with this face list. The default value for 'recognitionModel' is 'recognition_01', if the latest model needed, please explicitly specify the model you need in this parameter. New faces that are added to an existing face list will use the recognition model that's already associated with the collection. Existing face features in a face list can't be updated to features extracted by another version of recognition model.\n* 'recognition_01': The default recognition model for [FaceList- Create](https://docs.microsoft.com/rest/api/cognitiveservices/face/facelist/create). All those face lists created before 2019 March are bonded with this recognition model.\n* 'recognition_02': Recognition model released in 2019 March. 'recognition_02' is recommended since its overall accuracy is improved compared with 'recognition_01'.",
"operationId": "FaceList_Create",
"parameters": [
{
@@ -904,7 +904,7 @@
},
"/facelists": {
"get": {
- "description": "List face lists’ faceListId, name, userData and recognitionModel. \nTo get face information inside faceList use [FaceList - Get](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f3039524c)\n",
+ "description": "List face lists’ faceListId, name, userData and recognitionModel. \nTo get face information inside faceList use [FaceList - Get](https://docs.microsoft.com/rest/api/cognitiveservices/face/facelist/get)\n",
"operationId": "FaceList_List",
"parameters": [
{
@@ -967,7 +967,7 @@
},
"/persongroups/{personGroupId}/persons/{personId}/persistedfaces": {
"post": {
- "description": "Add a face to a person into a person group for face identification or verification. To deal with an image contains multiple faces, input face can be specified as an image with a targetFace rectangle. It returns a persistedFaceId representing the added face. No image will be stored. Only the extracted face feature will be stored on server until [PersonGroup PersonFace - Delete](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f3039523e), [PersonGroup Person - Delete](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f3039523d) or [PersonGroup - Delete](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395245) is called.\n Note persistedFaceId is different from faceId generated by [Face - Detect](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395236).\n* Higher face image quality means better recognition precision. Please consider high-quality faces: frontal, clear, and face size is 200x200 pixels (100 pixels between eyes) or bigger.\n* Each person entry can hold up to 248 faces.\n* JPEG, PNG, GIF (the first frame), and BMP format are supported. The allowed image file size is from 1KB to 6MB.\n* \"targetFace\" rectangle should contain one face. Zero or multiple faces will be regarded as an error. If the provided \"targetFace\" rectangle is not returned from [Face - Detect](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395236), there’s no guarantee to detect and add the face successfully.\n* Out of detectable face size (36x36 - 4096x4096 pixels), large head-pose, or large occlusions will cause failures.\n* Adding/deleting faces to/from a same person will be processed sequentially. Adding/deleting faces to/from different persons are processed in parallel.\n* The minimum detectable face size is 36x36 pixels in an image no larger than 1920x1080 pixels. Images with dimensions higher than 1920x1080 pixels will need a proportionally larger minimum face size.\n* Different 'detectionModel' values can be provided. To use and compare different detection models, please refer to [How to specify a detection model](https://docs.microsoft.com/en-us/azure/cognitive-services/face/face-api-how-to-topics/specify-detection-model)\n | Model | Recommended use-case(s) |\n | ---------- | -------- |\n | 'detection_01': | The default detection model for [PersonGroup Person - Add Face](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f3039523b). Recommend for near frontal face detection. For scenarios with exceptionally large angle (head-pose) faces, occluded faces or wrong image orientation, the faces in such cases may not be detected. |\n | 'detection_02': | Detection model released in 2019 May with improved accuracy especially on small, side and blurry faces. |",
+ "description": "Add a face to a person into a person group for face identification or verification. To deal with an image contains multiple faces, input face can be specified as an image with a targetFace rectangle. It returns a persistedFaceId representing the added face. No image will be stored. Only the extracted face feature will be stored on server until [PersonGroup PersonFace - Delete](https://docs.microsoft.com/rest/api/cognitiveservices/face/persongroupperson/deleteface), [PersonGroup Person - Delete](https://docs.microsoft.com/rest/api/cognitiveservices/face/persongroupperson/delete) or [PersonGroup - Delete](https://docs.microsoft.com/rest/api/cognitiveservices/face/persongroup/delete) is called.\n Note persistedFaceId is different from faceId generated by [Face - Detect](https://docs.microsoft.com/rest/api/cognitiveservices/face/face/detectwithurl).\n* Higher face image quality means better recognition precision. Please consider high-quality faces: frontal, clear, and face size is 200x200 pixels (100 pixels between eyes) or bigger.\n* Each person entry can hold up to 248 faces.\n* JPEG, PNG, GIF (the first frame), and BMP format are supported. The allowed image file size is from 1KB to 6MB.\n* \"targetFace\" rectangle should contain one face. Zero or multiple faces will be regarded as an error. If the provided \"targetFace\" rectangle is not returned from [Face - Detect](https://docs.microsoft.com/rest/api/cognitiveservices/face/face/detectwithurl), there’s no guarantee to detect and add the face successfully.\n* Out of detectable face size (36x36 - 4096x4096 pixels), large head-pose, or large occlusions will cause failures.\n* Adding/deleting faces to/from a same person will be processed sequentially. Adding/deleting faces to/from different persons are processed in parallel.\n* The minimum detectable face size is 36x36 pixels in an image no larger than 1920x1080 pixels. Images with dimensions higher than 1920x1080 pixels will need a proportionally larger minimum face size.\n* Different 'detectionModel' values can be provided. To use and compare different detection models, please refer to [How to specify a detection model](https://docs.microsoft.com/azure/cognitive-services/face/face-api-how-to-topics/specify-detection-model)\n | Model | Recommended use-case(s) |\n | ---------- | -------- |\n | 'detection_01': | The default detection model for [PersonGroup Person - Add Face](https://docs.microsoft.com/rest/api/cognitiveservices/face/persongroupperson/addfacefromurl). Recommend for near frontal face detection. For scenarios with exceptionally large angle (head-pose) faces, occluded faces or wrong image orientation, the faces in such cases may not be detected. |\n | 'detection_02': | Detection model released in 2019 May with improved accuracy especially on small, side and blurry faces. |",
"operationId": "PersonGroupPerson_AddFaceFromUrl",
"parameters": [
{
@@ -1018,7 +1018,7 @@
},
"/detect": {
"post": {
- "description": "Detect human faces in an image, return face rectangles, and optionally with faceIds, landmarks, and attributes. \n* No image will be stored. Only the extracted face feature will be stored on server. The faceId is an identifier of the face feature and will be used in [Face - Identify](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395239), [Face - Verify](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f3039523a), and [Face - Find Similar](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395237). The stored face feature(s) will expire and be deleted 24 hours after the original detection call.\n* Optional parameters include faceId, landmarks, and attributes. Attributes include age, gender, headPose, smile, facialHair, glasses, emotion, hair, makeup, occlusion, accessories, blur, exposure and noise. Some of the results returned for specific attributes may not be highly accurate.\n* JPEG, PNG, GIF (the first frame), and BMP format are supported. The allowed image file size is from 1KB to 6MB.\n* Up to 100 faces can be returned for an image. Faces are ranked by face rectangle size from large to small.\n* For optimal results when querying [Face - Identify](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395239), [Face - Verify](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f3039523a), and [Face - Find Similar](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395237) ('returnFaceId' is true), please use faces that are: frontal, clear, and with a minimum size of 200x200 pixels (100 pixels between eyes).\n* The minimum detectable face size is 36x36 pixels in an image no larger than 1920x1080 pixels. Images with dimensions higher than 1920x1080 pixels will need a proportionally larger minimum face size.\n* Different 'detectionModel' values can be provided. To use and compare different detection models, please refer to [How to specify a detection model](https://docs.microsoft.com/en-us/azure/cognitive-services/face/face-api-how-to-topics/specify-detection-model)\n | Model | Recommended use-case(s) |\n | ---------- | -------- |\n | 'detection_01': | The default detection model for [Face - Detect](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395236). Recommend for near frontal face detection. For scenarios with exceptionally large angle (head-pose) faces, occluded faces or wrong image orientation, the faces in such cases may not be detected. |\n | 'detection_02': | Detection model released in 2019 May with improved accuracy especially on small, side and blurry faces. |\n\n* Different 'recognitionModel' values are provided. If follow-up operations like Verify, Identify, Find Similar are needed, please specify the recognition model with 'recognitionModel' parameter. The default value for 'recognitionModel' is 'recognition_01', if latest model needed, please explicitly specify the model you need in this parameter. Once specified, the detected faceIds will be associated with the specified recognition model. More details, please refer to [How to specify a recognition model](https://docs.microsoft.com/en-us/azure/cognitive-services/face/face-api-how-to-topics/specify-recognition-model)\n | Model | Recommended use-case(s) |\n | ---------- | -------- |\n | 'recognition_01': | The default recognition model for [Face - Detect](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395236). All those faceIds created before 2019 March are bonded with this recognition model. |\n | 'recognition_02': | Recognition model released in 2019 March. 'recognition_02' is recommended since its overall accuracy is improved compared with 'recognition_01'. |",
+ "description": "Detect human faces in an image, return face rectangles, and optionally with faceIds, landmarks, and attributes. \n* No image will be stored. Only the extracted face feature will be stored on server. The faceId is an identifier of the face feature and will be used in [Face - Identify](https://docs.microsoft.com/rest/api/cognitiveservices/face/face/identify), [Face - Verify](https://docs.microsoft.com/rest/api/cognitiveservices/face/face/verifyfacetoface), and [Face - Find Similar](https://docs.microsoft.com/rest/api/cognitiveservices/face/face/findsimilar). The stored face feature(s) will expire and be deleted 24 hours after the original detection call.\n* Optional parameters include faceId, landmarks, and attributes. Attributes include age, gender, headPose, smile, facialHair, glasses, emotion, hair, makeup, occlusion, accessories, blur, exposure and noise. Some of the results returned for specific attributes may not be highly accurate.\n* JPEG, PNG, GIF (the first frame), and BMP format are supported. The allowed image file size is from 1KB to 6MB.\n* Up to 100 faces can be returned for an image. Faces are ranked by face rectangle size from large to small.\n* For optimal results when querying [Face - Identify](https://docs.microsoft.com/rest/api/cognitiveservices/face/face/identify), [Face - Verify](https://docs.microsoft.com/rest/api/cognitiveservices/face/face/verifyfacetoface), and [Face - Find Similar](https://docs.microsoft.com/rest/api/cognitiveservices/face/face/findsimilar) ('returnFaceId' is true), please use faces that are: frontal, clear, and with a minimum size of 200x200 pixels (100 pixels between eyes).\n* The minimum detectable face size is 36x36 pixels in an image no larger than 1920x1080 pixels. Images with dimensions higher than 1920x1080 pixels will need a proportionally larger minimum face size.\n* Different 'detectionModel' values can be provided. To use and compare different detection models, please refer to [How to specify a detection model](https://docs.microsoft.com/azure/cognitive-services/face/face-api-how-to-topics/specify-detection-model)\n | Model | Recommended use-case(s) |\n | ---------- | -------- |\n | 'detection_01': | The default detection model for [Face - Detect](https://docs.microsoft.com/rest/api/cognitiveservices/face/face/detectwithurl). Recommend for near frontal face detection. For scenarios with exceptionally large angle (head-pose) faces, occluded faces or wrong image orientation, the faces in such cases may not be detected. |\n | 'detection_02': | Detection model released in 2019 May with improved accuracy especially on small, side and blurry faces. |\n\n* Different 'recognitionModel' values are provided. If follow-up operations like Verify, Identify, Find Similar are needed, please specify the recognition model with 'recognitionModel' parameter. The default value for 'recognitionModel' is 'recognition_01', if latest model needed, please explicitly specify the model you need in this parameter. Once specified, the detected faceIds will be associated with the specified recognition model. More details, please refer to [How to specify a recognition model](https://docs.microsoft.com/azure/cognitive-services/face/face-api-how-to-topics/specify-recognition-model)\n | Model | Recommended use-case(s) |\n | ---------- | -------- |\n | 'recognition_01': | The default recognition model for [Face - Detect](https://docs.microsoft.com/rest/api/cognitiveservices/face/face/detectwithurl). All those faceIds created before 2019 March are bonded with this recognition model. |\n | 'recognition_02': | Recognition model released in 2019 March. 'recognition_02' is recommended since its overall accuracy is improved compared with 'recognition_01'. |",
"operationId": "Face_DetectWithUrl",
"parameters": [
{
@@ -1080,7 +1080,7 @@
},
"/facelists/{faceListId}/persistedfaces": {
"post": {
- "description": "Add a face to a specified face list, up to 1,000 faces.\n To deal with an image contains multiple faces, input face can be specified as an image with a targetFace rectangle. It returns a persistedFaceId representing the added face. No image will be stored. Only the extracted face feature will be stored on server until [FaceList - Delete Face](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395251) or [FaceList - Delete](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f3039524f) is called.\n Note persistedFaceId is different from faceId generated by [Face - Detect](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395236).\n* Higher face image quality means better detection and recognition precision. Please consider high-quality faces: frontal, clear, and face size is 200x200 pixels (100 pixels between eyes) or bigger.\n* JPEG, PNG, GIF (the first frame), and BMP format are supported. The allowed image file size is from 1KB to 6MB.\n* \"targetFace\" rectangle should contain one face. Zero or multiple faces will be regarded as an error. If the provided \"targetFace\" rectangle is not returned from [Face - Detect](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395236), there’s no guarantee to detect and add the face successfully.\n* Out of detectable face size (36x36 - 4096x4096 pixels), large head-pose, or large occlusions will cause failures.\n* Adding/deleting faces to/from a same face list are processed sequentially and to/from different face lists are in parallel.\n* The minimum detectable face size is 36x36 pixels in an image no larger than 1920x1080 pixels. Images with dimensions higher than 1920x1080 pixels will need a proportionally larger minimum face size.\n* Different 'detectionModel' values can be provided. To use and compare different detection models, please refer to [How to specify a detection model](https://docs.microsoft.com/en-us/azure/cognitive-services/face/face-api-how-to-topics/specify-detection-model)\n | Model | Recommended use-case(s) |\n | ---------- | -------- |\n | 'detection_01': | The default detection model for [FaceList - Add Face](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395250). Recommend for near frontal face detection. For scenarios with exceptionally large angle (head-pose) faces, occluded faces or wrong image orientation, the faces in such cases may not be detected. |\n | 'detection_02': | Detection model released in 2019 May with improved accuracy especially on small, side and blurry faces. |",
+ "description": "Add a face to a specified face list, up to 1,000 faces.\n To deal with an image contains multiple faces, input face can be specified as an image with a targetFace rectangle. It returns a persistedFaceId representing the added face. No image will be stored. Only the extracted face feature will be stored on server until [FaceList - Delete Face](https://docs.microsoft.com/rest/api/cognitiveservices/face/facelist/deleteface) or [FaceList - Delete](https://docs.microsoft.com/rest/api/cognitiveservices/face/facelist/delete) is called.\n Note persistedFaceId is different from faceId generated by [Face - Detect](https://docs.microsoft.com/rest/api/cognitiveservices/face/face/detectwithurl).\n* Higher face image quality means better detection and recognition precision. Please consider high-quality faces: frontal, clear, and face size is 200x200 pixels (100 pixels between eyes) or bigger.\n* JPEG, PNG, GIF (the first frame), and BMP format are supported. The allowed image file size is from 1KB to 6MB.\n* \"targetFace\" rectangle should contain one face. Zero or multiple faces will be regarded as an error. If the provided \"targetFace\" rectangle is not returned from [Face - Detect](https://docs.microsoft.com/rest/api/cognitiveservices/face/face/detectwithurl), there’s no guarantee to detect and add the face successfully.\n* Out of detectable face size (36x36 - 4096x4096 pixels), large head-pose, or large occlusions will cause failures.\n* Adding/deleting faces to/from a same face list are processed sequentially and to/from different face lists are in parallel.\n* The minimum detectable face size is 36x36 pixels in an image no larger than 1920x1080 pixels. Images with dimensions higher than 1920x1080 pixels will need a proportionally larger minimum face size.\n* Different 'detectionModel' values can be provided. To use and compare different detection models, please refer to [How to specify a detection model](https://docs.microsoft.com/azure/cognitive-services/face/face-api-how-to-topics/specify-detection-model)\n | Model | Recommended use-case(s) |\n | ---------- | -------- |\n | 'detection_01': | The default detection model for [FaceList - Add Face](https://docs.microsoft.com/rest/api/cognitiveservices/face/facelist/addfacefromurl). Recommend for near frontal face detection. For scenarios with exceptionally large angle (head-pose) faces, occluded faces or wrong image orientation, the faces in such cases may not be detected. |\n | 'detection_02': | Detection model released in 2019 May with improved accuracy especially on small, side and blurry faces. |",
"operationId": "FaceList_AddFaceFromUrl",
"parameters": [
{
@@ -1440,7 +1440,7 @@
},
"/largepersongroups/{largePersonGroupId}": {
"put": {
- "description": "Create a new large person group with user-specified largePersonGroupId, name, an optional userData and recognitionModel.\n A large person group is the container of the uploaded person data, including face recognition feature, and up to 1,000,000\npeople.\n After creation, use [LargePersonGroup Person - Create](/docs/services/563879b61984550e40cbbe8d/operations/599adcba3a7b9412a4d53f40) to add person into the group, and call [LargePersonGroup - Train](/docs/services/563879b61984550e40cbbe8d/operations/599ae2d16ac60f11b48b5aa4) to get this group ready for [Face - Identify](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395239).\n No image will be stored. Only the person's extracted face features and userData will be stored on server until [LargePersonGroup Person - Delete](/docs/services/563879b61984550e40cbbe8d/operations/599ade5c6ac60f11b48b5aa2) or [LargePersonGroup - Delete](/docs/services/563879b61984550e40cbbe8d/operations/599adc216ac60f11b48b5a9f) is called.\n 'recognitionModel' should be specified to associate with this large person group. The default value for 'recognitionModel' is 'recognition_01', if the latest model needed, please explicitly specify the model you need in this parameter. New faces that are added to an existing large person group will use the recognition model that's already associated with the collection. Existing face features in a large person group can't be updated to features extracted by another version of recognition model.\n* 'recognition_01': The default recognition model for [LargePersonGroup - Create](/docs/services/563879b61984550e40cbbe8d/operations/599acdee6ac60f11b48b5a9d). All those large person groups created before 2019 March are bonded with this recognition model.\n* 'recognition_02': Recognition model released in 2019 March. 'recognition_02' is recommended since its overall accuracy is improved compared with 'recognition_01'.\n\nLarge person group quota:\n* Free-tier subscription quota: 1,000 large person groups.\n* S0-tier subscription quota: 1,000,000 large person groups.",
+ "description": "Create a new large person group with user-specified largePersonGroupId, name, an optional userData and recognitionModel.\n A large person group is the container of the uploaded person data, including face recognition feature, and up to 1,000,000\npeople.\n After creation, use [LargePersonGroup Person - Create](https://docs.microsoft.com/rest/api/cognitiveservices/face/largepersongroupperson/create) to add person into the group, and call [LargePersonGroup - Train](https://docs.microsoft.com/rest/api/cognitiveservices/face/largepersongroup/train) to get this group ready for [Face - Identify](https://docs.microsoft.com/rest/api/cognitiveservices/face/face/identify).\n No image will be stored. Only the person's extracted face features and userData will be stored on server until [LargePersonGroup Person - Delete](https://docs.microsoft.com/rest/api/cognitiveservices/face/largepersongroupperson/delete) or [LargePersonGroup - Delete](https://docs.microsoft.com/rest/api/cognitiveservices/face/largepersongroup/delete) is called.\n 'recognitionModel' should be specified to associate with this large person group. The default value for 'recognitionModel' is 'recognition_01', if the latest model needed, please explicitly specify the model you need in this parameter. New faces that are added to an existing large person group will use the recognition model that's already associated with the collection. Existing face features in a large person group can't be updated to features extracted by another version of recognition model.\n* 'recognition_01': The default recognition model for [LargePersonGroup - Create](https://docs.microsoft.com/rest/api/cognitiveservices/face/largepersongroup/create). All those large person groups created before 2019 March are bonded with this recognition model.\n* 'recognition_02': Recognition model released in 2019 March. 'recognition_02' is recommended since its overall accuracy is improved compared with 'recognition_01'.\n\nLarge person group quota:\n* Free-tier subscription quota: 1,000 large person groups.\n* S0-tier subscription quota: 1,000,000 large person groups.",
"operationId": "LargePersonGroup_Create",
"parameters": [
{
@@ -1503,7 +1503,7 @@
}
},
"get": {
- "description": "Retrieve the information of a large person group, including its name, userData and recognitionModel. This API returns large person group information only, use [LargePersonGroup Person - List](/docs/services/563879b61984550e40cbbe8d/operations/599adda06ac60f11b48b5aa1) instead to retrieve person information under the large person group.\n",
+ "description": "Retrieve the information of a large person group, including its name, userData and recognitionModel. This API returns large person group information only, use [LargePersonGroup Person - List](https://docs.microsoft.com/rest/api/cognitiveservices/face/largepersongroupperson/list) instead to retrieve person information under the large person group.\n",
"operationId": "LargePersonGroup_Get",
"parameters": [
{
@@ -1691,7 +1691,7 @@
},
"/largepersongroups/{largePersonGroupId}/persons/{personId}/persistedfaces": {
"post": {
- "description": "Add a face to a person into a large person group for face identification or verification. To deal with an image contains multiple faces, input face can be specified as an image with a targetFace rectangle. It returns a persistedFaceId representing the added face. No image will be stored. Only the extracted face feature will be stored on server until [LargePersonGroup PersonFace - Delete](/docs/services/563879b61984550e40cbbe8d/operations/599ae2966ac60f11b48b5aa3), [LargePersonGroup Person - Delete](/docs/services/563879b61984550e40cbbe8d/operations/599ade5c6ac60f11b48b5aa2) or [LargePersonGroup - Delete](/docs/services/563879b61984550e40cbbe8d/operations/599adc216ac60f11b48b5a9f) is called.\n Note persistedFaceId is different from faceId generated by [Face - Detect](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395236).\n* Higher face image quality means better recognition precision. Please consider high-quality faces: frontal, clear, and face size is 200x200 pixels (100 pixels between eyes) or bigger.\n* Each person entry can hold up to 248 faces.\n* JPEG, PNG, GIF (the first frame), and BMP format are supported. The allowed image file size is from 1KB to 6MB.\n* \"targetFace\" rectangle should contain one face. Zero or multiple faces will be regarded as an error. If the provided \"targetFace\" rectangle is not returned from [Face - Detect](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395236), there’s no guarantee to detect and add the face successfully.\n* Out of detectable face size (36x36 - 4096x4096 pixels), large head-pose, or large occlusions will cause failures.\n* Adding/deleting faces to/from a same person will be processed sequentially. Adding/deleting faces to/from different persons are processed in parallel.\n* The minimum detectable face size is 36x36 pixels in an image no larger than 1920x1080 pixels. Images with dimensions higher than 1920x1080 pixels will need a proportionally larger minimum face size.\n* Different 'detectionModel' values can be provided. To use and compare different detection models, please refer to [How to specify a detection model](https://docs.microsoft.com/en-us/azure/cognitive-services/face/face-api-how-to-topics/specify-detection-model)\n | Model | Recommended use-case(s) |\n | ---------- | -------- |\n | 'detection_01': | The default detection model for [LargePersonGroup Person - Add Face](/docs/services/563879b61984550e40cbbe8d/operations/599adf2a3a7b9412a4d53f42). Recommend for near frontal face detection. For scenarios with exceptionally large angle (head-pose) faces, occluded faces or wrong image orientation, the faces in such cases may not be detected. |\n | 'detection_02': | Detection model released in 2019 May with improved accuracy especially on small, side and blurry faces. |",
+ "description": "Add a face to a person into a large person group for face identification or verification. To deal with an image contains multiple faces, input face can be specified as an image with a targetFace rectangle. It returns a persistedFaceId representing the added face. No image will be stored. Only the extracted face feature will be stored on server until [LargePersonGroup PersonFace - Delete](https://docs.microsoft.com/rest/api/cognitiveservices/face/largepersongroupperson/deleteface), [LargePersonGroup Person - Delete](https://docs.microsoft.com/rest/api/cognitiveservices/face/largepersongroupperson/delete) or [LargePersonGroup - Delete](https://docs.microsoft.com/rest/api/cognitiveservices/face/largepersongroup/delete) is called.\n Note persistedFaceId is different from faceId generated by [Face - Detect](https://docs.microsoft.com/rest/api/cognitiveservices/face/face/detectwithurl).\n* Higher face image quality means better recognition precision. Please consider high-quality faces: frontal, clear, and face size is 200x200 pixels (100 pixels between eyes) or bigger.\n* Each person entry can hold up to 248 faces.\n* JPEG, PNG, GIF (the first frame), and BMP format are supported. The allowed image file size is from 1KB to 6MB.\n* \"targetFace\" rectangle should contain one face. Zero or multiple faces will be regarded as an error. If the provided \"targetFace\" rectangle is not returned from [Face - Detect](https://docs.microsoft.com/rest/api/cognitiveservices/face/face/detectwithurl), there’s no guarantee to detect and add the face successfully.\n* Out of detectable face size (36x36 - 4096x4096 pixels), large head-pose, or large occlusions will cause failures.\n* Adding/deleting faces to/from a same person will be processed sequentially. Adding/deleting faces to/from different persons are processed in parallel.\n* The minimum detectable face size is 36x36 pixels in an image no larger than 1920x1080 pixels. Images with dimensions higher than 1920x1080 pixels will need a proportionally larger minimum face size.\n* Different 'detectionModel' values can be provided. To use and compare different detection models, please refer to [How to specify a detection model](https://docs.microsoft.com/azure/cognitive-services/face/face-api-how-to-topics/specify-detection-model)\n | Model | Recommended use-case(s) |\n | ---------- | -------- |\n | 'detection_01': | The default detection model for [LargePersonGroup Person - Add Face](https://docs.microsoft.com/rest/api/cognitiveservices/face/largepersongroupperson/addfacefromurl). Recommend for near frontal face detection. For scenarios with exceptionally large angle (head-pose) faces, occluded faces or wrong image orientation, the faces in such cases may not be detected. |\n | 'detection_02': | Detection model released in 2019 May with improved accuracy especially on small, side and blurry faces. |",
"operationId": "LargePersonGroupPerson_AddFaceFromUrl",
"parameters": [
{
@@ -1742,7 +1742,7 @@
},
"/largefacelists/{largeFaceListId}": {
"put": {
- "description": "Create an empty large face list with user-specified largeFaceListId, name, an optional userData and recognitionModel.\n Large face list is a list of faces, up to 1,000,000 faces, and used by [Face - Find Similar](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395237).\n After creation, user should use [LargeFaceList Face - Add](/docs/services/563879b61984550e40cbbe8d/operations/5a158c10d2de3616c086f2d3) to import the faces and [LargeFaceList - Train](/docs/services/563879b61984550e40cbbe8d/operations/5a158422d2de3616c086f2d1) to make it ready for [Face - Find Similar](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395237). No image will be stored. Only the extracted face features are stored on server until [LargeFaceList - Delete](/docs/services/563879b61984550e40cbbe8d/operations/5a1580d5d2de3616c086f2cd) is called.\n Find Similar is used for scenario like finding celebrity-like faces, similar face filtering, or as a light way face identification. But if the actual use is to identify person, please use [PersonGroup](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395244) / [LargePersonGroup](/docs/services/563879b61984550e40cbbe8d/operations/599acdee6ac60f11b48b5a9d) and [Face - Identify](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395239).\n 'recognitionModel' should be specified to associate with this large face list. The default value for 'recognitionModel' is 'recognition_01', if the latest model needed, please explicitly specify the model you need in this parameter. New faces that are added to an existing large face list will use the recognition model that's already associated with the collection. Existing face features in a large face list can't be updated to features extracted by another version of recognition model.\n* 'recognition_01': The default recognition model for [LargeFaceList- Create](/docs/services/563879b61984550e40cbbe8d/operations/5a157b68d2de3616c086f2cc). All those large face lists created before 2019 March are bonded with this recognition model.\n* 'recognition_02': Recognition model released in 2019 March. 'recognition_02' is recommended since its overall accuracy is improved compared with 'recognition_01'.\n\nLarge face list quota:\n* Free-tier subscription quota: 64 large face lists.\n* S0-tier subscription quota: 1,000,000 large face lists.",
+ "description": "Create an empty large face list with user-specified largeFaceListId, name, an optional userData and recognitionModel.\n Large face list is a list of faces, up to 1,000,000 faces, and used by [Face - Find Similar](https://docs.microsoft.com/rest/api/cognitiveservices/face/face/findsimilar).\n After creation, user should use [LargeFaceList Face - Add](https://docs.microsoft.com/rest/api/cognitiveservices/face/largefacelist/addfacefromurl) to import the faces and [LargeFaceList - Train](https://docs.microsoft.com/rest/api/cognitiveservices/face/largefacelist/train) to make it ready for [Face - Find Similar](https://docs.microsoft.com/rest/api/cognitiveservices/face/face/findsimilar). No image will be stored. Only the extracted face features are stored on server until [LargeFaceList - Delete](https://docs.microsoft.com/rest/api/cognitiveservices/face/largefacelist/delete) is called.\n Find Similar is used for scenario like finding celebrity-like faces, similar face filtering, or as a light way face identification. But if the actual use is to identify person, please use [PersonGroup](https://docs.microsoft.com/rest/api/cognitiveservices/face/persongroup) / [LargePersonGroup](https://docs.microsoft.com/rest/api/cognitiveservices/face/largepersongroup) and [Face - Identify](https://docs.microsoft.com/rest/api/cognitiveservices/face/face/identify).\n 'recognitionModel' should be specified to associate with this large face list. The default value for 'recognitionModel' is 'recognition_01', if the latest model needed, please explicitly specify the model you need in this parameter. New faces that are added to an existing large face list will use the recognition model that's already associated with the collection. Existing face features in a large face list can't be updated to features extracted by another version of recognition model.\n* 'recognition_01': The default recognition model for [LargeFaceList- Create](https://docs.microsoft.com/rest/api/cognitiveservices/face/largefacelist/create). All those large face lists created before 2019 March are bonded with this recognition model.\n* 'recognition_02': Recognition model released in 2019 March. 'recognition_02' is recommended since its overall accuracy is improved compared with 'recognition_01'.\n\nLarge face list quota:\n* Free-tier subscription quota: 64 large face lists.\n* S0-tier subscription quota: 1,000,000 large face lists.",
"operationId": "LargeFaceList_Create",
"parameters": [
{
@@ -1915,7 +1915,7 @@
},
"/largefacelists": {
"get": {
- "description": "List large face lists’ information of largeFaceListId, name, userData and recognitionModel. \nTo get face information inside largeFaceList use [LargeFaceList Face - Get](/docs/services/563879b61984550e40cbbe8d/operations/5a158cf2d2de3616c086f2d5) \n* Large face lists are stored in alphabetical order of largeFaceListId.\n* \"start\" parameter (string, optional) is a user-provided largeFaceListId value that returned entries have larger ids by string comparison. \"start\" set to empty to indicate return from the first item.\n* \"top\" parameter (int, optional) specifies the number of entries to return. A maximal of 1000 entries can be returned in one call. To fetch more, you can specify \"start\" with the last returned entry’s Id of the current call.\n \nFor example, total 5 large person lists: \"list1\", ..., \"list5\".\n \"start=&top=\" will return all 5 lists.\n \"start=&top=2\" will return \"list1\", \"list2\".\n \"start=list2&top=3\" will return \"list3\", \"list4\", \"list5\".\n",
+ "description": "List large face lists’ information of largeFaceListId, name, userData and recognitionModel. \nTo get face information inside largeFaceList use [LargeFaceList Face - Get](https://docs.microsoft.com/rest/api/cognitiveservices/face/largefacelist/getface) \n* Large face lists are stored in alphabetical order of largeFaceListId.\n* \"start\" parameter (string, optional) is a user-provided largeFaceListId value that returned entries have larger ids by string comparison. \"start\" set to empty to indicate return from the first item.\n* \"top\" parameter (int, optional) specifies the number of entries to return. A maximal of 1000 entries can be returned in one call. To fetch more, you can specify \"start\" with the last returned entry’s Id of the current call.\n \nFor example, total 5 large person lists: \"list1\", ..., \"list5\".\n \"start=&top=\" will return all 5 lists.\n \"start=&top=2\" will return \"list1\", \"list2\".\n \"start=list2&top=3\" will return \"list3\", \"list4\", \"list5\".\n",
"operationId": "LargeFaceList_List",
"parameters": [
{
@@ -2083,7 +2083,7 @@
},
"/largefacelists/{largeFaceListId}/persistedfaces": {
"post": {
- "description": "Add a face to a specified large face list, up to 1,000,000 faces.\n To deal with an image contains multiple faces, input face can be specified as an image with a targetFace rectangle. It returns a persistedFaceId representing the added face. No image will be stored. Only the extracted face feature will be stored on server until [LargeFaceList Face - Delete](/docs/services/563879b61984550e40cbbe8d/operations/5a158c8ad2de3616c086f2d4) or [LargeFaceList - Delete](/docs/services/563879b61984550e40cbbe8d/operations/5a1580d5d2de3616c086f2cd) is called.\n Note persistedFaceId is different from faceId generated by [Face - Detect](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395236).\n* Higher face image quality means better recognition precision. Please consider high-quality faces: frontal, clear, and face size is 200x200 pixels (100 pixels between eyes) or bigger.\n* JPEG, PNG, GIF (the first frame), and BMP format are supported. The allowed image file size is from 1KB to 6MB.\n* \"targetFace\" rectangle should contain one face. Zero or multiple faces will be regarded as an error. If the provided \"targetFace\" rectangle is not returned from [Face - Detect](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395236), there’s no guarantee to detect and add the face successfully.\n* Out of detectable face size (36x36 - 4096x4096 pixels), large head-pose, or large occlusions will cause failures.\n* Adding/deleting faces to/from a same face list are processed sequentially and to/from different face lists are in parallel.\n* The minimum detectable face size is 36x36 pixels in an image no larger than 1920x1080 pixels. Images with dimensions higher than 1920x1080 pixels will need a proportionally larger minimum face size.\n* Different 'detectionModel' values can be provided. To use and compare different detection models, please refer to [How to specify a detection model](https://docs.microsoft.com/en-us/azure/cognitive-services/face/face-api-how-to-topics/specify-detection-model)\n | Model | Recommended use-case(s) |\n | ---------- | -------- |\n | 'detection_01': | The default detection model for [LargeFaceList - Add Face](/docs/services/563879b61984550e40cbbe8d/operations/5a158c10d2de3616c086f2d3). Recommend for near frontal face detection. For scenarios with exceptionally large angle (head-pose) faces, occluded faces or wrong image orientation, the faces in such cases may not be detected. |\n | 'detection_02': | Detection model released in 2019 May with improved accuracy especially on small, side and blurry faces. |\n\nQuota:\n* Free-tier subscription quota: 1,000 faces per large face list.\n* S0-tier subscription quota: 1,000,000 faces per large face list.",
+ "description": "Add a face to a specified large face list, up to 1,000,000 faces.\n To deal with an image contains multiple faces, input face can be specified as an image with a targetFace rectangle. It returns a persistedFaceId representing the added face. No image will be stored. Only the extracted face feature will be stored on server until [LargeFaceList Face - Delete](https://docs.microsoft.com/rest/api/cognitiveservices/face/largefacelist/deleteface) or [LargeFaceList - Delete](https://docs.microsoft.com/rest/api/cognitiveservices/face/largefacelist/delete) is called.\n Note persistedFaceId is different from faceId generated by [Face - Detect](https://docs.microsoft.com/rest/api/cognitiveservices/face/face/detectwithurl).\n* Higher face image quality means better recognition precision. Please consider high-quality faces: frontal, clear, and face size is 200x200 pixels (100 pixels between eyes) or bigger.\n* JPEG, PNG, GIF (the first frame), and BMP format are supported. The allowed image file size is from 1KB to 6MB.\n* \"targetFace\" rectangle should contain one face. Zero or multiple faces will be regarded as an error. If the provided \"targetFace\" rectangle is not returned from [Face - Detect](https://docs.microsoft.com/rest/api/cognitiveservices/face/face/detectwithurl), there’s no guarantee to detect and add the face successfully.\n* Out of detectable face size (36x36 - 4096x4096 pixels), large head-pose, or large occlusions will cause failures.\n* Adding/deleting faces to/from a same face list are processed sequentially and to/from different face lists are in parallel.\n* The minimum detectable face size is 36x36 pixels in an image no larger than 1920x1080 pixels. Images with dimensions higher than 1920x1080 pixels will need a proportionally larger minimum face size.\n* Different 'detectionModel' values can be provided. To use and compare different detection models, please refer to [How to specify a detection model](https://docs.microsoft.com/azure/cognitive-services/face/face-api-how-to-topics/specify-detection-model)\n | Model | Recommended use-case(s) |\n | ---------- | -------- |\n | 'detection_01': | The default detection model for [LargeFaceList - Add Face](https://docs.microsoft.com/rest/api/cognitiveservices/face/largefacelist/addfacefromurl). Recommend for near frontal face detection. For scenarios with exceptionally large angle (head-pose) faces, occluded faces or wrong image orientation, the faces in such cases may not be detected. |\n | 'detection_02': | Detection model released in 2019 May with improved accuracy especially on small, side and blurry faces. |\n\nQuota:\n* Free-tier subscription quota: 1,000 faces per large face list.\n* S0-tier subscription quota: 1,000,000 faces per large face list.",
"operationId": "LargeFaceList_AddFaceFromUrl",
"parameters": [
{
@@ -2495,7 +2495,7 @@
},
"/detect?overload=stream": {
"post": {
- "description": "Detect human faces in an image, return face rectangles, and optionally with faceIds, landmarks, and attributes. \n* No image will be stored. Only the extracted face feature will be stored on server. The faceId is an identifier of the face feature and will be used in [Face - Identify](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395239), [Face - Verify](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f3039523a), and [Face - Find Similar](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395237). The stored face feature(s) will expire and be deleted 24 hours after the original detection call.\n* Optional parameters include faceId, landmarks, and attributes. Attributes include age, gender, headPose, smile, facialHair, glasses, emotion, hair, makeup, occlusion, accessories, blur, exposure and noise. Some of the results returned for specific attributes may not be highly accurate.\n* JPEG, PNG, GIF (the first frame), and BMP format are supported. The allowed image file size is from 1KB to 6MB.\n* Up to 100 faces can be returned for an image. Faces are ranked by face rectangle size from large to small.\n* For optimal results when querying [Face - Identify](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395239), [Face - Verify](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f3039523a), and [Face - Find Similar](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395237) ('returnFaceId' is true), please use faces that are: frontal, clear, and with a minimum size of 200x200 pixels (100 pixels between eyes).\n* The minimum detectable face size is 36x36 pixels in an image no larger than 1920x1080 pixels. Images with dimensions higher than 1920x1080 pixels will need a proportionally larger minimum face size.\n* Different 'detectionModel' values can be provided. To use and compare different detection models, please refer to [How to specify a detection model](https://docs.microsoft.com/en-us/azure/cognitive-services/face/face-api-how-to-topics/specify-detection-model)\n | Model | Recommended use-case(s) |\n | ---------- | -------- |\n | 'detection_01': | The default detection model for [Face - Detect](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395236). Recommend for near frontal face detection. For scenarios with exceptionally large angle (head-pose) faces, occluded faces or wrong image orientation, the faces in such cases may not be detected. |\n | 'detection_02': | Detection model released in 2019 May with improved accuracy especially on small, side and blurry faces. |\n\n* Different 'recognitionModel' values are provided. If follow-up operations like Verify, Identify, Find Similar are needed, please specify the recognition model with 'recognitionModel' parameter. The default value for 'recognitionModel' is 'recognition_01', if latest model needed, please explicitly specify the model you need in this parameter. Once specified, the detected faceIds will be associated with the specified recognition model. More details, please refer to [How to specify a recognition model](https://docs.microsoft.com/en-us/azure/cognitive-services/face/face-api-how-to-topics/specify-recognition-model)\n | Model | Recommended use-case(s) |\n | ---------- | -------- |\n | 'recognition_01': | The default recognition model for [Face - Detect](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395236). All those faceIds created before 2019 March are bonded with this recognition model. |\n | 'recognition_02': | Recognition model released in 2019 March. 'recognition_02' is recommended since its overall accuracy is improved compared with 'recognition_01'. |",
+ "description": "Detect human faces in an image, return face rectangles, and optionally with faceIds, landmarks, and attributes. \n* No image will be stored. Only the extracted face feature will be stored on server. The faceId is an identifier of the face feature and will be used in [Face - Identify](https://docs.microsoft.com/rest/api/cognitiveservices/face/face/identify), [Face - Verify](https://docs.microsoft.com/rest/api/cognitiveservices/face/face/verifyfacetoface), and [Face - Find Similar](https://docs.microsoft.com/rest/api/cognitiveservices/face/face/findsimilar). The stored face feature(s) will expire and be deleted 24 hours after the original detection call.\n* Optional parameters include faceId, landmarks, and attributes. Attributes include age, gender, headPose, smile, facialHair, glasses, emotion, hair, makeup, occlusion, accessories, blur, exposure and noise. Some of the results returned for specific attributes may not be highly accurate.\n* JPEG, PNG, GIF (the first frame), and BMP format are supported. The allowed image file size is from 1KB to 6MB.\n* Up to 100 faces can be returned for an image. Faces are ranked by face rectangle size from large to small.\n* For optimal results when querying [Face - Identify](https://docs.microsoft.com/rest/api/cognitiveservices/face/face/identify), [Face - Verify](https://docs.microsoft.com/rest/api/cognitiveservices/face/face/verifyfacetoface), and [Face - Find Similar](https://docs.microsoft.com/rest/api/cognitiveservices/face/face/findsimilar) ('returnFaceId' is true), please use faces that are: frontal, clear, and with a minimum size of 200x200 pixels (100 pixels between eyes).\n* The minimum detectable face size is 36x36 pixels in an image no larger than 1920x1080 pixels. Images with dimensions higher than 1920x1080 pixels will need a proportionally larger minimum face size.\n* Different 'detectionModel' values can be provided. To use and compare different detection models, please refer to [How to specify a detection model](https://docs.microsoft.com/azure/cognitive-services/face/face-api-how-to-topics/specify-detection-model)\n | Model | Recommended use-case(s) |\n | ---------- | -------- |\n | 'detection_01': | The default detection model for [Face - Detect](https://docs.microsoft.com/rest/api/cognitiveservices/face/face/detectwithurl). Recommend for near frontal face detection. For scenarios with exceptionally large angle (head-pose) faces, occluded faces or wrong image orientation, the faces in such cases may not be detected. |\n | 'detection_02': | Detection model released in 2019 May with improved accuracy especially on small, side and blurry faces. |\n\n* Different 'recognitionModel' values are provided. If follow-up operations like Verify, Identify, Find Similar are needed, please specify the recognition model with 'recognitionModel' parameter. The default value for 'recognitionModel' is 'recognition_01', if latest model needed, please explicitly specify the model you need in this parameter. Once specified, the detected faceIds will be associated with the specified recognition model. More details, please refer to [How to specify a recognition model](https://docs.microsoft.com/azure/cognitive-services/face/face-api-how-to-topics/specify-recognition-model)\n | Model | Recommended use-case(s) |\n | ---------- | -------- |\n | 'recognition_01': | The default recognition model for [Face - Detect](https://docs.microsoft.com/rest/api/cognitiveservices/face/face/detectwithurl). All those faceIds created before 2019 March are bonded with this recognition model. |\n | 'recognition_02': | Recognition model released in 2019 March. 'recognition_02' is recommended since its overall accuracy is improved compared with 'recognition_01'. |",
"operationId": "Face_DetectWithStream",
"parameters": [
{
@@ -2557,7 +2557,7 @@
},
"/persongroups/{personGroupId}/persons/{personId}/persistedfaces?overload=stream": {
"post": {
- "description": "Add a face to a person into a person group for face identification or verification. To deal with an image contains multiple faces, input face can be specified as an image with a targetFace rectangle. It returns a persistedFaceId representing the added face. No image will be stored. Only the extracted face feature will be stored on server until [PersonGroup PersonFace - Delete](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f3039523e), [PersonGroup Person - Delete](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f3039523d) or [PersonGroup - Delete](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395245) is called.\n Note persistedFaceId is different from faceId generated by [Face - Detect](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395236).\n* Higher face image quality means better recognition precision. Please consider high-quality faces: frontal, clear, and face size is 200x200 pixels (100 pixels between eyes) or bigger.\n* Each person entry can hold up to 248 faces.\n* JPEG, PNG, GIF (the first frame), and BMP format are supported. The allowed image file size is from 1KB to 6MB.\n* \"targetFace\" rectangle should contain one face. Zero or multiple faces will be regarded as an error. If the provided \"targetFace\" rectangle is not returned from [Face - Detect](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395236), there’s no guarantee to detect and add the face successfully.\n* Out of detectable face size (36x36 - 4096x4096 pixels), large head-pose, or large occlusions will cause failures.\n* Adding/deleting faces to/from a same person will be processed sequentially. Adding/deleting faces to/from different persons are processed in parallel.\n* The minimum detectable face size is 36x36 pixels in an image no larger than 1920x1080 pixels. Images with dimensions higher than 1920x1080 pixels will need a proportionally larger minimum face size.\n* Different 'detectionModel' values can be provided. To use and compare different detection models, please refer to [How to specify a detection model](https://docs.microsoft.com/en-us/azure/cognitive-services/face/face-api-how-to-topics/specify-detection-model)\n | Model | Recommended use-case(s) |\n | ---------- | -------- |\n | 'detection_01': | The default detection model for [PersonGroup Person - Add Face](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f3039523b). Recommend for near frontal face detection. For scenarios with exceptionally large angle (head-pose) faces, occluded faces or wrong image orientation, the faces in such cases may not be detected. |\n | 'detection_02': | Detection model released in 2019 May with improved accuracy especially on small, side and blurry faces. |",
+ "description": "Add a face to a person into a person group for face identification or verification. To deal with an image contains multiple faces, input face can be specified as an image with a targetFace rectangle. It returns a persistedFaceId representing the added face. No image will be stored. Only the extracted face feature will be stored on server until [PersonGroup PersonFace - Delete](https://docs.microsoft.com/rest/api/cognitiveservices/face/persongroupperson/deleteface), [PersonGroup Person - Delete](https://docs.microsoft.com/rest/api/cognitiveservices/face/persongroupperson/delete) or [PersonGroup - Delete](https://docs.microsoft.com/rest/api/cognitiveservices/face/persongroup/delete) is called.\n Note persistedFaceId is different from faceId generated by [Face - Detect](https://docs.microsoft.com/rest/api/cognitiveservices/face/face/detectwithurl).\n* Higher face image quality means better recognition precision. Please consider high-quality faces: frontal, clear, and face size is 200x200 pixels (100 pixels between eyes) or bigger.\n* Each person entry can hold up to 248 faces.\n* JPEG, PNG, GIF (the first frame), and BMP format are supported. The allowed image file size is from 1KB to 6MB.\n* \"targetFace\" rectangle should contain one face. Zero or multiple faces will be regarded as an error. If the provided \"targetFace\" rectangle is not returned from [Face - Detect](https://docs.microsoft.com/rest/api/cognitiveservices/face/face/detectwithurl), there’s no guarantee to detect and add the face successfully.\n* Out of detectable face size (36x36 - 4096x4096 pixels), large head-pose, or large occlusions will cause failures.\n* Adding/deleting faces to/from a same person will be processed sequentially. Adding/deleting faces to/from different persons are processed in parallel.\n* The minimum detectable face size is 36x36 pixels in an image no larger than 1920x1080 pixels. Images with dimensions higher than 1920x1080 pixels will need a proportionally larger minimum face size.\n* Different 'detectionModel' values can be provided. To use and compare different detection models, please refer to [How to specify a detection model](https://docs.microsoft.com/azure/cognitive-services/face/face-api-how-to-topics/specify-detection-model)\n | Model | Recommended use-case(s) |\n | ---------- | -------- |\n | 'detection_01': | The default detection model for [PersonGroup Person - Add Face](https://docs.microsoft.com/rest/api/cognitiveservices/face/persongroupperson/addfacefromurl). Recommend for near frontal face detection. For scenarios with exceptionally large angle (head-pose) faces, occluded faces or wrong image orientation, the faces in such cases may not be detected. |\n | 'detection_02': | Detection model released in 2019 May with improved accuracy especially on small, side and blurry faces. |",
"operationId": "PersonGroupPerson_AddFaceFromStream",
"parameters": [
{
@@ -2608,7 +2608,7 @@
},
"/facelists/{faceListId}/persistedfaces?overload=stream": {
"post": {
- "description": "Add a face to a specified face list, up to 1,000 faces.\n To deal with an image contains multiple faces, input face can be specified as an image with a targetFace rectangle. It returns a persistedFaceId representing the added face. No image will be stored. Only the extracted face feature will be stored on server until [FaceList - Delete Face](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395251) or [FaceList - Delete](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f3039524f) is called.\n Note persistedFaceId is different from faceId generated by [Face - Detect](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395236).\n* Higher face image quality means better detection and recognition precision. Please consider high-quality faces: frontal, clear, and face size is 200x200 pixels (100 pixels between eyes) or bigger.\n* JPEG, PNG, GIF (the first frame), and BMP format are supported. The allowed image file size is from 1KB to 6MB.\n* \"targetFace\" rectangle should contain one face. Zero or multiple faces will be regarded as an error. If the provided \"targetFace\" rectangle is not returned from [Face - Detect](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395236), there’s no guarantee to detect and add the face successfully.\n* Out of detectable face size (36x36 - 4096x4096 pixels), large head-pose, or large occlusions will cause failures.\n* Adding/deleting faces to/from a same face list are processed sequentially and to/from different face lists are in parallel.\n* The minimum detectable face size is 36x36 pixels in an image no larger than 1920x1080 pixels. Images with dimensions higher than 1920x1080 pixels will need a proportionally larger minimum face size.\n* Different 'detectionModel' values can be provided. To use and compare different detection models, please refer to [How to specify a detection model](https://docs.microsoft.com/en-us/azure/cognitive-services/face/face-api-how-to-topics/specify-detection-model)\n | Model | Recommended use-case(s) |\n | ---------- | -------- |\n | 'detection_01': | The default detection model for [FaceList - Add Face](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395250). Recommend for near frontal face detection. For scenarios with exceptionally large angle (head-pose) faces, occluded faces or wrong image orientation, the faces in such cases may not be detected. |\n | 'detection_02': | Detection model released in 2019 May with improved accuracy especially on small, side and blurry faces. |",
+ "description": "Add a face to a specified face list, up to 1,000 faces.\n To deal with an image contains multiple faces, input face can be specified as an image with a targetFace rectangle. It returns a persistedFaceId representing the added face. No image will be stored. Only the extracted face feature will be stored on server until [FaceList - Delete Face](https://docs.microsoft.com/rest/api/cognitiveservices/face/facelist/deleteface) or [FaceList - Delete](https://docs.microsoft.com/rest/api/cognitiveservices/face/facelist/delete) is called.\n Note persistedFaceId is different from faceId generated by [Face - Detect](https://docs.microsoft.com/rest/api/cognitiveservices/face/face/detectwithurl).\n* Higher face image quality means better detection and recognition precision. Please consider high-quality faces: frontal, clear, and face size is 200x200 pixels (100 pixels between eyes) or bigger.\n* JPEG, PNG, GIF (the first frame), and BMP format are supported. The allowed image file size is from 1KB to 6MB.\n* \"targetFace\" rectangle should contain one face. Zero or multiple faces will be regarded as an error. If the provided \"targetFace\" rectangle is not returned from [Face - Detect](https://docs.microsoft.com/rest/api/cognitiveservices/face/face/detectwithurl), there’s no guarantee to detect and add the face successfully.\n* Out of detectable face size (36x36 - 4096x4096 pixels), large head-pose, or large occlusions will cause failures.\n* Adding/deleting faces to/from a same face list are processed sequentially and to/from different face lists are in parallel.\n* The minimum detectable face size is 36x36 pixels in an image no larger than 1920x1080 pixels. Images with dimensions higher than 1920x1080 pixels will need a proportionally larger minimum face size.\n* Different 'detectionModel' values can be provided. To use and compare different detection models, please refer to [How to specify a detection model](https://docs.microsoft.com/azure/cognitive-services/face/face-api-how-to-topics/specify-detection-model)\n | Model | Recommended use-case(s) |\n | ---------- | -------- |\n | 'detection_01': | The default detection model for [FaceList - Add Face](https://docs.microsoft.com/rest/api/cognitiveservices/face/facelist/addfacefromurl). Recommend for near frontal face detection. For scenarios with exceptionally large angle (head-pose) faces, occluded faces or wrong image orientation, the faces in such cases may not be detected. |\n | 'detection_02': | Detection model released in 2019 May with improved accuracy especially on small, side and blurry faces. |",
"operationId": "FaceList_AddFaceFromStream",
"parameters": [
{
@@ -2656,7 +2656,7 @@
},
"/largepersongroups/{largePersonGroupId}/persons/{personId}/persistedfaces?overload=stream": {
"post": {
- "description": "Add a face to a person into a large person group for face identification or verification. To deal with an image contains multiple faces, input face can be specified as an image with a targetFace rectangle. It returns a persistedFaceId representing the added face. No image will be stored. Only the extracted face feature will be stored on server until [LargePersonGroup PersonFace - Delete](/docs/services/563879b61984550e40cbbe8d/operations/599ae2966ac60f11b48b5aa3), [LargePersonGroup Person - Delete](/docs/services/563879b61984550e40cbbe8d/operations/599ade5c6ac60f11b48b5aa2) or [LargePersonGroup - Delete](/docs/services/563879b61984550e40cbbe8d/operations/599adc216ac60f11b48b5a9f) is called.\n Note persistedFaceId is different from faceId generated by [Face - Detect](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395236).\n* Higher face image quality means better recognition precision. Please consider high-quality faces: frontal, clear, and face size is 200x200 pixels (100 pixels between eyes) or bigger.\n* Each person entry can hold up to 248 faces.\n* JPEG, PNG, GIF (the first frame), and BMP format are supported. The allowed image file size is from 1KB to 6MB.\n* \"targetFace\" rectangle should contain one face. Zero or multiple faces will be regarded as an error. If the provided \"targetFace\" rectangle is not returned from [Face - Detect](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395236), there’s no guarantee to detect and add the face successfully.\n* Out of detectable face size (36x36 - 4096x4096 pixels), large head-pose, or large occlusions will cause failures.\n* Adding/deleting faces to/from a same person will be processed sequentially. Adding/deleting faces to/from different persons are processed in parallel.\n* The minimum detectable face size is 36x36 pixels in an image no larger than 1920x1080 pixels. Images with dimensions higher than 1920x1080 pixels will need a proportionally larger minimum face size.\n* Different 'detectionModel' values can be provided. To use and compare different detection models, please refer to [How to specify a detection model](https://docs.microsoft.com/en-us/azure/cognitive-services/face/face-api-how-to-topics/specify-detection-model)\n | Model | Recommended use-case(s) |\n | ---------- | -------- |\n | 'detection_01': | The default detection model for [LargePersonGroup Person - Add Face](/docs/services/563879b61984550e40cbbe8d/operations/599adf2a3a7b9412a4d53f42). Recommend for near frontal face detection. For scenarios with exceptionally large angle (head-pose) faces, occluded faces or wrong image orientation, the faces in such cases may not be detected. |\n | 'detection_02': | Detection model released in 2019 May with improved accuracy especially on small, side and blurry faces. |",
+ "description": "Add a face to a person into a large person group for face identification or verification. To deal with an image contains multiple faces, input face can be specified as an image with a targetFace rectangle. It returns a persistedFaceId representing the added face. No image will be stored. Only the extracted face feature will be stored on server until [LargePersonGroup PersonFace - Delete](https://docs.microsoft.com/rest/api/cognitiveservices/face/largepersongroupperson/deleteface), [LargePersonGroup Person - Delete](https://docs.microsoft.com/rest/api/cognitiveservices/face/largepersongroupperson/delete) or [LargePersonGroup - Delete](https://docs.microsoft.com/rest/api/cognitiveservices/face/largepersongroup/delete) is called.\n Note persistedFaceId is different from faceId generated by [Face - Detect](https://docs.microsoft.com/rest/api/cognitiveservices/face/face/detectwithurl).\n* Higher face image quality means better recognition precision. Please consider high-quality faces: frontal, clear, and face size is 200x200 pixels (100 pixels between eyes) or bigger.\n* Each person entry can hold up to 248 faces.\n* JPEG, PNG, GIF (the first frame), and BMP format are supported. The allowed image file size is from 1KB to 6MB.\n* \"targetFace\" rectangle should contain one face. Zero or multiple faces will be regarded as an error. If the provided \"targetFace\" rectangle is not returned from [Face - Detect](https://docs.microsoft.com/rest/api/cognitiveservices/face/face/detectwithurl), there’s no guarantee to detect and add the face successfully.\n* Out of detectable face size (36x36 - 4096x4096 pixels), large head-pose, or large occlusions will cause failures.\n* Adding/deleting faces to/from a same person will be processed sequentially. Adding/deleting faces to/from different persons are processed in parallel.\n* The minimum detectable face size is 36x36 pixels in an image no larger than 1920x1080 pixels. Images with dimensions higher than 1920x1080 pixels will need a proportionally larger minimum face size.\n* Different 'detectionModel' values can be provided. To use and compare different detection models, please refer to [How to specify a detection model](https://docs.microsoft.com/azure/cognitive-services/face/face-api-how-to-topics/specify-detection-model)\n | Model | Recommended use-case(s) |\n | ---------- | -------- |\n | 'detection_01': | The default detection model for [LargePersonGroup Person - Add Face](https://docs.microsoft.com/rest/api/cognitiveservices/face/largepersongroupperson/addfacefromurl). Recommend for near frontal face detection. For scenarios with exceptionally large angle (head-pose) faces, occluded faces or wrong image orientation, the faces in such cases may not be detected. |\n | 'detection_02': | Detection model released in 2019 May with improved accuracy especially on small, side and blurry faces. |",
"operationId": "LargePersonGroupPerson_AddFaceFromStream",
"parameters": [
{
@@ -2707,7 +2707,7 @@
},
"/largefacelists/{largeFaceListId}/persistedfaces?overload=stream": {
"post": {
- "description": "Add a face to a specified large face list, up to 1,000,000 faces.\n To deal with an image contains multiple faces, input face can be specified as an image with a targetFace rectangle. It returns a persistedFaceId representing the added face. No image will be stored. Only the extracted face feature will be stored on server until [LargeFaceList Face - Delete](/docs/services/563879b61984550e40cbbe8d/operations/5a158c8ad2de3616c086f2d4) or [LargeFaceList - Delete](/docs/services/563879b61984550e40cbbe8d/operations/5a1580d5d2de3616c086f2cd) is called.\n Note persistedFaceId is different from faceId generated by [Face - Detect](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395236).\n* Higher face image quality means better recognition precision. Please consider high-quality faces: frontal, clear, and face size is 200x200 pixels (100 pixels between eyes) or bigger.\n* JPEG, PNG, GIF (the first frame), and BMP format are supported. The allowed image file size is from 1KB to 6MB.\n* \"targetFace\" rectangle should contain one face. Zero or multiple faces will be regarded as an error. If the provided \"targetFace\" rectangle is not returned from [Face - Detect](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395236), there’s no guarantee to detect and add the face successfully.\n* Out of detectable face size (36x36 - 4096x4096 pixels), large head-pose, or large occlusions will cause failures.\n* Adding/deleting faces to/from a same face list are processed sequentially and to/from different face lists are in parallel.\n* The minimum detectable face size is 36x36 pixels in an image no larger than 1920x1080 pixels. Images with dimensions higher than 1920x1080 pixels will need a proportionally larger minimum face size.\n* Different 'detectionModel' values can be provided. To use and compare different detection models, please refer to [How to specify a detection model](https://docs.microsoft.com/en-us/azure/cognitive-services/face/face-api-how-to-topics/specify-detection-model)\n | Model | Recommended use-case(s) |\n | ---------- | -------- |\n | 'detection_01': | The default detection model for [LargeFaceList - Add Face](/docs/services/563879b61984550e40cbbe8d/operations/5a158c10d2de3616c086f2d3). Recommend for near frontal face detection. For scenarios with exceptionally large angle (head-pose) faces, occluded faces or wrong image orientation, the faces in such cases may not be detected. |\n | 'detection_02': | Detection model released in 2019 May with improved accuracy especially on small, side and blurry faces. |\n\nQuota:\n* Free-tier subscription quota: 1,000 faces per large face list.\n* S0-tier subscription quota: 1,000,000 faces per large face list.",
+ "description": "Add a face to a specified large face list, up to 1,000,000 faces.\n To deal with an image contains multiple faces, input face can be specified as an image with a targetFace rectangle. It returns a persistedFaceId representing the added face. No image will be stored. Only the extracted face feature will be stored on server until [LargeFaceList Face - Delete](https://docs.microsoft.com/rest/api/cognitiveservices/face/largefacelist/deleteface) or [LargeFaceList - Delete](https://docs.microsoft.com/rest/api/cognitiveservices/face/largefacelist/delete) is called.\n Note persistedFaceId is different from faceId generated by [Face - Detect](https://docs.microsoft.com/rest/api/cognitiveservices/face/face/detectwithurl).\n* Higher face image quality means better recognition precision. Please consider high-quality faces: frontal, clear, and face size is 200x200 pixels (100 pixels between eyes) or bigger.\n* JPEG, PNG, GIF (the first frame), and BMP format are supported. The allowed image file size is from 1KB to 6MB.\n* \"targetFace\" rectangle should contain one face. Zero or multiple faces will be regarded as an error. If the provided \"targetFace\" rectangle is not returned from [Face - Detect](https://docs.microsoft.com/rest/api/cognitiveservices/face/face/detectwithurl), there’s no guarantee to detect and add the face successfully.\n* Out of detectable face size (36x36 - 4096x4096 pixels), large head-pose, or large occlusions will cause failures.\n* Adding/deleting faces to/from a same face list are processed sequentially and to/from different face lists are in parallel.\n* The minimum detectable face size is 36x36 pixels in an image no larger than 1920x1080 pixels. Images with dimensions higher than 1920x1080 pixels will need a proportionally larger minimum face size.\n* Different 'detectionModel' values can be provided. To use and compare different detection models, please refer to [How to specify a detection model](https://docs.microsoft.com/azure/cognitive-services/face/face-api-how-to-topics/specify-detection-model)\n | Model | Recommended use-case(s) |\n | ---------- | -------- |\n | 'detection_01': | The default detection model for [LargeFaceList - Add Face](https://docs.microsoft.com/rest/api/cognitiveservices/face/largefacelist/addfacefromurl). Recommend for near frontal face detection. For scenarios with exceptionally large angle (head-pose) faces, occluded faces or wrong image orientation, the faces in such cases may not be detected. |\n | 'detection_02': | Detection model released in 2019 May with improved accuracy especially on small, side and blurry faces. |\n\nQuota:\n* Free-tier subscription quota: 1,000 faces per large face list.\n* S0-tier subscription quota: 1,000,000 faces per large face list.",
"operationId": "LargeFaceList_AddFaceFromStream",
"parameters": [
{
diff --git a/specification/cognitiveservices/data-plane/Face/stable/v1.0/examples/AddFaceListFaceFromUrl.json b/specification/cognitiveservices/data-plane/Face/stable/v1.0/examples/AddFaceListFaceFromUrl.json
index 5cf854fce2cd..e54883e45ff6 100644
--- a/specification/cognitiveservices/data-plane/Face/stable/v1.0/examples/AddFaceListFaceFromUrl.json
+++ b/specification/cognitiveservices/data-plane/Face/stable/v1.0/examples/AddFaceListFaceFromUrl.json
@@ -11,7 +11,9 @@
100,
100
],
- "ImageUrl": "{Image url}",
+ "ImageUrl": {
+ "url": "{Image Url here}"
+ },
"detectionModel": "detection_01"
},
"responses": {
diff --git a/specification/cognitiveservices/data-plane/Face/stable/v1.0/examples/AddLargeFaceListFaceFromUrl.json b/specification/cognitiveservices/data-plane/Face/stable/v1.0/examples/AddLargeFaceListFaceFromUrl.json
index 03b6f1a74f25..cfc48557fa4f 100644
--- a/specification/cognitiveservices/data-plane/Face/stable/v1.0/examples/AddLargeFaceListFaceFromUrl.json
+++ b/specification/cognitiveservices/data-plane/Face/stable/v1.0/examples/AddLargeFaceListFaceFromUrl.json
@@ -11,7 +11,9 @@
100,
100
],
- "ImageUrl": "{Image url}",
+ "ImageUrl": {
+ "url": "{Image Url here}"
+ },
"detectionModel": "detection_01"
},
"responses": {
diff --git a/specification/cognitiveservices/data-plane/Face/stable/v1.0/examples/AddLargePersonGroupPersonFaceFromUrl.json b/specification/cognitiveservices/data-plane/Face/stable/v1.0/examples/AddLargePersonGroupPersonFaceFromUrl.json
index 70a604209ef7..b8a1e3fc5d82 100644
--- a/specification/cognitiveservices/data-plane/Face/stable/v1.0/examples/AddLargePersonGroupPersonFaceFromUrl.json
+++ b/specification/cognitiveservices/data-plane/Face/stable/v1.0/examples/AddLargePersonGroupPersonFaceFromUrl.json
@@ -12,7 +12,9 @@
100,
100
],
- "ImageUrl": "{Image url}",
+ "ImageUrl": {
+ "url": "{Image Url here}"
+ },
"detectionModel": "detection_01"
},
"responses": {
diff --git a/specification/cognitiveservices/data-plane/Face/stable/v1.0/examples/AddPersonGroupPersonFaceFromUrl.json b/specification/cognitiveservices/data-plane/Face/stable/v1.0/examples/AddPersonGroupPersonFaceFromUrl.json
index 99c2af7df29d..a5e102adc5cb 100644
--- a/specification/cognitiveservices/data-plane/Face/stable/v1.0/examples/AddPersonGroupPersonFaceFromUrl.json
+++ b/specification/cognitiveservices/data-plane/Face/stable/v1.0/examples/AddPersonGroupPersonFaceFromUrl.json
@@ -12,7 +12,9 @@
100,
100
],
- "ImageUrl": "{Image url}",
+ "ImageUrl": {
+ "url": "{Image Url here}"
+ },
"detectionModel": "detection_01"
},
"responses": {
diff --git a/specification/cognitiveservices/data-plane/Face/stable/v1.0/examples/DetectWithUrl.json b/specification/cognitiveservices/data-plane/Face/stable/v1.0/examples/DetectWithUrl.json
index 3242cb9a4b7f..693778906f3c 100644
--- a/specification/cognitiveservices/data-plane/Face/stable/v1.0/examples/DetectWithUrl.json
+++ b/specification/cognitiveservices/data-plane/Face/stable/v1.0/examples/DetectWithUrl.json
@@ -19,7 +19,9 @@
"exposure",
"noise"
],
- "ImageUrl": "{Image Url here}",
+ "ImageUrl": {
+ "url": "{Image Url here}"
+ },
"recognitionModel": "recognition_01",
"returnRecognitionModel": true,
"detectionModel": "detection_01"
diff --git a/specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.0/FormRecognizer.json b/specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.0/FormRecognizer.json
index a31432b94f34..b52f177eb964 100644
--- a/specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.0/FormRecognizer.json
+++ b/specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.0/FormRecognizer.json
@@ -273,6 +273,149 @@
}
}
},
+ "/custom/models/{modelId}/copy": {
+ "post": {
+ "summary": "Copy Custom Model",
+ "description": "Copy custom model stored in this resource (the source) to user specified target Form Recognizer resource.",
+ "operationId": "CopyCustomModel",
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "name": "modelId",
+ "in": "path",
+ "description": "Model identifier.",
+ "required": true,
+ "type": "string",
+ "format": "uuid"
+ },
+ {
+ "name": "copyRequest",
+ "in": "body",
+ "description": "Copy request parameters.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/CopyRequest"
+ }
+ }
+ ],
+ "responses": {
+ "202": {
+ "description": "Copy request is queued successfully.",
+ "headers": {
+ "Operation-Location": {
+ "type": "string",
+ "description": "URL containing the resultId used to track the progress and obtain the result of the copy operation."
+ }
+ }
+ },
+ "default": {
+ "description": "Response entity accompanying non-successful responses containing additional details about the error.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Copy custom model": {
+ "$ref": "./examples/CopyModel.json"
+ }
+ },
+ "x-ms-long-running-operation": true
+ }
+ },
+ "/custom/models/{modelId}/copyResults/{resultId}": {
+ "get": {
+ "summary": "Get Custom Model Copy Result",
+ "description": "Obtain current status and the result of a custom model copy operation.",
+ "operationId": "GetCustomModelCopyResult",
+ "consumes": [],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "name": "modelId",
+ "in": "path",
+ "description": "Model identifier.",
+ "required": true,
+ "type": "string",
+ "format": "uuid"
+ },
+ {
+ "name": "resultId",
+ "in": "path",
+ "description": "Copy operation result identifier.",
+ "required": true,
+ "type": "string",
+ "format": "uuid"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "schema": {
+ "$ref": "#/definitions/CopyOperationResult"
+ }
+ },
+ "default": {
+ "description": "Response entity accompanying non-successful responses containing additional details about the error.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Get copy custom model result": {
+ "$ref": "./examples/CopyOperationResult.json"
+ },
+ "Get copy custom model result with failures": {
+ "$ref": "./examples/CopyOperationResultWithErrors.json"
+ }
+ }
+ }
+ },
+ "/custom/models/copyAuthorization": {
+ "post": {
+ "summary": "Generate Copy Authorization",
+ "description": "Generate authorization to copy a model into the target Form Recognizer resource.",
+ "operationId": "GenerateModelCopyAuthorization",
+ "consumes": [],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [],
+ "responses": {
+ "201": {
+ "description": "Copy request is authorized successfully.",
+ "headers": {
+ "Location": {
+ "type": "string",
+ "description": "Location and ID of the model being copied. The status of model copy is specified in the status property at the model location."
+ }
+ },
+ "schema": {
+ "$ref": "#/definitions/CopyAuthorizationResult"
+ }
+ },
+ "default": {
+ "description": "Response entity accompanying non-successful responses containing additional details about the error.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Copy custom model": {
+ "$ref": "./examples/CopyModelAuthorization.json"
+ }
+ }
+ }
+ },
"/prebuilt/receipt/analyze": {
"post": {
"summary": "Analyze Receipt",
@@ -559,6 +702,111 @@
},
"x-nullable": false
},
+ "CopyAuthorizationResult": {
+ "description": "Request parameter that contains authorization claims for copy operation.",
+ "required": [
+ "modelId",
+ "accessToken",
+ "expirationDateTimeTicks"
+ ],
+ "type": "object",
+ "properties": {
+ "modelId": {
+ "description": "Model identifier.",
+ "type": "string"
+ },
+ "accessToken": {
+ "description": "Token claim used to authorize the request.",
+ "type": "string"
+ },
+ "expirationDateTimeTicks": {
+ "description": "The time when the access token expires. The date is represented as the number of seconds from 1970-01-01T0:0:0Z UTC until the expiration time.",
+ "type": "integer",
+ "format": "int64"
+ }
+ }
+ },
+ "CopyRequest": {
+ "description": "Request parameter to copy an existing custom model from the source resource to a target resource referenced by the resource ID.",
+ "required": [
+ "targetResourceId",
+ "targetResourceRegion",
+ "copyAuthorization"
+ ],
+ "type": "object",
+ "properties": {
+ "targetResourceId": {
+ "description": "Azure Resource Id of the target Form Recognizer resource where the model is copied to.",
+ "maxLength": 1024,
+ "type": "string",
+ "pattern": "^/subscriptions/[^/]*/resourceGroups/[^/]*/providers/Microsoft.CognitiveServices/accounts/[^/]*$",
+ "x-ms-azure-resource": true
+ },
+ "targetResourceRegion": {
+ "description": "Location of the target Azure resource. A valid Azure region name supported by Cognitive Services.",
+ "type": "string",
+ "pattern": "^[a-z0-9]+$",
+ "minLength": 1,
+ "maxLength": 24
+ },
+ "copyAuthorization": {
+ "description": "Entity that encodes claims to authorize the copy request.",
+ "$ref": "#/definitions/CopyAuthorizationResult"
+ }
+ }
+ },
+ "CopyOperationResult": {
+ "description": "Status and result of the queued copy operation.",
+ "type": "object",
+ "required": [
+ "status",
+ "createdDateTime",
+ "lastUpdatedDateTime"
+ ],
+ "properties": {
+ "status": {
+ "description": "Operation status.",
+ "$ref": "#/definitions/OperationStatus"
+ },
+ "createdDateTime": {
+ "format": "date-time",
+ "description": "Date and time (UTC) when the copy operation was submitted.",
+ "type": "string",
+ "x-nullable": false
+ },
+ "lastUpdatedDateTime": {
+ "format": "date-time",
+ "description": "Date and time (UTC) when the status was last updated.",
+ "type": "string",
+ "x-nullable": false
+ },
+ "copyResult": {
+ "description": "Results of the copy operation.",
+ "$ref": "#/definitions/CopyResult"
+ }
+ }
+ },
+ "CopyResult": {
+ "description": "Custom model copy result.",
+ "type": "object",
+ "required": [
+ "modelId"
+ ],
+ "properties": {
+ "modelId": {
+ "description": "Identifier of the target model.",
+ "type": "string",
+ "format": "uuid"
+ },
+ "errors": {
+ "description": "Errors returned during the copy operation.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ErrorInformation"
+ }
+ }
+ }
+ },
"AnalyzeOperationResult": {
"description": "Status and result of the queued analyze operation.",
"type": "object",
diff --git a/specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.0/examples/CopyModel.json b/specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.0/examples/CopyModel.json
new file mode 100644
index 000000000000..52ffef3e3811
--- /dev/null
+++ b/specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.0/examples/CopyModel.json
@@ -0,0 +1,25 @@
+{
+ "parameters": {
+ "endpoint": "{endpoint}",
+ "Content-Type": "application/json",
+ "Ocp-Apim-Subscription-Key": "{API key}",
+ "modelId": "{modelId}",
+ "body": {},
+ "copyRequest": {
+ "targetResourceId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{resourceName}",
+ "targetResourceRegion": "westus2",
+ "copyAuthorization": {
+ "modelId": "{modelId}",
+ "accessToken": "{accessToken}",
+ "expirationDateTimeTicks": 637190189980000000
+ }
+ }
+ },
+ "responses": {
+ "202": {
+ "headers": {
+ "Operation-Location": "{endpoint}/formrecognizer/v2.0-preview/custom/models/{modelId}/copyResults/{resultId}"
+ }
+ }
+ }
+}
diff --git a/specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.0/examples/CopyModelAuthorization.json b/specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.0/examples/CopyModelAuthorization.json
new file mode 100644
index 000000000000..967237ea3a1c
--- /dev/null
+++ b/specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.0/examples/CopyModelAuthorization.json
@@ -0,0 +1,20 @@
+{
+ "parameters": {
+ "endpoint": "{endpoint}",
+ "Content-Type": "application/json",
+ "Ocp-Apim-Subscription-Key": "{API key}",
+ "body": {}
+ },
+ "responses": {
+ "201": {
+ "headers": {
+ "Location": "{endpoint}/formrecognizer/v2.0-preview/custom/models/{modelId}"
+ },
+ "body": {
+ "modelId": "{modelId}",
+ "accessToken": "{accessToken}",
+ "expirationDateTimeTicks": 637190189980000000
+ }
+ }
+ }
+}
diff --git a/specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.0/examples/CopyOperationResult.json b/specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.0/examples/CopyOperationResult.json
new file mode 100644
index 000000000000..f7b7b1163884
--- /dev/null
+++ b/specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.0/examples/CopyOperationResult.json
@@ -0,0 +1,23 @@
+{
+ "parameters": {
+ "endpoint": "{endpoint}",
+ "Content-Type": "application/json",
+ "Ocp-Apim-Subscription-Key": "{API key}",
+ "modelId": "{modelId}",
+ "resultId": "{resultId}",
+ "body": {}
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "status": "succeeded",
+ "createdDateTime": "2020-01-01T00:00:00Z",
+ "lastUpdatedDateTime": "2020-01-01T00:01:00Z",
+ "copyResult": {
+ "modelId": "{modelId}",
+ "errors": []
+ }
+ }
+ }
+ }
+}
diff --git a/specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.0/examples/CopyOperationResultWithErrors.json b/specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.0/examples/CopyOperationResultWithErrors.json
new file mode 100644
index 000000000000..853dd73e595e
--- /dev/null
+++ b/specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.0/examples/CopyOperationResultWithErrors.json
@@ -0,0 +1,28 @@
+{
+ "parameters": {
+ "endpoint": "{endpoint}",
+ "Content-Type": "application/json",
+ "Ocp-Apim-Subscription-Key": "{API key}",
+ "modelId": "{modelId}",
+ "resultId": "{resultId}",
+ "body": {}
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "status": "failed",
+ "createdDateTime": "2020-01-01T00:00:00Z",
+ "lastUpdatedDateTime": "2020-01-01T00:01:00Z",
+ "copyResult": {
+ "modelId": "{modelId}",
+ "errors": [
+ {
+ "code": "ResourceResolverError",
+ "message": "{ErrorMessage}"
+ }
+ ]
+ }
+ }
+ }
+ }
+}
diff --git a/specification/cognitiveservices/data-plane/FormRecognizer/readme.md b/specification/cognitiveservices/data-plane/FormRecognizer/readme.md
index 969d24a80c96..6cf863de25a5 100644
--- a/specification/cognitiveservices/data-plane/FormRecognizer/readme.md
+++ b/specification/cognitiveservices/data-plane/FormRecognizer/readme.md
@@ -64,7 +64,7 @@ csharp:
license-header: MICROSOFT_MIT_NO_VERSION
azure-arm: false
namespace: Microsoft.Azure.CognitiveServices.FormRecognizer
- output-folder: $(csharp-sdks-folder)/CognitiveServices/Vision.FormRecognizer/src/Generated
+ output-folder: $(csharp-sdks-folder)/CognitiveServices/FormRecognizer/src/Generated
title: "FormRecognizerClient"
clear-output-folder: true
```
diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/LUIS-Authoring.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/LUIS-Authoring.json
index a7335b87f6b5..02fe2bdb6ec7 100644
--- a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/LUIS-Authoring.json
+++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/LUIS-Authoring.json
@@ -303,6 +303,9 @@
{
"$ref": "#/parameters/VersionIdInPath"
},
+ {
+ "$ref": "#/parameters/EnableNestedChildren"
+ },
{
"name": "exampleLabelObject",
"in": "body",
@@ -351,6 +354,9 @@
{
"$ref": "#/parameters/VersionIdInPath"
},
+ {
+ "$ref": "#/parameters/EnableNestedChildren"
+ },
{
"name": "exampleLabelObjectArray",
"in": "body",
@@ -408,6 +414,9 @@
},
{
"$ref": "#/parameters/TakeInPath"
+ },
+ {
+ "$ref": "#/parameters/EnableNestedChildren"
}
],
"responses": {
@@ -2342,6 +2351,9 @@
},
{
"$ref": "#/parameters/TakeInPath"
+ },
+ {
+ "$ref": "#/parameters/EnableNestedChildren"
}
],
"responses": {
@@ -2389,6 +2401,9 @@
},
{
"$ref": "#/parameters/TakeInPath"
+ },
+ {
+ "$ref": "#/parameters/EnableNestedChildren"
}
],
"responses": {
@@ -3413,168 +3428,6 @@
}
}
},
- "/apps/{appId}/permissions": {
- "get": {
- "description": "Gets the list of user emails that have permissions to access your application.",
- "operationId": "Permissions_List",
- "parameters": [
- {
- "$ref": "#/parameters/AppIdInPath"
- }
- ],
- "responses": {
- "200": {
- "description": "The list includes a single owner. All collaborators are listed in the emails array.",
- "schema": {
- "$ref": "#/definitions/UserAccessList"
- }
- },
- "default": {
- "description": "Error Response.",
- "schema": {
- "$ref": "#/definitions/ErrorResponse"
- }
- }
- },
- "produces": [
- "application/json"
- ],
- "x-ms-examples": {
- "Successful Get Application User Access List": {
- "$ref": "./examples/permissions/SuccessfulGetApplicationUserAccessListRequest.json"
- }
- }
- },
- "post": {
- "description": "Adds a user to the allowed list of users to access this LUIS application. Users are added using their email address.",
- "operationId": "Permissions_Add",
- "parameters": [
- {
- "$ref": "#/parameters/AppIdInPath"
- },
- {
- "name": "userToAdd",
- "in": "body",
- "required": true,
- "schema": {
- "$ref": "#/definitions/UserCollaborator"
- },
- "description": "A model containing the user's email address."
- }
- ],
- "consumes": [
- "application/json"
- ],
- "responses": {
- "200": {
- "description": "Successful operation.",
- "schema": {
- "$ref": "#/definitions/OperationStatus"
- }
- },
- "default": {
- "description": "Error Response.",
- "schema": {
- "$ref": "#/definitions/ErrorResponse"
- }
- }
- },
- "produces": [
- "application/json"
- ],
- "x-ms-examples": {
- "Successful Add User To Access List": {
- "$ref": "./examples/permissions/SuccessfulAddUserToAccessListRequest.json"
- }
- }
- },
- "delete": {
- "description": "Removes a user from the allowed list of users to access this LUIS application. Users are removed using their email address.",
- "operationId": "Permissions_Delete",
- "parameters": [
- {
- "$ref": "#/parameters/AppIdInPath"
- },
- {
- "name": "userToDelete",
- "in": "body",
- "required": true,
- "schema": {
- "$ref": "#/definitions/UserCollaborator"
- },
- "description": "A model containing the user's email address."
- }
- ],
- "consumes": [
- "application/json"
- ],
- "responses": {
- "200": {
- "description": "Successful operation.",
- "schema": {
- "$ref": "#/definitions/OperationStatus"
- }
- },
- "default": {
- "description": "Error Response.",
- "schema": {
- "$ref": "#/definitions/ErrorResponse"
- }
- }
- },
- "produces": [
- "application/json"
- ],
- "x-ms-examples": {
- "Successful Remove User From Access List": {
- "$ref": "./examples/permissions/SuccessfulRemoveUserFromAccessListRequest.json"
- }
- }
- },
- "put": {
- "description": "Replaces the current user access list with the new list sent in the body. If an empty list is sent, all access to other users will be removed.",
- "operationId": "Permissions_Update",
- "parameters": [
- {
- "$ref": "#/parameters/AppIdInPath"
- },
- {
- "name": "collaborators",
- "in": "body",
- "required": true,
- "schema": {
- "$ref": "#/definitions/CollaboratorsArray"
- },
- "description": "A model containing a list of user email addresses."
- }
- ],
- "consumes": [
- "application/json"
- ],
- "responses": {
- "200": {
- "description": "Successful operation.",
- "schema": {
- "$ref": "#/definitions/OperationStatus"
- }
- },
- "default": {
- "description": "Error Response.",
- "schema": {
- "$ref": "#/definitions/ErrorResponse"
- }
- }
- },
- "produces": [
- "application/json"
- ],
- "x-ms-examples": {
- "Successful Replaces Users From Access List": {
- "$ref": "./examples/permissions/SuccessfulReplacesUsersFromAccessListRequest.json"
- }
- }
- }
- },
"/apps/{appId}/endpoints": {
"get": {
"description": "Returns the available endpoint deployment regions and URLs.",
@@ -8149,6 +8002,22 @@
"role": {
"description": "The role the entity plays in the utterance.",
"type": "string"
+ },
+ "children": {
+ "description": "The identified entities within the example utterance.",
+ "items": {
+ "type": "object",
+ "$ref": "#/definitions/EntityLabelObject"
+ },
+ "type": "array",
+ "example": [
+ {
+ "entityName": "child",
+ "startCharIndex": 0,
+ "endCharIndex": 0,
+ "children": []
+ }
+ ]
}
}
},
@@ -8319,6 +8188,21 @@
"role": {
"description": "The role the entity plays in the utterance.",
"type": "string"
+ },
+ "children": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "$ref": "#/definitions/JSONEntity"
+ },
+ "example": [
+ {
+ "entity": "child1",
+ "startPos": 0,
+ "endPos": 0,
+ "children": []
+ }
+ ]
}
}
},
@@ -9278,6 +9162,21 @@
"type": "string",
"format": "uuid",
"description": "The role id for the predicted entity."
+ },
+ "children": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "$ref": "#/definitions/EntityLabel"
+ },
+ "example": [
+ {
+ "entityName": "child",
+ "startTokenIndex": 0,
+ "endTokenIndex": 0,
+ "children": []
+ }
+ ]
}
},
"required": [
@@ -9325,6 +9224,21 @@
"phrase": {
"type": "string",
"description": "The actual token(s) that comprise the entity."
+ },
+ "children": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "$ref": "#/definitions/EntityPrediction"
+ },
+ "example": [
+ {
+ "entityName": "child",
+ "startTokenIndex": 0,
+ "endTokenIndex": 0,
+ "phrase": "string"
+ }
+ ]
}
}
},
@@ -10604,6 +10518,9 @@
"featureName": {
"type": "string",
"description": "The name of the feature used."
+ },
+ "isRequired": {
+ "type": "boolean"
}
}
},
@@ -10847,6 +10764,14 @@
"type": "string",
"in": "path",
"x-ms-skip-url-encoding": true
+ },
+ "EnableNestedChildren": {
+ "name": "enableNestedChildren",
+ "in": "query",
+ "type": "boolean",
+ "default": false,
+ "description": "Toggles nested/flat format",
+ "x-ms-parameter-location": "method"
}
}
}
diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/examples/SuccessfulAddLabelRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/examples/SuccessfulAddLabelRequest.json
index 9a7220daa4e3..5512edd005fc 100644
--- a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/examples/SuccessfulAddLabelRequest.json
+++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/examples/SuccessfulAddLabelRequest.json
@@ -4,6 +4,7 @@
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
"appId": "86226c53-b7a6-416f-876b-226b2b5ab07b",
"versionId": "0.1",
+ "enableNestedChildren": false,
"exampleLabelObject": {
"text": "whats the weather in buenos aires?",
"intentName": "WeatherInPlace",
diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/examples/SuccessfulBatchAddLabelsRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/examples/SuccessfulBatchAddLabelsRequest.json
index bc2a357b807a..516369be8a7c 100644
--- a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/examples/SuccessfulBatchAddLabelsRequest.json
+++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/examples/SuccessfulBatchAddLabelsRequest.json
@@ -4,6 +4,7 @@
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
"appId": "2370fb9d-7dbc-4898-a361-a742cf290766",
"versionId": "0.1",
+ "enableNestedChildren": false,
"exampleLabelObjectArray": [
{
"text": "whats the weather in seattle?",
diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/examples/SuccessfulReviewLabeledExamplesRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/examples/SuccessfulReviewLabeledExamplesRequest.json
index a0a43d373b31..49071d052202 100644
--- a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/examples/SuccessfulReviewLabeledExamplesRequest.json
+++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/examples/SuccessfulReviewLabeledExamplesRequest.json
@@ -3,7 +3,8 @@
"Endpoint": "{Endpoint}",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
"appId": "86226c53-b7a6-416f-876b-226b2b5ab07b",
- "versionId": "0.1"
+ "versionId": "0.1",
+ "enableNestedChildren": false
},
"responses": {
"200": {
diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulGetEntitySuggestionExamples.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulGetEntitySuggestionExamples.json
index 0c103cc44e24..f6605ccf44e3 100644
--- a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulGetEntitySuggestionExamples.json
+++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulGetEntitySuggestionExamples.json
@@ -4,7 +4,8 @@
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
"appId": "86226c53-b7a6-416f-876b-226b2b5ab07b",
"versionId": "0.1",
- "entityId": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73"
+ "entityId": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73",
+ "enableNestedChildren": false
},
"responses": {
"200": {
diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulGetIntentsSuggestionExamples.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulGetIntentsSuggestionExamples.json
index a0cd5f3a1bbc..260784bda5d1 100644
--- a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulGetIntentsSuggestionExamples.json
+++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulGetIntentsSuggestionExamples.json
@@ -4,7 +4,8 @@
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
"appId": "86226c53-b7a6-416f-876b-226b2b5ab07b",
"versionId": "0.1",
- "intentId": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73"
+ "intentId": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73",
+ "enableNestedChildren": false
},
"responses": {
"200": {
diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/permissions/SuccessfulAddUserToAccessListRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/permissions/SuccessfulAddUserToAccessListRequest.json
deleted file mode 100644
index 868818ea0bda..000000000000
--- a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/permissions/SuccessfulAddUserToAccessListRequest.json
+++ /dev/null
@@ -1,19 +0,0 @@
-{
- "parameters": {
- "Endpoint": "{Endpoint}",
- "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
- "appId": "363187f1-c573-46b3-bc4c-ae01d686e68e",
- "userToAdd": {
- "email": "guest@outlook.com"
- }
- },
- "responses": {
- "200": {
- "headers": {},
- "body": {
- "code": "Success",
- "message": "Operation Successful"
- }
- }
- }
-}
diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/permissions/SuccessfulGetApplicationUserAccessListRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/permissions/SuccessfulGetApplicationUserAccessListRequest.json
deleted file mode 100644
index bca79c6b986c..000000000000
--- a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/permissions/SuccessfulGetApplicationUserAccessListRequest.json
+++ /dev/null
@@ -1,18 +0,0 @@
-{
- "parameters": {
- "Endpoint": "{Endpoint}",
- "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
- "appId": "363187f1-c573-46b3-bc4c-ae01d686e68e"
- },
- "responses": {
- "200": {
- "headers": {},
- "body": {
- "owner": "owner@email.com",
- "emails": [
- "yourname@outlook.com"
- ]
- }
- }
- }
-}
diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/permissions/SuccessfulRemoveUserFromAccessListRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/permissions/SuccessfulRemoveUserFromAccessListRequest.json
deleted file mode 100644
index e07a94cd0393..000000000000
--- a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/permissions/SuccessfulRemoveUserFromAccessListRequest.json
+++ /dev/null
@@ -1,19 +0,0 @@
-{
- "parameters": {
- "Endpoint": "{Endpoint}",
- "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
- "appId": "363187f1-c573-46b3-bc4c-ae01d686e68e",
- "userToDelete": {
- "email": "guest@outlook.com"
- }
- },
- "responses": {
- "200": {
- "headers": {},
- "body": {
- "code": "Success",
- "message": "Operation Successful"
- }
- }
- }
-}
diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/permissions/SuccessfulReplacesUsersFromAccessListRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/permissions/SuccessfulReplacesUsersFromAccessListRequest.json
deleted file mode 100644
index 34444826b73b..000000000000
--- a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/permissions/SuccessfulReplacesUsersFromAccessListRequest.json
+++ /dev/null
@@ -1,22 +0,0 @@
-{
- "parameters": {
- "Endpoint": "{Endpoint}",
- "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
- "appId": "363187f1-c573-46b3-bc4c-ae01d686e68e",
- "collaborators": {
- "emails": [
- "guest@outlook.com",
- "invited.user@live.com"
- ]
- }
- },
- "responses": {
- "200": {
- "headers": {},
- "body": {
- "code": "Success",
- "message": "Operation Successful"
- }
- }
- }
-}
diff --git a/specification/cognitiveservices/data-plane/SpeakerRecognition/Identification/preview/v2.0/Identification.json b/specification/cognitiveservices/data-plane/SpeakerRecognition/Identification/preview/v2.0/Identification.json
new file mode 100644
index 000000000000..d5476d4178cc
--- /dev/null
+++ b/specification/cognitiveservices/data-plane/SpeakerRecognition/Identification/preview/v2.0/Identification.json
@@ -0,0 +1,831 @@
+{
+ "swagger": "2.0",
+ "info": {
+ "title": "Speaker Identification API",
+ "version": "2.0",
+ "description": "This API is currently available in:\n\n* West US - westus.api.cognitive.microsoft.com"
+ },
+ "x-ms-parameterized-host": {
+ "hostTemplate": "{Endpoint}/speaker/identification/v2.0",
+ "useSchemePrefix": false,
+ "parameters": [
+ {
+ "$ref": "#/parameters/Endpoint"
+ }
+ ]
+ },
+ "schemes": [
+ "https"
+ ],
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "securityDefinitions": {
+ "apiKeyHeader": {
+ "type": "apiKey",
+ "name": "Ocp-Apim-Subscription-Key",
+ "in": "header"
+ }
+ },
+ "security": [
+ {
+ "apiKeyHeader": []
+ }
+ ],
+ "parameters": {
+ "Endpoint": {
+ "name": "Endpoint",
+ "description": "Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus.api.cognitive.microsoft.com).",
+ "x-ms-parameter-location": "client",
+ "required": true,
+ "type": "string",
+ "in": "path",
+ "x-ms-skip-url-encoding": true
+ },
+ "profileIdParam": {
+ "in": "path",
+ "name": "profileId",
+ "required": true,
+ "type": "string",
+ "format": "uuid",
+ "x-nullable": false,
+ "pattern": "^([0-9a-fA-F]){8}-?([0-9a-fA-F]){4}-?([0-9a-fA-F]){4}-?([0-9a-fA-F]){4}-?([0-9a-fA-F]){12}$",
+ "description": "Unique identifier for profile id (guid).",
+ "x-ms-parameter-location": "method"
+ },
+ "localeParam": {
+ "in": "path",
+ "name": "locale",
+ "required": true,
+ "type": "string",
+ "x-nullable": false,
+ "pattern": "^[a-zA-Z]{2}-?[a-zA-Z]{2}$",
+ "description": "A combination of language code and country code.",
+ "x-ms-parameter-location": "method"
+ }
+ },
+ "definitions": {
+ "ProfileId": {
+ "type": "string",
+ "pattern": "^([0-9a-fA-F]){8}-?([0-9a-fA-F]){4}-?([0-9a-fA-F]){4}-?([0-9a-fA-F]){4}-?([0-9a-fA-F]){12}$",
+ "description": "Unique identifier for profile id (guid).",
+ "example": "49a36324-fc4b-4387-aa06-090cfbf0064f",
+ "format": "uuid",
+ "x-nullable": false
+ },
+ "Locale": {
+ "type": "string",
+ "pattern": "^[a-zA-Z]{2}-?[a-zA-Z]{2}$",
+ "x-nullable": false,
+ "description": "Language identifier consisting of a combination of language code and country code.",
+ "example": "en-US"
+ },
+ "EnrollmentStatus": {
+ "type": "string",
+ "description": "Status representing the current state of the profile. Available values are:\n* Enrolling: profile has no voice print and not ready for recognition requests.\n* Training: voice print of profile is being created and can’t be used for recognition at the moment.\n* Enrolled: profile has a voice print and ready for recognition requests.",
+ "enum": [
+ "Enrolling",
+ "Training",
+ "Enrolled"
+ ],
+ "x-ms-enum": {
+ "name": "TrainingStatusType",
+ "modelAsString": false
+ },
+ "example": "Enrolling"
+ },
+ "CreatedDateTime": {
+ "type": "string",
+ "description": "Profile creation datetime.",
+ "example": "2015-04-23T18:25:43.41Z"
+ },
+ "LastUpdatedDateTime": {
+ "type": "string",
+ "description": "Last datetime when the profile was updated.",
+ "example": "2015-04-23T19:34:51.52Z"
+ },
+ "EnrollmentsCount": {
+ "type": "integer",
+ "description": "Number of enrolment audios accepted for this profile.",
+ "example": 1
+ },
+ "EnrollmentsLength": {
+ "type": "number",
+ "description": "Total length of enrollment audios accepted for this profile in seconds.",
+ "example": 1.83
+ },
+ "EnrollmentsSpeechLength": {
+ "type": "number",
+ "description": "Summation of pure speech (which is the amount of audio after removing silence and non-speech segments) across all profile enrollments in seconds.",
+ "example": 1.35
+ },
+ "RemainingEnrollmentsSpeechLength": {
+ "type": "number",
+ "description": "Amount of pure speech (which is the amount of audio after removing silence and non-speech segments) needed to complete profile enrollment in seconds.",
+ "example": 18.65
+ },
+ "ModelVersion": {
+ "type": "string",
+ "pattern": "^\\d{4}-\\d{2}-\\d{2}$",
+ "description": "Date specifying the model assigned to this profile. Format is yyyy-mm-dd. If profile has no enrollments, this value will be empty.",
+ "example": "2019-12-05"
+ },
+ "LocaleInfo": {
+ "description": "Speaker profile locale",
+ "required": [
+ "locale"
+ ],
+ "properties": {
+ "locale": {
+ "$ref": "#/definitions/Locale"
+ }
+ }
+ },
+ "TiProfileInfoList": {
+ "description": "Text-Independent Speaker profile info list",
+ "properties": {
+ "profiles": {
+ "items": {
+ "$ref": "#/definitions/TiProfileInfo"
+ }
+ },
+ "@nextLink": {
+ "type": "string",
+ "example": "https://{Endpoint}/text-independent/profiles?$top=35&$continuationToken=U21pdGg1QmVuOTk5"
+ }
+ }
+ },
+ "TiProfileInfo": {
+ "description": "Text-Independent Speaker profile info",
+ "properties": {
+ "profileId": {
+ "$ref": "#/definitions/ProfileId"
+ },
+ "locale": {
+ "$ref": "#/definitions/Locale"
+ },
+ "enrollmentStatus": {
+ "$ref": "#/definitions/EnrollmentStatus"
+ },
+ "createdDateTime": {
+ "$ref": "#/definitions/CreatedDateTime"
+ },
+ "lastUpdatedDateTime": {
+ "$ref": "#/definitions/LastUpdatedDateTime"
+ },
+ "enrollmentsCount": {
+ "$ref": "#/definitions/EnrollmentsCount"
+ },
+ "enrollmentsLength": {
+ "$ref": "#/definitions/EnrollmentsLength"
+ },
+ "enrollmentsSpeechLength": {
+ "$ref": "#/definitions/EnrollmentsSpeechLength"
+ },
+ "remainingEnrollmentsSpeechLength": {
+ "$ref": "#/definitions/RemainingEnrollmentsSpeechLength"
+ },
+ "modelVersion": {
+ "$ref": "#/definitions/ModelVersion"
+ }
+ }
+ },
+ "TiEnrollmentInfo": {
+ "description": "Speaker profile enrollment info",
+ "properties": {
+ "profileId": {
+ "$ref": "#/definitions/ProfileId"
+ },
+ "enrollmentStatus": {
+ "$ref": "#/definitions/EnrollmentStatus"
+ },
+ "enrollmentsCount": {
+ "$ref": "#/definitions/EnrollmentsCount"
+ },
+ "enrollmentsLength": {
+ "$ref": "#/definitions/EnrollmentsLength"
+ },
+ "enrollmentsSpeechLength": {
+ "$ref": "#/definitions/EnrollmentsSpeechLength"
+ },
+ "remainingEnrollmentsSpeechLength": {
+ "$ref": "#/definitions/RemainingEnrollmentsSpeechLength"
+ },
+ "audioLength": {
+ "type": "number",
+ "description": "This enrolment audio length in seconds.",
+ "example": 1.83
+ },
+ "audioSpeechLength": {
+ "type": "number",
+ "description": "This enrollment audio pure speech (which is the amount of audio after removing silence and non-speech segments) length in seconds.",
+ "example": 1.35
+ }
+ }
+ },
+ "IdentifiedSingleSpeakerInfo": {
+ "properties": {
+ "identifiedProfile": {
+ "description": "Object containing data of identified profile.",
+ "$ref": "#/definitions/IdentifyInfo"
+ },
+ "profilesRanking": {
+ "description": "Object containing data of the top 5 profiles (including identified profile) sorted in descending order by score.",
+ "items": {
+ "$ref": "#/definitions/IdentifyInfo"
+ },
+ "example": [
+ {
+ "profileId": "111f427c-3791-468f-b709-fcef7660fff9",
+ "score": 0.63
+ },
+ {
+ "profileId": "3669fa29-1bf3-45ad-beea-6b348d058d7e",
+ "score": 0.49
+ },
+ {
+ "profileId": "0e196cd9-32d5-4883-8631-54a0e7c7cb3d",
+ "score": 0.4
+ },
+ {
+ "profileId": "726e57d9-04e0-4214-b482-7f786fa83560",
+ "score": 0.1
+ },
+ {
+ "profileId": "f95189fd-1bf5-4485-9c2e-e5897e0c98ca",
+ "score": 0.03
+ }
+ ]
+ }
+ }
+ },
+ "IdentifyInfo": {
+ "description": "Identified speaker info",
+ "properties": {
+ "profileId": {
+ "type": "string",
+ "pattern": "^([0-9a-fA-F]){8}-?([0-9a-fA-F]){4}-?([0-9a-fA-F]){4}-?([0-9a-fA-F]){4}-?([0-9a-fA-F]){12}$",
+ "description": "ID of identified of profile. If no candidate is identified as the right speaker, the value is set to empty GUID.",
+ "example": "111f427c-3791-468f-b709-fcef7660fff9",
+ "format": "uuid",
+ "x-nullable": false
+ },
+ "score": {
+ "type": "number",
+ "description": "A float number indicating the similarity between input audio and targeted voice print. This number must be between 0 and 1. A higher number means higher similarity.",
+ "example": 0.63
+ }
+ }
+ },
+ "Error": {
+ "required": [
+ "error"
+ ],
+ "properties": {
+ "error": {
+ "properties": {
+ "code": {
+ "type": "string"
+ },
+ "message": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "NotFound": {
+ "description": "NotFound - Requested profile doesn't exist",
+ "schema": {
+ "$ref": "#/definitions/Error"
+ },
+ "examples": {
+ "application/json": {
+ "error": {
+ "code": "Not Found",
+ "message": "Requested profile doesn't exist"
+ }
+ }
+ },
+ "x-ms-error-response": true
+ },
+ "Unauthorized": {
+ "description": "Request is not authorized. Make sure subscription key is included and valid.",
+ "schema": {
+ "$ref": "#/definitions/Error"
+ },
+ "examples": {
+ "application/json": {
+ "error": {
+ "code": "Unauthorized",
+ "message": "Request is not authorized. Make sure subscription key is included and valid."
+ }
+ }
+ },
+ "x-ms-error-response": true
+ },
+ "RateLimit": {
+ "description": "Rate limit is exceeded.",
+ "schema": {
+ "$ref": "#/definitions/Error"
+ },
+ "examples": {
+ "application/json": {
+ "error": {
+ "code": "RateLimit",
+ "message": "Rate limit is exceeded."
+ }
+ }
+ },
+ "x-ms-error-response": true
+ },
+ "ServerError": {
+ "description": "Internal Server Error.",
+ "schema": {
+ "$ref": "#/definitions/Error"
+ },
+ "examples": {
+ "application/json": {
+ "error": {
+ "code": "InternalServerError",
+ "message": "Internal Server Error."
+ }
+ }
+ },
+ "x-ms-error-response": true
+ }
+ },
+ "paths": {
+ "/text-independent/profiles": {
+ "post": {
+ "description": "Creates a new speaker profile with specified locale.\nOne subscription can create 10,000 speaker profiles at most.",
+ "operationId": "TextIndependent_CreateProfile",
+ "summary": "Create Profile",
+ "x-ms-examples": {
+ "Successful Query": {
+ "$ref": "./examples/createProfile.json"
+ }
+ },
+ "tags": [
+ "text-independent"
+ ],
+ "parameters": [
+ {
+ "in": "body",
+ "name": "profileInfo",
+ "description": "Provide following detail info when creating a new profile.\nFields | Description\n------- | ------------\nlocale | Locale for the language of this speaker profile. A complete supported locale list is here:
**en-US**
**es-ES**
**fr-FR**
**zh-CN**
**de-DE**
**en-GB**
**en-AU**
**en-CA**
**fr-CA**
**it-IT**
**es-MX**
**ja-JP**
**pt-BR**
**en-IN**
",
+ "schema": {
+ "$ref": "#/definitions/LocaleInfo"
+ }
+ }
+ ],
+ "responses": {
+ "201": {
+ "description": "Speaker profile created successfully. GUID is returned to reference the created profile.",
+ "headers": {
+ "Location": {
+ "type": "string",
+ "description": "url location of new resource"
+ }
+ },
+ "schema": {
+ "$ref": "#/definitions/TiProfileInfo"
+ }
+ },
+ "400": {
+ "description": "Bad Request\n* InvalidRequest - Request body is missing.\n* InvalidRequest - Invalid JSON format.\n* InvalidRequest - Locale parameter is missing.\n* InvalidArgument - Invalid locale value. Supported locales are {comma-separated list of locales}.",
+ "schema": {
+ "$ref": "#/definitions/Error"
+ },
+ "examples": {
+ "application/json": {
+ "error": {
+ "code": "InvalidRequest",
+ "message": "Request body is missing."
+ }
+ }
+ },
+ "x-ms-error-response": true
+ },
+ "401": {
+ "$ref": "#/responses/Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden - Maximum allowed number of profiles is 10,000.",
+ "schema": {
+ "$ref": "#/definitions/Error"
+ },
+ "examples": {
+ "application/json": {
+ "error": {
+ "code": "Forbidden",
+ "message": "Maximum allowed number of profiles is 10,000."
+ }
+ }
+ },
+ "x-ms-error-response": true
+ },
+ "415": {
+ "description": "UnsupportedMediaType - Unsupported media type. Only 'application/JSON' is accepted.",
+ "schema": {
+ "$ref": "#/definitions/Error"
+ },
+ "examples": {
+ "application/json": {
+ "error": {
+ "code": "UnsupportedMediaType",
+ "message": "Unsupported media type. Only 'application/JSON' is accepted."
+ }
+ }
+ },
+ "x-ms-error-response": true
+ },
+ "429": {
+ "$ref": "#/responses/RateLimit"
+ },
+ "500": {
+ "$ref": "#/responses/ServerError"
+ }
+ }
+ },
+ "get": {
+ "x-ms-pageable": {
+ "nextLinkName": "@nextLink",
+ "itemName": "profiles"
+ },
+ "description": "Retrieves a set of profiles.\nProfiles are sorted alphabetically by ProfileId",
+ "operationId": "TextIndependent_ListProfiles",
+ "summary": "List Profile",
+ "x-ms-examples": {
+ "Successful Query": {
+ "$ref": "./examples/listProfiles.json"
+ }
+ },
+ "tags": [
+ "text-independent"
+ ],
+ "parameters": [
+ {
+ "in": "query",
+ "name": "$top",
+ "description": "The number of profiles to return. Default is 100 and the maximum is 500",
+ "type": "integer"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/TiProfileInfoList"
+ }
+ },
+ "400": {
+ "description": "Bad Request\n* InvalidArgument - Invalid $top parameter value. Value should be positive integer in the range [1, 500].\n* InvalidArgument - Invalid $continuationToken value. $continuationToken must be generated form a prior API call.\n* InvalidArgument - $filter parameter is not supported.\n* InvalidArgument - $skip parameter is not supported.\n* InvalidArgument - $orderBy parameter is not supported.\n* InvalidArgument - $delta parameter is not supported.",
+ "schema": {
+ "$ref": "#/definitions/Error"
+ },
+ "examples": {
+ "application/json": {
+ "error": {
+ "code": "InvalidArgument",
+ "message": "Invalid $top parameter value. Value should be positive integer in the range [1, 500]"
+ }
+ }
+ },
+ "x-ms-error-response": true
+ },
+ "401": {
+ "$ref": "#/responses/Unauthorized"
+ },
+ "429": {
+ "$ref": "#/responses/RateLimit"
+ },
+ "500": {
+ "$ref": "#/responses/ServerError"
+ }
+ }
+ }
+ },
+ "/text-independent/profiles/{profileId}": {
+ "parameters": [
+ {
+ "$ref": "#/parameters/profileIdParam"
+ }
+ ],
+ "get": {
+ "description": "Retrieves a single profile by ID.",
+ "operationId": "TextIndependent_GetProfile",
+ "summary": "Retrieve Single Profile",
+ "x-ms-examples": {
+ "Successful Query": {
+ "$ref": "./examples/fetchProfile.json"
+ }
+ },
+ "tags": [
+ "text-independent"
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/TiProfileInfo"
+ }
+ },
+ "401": {
+ "$ref": "#/responses/Unauthorized"
+ },
+ "404": {
+ "$ref": "#/responses/NotFound"
+ },
+ "429": {
+ "$ref": "#/responses/RateLimit"
+ },
+ "500": {
+ "$ref": "#/responses/ServerError"
+ }
+ }
+ },
+ "delete": {
+ "description": "Deletes an existing profile.",
+ "operationId": "TextIndependent_DeleteProfile",
+ "summary": "Delete Profile",
+ "x-ms-examples": {
+ "Successful Query": {
+ "$ref": "./examples/deleteProfile.json"
+ }
+ },
+ "tags": [
+ "text-independent"
+ ],
+ "responses": {
+ "204": {
+ "description": "OK"
+ },
+ "401": {
+ "$ref": "#/responses/Unauthorized"
+ },
+ "429": {
+ "$ref": "#/responses/RateLimit"
+ },
+ "500": {
+ "$ref": "#/responses/ServerError"
+ }
+ }
+ }
+ },
+ "/text-independent/profiles/{profileId}/reset": {
+ "parameters": [
+ {
+ "$ref": "#/parameters/profileIdParam"
+ }
+ ],
+ "post": {
+ "description": "Resets existing profile to its original creation state. The reset operation does the following:\n* Updates enrollmentStatus to Enrolling.\n* Updates lastUpdatedDateTime.\n* Updates enrollmentsCount to 0.\n* Updates enrollmentsLength to 0.\n* Updates enrollmentsSpeechLength to 0.\n* Updates remainingEnrollmentsSpeechLength to the required number.\n* Removes all associated enrollments from storage.\n* Removes chosen passphrase association.\n* Resets value of modelVersion.",
+ "operationId": "TextIndependent_ResetProfile",
+ "summary": "Reset Profile",
+ "x-ms-examples": {
+ "Successful Query": {
+ "$ref": "./examples/resetProfile.json"
+ }
+ },
+ "tags": [
+ "text-independent"
+ ],
+ "responses": {
+ "204": {
+ "description": "OK"
+ },
+ "401": {
+ "$ref": "#/responses/Unauthorized"
+ },
+ "404": {
+ "$ref": "#/responses/NotFound"
+ },
+ "429": {
+ "$ref": "#/responses/RateLimit"
+ },
+ "500": {
+ "$ref": "#/responses/ServerError"
+ }
+ }
+ }
+ },
+ "/text-independent/profiles/{profileId}/enrollments": {
+ "parameters": [
+ {
+ "$ref": "#/parameters/profileIdParam"
+ }
+ ],
+ "post": {
+ "description": "Adds an enrollment to existing profile.\nIf the minimum number of requested enrollment audios is reached, a voice print is created.\nIf the voice print was created before, it gets recreated from all existing enrollment audios including the new one.\n\nLimitations:\n* Minimum audio input length per request is **1 second**\n* Maximum audio input length per request is **120 seconds**\n* Minimum total effective speech length (excluding silence and other non-speech frames) for creating a voiceprint is **20 seconds**\n This limitation can be disabled by setting ignoreMinLength to **true**.\n\n* Maximum total audio input length allowed for creating a voiceprint is **300 seconds**\n* Minimum audio Signal-to-noise ratio (SNR) is **0dB**",
+ "operationId": "TextIndependent_CreateEnrollment",
+ "summary": "Enroll Profile",
+ "x-ms-examples": {
+ "Successful Query": {
+ "$ref": "./examples/createEnrollment.json"
+ }
+ },
+ "tags": [
+ "text-independent"
+ ],
+ "consumes": [
+ "audio/wav; codecs=audio/pcm"
+ ],
+ "parameters": [
+ {
+ "in": "query",
+ "name": "ignoreMinLength",
+ "type": "boolean",
+ "description": "If true, a voice print will be created immediately for this profile regardless of how much speech is supplied or stored. Default is false."
+ },
+ {
+ "name": "audioData",
+ "in": "body",
+ "description": "Binary audio file. Supported formats are audio/wav; codecs=audio/pcm. Supports audio up to 5MB.",
+ "required": true,
+ "schema": {
+ "type": "object",
+ "format": "file"
+ }
+ }
+ ],
+ "responses": {
+ "201": {
+ "description": "Created",
+ "schema": {
+ "$ref": "#/definitions/TiEnrollmentInfo"
+ }
+ },
+ "400": {
+ "description": "Bad Request\n* InvalidRequest - Invalid audio length. Maximum allowed length per enrollment request is 120 seconds.\n* InvalidRequest - Invalid audio length. Minimum allowed length per enrollment request is 1 second.\n* InvalidRequest - Invalid audio format. Supported format is 16Khz 16bit Mono PCM.\n* InvalidArgument - Invalid ignoreMinLength parameter value. Valid values are \"true\" and \"false\".\n* InvalidRequest - Minimum audio Signal-to-noise ratio (SNR) is 0dB\n* InvalidRequest - Audio is too noisy. The minimum allowed Signal-to-noise ratio (SNR) is 0dB.",
+ "schema": {
+ "$ref": "#/definitions/Error"
+ },
+ "examples": {
+ "application/json": {
+ "error": {
+ "code": "InvalidRequest",
+ "message": "Audio is too noisy."
+ }
+ }
+ },
+ "x-ms-error-response": true
+ },
+ "401": {
+ "$ref": "#/responses/Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden\n* InvalidRequest - Maximum allowed length across all profile enrollments is 300 seconds.",
+ "schema": {
+ "$ref": "#/definitions/Error"
+ },
+ "examples": {
+ "application/json": {
+ "error": {
+ "code": "InvalidRequest",
+ "message": "Maximum allowed length across all profile enrollments is 300 seconds."
+ }
+ }
+ },
+ "x-ms-error-response": true
+ },
+ "404": {
+ "$ref": "#/responses/NotFound"
+ },
+ "409": {
+ "description": "Conflict\n* Conflict - Sending concurrent requests on same profile is not allowed.",
+ "schema": {
+ "$ref": "#/definitions/Error"
+ },
+ "examples": {
+ "application/json": {
+ "error": {
+ "code": "Conflict",
+ "message": "Sending concurrent requests on same profile is not allowed."
+ }
+ }
+ },
+ "x-ms-error-response": true
+ },
+ "415": {
+ "description": "UnsupportedMediaType - Unsupported media type. Only \"audio/wav; codecs=audio/pcm\" is accepted.",
+ "schema": {
+ "$ref": "#/definitions/Error"
+ },
+ "examples": {
+ "application/json": {
+ "error": {
+ "code": "UnsupportedMediaType",
+ "message": "Unsupported media type. Only 'audio/wav; codecs=audio/pcm' is accepted."
+ }
+ }
+ },
+ "x-ms-error-response": true
+ },
+ "429": {
+ "$ref": "#/responses/RateLimit"
+ },
+ "500": {
+ "$ref": "#/responses/ServerError"
+ }
+ }
+ }
+ },
+ "/text-independent/profiles/identifySingleSpeaker": {
+ "post": {
+ "description": "Identifies who is speaking in input audio among a list of candidate profiles.\n\nLimitations:\n* Minimum audio input length is **1 second**\n* Maximum audio input length is **120 seconds**\n* Minimum candidate speakers count is **1**\n* Maximum candidate speakers count is **50**\n* Minimum effective speech length (excluding silence and other non-speech frames) is **4 seconds**\n This limitation can be disabled by setting \"ignoreMinLength\" to **true**.\n\n* Minimum audio Signal-to-noise ratio (SNR) is **0dB**",
+ "operationId": "TextIndependent_IdentifySingleSpeaker",
+ "summary": "Identify Single Speaker Profile",
+ "x-ms-examples": {
+ "Successful Query": {
+ "$ref": "./examples/identifySingleSpeaker.json"
+ }
+ },
+ "tags": [
+ "text-independent"
+ ],
+ "consumes": [
+ "audio/wav; codecs=audio/pcm"
+ ],
+ "parameters": [
+ {
+ "in": "query",
+ "name": "profileIds",
+ "type": "string",
+ "required": true,
+ "description": "Comma-delimited profile IDs. Maximum supported number is 50 IDs."
+ },
+ {
+ "in": "query",
+ "name": "ignoreMinLength",
+ "type": "boolean",
+ "description": "If true, the minimum amount of speech needed for identification is skipped. Default is false."
+ },
+ {
+ "name": "audioData",
+ "in": "body",
+ "description": "Binary audio file. Supported formats are audio/wav; codecs=audio/pcm. Supports audio up to 5MB.",
+ "required": true,
+ "schema": {
+ "type": "object",
+ "format": "file"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/IdentifiedSingleSpeakerInfo"
+ }
+ },
+ "400": {
+ "description": "Bad Request\n* InvalidRequest - Invalid audio length. Maximum allowed length per recognition request is 120 seconds.\n* InvalidRequest - Invalid audio length. Minimum allowed length per recognition request is 1 second.\n* InvalidRequest - Invalid audio format. Supported format is 16Khz 16bit Mono PCM.\n* InvalidArgument - Invalid ignoreMinLength parameter value. Valid values are \"true\" and \"false\".\n* InvalidArgument - Invalid profileIds parameter value. It should be comma-delimited list of IDs containing at least one ID.\n* InvalidRequest - profileIds parameter is missing. It should be comma-delimited list of IDs containing at least one ID.\n* InvalidRequest - Invalid group of profiles. Profiles must have the same locale.\n* InvalidRequest - Maximum number of profiles allowed per request is 50.\n* InvalidRequest - Minimum audio Signal-to-noise ratio (SNR) is 0dB\n* InvalidRequest - Profile is not enrolled.",
+ "schema": {
+ "$ref": "#/definitions/Error"
+ },
+ "examples": {
+ "application/json": {
+ "error": {
+ "code": "InvalidRequest",
+ "message": "Profile is not enrolled."
+ }
+ }
+ },
+ "x-ms-error-response": true
+ },
+ "401": {
+ "$ref": "#/responses/Unauthorized"
+ },
+ "415": {
+ "description": "UnsupportedMediaType - Unsupported media type. Only \"audio/wav; codecs=audio/pcm\" is accepted.",
+ "schema": {
+ "$ref": "#/definitions/Error"
+ },
+ "examples": {
+ "application/json": {
+ "error": {
+ "code": "UnsupportedMediaType",
+ "message": "Unsupported media type. Only 'audio/wav; codecs=audio/pcm' is accepted."
+ }
+ }
+ },
+ "x-ms-error-response": true
+ },
+ "429": {
+ "$ref": "#/responses/RateLimit"
+ },
+ "500": {
+ "$ref": "#/responses/ServerError"
+ }
+ }
+ }
+ }
+ },
+ "tags": []
+}
diff --git a/specification/cognitiveservices/data-plane/SpeakerRecognition/Identification/preview/v2.0/examples/createEnrollment.json b/specification/cognitiveservices/data-plane/SpeakerRecognition/Identification/preview/v2.0/examples/createEnrollment.json
new file mode 100644
index 000000000000..b7eb28955a51
--- /dev/null
+++ b/specification/cognitiveservices/data-plane/SpeakerRecognition/Identification/preview/v2.0/examples/createEnrollment.json
@@ -0,0 +1,114 @@
+{
+ "parameters": {
+ "Endpoint": "{Endpoint}",
+ "Content-Type": "audio/wav; codecs=audio/pcm",
+ "Ocp-Apim-Subscription-Key": "{API key}",
+ "profileId": "49a36324-fc4b-4387-aa06-090cfbf0064f",
+ "audioData": "{binary file date}"
+ },
+ "responses": {
+ "201": {
+ "headers": {
+ "Content-Type": "application/json"
+ },
+ "body": {
+ "profileId": "49a36324-fc4b-4387-aa06-090cfbf0064f",
+ "enrollmentStatus": "Enrolling",
+ "enrollmentsCount": 1,
+ "enrollmentsLength": 1.83,
+ "enrollmentsSpeechLength": 1.35,
+ "remainingEnrollmentsSpeechLength": 18.65,
+ "audioLength": 1.83,
+ "audioSpeechLength": 1.35
+ }
+ },
+ "400": {
+ "headers": {
+ "Content-Type": "application/json"
+ },
+ "body": {
+ "error": {
+ "code": "InvalidRequest",
+ "message": "Audio is too noisy."
+ }
+ }
+ },
+ "401": {
+ "headers": {
+ "Content-Type": "application/json"
+ },
+ "body": {
+ "error": {
+ "code": "Unauthorized",
+ "message": "Request is not authorized. Make sure subscription key is included and valid."
+ }
+ }
+ },
+ "403": {
+ "headers": {
+ "Content-Type": "application/json"
+ },
+ "body": {
+ "error": {
+ "code": "InvalidRequest",
+ "message": "Maximum allowed length across all profile enrollments is 300 seconds."
+ }
+ }
+ },
+ "404": {
+ "headers": {
+ "Content-Type": "application/json"
+ },
+ "body": {
+ "error": {
+ "code": "Not Found",
+ "message": "Requested profile doesn't exist"
+ }
+ }
+ },
+ "409": {
+ "headers": {
+ "Content-Type": "application/json"
+ },
+ "body": {
+ "error": {
+ "code": "Conflict",
+ "message": "Sending concurrent requests on same profile is not allowed."
+ }
+ }
+ },
+ "415": {
+ "headers": {
+ "Content-Type": "application/json"
+ },
+ "body": {
+ "error": {
+ "code": "UnsupportedMediaType",
+ "message": "Unsupported media type. Only 'audio/wav; codecs=audio/pcm' is accepted."
+ }
+ }
+ },
+ "429": {
+ "headers": {
+ "Content-Type": "application/json"
+ },
+ "body": {
+ "error": {
+ "code": "RateLimit",
+ "message": "Rate limit is exceeded."
+ }
+ }
+ },
+ "500": {
+ "headers": {
+ "Content-Type": "application/json"
+ },
+ "body": {
+ "error": {
+ "code": "InternalServerError",
+ "message": "Internal Server Error."
+ }
+ }
+ }
+ }
+}
diff --git a/specification/cognitiveservices/data-plane/SpeakerRecognition/Identification/preview/v2.0/examples/createProfile.json b/specification/cognitiveservices/data-plane/SpeakerRecognition/Identification/preview/v2.0/examples/createProfile.json
new file mode 100644
index 000000000000..f20460a77a87
--- /dev/null
+++ b/specification/cognitiveservices/data-plane/SpeakerRecognition/Identification/preview/v2.0/examples/createProfile.json
@@ -0,0 +1,95 @@
+{
+ "parameters": {
+ "Endpoint": "{Endpoint}",
+ "Content-Type": "application/json",
+ "Ocp-Apim-Subscription-Key": "{API key}",
+ "profileInfo": {
+ "locale": "en-us"
+ }
+ },
+ "responses": {
+ "201": {
+ "headers": {
+ "Content-Type": "application/json"
+ },
+ "body": {
+ "profileId": "49a36324-fc4b-4387-aa06-090cfbf0064f",
+ "locale": "en-US",
+ "enrollmentStatus": "Enrolling",
+ "createdDateTime": "2015-04-23T18:25:43.41Z",
+ "lastUpdatedDateTime": "2015-04-23T18:25:43.41Z",
+ "enrollmentsCount": 0,
+ "enrollmentsLength": 0,
+ "enrollmentsSpeechLength": 0,
+ "remainingEnrollmentsSpeechLength": 20,
+ "modelVersion": "2019-12-05"
+ }
+ },
+ "400": {
+ "headers": {
+ "Content-Type": "application/json"
+ },
+ "body": {
+ "error": {
+ "code": "InvalidRequest",
+ "message": "Request body is missing."
+ }
+ }
+ },
+ "401": {
+ "headers": {
+ "Content-Type": "application/json"
+ },
+ "body": {
+ "error": {
+ "code": "Unauthorized",
+ "message": "Request is not authorized. Make sure subscription key is included and valid."
+ }
+ }
+ },
+ "403": {
+ "headers": {
+ "Content-Type": "application/json"
+ },
+ "body": {
+ "error": {
+ "code": "Forbidden",
+ "message": "Maximum allowed number of profiles is 10,000."
+ }
+ }
+ },
+ "415": {
+ "headers": {
+ "Content-Type": "application/json"
+ },
+ "body": {
+ "error": {
+ "code": "UnsupportedMediaType",
+ "message": "Unsupported media type. Only 'application/JSON' is accepted."
+ }
+ }
+ },
+ "429": {
+ "headers": {
+ "Content-Type": "application/json"
+ },
+ "body": {
+ "error": {
+ "code": "RateLimit",
+ "message": "Rate limit is exceeded."
+ }
+ }
+ },
+ "500": {
+ "headers": {
+ "Content-Type": "application/json"
+ },
+ "body": {
+ "error": {
+ "code": "InternalServerError",
+ "message": "Internal Server Error."
+ }
+ }
+ }
+ }
+}
diff --git a/specification/cognitiveservices/data-plane/SpeakerRecognition/Identification/preview/v2.0/examples/deleteProfile.json b/specification/cognitiveservices/data-plane/SpeakerRecognition/Identification/preview/v2.0/examples/deleteProfile.json
new file mode 100644
index 000000000000..1af07b0b1a4f
--- /dev/null
+++ b/specification/cognitiveservices/data-plane/SpeakerRecognition/Identification/preview/v2.0/examples/deleteProfile.json
@@ -0,0 +1,48 @@
+{
+ "parameters": {
+ "Endpoint": "{Endpoint}",
+ "Content-Type": "application/json",
+ "Ocp-Apim-Subscription-Key": "{API key}",
+ "profileId": "49a36324-fc4b-4387-aa06-090cfbf0064f"
+ },
+ "responses": {
+ "204": {
+ "headers": {
+ "Content-Type": "application/json"
+ }
+ },
+ "401": {
+ "headers": {
+ "Content-Type": "application/json"
+ },
+ "body": {
+ "error": {
+ "code": "Unauthorized",
+ "message": "Request is not authorized. Make sure subscription key is included and valid."
+ }
+ }
+ },
+ "429": {
+ "headers": {
+ "Content-Type": "application/json"
+ },
+ "body": {
+ "error": {
+ "code": "RateLimit",
+ "message": "Rate limit is exceeded."
+ }
+ }
+ },
+ "500": {
+ "headers": {
+ "Content-Type": "application/json"
+ },
+ "body": {
+ "error": {
+ "code": "InternalServerError",
+ "message": "Internal Server Error."
+ }
+ }
+ }
+ }
+}
diff --git a/specification/cognitiveservices/data-plane/SpeakerRecognition/Identification/preview/v2.0/examples/fetchProfile.json b/specification/cognitiveservices/data-plane/SpeakerRecognition/Identification/preview/v2.0/examples/fetchProfile.json
new file mode 100644
index 000000000000..5ab27b08d95f
--- /dev/null
+++ b/specification/cognitiveservices/data-plane/SpeakerRecognition/Identification/preview/v2.0/examples/fetchProfile.json
@@ -0,0 +1,71 @@
+{
+ "parameters": {
+ "Endpoint": "{Endpoint}",
+ "Content-Type": "application/json",
+ "Ocp-Apim-Subscription-Key": "{API key}",
+ "profileId": "49a36324-fc4b-4387-aa06-090cfbf0064f"
+ },
+ "responses": {
+ "200": {
+ "headers": {
+ "Content-Type": "application/json"
+ },
+ "body": {
+ "profileId": "49a36324-fc4b-4387-aa06-090cfbf0064f",
+ "locale": "en-US",
+ "enrollmentStatus": "Enrolling",
+ "createdDateTime": "2015-04-23T18:25:43.41Z",
+ "lastUpdatedDateTime": "2015-04-23T19:34:51.52Z",
+ "enrollmentsCount": 1,
+ "enrollmentsLength": 1.83,
+ "enrollmentsSpeechLength": 1.35,
+ "remainingEnrollmentsSpeechLength": 18.65,
+ "modelVersion": "2019-12-05"
+ }
+ },
+ "401": {
+ "headers": {
+ "Content-Type": "application/json"
+ },
+ "body": {
+ "error": {
+ "code": "Unauthorized",
+ "message": "Request is not authorized. Make sure subscription key is included and valid."
+ }
+ }
+ },
+ "404": {
+ "headers": {
+ "Content-Type": "application/json"
+ },
+ "body": {
+ "error": {
+ "code": "Not Found",
+ "message": "Requested profile doesn't exist"
+ }
+ }
+ },
+ "429": {
+ "headers": {
+ "Content-Type": "application/json"
+ },
+ "body": {
+ "error": {
+ "code": "RateLimit",
+ "message": "Rate limit is exceeded."
+ }
+ }
+ },
+ "500": {
+ "headers": {
+ "Content-Type": "application/json"
+ },
+ "body": {
+ "error": {
+ "code": "InternalServerError",
+ "message": "Internal Server Error."
+ }
+ }
+ }
+ }
+}
diff --git a/specification/cognitiveservices/data-plane/SpeakerRecognition/Identification/preview/v2.0/examples/identifySingleSpeaker.json b/specification/cognitiveservices/data-plane/SpeakerRecognition/Identification/preview/v2.0/examples/identifySingleSpeaker.json
new file mode 100644
index 000000000000..927ec1be8ab0
--- /dev/null
+++ b/specification/cognitiveservices/data-plane/SpeakerRecognition/Identification/preview/v2.0/examples/identifySingleSpeaker.json
@@ -0,0 +1,99 @@
+{
+ "parameters": {
+ "Endpoint": "{Endpoint}",
+ "Content-Type": "audio/wav; codecs=audio/pcm",
+ "Ocp-Apim-Subscription-Key": "{API key}",
+ "profileIds": "3669fa29-1bf3-45ad-beea-6b348d058d7e,111f427c-3791-468f-b709-fcef7660fff9,0e196cd9-32d5-4883-8631-54a0e7c7cb3d,0e196cd9-32d5-4883-8631-54a0e7c7cb3d,726e57d9-04e0-4214-b482-7f786fa83560,f95189fd-1bf5-4485-9c2e-e5897e0c98ca",
+ "audioData": "{binary file date}"
+ },
+ "responses": {
+ "200": {
+ "headers": {
+ "Content-Type": "application/json"
+ },
+ "body": {
+ "identifiedProfile": {
+ "profileId": "111f427c-3791-468f-b709-fcef7660fff9",
+ "score": 0.63
+ },
+ "profilesRanking": [
+ {
+ "profileId": "111f427c-3791-468f-b709-fcef7660fff9",
+ "score": 0.63
+ },
+ {
+ "profileId": "3669fa29-1bf3-45ad-beea-6b348d058d7e",
+ "score": 0.49
+ },
+ {
+ "profileId": "0e196cd9-32d5-4883-8631-54a0e7c7cb3d",
+ "score": 0.4
+ },
+ {
+ "profileId": "726e57d9-04e0-4214-b482-7f786fa83560",
+ "score": 0.1
+ },
+ {
+ "profileId": "f95189fd-1bf5-4485-9c2e-e5897e0c98ca",
+ "score": 0.03
+ }
+ ]
+ }
+ },
+ "400": {
+ "headers": {
+ "Content-Type": "application/json"
+ },
+ "body": {
+ "error": {
+ "code": "InvalidRequest",
+ "message": "Profile is not enrolled."
+ }
+ }
+ },
+ "401": {
+ "headers": {
+ "Content-Type": "application/json"
+ },
+ "body": {
+ "error": {
+ "code": "Unauthorized",
+ "message": "Request is not authorized. Make sure subscription key is included and valid."
+ }
+ }
+ },
+ "415": {
+ "headers": {
+ "Content-Type": "application/json"
+ },
+ "body": {
+ "error": {
+ "code": "UnsupportedMediaType",
+ "message": "Unsupported media type. Only 'audio/wav; codecs=audio/pcm' is accepted."
+ }
+ }
+ },
+ "429": {
+ "headers": {
+ "Content-Type": "application/json"
+ },
+ "body": {
+ "error": {
+ "code": "RateLimit",
+ "message": "Rate limit is exceeded."
+ }
+ }
+ },
+ "500": {
+ "headers": {
+ "Content-Type": "application/json"
+ },
+ "body": {
+ "error": {
+ "code": "InternalServerError",
+ "message": "Internal Server Error."
+ }
+ }
+ }
+ }
+}
diff --git a/specification/cognitiveservices/data-plane/SpeakerRecognition/Identification/preview/v2.0/examples/listProfiles.json b/specification/cognitiveservices/data-plane/SpeakerRecognition/Identification/preview/v2.0/examples/listProfiles.json
new file mode 100644
index 000000000000..1e6916cfd8e0
--- /dev/null
+++ b/specification/cognitiveservices/data-plane/SpeakerRecognition/Identification/preview/v2.0/examples/listProfiles.json
@@ -0,0 +1,75 @@
+{
+ "parameters": {
+ "Endpoint": "{Endpoint}",
+ "Content-Type": "application/json",
+ "Ocp-Apim-Subscription-Key": "{API key}"
+ },
+ "responses": {
+ "200": {
+ "headers": {
+ "Content-Type": "application/json"
+ },
+ "body": {
+ "profiles": [
+ {
+ "profileId": "49a36324-fc4b-4387-aa06-090cfbf0064f",
+ "locale": "en-US",
+ "enrollmentStatus": "Enrolling",
+ "createdDateTime": "2015-04-23T18:25:43.41Z",
+ "lastUpdatedDateTime": "2015-04-23T19:34:51.52Z",
+ "enrollmentsCount": 1,
+ "enrollmentsLength": 1.83,
+ "enrollmentsSpeechLength": 1.35,
+ "remainingEnrollmentsSpeechLength": 18.65,
+ "modelVersion": "2019-12-05"
+ }
+ ],
+ "@nextLink": "https://{Endpoint}/text-independent/profiles?$top=35&$continuationToken=U21pdGg1QmVuOTk5"
+ }
+ },
+ "400": {
+ "headers": {
+ "Content-Type": "application/json"
+ },
+ "body": {
+ "error": {
+ "code": "InvalidArgument",
+ "message": "Invalid $top parameter value. Value should be positive integer in the range [1, 500]"
+ }
+ }
+ },
+ "401": {
+ "headers": {
+ "Content-Type": "application/json"
+ },
+ "body": {
+ "error": {
+ "code": "Unauthorized",
+ "message": "Request is not authorized. Make sure subscription key is included and valid."
+ }
+ }
+ },
+ "429": {
+ "headers": {
+ "Content-Type": "application/json"
+ },
+ "body": {
+ "error": {
+ "code": "RateLimit",
+ "message": "Rate limit is exceeded."
+ }
+ }
+ },
+ "500": {
+ "headers": {
+ "Content-Type": "application/json"
+ },
+ "body": {
+ "error": {
+ "code": "InternalServerError",
+ "message": "Internal Server Error."
+ }
+ }
+ }
+ }
+}
diff --git a/specification/cognitiveservices/data-plane/SpeakerRecognition/Identification/preview/v2.0/examples/resetProfile.json b/specification/cognitiveservices/data-plane/SpeakerRecognition/Identification/preview/v2.0/examples/resetProfile.json
new file mode 100644
index 000000000000..83389ad8eb82
--- /dev/null
+++ b/specification/cognitiveservices/data-plane/SpeakerRecognition/Identification/preview/v2.0/examples/resetProfile.json
@@ -0,0 +1,59 @@
+{
+ "parameters": {
+ "Endpoint": "{Endpoint}",
+ "Content-Type": "application/json",
+ "Ocp-Apim-Subscription-Key": "{API key}",
+ "profileId": "49a36324-fc4b-4387-aa06-090cfbf0064f"
+ },
+ "responses": {
+ "204": {
+ "headers": {
+ "Content-Type": "application/json"
+ }
+ },
+ "401": {
+ "headers": {
+ "Content-Type": "application/json"
+ },
+ "body": {
+ "error": {
+ "code": "Unauthorized",
+ "message": "Request is not authorized. Make sure subscription key is included and valid."
+ }
+ }
+ },
+ "404": {
+ "headers": {
+ "Content-Type": "application/json"
+ },
+ "body": {
+ "error": {
+ "code": "Not Found",
+ "message": "Requested profile doesn't exist"
+ }
+ }
+ },
+ "429": {
+ "headers": {
+ "Content-Type": "application/json"
+ },
+ "body": {
+ "error": {
+ "code": "RateLimit",
+ "message": "Rate limit is exceeded."
+ }
+ }
+ },
+ "500": {
+ "headers": {
+ "Content-Type": "application/json"
+ },
+ "body": {
+ "error": {
+ "code": "InternalServerError",
+ "message": "Internal Server Error."
+ }
+ }
+ }
+ }
+}
diff --git a/specification/cognitiveservices/data-plane/SpeakerRecognition/Identification/readme.md b/specification/cognitiveservices/data-plane/SpeakerRecognition/Identification/readme.md
new file mode 100644
index 000000000000..3b3cb7393249
--- /dev/null
+++ b/specification/cognitiveservices/data-plane/SpeakerRecognition/Identification/readme.md
@@ -0,0 +1,92 @@
+# Cognitive Services Speaker Recognition SDKs
+
+> see https://aka.ms/autorest
+
+Configuration for generating Speaker Verification SDK.
+
+``` yaml
+tag: identification_2_0_preview
+add-credentials: true
+openapi-type: data-plane
+```
+
+The current release for the Authoring Endpoint is `identification_2_0_preview`.
+
+# Releases
+
+## Identification 2.0
+These settings apply only when `--tag=identification_2_0_preview` is specified on the command line.
+
+``` yaml $(tag) == 'identification_2_0_preview'
+input-file: preview/v2.0/Identification.json
+```
+
+---
+
+# Code Generation
+
+
+## Swagger to SDK
+
+This section describes what SDK should be generated by the automatic system.
+This is not used by Autorest itself.
+
+``` yaml $(swagger-to-sdk)
+swagger-to-sdk:
+ - repo: azure-sdk-for-python
+ - repo: azure-sdk-for-js
+ - repo: azure-sdk-for-node
+```
+
+### CSharp Settings
+These settings apply only when `--csharp` is specified on the command line.
+``` yaml $(csharp)
+csharp:
+ sync-methods: None
+ license-header: MICROSOFT_MIT_NO_VERSION
+ azure-arm: false
+ namespace: Microsoft.Azure.CognitiveServices.speech.speaker.identification
+ output-folder: $(csharp-sdks-folder)/CognitiveServices/speech.speaker.identification/src/Generated
+ clear-output-folder: true
+```
+
+## Java
+
+These settings apply only when `--java` is specified on the command line.
+Please also specify `--azure-libraries-for-java-folder=`.
+
+``` yaml $(java)
+java:
+ azure-arm: true
+ namespace: com.microsoft.azure.cognitiveservices.speech.speaker.identification
+ license-header: MICROSOFT_MIT_NO_CODEGEN
+ payload-flattening-threshold: 1
+ output-folder: $(azure-libraries-for-java-folder)/cognitiveservices/data-plane/speech/speaker/identification
+ 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.
+
+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)/preview/v2.0/Identification.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/cognitiveservices/data-plane/SpeakerRecognition/Identification/readme.nodejs.md b/specification/cognitiveservices/data-plane/SpeakerRecognition/Identification/readme.nodejs.md
new file mode 100644
index 000000000000..8e7f4305b148
--- /dev/null
+++ b/specification/cognitiveservices/data-plane/SpeakerRecognition/Identification/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:
+ package-name: azure-cognitiveservices-speech-speaker-identification
+ output-folder: $(node-sdks-folder)/lib/services/speech/speaker/identification
+ azure-arm: false
+ generate-license-txt: true
+ generate-package-json: true
+ generate-readme-md: true
+```
diff --git a/specification/cognitiveservices/data-plane/SpeakerRecognition/Identification/readme.python.md b/specification/cognitiveservices/data-plane/SpeakerRecognition/Identification/readme.python.md
new file mode 100644
index 000000000000..f80705467b9c
--- /dev/null
+++ b/specification/cognitiveservices/data-plane/SpeakerRecognition/Identification/readme.python.md
@@ -0,0 +1,26 @@
+## Python
+
+These settings apply only when `--python` is specified on the command line.
+Please also specify `--python-sdks-folder=`.
+Use `--python-mode=update` if you already have a setup.py and just want to update the code itself.
+
+``` yaml $(python)
+python-mode: create
+python:
+ license-header: MICROSOFT_MIT_NO_VERSION
+ payload-flattening-threshold: 2
+ namespace: azure.cognitiveservices.speech.speaker.identification
+ package-name: azure-cognitiveservices-speech-speaker
+ clear-output-folder: true
+
+```
+``` yaml $(python) && $(python-mode) == 'update'
+python:
+ no-namespace-folders: true
+ output-folder: $(python-sdks-folder)/cognitiveservices/speech/speaker/identification
+```
+``` yaml $(python) && $(python-mode) == 'create'
+python:
+ basic-setup-py: true
+ output-folder: $(python-sdks-folder)/cognitiveservices/azure-cognitiveservices-speech-speaker
+```
diff --git a/specification/cognitiveservices/data-plane/SpeakerRecognition/Identification/readme.typescript.md b/specification/cognitiveservices/data-plane/SpeakerRecognition/Identification/readme.typescript.md
new file mode 100644
index 000000000000..f7fae2db4c68
--- /dev/null
+++ b/specification/cognitiveservices/data-plane/SpeakerRecognition/Identification/readme.typescript.md
@@ -0,0 +1,12 @@
+## TypeScript
+
+These settings apply only when `--typescript` is specified on the command line.
+Please also specify `--typescript-sdks-folder=`.
+
+``` yaml $(typescript)
+typescript:
+ package-name: "@azure/cognitiveservices-speaker-identification"
+ output-folder: "$(typescript-sdks-folder)/sdk/cognitiveservices/cognitiveservices-speaker-identification"
+ azure-arm: false
+ generate-metadata: true
+```
diff --git a/specification/cognitiveservices/data-plane/SpeakerRecognition/Verification/preview/v2.0/Verification.json b/specification/cognitiveservices/data-plane/SpeakerRecognition/Verification/preview/v2.0/Verification.json
new file mode 100644
index 000000000000..2530e8f3ea1c
--- /dev/null
+++ b/specification/cognitiveservices/data-plane/SpeakerRecognition/Verification/preview/v2.0/Verification.json
@@ -0,0 +1,1408 @@
+{
+ "swagger": "2.0",
+ "info": {
+ "title": "Speaker Verification API",
+ "version": "2.0",
+ "description": "This API is currently available in:\n\n* West US - westus.api.cognitive.microsoft.com"
+ },
+ "x-ms-parameterized-host": {
+ "hostTemplate": "{Endpoint}/speaker/verification/v2.0",
+ "useSchemePrefix": false,
+ "parameters": [
+ {
+ "$ref": "#/parameters/Endpoint"
+ }
+ ]
+ },
+ "schemes": [
+ "https"
+ ],
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "securityDefinitions": {
+ "apiKeyHeader": {
+ "type": "apiKey",
+ "name": "Ocp-Apim-Subscription-Key",
+ "in": "header"
+ }
+ },
+ "security": [
+ {
+ "apiKeyHeader": []
+ }
+ ],
+ "parameters": {
+ "Endpoint": {
+ "name": "Endpoint",
+ "description": "Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus.api.cognitive.microsoft.com).",
+ "x-ms-parameter-location": "client",
+ "required": true,
+ "type": "string",
+ "in": "path",
+ "x-ms-skip-url-encoding": true
+ },
+ "profileIdParam": {
+ "in": "path",
+ "name": "profileId",
+ "required": true,
+ "type": "string",
+ "format": "uuid",
+ "x-nullable": false,
+ "pattern": "^([0-9a-fA-F]){8}-?([0-9a-fA-F]){4}-?([0-9a-fA-F]){4}-?([0-9a-fA-F]){4}-?([0-9a-fA-F]){12}$",
+ "description": "Unique identifier for profile id (guid).",
+ "x-ms-parameter-location": "method"
+ },
+ "localeParam": {
+ "in": "path",
+ "name": "locale",
+ "required": true,
+ "type": "string",
+ "x-nullable": false,
+ "pattern": "^[a-zA-Z]{2}-?[a-zA-Z]{2}$",
+ "description": "A combination of language code and country code.",
+ "x-ms-parameter-location": "method"
+ }
+ },
+ "definitions": {
+ "ProfileId": {
+ "type": "string",
+ "pattern": "^([0-9a-fA-F]){8}-?([0-9a-fA-F]){4}-?([0-9a-fA-F]){4}-?([0-9a-fA-F]){4}-?([0-9a-fA-F]){12}$",
+ "description": "Unique identifier for profile id (guid).",
+ "format": "uuid",
+ "x-nullable": false,
+ "example": "49a36324-fc4b-4387-aa06-090cfbf0064f"
+ },
+ "Locale": {
+ "type": "string",
+ "pattern": "^[a-zA-Z]{2}-?[a-zA-Z]{2}$",
+ "description": "Language identifier consisting of a combination of language code and country code.",
+ "x-nullable": false,
+ "example": "en-US"
+ },
+ "EnrollmentStatus": {
+ "type": "string",
+ "description": "Status representing the current state of the profile. Available values are:\n* Enrolling: profile has no voice print and not ready for recognition requests.\n* Training: voice print of profile is being created and can’t be used for recognition at the moment.\n* Enrolled: profile has a voice print and ready for recognition requests.",
+ "enum": [
+ "Enrolling",
+ "Training",
+ "Enrolled"
+ ],
+ "x-ms-enum": {
+ "name": "TrainingStatusType",
+ "modelAsString": false
+ },
+ "example": "Enrolling"
+ },
+ "CreatedDateTime": {
+ "type": "string",
+ "description": "Profile creation datetime.",
+ "example": "2015-04-23T18:25:43.41Z"
+ },
+ "LastUpdatedDateTime": {
+ "type": "string",
+ "description": "Last datetime when the profile was updated.",
+ "example": "2015-04-23T19:34:51.52Z"
+ },
+ "EnrollmentsCount": {
+ "type": "integer",
+ "description": "Number of enrolment audios accepted for this profile.",
+ "example": 1
+ },
+ "EnrollmentsLength": {
+ "type": "number",
+ "description": "Total length of enrollment audios accepted for this profile in seconds.",
+ "example": 1.83
+ },
+ "EnrollmentsSpeechLength": {
+ "type": "number",
+ "description": "Summation of pure speech (which is the amount of audio after removing silence and non-speech segments) across all profile enrollments in seconds.",
+ "example": 1.35
+ },
+ "RemainingEnrollmentsCount": {
+ "type": "integer",
+ "description": "Number of enrollment audios needed to complete profile enrollment.",
+ "example": 2
+ },
+ "RemainingEnrollmentsSpeechLength": {
+ "type": "number",
+ "description": "Amount of pure speech (which is the amount of audio after removing silence and non-speech segments) needed to complete profile enrollment in seconds.",
+ "example": 18.65
+ },
+ "ModelVersion": {
+ "type": "string",
+ "pattern": "^\\d{4}-\\d{2}-\\d{2}$",
+ "description": "Date specifying the model assigned to this profile. Format is yyyy-mm-dd. If profile has no enrollments, this value will be empty.",
+ "example": "2019-12-05"
+ },
+ "LocaleInfo": {
+ "description": "Speaker profile locale",
+ "properties": {
+ "locale": {
+ "$ref": "#/definitions/Locale"
+ }
+ }
+ },
+ "TdProfileInfoList": {
+ "description": "Text-Dependent Speaker profile info list",
+ "properties": {
+ "profiles": {
+ "items": {
+ "$ref": "#/definitions/TdProfileInfo"
+ }
+ },
+ "@nextLink": {
+ "type": "string",
+ "example": "https://{Endpoint}/text-dependent/profiles?$top=35&$continuationToken=U21pdGg1QmVuOTk5"
+ }
+ }
+ },
+ "TdProfileInfo": {
+ "description": "Text-Dependent Speaker profile info",
+ "properties": {
+ "profileId": {
+ "$ref": "#/definitions/ProfileId"
+ },
+ "locale": {
+ "$ref": "#/definitions/Locale"
+ },
+ "enrollmentStatus": {
+ "$ref": "#/definitions/EnrollmentStatus"
+ },
+ "createdDateTime": {
+ "$ref": "#/definitions/CreatedDateTime"
+ },
+ "lastUpdatedDateTime": {
+ "$ref": "#/definitions/LastUpdatedDateTime"
+ },
+ "enrollmentsCount": {
+ "$ref": "#/definitions/EnrollmentsCount"
+ },
+ "enrollmentsLength": {
+ "$ref": "#/definitions/EnrollmentsLength"
+ },
+ "enrollmentsSpeechLength": {
+ "$ref": "#/definitions/EnrollmentsSpeechLength"
+ },
+ "remainingEnrollmentsCount": {
+ "$ref": "#/definitions/RemainingEnrollmentsCount"
+ },
+ "modelVersion": {
+ "$ref": "#/definitions/ModelVersion"
+ }
+ }
+ },
+ "TdEnrollmentInfo": {
+ "description": "Text-Dependent Speaker profile enrollment info",
+ "properties": {
+ "profileId": {
+ "$ref": "#/definitions/ProfileId"
+ },
+ "enrollmentStatus": {
+ "$ref": "#/definitions/EnrollmentStatus"
+ },
+ "enrollmentsCount": {
+ "$ref": "#/definitions/EnrollmentsCount"
+ },
+ "enrollmentsLength": {
+ "$ref": "#/definitions/EnrollmentsLength"
+ },
+ "enrollmentsSpeechLength": {
+ "$ref": "#/definitions/EnrollmentsSpeechLength"
+ },
+ "remainingEnrollmentsCount": {
+ "$ref": "#/definitions/RemainingEnrollmentsCount"
+ },
+ "passPhrase": {
+ "type": "string",
+ "description": "Passphrase associated with this enrollment.",
+ "example": "my voice is my passport verify me"
+ },
+ "audioLength": {
+ "type": "number",
+ "description": "This enrolment audio length in seconds.",
+ "example": 1.83
+ },
+ "audioSpeechLength": {
+ "type": "number",
+ "description": "This enrollment audio pure speech (which is the amount of audio after removing silence and non-speech segments) length in seconds.",
+ "example": 1.35
+ }
+ }
+ },
+ "TiProfileInfoList": {
+ "description": "Text-Independent Speaker profile info list",
+ "properties": {
+ "profiles": {
+ "items": {
+ "$ref": "#/definitions/TiProfileInfo"
+ }
+ },
+ "@nextLink": {
+ "type": "string",
+ "example": "https://{Endpoint}/text-independent/profiles?$top=35&$continuationToken=U21pdGg1QmVuOTk5"
+ }
+ }
+ },
+ "TiProfileInfo": {
+ "description": "Text-Independent Speaker profile info",
+ "properties": {
+ "profileId": {
+ "$ref": "#/definitions/ProfileId"
+ },
+ "locale": {
+ "$ref": "#/definitions/Locale"
+ },
+ "enrollmentStatus": {
+ "$ref": "#/definitions/EnrollmentStatus"
+ },
+ "createdDateTime": {
+ "$ref": "#/definitions/CreatedDateTime"
+ },
+ "lastUpdatedDateTime": {
+ "$ref": "#/definitions/LastUpdatedDateTime"
+ },
+ "enrollmentsCount": {
+ "$ref": "#/definitions/EnrollmentsCount"
+ },
+ "enrollmentsLength": {
+ "$ref": "#/definitions/EnrollmentsLength"
+ },
+ "enrollmentsSpeechLength": {
+ "$ref": "#/definitions/EnrollmentsSpeechLength"
+ },
+ "remainingEnrollmentsSpeechLength": {
+ "$ref": "#/definitions/RemainingEnrollmentsSpeechLength"
+ },
+ "modelVersion": {
+ "$ref": "#/definitions/ModelVersion"
+ }
+ }
+ },
+ "TiEnrollmentInfo": {
+ "description": "Text-Independent Speaker profile enrollment info",
+ "properties": {
+ "profileId": {
+ "$ref": "#/definitions/ProfileId"
+ },
+ "enrollmentStatus": {
+ "$ref": "#/definitions/EnrollmentStatus"
+ },
+ "enrollmentsCount": {
+ "$ref": "#/definitions/EnrollmentsCount"
+ },
+ "enrollmentsLength": {
+ "$ref": "#/definitions/EnrollmentsLength"
+ },
+ "enrollmentsSpeechLength": {
+ "$ref": "#/definitions/EnrollmentsSpeechLength"
+ },
+ "remainingEnrollmentsSpeechLength": {
+ "$ref": "#/definitions/RemainingEnrollmentsSpeechLength"
+ },
+ "audioLength": {
+ "type": "number",
+ "description": "This enrolment audio length in seconds.",
+ "example": 1.83
+ },
+ "audioSpeechLength": {
+ "type": "number",
+ "description": "This enrollment audio pure speech (which is the amount of audio after removing silence and non-speech segments) length in seconds.",
+ "example": 1.35
+ }
+ }
+ },
+ "RecognitionInfo": {
+ "description": "Speaker recognition result",
+ "properties": {
+ "recognitionResult": {
+ "type": "string",
+ "description": "Does audio belong to targeted profile?",
+ "enum": [
+ "accept",
+ "reject"
+ ],
+ "x-ms-enum": {
+ "name": "ResultType",
+ "modelAsString": false
+ },
+ "example": "Accept"
+ },
+ "score": {
+ "type": "number",
+ "description": "A float number indicating the similarity between input audio and targeted voice print. This number must be between 0 and 1. A higher number means higher similarity.",
+ "example": 0.63
+ }
+ }
+ },
+ "Error": {
+ "description": "Speaker error message",
+ "required": [
+ "error"
+ ],
+ "properties": {
+ "error": {
+ "properties": {
+ "code": {
+ "type": "string"
+ },
+ "message": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "NotFound": {
+ "description": "NotFound - Requested profile doesn't exist",
+ "schema": {
+ "$ref": "#/definitions/Error"
+ },
+ "examples": {
+ "application/json": {
+ "error": {
+ "code": "Not Found",
+ "message": "Requested profile doesn't exist"
+ }
+ }
+ },
+ "x-ms-error-response": true
+ },
+ "Unauthorized": {
+ "description": "Request is not authorized. Make sure subscription key is included and valid.",
+ "schema": {
+ "$ref": "#/definitions/Error"
+ },
+ "examples": {
+ "application/json": {
+ "error": {
+ "code": "Unauthorized",
+ "message": "Request is not authorized. Make sure subscription key is included and valid."
+ }
+ }
+ },
+ "x-ms-error-response": true
+ },
+ "RateLimit": {
+ "description": "Rate limit is exceeded.",
+ "schema": {
+ "$ref": "#/definitions/Error"
+ },
+ "examples": {
+ "application/json": {
+ "error": {
+ "code": "RateLimit",
+ "message": "Rate limit is exceeded."
+ }
+ }
+ },
+ "x-ms-error-response": true
+ },
+ "ServerError": {
+ "description": "Internal Server Error.",
+ "schema": {
+ "$ref": "#/definitions/Error"
+ },
+ "examples": {
+ "application/json": {
+ "error": {
+ "code": "InternalServerError",
+ "message": "Internal Server Error."
+ }
+ }
+ },
+ "x-ms-error-response": true
+ }
+ },
+ "paths": {
+ "/text-dependent/profiles": {
+ "post": {
+ "description": "Create a new speaker profile with specified locale.\nOne subscription can create 10,000 speaker profiles at most.",
+ "operationId": "TextDependent_CreateProfile",
+ "summary": "Create Profile",
+ "x-ms-examples": {
+ "Successful Query": {
+ "$ref": "./examples/textDependentCreateProfile.json"
+ }
+ },
+ "tags": [
+ "text-dependent"
+ ],
+ "parameters": [
+ {
+ "in": "body",
+ "name": "profileInfo",
+ "description": "Provide following detail info when creating a new profile.\nFields | Description\n------- | ------------\nlocale | Locale for the language of this speaker profile. A complete supported locale list is here:
**en-US**
",
+ "schema": {
+ "required": [
+ "locale"
+ ],
+ "$ref": "#/definitions/LocaleInfo"
+ }
+ }
+ ],
+ "responses": {
+ "201": {
+ "description": "Speaker profile created successfully. GUID is returned to reference the created profile.",
+ "headers": {
+ "Location": {
+ "type": "string",
+ "description": "url location of new resource"
+ }
+ },
+ "schema": {
+ "$ref": "#/definitions/TdProfileInfo"
+ }
+ },
+ "400": {
+ "description": "Bad Request\n* InvalidRequest - Request body is missing.\n* InvalidRequest - Invalid JSON format.\n* InvalidRequest - Locale parameter is missing.\n* InvalidArgument - Invalid locale value. Supported locales are {comma-separated list of locales}.",
+ "schema": {
+ "$ref": "#/definitions/Error"
+ },
+ "examples": {
+ "application/json": {
+ "error": {
+ "code": "InvalidRequest",
+ "message": "Request body is missing."
+ }
+ }
+ },
+ "x-ms-error-response": true
+ },
+ "401": {
+ "$ref": "#/responses/Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden - Maximum allowed number of profiles is 10,000.",
+ "schema": {
+ "$ref": "#/definitions/Error"
+ },
+ "examples": {
+ "application/json": {
+ "error": {
+ "code": "Forbidden",
+ "message": "Maximum allowed number of profiles is 10,000."
+ }
+ }
+ },
+ "x-ms-error-response": true
+ },
+ "415": {
+ "description": "UnsupportedMediaType - Unsupported media type. Only 'application/JSON' is accepted.",
+ "schema": {
+ "$ref": "#/definitions/Error"
+ },
+ "examples": {
+ "application/json": {
+ "error": {
+ "code": "UnsupportedMediaType",
+ "message": "Unsupported media type. Only 'application/JSON' is accepted."
+ }
+ }
+ },
+ "x-ms-error-response": true
+ },
+ "429": {
+ "$ref": "#/responses/RateLimit"
+ },
+ "500": {
+ "$ref": "#/responses/ServerError"
+ }
+ }
+ },
+ "get": {
+ "x-ms-pageable": {
+ "nextLinkName": "@nextLink",
+ "itemName": "profiles"
+ },
+ "description": "Retrieves a set of profiles.\nProfiles are sorted alphabetically by ProfileId",
+ "operationId": "TextDependent_ListProfiles",
+ "summary": "List Profiles",
+ "x-ms-examples": {
+ "Successful Query": {
+ "$ref": "./examples/textDependentListProfiles.json"
+ }
+ },
+ "tags": [
+ "text-dependent"
+ ],
+ "parameters": [
+ {
+ "in": "query",
+ "name": "$top",
+ "description": "The number of profiles to return. Default is 100 and the maximum is 500",
+ "type": "integer"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/TdProfileInfoList"
+ }
+ },
+ "400": {
+ "description": "Bad Request\n* InvalidArgument - Invalid $top parameter value. Value should be positive integer in the range [1, 500].\n* InvalidArgument - Invalid $continuationToken value. $continuationToken must be generated form a prior API call.\n* InvalidArgument - $filter parameter is not supported.\n* InvalidArgument - $skip parameter is not supported.\n* InvalidArgument - $orderBy parameter is not supported.\n* InvalidArgument - $delta parameter is not supported.",
+ "schema": {
+ "$ref": "#/definitions/Error"
+ },
+ "examples": {
+ "application/json": {
+ "error": {
+ "code": "InvalidArgument",
+ "message": "Invalid $top parameter value. Value should be positive integer in the range [1, 500]"
+ }
+ }
+ },
+ "x-ms-error-response": true
+ },
+ "401": {
+ "$ref": "#/responses/Unauthorized"
+ },
+ "429": {
+ "$ref": "#/responses/RateLimit"
+ },
+ "500": {
+ "$ref": "#/responses/ServerError"
+ }
+ }
+ }
+ },
+ "/text-dependent/profiles/{profileId}": {
+ "parameters": [
+ {
+ "$ref": "#/parameters/profileIdParam"
+ }
+ ],
+ "get": {
+ "description": "Retrieves a single profile by ID.",
+ "operationId": "TextDependent_GetProfile",
+ "summary": "Retrieve Single Profile",
+ "x-ms-examples": {
+ "Successful Query": {
+ "$ref": "./examples/textDependentFetchProfile.json"
+ }
+ },
+ "tags": [
+ "text-dependent"
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/TdProfileInfo"
+ }
+ },
+ "401": {
+ "$ref": "#/responses/Unauthorized"
+ },
+ "404": {
+ "$ref": "#/responses/NotFound"
+ },
+ "429": {
+ "$ref": "#/responses/RateLimit"
+ },
+ "500": {
+ "$ref": "#/responses/ServerError"
+ }
+ }
+ },
+ "delete": {
+ "description": "Deletes an existing profile.",
+ "operationId": "TextDependent_DeleteProfile",
+ "summary": "Delete Profile",
+ "x-ms-examples": {
+ "Successful Query": {
+ "$ref": "./examples/deleteProfile.json"
+ }
+ },
+ "tags": [
+ "text-dependent"
+ ],
+ "responses": {
+ "204": {
+ "description": "OK"
+ },
+ "401": {
+ "$ref": "#/responses/Unauthorized"
+ },
+ "429": {
+ "$ref": "#/responses/RateLimit"
+ },
+ "500": {
+ "$ref": "#/responses/ServerError"
+ }
+ }
+ }
+ },
+ "/text-dependent/profiles/{profileId}/reset": {
+ "parameters": [
+ {
+ "$ref": "#/parameters/profileIdParam"
+ }
+ ],
+ "post": {
+ "description": "Resets existing profile to its original creation state. The reset operation does the following:\n* Updates enrollmentStatus to Enrolling.\n* Updates lastUpdatedDateTime.\n* Updates enrollmentsCount to 0.\n* Updates enrollmentsLength to 0.\n* Updates enrollmentsSpeechLength to 0.\n* Updates remainingEnrollmentsCount to the initial required number.\n* Removes all associated enrollments from storage.\n* Removes chosen passphrase association.\n* Resets value of modelVersion.",
+ "operationId": "TextDependent_ResetProfile",
+ "summary": "Reset Profile",
+ "x-ms-examples": {
+ "Successful Query": {
+ "$ref": "./examples/resetProfile.json"
+ }
+ },
+ "tags": [
+ "text-dependent"
+ ],
+ "responses": {
+ "204": {
+ "description": "OK"
+ },
+ "401": {
+ "$ref": "#/responses/Unauthorized"
+ },
+ "404": {
+ "$ref": "#/responses/NotFound"
+ },
+ "429": {
+ "$ref": "#/responses/RateLimit"
+ },
+ "500": {
+ "$ref": "#/responses/ServerError"
+ }
+ }
+ }
+ },
+ "/text-dependent/profiles/{profileId}/enrollments": {
+ "parameters": [
+ {
+ "$ref": "#/parameters/profileIdParam"
+ }
+ ],
+ "post": {
+ "description": "Adds an enrollment to existing profile.\nIf the minimum number of requested enrollment audios is reached, a voice print is created.\nIf the voice print was created before, it gets recreated from all existing enrollment audios including the new one.\n\nLimitations:\n* Minimum audio input length per request is **1 second**\n* Maximum audio input length per request is **10 seconds**\n* Minimum number of enrollments for creating a voiceprint is **3**\n* Maximum number of enrollments for creating a voiceprint is **50**\n* Minimum audio Signal-to-noise ratio (SNR) is **10dB**\n\nConstraints:\n* First enrollment must match an existing passphrase.\n* All enrollments after the first one, must use the same passphrase used in the first enrollment.",
+ "operationId": "TextDependent_CreateEnrollment",
+ "summary": "Enroll Profile",
+ "x-ms-examples": {
+ "Successful Query": {
+ "$ref": "./examples/textDependentCreateEnrollment.json"
+ }
+ },
+ "tags": [
+ "text-dependent"
+ ],
+ "consumes": [
+ "audio/wav; codecs=audio/pcm"
+ ],
+ "parameters": [
+ {
+ "name": "audioData",
+ "in": "body",
+ "description": "Binary audio file. Supported formats are audio/wav; codecs=audio/pcm. Supports audio up to 5MB.",
+ "required": true,
+ "schema": {
+ "type": "object",
+ "format": "file"
+ }
+ }
+ ],
+ "responses": {
+ "201": {
+ "description": "Created",
+ "schema": {
+ "$ref": "#/definitions/TdEnrollmentInfo"
+ }
+ },
+ "400": {
+ "description": "Bad Request\n* InvalidRequest - Invalid audio length. Maximum allowed length is 10 seconds.\n* InvalidRequest - Invalid audio length. Minimum allowed length is 1 second.\n* InvalidRequest - Invalid audio format. Supported format is WAV 16Khz 16bit Mono PCM.\n* InvalidRequest - Invalid passphrase.\n* InvalidRequest - Audio is too noisy. The minimum allowed Signal-to-noise ratio (SNR) is 10dB.",
+ "schema": {
+ "$ref": "#/definitions/Error"
+ },
+ "examples": {
+ "application/json": {
+ "error": {
+ "code": "InvalidRequest",
+ "message": "Audio is too noisy."
+ }
+ }
+ },
+ "x-ms-error-response": true
+ },
+ "401": {
+ "$ref": "#/responses/Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden\n* InvalidOperation - Maximum allowed number of enrollments per profile is 50.",
+ "schema": {
+ "$ref": "#/definitions/Error"
+ },
+ "examples": {
+ "application/json": {
+ "error": {
+ "code": "InvalidOperation",
+ "message": "Maximum allowed number of enrollments per profile is 50."
+ }
+ }
+ },
+ "x-ms-error-response": true
+ },
+ "404": {
+ "$ref": "#/responses/NotFound"
+ },
+ "409": {
+ "description": "Conflict\n* Conflict - Sending concurrent requests on same profile is not allowed.",
+ "schema": {
+ "$ref": "#/definitions/Error"
+ },
+ "examples": {
+ "application/json": {
+ "error": {
+ "code": "Conflict",
+ "message": "Sending concurrent requests on same profile is not allowed."
+ }
+ }
+ },
+ "x-ms-error-response": true
+ },
+ "415": {
+ "description": "UnsupportedMediaType - Unsupported media type. Only \"audio/wav; codecs=audio/pcm\" is accepted.",
+ "schema": {
+ "$ref": "#/definitions/Error"
+ },
+ "examples": {
+ "application/json": {
+ "error": {
+ "code": "UnsupportedMediaType",
+ "message": "Unsupported media type. Only 'audio/wav; codecs=audio/pcm' is accepted."
+ }
+ }
+ },
+ "x-ms-error-response": true
+ },
+ "429": {
+ "$ref": "#/responses/RateLimit"
+ },
+ "500": {
+ "$ref": "#/responses/ServerError"
+ }
+ }
+ }
+ },
+ "/text-dependent/profiles/{profileId}/verify": {
+ "parameters": [
+ {
+ "$ref": "#/parameters/profileIdParam"
+ }
+ ],
+ "post": {
+ "description": "Verifies existing profiles against input audio.\n\nLimitations:\n* Minimum audio input length per request is **1 second**\n* Maximum audio input length per request is **10 seconds**\n* Minimum audio Signal-to-noise ratio (SNR) is **10 dB**",
+ "operationId": "TextDependent_VerifyProfile",
+ "summary": "Verify Profile",
+ "x-ms-examples": {
+ "Successful Query": {
+ "$ref": "./examples/verify.json"
+ }
+ },
+ "tags": [
+ "text-dependent"
+ ],
+ "consumes": [
+ "audio/wav; codecs=audio/pcm"
+ ],
+ "parameters": [
+ {
+ "name": "audioData",
+ "in": "body",
+ "description": "Binary audio file. Supported formats are audio/wav; codecs=audio/pcm. Supports audio up to 5MB.",
+ "required": true,
+ "schema": {
+ "type": "object",
+ "format": "file"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/RecognitionInfo"
+ }
+ },
+ "400": {
+ "description": "Bad Request\n* InvalidRequest - Invalid audio length. Maximum allowed length is 10 seconds.\n* InvalidRequest - Invalid audio length. Minimum allowed length is 1 second.\n* InvalidRequest - Invalid audio format. Supported format is 16Khz 16bit Mono PCM.\n* InvalidRequest - Audio is too noisy. The minimum allowed Signal-to-noise ratio (SNR) is 10dB.\n* InvalidRequest - Profile is not enrolled.",
+ "schema": {
+ "$ref": "#/definitions/Error"
+ },
+ "examples": {
+ "application/json": {
+ "error": {
+ "code": "InvalidRequest",
+ "message": "Profile is not enrolled."
+ }
+ }
+ },
+ "x-ms-error-response": true
+ },
+ "401": {
+ "$ref": "#/responses/Unauthorized"
+ },
+ "404": {
+ "$ref": "#/responses/NotFound"
+ },
+ "415": {
+ "description": "UnsupportedMediaType - Unsupported media type. Only \"audio/wav; codecs=audio/pcm\" is accepted.",
+ "schema": {
+ "$ref": "#/definitions/Error"
+ },
+ "examples": {
+ "application/json": {
+ "error": {
+ "code": "UnsupportedMediaType",
+ "message": "Unsupported media type. Only 'audio/wav; codecs=audio/pcm' is accepted."
+ }
+ }
+ },
+ "x-ms-error-response": true
+ },
+ "429": {
+ "$ref": "#/responses/RateLimit"
+ },
+ "500": {
+ "$ref": "#/responses/ServerError"
+ }
+ }
+ }
+ },
+ "/text-dependent/phrases/{locale}": {
+ "parameters": [
+ {
+ "$ref": "#/parameters/localeParam"
+ }
+ ],
+ "get": {
+ "description": "Retrieves list of supported passphrases for a specific locale.",
+ "operationId": "TextDependent_ListPhrases",
+ "summary": "Pass Phrases",
+ "x-ms-examples": {
+ "Successful Query": {
+ "$ref": "./examples/phrases.json"
+ }
+ },
+ "tags": [
+ "text-dependent"
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "items": {
+ "type": "string"
+ },
+ "example": [
+ "my voice is my passport verify me",
+ "my voice is stronger than passwords"
+ ]
+ }
+ },
+ "400": {
+ "description": "Bad Request\n* InvalidRequest - Locale parameter is missing.\n* InvalidArgument - Invalid locale value. Supported locales are {comma-separated list of locales}.",
+ "schema": {
+ "$ref": "#/definitions/Error"
+ },
+ "examples": {
+ "application/json": {
+ "error": {
+ "code": "InvalidRequest",
+ "message": "Locale parameter is missing."
+ }
+ }
+ },
+ "x-ms-error-response": true
+ },
+ "401": {
+ "$ref": "#/responses/Unauthorized"
+ },
+ "429": {
+ "$ref": "#/responses/RateLimit"
+ },
+ "500": {
+ "$ref": "#/responses/ServerError"
+ }
+ }
+ }
+ },
+ "/text-independent/profiles": {
+ "post": {
+ "description": "Creates a new speaker profile with specified locale.\nOne subscription can create 10,000 speaker profiles at most.",
+ "operationId": "TextIndependent_CreateProfile",
+ "summary": "Create Profile",
+ "x-ms-examples": {
+ "Successful Query": {
+ "$ref": "./examples/textIndependentCreateProfile.json"
+ }
+ },
+ "tags": [
+ "text-independent"
+ ],
+ "parameters": [
+ {
+ "in": "body",
+ "name": "profileInfo",
+ "description": "Provide following detail info when creating a new profile.\nFields | Description\n------- | ------------\nlocale | Locale for the language of this speaker profile. A complete supported locale list is here:
**en-US**
**es-ES**
**fr-FR**
**zh-CN**
**de-DE**
**en-GB**
**en-AU**
**en-CA**
**fr-CA**
**it-IT**
**es-MX**
**ja-JP**
**pt-BR**
**en-IN**
",
+ "schema": {
+ "required": [
+ "locale"
+ ],
+ "$ref": "#/definitions/LocaleInfo"
+ }
+ }
+ ],
+ "responses": {
+ "201": {
+ "description": "Speaker profile created successfully. GUID is returned to reference the created profile.",
+ "headers": {
+ "Location": {
+ "type": "string",
+ "description": "url location of new resource"
+ }
+ },
+ "schema": {
+ "$ref": "#/definitions/TiProfileInfo"
+ }
+ },
+ "400": {
+ "description": "Bad Request\n* InvalidRequest - Request body is missing.\n* InvalidRequest - Invalid JSON format.\n* InvalidRequest - Locale parameter is missing.\n* InvalidArgument - Invalid locale value. Supported locales are {comma-separated list of locales}.",
+ "schema": {
+ "$ref": "#/definitions/Error"
+ },
+ "examples": {
+ "application/json": {
+ "error": {
+ "code": "InvalidRequest",
+ "message": "Request body is missing."
+ }
+ }
+ },
+ "x-ms-error-response": true
+ },
+ "401": {
+ "$ref": "#/responses/Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden - Maximum allowed number of profiles is 10,000.",
+ "schema": {
+ "$ref": "#/definitions/Error"
+ },
+ "examples": {
+ "application/json": {
+ "error": {
+ "code": "Forbidden",
+ "message": "Maximum allowed number of profiles is 10,000."
+ }
+ }
+ },
+ "x-ms-error-response": true
+ },
+ "415": {
+ "description": "UnsupportedMediaType - Unsupported media type. Only 'application/JSON' is accepted.",
+ "schema": {
+ "$ref": "#/definitions/Error"
+ },
+ "examples": {
+ "application/json": {
+ "error": {
+ "code": "UnsupportedMediaType",
+ "message": "Unsupported media type. Only 'application/JSON' is accepted."
+ }
+ }
+ },
+ "x-ms-error-response": true
+ },
+ "429": {
+ "$ref": "#/responses/RateLimit"
+ },
+ "500": {
+ "$ref": "#/responses/ServerError"
+ }
+ }
+ },
+ "get": {
+ "x-ms-pageable": {
+ "nextLinkName": "@nextLink"
+ },
+ "description": "Retrieves a set of profiles.\nProfiles are sorted alphabetically by ProfileId",
+ "operationId": "TextIndependent_ListProfiles",
+ "summary": "List Profiles",
+ "x-ms-examples": {
+ "Successful Query": {
+ "$ref": "./examples/textIndependentListProfiles.json"
+ }
+ },
+ "tags": [
+ "text-independent"
+ ],
+ "parameters": [
+ {
+ "in": "query",
+ "name": "$top",
+ "description": "The number of profiles to return. Default is 100 and the maximum is 500",
+ "type": "integer"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/TiProfileInfoList"
+ }
+ },
+ "400": {
+ "description": "Bad Request\n* InvalidArgument - Invalid $top parameter value. Value should be positive integer in the range [1, 500].\n* InvalidArgument - Invalid $continuationToken value. $continuationToken must be generated form a prior API call.\n* InvalidArgument - $filter parameter is not supported.\n* InvalidArgument - $skip parameter is not supported.\n* InvalidArgument - $orderBy parameter is not supported.\n* InvalidArgument - $delta parameter is not supported.",
+ "schema": {
+ "$ref": "#/definitions/Error"
+ },
+ "examples": {
+ "application/json": {
+ "error": {
+ "code": "InvalidArgument",
+ "message": "Invalid $top parameter value. Value should be positive integer in the range [1, 500]"
+ }
+ }
+ },
+ "x-ms-error-response": true
+ },
+ "401": {
+ "$ref": "#/responses/Unauthorized"
+ },
+ "429": {
+ "$ref": "#/responses/RateLimit"
+ },
+ "500": {
+ "$ref": "#/responses/ServerError"
+ }
+ }
+ }
+ },
+ "/text-independent/profiles/{profileId}": {
+ "parameters": [
+ {
+ "$ref": "#/parameters/profileIdParam"
+ }
+ ],
+ "get": {
+ "description": "Retrieves a single profile by ID.",
+ "operationId": "TextIndependent_GetProfile",
+ "summary": "Retrieve Single Profile",
+ "x-ms-examples": {
+ "Successful Query": {
+ "$ref": "./examples/textIndependentFetchProfile.json"
+ }
+ },
+ "tags": [
+ "text-independent"
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/TiProfileInfo"
+ }
+ },
+ "401": {
+ "$ref": "#/responses/Unauthorized"
+ },
+ "404": {
+ "$ref": "#/responses/NotFound"
+ },
+ "429": {
+ "$ref": "#/responses/RateLimit"
+ },
+ "500": {
+ "$ref": "#/responses/ServerError"
+ }
+ }
+ },
+ "delete": {
+ "description": "Deletes an existing profile.",
+ "operationId": "TextIndependent_DeleteProfile",
+ "summary": "Delete Profile",
+ "x-ms-examples": {
+ "Successful Query": {
+ "$ref": "./examples/deleteProfile.json"
+ }
+ },
+ "tags": [
+ "text-independent"
+ ],
+ "responses": {
+ "204": {
+ "description": "OK"
+ },
+ "401": {
+ "$ref": "#/responses/Unauthorized"
+ },
+ "429": {
+ "$ref": "#/responses/RateLimit"
+ },
+ "500": {
+ "$ref": "#/responses/ServerError"
+ }
+ }
+ }
+ },
+ "/text-independent/profiles/{profileId}/reset": {
+ "parameters": [
+ {
+ "$ref": "#/parameters/profileIdParam"
+ }
+ ],
+ "post": {
+ "description": "Resets existing profile to its original creation state. The reset operation does the following:\n* Updates enrollmentStatus to Enrolling.\n* Updates lastUpdatedDateTime.\n* Updates enrollmentsCount to 0.\n* Updates enrollmentsLength to 0.\n* Updates enrollmentsSpeechLength to 0.\n* Updates remainingEnrollmentsSpeechLength to the required number.\n* Removes all associated enrollments from storage.\n* Removes chosen passphrase association.\n* Resets value of modelVersion.",
+ "operationId": "TextIndependent_ResetProfile",
+ "summary": "Reset Profile",
+ "x-ms-examples": {
+ "Successful Query": {
+ "$ref": "./examples/resetProfile.json"
+ }
+ },
+ "tags": [
+ "text-independent"
+ ],
+ "responses": {
+ "204": {
+ "description": "OK"
+ },
+ "401": {
+ "$ref": "#/responses/Unauthorized"
+ },
+ "404": {
+ "$ref": "#/responses/NotFound"
+ },
+ "429": {
+ "$ref": "#/responses/RateLimit"
+ },
+ "500": {
+ "$ref": "#/responses/ServerError"
+ }
+ }
+ }
+ },
+ "/text-independent/profiles/{profileId}/enrollments": {
+ "parameters": [
+ {
+ "$ref": "#/parameters/profileIdParam"
+ }
+ ],
+ "post": {
+ "description": "Adds enrollments to existing profile.\nIf the minimum number of requested enrollment audios is reached, a voice print is created.\nIf the voice print was created before, it gets recreated from all existing enrollment including the new one.\n\nLimitations:\n* Minimum audio input length per request is **1 second**\n* Maximum audio input length per request is **120 seconds**\n* Minimum total effective speech length (excluding silence and other non-speech frames) for creating a voiceprint is **20 seconds**\n This limitation can be disabled by setting \"ignoreMinLength\" to **true**.\n\n* Maximum total audio input length allowed for creating a voiceprint is **300 seconds**\n* Minimum audio Signal-to-noise ratio (SNR) is **0dB**",
+ "operationId": "TextIndependent_CreateEnrollment",
+ "summary": "Enroll Profile",
+ "x-ms-examples": {
+ "Successful Query": {
+ "$ref": "./examples/textIndependentCreateEnrollment.json"
+ }
+ },
+ "tags": [
+ "text-independent"
+ ],
+ "consumes": [
+ "audio/wav; codecs=audio/pcm"
+ ],
+ "parameters": [
+ {
+ "in": "query",
+ "name": "ignoreMinLength",
+ "type": "boolean",
+ "description": "If true, a voice print will be created immediately for this profile regardless of how much speech is supplied or stored. Default is false."
+ },
+ {
+ "name": "audioData",
+ "in": "body",
+ "description": "Binary audio file. Supported formats are audio/wav; codecs=audio/pcm. Supports audio up to 5MB.",
+ "required": true,
+ "schema": {
+ "type": "object",
+ "format": "file"
+ }
+ }
+ ],
+ "responses": {
+ "201": {
+ "description": "Created",
+ "schema": {
+ "$ref": "#/definitions/TiEnrollmentInfo"
+ }
+ },
+ "400": {
+ "description": "Bad Request\n* InvalidRequest - Invalid audio length. Maximum allowed length per enrollment request is 120 seconds.\n* InvalidRequest - Invalid audio length. Minimum allowed length per enrollment request is 1 second.\n* InvalidRequest - Invalid audio format. Supported format is 16Khz 16bit Mono PCM.\n* InvalidArgument - Invalid ignoreMinLength parameter value. Valid values are \"true\" and \"false\".\n* InvalidRequest - Audio is too noisy. The minimum allowed Signal-to-noise ratio (SNR) is 0dB.",
+ "schema": {
+ "$ref": "#/definitions/Error"
+ },
+ "examples": {
+ "application/json": {
+ "error": {
+ "code": "InvalidRequest",
+ "message": "Audio is too noisy."
+ }
+ }
+ },
+ "x-ms-error-response": true
+ },
+ "401": {
+ "$ref": "#/responses/Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden\n* InvalidRequest - Maximum allowed length across all profile enrollments is 300 seconds.",
+ "schema": {
+ "$ref": "#/definitions/Error"
+ },
+ "examples": {
+ "application/json": {
+ "error": {
+ "code": "InvalidRequest",
+ "message": "Maximum allowed length across all profile enrollments is 300 seconds."
+ }
+ }
+ },
+ "x-ms-error-response": true
+ },
+ "404": {
+ "$ref": "#/responses/NotFound"
+ },
+ "409": {
+ "description": "Conflict\n* Conflict - Sending concurrent requests on same profile is not allowed.",
+ "schema": {
+ "$ref": "#/definitions/Error"
+ },
+ "examples": {
+ "application/json": {
+ "error": {
+ "code": "Conflict",
+ "message": "Sending concurrent requests on same profile is not allowed."
+ }
+ }
+ },
+ "x-ms-error-response": true
+ },
+ "415": {
+ "description": "UnsupportedMediaType - Unsupported media type. Only \"audio/wav; codecs=audio/pcm\" is accepted.",
+ "schema": {
+ "$ref": "#/definitions/Error"
+ },
+ "examples": {
+ "application/json": {
+ "error": {
+ "code": "UnsupportedMediaType",
+ "message": "Unsupported media type. Only 'audio/wav; codecs=audio/pcm' is accepted."
+ }
+ }
+ },
+ "x-ms-error-response": true
+ },
+ "429": {
+ "$ref": "#/responses/RateLimit"
+ },
+ "500": {
+ "$ref": "#/responses/ServerError"
+ }
+ }
+ }
+ },
+ "/text-independent/profiles/{profileId}/verify": {
+ "parameters": [
+ {
+ "$ref": "#/parameters/profileIdParam"
+ }
+ ],
+ "post": {
+ "description": "Verifies existing profiles against input audio.\n\nLimitations:\n* Minimum audio input length is **1 second**\n* Maximum audio input length is **120 seconds**\n* Minimum effective speech length (excluding silence and other \"non-speech\" frames) is **4 seconds**\n This limitation can be disabled by setting \"ignoreMinLength\" to **true**.\n* Minimum audio Signal-to-noise ratio (SNR) is **0dB**",
+ "operationId": "TextIndependent_VerifyProfile",
+ "summary": "Verify Profile",
+ "x-ms-examples": {
+ "Successful Query": {
+ "$ref": "./examples/verify.json"
+ }
+ },
+ "tags": [
+ "text-independent"
+ ],
+ "consumes": [
+ "audio/wav; codecs=audio/pcm"
+ ],
+ "parameters": [
+ {
+ "in": "query",
+ "name": "ignoreMinLength",
+ "type": "boolean",
+ "description": "If true, a voice print will be created immediately for this profile regardless of how much speech is supplied or stored. Default is false."
+ },
+ {
+ "name": "audioData",
+ "in": "body",
+ "description": "Binary audio file. Supported formats are audio/wav; codecs=audio/pcm. Supports audio up to 5MB.",
+ "required": true,
+ "schema": {
+ "type": "object",
+ "format": "file"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/RecognitionInfo"
+ }
+ },
+ "400": {
+ "description": "Bad Request\n* InvalidRequest - Invalid audio length. Maximum allowed length per recognition request is 120 seconds.\n* InvalidRequest - Invalid audio length. Minimum allowed length per recognition request is 1 second.\n* InvalidRequest - Invalid audio format. Supported format is 16Khz 16bit Mono PCM.\n* InvalidArgument - Invalid ignoreMinLength parameter value. Valid values are \"true\" and \"false\".\n* InvalidRequest - Profile is not enrolled.",
+ "schema": {
+ "$ref": "#/definitions/Error"
+ },
+ "examples": {
+ "application/json": {
+ "error": {
+ "code": "InvalidRequest",
+ "message": "Profile is not enrolled."
+ }
+ }
+ },
+ "x-ms-error-response": true
+ },
+ "401": {
+ "$ref": "#/responses/Unauthorized"
+ },
+ "404": {
+ "$ref": "#/responses/NotFound"
+ },
+ "415": {
+ "description": "UnsupportedMediaType - Unsupported media type. Only \"audio/wav; codecs=audio/pcm\" is accepted.",
+ "schema": {
+ "$ref": "#/definitions/Error"
+ },
+ "examples": {
+ "application/json": {
+ "error": {
+ "code": "UnsupportedMediaType",
+ "message": "Unsupported media type. Only 'audio/wav; codecs=audio/pcm' is accepted."
+ }
+ }
+ },
+ "x-ms-error-response": true
+ },
+ "429": {
+ "$ref": "#/responses/RateLimit"
+ },
+ "500": {
+ "$ref": "#/responses/ServerError"
+ }
+ }
+ }
+ }
+ },
+ "tags": []
+}
diff --git a/specification/cognitiveservices/data-plane/SpeakerRecognition/Verification/preview/v2.0/examples/deleteProfile.json b/specification/cognitiveservices/data-plane/SpeakerRecognition/Verification/preview/v2.0/examples/deleteProfile.json
new file mode 100644
index 000000000000..1af07b0b1a4f
--- /dev/null
+++ b/specification/cognitiveservices/data-plane/SpeakerRecognition/Verification/preview/v2.0/examples/deleteProfile.json
@@ -0,0 +1,48 @@
+{
+ "parameters": {
+ "Endpoint": "{Endpoint}",
+ "Content-Type": "application/json",
+ "Ocp-Apim-Subscription-Key": "{API key}",
+ "profileId": "49a36324-fc4b-4387-aa06-090cfbf0064f"
+ },
+ "responses": {
+ "204": {
+ "headers": {
+ "Content-Type": "application/json"
+ }
+ },
+ "401": {
+ "headers": {
+ "Content-Type": "application/json"
+ },
+ "body": {
+ "error": {
+ "code": "Unauthorized",
+ "message": "Request is not authorized. Make sure subscription key is included and valid."
+ }
+ }
+ },
+ "429": {
+ "headers": {
+ "Content-Type": "application/json"
+ },
+ "body": {
+ "error": {
+ "code": "RateLimit",
+ "message": "Rate limit is exceeded."
+ }
+ }
+ },
+ "500": {
+ "headers": {
+ "Content-Type": "application/json"
+ },
+ "body": {
+ "error": {
+ "code": "InternalServerError",
+ "message": "Internal Server Error."
+ }
+ }
+ }
+ }
+}
diff --git a/specification/cognitiveservices/data-plane/SpeakerRecognition/Verification/preview/v2.0/examples/phrases.json b/specification/cognitiveservices/data-plane/SpeakerRecognition/Verification/preview/v2.0/examples/phrases.json
new file mode 100644
index 000000000000..5bfd15a05c0d
--- /dev/null
+++ b/specification/cognitiveservices/data-plane/SpeakerRecognition/Verification/preview/v2.0/examples/phrases.json
@@ -0,0 +1,63 @@
+{
+ "parameters": {
+ "Endpoint": "{Endpoint}",
+ "Content-Type": "application/json",
+ "locale": "en-US",
+ "Ocp-Apim-Subscription-Key": "{API key}"
+ },
+ "responses": {
+ "200": {
+ "headers": {
+ "Content-Type": "application/json"
+ },
+ "body": [
+ "my voice is my passport verify me",
+ "my voice is stronger than passwords"
+ ]
+ },
+ "400": {
+ "headers": {
+ "Content-Type": "application/json"
+ },
+ "body": {
+ "error": {
+ "code": "InvalidRequest",
+ "message": "Locale parameter is missing."
+ }
+ }
+ },
+ "401": {
+ "headers": {
+ "Content-Type": "application/json"
+ },
+ "body": {
+ "error": {
+ "code": "Unauthorized",
+ "message": "Request is not authorized. Make sure subscription key is included and valid."
+ }
+ }
+ },
+ "429": {
+ "headers": {
+ "Content-Type": "application/json"
+ },
+ "body": {
+ "error": {
+ "code": "RateLimit",
+ "message": "Rate limit is exceeded."
+ }
+ }
+ },
+ "500": {
+ "headers": {
+ "Content-Type": "application/json"
+ },
+ "body": {
+ "error": {
+ "code": "InternalServerError",
+ "message": "Internal Server Error."
+ }
+ }
+ }
+ }
+}
diff --git a/specification/cognitiveservices/data-plane/SpeakerRecognition/Verification/preview/v2.0/examples/resetProfile.json b/specification/cognitiveservices/data-plane/SpeakerRecognition/Verification/preview/v2.0/examples/resetProfile.json
new file mode 100644
index 000000000000..83389ad8eb82
--- /dev/null
+++ b/specification/cognitiveservices/data-plane/SpeakerRecognition/Verification/preview/v2.0/examples/resetProfile.json
@@ -0,0 +1,59 @@
+{
+ "parameters": {
+ "Endpoint": "{Endpoint}",
+ "Content-Type": "application/json",
+ "Ocp-Apim-Subscription-Key": "{API key}",
+ "profileId": "49a36324-fc4b-4387-aa06-090cfbf0064f"
+ },
+ "responses": {
+ "204": {
+ "headers": {
+ "Content-Type": "application/json"
+ }
+ },
+ "401": {
+ "headers": {
+ "Content-Type": "application/json"
+ },
+ "body": {
+ "error": {
+ "code": "Unauthorized",
+ "message": "Request is not authorized. Make sure subscription key is included and valid."
+ }
+ }
+ },
+ "404": {
+ "headers": {
+ "Content-Type": "application/json"
+ },
+ "body": {
+ "error": {
+ "code": "Not Found",
+ "message": "Requested profile doesn't exist"
+ }
+ }
+ },
+ "429": {
+ "headers": {
+ "Content-Type": "application/json"
+ },
+ "body": {
+ "error": {
+ "code": "RateLimit",
+ "message": "Rate limit is exceeded."
+ }
+ }
+ },
+ "500": {
+ "headers": {
+ "Content-Type": "application/json"
+ },
+ "body": {
+ "error": {
+ "code": "InternalServerError",
+ "message": "Internal Server Error."
+ }
+ }
+ }
+ }
+}
diff --git a/specification/cognitiveservices/data-plane/SpeakerRecognition/Verification/preview/v2.0/examples/textDependentCreateEnrollment.json b/specification/cognitiveservices/data-plane/SpeakerRecognition/Verification/preview/v2.0/examples/textDependentCreateEnrollment.json
new file mode 100644
index 000000000000..6208e8e8a0d3
--- /dev/null
+++ b/specification/cognitiveservices/data-plane/SpeakerRecognition/Verification/preview/v2.0/examples/textDependentCreateEnrollment.json
@@ -0,0 +1,115 @@
+{
+ "parameters": {
+ "Endpoint": "{Endpoint}",
+ "Content-Type": "audio/wav; codecs=audio/pcm",
+ "Ocp-Apim-Subscription-Key": "{API key}",
+ "profileId": "49a36324-fc4b-4387-aa06-090cfbf0064f",
+ "audioData": "{binary file date}"
+ },
+ "responses": {
+ "201": {
+ "headers": {
+ "Content-Type": "application/json"
+ },
+ "body": {
+ "profileId": "49a36324-fc4b-4387-aa06-090cfbf0064f",
+ "enrollmentStatus": "Enrolling",
+ "enrollmentsCount": 1,
+ "enrollmentsLength": 1.83,
+ "enrollmentsSpeechLength": 1.35,
+ "remainingEnrollmentsCount": 2,
+ "passPhrase": "my voice is my passport verify me",
+ "audioLength": 1.83,
+ "audioSpeechLength": 1.35
+ }
+ },
+ "400": {
+ "headers": {
+ "Content-Type": "application/json"
+ },
+ "body": {
+ "error": {
+ "code": "InvalidRequest",
+ "message": "Audio is too noisy."
+ }
+ }
+ },
+ "401": {
+ "headers": {
+ "Content-Type": "application/json"
+ },
+ "body": {
+ "error": {
+ "code": "Unauthorized",
+ "message": "Request is not authorized. Make sure subscription key is included and valid."
+ }
+ }
+ },
+ "403": {
+ "headers": {
+ "Content-Type": "application/json"
+ },
+ "body": {
+ "error": {
+ "code": "InvalidRequest",
+ "message": "Maximum allowed length across all profile enrollments is 300 seconds."
+ }
+ }
+ },
+ "404": {
+ "headers": {
+ "Content-Type": "application/json"
+ },
+ "body": {
+ "error": {
+ "code": "Not Found",
+ "message": "Requested profile doesn't exist"
+ }
+ }
+ },
+ "409": {
+ "headers": {
+ "Content-Type": "application/json"
+ },
+ "body": {
+ "error": {
+ "code": "Conflict",
+ "message": "Sending concurrent requests on same profile is not allowed."
+ }
+ }
+ },
+ "415": {
+ "headers": {
+ "Content-Type": "application/json"
+ },
+ "body": {
+ "error": {
+ "code": "UnsupportedMediaType",
+ "message": "Unsupported media type. Only 'audio/wav; codecs=audio/pcm' is accepted."
+ }
+ }
+ },
+ "429": {
+ "headers": {
+ "Content-Type": "application/json"
+ },
+ "body": {
+ "error": {
+ "code": "RateLimit",
+ "message": "Rate limit is exceeded."
+ }
+ }
+ },
+ "500": {
+ "headers": {
+ "Content-Type": "application/json"
+ },
+ "body": {
+ "error": {
+ "code": "InternalServerError",
+ "message": "Internal Server Error."
+ }
+ }
+ }
+ }
+}
diff --git a/specification/cognitiveservices/data-plane/SpeakerRecognition/Verification/preview/v2.0/examples/textDependentCreateProfile.json b/specification/cognitiveservices/data-plane/SpeakerRecognition/Verification/preview/v2.0/examples/textDependentCreateProfile.json
new file mode 100644
index 000000000000..823a2804f5ee
--- /dev/null
+++ b/specification/cognitiveservices/data-plane/SpeakerRecognition/Verification/preview/v2.0/examples/textDependentCreateProfile.json
@@ -0,0 +1,95 @@
+{
+ "parameters": {
+ "Endpoint": "{Endpoint}",
+ "Content-Type": "application/json",
+ "Ocp-Apim-Subscription-Key": "{API key}",
+ "profileInfo": {
+ "locale": "en-us"
+ }
+ },
+ "responses": {
+ "201": {
+ "headers": {
+ "Content-Type": "application/json"
+ },
+ "body": {
+ "profileId": "49a36324-fc4b-4387-aa06-090cfbf0064f",
+ "locale": "en-US",
+ "enrollmentStatus": "Enrolling",
+ "createdDateTime": "2015-04-23T18:25:43.41Z",
+ "lastUpdatedDateTime": "2015-04-23T18:25:43.41Z",
+ "enrollmentsCount": 0,
+ "enrollmentsLength": 0,
+ "enrollmentsSpeechLength": 0,
+ "remainingEnrollmentsCount": 3,
+ "modelVersion": "2019-12-05"
+ }
+ },
+ "400": {
+ "headers": {
+ "Content-Type": "application/json"
+ },
+ "body": {
+ "error": {
+ "code": "InvalidRequest",
+ "message": "Request body is missing."
+ }
+ }
+ },
+ "401": {
+ "headers": {
+ "Content-Type": "application/json"
+ },
+ "body": {
+ "error": {
+ "code": "Unauthorized",
+ "message": "Request is not authorized. Make sure subscription key is included and valid."
+ }
+ }
+ },
+ "403": {
+ "headers": {
+ "Content-Type": "application/json"
+ },
+ "body": {
+ "error": {
+ "code": "Forbidden",
+ "message": "Maximum allowed number of profiles is 10,000."
+ }
+ }
+ },
+ "415": {
+ "headers": {
+ "Content-Type": "application/json"
+ },
+ "body": {
+ "error": {
+ "code": "UnsupportedMediaType",
+ "message": "Unsupported media type. Only 'application/JSON' is accepted."
+ }
+ }
+ },
+ "429": {
+ "headers": {
+ "Content-Type": "application/json"
+ },
+ "body": {
+ "error": {
+ "code": "RateLimit",
+ "message": "Rate limit is exceeded."
+ }
+ }
+ },
+ "500": {
+ "headers": {
+ "Content-Type": "application/json"
+ },
+ "body": {
+ "error": {
+ "code": "InternalServerError",
+ "message": "Internal Server Error."
+ }
+ }
+ }
+ }
+}
diff --git a/specification/cognitiveservices/data-plane/SpeakerRecognition/Verification/preview/v2.0/examples/textDependentFetchProfile.json b/specification/cognitiveservices/data-plane/SpeakerRecognition/Verification/preview/v2.0/examples/textDependentFetchProfile.json
new file mode 100644
index 000000000000..a21e8bdf6c5a
--- /dev/null
+++ b/specification/cognitiveservices/data-plane/SpeakerRecognition/Verification/preview/v2.0/examples/textDependentFetchProfile.json
@@ -0,0 +1,71 @@
+{
+ "parameters": {
+ "Endpoint": "{Endpoint}",
+ "Content-Type": "application/json",
+ "Ocp-Apim-Subscription-Key": "{API key}",
+ "profileId": "49a36324-fc4b-4387-aa06-090cfbf0064f"
+ },
+ "responses": {
+ "200": {
+ "headers": {
+ "Content-Type": "application/json"
+ },
+ "body": {
+ "profileId": "49a36324-fc4b-4387-aa06-090cfbf0064f",
+ "locale": "en-US",
+ "enrollmentStatus": "Enrolling",
+ "createdDateTime": "2015-04-23T18:25:43.41Z",
+ "lastUpdatedDateTime": "2015-04-23T19:34:51.52Z",
+ "enrollmentsCount": 1,
+ "enrollmentsLength": 1.83,
+ "enrollmentsSpeechLength": 1.35,
+ "remainingEnrollmentsCount": 2,
+ "modelVersion": "2019-12-05"
+ }
+ },
+ "401": {
+ "headers": {
+ "Content-Type": "application/json"
+ },
+ "body": {
+ "error": {
+ "code": "Unauthorized",
+ "message": "Request is not authorized. Make sure subscription key is included and valid."
+ }
+ }
+ },
+ "404": {
+ "headers": {
+ "Content-Type": "application/json"
+ },
+ "body": {
+ "error": {
+ "code": "Not Found",
+ "message": "Requested profile doesn't exist"
+ }
+ }
+ },
+ "429": {
+ "headers": {
+ "Content-Type": "application/json"
+ },
+ "body": {
+ "error": {
+ "code": "RateLimit",
+ "message": "Rate limit is exceeded."
+ }
+ }
+ },
+ "500": {
+ "headers": {
+ "Content-Type": "application/json"
+ },
+ "body": {
+ "error": {
+ "code": "InternalServerError",
+ "message": "Internal Server Error."
+ }
+ }
+ }
+ }
+}
diff --git a/specification/cognitiveservices/data-plane/SpeakerRecognition/Verification/preview/v2.0/examples/textDependentListProfiles.json b/specification/cognitiveservices/data-plane/SpeakerRecognition/Verification/preview/v2.0/examples/textDependentListProfiles.json
new file mode 100644
index 000000000000..7126a6fc2a2b
--- /dev/null
+++ b/specification/cognitiveservices/data-plane/SpeakerRecognition/Verification/preview/v2.0/examples/textDependentListProfiles.json
@@ -0,0 +1,75 @@
+{
+ "parameters": {
+ "Endpoint": "{Endpoint}",
+ "Content-Type": "application/json",
+ "Ocp-Apim-Subscription-Key": "{API key}"
+ },
+ "responses": {
+ "200": {
+ "headers": {
+ "Content-Type": "application/json"
+ },
+ "body": {
+ "profiles": [
+ {
+ "profileId": "49a36324-fc4b-4387-aa06-090cfbf0064f",
+ "locale": "en-US",
+ "enrollmentStatus": "Enrolling",
+ "createdDateTime": "2015-04-23T18:25:43.41Z",
+ "lastUpdatedDateTime": "2015-04-23T19:34:51.52Z",
+ "enrollmentsCount": 1,
+ "enrollmentsLength": 1.83,
+ "enrollmentsSpeechLength": 1.35,
+ "remainingEnrollmentsCount": 2,
+ "modelVersion": "2019-12-05"
+ }
+ ],
+ "@nextLink": "https://{Endpoint}/text-independent/profiles?$top=35&$continuationToken=U21pdGg1QmVuOTk5"
+ }
+ },
+ "400": {
+ "headers": {
+ "Content-Type": "application/json"
+ },
+ "body": {
+ "error": {
+ "code": "InvalidArgument",
+ "message": "Invalid $top parameter value. Value should be positive integer in the range [1, 500]"
+ }
+ }
+ },
+ "401": {
+ "headers": {
+ "Content-Type": "application/json"
+ },
+ "body": {
+ "error": {
+ "code": "Unauthorized",
+ "message": "Request is not authorized. Make sure subscription key is included and valid."
+ }
+ }
+ },
+ "429": {
+ "headers": {
+ "Content-Type": "application/json"
+ },
+ "body": {
+ "error": {
+ "code": "RateLimit",
+ "message": "Rate limit is exceeded."
+ }
+ }
+ },
+ "500": {
+ "headers": {
+ "Content-Type": "application/json"
+ },
+ "body": {
+ "error": {
+ "code": "InternalServerError",
+ "message": "Internal Server Error."
+ }
+ }
+ }
+ }
+}
diff --git a/specification/cognitiveservices/data-plane/SpeakerRecognition/Verification/preview/v2.0/examples/textIndependentCreateEnrollment.json b/specification/cognitiveservices/data-plane/SpeakerRecognition/Verification/preview/v2.0/examples/textIndependentCreateEnrollment.json
new file mode 100644
index 000000000000..b7eb28955a51
--- /dev/null
+++ b/specification/cognitiveservices/data-plane/SpeakerRecognition/Verification/preview/v2.0/examples/textIndependentCreateEnrollment.json
@@ -0,0 +1,114 @@
+{
+ "parameters": {
+ "Endpoint": "{Endpoint}",
+ "Content-Type": "audio/wav; codecs=audio/pcm",
+ "Ocp-Apim-Subscription-Key": "{API key}",
+ "profileId": "49a36324-fc4b-4387-aa06-090cfbf0064f",
+ "audioData": "{binary file date}"
+ },
+ "responses": {
+ "201": {
+ "headers": {
+ "Content-Type": "application/json"
+ },
+ "body": {
+ "profileId": "49a36324-fc4b-4387-aa06-090cfbf0064f",
+ "enrollmentStatus": "Enrolling",
+ "enrollmentsCount": 1,
+ "enrollmentsLength": 1.83,
+ "enrollmentsSpeechLength": 1.35,
+ "remainingEnrollmentsSpeechLength": 18.65,
+ "audioLength": 1.83,
+ "audioSpeechLength": 1.35
+ }
+ },
+ "400": {
+ "headers": {
+ "Content-Type": "application/json"
+ },
+ "body": {
+ "error": {
+ "code": "InvalidRequest",
+ "message": "Audio is too noisy."
+ }
+ }
+ },
+ "401": {
+ "headers": {
+ "Content-Type": "application/json"
+ },
+ "body": {
+ "error": {
+ "code": "Unauthorized",
+ "message": "Request is not authorized. Make sure subscription key is included and valid."
+ }
+ }
+ },
+ "403": {
+ "headers": {
+ "Content-Type": "application/json"
+ },
+ "body": {
+ "error": {
+ "code": "InvalidRequest",
+ "message": "Maximum allowed length across all profile enrollments is 300 seconds."
+ }
+ }
+ },
+ "404": {
+ "headers": {
+ "Content-Type": "application/json"
+ },
+ "body": {
+ "error": {
+ "code": "Not Found",
+ "message": "Requested profile doesn't exist"
+ }
+ }
+ },
+ "409": {
+ "headers": {
+ "Content-Type": "application/json"
+ },
+ "body": {
+ "error": {
+ "code": "Conflict",
+ "message": "Sending concurrent requests on same profile is not allowed."
+ }
+ }
+ },
+ "415": {
+ "headers": {
+ "Content-Type": "application/json"
+ },
+ "body": {
+ "error": {
+ "code": "UnsupportedMediaType",
+ "message": "Unsupported media type. Only 'audio/wav; codecs=audio/pcm' is accepted."
+ }
+ }
+ },
+ "429": {
+ "headers": {
+ "Content-Type": "application/json"
+ },
+ "body": {
+ "error": {
+ "code": "RateLimit",
+ "message": "Rate limit is exceeded."
+ }
+ }
+ },
+ "500": {
+ "headers": {
+ "Content-Type": "application/json"
+ },
+ "body": {
+ "error": {
+ "code": "InternalServerError",
+ "message": "Internal Server Error."
+ }
+ }
+ }
+ }
+}
diff --git a/specification/cognitiveservices/data-plane/SpeakerRecognition/Verification/preview/v2.0/examples/textIndependentCreateProfile.json b/specification/cognitiveservices/data-plane/SpeakerRecognition/Verification/preview/v2.0/examples/textIndependentCreateProfile.json
new file mode 100644
index 000000000000..f20460a77a87
--- /dev/null
+++ b/specification/cognitiveservices/data-plane/SpeakerRecognition/Verification/preview/v2.0/examples/textIndependentCreateProfile.json
@@ -0,0 +1,95 @@
+{
+ "parameters": {
+ "Endpoint": "{Endpoint}",
+ "Content-Type": "application/json",
+ "Ocp-Apim-Subscription-Key": "{API key}",
+ "profileInfo": {
+ "locale": "en-us"
+ }
+ },
+ "responses": {
+ "201": {
+ "headers": {
+ "Content-Type": "application/json"
+ },
+ "body": {
+ "profileId": "49a36324-fc4b-4387-aa06-090cfbf0064f",
+ "locale": "en-US",
+ "enrollmentStatus": "Enrolling",
+ "createdDateTime": "2015-04-23T18:25:43.41Z",
+ "lastUpdatedDateTime": "2015-04-23T18:25:43.41Z",
+ "enrollmentsCount": 0,
+ "enrollmentsLength": 0,
+ "enrollmentsSpeechLength": 0,
+ "remainingEnrollmentsSpeechLength": 20,
+ "modelVersion": "2019-12-05"
+ }
+ },
+ "400": {
+ "headers": {
+ "Content-Type": "application/json"
+ },
+ "body": {
+ "error": {
+ "code": "InvalidRequest",
+ "message": "Request body is missing."
+ }
+ }
+ },
+ "401": {
+ "headers": {
+ "Content-Type": "application/json"
+ },
+ "body": {
+ "error": {
+ "code": "Unauthorized",
+ "message": "Request is not authorized. Make sure subscription key is included and valid."
+ }
+ }
+ },
+ "403": {
+ "headers": {
+ "Content-Type": "application/json"
+ },
+ "body": {
+ "error": {
+ "code": "Forbidden",
+ "message": "Maximum allowed number of profiles is 10,000."
+ }
+ }
+ },
+ "415": {
+ "headers": {
+ "Content-Type": "application/json"
+ },
+ "body": {
+ "error": {
+ "code": "UnsupportedMediaType",
+ "message": "Unsupported media type. Only 'application/JSON' is accepted."
+ }
+ }
+ },
+ "429": {
+ "headers": {
+ "Content-Type": "application/json"
+ },
+ "body": {
+ "error": {
+ "code": "RateLimit",
+ "message": "Rate limit is exceeded."
+ }
+ }
+ },
+ "500": {
+ "headers": {
+ "Content-Type": "application/json"
+ },
+ "body": {
+ "error": {
+ "code": "InternalServerError",
+ "message": "Internal Server Error."
+ }
+ }
+ }
+ }
+}
diff --git a/specification/cognitiveservices/data-plane/SpeakerRecognition/Verification/preview/v2.0/examples/textIndependentFetchProfile.json b/specification/cognitiveservices/data-plane/SpeakerRecognition/Verification/preview/v2.0/examples/textIndependentFetchProfile.json
new file mode 100644
index 000000000000..5ab27b08d95f
--- /dev/null
+++ b/specification/cognitiveservices/data-plane/SpeakerRecognition/Verification/preview/v2.0/examples/textIndependentFetchProfile.json
@@ -0,0 +1,71 @@
+{
+ "parameters": {
+ "Endpoint": "{Endpoint}",
+ "Content-Type": "application/json",
+ "Ocp-Apim-Subscription-Key": "{API key}",
+ "profileId": "49a36324-fc4b-4387-aa06-090cfbf0064f"
+ },
+ "responses": {
+ "200": {
+ "headers": {
+ "Content-Type": "application/json"
+ },
+ "body": {
+ "profileId": "49a36324-fc4b-4387-aa06-090cfbf0064f",
+ "locale": "en-US",
+ "enrollmentStatus": "Enrolling",
+ "createdDateTime": "2015-04-23T18:25:43.41Z",
+ "lastUpdatedDateTime": "2015-04-23T19:34:51.52Z",
+ "enrollmentsCount": 1,
+ "enrollmentsLength": 1.83,
+ "enrollmentsSpeechLength": 1.35,
+ "remainingEnrollmentsSpeechLength": 18.65,
+ "modelVersion": "2019-12-05"
+ }
+ },
+ "401": {
+ "headers": {
+ "Content-Type": "application/json"
+ },
+ "body": {
+ "error": {
+ "code": "Unauthorized",
+ "message": "Request is not authorized. Make sure subscription key is included and valid."
+ }
+ }
+ },
+ "404": {
+ "headers": {
+ "Content-Type": "application/json"
+ },
+ "body": {
+ "error": {
+ "code": "Not Found",
+ "message": "Requested profile doesn't exist"
+ }
+ }
+ },
+ "429": {
+ "headers": {
+ "Content-Type": "application/json"
+ },
+ "body": {
+ "error": {
+ "code": "RateLimit",
+ "message": "Rate limit is exceeded."
+ }
+ }
+ },
+ "500": {
+ "headers": {
+ "Content-Type": "application/json"
+ },
+ "body": {
+ "error": {
+ "code": "InternalServerError",
+ "message": "Internal Server Error."
+ }
+ }
+ }
+ }
+}
diff --git a/specification/cognitiveservices/data-plane/SpeakerRecognition/Verification/preview/v2.0/examples/textIndependentListProfiles.json b/specification/cognitiveservices/data-plane/SpeakerRecognition/Verification/preview/v2.0/examples/textIndependentListProfiles.json
new file mode 100644
index 000000000000..1e6916cfd8e0
--- /dev/null
+++ b/specification/cognitiveservices/data-plane/SpeakerRecognition/Verification/preview/v2.0/examples/textIndependentListProfiles.json
@@ -0,0 +1,75 @@
+{
+ "parameters": {
+ "Endpoint": "{Endpoint}",
+ "Content-Type": "application/json",
+ "Ocp-Apim-Subscription-Key": "{API key}"
+ },
+ "responses": {
+ "200": {
+ "headers": {
+ "Content-Type": "application/json"
+ },
+ "body": {
+ "profiles": [
+ {
+ "profileId": "49a36324-fc4b-4387-aa06-090cfbf0064f",
+ "locale": "en-US",
+ "enrollmentStatus": "Enrolling",
+ "createdDateTime": "2015-04-23T18:25:43.41Z",
+ "lastUpdatedDateTime": "2015-04-23T19:34:51.52Z",
+ "enrollmentsCount": 1,
+ "enrollmentsLength": 1.83,
+ "enrollmentsSpeechLength": 1.35,
+ "remainingEnrollmentsSpeechLength": 18.65,
+ "modelVersion": "2019-12-05"
+ }
+ ],
+ "@nextLink": "https://{Endpoint}/text-independent/profiles?$top=35&$continuationToken=U21pdGg1QmVuOTk5"
+ }
+ },
+ "400": {
+ "headers": {
+ "Content-Type": "application/json"
+ },
+ "body": {
+ "error": {
+ "code": "InvalidArgument",
+ "message": "Invalid $top parameter value. Value should be positive integer in the range [1, 500]"
+ }
+ }
+ },
+ "401": {
+ "headers": {
+ "Content-Type": "application/json"
+ },
+ "body": {
+ "error": {
+ "code": "Unauthorized",
+ "message": "Request is not authorized. Make sure subscription key is included and valid."
+ }
+ }
+ },
+ "429": {
+ "headers": {
+ "Content-Type": "application/json"
+ },
+ "body": {
+ "error": {
+ "code": "RateLimit",
+ "message": "Rate limit is exceeded."
+ }
+ }
+ },
+ "500": {
+ "headers": {
+ "Content-Type": "application/json"
+ },
+ "body": {
+ "error": {
+ "code": "InternalServerError",
+ "message": "Internal Server Error."
+ }
+ }
+ }
+ }
+}
diff --git a/specification/cognitiveservices/data-plane/SpeakerRecognition/Verification/preview/v2.0/examples/verify.json b/specification/cognitiveservices/data-plane/SpeakerRecognition/Verification/preview/v2.0/examples/verify.json
new file mode 100644
index 000000000000..5a1bf239e46e
--- /dev/null
+++ b/specification/cognitiveservices/data-plane/SpeakerRecognition/Verification/preview/v2.0/examples/verify.json
@@ -0,0 +1,86 @@
+{
+ "parameters": {
+ "Endpoint": "{Endpoint}",
+ "Content-Type": "audio/wav; codecs=audio/pcm",
+ "Ocp-Apim-Subscription-Key": "{API key}",
+ "profileId": "49a36324-fc4b-4387-aa06-090cfbf0064f",
+ "audioData": "{binary file date}"
+ },
+ "responses": {
+ "200": {
+ "headers": {
+ "Content-Type": "application/json"
+ },
+ "body": {
+ "recognitionResult": "accept",
+ "score": 0.63
+ }
+ },
+ "400": {
+ "headers": {
+ "Content-Type": "application/json"
+ },
+ "body": {
+ "error": {
+ "code": "InvalidRequest",
+ "message": "Profile is not enrolled."
+ }
+ }
+ },
+ "401": {
+ "headers": {
+ "Content-Type": "application/json"
+ },
+ "body": {
+ "error": {
+ "code": "Unauthorized",
+ "message": "Request is not authorized. Make sure subscription key is included and valid."
+ }
+ }
+ },
+ "404": {
+ "headers": {
+ "Content-Type": "application/json"
+ },
+ "body": {
+ "error": {
+ "code": "Not Found",
+ "message": "Requested profile doesn't exist"
+ }
+ }
+ },
+ "415": {
+ "headers": {
+ "Content-Type": "application/json"
+ },
+ "body": {
+ "error": {
+ "code": "UnsupportedMediaType",
+ "message": "Unsupported media type. Only 'audio/wav; codecs=audio/pcm' is accepted."
+ }
+ }
+ },
+ "429": {
+ "headers": {
+ "Content-Type": "application/json"
+ },
+ "body": {
+ "error": {
+ "code": "RateLimit",
+ "message": "Rate limit is exceeded."
+ }
+ }
+ },
+ "500": {
+ "headers": {
+ "Content-Type": "application/json"
+ },
+ "body": {
+ "error": {
+ "code": "InternalServerError",
+ "message": "Internal Server Error."
+ }
+ }
+ }
+ }
+}
diff --git a/specification/cognitiveservices/data-plane/SpeakerRecognition/Verification/readme.md b/specification/cognitiveservices/data-plane/SpeakerRecognition/Verification/readme.md
new file mode 100644
index 000000000000..4a6dcd91654b
--- /dev/null
+++ b/specification/cognitiveservices/data-plane/SpeakerRecognition/Verification/readme.md
@@ -0,0 +1,92 @@
+# Cognitive Services Speaker Recognition SDKs
+
+> see https://aka.ms/autorest
+
+Configuration for generating Speaker Verification SDK.
+
+``` yaml
+tag: verification_2_0_preview
+add-credentials: true
+openapi-type: data-plane
+```
+
+The current release for the Authoring Endpoint is `verification_2_0_preview`.
+
+# Releases
+
+## verification 2.0
+These settings apply only when `--tag=verification_2_0_preview` is specified on the command line.
+
+``` yaml $(tag) == 'verification_2_0_preview'
+input-file: preview/v2.0/Verification.json
+```
+
+---
+
+# Code Generation
+
+
+## Swagger to SDK
+
+This section describes what SDK should be generated by the automatic system.
+This is not used by Autorest itself.
+
+``` yaml $(swagger-to-sdk)
+swagger-to-sdk:
+ - repo: azure-sdk-for-python
+ - repo: azure-sdk-for-js
+ - repo: azure-sdk-for-node
+```
+
+### CSharp Settings
+These settings apply only when `--csharp` is specified on the command line.
+``` yaml $(csharp)
+csharp:
+ sync-methods: None
+ license-header: MICROSOFT_MIT_NO_VERSION
+ azure-arm: false
+ namespace: Microsoft.Azure.CognitiveServices.speech.speaker.verification
+ output-folder: $(csharp-sdks-folder)/CognitiveServices/speech.speaker.verification/src/Generated
+ clear-output-folder: true
+```
+
+## Java
+
+These settings apply only when `--java` is specified on the command line.
+Please also specify `--azure-libraries-for-java-folder=`.
+
+``` yaml $(java)
+java:
+ azure-arm: true
+ namespace: com.microsoft.azure.cognitiveservices.speech.speaker.verification
+ license-header: MICROSOFT_MIT_NO_CODEGEN
+ payload-flattening-threshold: 1
+ output-folder: $(azure-libraries-for-java-folder)/cognitiveservices/data-plane/speech/speaker/verification
+ 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.
+
+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)/preview/v2.0/Verification.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/cognitiveservices/data-plane/SpeakerRecognition/Verification/readme.nodejs.md b/specification/cognitiveservices/data-plane/SpeakerRecognition/Verification/readme.nodejs.md
new file mode 100644
index 000000000000..d9965af29de6
--- /dev/null
+++ b/specification/cognitiveservices/data-plane/SpeakerRecognition/Verification/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:
+ package-name: azure-cognitiveservices-speech-speaker-verification
+ output-folder: $(node-sdks-folder)/lib/services/speech/speaker/verification
+ azure-arm: false
+ generate-license-txt: true
+ generate-package-json: true
+ generate-readme-md: true
+```
diff --git a/specification/cognitiveservices/data-plane/SpeakerRecognition/Verification/readme.python.md b/specification/cognitiveservices/data-plane/SpeakerRecognition/Verification/readme.python.md
new file mode 100644
index 000000000000..b5418a87b8b1
--- /dev/null
+++ b/specification/cognitiveservices/data-plane/SpeakerRecognition/Verification/readme.python.md
@@ -0,0 +1,26 @@
+## Python
+
+These settings apply only when `--python` is specified on the command line.
+Please also specify `--python-sdks-folder=`.
+Use `--python-mode=update` if you already have a setup.py and just want to update the code itself.
+
+``` yaml $(python)
+python-mode: create
+python:
+ license-header: MICROSOFT_MIT_NO_VERSION
+ payload-flattening-threshold: 2
+ namespace: azure.cognitiveservices.speech.speaker.verification
+ package-name: azure-cognitiveservices-speech-speaker
+ clear-output-folder: true
+
+```
+``` yaml $(python) && $(python-mode) == 'update'
+python:
+ no-namespace-folders: true
+ output-folder: $(python-sdks-folder)/cognitiveservices/speech/speaker/verification
+```
+``` yaml $(python) && $(python-mode) == 'create'
+python:
+ basic-setup-py: true
+ output-folder: $(python-sdks-folder)/cognitiveservices/azure-cognitiveservices-speech-speaker
+```
diff --git a/specification/cognitiveservices/data-plane/SpeakerRecognition/Verification/readme.typescript.md b/specification/cognitiveservices/data-plane/SpeakerRecognition/Verification/readme.typescript.md
new file mode 100644
index 000000000000..40bebe3609bd
--- /dev/null
+++ b/specification/cognitiveservices/data-plane/SpeakerRecognition/Verification/readme.typescript.md
@@ -0,0 +1,12 @@
+## TypeScript
+
+These settings apply only when `--typescript` is specified on the command line.
+Please also specify `--typescript-sdks-folder=`.
+
+``` yaml $(typescript)
+typescript:
+ package-name: "@azure/cognitiveservices-speaker-verification"
+ output-folder: "$(typescript-sdks-folder)/sdk/cognitiveservices/cognitiveservices-speaker-verification"
+ azure-arm: false
+ generate-metadata: true
+```
diff --git a/specification/cognitiveservices/data-plane/TextAnalytics/stable/v3.0/TextAnalytics.json b/specification/cognitiveservices/data-plane/TextAnalytics/stable/v3.0/TextAnalytics.json
index 6a5ac3d74066..81ec70c74f6b 100644
--- a/specification/cognitiveservices/data-plane/TextAnalytics/stable/v3.0/TextAnalytics.json
+++ b/specification/cognitiveservices/data-plane/TextAnalytics/stable/v3.0/TextAnalytics.json
@@ -1064,7 +1064,7 @@
"type": "object",
"required": [
"id",
- "detectedLanguages",
+ "detectedLanguage",
"warnings"
],
"properties": {
@@ -1072,12 +1072,9 @@
"type": "string",
"description": "Unique, non-empty document identifier."
},
- "detectedLanguages": {
- "type": "array",
- "description": "A list of extracted languages.",
- "items": {
- "$ref": "#/definitions/DetectedLanguage"
- }
+ "detectedLanguage": {
+ "description": "Detected Language.",
+ "$ref": "#/definitions/DetectedLanguage"
},
"warnings": {
"type": "array",
diff --git a/specification/cognitiveservices/data-plane/TextAnalytics/stable/v3.0/examples/SuccessfulLanguagesRequest.json b/specification/cognitiveservices/data-plane/TextAnalytics/stable/v3.0/examples/SuccessfulLanguagesRequest.json
index 109e2c90de57..3cee2aef5bd1 100644
--- a/specification/cognitiveservices/data-plane/TextAnalytics/stable/v3.0/examples/SuccessfulLanguagesRequest.json
+++ b/specification/cognitiveservices/data-plane/TextAnalytics/stable/v3.0/examples/SuccessfulLanguagesRequest.json
@@ -27,35 +27,29 @@
"documents": [
{
"id": "1",
- "detectedLanguages": [
- {
- "name": "English",
- "iso6391Name": "en",
- "confidenceScore": 1
- }
- ],
+ "detectedLanguage": {
+ "name": "English",
+ "iso6391Name": "en",
+ "confidenceScore": 1
+ },
"warnings": []
},
{
"id": "2",
- "detectedLanguages": [
- {
- "name": "French",
- "iso6391Name": "fr",
- "confidenceScore": 1
- }
- ],
+ "detectedLanguage": {
+ "name": "French",
+ "iso6391Name": "fr",
+ "confidenceScore": 1
+ },
"warnings": []
},
{
"id": "3",
- "detectedLanguages": [
- {
- "name": "Spanish",
- "iso6391Name": "es",
- "confidenceScore": 1
- }
- ],
+ "detectedLanguage": {
+ "name": "Spanish",
+ "iso6391Name": "es",
+ "confidenceScore": 1
+ },
"warnings": []
}
],
diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2017-04-18/cognitiveservices.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2017-04-18/cognitiveservices.json
index 97638fdad4bf..6fafff2877ff 100644
--- a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2017-04-18/cognitiveservices.json
+++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2017-04-18/cognitiveservices.json
@@ -44,21 +44,10 @@
},
"parameters": [
{
- "name": "resourceGroupName",
- "in": "path",
- "required": true,
- "type": "string",
- "description": "The name of the resource group within the user's subscription."
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter"
},
{
- "name": "accountName",
- "in": "path",
- "required": true,
- "type": "string",
- "maxLength": 64,
- "minLength": 2,
- "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$",
- "description": "The name of Cognitive Services account."
+ "$ref": "#/parameters/accountNameParameter"
},
{
"name": "account",
@@ -70,10 +59,10 @@
"description": "The parameters to provide for the created account."
},
{
- "$ref": "#/parameters/apiVersionParameter"
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter"
},
{
- "$ref": "#/parameters/subscriptionIdParameter"
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter"
}
],
"responses": {
@@ -116,21 +105,10 @@
},
"parameters": [
{
- "name": "resourceGroupName",
- "in": "path",
- "required": true,
- "type": "string",
- "description": "The name of the resource group within the user's subscription."
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter"
},
{
- "name": "accountName",
- "in": "path",
- "required": true,
- "type": "string",
- "maxLength": 64,
- "minLength": 2,
- "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$",
- "description": "The name of Cognitive Services account."
+ "$ref": "#/parameters/accountNameParameter"
},
{
"name": "account",
@@ -142,10 +120,10 @@
"description": "The parameters to provide for the created account."
},
{
- "$ref": "#/parameters/apiVersionParameter"
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter"
},
{
- "$ref": "#/parameters/subscriptionIdParameter"
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter"
}
],
"responses": {
@@ -182,27 +160,16 @@
},
"parameters": [
{
- "name": "resourceGroupName",
- "in": "path",
- "required": true,
- "type": "string",
- "description": "The name of the resource group within the user's subscription."
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter"
},
{
- "name": "accountName",
- "in": "path",
- "required": true,
- "type": "string",
- "maxLength": 64,
- "minLength": 2,
- "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$",
- "description": "The name of Cognitive Services account."
+ "$ref": "#/parameters/accountNameParameter"
},
{
- "$ref": "#/parameters/apiVersionParameter"
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter"
},
{
- "$ref": "#/parameters/subscriptionIdParameter"
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter"
}
],
"responses": {
@@ -236,27 +203,16 @@
},
"parameters": [
{
- "name": "resourceGroupName",
- "in": "path",
- "required": true,
- "type": "string",
- "description": "The name of the resource group within the user's subscription."
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter"
},
{
- "name": "accountName",
- "in": "path",
- "required": true,
- "type": "string",
- "maxLength": 64,
- "minLength": 2,
- "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$",
- "description": "The name of Cognitive Services account."
+ "$ref": "#/parameters/accountNameParameter"
},
{
- "$ref": "#/parameters/apiVersionParameter"
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter"
},
{
- "$ref": "#/parameters/subscriptionIdParameter"
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter"
}
],
"responses": {
@@ -289,17 +245,13 @@
},
"parameters": [
{
- "name": "resourceGroupName",
- "in": "path",
- "required": true,
- "type": "string",
- "description": "The name of the resource group within the user's subscription."
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter"
},
{
- "$ref": "#/parameters/subscriptionIdParameter"
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter"
},
{
- "$ref": "#/parameters/apiVersionParameter"
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter"
}
],
"responses": {
@@ -335,10 +287,10 @@
},
"parameters": [
{
- "$ref": "#/parameters/apiVersionParameter"
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter"
},
{
- "$ref": "#/parameters/subscriptionIdParameter"
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter"
}
],
"responses": {
@@ -374,27 +326,16 @@
},
"parameters": [
{
- "name": "resourceGroupName",
- "in": "path",
- "required": true,
- "type": "string",
- "description": "The name of the resource group within the user's subscription."
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter"
},
{
- "name": "accountName",
- "in": "path",
- "required": true,
- "type": "string",
- "maxLength": 64,
- "minLength": 2,
- "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$",
- "description": "The name of Cognitive Services account."
+ "$ref": "#/parameters/accountNameParameter"
},
{
- "$ref": "#/parameters/apiVersionParameter"
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter"
},
{
- "$ref": "#/parameters/subscriptionIdParameter"
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter"
}
],
"responses": {
@@ -427,21 +368,10 @@
},
"parameters": [
{
- "name": "resourceGroupName",
- "in": "path",
- "required": true,
- "type": "string",
- "description": "The name of the resource group within the user's subscription."
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter"
},
{
- "name": "accountName",
- "in": "path",
- "required": true,
- "type": "string",
- "maxLength": 64,
- "minLength": 2,
- "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$",
- "description": "The name of Cognitive Services account."
+ "$ref": "#/parameters/accountNameParameter"
},
{
"name": "parameters",
@@ -454,10 +384,10 @@
"description": "regenerate key parameters."
},
{
- "$ref": "#/parameters/apiVersionParameter"
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter"
},
{
- "$ref": "#/parameters/subscriptionIdParameter"
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter"
}
],
"responses": {
@@ -491,10 +421,10 @@
},
"parameters": [
{
- "$ref": "#/parameters/apiVersionParameter"
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter"
},
{
- "$ref": "#/parameters/subscriptionIdParameter"
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter"
}
],
"responses": {
@@ -524,27 +454,16 @@
"operationId": "Accounts_ListSkus",
"parameters": [
{
- "name": "resourceGroupName",
- "in": "path",
- "required": true,
- "type": "string",
- "description": "The name of the resource group within the user's subscription."
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter"
},
{
- "name": "accountName",
- "in": "path",
- "required": true,
- "type": "string",
- "maxLength": 64,
- "minLength": 2,
- "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$",
- "description": "The name of Cognitive Services account."
+ "$ref": "#/parameters/accountNameParameter"
},
{
- "$ref": "#/parameters/apiVersionParameter"
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter"
},
{
- "$ref": "#/parameters/subscriptionIdParameter"
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter"
}
],
"responses": {
@@ -577,27 +496,16 @@
"operationId": "Accounts_GetUsages",
"parameters": [
{
- "name": "resourceGroupName",
- "in": "path",
- "required": true,
- "type": "string",
- "description": "The name of the resource group within the user's subscription."
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter"
},
{
- "name": "accountName",
- "in": "path",
- "required": true,
- "type": "string",
- "maxLength": 64,
- "minLength": 2,
- "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$",
- "description": "The name of Cognitive Services account."
+ "$ref": "#/parameters/accountNameParameter"
},
{
- "$ref": "#/parameters/apiVersionParameter"
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter"
},
{
- "$ref": "#/parameters/subscriptionIdParameter"
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "#/parameters/usageFilterParameter"
@@ -633,7 +541,7 @@
},
"parameters": [
{
- "$ref": "#/parameters/apiVersionParameter"
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter"
}
],
"responses": {
@@ -664,10 +572,10 @@
},
"parameters": [
{
- "$ref": "#/parameters/subscriptionIdParameter"
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter"
},
{
- "$ref": "#/parameters/apiVersionParameter"
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "#/parameters/locationParameter"
@@ -707,10 +615,10 @@
},
"parameters": [
{
- "$ref": "#/parameters/subscriptionIdParameter"
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter"
},
{
- "$ref": "#/parameters/apiVersionParameter"
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter"
},
{
"name": "parameters",
@@ -732,6 +640,164 @@
}
}
}
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/privateEndpointConnections/{privateEndpointConnectionName}": {
+ "get": {
+ "tags": [
+ "PrivateEndpointConnections"
+ ],
+ "operationId": "PrivateEndpointConnections_Get",
+ "description": "Gets the specified private endpoint connection associated with the Cognitive Services account.",
+ "x-ms-examples": {
+ "GetPrivateEndpointConnection": {
+ "$ref": "./examples/GetPrivateEndpointConnection.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/accountNameParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/privateEndpointConnectionName"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK -- Get the private endpoint connection properties successfully.",
+ "schema": {
+ "$ref": "#/definitions/PrivateEndpointConnection"
+ }
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "PrivateEndpointConnections"
+ ],
+ "operationId": "PrivateEndpointConnections_CreateOrUpdate",
+ "description": "Update the state of specified private endpoint connection associated with the Cognitive Services account.",
+ "x-ms-examples": {
+ "PutPrivateEndpointConnection": {
+ "$ref": "./examples/PutPrivateEndpointConnection.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/accountNameParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/privateEndpointConnectionName"
+ },
+ {
+ "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"
+ }
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "PrivateEndpointConnections"
+ ],
+ "operationId": "PrivateEndpointConnections_Delete",
+ "description": "Deletes the specified private endpoint connection associated with the Cognitive Services account.",
+ "x-ms-examples": {
+ "DeletePrivateEndpointConnection": {
+ "$ref": "./examples/DeletePrivateEndpointConnection.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/accountNameParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/privateEndpointConnectionName"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK -- Delete the private endpoint connection successfully."
+ },
+ "204": {
+ "description": "No Content -- The private endpoint connection does not exist."
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/privateLinkResources": {
+ "get": {
+ "tags": [
+ "PrivateLinkResources"
+ ],
+ "operationId": "PrivateLinkResources_List",
+ "description": "Gets the private link resources that need to be created for a Cognitive Services account.",
+ "x-ms-examples": {
+ "ListPrivateLinkResources": {
+ "$ref": "./examples/ListPrivateLinkResources.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/accountNameParameter"
+ },
+ {
+ "$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": "#/definitions/PrivateLinkResourceListResult"
+ }
+ }
+ }
+ }
}
},
"definitions": {
@@ -869,6 +935,14 @@
"description": "The internal identifier.",
"readOnly": true
},
+ "capabilities": {
+ "readOnly": true,
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/SkuCapability"
+ },
+ "description": "Gets the capabilities of the cognitive services account. Each item indicates the capability of a specific feature. The values are read-only and for reference only."
+ },
"customSubDomainName": {
"type": "string",
"description": "Optional subdomain name used for token-based authentication."
@@ -888,6 +962,25 @@
},
"description": "The storage accounts for this resource."
},
+ "privateEndpointConnections": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/PrivateEndpointConnection"
+ },
+ "description": "The private endpoint connection associated with the Cognitive Services account."
+ },
+ "publicNetworkAccess": {
+ "type": "string",
+ "description": "Whether or not public endpoint access is allowed for this account. Value is optional but if passed in, must be 'Enabled' or 'Disabled'",
+ "enum": [
+ "Enabled",
+ "Disabled"
+ ],
+ "x-ms-enum": {
+ "name": "PublicNetworkAccess",
+ "modelAsString": true
+ }
+ },
"apiProperties": {
"$ref": "#/definitions/CognitiveServicesAccountApiProperties",
"description": "The api properties for special APIs."
@@ -1228,6 +1321,19 @@
}
}
},
+ "SkuCapability": {
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "The name of the SkuCapability."
+ },
+ "value": {
+ "type": "string",
+ "description": "The value of the SkuCapability."
+ }
+ },
+ "description": "SkuCapability indicates the capability of a certain feature."
+ },
"CheckDomainAvailabilityParameter": {
"description": "Check Domain availability parameter.",
"properties": {
@@ -1551,22 +1657,153 @@
}
},
"description": "The user owned storage for Cognitive Services account."
+ },
+ "PrivateEndpointConnection": {
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/PrivateEndpointConnectionProperties",
+ "description": "Resource properties."
+ }
+ },
+ "allOf": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/Resource"
+ }
+ ],
+ "description": "The Private Endpoint Connection resource."
+ },
+ "PrivateEndpointConnectionProperties": {
+ "properties": {
+ "privateEndpoint": {
+ "$ref": "#/definitions/PrivateEndpoint",
+ "description": "The resource of private end point."
+ },
+ "privateLinkServiceConnectionState": {
+ "$ref": "#/definitions/PrivateLinkServiceConnectionState",
+ "description": "A collection of information about the state of the connection between service consumer and provider."
+ },
+ "groupIds": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "The private link resource group ids."
+ }
+ },
+ "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."
+ },
+ "actionRequired": {
+ "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"
+ ],
+ "x-ms-enum": {
+ "name": "PrivateEndpointServiceConnectionStatus",
+ "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."
+ }
+ },
+ "allOf": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/Resource"
+ }
+ ],
+ "description": "A private link resource"
+ },
+ "PrivateLinkResourceProperties": {
+ "properties": {
+ "groupId": {
+ "description": "The private link resource group id.",
+ "type": "string",
+ "readOnly": true
+ },
+ "displayName": {
+ "description": "The private link resource display name.",
+ "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."
}
},
"parameters": {
- "subscriptionIdParameter": {
- "name": "subscriptionId",
+ "accountNameParameter": {
+ "name": "accountName",
"in": "path",
- "description": "Azure Subscription ID.",
- "required": true,
- "type": "string"
- },
- "apiVersionParameter": {
- "name": "api-version",
- "in": "query",
"required": true,
"type": "string",
- "description": "Version of the API to be used with the client request. Current version is 2017-04-18"
+ "maxLength": 64,
+ "minLength": 2,
+ "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$",
+ "description": "The name of Cognitive Services account.",
+ "x-ms-parameter-location": "method"
},
"locationParameter": {
"name": "location",
@@ -1583,6 +1820,14 @@
"type": "string",
"description": "An OData filter expression that describes a subset of usages to return. The supported parameter is name.value (name of the metric, can have an or of multiple names).",
"x-ms-parameter-location": "method"
+ },
+ "privateEndpointConnectionName": {
+ "name": "privateEndpointConnectionName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the private endpoint connection associated with the Cognitive Services Account",
+ "x-ms-parameter-location": "method"
}
}
}
diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2017-04-18/examples/DeletePrivateEndpointConnection.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2017-04-18/examples/DeletePrivateEndpointConnection.json
new file mode 100644
index 000000000000..00f982aa7123
--- /dev/null
+++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2017-04-18/examples/DeletePrivateEndpointConnection.json
@@ -0,0 +1,14 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "res6977",
+ "accountName": "sto2527",
+ "privateEndpointConnectionName": "{privateEndpointConnectionName}",
+ "api-version": "2019-06-01",
+ "monitor": "true"
+ },
+ "responses": {
+ "200": {},
+ "204": {}
+ }
+}
diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2017-04-18/examples/GetPrivateEndpointConnection.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2017-04-18/examples/GetPrivateEndpointConnection.json
new file mode 100644
index 000000000000..89b0fccf74d9
--- /dev/null
+++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2017-04-18/examples/GetPrivateEndpointConnection.json
@@ -0,0 +1,29 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "res6977",
+ "accountName": "sto2527",
+ "privateEndpointConnectionName": "{privateEndpointConnectionName}",
+ "api-version": "2019-06-01",
+ "monitor": "true"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/res7231/providers/Microsoft.CognitiveServices/accounts/sto288/privateEndpointConnections/{privateEndpointConnectionName}",
+ "name": "{privateEndpointConnectionName}",
+ "type": "Microsoft.CognitiveServices/accounts/privateEndpointConnections",
+ "properties": {
+ "privateEndpoint": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/res7231/providers/Microsoft.Network/privateEndpoints/petest01"
+ },
+ "privateLinkServiceConnectionState": {
+ "status": "Approved",
+ "description": "Auto-Approved",
+ "actionRequired": "None"
+ }
+ }
+ }
+ }
+ }
+}
diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2017-04-18/examples/ListPrivateLinkResources.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2017-04-18/examples/ListPrivateLinkResources.json
new file mode 100644
index 000000000000..c35569afa3c2
--- /dev/null
+++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2017-04-18/examples/ListPrivateLinkResources.json
@@ -0,0 +1,30 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "res6977",
+ "accountName": "sto2527",
+ "api-version": "2019-06-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/res6977/providers/Microsoft.CognitiveServices/accounts/sto2527/privateLinkResources/account",
+ "name": "blob",
+ "type": "Microsoft.CognitiveServices/accounts/privateLinkResources",
+ "properties": {
+ "groupId": "account",
+ "requiredMembers": [
+ "default"
+ ],
+ "requiredZoneNames": [
+ "privatelink.cognitiveservices.azure.com"
+ ]
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2017-04-18/examples/PutPrivateEndpointConnection.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2017-04-18/examples/PutPrivateEndpointConnection.json
new file mode 100644
index 000000000000..f1153309ffb0
--- /dev/null
+++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2017-04-18/examples/PutPrivateEndpointConnection.json
@@ -0,0 +1,37 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "res7687",
+ "accountName": "sto9699",
+ "privateEndpointConnectionName": "{privateEndpointConnectionName}",
+ "api-version": "2019-06-01",
+ "monitor": "true",
+ "properties": {
+ "properties": {
+ "privateLinkServiceConnectionState": {
+ "status": "Approved",
+ "description": "Auto-Approved"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/res7231/providers/Microsoft.CognitiveServices/accounts/sto288/privateEndpointConnections/{privateEndpointConnectionName}",
+ "name": "{privateEndpointConnectionName}",
+ "type": "Microsoft.CognitiveServices/accounts/privateEndpointConnections",
+ "properties": {
+ "privateEndpoint": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/res7231/providers/Microsoft.Network/privateEndpoints/petest01"
+ },
+ "privateLinkServiceConnectionState": {
+ "status": "Approved",
+ "description": "Auto-Approved",
+ "actionRequired": "None"
+ }
+ }
+ }
+ }
+ }
+}
diff --git a/specification/common-types/resource-management/v1/privatelinks.json b/specification/common-types/resource-management/v1/privatelinks.json
new file mode 100644
index 000000000000..d6cb94988421
--- /dev/null
+++ b/specification/common-types/resource-management/v1/privatelinks.json
@@ -0,0 +1,174 @@
+{
+ "swagger": "2.0",
+ "info": {
+ "version": "1.0",
+ "title": "Common types"
+ },
+ "paths": {},
+ "definitions": {
+ "PrivateEndpoint": {
+ "properties": {
+ "id": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The ARM identifier for Private Endpoint"
+ }
+ },
+ "description": "The Private Endpoint resource."
+ },
+ "PrivateEndpointConnection": {
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/PrivateEndpointConnectionProperties",
+ "x-ms-client-flatten": true,
+ "description": "Resource properties."
+ }
+ },
+ "allOf": [
+ {
+ "$ref": "./types.json#/definitions/Resource"
+ }
+ ],
+ "description": "The Private Endpoint Connection resource."
+ },
+ "PrivateEndpointConnectionProperties": {
+ "properties": {
+ "privateEndpoint": {
+ "$ref": "#/definitions/PrivateEndpoint",
+ "description": "The resource of private end point."
+ },
+ "privateLinkServiceConnectionState": {
+ "$ref": "#/definitions/PrivateLinkServiceConnectionState",
+ "description": "A collection of information about the state of the connection between service consumer and provider."
+ },
+ "provisioningState": {
+ "$ref": "#/definitions/PrivateEndpointConnectionProvisioningState",
+ "description": "The provisioning state of the private endpoint connection resource."
+ }
+ },
+ "required": [
+ "privateLinkServiceConnectionState"
+ ],
+ "description": "Properties of the PrivateEndpointConnectProperties."
+ },
+ "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."
+ },
+ "actionRequired": {
+ "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"
+ ],
+ "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
+ }
+ },
+ "PrivateLinkResource": {
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/PrivateLinkResourceProperties",
+ "description": "Resource properties.",
+ "x-ms-client-flatten": true
+ }
+ },
+ "allOf": [
+ {
+ "$ref": "./types.json#/definitions/Resource"
+ }
+ ],
+ "description": "A private link resource"
+ },
+ "PrivateLinkResourceProperties": {
+ "properties": {
+ "groupId": {
+ "description": "The private link resource group id.",
+ "type": "string",
+ "readOnly": true
+ },
+ "requiredMembers": {
+ "description": "The private link resource required member names.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "readOnly": true
+ },
+ "requiredZoneNames": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "The private link resource Private link DNS zone name."
+ }
+ },
+ "description": "Properties of a private link resource."
+ },
+ "PrivateEndpointConnectionListResult": {
+ "properties": {
+ "value": {
+ "type": "array",
+ "description": "Array of private endpoint connections",
+ "items": {
+ "$ref": "#/definitions/PrivateEndpointConnection"
+ }
+ }
+ },
+ "description": "List of private endpoint connection associated with the specified storage account"
+ },
+ "PrivateLinkResourceListResult": {
+ "properties": {
+ "value": {
+ "type": "array",
+ "description": "Array of private link resources",
+ "items": {
+ "$ref": "#/definitions/PrivateLinkResource"
+ }
+ }
+ },
+ "description": "A list of private link resources"
+ }
+ },
+ "parameters": {
+ "PrivateEndpointConnectionName": {
+ "name": "privateEndpointConnectionName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the private endpoint connection associated with the Azure resource",
+ "x-ms-parameter-location": "method"
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2015-06-15/compute.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2015-06-15/compute.json
index 66735a54b30d..27547d5699c5 100644
--- a/specification/compute/resource-manager/Microsoft.Compute/stable/2015-06-15/compute.json
+++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2015-06-15/compute.json
@@ -2460,21 +2460,21 @@
"in": "query",
"required": false,
"type": "string",
- "description": "The filter to apply to the operation."
+ "description": "The filter to apply to the operation. Allowed values are 'startswith(instanceView/statuses/code, 'PowerState') eq true', 'properties/latestModelApplied eq true', 'properties/latestModelApplied eq false'."
},
{
"name": "$select",
"in": "query",
"required": false,
"type": "string",
- "description": "The list parameters."
+ "description": "The list parameters. Allowed values are 'instanceView', 'instanceView/statuses'."
},
{
"name": "$expand",
"in": "query",
"required": false,
"type": "string",
- "description": "The expand expression to apply to the operation."
+ "description": "The expand expression to apply to the operation. Allowed values are 'instanceView'."
},
{
"$ref": "#/parameters/ApiVersionParameter"
diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2016-03-30/compute.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2016-03-30/compute.json
index 939d08a0e931..83dd89c98d6b 100644
--- a/specification/compute/resource-manager/Microsoft.Compute/stable/2016-03-30/compute.json
+++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2016-03-30/compute.json
@@ -179,7 +179,7 @@
"in": "query",
"required": false,
"type": "string",
- "description": "The expand expression to apply to the operation."
+ "description": "The expand expression to apply to the operation. Allowed values are 'instanceView'."
}
],
"responses": {
@@ -2541,21 +2541,21 @@
"in": "query",
"required": false,
"type": "string",
- "description": "The filter to apply to the operation."
+ "description": "The filter to apply to the operation. Allowed values are 'startswith(instanceView/statuses/code, 'PowerState') eq true', 'properties/latestModelApplied eq true', 'properties/latestModelApplied eq false'."
},
{
"name": "$select",
"in": "query",
"required": false,
"type": "string",
- "description": "The list parameters."
+ "description": "The list parameters. Allowed values are 'instanceView', 'instanceView/statuses'."
},
{
"name": "$expand",
"in": "query",
"required": false,
"type": "string",
- "description": "The expand expression to apply to the operation."
+ "description": "The expand expression to apply to the operation. Allowed values are 'instanceView'."
},
{
"$ref": "#/parameters/ApiVersionParameter"
diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2017-03-30/compute.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2017-03-30/compute.json
index 9cb759885ebe..9fbeb9bcab70 100644
--- a/specification/compute/resource-manager/Microsoft.Compute/stable/2017-03-30/compute.json
+++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2017-03-30/compute.json
@@ -183,7 +183,7 @@
"in": "query",
"required": false,
"type": "string",
- "description": "The expand expression to apply to the operation."
+ "description": "The expand expression to apply to the operation. Allowed values are 'instanceView'."
}
],
"responses": {
@@ -3562,21 +3562,21 @@
"in": "query",
"required": false,
"type": "string",
- "description": "The filter to apply to the operation."
+ "description": "The filter to apply to the operation. Allowed values are 'startswith(instanceView/statuses/code, 'PowerState') eq true', 'properties/latestModelApplied eq true', 'properties/latestModelApplied eq false'."
},
{
"name": "$select",
"in": "query",
"required": false,
"type": "string",
- "description": "The list parameters."
+ "description": "The list parameters. Allowed values are 'instanceView', 'instanceView/statuses'."
},
{
"name": "$expand",
"in": "query",
"required": false,
"type": "string",
- "description": "The expand expression to apply to the operation."
+ "description": "The expand expression to apply to the operation. Allowed values are 'instanceView'."
},
{
"$ref": "#/parameters/ApiVersionParameter"
diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2017-03-30/examples/ListAvailabilitySetsInASubscription.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2017-03-30/examples/ListAvailabilitySetsInASubscription.json
index 996c3b390765..8184ebca23ed 100644
--- a/specification/compute/resource-manager/Microsoft.Compute/stable/2017-03-30/examples/ListAvailabilitySetsInASubscription.json
+++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2017-03-30/examples/ListAvailabilitySetsInASubscription.json
@@ -2,7 +2,7 @@
"parameters": {
"subscriptionId": "{subscriptionId}",
"api-version": "2017-03-30",
- "$expand": "virtualMachines\\$ref"
+ "$expand": "instanceView"
},
"responses": {
"200": {
diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2017-12-01/compute.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2017-12-01/compute.json
index 0cb61c92bf74..02566cf61a71 100644
--- a/specification/compute/resource-manager/Microsoft.Compute/stable/2017-12-01/compute.json
+++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2017-12-01/compute.json
@@ -254,7 +254,7 @@
"in": "query",
"required": false,
"type": "string",
- "description": "The expand expression to apply to the operation."
+ "description": "The expand expression to apply to the operation. Allowed values are 'instanceView'."
}
],
"responses": {
@@ -3968,21 +3968,21 @@
"in": "query",
"required": false,
"type": "string",
- "description": "The filter to apply to the operation."
+ "description": "The filter to apply to the operation. Allowed values are 'startswith(instanceView/statuses/code, 'PowerState') eq true', 'properties/latestModelApplied eq true', 'properties/latestModelApplied eq false'."
},
{
"name": "$select",
"in": "query",
"required": false,
"type": "string",
- "description": "The list parameters."
+ "description": "The list parameters. Allowed values are 'instanceView', 'instanceView/statuses'."
},
{
"name": "$expand",
"in": "query",
"required": false,
"type": "string",
- "description": "The expand expression to apply to the operation."
+ "description": "The expand expression to apply to the operation. Allowed values are 'instanceView'."
},
{
"$ref": "#/parameters/ApiVersionParameter"
diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2017-12-01/examples/ListAvailabilitySetsInASubscription.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2017-12-01/examples/ListAvailabilitySetsInASubscription.json
index d5bb9e943b6d..1d999ce5a8fa 100644
--- a/specification/compute/resource-manager/Microsoft.Compute/stable/2017-12-01/examples/ListAvailabilitySetsInASubscription.json
+++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2017-12-01/examples/ListAvailabilitySetsInASubscription.json
@@ -2,7 +2,7 @@
"parameters": {
"subscriptionId": "{subscriptionId}",
"api-version": "2017-12-01",
- "$expand": "virtualMachines\\$ref"
+ "$expand": "instanceView"
},
"responses": {
"200": {
diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-04-01/compute.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-04-01/compute.json
index e0f8125e5df8..9f7169f58aaa 100644
--- a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-04-01/compute.json
+++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-04-01/compute.json
@@ -251,7 +251,7 @@
"in": "query",
"required": false,
"type": "string",
- "description": "The expand expression to apply to the operation."
+ "description": "The expand expression to apply to the operation. Allowed values are 'instanceView'."
}
],
"responses": {
@@ -4079,21 +4079,21 @@
"in": "query",
"required": false,
"type": "string",
- "description": "The filter to apply to the operation."
+ "description": "The filter to apply to the operation. Allowed values are 'startswith(instanceView/statuses/code, 'PowerState') eq true', 'properties/latestModelApplied eq true', 'properties/latestModelApplied eq false'."
},
{
"name": "$select",
"in": "query",
"required": false,
"type": "string",
- "description": "The list parameters."
+ "description": "The list parameters. Allowed values are 'instanceView', 'instanceView/statuses'."
},
{
"name": "$expand",
"in": "query",
"required": false,
"type": "string",
- "description": "The expand expression to apply to the operation."
+ "description": "The expand expression to apply to the operation. Allowed values are 'instanceView'."
},
{
"$ref": "#/parameters/ApiVersionParameter"
diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-04-01/examples/ListAvailabilitySetsInASubscription.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-04-01/examples/ListAvailabilitySetsInASubscription.json
index 29bb119ff690..c97c80fff2f5 100644
--- a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-04-01/examples/ListAvailabilitySetsInASubscription.json
+++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-04-01/examples/ListAvailabilitySetsInASubscription.json
@@ -2,7 +2,7 @@
"parameters": {
"subscriptionId": "{subscriptionId}",
"api-version": "2018-04-01",
- "$expand": "virtualMachines\\$ref"
+ "$expand": "instanceView"
},
"responses": {
"200": {
diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/compute.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/compute.json
index 6ec3b585ce05..acdb3a9dc59d 100644
--- a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/compute.json
+++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/compute.json
@@ -251,7 +251,7 @@
"in": "query",
"required": false,
"type": "string",
- "description": "The expand expression to apply to the operation."
+ "description": "The expand expression to apply to the operation. Allowed values are 'instanceView'."
}
],
"responses": {
@@ -4198,21 +4198,21 @@
"in": "query",
"required": false,
"type": "string",
- "description": "The filter to apply to the operation."
+ "description": "The filter to apply to the operation. Allowed values are 'startswith(instanceView/statuses/code, 'PowerState') eq true', 'properties/latestModelApplied eq true', 'properties/latestModelApplied eq false'."
},
{
"name": "$select",
"in": "query",
"required": false,
"type": "string",
- "description": "The list parameters."
+ "description": "The list parameters. Allowed values are 'instanceView', 'instanceView/statuses'."
},
{
"name": "$expand",
"in": "query",
"required": false,
"type": "string",
- "description": "The expand expression to apply to the operation."
+ "description": "The expand expression to apply to the operation. Allowed values are 'instanceView'."
},
{
"$ref": "#/parameters/ApiVersionParameter"
diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/ListAvailabilitySetsInASubscription.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/ListAvailabilitySetsInASubscription.json
index 217c0f707840..fc595d9a5ab8 100644
--- a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/ListAvailabilitySetsInASubscription.json
+++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/ListAvailabilitySetsInASubscription.json
@@ -2,7 +2,7 @@
"parameters": {
"subscriptionId": "{subscriptionId}",
"api-version": "2018-06-01",
- "$expand": "virtualMachines\\$ref"
+ "$expand": "instanceView"
},
"responses": {
"200": {
diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-10-01/compute.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-10-01/compute.json
index 11aeaedc3244..429401d44d5f 100644
--- a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-10-01/compute.json
+++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-10-01/compute.json
@@ -251,7 +251,7 @@
"in": "query",
"required": false,
"type": "string",
- "description": "The expand expression to apply to the operation."
+ "description": "The expand expression to apply to the operation. Allowed values are 'instanceView'."
}
],
"responses": {
@@ -4201,21 +4201,21 @@
"in": "query",
"required": false,
"type": "string",
- "description": "The filter to apply to the operation."
+ "description": "The filter to apply to the operation. Allowed values are 'startswith(instanceView/statuses/code, 'PowerState') eq true', 'properties/latestModelApplied eq true', 'properties/latestModelApplied eq false'."
},
{
"name": "$select",
"in": "query",
"required": false,
"type": "string",
- "description": "The list parameters."
+ "description": "The list parameters. Allowed values are 'instanceView', 'instanceView/statuses'."
},
{
"name": "$expand",
"in": "query",
"required": false,
"type": "string",
- "description": "The expand expression to apply to the operation."
+ "description": "The expand expression to apply to the operation. Allowed values are 'instanceView'."
},
{
"$ref": "#/parameters/ApiVersionParameter"
diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-10-01/examples/ListAvailabilitySetsInASubscription.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-10-01/examples/ListAvailabilitySetsInASubscription.json
index bd9cb9e4e140..cb52806da595 100644
--- a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-10-01/examples/ListAvailabilitySetsInASubscription.json
+++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-10-01/examples/ListAvailabilitySetsInASubscription.json
@@ -2,7 +2,7 @@
"parameters": {
"subscriptionId": "{subscriptionId}",
"api-version": "2018-10-01",
- "$expand": "virtualMachines\\$ref"
+ "$expand": "instanceView"
},
"responses": {
"200": {
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 6ab37f15f568..d7d39de3f591 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
@@ -251,7 +251,7 @@
"in": "query",
"required": false,
"type": "string",
- "description": "The expand expression to apply to the operation."
+ "description": "The expand expression to apply to the operation. Allowed values are 'instanceView'."
}
],
"responses": {
@@ -4405,6 +4405,9 @@
},
"description": "The input object for ConvertToSinglePlacementGroup API."
},
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
{
"$ref": "#/parameters/SubscriptionIdParameter"
}
@@ -4807,21 +4810,21 @@
"in": "query",
"required": false,
"type": "string",
- "description": "The filter to apply to the operation."
+ "description": "The filter to apply to the operation. Allowed values are 'startswith(instanceView/statuses/code, 'PowerState') eq true', 'properties/latestModelApplied eq true', 'properties/latestModelApplied eq false'."
},
{
"name": "$select",
"in": "query",
"required": false,
"type": "string",
- "description": "The list parameters."
+ "description": "The list parameters. Allowed values are 'instanceView', 'instanceView/statuses'."
},
{
"name": "$expand",
"in": "query",
"required": false,
"type": "string",
- "description": "The expand expression to apply to the operation."
+ "description": "The expand expression to apply to the operation. Allowed values are 'instanceView'."
},
{
"$ref": "#/parameters/ApiVersionParameter"
diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/ListAvailabilitySetsInASubscription.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/ListAvailabilitySetsInASubscription.json
index d7c2558571ef..f7b93ed9e9b9 100644
--- a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/ListAvailabilitySetsInASubscription.json
+++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/ListAvailabilitySetsInASubscription.json
@@ -2,7 +2,7 @@
"parameters": {
"subscriptionId": "{subscriptionId}",
"api-version": "2019-03-01",
- "$expand": "virtualMachines\\$ref"
+ "$expand": "instanceView"
},
"responses": {
"200": {
diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-04-01/skus.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-04-01/skus.json
index e579007e9eaa..c568990135eb 100644
--- a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-04-01/skus.json
+++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-04-01/skus.json
@@ -54,7 +54,7 @@
"in": "query",
"required": false,
"type": "string",
- "description": "The filter to apply on the operation."
+ "description": "The filter to apply on the operation. Only **location** filter is supported currently."
}
],
"responses": {
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 b125a7a590f1..f0df5077fd9c 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
@@ -251,7 +251,7 @@
"in": "query",
"required": false,
"type": "string",
- "description": "The expand expression to apply to the operation."
+ "description": "The expand expression to apply to the operation. Allowed values are 'instanceView'."
}
],
"responses": {
@@ -4560,6 +4560,9 @@
},
"description": "The input object for ConvertToSinglePlacementGroup API."
},
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
{
"$ref": "#/parameters/SubscriptionIdParameter"
}
@@ -5313,21 +5316,21 @@
"in": "query",
"required": false,
"type": "string",
- "description": "The filter to apply to the operation."
+ "description": "The filter to apply to the operation. Allowed values are 'startswith(instanceView/statuses/code, 'PowerState') eq true', 'properties/latestModelApplied eq true', 'properties/latestModelApplied eq false'."
},
{
"name": "$select",
"in": "query",
"required": false,
"type": "string",
- "description": "The list parameters."
+ "description": "The list parameters. Allowed values are 'instanceView', 'instanceView/statuses'."
},
{
"name": "$expand",
"in": "query",
"required": false,
"type": "string",
- "description": "The expand expression to apply to the operation."
+ "description": "The expand expression to apply to the operation. Allowed values are 'instanceView'."
},
{
"$ref": "#/parameters/ApiVersionParameter"
diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/ListAvailabilitySetsInASubscription.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/ListAvailabilitySetsInASubscription.json
index 719e9496ee1e..a76d7a10ce71 100644
--- a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/ListAvailabilitySetsInASubscription.json
+++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/ListAvailabilitySetsInASubscription.json
@@ -2,7 +2,7 @@
"parameters": {
"subscriptionId": "{subscriptionId}",
"api-version": "2019-07-01",
- "$expand": "virtualMachines\\$ref"
+ "$expand": "instanceView"
},
"responses": {
"200": {
diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/gallery.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/gallery.json
index 271186b61e9a..ad40111669f1 100644
--- a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/gallery.json
+++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/gallery.json
@@ -2223,9 +2223,6 @@
"description": "The id of the gallery artifact version source. Can specify a disk uri, snapshot uri, or user image."
}
},
- "required": [
- "id"
- ],
"description": "The gallery artifact version source."
},
"GalleryOSDiskImage": {
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 99c290c8418a..4e9f646b5399 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
@@ -251,7 +251,7 @@
"in": "query",
"required": false,
"type": "string",
- "description": "The expand expression to apply to the operation."
+ "description": "The expand expression to apply to the operation. Allowed values are 'instanceView'."
}
],
"responses": {
@@ -3439,13 +3439,13 @@
"x-ms-long-running-operation": true
}
},
- "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/SimulateEviction": {
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/simulateEviction": {
"post": {
"tags": [
"VirtualMachines"
],
- "operationId": "VirtualMachines_SimulateEviction",
- "description": "The operation to simulate the eviction of spot virtual machine",
+ "operationId": "VirtualMachines_simulateEviction",
+ "description": "The operation to simulate the eviction of spot virtual machine. The eviction will occur within 30 minutes of calling the API",
"parameters": [
{
"name": "resourceGroupName",
@@ -4902,6 +4902,9 @@
},
"description": "The input object for ConvertToSinglePlacementGroup API."
},
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
{
"$ref": "#/parameters/SubscriptionIdParameter"
}
@@ -5704,21 +5707,21 @@
"in": "query",
"required": false,
"type": "string",
- "description": "The filter to apply to the operation."
+ "description": "The filter to apply to the operation. Allowed values are 'startswith(instanceView/statuses/code, 'PowerState') eq true', 'properties/latestModelApplied eq true', 'properties/latestModelApplied eq false'."
},
{
"name": "$select",
"in": "query",
"required": false,
"type": "string",
- "description": "The list parameters."
+ "description": "The list parameters. Allowed values are 'instanceView', 'instanceView/statuses'."
},
{
"name": "$expand",
"in": "query",
"required": false,
"type": "string",
- "description": "The expand expression to apply to the operation."
+ "description": "The expand expression to apply to the operation. Allowed values are 'instanceView'."
},
{
"$ref": "#/parameters/ApiVersionParameter"
@@ -5984,6 +5987,55 @@
"x-ms-long-running-operation": true
}
},
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualMachines/{instanceId}/simulateEviction": {
+ "post": {
+ "tags": [
+ "VirtualMachineScaleSetVMs"
+ ],
+ "operationId": "VirtualMachineScaleSetVMs_simulateEviction",
+ "description": "The operation to simulate the eviction of spot virtual machine in a VM scale set. The eviction will occur within 30 minutes of calling the API",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group."
+ },
+ {
+ "name": "vmScaleSetName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the VM scale set."
+ },
+ {
+ "name": "instanceId",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The instance ID of the virtual machine."
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "No Content"
+ }
+ },
+ "x-ms-long-running-operation": false,
+ "x-ms-examples": {
+ "Simulate Eviction a virtual machine.": {
+ "$ref": "./examples/SimulateEvictionOfVmssVM.json"
+ }
+ }
+ }
+ },
"/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/logAnalytics/apiAccess/getRequestRateByInterval": {
"post": {
"tags": [
@@ -8404,7 +8456,7 @@
},
"evictionPolicy": {
"$ref": "#/definitions/evictionPolicy",
- "description": "Specifies the eviction policy for the Azure Spot virtual machine and Azure Spot scale set.
For Azure Spot virtual machines, the only supported value is 'Deallocate' and the minimum api-version is 2019-03-01.
For Azure Spot scale sets, both 'Deallocate' and 'Delete' are supported and the minimum api-version is 2017-10-30-preview."
+ "description": "Specifies the eviction policy for the Azure Spot virtual machine and Azure Spot scale set.
For Azure Spot virtual machines, both 'Deallocate' and 'Delete' are supported and the minimum api-version is 2019-03-01.
For Azure Spot scale sets, both 'Deallocate' and 'Delete' are supported and the minimum api-version is 2017-10-30-preview."
},
"billingProfile": {
"$ref": "#/definitions/BillingProfile",
@@ -9184,14 +9236,14 @@
"items": {
"$ref": "#/definitions/SubResource"
},
- "description": "Specifies an array of references to backend address pools of load balancers. A scale set can reference backend address pools of one public and one internal load balancer. Multiple scale sets cannot use the same load balancer."
+ "description": "Specifies an array of references to backend address pools of load balancers. A scale set can reference backend address pools of one public and one internal load balancer. Multiple scale sets cannot use the same basic sku load balancer."
},
"loadBalancerInboundNatPools": {
"type": "array",
"items": {
"$ref": "#/definitions/SubResource"
},
- "description": "Specifies an array of references to inbound Nat pools of the load balancers. A scale set can reference inbound nat pools of one public and one internal load balancer. Multiple scale sets cannot use the same load balancer"
+ "description": "Specifies an array of references to inbound Nat pools of the load balancers. A scale set can reference inbound nat pools of one public and one internal load balancer. Multiple scale sets cannot use the same basic sku load balancer."
}
},
"description": "Describes a virtual machine scale set network profile's IP configuration properties."
@@ -9702,7 +9754,7 @@
},
"evictionPolicy": {
"$ref": "#/definitions/evictionPolicy",
- "description": "Specifies the eviction policy for the Azure Spot virtual machine and Azure Spot scale set.
For Azure Spot virtual machines, the only supported value is 'Deallocate' and the minimum api-version is 2019-03-01.
For Azure Spot scale sets, both 'Deallocate' and 'Delete' are supported and the minimum api-version is 2017-10-30-preview."
+ "description": "Specifies the eviction policy for the Azure Spot virtual machine and Azure Spot scale set.
For Azure Spot virtual machines, both 'Deallocate' and 'Delete' are supported and the minimum api-version is 2019-03-01.
The properties you can use for eq (equals) or ne (not equals) are: location, resourceType, name, resourceGroup, identity, identity/principalId, plan, plan/publisher, plan/product, plan/name, plan/version, and plan/promotionCode.
For example, to filter by a resource type, use: $filter=resourceType eq 'Microsoft.Network/virtualNetworks'
You can use substringof(value, property) in the filter. The properties you can use for substring are: name and resourceGroup.
For example, to get all resources with 'demo' anywhere in the name, use: $filter=substringof('demo', name)
You can link more than one substringof together by adding and/or operators.
You can filter by tag names and values. For example, to filter for a tag name and value, use $filter=tagName eq 'tag1' and tagValue eq 'Value1'. When you filter by a tag name and value, the tags for each resource are not returned in the results.
You can use some properties together when filtering. The combinations you can use are: substringof and/or resourceType, plan and plan/publisher and plan/name, identity and identity/principalId."
+ },
+ {
+ "name": "$expand",
+ "in": "query",
+ "required": false,
+ "type": "string",
+ "description": "Comma-separated list of additional properties to be included in the response. Valid values include `createdTime`, `changedTime` and `provisioningState`. For example, `$expand=createdTime,changedTime`."
+ },
+ {
+ "name": "$top",
+ "in": "query",
+ "required": false,
+ "type": "integer",
+ "format": "int32",
+ "description": "The number of results to return. If null is passed, returns all resources."
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - Returns an array of resources",
+ "schema": {
+ "$ref": "#/definitions/ResourceListResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-odata": "#/definitions/GenericResourceFilter"
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}": {
+ "head": {
+ "tags": [
+ "ResourceGroups"
+ ],
+ "operationId": "ResourceGroups_CheckExistence",
+ "description": "Checks whether a resource group exists.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group to check. The name is case insensitive.",
+ "pattern": "^[-\\w\\._\\(\\)]+$",
+ "minLength": 1,
+ "maxLength": 90
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "No Content"
+ },
+ "404": {
+ "description": "Not Found"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "ResourceGroups"
+ ],
+ "x-ms-examples": {
+ "Create or update a resource group": {
+ "$ref": "./examples/CreateResourceGroup.json"
+ }
+ },
+ "operationId": "ResourceGroups_CreateOrUpdate",
+ "description": "Creates or updates a resource group.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group to create or update. Can include alphanumeric, underscore, parentheses, hyphen, period (except at end), and Unicode characters that match the allowed characters.",
+ "pattern": "^[-\\w\\._\\(\\)]+$",
+ "minLength": 1,
+ "maxLength": 90
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/ResourceGroup"
+ },
+ "description": "Parameters supplied to the create or update a resource group."
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - Returns information about the new resource group.",
+ "schema": {
+ "$ref": "#/definitions/ResourceGroup"
+ }
+ },
+ "201": {
+ "description": "Created - Returns information about the new resource group.",
+ "schema": {
+ "$ref": "#/definitions/ResourceGroup"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "ResourceGroups"
+ ],
+ "operationId": "ResourceGroups_Delete",
+ "summary": "Deletes a resource group.",
+ "description": "When you delete a resource group, all of its resources are also deleted. Deleting a resource group deletes all of its template deployments and currently stored operations.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group to delete. The name is case insensitive.",
+ "pattern": "^[-\\w\\._\\(\\)]+$",
+ "minLength": 1,
+ "maxLength": 90
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK"
+ },
+ "202": {
+ "description": "Accepted"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true
+ },
+ "get": {
+ "tags": [
+ "ResourceGroups"
+ ],
+ "operationId": "ResourceGroups_Get",
+ "description": "Gets a resource group.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group to get. The name is case insensitive.",
+ "pattern": "^[-\\w\\._\\(\\)]+$",
+ "minLength": 1,
+ "maxLength": 90
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - Returns information about the resource group.",
+ "schema": {
+ "$ref": "#/definitions/ResourceGroup"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ }
+ },
+ "patch": {
+ "tags": [
+ "ResourceGroups"
+ ],
+ "operationId": "ResourceGroups_Update",
+ "summary": "Updates a resource group.",
+ "description": "Resource groups can be updated through a simple PATCH operation to a group address. The format of the request is the same as that for creating a resource group. If a field is unspecified, the current value is retained.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group to update. The name is case insensitive.",
+ "pattern": "^[-\\w\\._\\(\\)]+$",
+ "minLength": 1,
+ "maxLength": 90
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/ResourceGroupPatchable"
+ },
+ "description": "Parameters supplied to update a resource group."
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - Returns information about the resource group.",
+ "schema": {
+ "$ref": "#/definitions/ResourceGroup"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/exportTemplate": {
+ "post": {
+ "tags": [
+ "ResourceGroups"
+ ],
+ "operationId": "ResourceGroups_ExportTemplate",
+ "description": "Captures the specified resource group as a template.",
+ "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": "parameters",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/ExportTemplateRequest"
+ },
+ "description": "Parameters for exporting the template."
+ }
+ ],
+ "x-ms-examples": {
+ "Export a resource group": {
+ "$ref": "./examples/ExportResourceGroup.json"
+ },
+ "Export a resource group with filtering": {
+ "$ref": "./examples/ExportResourceGroupWithFiltering.json"
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "OK - Returns the result of the export.",
+ "schema": {
+ "$ref": "#/definitions/ResourceGroupExportResult"
+ }
+ },
+ "202": {
+ "description": "Accepted"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-long-running-operation-options": {
+ "final-state-via": "location"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourcegroups": {
+ "get": {
+ "tags": [
+ "ResourceGroups"
+ ],
+ "operationId": "ResourceGroups_List",
+ "description": "Gets all the resource groups for a subscription.",
+ "parameters": [
+ {
+ "name": "$filter",
+ "in": "query",
+ "required": false,
+ "type": "string",
+ "description": "The filter to apply on the operation.
You can filter by tag names and values. For example, to filter for a tag name and value, use $filter=tagName eq 'tag1' and tagValue eq 'Value1'"
+ },
+ {
+ "name": "$top",
+ "in": "query",
+ "required": false,
+ "type": "integer",
+ "format": "int32",
+ "description": "The number of results to return. If null is passed, returns all resource groups."
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - Returns an array of resource groups.",
+ "schema": {
+ "$ref": "#/definitions/ResourceGroupListResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-odata": "#/definitions/ResourceGroupFilter"
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{sourceResourceGroupName}/moveResources": {
+ "post": {
+ "tags": [
+ "Resources"
+ ],
+ "operationId": "Resources_MoveResources",
+ "summary": "Moves resources from one resource group to another resource group.",
+ "description": "The resources to move must be in the same source resource group. The target resource group may be in a different subscription. When moving resources, both the source group and the target group are locked for the duration of the operation. Write and delete operations are blocked on the groups until the move completes. ",
+ "parameters": [
+ {
+ "name": "sourceResourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group containing the resources to move.",
+ "pattern": "^[-\\w\\._\\(\\)]+$",
+ "minLength": 1,
+ "maxLength": 90
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/ResourcesMoveInfo"
+ },
+ "description": "Parameters for moving resources."
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "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
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{sourceResourceGroupName}/validateMoveResources": {
+ "post": {
+ "tags": [
+ "Resources"
+ ],
+ "operationId": "Resources_ValidateMoveResources",
+ "summary": "Validates whether resources can be moved from one resource group to another resource group.",
+ "description": "This operation checks whether the specified resources can be moved to the target. The resources to move must be in the same source resource group. The target resource group may be in a different subscription. If validation succeeds, it returns HTTP response code 204 (no content). If validation fails, it returns HTTP response code 409 (Conflict) with an error message. Retrieve the URL in the Location header value to check the result of the long-running operation.",
+ "parameters": [
+ {
+ "name": "sourceResourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group containing the resources to validate for move.",
+ "pattern": "^[-\\w\\._\\(\\)]+$",
+ "minLength": 1,
+ "maxLength": 90
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/ResourcesMoveInfo"
+ },
+ "description": "Parameters for moving resources."
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SourceSubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "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
+ }
+ },
+ "/subscriptions/{subscriptionId}/resources": {
+ "get": {
+ "tags": [
+ "Resources"
+ ],
+ "operationId": "Resources_List",
+ "description": "Get all the resources in a subscription.",
+ "parameters": [
+ {
+ "name": "$filter",
+ "in": "query",
+ "required": false,
+ "type": "string",
+ "description": "The filter to apply on the operation.
The properties you can use for eq (equals) or ne (not equals) are: location, resourceType, name, resourceGroup, identity, identity/principalId, plan, plan/publisher, plan/product, plan/name, plan/version, and plan/promotionCode.
For example, to filter by a resource type, use: $filter=resourceType eq 'Microsoft.Network/virtualNetworks'
You can use substringof(value, property) in the filter. The properties you can use for substring are: name and resourceGroup.
For example, to get all resources with 'demo' anywhere in the name, use: $filter=substringof('demo', name)
You can link more than one substringof together by adding and/or operators.
You can filter by tag names and values. For example, to filter for a tag name and value, use $filter=tagName eq 'tag1' and tagValue eq 'Value1'. When you filter by a tag name and value, the tags for each resource are not returned in the results.
You can use some properties together when filtering. The combinations you can use are: substringof and/or resourceType, plan and plan/publisher and plan/name, identity and identity/principalId."
+ },
+ {
+ "name": "$expand",
+ "in": "query",
+ "required": false,
+ "type": "string",
+ "description": "Comma-separated list of additional properties to be included in the response. Valid values include `createdTime`, `changedTime` and `provisioningState`. For example, `$expand=createdTime,changedTime`."
+ },
+ {
+ "name": "$top",
+ "in": "query",
+ "required": false,
+ "type": "integer",
+ "format": "int32",
+ "description": "The number of results to return. If null is passed, returns all resource groups."
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - Returns an array of resources.",
+ "schema": {
+ "$ref": "#/definitions/ResourceListResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-odata": "#/definitions/GenericResourceFilter"
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{parentResourcePath}/{resourceType}/{resourceName}": {
+ "head": {
+ "tags": [
+ "Resources"
+ ],
+ "operationId": "Resources_CheckExistence",
+ "description": "Checks whether a resource exists.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group containing the resource to check. The name is case insensitive.",
+ "pattern": "^[-\\w\\._\\(\\)]+$",
+ "minLength": 1,
+ "maxLength": 90
+ },
+ {
+ "name": "resourceProviderNamespace",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The resource provider of the resource to check."
+ },
+ {
+ "name": "parentResourcePath",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The parent resource identity.",
+ "x-ms-skip-url-encoding": true
+ },
+ {
+ "name": "resourceType",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The resource type.",
+ "x-ms-skip-url-encoding": true
+ },
+ {
+ "name": "resourceName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource to check whether it exists."
+ },
+ {
+ "name": "api-version",
+ "in": "query",
+ "required": true,
+ "type": "string",
+ "description": "The API version to use for the operation."
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "No Content"
+ },
+ "404": {
+ "description": "Not Found"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "Resources"
+ ],
+ "operationId": "Resources_Delete",
+ "description": "Deletes a resource.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group that contains the resource to delete. The name is case insensitive.",
+ "pattern": "^[-\\w\\._\\(\\)]+$",
+ "minLength": 1,
+ "maxLength": 90
+ },
+ {
+ "name": "resourceProviderNamespace",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The namespace of the resource provider."
+ },
+ {
+ "name": "parentResourcePath",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The parent resource identity.",
+ "x-ms-skip-url-encoding": true
+ },
+ {
+ "name": "resourceType",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The resource type.",
+ "x-ms-skip-url-encoding": true
+ },
+ {
+ "name": "resourceName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource to delete."
+ },
+ {
+ "name": "api-version",
+ "in": "query",
+ "required": true,
+ "type": "string",
+ "description": "The API version to use for the operation."
+ },
+ {
+ "$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
+ },
+ "put": {
+ "tags": [
+ "Resources"
+ ],
+ "operationId": "Resources_CreateOrUpdate",
+ "description": "Creates a resource.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group for the resource. The name is case insensitive.",
+ "pattern": "^[-\\w\\._\\(\\)]+$",
+ "minLength": 1,
+ "maxLength": 90
+ },
+ {
+ "name": "resourceProviderNamespace",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The namespace of the resource provider."
+ },
+ {
+ "name": "parentResourcePath",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The parent resource identity.",
+ "x-ms-skip-url-encoding": true
+ },
+ {
+ "name": "resourceType",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The resource type of the resource to create.",
+ "x-ms-skip-url-encoding": true
+ },
+ {
+ "name": "resourceName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource to create."
+ },
+ {
+ "name": "api-version",
+ "in": "query",
+ "required": true,
+ "type": "string",
+ "description": "The API version to use for the operation."
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/GenericResource"
+ },
+ "description": "Parameters for creating or updating the resource."
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - Returns information about the resource.",
+ "schema": {
+ "$ref": "#/definitions/GenericResource"
+ }
+ },
+ "201": {
+ "description": "Created - Returns information about the resource.",
+ "schema": {
+ "$ref": "#/definitions/GenericResource"
+ }
+ },
+ "202": {
+ "description": "Accepted"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true
+ },
+ "patch": {
+ "tags": [
+ "Resources"
+ ],
+ "operationId": "Resources_Update",
+ "description": "Updates a resource.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group for the resource. The name is case insensitive.",
+ "pattern": "^[-\\w\\._\\(\\)]+$",
+ "minLength": 1,
+ "maxLength": 90
+ },
+ {
+ "name": "resourceProviderNamespace",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The namespace of the resource provider."
+ },
+ {
+ "name": "parentResourcePath",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The parent resource identity.",
+ "x-ms-skip-url-encoding": true
+ },
+ {
+ "name": "resourceType",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The resource type of the resource to update.",
+ "x-ms-skip-url-encoding": true
+ },
+ {
+ "name": "resourceName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource to update."
+ },
+ {
+ "name": "api-version",
+ "in": "query",
+ "required": true,
+ "type": "string",
+ "description": "The API version to use for the operation."
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/GenericResource"
+ },
+ "description": "Parameters for updating the resource."
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - Returns information about the resource.",
+ "schema": {
+ "$ref": "#/definitions/GenericResource"
+ }
+ },
+ "202": {
+ "description": "Accepted"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true
+ },
+ "get": {
+ "tags": [
+ "Resources"
+ ],
+ "operationId": "Resources_Get",
+ "description": "Gets a resource.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group containing the resource to get. The name is case insensitive.",
+ "pattern": "^[-\\w\\._\\(\\)]+$",
+ "minLength": 1,
+ "maxLength": 90
+ },
+ {
+ "name": "resourceProviderNamespace",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The namespace of the resource provider."
+ },
+ {
+ "name": "parentResourcePath",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The parent resource identity.",
+ "x-ms-skip-url-encoding": true
+ },
+ {
+ "name": "resourceType",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The resource type of the resource.",
+ "x-ms-skip-url-encoding": true
+ },
+ {
+ "name": "resourceName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource to get."
+ },
+ {
+ "name": "api-version",
+ "in": "query",
+ "required": true,
+ "type": "string",
+ "description": "The API version to use for the operation."
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - Returns information about the resource.",
+ "schema": {
+ "$ref": "#/definitions/GenericResource"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ }
+ }
+ },
+ "/{resourceId}": {
+ "head": {
+ "tags": [
+ "Resources"
+ ],
+ "operationId": "Resources_CheckExistenceById",
+ "description": "Checks by ID whether a resource exists.",
+ "parameters": [
+ {
+ "name": "resourceId",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The fully qualified ID of the resource, including the resource name and resource type. Use the format, /subscriptions/{guid}/resourceGroups/{resource-group-name}/{resource-provider-namespace}/{resource-type}/{resource-name}",
+ "x-ms-skip-url-encoding": true
+ },
+ {
+ "name": "api-version",
+ "in": "query",
+ "required": true,
+ "type": "string",
+ "description": "The API version to use for the operation."
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "No Content"
+ },
+ "404": {
+ "description": "Not Found"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "Resources"
+ ],
+ "operationId": "Resources_DeleteById",
+ "description": "Deletes a resource by ID.",
+ "parameters": [
+ {
+ "name": "resourceId",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The fully qualified ID of the resource, including the resource name and resource type. Use the format, /subscriptions/{guid}/resourceGroups/{resource-group-name}/{resource-provider-namespace}/{resource-type}/{resource-name}",
+ "x-ms-skip-url-encoding": true
+ },
+ {
+ "name": "api-version",
+ "in": "query",
+ "required": true,
+ "type": "string",
+ "description": "The API version to use for the operation."
+ }
+ ],
+ "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
+ },
+ "put": {
+ "tags": [
+ "Resources"
+ ],
+ "operationId": "Resources_CreateOrUpdateById",
+ "description": "Create a resource by ID.",
+ "parameters": [
+ {
+ "name": "resourceId",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The fully qualified ID of the resource, including the resource name and resource type. Use the format, /subscriptions/{guid}/resourceGroups/{resource-group-name}/{resource-provider-namespace}/{resource-type}/{resource-name}",
+ "x-ms-skip-url-encoding": true
+ },
+ {
+ "name": "api-version",
+ "in": "query",
+ "required": true,
+ "type": "string",
+ "description": "The API version to use for the operation."
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/GenericResource"
+ },
+ "description": "Create or update resource parameters."
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - Returns information about the resource.",
+ "schema": {
+ "$ref": "#/definitions/GenericResource"
+ }
+ },
+ "201": {
+ "description": "Created - Returns information about the resource.",
+ "schema": {
+ "$ref": "#/definitions/GenericResource"
+ }
+ },
+ "202": {
+ "description": "Accepted"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true
+ },
+ "patch": {
+ "tags": [
+ "Resources"
+ ],
+ "operationId": "Resources_UpdateById",
+ "description": "Updates a resource by ID.",
+ "parameters": [
+ {
+ "name": "resourceId",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The fully qualified ID of the resource, including the resource name and resource type. Use the format, /subscriptions/{guid}/resourceGroups/{resource-group-name}/{resource-provider-namespace}/{resource-type}/{resource-name}",
+ "x-ms-skip-url-encoding": true
+ },
+ {
+ "name": "api-version",
+ "in": "query",
+ "required": true,
+ "type": "string",
+ "description": "The API version to use for the operation."
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/GenericResource"
+ },
+ "description": "Update resource parameters."
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - Returns information about the resource.",
+ "schema": {
+ "$ref": "#/definitions/GenericResource"
+ }
+ },
+ "202": {
+ "description": "Accepted"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true
+ },
+ "get": {
+ "tags": [
+ "Resources"
+ ],
+ "operationId": "Resources_GetById",
+ "description": "Gets a resource by ID.",
+ "parameters": [
+ {
+ "name": "resourceId",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The fully qualified ID of the resource, including the resource name and resource type. Use the format, /subscriptions/{guid}/resourceGroups/{resource-group-name}/{resource-provider-namespace}/{resource-type}/{resource-name}",
+ "x-ms-skip-url-encoding": true
+ },
+ {
+ "name": "api-version",
+ "in": "query",
+ "required": true,
+ "type": "string",
+ "description": "The API version to use for the operation."
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - Returns information about the resource.",
+ "schema": {
+ "$ref": "#/definitions/GenericResource"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/tagNames/{tagName}/tagValues/{tagValue}": {
+ "delete": {
+ "tags": [
+ "Tags"
+ ],
+ "operationId": "TagsOperation_DeleteValue",
+ "summary": "Deletes a predefined tag value for a predefined tag name.",
+ "description": "This operation allows deleting a value from the list of predefined values for an existing predefined tag name. The value being deleted must not be in use as a tag value for the given tag name for any resource.",
+ "parameters": [
+ {
+ "name": "tagName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the tag."
+ },
+ {
+ "name": "tagValue",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The value of the tag to delete."
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Predefined tag value successfully deleted."
+ },
+ "204": {
+ "description": "Predefined tag value did not exist."
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "Tags"
+ ],
+ "operationId": "TagsOperation_CreateOrUpdateValue",
+ "summary": "Creates a predefined value for a predefined tag name.",
+ "description": "This operation allows adding a value to the list of predefined values for an existing predefined tag name. A tag value can have a maximum of 256 characters.",
+ "parameters": [
+ {
+ "name": "tagName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the tag."
+ },
+ {
+ "name": "tagValue",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The value of the tag to create."
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Predefined tag value already exists. Returns information about the predefined tag value.",
+ "schema": {
+ "$ref": "#/definitions/TagValue"
+ }
+ },
+ "201": {
+ "description": "Predefined tag value successfully created. Returns information about the predefined tag value.",
+ "schema": {
+ "$ref": "#/definitions/TagValue"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/tagNames/{tagName}": {
+ "put": {
+ "tags": [
+ "Tags"
+ ],
+ "operationId": "TagsOperation_CreateOrUpdate",
+ "summary": "Creates a predefined tag name.",
+ "description": "This operation allows adding a name to the list of predefined tag names for the given subscription. A tag name can have a maximum of 512 characters and is case-insensitive. Tag names cannot have the following prefixes which are reserved for Azure use: 'microsoft', 'azure', 'windows'.",
+ "parameters": [
+ {
+ "name": "tagName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the tag to create."
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Predefined tag name already exists. Returns information about the predefined tag name.",
+ "schema": {
+ "$ref": "#/definitions/TagDetails"
+ }
+ },
+ "201": {
+ "description": "Predefined tag name successfully created. Returns information about the predefined tag name.",
+ "schema": {
+ "$ref": "#/definitions/TagDetails"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "Tags"
+ ],
+ "operationId": "TagsOperation_Delete",
+ "summary": "Deletes a predefined tag name.",
+ "description": "This operation allows deleting a name from the list of predefined tag names for the given subscription. The name being deleted must not be in use as a tag name for any resource. All predefined values for the given name must have already been deleted.",
+ "parameters": [
+ {
+ "name": "tagName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the tag."
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Predefined tag name successfully deleted."
+ },
+ "204": {
+ "description": "Predefined tag name did not exist."
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/tagNames": {
+ "get": {
+ "tags": [
+ "Tags"
+ ],
+ "operationId": "TagsOperation_List",
+ "summary": "Gets a summary of tag usage under the subscription.",
+ "description": "This operation performs a union of predefined tags, resource tags, resource group tags and subscription tags, and returns a summary of usage for each tag name and value under the given subscription. In case of a large number of tags, this operation may return a previously cached result.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - Returns an array of tag names and values.",
+ "schema": {
+ "$ref": "#/definitions/TagsListResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/{scope}/providers/Microsoft.Resources/deployments/{deploymentName}/operations/{operationId}": {
+ "get": {
+ "tags": [
+ "DeploymentOperations"
+ ],
+ "operationId": "DeploymentOperations_GetAtScope",
+ "description": "Gets a deployments operation.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ScopeParameter"
+ },
+ {
+ "$ref": "#/parameters/DeploymentNameParameter"
+ },
+ {
+ "name": "operationId",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The ID of the operation to get."
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - Returns information about the deployment operation.",
+ "schema": {
+ "$ref": "#/definitions/DeploymentOperation"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ }
+ }
+ },
+ "/{scope}/providers/Microsoft.Resources/deployments/{deploymentName}/operations": {
+ "get": {
+ "tags": [
+ "DeploymentOperations"
+ ],
+ "operationId": "DeploymentOperations_ListAtScope",
+ "description": "Gets all deployments operations for a deployment.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ScopeParameter"
+ },
+ {
+ "$ref": "#/parameters/DeploymentNameParameter"
+ },
+ {
+ "name": "$top",
+ "in": "query",
+ "required": false,
+ "type": "integer",
+ "format": "int32",
+ "description": "The number of results to return."
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - Return an array of deployment operations.",
+ "schema": {
+ "$ref": "#/definitions/DeploymentOperationsListResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/providers/Microsoft.Resources/deployments/{deploymentName}/operations/{operationId}": {
+ "get": {
+ "tags": [
+ "DeploymentOperations"
+ ],
+ "operationId": "DeploymentOperations_GetAtTenantScope",
+ "description": "Gets a deployments operation.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/DeploymentNameParameter"
+ },
+ {
+ "name": "operationId",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The ID of the operation to get."
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - Returns information about the deployment operation.",
+ "schema": {
+ "$ref": "#/definitions/DeploymentOperation"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ }
+ }
+ },
+ "/providers/Microsoft.Resources/deployments/{deploymentName}/operations": {
+ "get": {
+ "tags": [
+ "DeploymentOperations"
+ ],
+ "operationId": "DeploymentOperations_ListAtTenantScope",
+ "description": "Gets all deployments operations for a deployment.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/DeploymentNameParameter"
+ },
+ {
+ "name": "$top",
+ "in": "query",
+ "required": false,
+ "type": "integer",
+ "format": "int32",
+ "description": "The number of results to return."
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - Return an array of deployment operations.",
+ "schema": {
+ "$ref": "#/definitions/DeploymentOperationsListResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/providers/Microsoft.Management/managementGroups/{groupId}/providers/Microsoft.Resources/deployments/{deploymentName}/operations/{operationId}": {
+ "get": {
+ "tags": [
+ "DeploymentOperations"
+ ],
+ "operationId": "DeploymentOperations_GetAtManagementGroupScope",
+ "description": "Gets a deployments operation.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/GroupIdParameter"
+ },
+ {
+ "$ref": "#/parameters/DeploymentNameParameter"
+ },
+ {
+ "name": "operationId",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The ID of the operation to get."
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - Returns information about the deployment operation.",
+ "schema": {
+ "$ref": "#/definitions/DeploymentOperation"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ }
+ }
+ },
+ "/providers/Microsoft.Management/managementGroups/{groupId}/providers/Microsoft.Resources/deployments/{deploymentName}/operations": {
+ "get": {
+ "tags": [
+ "DeploymentOperations"
+ ],
+ "operationId": "DeploymentOperations_ListAtManagementGroupScope",
+ "description": "Gets all deployments operations for a deployment.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/GroupIdParameter"
+ },
+ {
+ "$ref": "#/parameters/DeploymentNameParameter"
+ },
+ {
+ "name": "$top",
+ "in": "query",
+ "required": false,
+ "type": "integer",
+ "format": "int32",
+ "description": "The number of results to return."
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - Return an array of deployment operations.",
+ "schema": {
+ "$ref": "#/definitions/DeploymentOperationsListResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/providers/Microsoft.Resources/deployments/{deploymentName}/operations/{operationId}": {
+ "get": {
+ "tags": [
+ "DeploymentOperations"
+ ],
+ "operationId": "DeploymentOperations_GetAtSubscriptionScope",
+ "description": "Gets a deployments operation.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/DeploymentNameParameter"
+ },
+ {
+ "name": "operationId",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The ID of the operation to get."
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - Returns information about the deployment operation.",
+ "schema": {
+ "$ref": "#/definitions/DeploymentOperation"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/providers/Microsoft.Resources/deployments/{deploymentName}/operations": {
+ "get": {
+ "tags": [
+ "DeploymentOperations"
+ ],
+ "operationId": "DeploymentOperations_ListAtSubscriptionScope",
+ "description": "Gets all deployments operations for a deployment.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/DeploymentNameParameter"
+ },
+ {
+ "name": "$top",
+ "in": "query",
+ "required": false,
+ "type": "integer",
+ "format": "int32",
+ "description": "The number of results to return."
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - Return an array of deployment operations.",
+ "schema": {
+ "$ref": "#/definitions/DeploymentOperationsListResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/deployments/{deploymentName}/operations/{operationId}": {
+ "get": {
+ "tags": [
+ "DeploymentOperations"
+ ],
+ "operationId": "DeploymentOperations_Get",
+ "description": "Gets a deployments operation.",
+ "parameters": [
+ {
+ "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
+ },
+ {
+ "$ref": "#/parameters/DeploymentNameParameter"
+ },
+ {
+ "name": "operationId",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The ID of the operation to get."
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - Returns information about the deployment operation.",
+ "schema": {
+ "$ref": "#/definitions/DeploymentOperation"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/deployments/{deploymentName}/operations": {
+ "get": {
+ "tags": [
+ "DeploymentOperations"
+ ],
+ "operationId": "DeploymentOperations_List",
+ "description": "Gets all deployments operations for a deployment.",
+ "parameters": [
+ {
+ "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
+ },
+ {
+ "$ref": "#/parameters/DeploymentNameParameter"
+ },
+ {
+ "name": "$top",
+ "in": "query",
+ "required": false,
+ "type": "integer",
+ "format": "int32",
+ "description": "The number of results to return."
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - Return an array of deployment operations.",
+ "schema": {
+ "$ref": "#/definitions/DeploymentOperationsListResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/providers/Microsoft.Resources/calculateTemplateHash": {
+ "post": {
+ "tags": [
+ "Deployments"
+ ],
+ "operationId": "Deployments_CalculateTemplateHash",
+ "description": "Calculate the hash of the given template.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "name": "template",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "type": "object"
+ },
+ "description": "The template provided to calculate hash."
+ }
+ ],
+ "x-ms-examples": {
+ "Calculate template hash": {
+ "$ref": "./examples/CalculateTemplateHash.json"
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "OK - Returns the hash.",
+ "schema": {
+ "$ref": "#/definitions/TemplateHashResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ }
+ }
+ },
+ "/{scope}/providers/Microsoft.Resources/tags/default": {
+ "put": {
+ "tags": [
+ "Tags"
+ ],
+ "operationId": "TagsOperation_CreateOrUpdateAtScope",
+ "summary": "Creates or updates the entire set of tags on a resource or subscription.",
+ "description": "This operation allows adding or replacing the entire set of tags on the specified resource or subscription. The specified entity can have a maximum of 50 tags.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ScopeParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/TagsResource"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Tags updated successfully. Returns tags from the specified object.",
+ "schema": {
+ "$ref": "#/definitions/TagsResource"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Update tags on a resource": {
+ "$ref": "./examples/PutTagsResource.json"
+ },
+ "Update tags on a subscription": {
+ "$ref": "./examples/PutTagsSubscription.json"
+ }
+ }
+ },
+ "patch": {
+ "tags": [
+ "Tags"
+ ],
+ "operationId": "TagsOperation_UpdateAtScope",
+ "summary": "Selectively updates the set of tags on a resource or subscription.",
+ "description": "This operation allows replacing, merging or selectively deleting tags on the specified resource or subscription. The specified entity can have a maximum of 50 tags at the end of the operation. The 'replace' option replaces the entire set of existing tags with a new set. The 'merge' option allows adding tags with new names and updating the values of tags with existing names. The 'delete' option allows selectively deleting tags based on given names or name/value pairs.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ScopeParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/TagsPatchResource"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Tags updated successfully. Returns tags from the specified object.",
+ "schema": {
+ "$ref": "#/definitions/TagsResource"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ }
+ },
+ "get": {
+ "tags": [
+ "Tags"
+ ],
+ "operationId": "TagsOperation_GetAtScope",
+ "summary": "Gets the entire set of tags on a resource or subscription.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ScopeParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Returns tags from the specified object.",
+ "schema": {
+ "$ref": "#/definitions/TagsResource"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Get tags on a resource": {
+ "$ref": "./examples/GetTagsResource.json"
+ },
+ "Get tags on a subscription": {
+ "$ref": "./examples/GetTagsSubscription.json"
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "Tags"
+ ],
+ "operationId": "TagsOperation_DeleteAtScope",
+ "summary": "Deletes the entire set of tags on a resource or subscription.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ScopeParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Tags successfully deleted."
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ }
+ }
+ }
+ },
+ "definitions": {
+ "DeploymentExtendedFilter": {
+ "properties": {
+ "provisioningState": {
+ "type": "string",
+ "description": "The provisioning state."
+ }
+ },
+ "description": "Deployment filter."
+ },
+ "GenericResourceFilter": {
+ "properties": {
+ "resourceType": {
+ "type": "string",
+ "description": "The resource type."
+ },
+ "tagname": {
+ "type": "string",
+ "description": "The tag name."
+ },
+ "tagvalue": {
+ "type": "string",
+ "description": "The tag value."
+ }
+ },
+ "description": "Resource filter."
+ },
+ "ResourceGroupFilter": {
+ "properties": {
+ "tagName": {
+ "type": "string",
+ "description": "The tag name."
+ },
+ "tagValue": {
+ "type": "string",
+ "description": "The tag value."
+ }
+ },
+ "description": "Resource group filter."
+ },
+ "TemplateLink": {
+ "properties": {
+ "uri": {
+ "type": "string",
+ "description": "The URI of the template to deploy. Use either the uri or id property, but not both."
+ },
+ "id": {
+ "type": "string",
+ "description": "The resource id of a Template Spec. Use either the id or uri property, but not both."
+ },
+ "relativePath": {
+ "type": "string",
+ "description": "Applicable only if this template link references a Template Spec. This relativePath property can optionally be used to reference a Template Spec artifact by path."
+ },
+ "contentVersion": {
+ "type": "string",
+ "description": "If included, must match the ContentVersion in the template."
+ }
+ },
+ "description": "Entity representing the reference to the template."
+ },
+ "ParametersLink": {
+ "properties": {
+ "uri": {
+ "type": "string",
+ "description": "The URI of the parameters file."
+ },
+ "contentVersion": {
+ "type": "string",
+ "description": "If included, must match the ContentVersion in the template."
+ }
+ },
+ "required": [
+ "uri"
+ ],
+ "description": "Entity representing the reference to the deployment parameters."
+ },
+ "DeploymentProperties": {
+ "properties": {
+ "template": {
+ "type": "object",
+ "description": "The template content. You use this element when you want to pass the template syntax directly in the request rather than link to an existing template. It can be a JObject or well-formed JSON string. Use either the templateLink property or the template property, but not both."
+ },
+ "templateLink": {
+ "$ref": "#/definitions/TemplateLink",
+ "description": "The URI of the template. Use either the templateLink property or the template property, but not both."
+ },
+ "parameters": {
+ "type": "object",
+ "description": "Name and value pairs that define the deployment parameters for the template. You use this element when you want to provide the parameter values directly in the request rather than link to an existing parameter file. Use either the parametersLink property or the parameters property, but not both. It can be a JObject or a well formed JSON string."
+ },
+ "parametersLink": {
+ "$ref": "#/definitions/ParametersLink",
+ "description": "The URI of parameters file. You use this element to link to an existing parameters file. Use either the parametersLink property or the parameters property, but not both."
+ },
+ "mode": {
+ "type": "string",
+ "description": "The mode that is used to deploy resources. This value can be either Incremental or Complete. In Incremental mode, resources are deployed without deleting existing resources that are not included in the template. In Complete mode, resources are deployed and existing resources in the resource group that are not included in the template are deleted. Be careful when using Complete mode as you may unintentionally delete resources.",
+ "enum": [
+ "Incremental",
+ "Complete"
+ ],
+ "x-ms-enum": {
+ "name": "DeploymentMode",
+ "modelAsString": false
+ }
+ },
+ "debugSetting": {
+ "$ref": "#/definitions/DebugSetting",
+ "description": "The debug setting of the deployment."
+ },
+ "onErrorDeployment": {
+ "$ref": "#/definitions/OnErrorDeployment",
+ "description": "The deployment on error behavior."
+ }
+ },
+ "required": [
+ "mode"
+ ],
+ "description": "Deployment properties."
+ },
+ "DebugSetting": {
+ "properties": {
+ "detailLevel": {
+ "type": "string",
+ "description": "Specifies the type of information to log for debugging. The permitted values are none, requestContent, responseContent, or both requestContent and responseContent separated by a comma. The default is none. When setting this value, carefully consider the type of information you are passing in during deployment. By logging information about the request or response, you could potentially expose sensitive data that is retrieved through the deployment operations."
+ }
+ },
+ "description": "The debug setting."
+ },
+ "Deployment": {
+ "properties": {
+ "location": {
+ "type": "string",
+ "description": "The location to store the deployment data."
+ },
+ "properties": {
+ "$ref": "#/definitions/DeploymentProperties",
+ "description": "The deployment properties."
+ },
+ "tags": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Deployment tags"
+ }
+ },
+ "required": [
+ "properties"
+ ],
+ "description": "Deployment operation parameters."
+ },
+ "ScopedDeployment": {
+ "properties": {
+ "location": {
+ "type": "string",
+ "description": "The location to store the deployment data."
+ },
+ "properties": {
+ "$ref": "#/definitions/DeploymentProperties",
+ "description": "The deployment properties."
+ },
+ "tags": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Deployment tags"
+ }
+ },
+ "required": [
+ "location",
+ "properties"
+ ],
+ "description": "Deployment operation parameters."
+ },
+ "DeploymentExportResult": {
+ "properties": {
+ "template": {
+ "type": "object",
+ "description": "The template content."
+ }
+ },
+ "description": "The deployment export result. "
+ },
+ "DeploymentWhatIf": {
+ "properties": {
+ "location": {
+ "type": "string",
+ "description": "The location to store the deployment data."
+ },
+ "properties": {
+ "$ref": "#/definitions/DeploymentWhatIfProperties",
+ "description": "The deployment properties."
+ }
+ },
+ "required": [
+ "properties"
+ ],
+ "description": "Deployment What-if operation parameters."
+ },
+ "DeploymentWhatIfProperties": {
+ "properties": {
+ "whatIfSettings": {
+ "$ref": "#/definitions/DeploymentWhatIfSettings",
+ "description": "Optional What-If operation settings."
+ }
+ },
+ "allOf": [
+ {
+ "$ref": "#/definitions/DeploymentProperties"
+ }
+ ],
+ "description": "Deployment What-if properties."
+ },
+ "DeploymentWhatIfSettings": {
+ "properties": {
+ "resultFormat": {
+ "type": "string",
+ "description": "The format of the What-If results",
+ "enum": [
+ "ResourceIdOnly",
+ "FullResourcePayloads"
+ ],
+ "x-ms-enum": {
+ "name": "WhatIfResultFormat",
+ "modelAsString": false
+ }
+ }
+ },
+ "description": "Deployment What-If operation settings."
+ },
+ "CloudError": {
+ "x-ms-external": true,
+ "properties": {
+ "error": {
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ErrorResponse"
+ }
+ },
+ "description": "An error response for a resource management request."
+ },
+ "AliasPath": {
+ "properties": {
+ "path": {
+ "type": "string",
+ "description": "The path of an alias."
+ },
+ "apiVersions": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "The API versions."
+ },
+ "pattern": {
+ "$ref": "#/definitions/AliasPattern",
+ "description": "The pattern for an alias path."
+ }
+ },
+ "description": "The type of the paths for alias."
+ },
+ "AliasPattern": {
+ "properties": {
+ "phrase": {
+ "type": "string",
+ "description": "The alias pattern phrase."
+ },
+ "variable": {
+ "type": "string",
+ "description": "The alias pattern variable."
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "NotSpecified",
+ "Extract"
+ ],
+ "x-ms-enum": {
+ "name": "AliasPatternType",
+ "modelAsString": false,
+ "values": [
+ {
+ "value": "NotSpecified",
+ "description": "NotSpecified is not allowed."
+ },
+ {
+ "value": "Extract",
+ "description": "Extract is the only allowed value."
+ }
+ ]
+ },
+ "description": "The type of alias pattern"
+ }
+ },
+ "description": "The type of the pattern for an alias path."
+ },
+ "Alias": {
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "The alias name."
+ },
+ "paths": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/AliasPath"
+ },
+ "description": "The paths for an alias."
+ },
+ "type": {
+ "type": "string",
+ "description": "The type of the alias.",
+ "enum": [
+ "NotSpecified",
+ "PlainText",
+ "Mask"
+ ],
+ "x-ms-enum": {
+ "name": "AliasType",
+ "modelAsString": false,
+ "values": [
+ {
+ "value": "NotSpecified",
+ "description": "Alias type is unknown (same as not providing alias type)."
+ },
+ {
+ "value": "PlainText",
+ "description": "Alias value is not secret."
+ },
+ {
+ "value": "Mask",
+ "description": "Alias value is secret."
+ }
+ ]
+ }
+ },
+ "defaultPath": {
+ "type": "string",
+ "description": "The default path for an alias."
+ },
+ "defaultPattern": {
+ "$ref": "#/definitions/AliasPattern",
+ "description": "The default pattern for an alias."
+ }
+ },
+ "description": "The alias type. "
+ },
+ "ProviderResourceType": {
+ "properties": {
+ "resourceType": {
+ "type": "string",
+ "description": "The resource type."
+ },
+ "locations": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "The collection of locations where this resource type can be created."
+ },
+ "aliases": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/Alias"
+ },
+ "description": "The aliases that are supported by this resource type."
+ },
+ "apiVersions": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "The API version."
+ },
+ "capabilities": {
+ "type": "string",
+ "description": "The additional capabilities offered by this resource type."
+ },
+ "properties": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string",
+ "description": "The additional properties. "
+ },
+ "description": "The properties."
+ }
+ },
+ "description": "Resource type managed by the resource provider."
+ },
+ "Provider": {
+ "properties": {
+ "id": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The provider ID."
+ },
+ "namespace": {
+ "type": "string",
+ "description": "The namespace of the resource provider."
+ },
+ "registrationState": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The registration state of the resource provider."
+ },
+ "registrationPolicy": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The registration policy of the resource provider."
+ },
+ "resourceTypes": {
+ "readOnly": true,
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ProviderResourceType"
+ },
+ "description": "The collection of provider resource types."
+ }
+ },
+ "description": "Resource provider information."
+ },
+ "BasicDependency": {
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "The ID of the dependency."
+ },
+ "resourceType": {
+ "type": "string",
+ "description": "The dependency resource type."
+ },
+ "resourceName": {
+ "type": "string",
+ "description": "The dependency resource name."
+ }
+ },
+ "description": "Deployment dependency information."
+ },
+ "Dependency": {
+ "properties": {
+ "dependsOn": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/BasicDependency"
+ },
+ "description": "The list of dependencies."
+ },
+ "id": {
+ "type": "string",
+ "description": "The ID of the dependency."
+ },
+ "resourceType": {
+ "type": "string",
+ "description": "The dependency resource type."
+ },
+ "resourceName": {
+ "type": "string",
+ "description": "The dependency resource name."
+ }
+ },
+ "description": "Deployment dependency information."
+ },
+ "DeploymentPropertiesExtended": {
+ "properties": {
+ "provisioningState": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Denotes the state of provisioning.",
+ "enum": [
+ "NotSpecified",
+ "Accepted",
+ "Running",
+ "Ready",
+ "Creating",
+ "Created",
+ "Deleting",
+ "Deleted",
+ "Canceled",
+ "Failed",
+ "Succeeded",
+ "Updating"
+ ],
+ "x-ms-enum": {
+ "name": "ProvisioningState",
+ "modelAsString": true
+ }
+ },
+ "correlationId": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The correlation ID of the deployment."
+ },
+ "timestamp": {
+ "readOnly": true,
+ "type": "string",
+ "format": "date-time",
+ "description": "The timestamp of the template deployment."
+ },
+ "duration": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The duration of the template deployment."
+ },
+ "outputs": {
+ "readOnly": true,
+ "type": "object",
+ "description": "Key/value pairs that represent deployment output."
+ },
+ "providers": {
+ "readOnly": true,
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/Provider"
+ },
+ "description": "The list of resource providers needed for the deployment."
+ },
+ "dependencies": {
+ "readOnly": true,
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/Dependency"
+ },
+ "description": "The list of deployment dependencies."
+ },
+ "templateLink": {
+ "readOnly": true,
+ "$ref": "#/definitions/TemplateLink",
+ "description": "The URI referencing the template."
+ },
+ "parameters": {
+ "readOnly": true,
+ "type": "object",
+ "description": "Deployment parameters. "
+ },
+ "parametersLink": {
+ "readOnly": true,
+ "$ref": "#/definitions/ParametersLink",
+ "description": "The URI referencing the parameters. "
+ },
+ "mode": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The deployment mode. Possible values are Incremental and Complete.",
+ "enum": [
+ "Incremental",
+ "Complete"
+ ],
+ "x-ms-enum": {
+ "name": "DeploymentMode",
+ "modelAsString": false
+ }
+ },
+ "debugSetting": {
+ "readOnly": true,
+ "$ref": "#/definitions/DebugSetting",
+ "description": "The debug setting of the deployment."
+ },
+ "onErrorDeployment": {
+ "readOnly": true,
+ "$ref": "#/definitions/OnErrorDeploymentExtended",
+ "description": "The deployment on error behavior."
+ },
+ "templateHash": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The hash produced for the template."
+ },
+ "outputResources": {
+ "readOnly": true,
+ "type": "array",
+ "description": "Array of provisioned resources.",
+ "items": {
+ "$ref": "#/definitions/ResourceReference",
+ "description": "Details of provisioned resources."
+ }
+ },
+ "validatedResources": {
+ "readOnly": true,
+ "type": "array",
+ "description": "Array of validated resources.",
+ "items": {
+ "$ref": "#/definitions/ResourceReference",
+ "description": "Details of validated resources."
+ }
+ },
+ "error": {
+ "readOnly": true,
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ErrorResponse",
+ "description": "The deployment error."
+ }
+ },
+ "description": "Deployment properties with additional details."
+ },
+ "ResourceReference": {
+ "description": "The resource Id model.",
+ "properties": {
+ "id": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The fully qualified resource Id."
+ }
+ }
+ },
+ "OnErrorDeployment": {
+ "properties": {
+ "type": {
+ "type": "string",
+ "description": "The deployment on error behavior type. Possible values are LastSuccessful and SpecificDeployment.",
+ "enum": [
+ "LastSuccessful",
+ "SpecificDeployment"
+ ],
+ "x-ms-enum": {
+ "name": "OnErrorDeploymentType",
+ "modelAsString": false
+ }
+ },
+ "deploymentName": {
+ "type": "string",
+ "description": "The deployment to be used on error case."
+ }
+ },
+ "description": "Deployment on error behavior."
+ },
+ "OnErrorDeploymentExtended": {
+ "properties": {
+ "provisioningState": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The state of the provisioning for the on error deployment."
+ },
+ "type": {
+ "type": "string",
+ "description": "The deployment on error behavior type. Possible values are LastSuccessful and SpecificDeployment.",
+ "enum": [
+ "LastSuccessful",
+ "SpecificDeployment"
+ ],
+ "x-ms-enum": {
+ "name": "OnErrorDeploymentType",
+ "modelAsString": false
+ }
+ },
+ "deploymentName": {
+ "type": "string",
+ "description": "The deployment to be used on error case."
+ }
+ },
+ "description": "Deployment on error behavior with additional details."
+ },
+ "DeploymentValidateResult": {
+ "properties": {
+ "error": {
+ "readOnly": true,
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ErrorResponse",
+ "description": "The deployment validation error."
+ },
+ "properties": {
+ "$ref": "#/definitions/DeploymentPropertiesExtended",
+ "description": "The template deployment properties."
+ }
+ },
+ "description": "Information from validate template deployment response."
+ },
+ "DeploymentExtended": {
+ "properties": {
+ "id": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The ID of the deployment."
+ },
+ "name": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The name of the deployment."
+ },
+ "type": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The type of the deployment."
+ },
+ "location": {
+ "type": "string",
+ "description": "the location of the deployment."
+ },
+ "properties": {
+ "$ref": "#/definitions/DeploymentPropertiesExtended",
+ "description": "Deployment properties."
+ },
+ "tags": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Deployment tags"
+ }
+ },
+ "x-ms-azure-resource": true,
+ "description": "Deployment information."
+ },
+ "DeploymentListResult": {
+ "properties": {
+ "value": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/DeploymentExtended"
+ },
+ "description": "An array of deployments."
+ },
+ "nextLink": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The URL to use for getting the next set of results."
+ }
+ },
+ "description": "List of deployments."
+ },
+ "ProviderListResult": {
+ "properties": {
+ "value": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/Provider"
+ },
+ "description": "An array of resource providers."
+ },
+ "nextLink": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The URL to use for getting the next set of results."
+ }
+ },
+ "description": "List of resource providers."
+ },
+ "GenericResource": {
+ "properties": {
+ "plan": {
+ "$ref": "#/definitions/Plan",
+ "description": "The plan of the resource."
+ },
+ "properties": {
+ "type": "object",
+ "description": "The resource properties."
+ },
+ "kind": {
+ "type": "string",
+ "description": "The kind of the resource.",
+ "pattern": "^[-\\w\\._,\\(\\)]+$"
+ },
+ "managedBy": {
+ "type": "string",
+ "description": "ID of the resource that manages this resource."
+ },
+ "sku": {
+ "$ref": "#/definitions/Sku",
+ "description": "The SKU of the resource."
+ },
+ "identity": {
+ "$ref": "#/definitions/Identity",
+ "description": "The identity of the resource."
+ }
+ },
+ "allOf": [
+ {
+ "$ref": "#/definitions/Resource"
+ }
+ ],
+ "description": "Resource information."
+ },
+ "GenericResourceExpanded": {
+ "properties": {
+ "createdTime": {
+ "readOnly": true,
+ "type": "string",
+ "format": "date-time",
+ "description": "The created time of the resource. This is only present if requested via the $expand query parameter."
+ },
+ "changedTime": {
+ "readOnly": true,
+ "type": "string",
+ "format": "date-time",
+ "description": "The changed time of the resource. This is only present if requested via the $expand query parameter."
+ },
+ "provisioningState": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The provisioning state of the resource. This is only present if requested via the $expand query parameter."
+ }
+ },
+ "allOf": [
+ {
+ "$ref": "#/definitions/GenericResource"
+ }
+ ],
+ "description": "Resource information."
+ },
+ "Plan": {
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "The plan ID."
+ },
+ "publisher": {
+ "type": "string",
+ "description": "The publisher ID."
+ },
+ "product": {
+ "type": "string",
+ "description": "The offer ID."
+ },
+ "promotionCode": {
+ "type": "string",
+ "description": "The promotion code."
+ },
+ "version": {
+ "type": "string",
+ "description": "The plan's version."
+ }
+ },
+ "description": "Plan for the resource."
+ },
+ "Sku": {
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "The SKU name."
+ },
+ "tier": {
+ "type": "string",
+ "description": "The SKU tier."
+ },
+ "size": {
+ "type": "string",
+ "description": "The SKU size."
+ },
+ "family": {
+ "type": "string",
+ "description": "The SKU family."
+ },
+ "model": {
+ "type": "string",
+ "description": "The SKU model."
+ },
+ "capacity": {
+ "type": "integer",
+ "format": "int32",
+ "description": "The SKU capacity."
+ }
+ },
+ "description": "SKU for the resource."
+ },
+ "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",
+ "x-ms-client-name": "IdentityUserAssignedIdentitiesValue",
+ "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 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."
+ },
+ "ResourceListResult": {
+ "properties": {
+ "value": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/GenericResourceExpanded"
+ },
+ "description": "An array of resources."
+ },
+ "nextLink": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The URL to use for getting the next set of results."
+ }
+ },
+ "description": "List of resource groups."
+ },
+ "ResourceGroup": {
+ "properties": {
+ "id": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The ID of the resource group."
+ },
+ "name": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The name of the resource group."
+ },
+ "type": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The type of the resource group."
+ },
+ "properties": {
+ "$ref": "#/definitions/ResourceGroupProperties",
+ "description": "The resource group properties."
+ },
+ "location": {
+ "type": "string",
+ "description": "The location of the resource group. It cannot be changed after the resource group has been created. It must be one of the supported Azure locations."
+ },
+ "managedBy": {
+ "type": "string",
+ "description": "The ID of the resource that manages this resource group."
+ },
+ "tags": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string",
+ "description": "The additional properties. "
+ },
+ "description": "The tags attached to the resource group."
+ }
+ },
+ "required": [
+ "location"
+ ],
+ "x-ms-azure-resource": true,
+ "description": "Resource group information."
+ },
+ "ResourceGroupPatchable": {
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "The name of the resource group."
+ },
+ "properties": {
+ "$ref": "#/definitions/ResourceGroupProperties",
+ "description": "The resource group properties."
+ },
+ "managedBy": {
+ "type": "string",
+ "description": "The ID of the resource that manages this resource group."
+ },
+ "tags": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string",
+ "description": "The additional properties. "
+ },
+ "description": "The tags attached to the resource group."
+ }
+ },
+ "description": "Resource group information."
+ },
+ "ResourceGroupProperties": {
+ "properties": {
+ "provisioningState": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The provisioning state. "
+ }
+ },
+ "description": "The resource group properties."
+ },
+ "ResourceGroupListResult": {
+ "properties": {
+ "value": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ResourceGroup"
+ },
+ "description": "An array of resource groups."
+ },
+ "nextLink": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The URL to use for getting the next set of results."
+ }
+ },
+ "description": "List of resource groups."
+ },
+ "ResourcesMoveInfo": {
+ "properties": {
+ "resources": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "The IDs of the resources."
+ },
+ "targetResourceGroup": {
+ "type": "string",
+ "description": "The target resource group."
+ }
+ },
+ "description": "Parameters of move resources."
+ },
+ "ExportTemplateRequest": {
+ "properties": {
+ "resources": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "The IDs of the resources to filter the export by. To export all resources, supply an array with single entry '*'."
+ },
+ "options": {
+ "type": "string",
+ "description": "The export template options. A CSV-formatted list containing zero or more of the following: 'IncludeParameterDefaultValue', 'IncludeComments', 'SkipResourceNameParameterization', 'SkipAllParameterization'"
+ }
+ },
+ "description": "Export resource group template request parameters."
+ },
+ "TagCount": {
+ "properties": {
+ "type": {
+ "type": "string",
+ "description": "Type of count."
+ },
+ "value": {
+ "type": "integer",
+ "description": "Value of count."
+ }
+ },
+ "description": "Tag count."
+ },
+ "TagValue": {
+ "properties": {
+ "id": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The tag value ID."
+ },
+ "tagValue": {
+ "type": "string",
+ "description": "The tag value."
+ },
+ "count": {
+ "$ref": "#/definitions/TagCount",
+ "description": "The tag value count."
+ }
+ },
+ "x-ms-azure-resource": true,
+ "description": "Tag information."
+ },
+ "TagDetails": {
+ "properties": {
+ "id": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The tag name ID."
+ },
+ "tagName": {
+ "type": "string",
+ "description": "The tag name."
+ },
+ "count": {
+ "$ref": "#/definitions/TagCount",
+ "description": "The total number of resources that use the resource tag. When a tag is initially created and has no associated resources, the value is 0."
+ },
+ "values": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/TagValue"
+ },
+ "description": "The list of tag values."
+ }
+ },
+ "x-ms-azure-resource": true,
+ "description": "Tag details."
+ },
+ "TagsListResult": {
+ "properties": {
+ "value": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/TagDetails"
+ },
+ "description": "An array of tags."
+ },
+ "nextLink": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The URL to use for getting the next set of results."
+ }
+ },
+ "description": "List of subscription tags."
+ },
+ "TargetResource": {
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "The ID of the resource."
+ },
+ "resourceName": {
+ "type": "string",
+ "description": "The name of the resource."
+ },
+ "resourceType": {
+ "type": "string",
+ "description": "The type of the resource."
+ }
+ },
+ "description": "Target resource."
+ },
+ "HttpMessage": {
+ "properties": {
+ "content": {
+ "type": "object",
+ "description": "HTTP message content."
+ }
+ },
+ "description": "HTTP message."
+ },
+ "DeploymentOperationProperties": {
+ "properties": {
+ "provisioningOperation": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The name of the current provisioning operation.",
+ "enum": [
+ "NotSpecified",
+ "Create",
+ "Delete",
+ "Waiting",
+ "AzureAsyncOperationWaiting",
+ "ResourceCacheWaiting",
+ "Action",
+ "Read",
+ "EvaluateDeploymentOutput",
+ "DeploymentCleanup"
+ ],
+ "x-ms-enum": {
+ "name": "ProvisioningOperation",
+ "modelAsString": false,
+ "values": [
+ {
+ "value": "NotSpecified",
+ "description": "The provisioning operation is not specified."
+ },
+ {
+ "value": "Create",
+ "description": "The provisioning operation is create."
+ },
+ {
+ "value": "Delete",
+ "description": "The provisioning operation is delete."
+ },
+ {
+ "value": "Waiting",
+ "description": "The provisioning operation is waiting."
+ },
+ {
+ "value": "AzureAsyncOperationWaiting",
+ "description": "The provisioning operation is waiting Azure async operation."
+ },
+ {
+ "value": "ResourceCacheWaiting",
+ "description": "The provisioning operation is waiting for resource cache."
+ },
+ {
+ "value": "Action",
+ "description": "The provisioning operation is action."
+ },
+ {
+ "value": "Read",
+ "description": "The provisioning operation is read."
+ },
+ {
+ "value": "EvaluateDeploymentOutput",
+ "description": "The provisioning operation is evaluate output."
+ },
+ {
+ "value": "DeploymentCleanup",
+ "description": "The provisioning operation is cleanup. This operation is part of the 'complete' mode deployment."
+ }
+ ]
+ }
+ },
+ "provisioningState": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The state of the provisioning."
+ },
+ "timestamp": {
+ "readOnly": true,
+ "type": "string",
+ "format": "date-time",
+ "description": "The date and time of the operation."
+ },
+ "duration": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The duration of the operation."
+ },
+ "serviceRequestId": {
+ "readOnly": true,
+ "type": "string",
+ "description": "Deployment operation service request id."
+ },
+ "statusCode": {
+ "readOnly": true,
+ "type": "string",
+ "description": "Operation status code."
+ },
+ "statusMessage": {
+ "readOnly": true,
+ "description": "Operation status message.",
+ "$ref": "#/definitions/StatusMessage"
+ },
+ "targetResource": {
+ "readOnly": true,
+ "$ref": "#/definitions/TargetResource",
+ "description": "The target resource."
+ },
+ "request": {
+ "readOnly": true,
+ "$ref": "#/definitions/HttpMessage",
+ "description": "The HTTP request message."
+ },
+ "response": {
+ "readOnly": true,
+ "$ref": "#/definitions/HttpMessage",
+ "description": "The HTTP response message."
+ }
+ },
+ "description": "Deployment operation properties."
+ },
+ "DeploymentOperation": {
+ "properties": {
+ "id": {
+ "readOnly": true,
+ "type": "string",
+ "description": "Full deployment operation ID."
+ },
+ "operationId": {
+ "readOnly": true,
+ "type": "string",
+ "description": "Deployment operation ID."
+ },
+ "properties": {
+ "$ref": "#/definitions/DeploymentOperationProperties",
+ "description": "Deployment properties."
+ }
+ },
+ "description": "Deployment operation information."
+ },
+ "DeploymentOperationsListResult": {
+ "properties": {
+ "value": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/DeploymentOperation"
+ },
+ "description": "An array of deployment operations."
+ },
+ "nextLink": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The URL to use for getting the next set of results."
+ }
+ },
+ "description": "List of deployment operations."
+ },
+ "ResourceProviderOperationDisplayProperties": {
+ "properties": {
+ "publisher": {
+ "type": "string",
+ "description": "Operation description."
+ },
+ "provider": {
+ "type": "string",
+ "description": "Operation provider."
+ },
+ "resource": {
+ "type": "string",
+ "description": "Operation resource."
+ },
+ "operation": {
+ "type": "string",
+ "description": "Resource provider operation."
+ },
+ "description": {
+ "type": "string",
+ "description": "Operation description."
+ }
+ },
+ "description": "Resource provider operation's display properties."
+ },
+ "Resource": {
+ "properties": {
+ "id": {
+ "readOnly": true,
+ "type": "string",
+ "description": "Resource ID"
+ },
+ "name": {
+ "readOnly": true,
+ "type": "string",
+ "description": "Resource name"
+ },
+ "type": {
+ "readOnly": true,
+ "type": "string",
+ "description": "Resource type"
+ },
+ "location": {
+ "type": "string",
+ "description": "Resource location"
+ },
+ "tags": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Resource tags"
+ }
+ },
+ "x-ms-azure-resource": true,
+ "description": "Specified resource."
+ },
+ "SubResource": {
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "Resource ID"
+ }
+ },
+ "x-ms-azure-resource": true,
+ "description": "Sub-resource."
+ },
+ "ResourceGroupExportResult": {
+ "properties": {
+ "template": {
+ "type": "object",
+ "description": "The template content."
+ },
+ "error": {
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ErrorResponse",
+ "description": "The template export error."
+ }
+ },
+ "description": "Resource group export result."
+ },
+ "Operation": {
+ "description": "Microsoft.Resources operation",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "Operation name: {provider}/{resource}/{operation}",
+ "type": "string"
+ },
+ "display": {
+ "description": "The object that represents the operation.",
+ "properties": {
+ "provider": {
+ "description": "Service provider: Microsoft.Resources",
+ "type": "string"
+ },
+ "resource": {
+ "description": "Resource on which the operation is performed: Profile, endpoint, etc.",
+ "type": "string"
+ },
+ "operation": {
+ "description": "Operation type: Read, write, delete, etc.",
+ "type": "string"
+ },
+ "description": {
+ "description": "Description of the operation.",
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "OperationListResult": {
+ "description": "Result of the request to list Microsoft.Resources operations. It contains a list of operations and a URL link to get the next set of results.",
+ "properties": {
+ "value": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/Operation"
+ },
+ "description": "List of Microsoft.Resources operations."
+ },
+ "nextLink": {
+ "type": "string",
+ "description": "URL to get the next set of operation list results if there are any."
+ }
+ }
+ },
+ "TemplateHashResult": {
+ "description": "Result of the request to calculate template hash. It contains a string of minified template and its hash.",
+ "properties": {
+ "minifiedTemplate": {
+ "type": "string",
+ "description": "The minified template string."
+ },
+ "templateHash": {
+ "type": "string",
+ "description": "The template hash."
+ }
+ }
+ },
+ "WhatIfPropertyChange": {
+ "required": [
+ "path",
+ "propertyChangeType"
+ ],
+ "properties": {
+ "path": {
+ "type": "string",
+ "description": "The path of the property."
+ },
+ "propertyChangeType": {
+ "type": "string",
+ "description": "The type of property change.",
+ "enum": [
+ "Create",
+ "Delete",
+ "Modify",
+ "Array"
+ ],
+ "x-ms-enum": {
+ "name": "PropertyChangeType",
+ "modelAsString": false,
+ "values": [
+ {
+ "value": "Create",
+ "description": "The property does not exist in the current state but is present in the desired state. The property will be created when the deployment is executed."
+ },
+ {
+ "value": "Delete",
+ "description": "The property exists in the current state and is missing from the desired state. It will be deleted when the deployment is executed."
+ },
+ {
+ "value": "Modify",
+ "description": "The property exists in both current and desired state and is different. The value of the property will change when the deployment is executed."
+ },
+ {
+ "value": "Array",
+ "description": "The property is an array and contains nested changes."
+ }
+ ]
+ }
+ },
+ "before": {
+ "type": "object",
+ "description": "The value of the property before the deployment is executed."
+ },
+ "after": {
+ "type": "object",
+ "description": "The value of the property after the deployment is executed."
+ },
+ "children": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/WhatIfPropertyChange"
+ },
+ "description": "Nested property changes."
+ }
+ },
+ "description": "The predicted change to the resource property."
+ },
+ "WhatIfChange": {
+ "description": "Information about a single resource change predicted by What-If operation.",
+ "required": [
+ "resourceId",
+ "changeType"
+ ],
+ "properties": {
+ "resourceId": {
+ "type": "string",
+ "description": "Resource ID"
+ },
+ "changeType": {
+ "type": "string",
+ "description": "Type of change that will be made to the resource when the deployment is executed.",
+ "enum": [
+ "Create",
+ "Delete",
+ "Ignore",
+ "Deploy",
+ "NoChange",
+ "Modify"
+ ],
+ "x-ms-enum": {
+ "name": "ChangeType",
+ "modelAsString": false,
+ "values": [
+ {
+ "value": "Create",
+ "description": "The resource does not exist in the current state but is present in the desired state. The resource will be created when the deployment is executed."
+ },
+ {
+ "value": "Delete",
+ "description": "The resource exists in the current state and is missing from the desired state. The resource will be deleted when the deployment is executed."
+ },
+ {
+ "value": "Ignore",
+ "description": "The resource exists in the current state and is missing from the desired state. The resource will not be deployed or modified when the deployment is executed."
+ },
+ {
+ "value": "Deploy",
+ "description": "The resource exists in the current state and the desired state and will be redeployed when the deployment is executed. The properties of the resource may or may not change."
+ },
+ {
+ "value": "NoChange",
+ "description": "The resource exists in the current state and the desired state and will be redeployed when the deployment is executed. The properties of the resource will not change."
+ },
+ {
+ "value": "Modify",
+ "description": "The resource exists in the current state and the desired state and will be redeployed when the deployment is executed. The properties of the resource will change."
+ }
+ ]
+ }
+ },
+ "before": {
+ "type": "object",
+ "description": "The snapshot of the resource before the deployment is executed."
+ },
+ "after": {
+ "type": "object",
+ "description": "The predicted snapshot of the resource after the deployment is executed."
+ },
+ "delta": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/WhatIfPropertyChange"
+ },
+ "description": "The predicted changes to resource properties."
+ }
+ }
+ },
+ "WhatIfOperationProperties": {
+ "description": "Deployment operation properties.",
+ "properties": {
+ "changes": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/WhatIfChange"
+ },
+ "description": "List of resource changes predicted by What-If operation."
+ }
+ }
+ },
+ "WhatIfOperationResult": {
+ "description": "Result of the What-If operation. Contains a list of predicted changes and a URL link to get to the next set of results.",
+ "properties": {
+ "status": {
+ "type": "string",
+ "description": "Status of the What-If operation."
+ },
+ "properties": {
+ "x-ms-client-flatten": true,
+ "$ref": "#/definitions/WhatIfOperationProperties",
+ "description": "What-If operation properties."
+ },
+ "error": {
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ErrorResponse",
+ "description": "Error when What-If operation fails."
+ }
+ }
+ },
+ "Tags": {
+ "description": "A dictionary of name and value pairs.",
+ "properties": {
+ "tags": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string",
+ "description": "The tag value."
+ }
+ }
+ }
+ },
+ "TagsPatchResource": {
+ "type": "object",
+ "description": "Wrapper resource for tags patch API request only.",
+ "properties": {
+ "operation": {
+ "type": "string",
+ "description": "The operation type for the patch API.",
+ "enum": [
+ "Replace",
+ "Merge",
+ "Delete"
+ ]
+ },
+ "properties": {
+ "$ref": "#/definitions/Tags",
+ "description": "The set of tags."
+ }
+ }
+ },
+ "TagsResource": {
+ "type": "object",
+ "description": "Wrapper resource for tags API requests and responses.",
+ "required": [
+ "properties"
+ ],
+ "properties": {
+ "id": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The ID of the tags wrapper resource."
+ },
+ "name": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The name of the tags wrapper resource."
+ },
+ "type": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The type of the tags wrapper resource."
+ },
+ "properties": {
+ "$ref": "#/definitions/Tags",
+ "description": "The set of tags."
+ }
+ },
+ "x-ms-azure-resource": true
+ },
+ "StatusMessage": {
+ "type": "object",
+ "description": "Operation status message object.",
+ "properties": {
+ "status": {
+ "type": "string",
+ "description": "Status of the deployment operation."
+ },
+ "error": {
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ErrorResponse",
+ "description": "The error reported by the operation."
+ }
+ }
+ }
+ },
+ "parameters": {
+ "ScopeParameter": {
+ "name": "scope",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The resource scope.",
+ "x-ms-parameter-location": "method",
+ "x-ms-skip-url-encoding": true
+ },
+ "GroupIdParameter": {
+ "name": "groupId",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The management group ID.",
+ "x-ms-parameter-location": "method",
+ "minLength": 1,
+ "maxLength": 90
+ },
+ "SubscriptionIdParameter": {
+ "name": "subscriptionId",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The ID of the target subscription."
+ },
+ "SourceSubscriptionIdParameter": {
+ "name": "subscriptionId",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The ID of the source subscription."
+ },
+ "DeploymentNameParameter": {
+ "name": "deploymentName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "pattern": "^[-\\w\\._\\(\\)]+$",
+ "x-ms-parameter-location": "method",
+ "minLength": 1,
+ "maxLength": 64,
+ "description": "The name of the deployment."
+ },
+ "ApiVersionParameter": {
+ "name": "api-version",
+ "in": "query",
+ "required": true,
+ "type": "string",
+ "description": "The API version to use for this operation."
+ }
+ }
+}
diff --git a/specification/resources/resource-manager/readme.csharp.md b/specification/resources/resource-manager/readme.csharp.md
index 8035831712c8..0364f5d7d6c2 100644
--- a/specification/resources/resource-manager/readme.csharp.md
+++ b/specification/resources/resource-manager/readme.csharp.md
@@ -24,6 +24,7 @@ batch:
- package-subscriptions: true
- package-links: true
- package-deploymentscripts: true
+ - package-templatespecs: true
# - package-managedapplications: true
```
@@ -137,6 +138,19 @@ batch:
ApiVersionName: Api2019_10_01
- policyD-2016-12-01: true
ApiVersionName: Api2019_10_01
+
+ - resources-2020-06-01: true
+ ApiVersionName: Api2020_06_01
+ - links-2016-09-01: true
+ ApiVersionName: Api2020_06_01
+ - subscription-2016-06-01: true
+ ApiVersionName: Api2020_06_01
+ - locks-2016-09-01: true
+ ApiVersionName: Api2020_06_01
+ - policyA-2016-12-01: true
+ ApiVersionName: Api2020_06_01
+ - policyD-2016-12-01: true
+ ApiVersionName: Api2020_06_01
```
@@ -258,6 +272,72 @@ input-file:
input-file:
- Microsoft.Authorization/stable/2016-12-01/policyDefinitions.json
```
+``` yaml $(Separator)
+###########################################################################
+###########################################################################
+```
+
+``` yaml $(resources-2020-06-01)
+tag: pkg-2020-06-Az-res
+```
+
+``` yaml $(links-2016-09-01)
+tag: pkg-2020-06-Az-lnk
+```
+
+``` yaml $(subscription-2016-06-01)
+tag: pkg-2020-06-Az-sub
+```
+
+``` yaml $(locks-2016-09-01)
+tag: pkg-2020-06-Az-loc
+```
+
+``` yaml $(policyA-2016-12-01)
+tag: pkg-2020-06-Az-polA
+```
+
+``` yaml $(policyD-2016-12-01)
+tag: pkg-2020-06-Az-polD
+```
+
+
+## Tag: Packages for Azure Stack
+### 1) pkg-2020-06-AzStk-res
+``` yaml $(tag) == 'pkg-2020-06-Az-res'
+input-file:
+- Microsoft.Resources/stable/2019-05-01/resources.json
+```
+
+### 2) pkg-2020-06-AzStk-lnk
+``` yaml $(tag) == 'pkg-2020-06-Az-lnk'
+input-file:
+- Microsoft.Resources/stable/2016-09-01/links.json
+```
+
+### 3) pkg-2020-06-AzStk-sub
+``` yaml $(tag) == 'pkg-2020-06-Az-sub'
+input-file:
+- Microsoft.Resources/stable/2016-06-01/subscriptions.json
+```
+
+### 4) pkg-2020-06-AzStk-loc
+``` yaml $(tag) == 'pkg-2020-06-Az-loc'
+input-file:
+- Microsoft.Authorization/stable/2016-09-01/locks.json
+```
+
+### 5) pkg-2020-06-AzStk-polA
+``` yaml $(tag) == 'pkg-2020-06-Az-polA'
+input-file:
+- Microsoft.Authorization/stable/2016-12-01/policyAssignments.json
+```
+
+### 6) pkg-2020-06-AzStk-polD
+``` yaml $(tag) == 'pkg-2020-06-Az-polD'
+input-file:
+- Microsoft.Authorization/stable/2016-12-01/policyDefinitions.json
+```
``` yaml $(Separator)
###########################################################################
diff --git a/specification/resources/resource-manager/readme.java.md b/specification/resources/resource-manager/readme.java.md
index 3f11f6b2e9f2..5e5e0d5c92b8 100644
--- a/specification/resources/resource-manager/readme.java.md
+++ b/specification/resources/resource-manager/readme.java.md
@@ -27,6 +27,7 @@ batch:
- tag: package-policy-2018-05
- tag: package-policy-2018-03
- tag: package-policy-2016-12
+ - tag: package-resources-2020-06
- tag: package-resources-2019-08
- tag: package-resources-2019-07
- tag: package-resources-2019-0510
@@ -38,7 +39,6 @@ batch:
- tag: package-subscriptions-2018-06
- tag: package-subscriptions-2016-06
```
-```
### Tag: package-features-2015-12 and java
@@ -190,6 +190,19 @@ directive:
transform: $['x-ms-client-name'] = 'scopeProperty'
```
+### Tag: package-resources-2020-06 and java
+
+These settings apply only when `--tag=package-resources-2020-06 --java` is specified on the command line.
+Please also specify `--azure-libraries-for-java-folder=`.
+
+``` yaml $(tag) == 'package-resources-2020-06' && $(java) && $(multiapi)
+java:
+ namespace: com.microsoft.azure.management.resources.v2020_06_01
+ output-folder: $(azure-libraries-for-java-folder)/resources/resource-manager/v2020_06_01
+regenerate-manager: true
+generate-interface: true
+```
+
### Tag: package-resources-2019-08 and java
These settings apply only when `--tag=package-resources-2019-08 --java` is specified on the command line.
diff --git a/specification/resources/resource-manager/readme.md b/specification/resources/resource-manager/readme.md
index 32aea908a345..7ae41c1ac69c 100644
--- a/specification/resources/resource-manager/readme.md
+++ b/specification/resources/resource-manager/readme.md
@@ -41,7 +41,7 @@ tag: package-policy-2019-09
```
``` yaml $(package-resources)
-tag: package-resources-2019-10
+tag: package-resources-2020-06
```
``` yaml $(package-subscriptions)
@@ -60,6 +60,19 @@ tag: package-managedapplications-2018-06
tag: package-deploymentscripts-2019-10-preview
```
+``` yaml $(package-templatespecs)
+tag: package-templatespecs-2019-06-preview
+```
+
+### 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
+```
+
### Tag: package-subscriptions-2020-01
These settings apply only when `--tag=package-subscriptions-2020-01` is specified on the command line.
@@ -209,6 +222,15 @@ override-info:
title: PolicyClient
```
+### Tag: package-templatespecs-2019-06-preview
+
+These settings apply only when `--tag=package-templatespecs-2019-06-preview` is specified on the command line.
+
+``` yaml $(tag) == 'package-templatespecs-2019-06-preview'
+input-file:
+- Microsoft.Resources/preview/2019-06-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.
@@ -551,6 +573,26 @@ directive:
- $.definitions.AzureCliScript.properties
- $.definitions.AzurePowerShellScript.properties
reason: Currently systemData is not allowed
+ - suppress: OperationsAPIImplementation
+ from: templateSpecs.json
+ where: $.paths
+ reason: OperationsAPI will come from Resources
+ - suppress: R3006 #BodyTopLevelProperties
+ from: templateSpecs.json
+ where:
+ - $.definitions.TemplateSpecModel.properties
+ - $.definitions.TemplateSpecVersionModel.properties
+ - $.definitions.TemplateSpecUpdateModel.properties
+ - $.definitions.TemplateSpecVersionUpdateModel.properties
+ reason: Currently systemData is not allowed
+ - suppress: TrackedResourceListByImmediateParent
+ from: templateSpecs.json
+ where: $.definitions
+ reason: Tooling issue
+ - suppress: TrackedResourceListByResourceGroup
+ from: templateSpecs.json
+ where: $.definitions.TemplateSpecVersionModel
+ reason: Tooling issue
```
---
@@ -574,6 +616,7 @@ swagger-to-sdk:
- python ./scripts/multiapi_init_gen.py azure-mgmt-resource#subscriptions
- python ./scripts/multiapi_init_gen.py azure-mgmt-resource#links
- python ./scripts/multiapi_init_gen.py azure-mgmt-resource#deploymentscripts
+ - repo: azure-sdk-for-python-track2
- repo: azure-sdk-for-java
- repo: azure-sdk-for-go
- repo: azure-sdk-for-node
@@ -602,6 +645,7 @@ batch:
- package-links: true
- package-managedapplications: true
- package-deploymentscripts: true
+ - package-templatespecs: true
```
### Tag: profile-hybrid-2019-03-01
diff --git a/specification/resources/resource-manager/readme.python.md b/specification/resources/resource-manager/readme.python.md
index e000118f5bbd..709ec28a6bf9 100644
--- a/specification/resources/resource-manager/readme.python.md
+++ b/specification/resources/resource-manager/readme.python.md
@@ -41,6 +41,7 @@ batch:
- tag: package-policy-2016-12
- tag: package-policy-2016-04
- tag: package-policy-2015-10
+ - tag: package-resources-2020-06
- tag: package-resources-2019-10
- tag: package-resources-2019-08
- tag: package-resources-2019-07
@@ -63,9 +64,12 @@ batch:
clear-output-folder: true
batch:
- tag: package-features-2015-12
+ - multiapiscript-features: true
- tag: package-links-2016-09
+ - multiapiscript-links: true
- tag: package-locks-2016-09
- tag: package-locks-2015-01
+ - multiapiscript-locks: true
- tag: package-managedapplications-2018-06
- tag: package-policy-2019-09
- tag: package-policy-2019-06
@@ -76,6 +80,8 @@ batch:
- tag: package-policy-2016-12
- tag: package-policy-2016-04
- tag: package-policy-2015-10
+ - multiapiscript-policy: true
+ - tag: package-resources-2020-06
- tag: package-resources-2019-10
- tag: package-resources-2019-08
- tag: package-resources-2019-07
@@ -87,16 +93,61 @@ batch:
- tag: package-resources-2017-05
- tag: package-resources-2016-09
- tag: package-resources-2016-02
+ - multiapiscript-resources: true
- tag: package-subscriptions-2019-11
- tag: package-subscriptions-2019-06
- tag: package-subscriptions-2018-06
- tag: package-subscriptions-2016-06
+ - multiapiscript-subscriptions: true
- tag: package-deploymentscripts-2019-10-preview
- - multiapiscript: true
+ - multiapiscript-deploymentscripts: true
```
-``` yaml $(multiapiscript)
-output-folder: $(python-sdks-folder)/resources/azure-mgmt-resource/azure/mgmt/resource/
+```yaml $(multiapiscript-features)
+multiapiscript: true
+output-folder: $(python-sdks-folder)/resources/azure-mgmt-resource/azure/mgmt/resource/features
+clear-output-folder: false
+perform-load: false
+```
+
+```yaml $(multiapiscript-policy)
+multiapiscript: true
+output-folder: $(python-sdks-folder)/resources/azure-mgmt-resource/azure/mgmt/resource/policy
+clear-output-folder: false
+perform-load: false
+```
+
+```yaml $(multiapiscript-resources)
+multiapiscript: true
+output-folder: $(python-sdks-folder)/resources/azure-mgmt-resource/azure/mgmt/resource/resources
+clear-output-folder: false
+perform-load: false
+```
+
+```yaml $(multiapiscript-subscriptions)
+multiapiscript: true
+output-folder: $(python-sdks-folder)/resources/azure-mgmt-resource/azure/mgmt/resource/subscriptions
+clear-output-folder: false
+perform-load: false
+```
+
+```yaml $(multiapiscript-deploymentscripts)
+multiapiscript: true
+output-folder: $(python-sdks-folder)/resources/azure-mgmt-resource/azure/mgmt/resource/deploymentscripts
+clear-output-folder: false
+perform-load: false
+```
+
+```yaml $(multiapiscript-locks)
+multiapiscript: true
+output-folder: $(python-sdks-folder)/resources/azure-mgmt-resource/azure/mgmt/resource/locks
+clear-output-folder: false
+perform-load: false
+```
+
+```yaml $(multiapiscript-links)
+multiapiscript: true
+output-folder: $(python-sdks-folder)/resources/azure-mgmt-resource/azure/mgmt/resource/links
clear-output-folder: false
perform-load: false
```
@@ -283,6 +334,19 @@ python:
output-folder: $(python-sdks-folder)/resources/azure-mgmt-resource/azure/mgmt/resource/policy/v2015_10_01_preview
```
+### Tag: package-resources-2020-06 and python
+
+These settings apply only when `--tag=package-resources-2020-06 --python` is specified on the command line.
+Please also specify `--python-sdks-folder=`.
+
+``` yaml $(tag) == 'package-resources-2020-06'
+namespace: azure.mgmt.resource.resources.v2020_06_01
+output-folder: $(python-sdks-folder)/resources/azure-mgmt-resource/azure/mgmt/resource/resources/v2020_06_01
+python:
+ namespace: azure.mgmt.resource.resources.v2020_06_01
+ output-folder: $(python-sdks-folder)/resources/azure-mgmt-resource/azure/mgmt/resource/resources/v2020_06_01
+```
+
### Tag: package-resources-2019-10 and python
These settings apply only when `--tag=package-resources-2019-10 --python` is specified on the command line.
diff --git a/specification/resources/resource-manager/readme.trenton.md b/specification/resources/resource-manager/readme.trenton.md
new file mode 100644
index 000000000000..03432508ba66
--- /dev/null
+++ b/specification/resources/resource-manager/readme.trenton.md
@@ -0,0 +1,50 @@
+
+## trenton
+
+These settings apply only when `--trenton` is specified on the command line.
+
+
+``` yaml $(trenton)
+batch:
+ - package-features: true
+ - package-policy: true
+ - package-managedapplications: true
+```
+
+```yaml $(trenton) && $(package-policy)
+trenton:
+ cli-name: policy
+ package-name: policy
+output-folder: $(trenton-output-folder)/policy
+clear-output-folder: true
+```
+
+```yaml $(trenton) && $(package-features)
+trenton:
+ cli-name: features
+ package-name: features
+output-folder: $(trenton-output-folder)/features
+clear-output-folder: true
+```
+
+```yaml $(trenton) && $(package-managedapplications)
+trenton:
+ cli-name: managedApplications
+ package-name: managedapplications
+output-folder: $(trenton-output-folder)/managedapplications
+clear-output-folder: true
+
+overrides:
+ - where:
+ resource: "Applications"
+ property: "/parameters"
+ set:
+ - GoVariableName: "appParameters"
+ - Gen: "newgen"
+```
\ No newline at end of file
diff --git a/specification/search/data-plane/Azure.Search/preview/2019-05-06-preview/examples/SearchServiceCreateIndex.json b/specification/search/data-plane/Azure.Search/preview/2019-05-06-preview/examples/SearchServiceCreateIndex.json
index c00ad863e1eb..e469954065d6 100644
--- a/specification/search/data-plane/Azure.Search/preview/2019-05-06-preview/examples/SearchServiceCreateIndex.json
+++ b/specification/search/data-plane/Azure.Search/preview/2019-05-06-preview/examples/SearchServiceCreateIndex.json
@@ -120,6 +120,11 @@
"applicationId": "00000000-0000-0000-0000-000000000000",
"applicationSecret": "myapplicationsecret"
}
+ },
+ "similarity": {
+ "@odata.type": "#Microsoft.Azure.Search.BM25Similarity",
+ "b": 0.5,
+ "k1": 1.3
}
}
},
@@ -356,6 +361,11 @@
"applicationId": "00000000-0000-0000-0000-000000000000",
"applicationSecret": null
}
+ },
+ "similarity": {
+ "@odata.type": "#Microsoft.Azure.Search.BM25Similarity",
+ "b": 0.5,
+ "k1": 1.3
}
}
}
diff --git a/specification/search/data-plane/Azure.Search/preview/2019-05-06-preview/examples/SearchServiceCreateOrUpdateIndex.json b/specification/search/data-plane/Azure.Search/preview/2019-05-06-preview/examples/SearchServiceCreateOrUpdateIndex.json
index e60268c5c8cd..8d73eb29c474 100644
--- a/specification/search/data-plane/Azure.Search/preview/2019-05-06-preview/examples/SearchServiceCreateOrUpdateIndex.json
+++ b/specification/search/data-plane/Azure.Search/preview/2019-05-06-preview/examples/SearchServiceCreateOrUpdateIndex.json
@@ -120,6 +120,9 @@
"keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
"keyVaultUri": "https://myKeyVault.vault.azure.net",
"accessCredentials": null
+ },
+ "similarity": {
+ "@odata.type": "#Microsoft.Azure.Search.ClassicSimilarity"
}
}
},
@@ -353,6 +356,9 @@
"keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
"keyVaultUri": "https://myKeyVault.vault.azure.net",
"accessCredentials": null
+ },
+ "similarity": {
+ "@odata.type": "#Microsoft.Azure.Search.ClassicSimilarity"
}
}
},
diff --git a/specification/search/data-plane/Azure.Search/preview/2019-05-06-preview/searchindex.json b/specification/search/data-plane/Azure.Search/preview/2019-05-06-preview/searchindex.json
index b813d6d1346a..8f751cb3e6c4 100644
--- a/specification/search/data-plane/Azure.Search/preview/2019-05-06-preview/searchindex.json
+++ b/specification/search/data-plane/Azure.Search/preview/2019-05-06-preview/searchindex.json
@@ -190,7 +190,19 @@
],
"x-ms-enum": {
"name": "QueryType",
- "modelAsString": false
+ "modelAsString": false,
+ "values": [
+ {
+ "value": "simple",
+ "name": "Simple",
+ "description": "Uses the simple query syntax for searches. Search text is interpreted using a simple query language that allows for symbols such as +, * and \"\". Queries are evaluated across all searchable fields by default, unless the searchFields parameter is specified."
+ },
+ {
+ "value": "full",
+ "name": "Full",
+ "description": "Uses the full Lucene query syntax for searches. Search text is interpreted using the Lucene query language which allows field-specific and weighted searches, as well as other advanced features."
+ }
+ ]
},
"x-nullable": false,
"description": "A value that specifies the syntax of the search query. The default is 'simple'. Use 'full' if your query uses the Lucene query syntax.",
@@ -243,7 +255,19 @@
],
"x-ms-enum": {
"name": "SearchMode",
- "modelAsString": false
+ "modelAsString": false,
+ "values": [
+ {
+ "value": "any",
+ "name": "Any",
+ "description": "Any of the search terms must be matched in order to count the document as a match."
+ },
+ {
+ "value": "all",
+ "name": "All",
+ "description": "All of the search terms must be matched in order to count the document as a match."
+ }
+ ]
},
"x-nullable": false,
"description": "A value that specifies whether any or all of the search terms must be matched in order to count the document as a match.",
@@ -716,7 +740,24 @@
],
"x-ms-enum": {
"name": "AutocompleteMode",
- "modelAsString": false
+ "modelAsString": false,
+ "values": [
+ {
+ "value": "oneTerm",
+ "name": "OneTerm",
+ "description": "Only one term is suggested. If the query has two terms, only the last term is completed. For example, if the input is 'washington medic', the suggested terms could include 'medicaid', 'medicare', and 'medicine'."
+ },
+ {
+ "value": "twoTerms",
+ "name": "TwoTerms",
+ "description": "Matching two-term phrases in the index will be suggested. For example, if the input is 'medic', the suggested terms could include 'medicare coverage' and 'medical assistant'."
+ },
+ {
+ "value": "oneTermWithContext",
+ "name": "OneTermWithContext",
+ "description": "Completes the last term in a query with two or more terms, where the last two terms are a phrase that exists in the index. For example, if the input is 'washington medic', the suggested terms could include 'washington medicaid' and 'washington medical'."
+ }
+ ]
},
"description": "Specifies the mode for Autocomplete. The default is 'oneTerm'. Use 'twoTerms' to get shingles and 'oneTermWithContext' to use the current context while producing auto-completed terms.",
"x-ms-parameter-grouping": {
@@ -1024,7 +1065,29 @@
],
"x-ms-enum": {
"name": "IndexActionType",
- "modelAsString": false
+ "modelAsString": false,
+ "values": [
+ {
+ "value": "upload",
+ "name": "Upload",
+ "description": "Inserts the document into the index if it is new and updates it if it exists. All fields are replaced in the update case."
+ },
+ {
+ "value": "merge",
+ "name": "Merge",
+ "description": "Merges the specified field values with an existing document. If the document does not exist, the merge will fail. Any field you specify in a merge will replace the existing field in the document. This also applies to collections of primitive and complex types."
+ },
+ {
+ "value": "mergeOrUpload",
+ "name": "MergeOrUpload",
+ "description": "Behaves like merge if a document with the given key already exists in the index. If the document does not exist, it behaves like upload with a new document."
+ },
+ {
+ "value": "delete",
+ "name": "Delete",
+ "description": "Removes the specified document from the index. Any field you specify in a delete operation other than the key field will be ignored. If you want to remove an individual field from a document, use merge instead and set the field explicitly to null."
+ }
+ ]
},
"x-ms-client-name": "ActionType",
"x-nullable": false,
@@ -1093,7 +1156,19 @@
],
"x-ms-enum": {
"name": "SearchMode",
- "modelAsString": false
+ "modelAsString": false,
+ "values": [
+ {
+ "value": "any",
+ "name": "Any",
+ "description": "Any of the search terms must be matched in order to count the document as a match."
+ },
+ {
+ "value": "all",
+ "name": "All",
+ "description": "All of the search terms must be matched in order to count the document as a match."
+ }
+ ]
},
"description": "Specifies whether any or all of the search terms must be matched in order to count the document as a match."
},
@@ -1105,7 +1180,19 @@
],
"x-ms-enum": {
"name": "QueryType",
- "modelAsString": false
+ "modelAsString": false,
+ "values": [
+ {
+ "value": "simple",
+ "name": "Simple",
+ "description": "Uses the simple query syntax for searches. Search text is interpreted using a simple query language that allows for symbols such as +, * and \"\". Queries are evaluated across all searchable fields by default, unless the searchFields parameter is specified."
+ },
+ {
+ "value": "full",
+ "name": "Full",
+ "description": "Uses the full Lucene query syntax for searches. Search text is interpreted using the Lucene query language which allows field-specific and weighted searches, as well as other advanced features."
+ }
+ ]
},
"description": "Specifies the syntax of the search query. The default is 'simple'. Use 'full' if your query uses the Lucene query syntax."
},
@@ -1118,7 +1205,24 @@
],
"x-ms-enum": {
"name": "AutocompleteMode",
- "modelAsString": false
+ "modelAsString": false,
+ "values": [
+ {
+ "value": "oneTerm",
+ "name": "OneTerm",
+ "description": "Only one term is suggested. If the query has two terms, only the last term is completed. For example, if the input is 'washington medic', the suggested terms could include 'medicaid', 'medicare', and 'medicine'."
+ },
+ {
+ "value": "twoTerms",
+ "name": "TwoTerms",
+ "description": "Matching two-term phrases in the index will be suggested. For example, if the input is 'medic', the suggested terms could include 'medicare coverage' and 'medical assistant'."
+ },
+ {
+ "value": "oneTermWithContext",
+ "name": "OneTermWithContext",
+ "description": "Completes the last term in a query with two or more terms, where the last two terms are a phrase that exists in the index. For example, if the input is 'washington medic', the suggested terms could include 'washington medicaid' and 'washington medical'."
+ }
+ ]
},
"description": "Specifies the mode for Autocomplete. The default is 'oneTerm'. Use 'twoTerms' to get shingles and 'oneTermWithContext' to use the current context in producing autocomplete terms."
},
diff --git a/specification/search/data-plane/Azure.Search/preview/2019-05-06-preview/searchservice.json b/specification/search/data-plane/Azure.Search/preview/2019-05-06-preview/searchservice.json
index e205a9f1b575..c2a69aac29b9 100644
--- a/specification/search/data-plane/Azure.Search/preview/2019-05-06-preview/searchservice.json
+++ b/specification/search/data-plane/Azure.Search/preview/2019-05-06-preview/searchservice.json
@@ -52,7 +52,7 @@
"in": "body",
"required": true,
"schema": {
- "$ref": "#/definitions/DataSource"
+ "$ref": "#/definitions/SearchIndexerDataSource"
},
"description": "The definition of the datasource to create or update."
},
@@ -77,13 +77,13 @@
"200": {
"description": "",
"schema": {
- "$ref": "#/definitions/DataSource"
+ "$ref": "#/definitions/SearchIndexerDataSource"
}
},
"201": {
"description": "",
"schema": {
- "$ref": "#/definitions/DataSource"
+ "$ref": "#/definitions/SearchIndexerDataSource"
}
},
"default": {
@@ -179,7 +179,7 @@
"200": {
"description": "",
"schema": {
- "$ref": "#/definitions/DataSource"
+ "$ref": "#/definitions/SearchIndexerDataSource"
}
},
"default": {
@@ -257,7 +257,7 @@
"in": "body",
"required": true,
"schema": {
- "$ref": "#/definitions/DataSource"
+ "$ref": "#/definitions/SearchIndexerDataSource"
},
"description": "The definition of the datasource to create."
},
@@ -273,7 +273,7 @@
"201": {
"description": "",
"schema": {
- "$ref": "#/definitions/DataSource"
+ "$ref": "#/definitions/SearchIndexerDataSource"
}
},
"default": {
@@ -401,7 +401,7 @@
"in": "body",
"required": true,
"schema": {
- "$ref": "#/definitions/Indexer"
+ "$ref": "#/definitions/SearchIndexer"
},
"description": "The definition of the indexer to create or update."
},
@@ -426,13 +426,13 @@
"201": {
"description": "",
"schema": {
- "$ref": "#/definitions/Indexer"
+ "$ref": "#/definitions/SearchIndexer"
}
},
"200": {
"description": "",
"schema": {
- "$ref": "#/definitions/Indexer"
+ "$ref": "#/definitions/SearchIndexer"
}
},
"default": {
@@ -528,7 +528,7 @@
"200": {
"description": "",
"schema": {
- "$ref": "#/definitions/Indexer"
+ "$ref": "#/definitions/SearchIndexer"
}
},
"default": {
@@ -606,7 +606,7 @@
"in": "body",
"required": true,
"schema": {
- "$ref": "#/definitions/Indexer"
+ "$ref": "#/definitions/SearchIndexer"
},
"description": "The definition of the indexer to create."
},
@@ -622,7 +622,7 @@
"201": {
"description": "",
"schema": {
- "$ref": "#/definitions/Indexer"
+ "$ref": "#/definitions/SearchIndexer"
}
},
"default": {
@@ -669,7 +669,7 @@
"200": {
"description": "",
"schema": {
- "$ref": "#/definitions/IndexerExecutionInfo"
+ "$ref": "#/definitions/SearchIndexerStatus"
}
},
"default": {
@@ -709,7 +709,7 @@
"in": "body",
"required": true,
"schema": {
- "$ref": "#/definitions/Skillset"
+ "$ref": "#/definitions/SearchIndexerSkillset"
},
"description": "The skillset containing one or more skills to create or update in a search service."
},
@@ -734,13 +734,13 @@
"200": {
"description": "The skillset is successfully updated.",
"schema": {
- "$ref": "#/definitions/Skillset"
+ "$ref": "#/definitions/SearchIndexerSkillset"
}
},
"201": {
"description": "The skillset is successfully created.",
"schema": {
- "$ref": "#/definitions/Skillset"
+ "$ref": "#/definitions/SearchIndexerSkillset"
}
},
"default": {
@@ -836,7 +836,7 @@
"200": {
"description": "The skillset is successfully returned.",
"schema": {
- "$ref": "#/definitions/Skillset"
+ "$ref": "#/definitions/SearchIndexerSkillset"
}
},
"default": {
@@ -914,7 +914,7 @@
"in": "body",
"required": true,
"schema": {
- "$ref": "#/definitions/Skillset"
+ "$ref": "#/definitions/SearchIndexerSkillset"
},
"description": "The skillset containing one or more skills to create in a search service."
},
@@ -930,7 +930,7 @@
"201": {
"description": "The skillset is successfully created.",
"schema": {
- "$ref": "#/definitions/Skillset"
+ "$ref": "#/definitions/SearchIndexerSkillset"
}
},
"default": {
@@ -1224,7 +1224,7 @@
"in": "body",
"required": true,
"schema": {
- "$ref": "#/definitions/Index"
+ "$ref": "#/definitions/SearchIndex"
},
"description": "The definition of the index to create."
},
@@ -1240,7 +1240,7 @@
"201": {
"description": "",
"schema": {
- "$ref": "#/definitions/Index"
+ "$ref": "#/definitions/SearchIndex"
}
},
"default": {
@@ -1294,6 +1294,9 @@
"$ref": "#/definitions/SearchError"
}
}
+ },
+ "x-ms-pageable": {
+ "nextLinkName": null
}
}
},
@@ -1325,7 +1328,7 @@
"in": "body",
"required": true,
"schema": {
- "$ref": "#/definitions/Index"
+ "$ref": "#/definitions/SearchIndex"
},
"description": "The definition of the index to create or update."
},
@@ -1357,13 +1360,13 @@
"200": {
"description": "",
"schema": {
- "$ref": "#/definitions/Index"
+ "$ref": "#/definitions/SearchIndex"
}
},
"201": {
"description": "",
"schema": {
- "$ref": "#/definitions/Index"
+ "$ref": "#/definitions/SearchIndex"
}
},
"default": {
@@ -1384,7 +1387,7 @@
"$ref": "./examples/SearchServiceDeleteIndex.json"
}
},
- "description": "Deletes a search index and all the documents it contains.",
+ "description": "Deletes a search index and all the documents it contains. This operation is permanent, with no recovery option. Make sure you have a master copy of your index definition, data ingestion code, and a backup of the primary data source in case you need to re-build the index.",
"externalDocs": {
"url": "https://docs.microsoft.com/rest/api/searchservice/Delete-Index"
},
@@ -1459,7 +1462,7 @@
"200": {
"description": "",
"schema": {
- "$ref": "#/definitions/Index"
+ "$ref": "#/definitions/SearchIndex"
}
},
"default": {
@@ -1620,11 +1623,11 @@
"description": "The text to break into tokens."
},
"analyzer": {
- "$ref": "#/definitions/AnalyzerName",
+ "$ref": "#/definitions/LexicalAnalyzerName",
"description": "The name of the analyzer to use to break the given text. If this parameter is not specified, you must specify a tokenizer instead. The tokenizer and analyzer parameters are mutually exclusive."
},
"tokenizer": {
- "$ref": "#/definitions/TokenizerName",
+ "$ref": "#/definitions/LexicalTokenizerName",
"description": "The name of the tokenizer to use to break the given text. If this parameter is not specified, you must specify an analyzer instead. The tokenizer and analyzer parameters are mutually exclusive."
},
"tokenFilters": {
@@ -1654,7 +1657,7 @@
"tokens": {
"type": "array",
"items": {
- "$ref": "#/definitions/TokenInfo"
+ "$ref": "#/definitions/AnalyzedTokenInfo"
},
"description": "The list of tokens returned by the analyzer specified in the request."
}
@@ -1664,7 +1667,7 @@
],
"description": "The result of testing an analyzer on text."
},
- "TokenInfo": {
+ "AnalyzedTokenInfo": {
"properties": {
"token": {
"type": "string",
@@ -1701,7 +1704,7 @@
],
"description": "Information about a token returned by an analyzer."
},
- "AnalyzerName": {
+ "LexicalAnalyzerName": {
"type": "string",
"enum": [
"ar.microsoft",
@@ -1799,7 +1802,7 @@
"whitespace"
],
"x-ms-enum": {
- "name": "AnalyzerName",
+ "name": "LexicalAnalyzerName",
"modelAsString": true,
"values": [
{
@@ -2274,7 +2277,7 @@
"url": "https://docs.microsoft.com/rest/api/searchservice/Language-support"
}
},
- "TokenizerName": {
+ "LexicalTokenizerName": {
"type": "string",
"enum": [
"classic",
@@ -2292,7 +2295,7 @@
"whitespace"
],
"x-ms-enum": {
- "name": "TokenizerName",
+ "name": "LexicalTokenizerName",
"modelAsString": true,
"values": [
{
@@ -2427,7 +2430,7 @@
{
"value": "cjk_bigram",
"name": "CjkBigram",
- "description": "Forms bigrams of CJK terms that are generated from StandardTokenizer. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/cjk/CJKBigramFilter.html"
+ "description": "Forms bigrams of CJK terms that are generated from the standard tokenizer. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/cjk/CJKBigramFilter.html"
},
{
"value": "cjk_width",
@@ -2621,14 +2624,56 @@
],
"x-ms-enum": {
"name": "RegexFlags",
- "modelAsString": true
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "CANON_EQ",
+ "name": "CanonEq",
+ "description": "Enables canonical equivalence."
+ },
+ {
+ "value": "CASE_INSENSITIVE",
+ "name": "CaseInsensitive",
+ "description": "Enables case-insensitive matching."
+ },
+ {
+ "value": "COMMENTS",
+ "name": "Comments",
+ "description": "Permits whitespace and comments in the pattern."
+ },
+ {
+ "value": "DOTALL",
+ "name": "DotAll",
+ "description": "Enables dotall mode."
+ },
+ {
+ "value": "LITERAL",
+ "name": "Literal",
+ "description": "Enables literal parsing of the pattern."
+ },
+ {
+ "value": "MULTILINE",
+ "name": "Multiline",
+ "description": "Enables multiline mode."
+ },
+ {
+ "value": "UNICODE_CASE",
+ "name": "UnicodeCase",
+ "description": "Enables Unicode-aware case folding."
+ },
+ {
+ "value": "UNIX_LINES",
+ "name": "UnixLines",
+ "description": "Enables Unix lines mode."
+ }
+ ]
},
"description": "Defines flags that can be combined to control how regular expressions are used in the pattern analyzer and pattern tokenizer.",
"externalDocs": {
"url": "http://docs.oracle.com/javase/6/docs/api/java/util/regex/Pattern.html#field_summary"
}
},
- "DataType": {
+ "SearchFieldDataType": {
"type": "string",
"enum": [
"Edm.String",
@@ -2641,12 +2686,54 @@
"Edm.ComplexType"
],
"x-ms-enum": {
- "name": "DataType",
- "modelAsString": true
+ "name": "SearchFieldDataType",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "Edm.String",
+ "name": "String",
+ "description": "Indicates that a field contains a string."
+ },
+ {
+ "value": "Edm.Int32",
+ "name": "Int32",
+ "description": "Indicates that a field contains a 32-bit signed integer."
+ },
+ {
+ "value": "Edm.Int64",
+ "name": "Int64",
+ "description": "Indicates that a field contains a 64-bit signed integer."
+ },
+ {
+ "value": "Edm.Double",
+ "name": "Double",
+ "description": "Indicates that a field contains an IEEE double-precision floating point number."
+ },
+ {
+ "value": "Edm.Boolean",
+ "name": "Boolean",
+ "description": "Indicates that a field contains a Boolean value (true or false)."
+ },
+ {
+ "value": "Edm.DateTimeOffset",
+ "name": "DateTimeOffset",
+ "description": "Indicates that a field contains a date/time value, including timezone information."
+ },
+ {
+ "value": "Edm.GeographyPoint",
+ "name": "GeographyPoint",
+ "description": "Indicates that a field contains a geo-location in terms of longitude and latitude."
+ },
+ {
+ "value": "Edm.ComplexType",
+ "name": "Complex",
+ "description": "Indicates that a field contains one or more complex objects that in turn have sub-fields of other types."
+ }
+ ]
},
"description": "Defines the data type of a field in a search index."
},
- "Analyzer": {
+ "LexicalAnalyzer": {
"discriminator": "@odata.type",
"properties": {
"@odata.type": {
@@ -2671,12 +2758,12 @@
"x-ms-discriminator-value": "#Microsoft.Azure.Search.CustomAnalyzer",
"allOf": [
{
- "$ref": "#/definitions/Analyzer"
+ "$ref": "#/definitions/LexicalAnalyzer"
}
],
"properties": {
"tokenizer": {
- "$ref": "#/definitions/TokenizerName",
+ "$ref": "#/definitions/LexicalTokenizerName",
"description": "The name of the tokenizer to use to divide continuous text into a sequence of tokens, such as breaking a sentence into words."
},
"tokenFilters": {
@@ -2705,7 +2792,7 @@
"x-ms-discriminator-value": "#Microsoft.Azure.Search.PatternAnalyzer",
"allOf": [
{
- "$ref": "#/definitions/Analyzer"
+ "$ref": "#/definitions/LexicalAnalyzer"
}
],
"properties": {
@@ -2718,7 +2805,7 @@
"pattern": {
"type": "string",
"default": "\\W+",
- "description": "A regular expression pattern to match token separators. Default is an expression that matches one or more whitespace characters."
+ "description": "A regular expression pattern to match token separators. Default is an expression that matches one or more non-word characters."
},
"flags": {
"$ref": "#/definitions/RegexFlags",
@@ -2737,11 +2824,11 @@
"url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/PatternAnalyzer.html"
}
},
- "StandardAnalyzer": {
+ "LuceneStandardAnalyzer": {
"x-ms-discriminator-value": "#Microsoft.Azure.Search.StandardAnalyzer",
"allOf": [
{
- "$ref": "#/definitions/Analyzer"
+ "$ref": "#/definitions/LexicalAnalyzer"
}
],
"properties": {
@@ -2769,7 +2856,7 @@
"x-ms-discriminator-value": "#Microsoft.Azure.Search.StopAnalyzer",
"allOf": [
{
- "$ref": "#/definitions/Analyzer"
+ "$ref": "#/definitions/LexicalAnalyzer"
}
],
"properties": {
@@ -2786,7 +2873,7 @@
"url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/StopAnalyzer.html"
}
},
- "Tokenizer": {
+ "LexicalTokenizer": {
"discriminator": "@odata.type",
"properties": {
"@odata.type": {
@@ -2814,7 +2901,7 @@
"x-ms-discriminator-value": "#Microsoft.Azure.Search.ClassicTokenizer",
"allOf": [
{
- "$ref": "#/definitions/Tokenizer"
+ "$ref": "#/definitions/LexicalTokenizer"
}
],
"properties": {
@@ -2842,7 +2929,34 @@
],
"x-ms-enum": {
"name": "TokenCharacterKind",
- "modelAsString": false
+ "modelAsString": false,
+ "values": [
+ {
+ "value": "letter",
+ "name": "Letter",
+ "description": "Keeps letters in tokens."
+ },
+ {
+ "value": "digit",
+ "name": "Digit",
+ "description": "Keeps digits in tokens."
+ },
+ {
+ "value": "whitespace",
+ "name": "Whitespace",
+ "description": "Keeps whitespace in tokens."
+ },
+ {
+ "value": "punctuation",
+ "name": "Punctuation",
+ "description": "Keeps punctuation in tokens."
+ },
+ {
+ "value": "symbol",
+ "name": "Symbol",
+ "description": "Keeps symbols in tokens."
+ }
+ ]
},
"description": "Represents classes of characters on which a token filter can operate."
},
@@ -2850,7 +2964,7 @@
"x-ms-discriminator-value": "#Microsoft.Azure.Search.EdgeNGramTokenizer",
"allOf": [
{
- "$ref": "#/definitions/Tokenizer"
+ "$ref": "#/definitions/LexicalTokenizer"
}
],
"properties": {
@@ -2886,7 +3000,7 @@
"x-ms-discriminator-value": "#Microsoft.Azure.Search.KeywordTokenizer",
"allOf": [
{
- "$ref": "#/definitions/Tokenizer"
+ "$ref": "#/definitions/LexicalTokenizer"
}
],
"properties": {
@@ -2907,7 +3021,7 @@
"x-ms-discriminator-value": "#Microsoft.Azure.Search.KeywordTokenizerV2",
"allOf": [
{
- "$ref": "#/definitions/Tokenizer"
+ "$ref": "#/definitions/LexicalTokenizer"
}
],
"properties": {
@@ -2972,7 +3086,219 @@
],
"x-ms-enum": {
"name": "MicrosoftTokenizerLanguage",
- "modelAsString": false
+ "modelAsString": false,
+ "values": [
+ {
+ "value": "bangla",
+ "name": "Bangla",
+ "description": "Selects the Microsoft tokenizer for Bangla."
+ },
+ {
+ "value": "bulgarian",
+ "name": "Bulgarian",
+ "description": "Selects the Microsoft tokenizer for Bulgarian."
+ },
+ {
+ "value": "catalan",
+ "name": "Catalan",
+ "description": "Selects the Microsoft tokenizer for Catalan."
+ },
+ {
+ "value": "chineseSimplified",
+ "name": "ChineseSimplified",
+ "description": "Selects the Microsoft tokenizer for Chinese (Simplified)."
+ },
+ {
+ "value": "chineseTraditional",
+ "name": "ChineseTraditional",
+ "description": "Selects the Microsoft tokenizer for Chinese (Traditional)."
+ },
+ {
+ "value": "croatian",
+ "name": "Croatian",
+ "description": "Selects the Microsoft tokenizer for Croatian."
+ },
+ {
+ "value": "czech",
+ "name": "Czech",
+ "description": "Selects the Microsoft tokenizer for Czech."
+ },
+ {
+ "value": "danish",
+ "name": "Danish",
+ "description": "Selects the Microsoft tokenizer for Danish."
+ },
+ {
+ "value": "dutch",
+ "name": "Dutch",
+ "description": "Selects the Microsoft tokenizer for Dutch."
+ },
+ {
+ "value": "english",
+ "name": "English",
+ "description": "Selects the Microsoft tokenizer for English."
+ },
+ {
+ "value": "french",
+ "name": "French",
+ "description": "Selects the Microsoft tokenizer for French."
+ },
+ {
+ "value": "german",
+ "name": "German",
+ "description": "Selects the Microsoft tokenizer for German."
+ },
+ {
+ "value": "greek",
+ "name": "Greek",
+ "description": "Selects the Microsoft tokenizer for Greek."
+ },
+ {
+ "value": "gujarati",
+ "name": "Gujarati",
+ "description": "Selects the Microsoft tokenizer for Gujarati."
+ },
+ {
+ "value": "hindi",
+ "name": "Hindi",
+ "description": "Selects the Microsoft tokenizer for Hindi."
+ },
+ {
+ "value": "icelandic",
+ "name": "Icelandic",
+ "description": "Selects the Microsoft tokenizer for Icelandic."
+ },
+ {
+ "value": "indonesian",
+ "name": "Indonesian",
+ "description": "Selects the Microsoft tokenizer for Indonesian."
+ },
+ {
+ "value": "italian",
+ "name": "Italian",
+ "description": "Selects the Microsoft tokenizer for Italian."
+ },
+ {
+ "value": "japanese",
+ "name": "Japanese",
+ "description": "Selects the Microsoft tokenizer for Japanese."
+ },
+ {
+ "value": "kannada",
+ "name": "Kannada",
+ "description": "Selects the Microsoft tokenizer for Kannada."
+ },
+ {
+ "value": "korean",
+ "name": "Korean",
+ "description": "Selects the Microsoft tokenizer for Korean."
+ },
+ {
+ "value": "malay",
+ "name": "Malay",
+ "description": "Selects the Microsoft tokenizer for Malay."
+ },
+ {
+ "value": "malayalam",
+ "name": "Malayalam",
+ "description": "Selects the Microsoft tokenizer for Malayalam."
+ },
+ {
+ "value": "marathi",
+ "name": "Marathi",
+ "description": "Selects the Microsoft tokenizer for Marathi."
+ },
+ {
+ "value": "norwegianBokmaal",
+ "name": "NorwegianBokmaal",
+ "description": "Selects the Microsoft tokenizer for Norwegian (Bokmål)."
+ },
+ {
+ "value": "polish",
+ "name": "Polish",
+ "description": "Selects the Microsoft tokenizer for Polish."
+ },
+ {
+ "value": "portuguese",
+ "name": "Portuguese",
+ "description": "Selects the Microsoft tokenizer for Portuguese."
+ },
+ {
+ "value": "portugueseBrazilian",
+ "name": "PortugueseBrazilian",
+ "description": "Selects the Microsoft tokenizer for Portuguese (Brazil)."
+ },
+ {
+ "value": "punjabi",
+ "name": "Punjabi",
+ "description": "Selects the Microsoft tokenizer for Punjabi."
+ },
+ {
+ "value": "romanian",
+ "name": "Romanian",
+ "description": "Selects the Microsoft tokenizer for Romanian."
+ },
+ {
+ "value": "russian",
+ "name": "Russian",
+ "description": "Selects the Microsoft tokenizer for Russian."
+ },
+ {
+ "value": "serbianCyrillic",
+ "name": "SerbianCyrillic",
+ "description": "Selects the Microsoft tokenizer for Serbian (Cyrillic)."
+ },
+ {
+ "value": "serbianLatin",
+ "name": "SerbianLatin",
+ "description": "Selects the Microsoft tokenizer for Serbian (Latin)."
+ },
+ {
+ "value": "slovenian",
+ "name": "Slovenian",
+ "description": "Selects the Microsoft tokenizer for Slovenian."
+ },
+ {
+ "value": "spanish",
+ "name": "Spanish",
+ "description": "Selects the Microsoft tokenizer for Spanish."
+ },
+ {
+ "value": "swedish",
+ "name": "Swedish",
+ "description": "Selects the Microsoft tokenizer for Swedish."
+ },
+ {
+ "value": "tamil",
+ "name": "Tamil",
+ "description": "Selects the Microsoft tokenizer for Tamil."
+ },
+ {
+ "value": "telugu",
+ "name": "Telugu",
+ "description": "Selects the Microsoft tokenizer for Telugu."
+ },
+ {
+ "value": "thai",
+ "name": "Thai",
+ "description": "Selects the Microsoft tokenizer for Thai."
+ },
+ {
+ "value": "ukrainian",
+ "name": "Ukrainian",
+ "description": "Selects the Microsoft tokenizer for Ukrainian."
+ },
+ {
+ "value": "urdu",
+ "name": "Urdu",
+ "description": "Selects the Microsoft tokenizer for Urdu."
+ },
+ {
+ "value": "vietnamese",
+ "name": "Vietnamese",
+ "description": "Selects the Microsoft tokenizer for Vietnamese."
+ }
+ ]
},
"description": "Lists the languages supported by the Microsoft language tokenizer."
},
@@ -2980,7 +3306,7 @@
"x-ms-discriminator-value": "#Microsoft.Azure.Search.MicrosoftLanguageTokenizer",
"allOf": [
{
- "$ref": "#/definitions/Tokenizer"
+ "$ref": "#/definitions/LexicalTokenizer"
}
],
"properties": {
@@ -3054,7 +3380,234 @@
],
"x-ms-enum": {
"name": "MicrosoftStemmingTokenizerLanguage",
- "modelAsString": false
+ "modelAsString": false,
+ "values": [
+ {
+ "value": "arabic",
+ "name": "Arabic",
+ "description": "Selects the Microsoft stemming tokenizer for Arabic."
+ },
+ {
+ "value": "bangla",
+ "name": "Bangla",
+ "description": "Selects the Microsoft stemming tokenizer for Bangla."
+ },
+ {
+ "value": "bulgarian",
+ "name": "Bulgarian",
+ "description": "Selects the Microsoft stemming tokenizer for Bulgarian."
+ },
+ {
+ "value": "catalan",
+ "name": "Catalan",
+ "description": "Selects the Microsoft stemming tokenizer for Catalan."
+ },
+ {
+ "value": "croatian",
+ "name": "Croatian",
+ "description": "Selects the Microsoft stemming tokenizer for Croatian."
+ },
+ {
+ "value": "czech",
+ "name": "Czech",
+ "description": "Selects the Microsoft stemming tokenizer for Czech."
+ },
+ {
+ "value": "danish",
+ "name": "Danish",
+ "description": "Selects the Microsoft stemming tokenizer for Danish."
+ },
+ {
+ "value": "dutch",
+ "name": "Dutch",
+ "description": "Selects the Microsoft stemming tokenizer for Dutch."
+ },
+ {
+ "value": "english",
+ "name": "English",
+ "description": "Selects the Microsoft stemming tokenizer for English."
+ },
+ {
+ "value": "estonian",
+ "name": "Estonian",
+ "description": "Selects the Microsoft stemming tokenizer for Estonian."
+ },
+ {
+ "value": "finnish",
+ "name": "Finnish",
+ "description": "Selects the Microsoft stemming tokenizer for Finnish."
+ },
+ {
+ "value": "french",
+ "name": "French",
+ "description": "Selects the Microsoft stemming tokenizer for French."
+ },
+ {
+ "value": "german",
+ "name": "German",
+ "description": "Selects the Microsoft stemming tokenizer for German."
+ },
+ {
+ "value": "greek",
+ "name": "Greek",
+ "description": "Selects the Microsoft stemming tokenizer for Greek."
+ },
+ {
+ "value": "gujarati",
+ "name": "Gujarati",
+ "description": "Selects the Microsoft stemming tokenizer for Gujarati."
+ },
+ {
+ "value": "hebrew",
+ "name": "Hebrew",
+ "description": "Selects the Microsoft stemming tokenizer for Hebrew."
+ },
+ {
+ "value": "hindi",
+ "name": "Hindi",
+ "description": "Selects the Microsoft stemming tokenizer for Hindi."
+ },
+ {
+ "value": "hungarian",
+ "name": "Hungarian",
+ "description": "Selects the Microsoft stemming tokenizer for Hungarian."
+ },
+ {
+ "value": "icelandic",
+ "name": "Icelandic",
+ "description": "Selects the Microsoft stemming tokenizer for Icelandic."
+ },
+ {
+ "value": "indonesian",
+ "name": "Indonesian",
+ "description": "Selects the Microsoft stemming tokenizer for Indonesian."
+ },
+ {
+ "value": "italian",
+ "name": "Italian",
+ "description": "Selects the Microsoft stemming tokenizer for Italian."
+ },
+ {
+ "value": "kannada",
+ "name": "Kannada",
+ "description": "Selects the Microsoft stemming tokenizer for Kannada."
+ },
+ {
+ "value": "latvian",
+ "name": "Latvian",
+ "description": "Selects the Microsoft stemming tokenizer for Latvian."
+ },
+ {
+ "value": "lithuanian",
+ "name": "Lithuanian",
+ "description": "Selects the Microsoft stemming tokenizer for Lithuanian."
+ },
+ {
+ "value": "malay",
+ "name": "Malay",
+ "description": "Selects the Microsoft stemming tokenizer for Malay."
+ },
+ {
+ "value": "malayalam",
+ "name": "Malayalam",
+ "description": "Selects the Microsoft stemming tokenizer for Malayalam."
+ },
+ {
+ "value": "marathi",
+ "name": "Marathi",
+ "description": "Selects the Microsoft stemming tokenizer for Marathi."
+ },
+ {
+ "value": "norwegianBokmaal",
+ "name": "NorwegianBokmaal",
+ "description": "Selects the Microsoft stemming tokenizer for Norwegian (Bokmål)."
+ },
+ {
+ "value": "polish",
+ "name": "Polish",
+ "description": "Selects the Microsoft stemming tokenizer for Polish."
+ },
+ {
+ "value": "portuguese",
+ "name": "Portuguese",
+ "description": "Selects the Microsoft stemming tokenizer for Portuguese."
+ },
+ {
+ "value": "portugueseBrazilian",
+ "name": "PortugueseBrazilian",
+ "description": "Selects the Microsoft stemming tokenizer for Portuguese (Brazil)."
+ },
+ {
+ "value": "punjabi",
+ "name": "Punjabi",
+ "description": "Selects the Microsoft stemming tokenizer for Punjabi."
+ },
+ {
+ "value": "romanian",
+ "name": "Romanian",
+ "description": "Selects the Microsoft stemming tokenizer for Romanian."
+ },
+ {
+ "value": "russian",
+ "name": "Russian",
+ "description": "Selects the Microsoft stemming tokenizer for Russian."
+ },
+ {
+ "value": "serbianCyrillic",
+ "name": "SerbianCyrillic",
+ "description": "Selects the Microsoft stemming tokenizer for Serbian (Cyrillic)."
+ },
+ {
+ "value": "serbianLatin",
+ "name": "SerbianLatin",
+ "description": "Selects the Microsoft stemming tokenizer for Serbian (Latin)."
+ },
+ {
+ "value": "slovak",
+ "name": "Slovak",
+ "description": "Selects the Microsoft stemming tokenizer for Slovak."
+ },
+ {
+ "value": "slovenian",
+ "name": "Slovenian",
+ "description": "Selects the Microsoft stemming tokenizer for Slovenian."
+ },
+ {
+ "value": "spanish",
+ "name": "Spanish",
+ "description": "Selects the Microsoft stemming tokenizer for Spanish."
+ },
+ {
+ "value": "swedish",
+ "name": "Swedish",
+ "description": "Selects the Microsoft stemming tokenizer for Swedish."
+ },
+ {
+ "value": "tamil",
+ "name": "Tamil",
+ "description": "Selects the Microsoft stemming tokenizer for Tamil."
+ },
+ {
+ "value": "telugu",
+ "name": "Telugu",
+ "description": "Selects the Microsoft stemming tokenizer for Telugu."
+ },
+ {
+ "value": "turkish",
+ "name": "Turkish",
+ "description": "Selects the Microsoft stemming tokenizer for Turkish."
+ },
+ {
+ "value": "ukrainian",
+ "name": "Ukrainian",
+ "description": "Selects the Microsoft stemming tokenizer for Ukrainian."
+ },
+ {
+ "value": "urdu",
+ "name": "Urdu",
+ "description": "Selects the Microsoft stemming tokenizer for Urdu."
+ }
+ ]
},
"description": "Lists the languages supported by the Microsoft language stemming tokenizer."
},
@@ -3062,7 +3615,7 @@
"x-ms-discriminator-value": "#Microsoft.Azure.Search.MicrosoftLanguageStemmingTokenizer",
"allOf": [
{
- "$ref": "#/definitions/Tokenizer"
+ "$ref": "#/definitions/LexicalTokenizer"
}
],
"properties": {
@@ -3089,7 +3642,7 @@
"x-ms-discriminator-value": "#Microsoft.Azure.Search.NGramTokenizer",
"allOf": [
{
- "$ref": "#/definitions/Tokenizer"
+ "$ref": "#/definitions/LexicalTokenizer"
}
],
"properties": {
@@ -3125,7 +3678,7 @@
"x-ms-discriminator-value": "#Microsoft.Azure.Search.PathHierarchyTokenizerV2",
"allOf": [
{
- "$ref": "#/definitions/Tokenizer"
+ "$ref": "#/definitions/LexicalTokenizer"
}
],
"properties": {
@@ -3171,14 +3724,14 @@
"x-ms-discriminator-value": "#Microsoft.Azure.Search.PatternTokenizer",
"allOf": [
{
- "$ref": "#/definitions/Tokenizer"
+ "$ref": "#/definitions/LexicalTokenizer"
}
],
"properties": {
"pattern": {
"type": "string",
"default": "\\W+",
- "description": "A regular expression pattern to match token separators. Default is an expression that matches one or more whitespace characters."
+ "description": "A regular expression pattern to match token separators. Default is an expression that matches one or more non-word characters."
},
"flags": {
"$ref": "#/definitions/RegexFlags",
@@ -3196,11 +3749,11 @@
"url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/pattern/PatternTokenizer.html"
}
},
- "StandardTokenizer": {
+ "LuceneStandardTokenizer": {
"x-ms-discriminator-value": "#Microsoft.Azure.Search.StandardTokenizer",
"allOf": [
{
- "$ref": "#/definitions/Tokenizer"
+ "$ref": "#/definitions/LexicalTokenizer"
}
],
"properties": {
@@ -3217,11 +3770,11 @@
},
"x-az-search-deprecated": true
},
- "StandardTokenizerV2": {
+ "LuceneStandardTokenizerV2": {
"x-ms-discriminator-value": "#Microsoft.Azure.Search.StandardTokenizerV2",
"allOf": [
{
- "$ref": "#/definitions/Tokenizer"
+ "$ref": "#/definitions/LexicalTokenizer"
}
],
"properties": {
@@ -3242,7 +3795,7 @@
"x-ms-discriminator-value": "#Microsoft.Azure.Search.UaxUrlEmailTokenizer",
"allOf": [
{
- "$ref": "#/definitions/Tokenizer"
+ "$ref": "#/definitions/LexicalTokenizer"
}
],
"properties": {
@@ -3312,7 +3865,29 @@
],
"x-ms-enum": {
"name": "CjkBigramTokenFilterScripts",
- "modelAsString": false
+ "modelAsString": false,
+ "values": [
+ {
+ "value": "han",
+ "name": "Han",
+ "description": "Ignore Han script when forming bigrams of CJK terms."
+ },
+ {
+ "value": "hiragana",
+ "name": "Hiragana",
+ "description": "Ignore Hiragana script when forming bigrams of CJK terms."
+ },
+ {
+ "value": "katakana",
+ "name": "Katakana",
+ "description": "Ignore Katakana script when forming bigrams of CJK terms."
+ },
+ {
+ "value": "hangul",
+ "name": "Hangul",
+ "description": "Ignore Hangul script when forming bigrams of CJK terms."
+ }
+ ]
},
"description": "Scripts that can be ignored by CjkBigramTokenFilter."
},
@@ -3338,7 +3913,7 @@
"description": "A value indicating whether to output both unigrams and bigrams (if true), or just bigrams (if false). Default is false."
}
},
- "description": "Forms bigrams of CJK terms that are generated from StandardTokenizer. This token filter is implemented using Apache Lucene.",
+ "description": "Forms bigrams of CJK terms that are generated from the standard tokenizer. This token filter is implemented using Apache Lucene.",
"externalDocs": {
"url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/cjk/CJKBigramFilter.html"
}
@@ -3436,7 +4011,19 @@
],
"x-ms-enum": {
"name": "EdgeNGramTokenFilterSide",
- "modelAsString": false
+ "modelAsString": false,
+ "values": [
+ {
+ "value": "front",
+ "name": "Front",
+ "description": "Specifies that the n-gram should be generated from the front of the input."
+ },
+ {
+ "value": "back",
+ "name": "Back",
+ "description": "Specifies that the n-gram should be generated from the back of the input."
+ }
+ ]
},
"description": "Specifies which side of the input an n-gram should be generated from."
},
@@ -3594,6 +4181,7 @@
],
"properties": {
"min": {
+ "x-ms-client-name": "minLength",
"type": "integer",
"format": "int32",
"default": 0,
@@ -3601,6 +4189,7 @@
"description": "The minimum length in characters. Default is 0. Maximum is 300. Must be less than the value of max."
},
"max": {
+ "x-ms-client-name": "maxLength",
"type": "integer",
"format": "int32",
"default": 300,
@@ -3765,7 +4354,64 @@
],
"x-ms-enum": {
"name": "PhoneticEncoder",
- "modelAsString": false
+ "modelAsString": false,
+ "values": [
+ {
+ "value": "metaphone",
+ "name": "Metaphone",
+ "description": "Encodes a token into a Metaphone value."
+ },
+ {
+ "value": "doubleMetaphone",
+ "name": "DoubleMetaphone",
+ "description": "Encodes a token into a double metaphone value."
+ },
+ {
+ "value": "soundex",
+ "name": "Soundex",
+ "description": "Encodes a token into a Soundex value."
+ },
+ {
+ "value": "refinedSoundex",
+ "name": "RefinedSoundex",
+ "description": "Encodes a token into a Refined Soundex value."
+ },
+ {
+ "value": "caverphone1",
+ "name": "Caverphone1",
+ "description": "Encodes a token into a Caverphone 1.0 value."
+ },
+ {
+ "value": "caverphone2",
+ "name": "Caverphone2",
+ "description": "Encodes a token into a Caverphone 2.0 value."
+ },
+ {
+ "value": "cologne",
+ "name": "Cologne",
+ "description": "Encodes a token into a Cologne Phonetic value."
+ },
+ {
+ "value": "nysiis",
+ "name": "Nysiis",
+ "description": "Encodes a token into a NYSIIS value."
+ },
+ {
+ "value": "koelnerPhonetik",
+ "name": "KoelnerPhonetik",
+ "description": "Encodes a token using the Kölner Phonetik algorithm."
+ },
+ {
+ "value": "haasePhonetik",
+ "name": "HaasePhonetik",
+ "description": "Encodes a token using the Haase refinement of the Kölner Phonetik algorithm."
+ },
+ {
+ "value": "beiderMorse",
+ "name": "BeiderMorse",
+ "description": "Encodes a token into a Beider-Morse value."
+ }
+ ]
},
"description": "Identifies the type of phonetic encoder to use with a PhoneticTokenFilter."
},
@@ -3870,7 +4516,119 @@
],
"x-ms-enum": {
"name": "SnowballTokenFilterLanguage",
- "modelAsString": false
+ "modelAsString": false,
+ "values": [
+ {
+ "value": "armenian",
+ "name": "Armenian",
+ "description": "Selects the Lucene Snowball stemming tokenizer for Armenian."
+ },
+ {
+ "value": "basque",
+ "name": "Basque",
+ "description": "Selects the Lucene Snowball stemming tokenizer for Basque."
+ },
+ {
+ "value": "catalan",
+ "name": "Catalan",
+ "description": "Selects the Lucene Snowball stemming tokenizer for Catalan."
+ },
+ {
+ "value": "danish",
+ "name": "Danish",
+ "description": "Selects the Lucene Snowball stemming tokenizer for Danish."
+ },
+ {
+ "value": "dutch",
+ "name": "Dutch",
+ "description": "Selects the Lucene Snowball stemming tokenizer for Dutch."
+ },
+ {
+ "value": "english",
+ "name": "English",
+ "description": "Selects the Lucene Snowball stemming tokenizer for English."
+ },
+ {
+ "value": "finnish",
+ "name": "Finnish",
+ "description": "Selects the Lucene Snowball stemming tokenizer for Finnish."
+ },
+ {
+ "value": "french",
+ "name": "French",
+ "description": "Selects the Lucene Snowball stemming tokenizer for French."
+ },
+ {
+ "value": "german",
+ "name": "German",
+ "description": "Selects the Lucene Snowball stemming tokenizer for German."
+ },
+ {
+ "value": "german2",
+ "name": "German2",
+ "description": "Selects the Lucene Snowball stemming tokenizer that uses the German variant algorithm."
+ },
+ {
+ "value": "hungarian",
+ "name": "Hungarian",
+ "description": "Selects the Lucene Snowball stemming tokenizer for Hungarian."
+ },
+ {
+ "value": "italian",
+ "name": "Italian",
+ "description": "Selects the Lucene Snowball stemming tokenizer for Italian."
+ },
+ {
+ "value": "kp",
+ "name": "Kp",
+ "description": "Selects the Lucene Snowball stemming tokenizer for Dutch that uses the Kraaij-Pohlmann stemming algorithm."
+ },
+ {
+ "value": "lovins",
+ "name": "Lovins",
+ "description": "Selects the Lucene Snowball stemming tokenizer for English that uses the Lovins stemming algorithm."
+ },
+ {
+ "value": "norwegian",
+ "name": "Norwegian",
+ "description": "Selects the Lucene Snowball stemming tokenizer for Norwegian."
+ },
+ {
+ "value": "porter",
+ "name": "Porter",
+ "description": "Selects the Lucene Snowball stemming tokenizer for English that uses the Porter stemming algorithm."
+ },
+ {
+ "value": "portuguese",
+ "name": "Portuguese",
+ "description": "Selects the Lucene Snowball stemming tokenizer for Portuguese."
+ },
+ {
+ "value": "romanian",
+ "name": "Romanian",
+ "description": "Selects the Lucene Snowball stemming tokenizer for Romanian."
+ },
+ {
+ "value": "russian",
+ "name": "Russian",
+ "description": "Selects the Lucene Snowball stemming tokenizer for Russian."
+ },
+ {
+ "value": "spanish",
+ "name": "Spanish",
+ "description": "Selects the Lucene Snowball stemming tokenizer for Spanish."
+ },
+ {
+ "value": "swedish",
+ "name": "Swedish",
+ "description": "Selects the Lucene Snowball stemming tokenizer for Swedish."
+ },
+ {
+ "value": "turkish",
+ "name": "Turkish",
+ "description": "Selects the Lucene Snowball stemming tokenizer for Turkish."
+ }
+ ]
},
"description": "The language to use for a Snowball token filter."
},
@@ -3955,7 +4713,279 @@
],
"x-ms-enum": {
"name": "StemmerTokenFilterLanguage",
- "modelAsString": false
+ "modelAsString": false,
+ "values": [
+ {
+ "value": "arabic",
+ "name": "Arabic",
+ "description": "Selects the Lucene stemming tokenizer for Arabic."
+ },
+ {
+ "value": "armenian",
+ "name": "Armenian",
+ "description": "Selects the Lucene stemming tokenizer for Armenian."
+ },
+ {
+ "value": "basque",
+ "name": "Basque",
+ "description": "Selects the Lucene stemming tokenizer for Basque."
+ },
+ {
+ "value": "brazilian",
+ "name": "Brazilian",
+ "description": "Selects the Lucene stemming tokenizer for Portuguese (Brazil)."
+ },
+ {
+ "value": "bulgarian",
+ "name": "Bulgarian",
+ "description": "Selects the Lucene stemming tokenizer for Bulgarian."
+ },
+ {
+ "value": "catalan",
+ "name": "Catalan",
+ "description": "Selects the Lucene stemming tokenizer for Catalan."
+ },
+ {
+ "value": "czech",
+ "name": "Czech",
+ "description": "Selects the Lucene stemming tokenizer for Czech."
+ },
+ {
+ "value": "danish",
+ "name": "Danish",
+ "description": "Selects the Lucene stemming tokenizer for Danish."
+ },
+ {
+ "value": "dutch",
+ "name": "Dutch",
+ "description": "Selects the Lucene stemming tokenizer for Dutch."
+ },
+ {
+ "value": "dutchKp",
+ "name": "DutchKp",
+ "description": "Selects the Lucene stemming tokenizer for Dutch that uses the Kraaij-Pohlmann stemming algorithm."
+ },
+ {
+ "value": "english",
+ "name": "English",
+ "description": "Selects the Lucene stemming tokenizer for English."
+ },
+ {
+ "value": "lightEnglish",
+ "name": "LightEnglish",
+ "description": "Selects the Lucene stemming tokenizer for English that does light stemming."
+ },
+ {
+ "value": "minimalEnglish",
+ "name": "MinimalEnglish",
+ "description": "Selects the Lucene stemming tokenizer for English that does minimal stemming."
+ },
+ {
+ "value": "possessiveEnglish",
+ "name": "PossessiveEnglish",
+ "description": "Selects the Lucene stemming tokenizer for English that removes trailing possessives from words."
+ },
+ {
+ "value": "porter2",
+ "name": "Porter2",
+ "description": "Selects the Lucene stemming tokenizer for English that uses the Porter2 stemming algorithm."
+ },
+ {
+ "value": "lovins",
+ "name": "Lovins",
+ "description": "Selects the Lucene stemming tokenizer for English that uses the Lovins stemming algorithm."
+ },
+ {
+ "value": "finnish",
+ "name": "Finnish",
+ "description": "Selects the Lucene stemming tokenizer for Finnish."
+ },
+ {
+ "value": "lightFinnish",
+ "name": "LightFinnish",
+ "description": "Selects the Lucene stemming tokenizer for Finnish that does light stemming."
+ },
+ {
+ "value": "french",
+ "name": "French",
+ "description": "Selects the Lucene stemming tokenizer for French."
+ },
+ {
+ "value": "lightFrench",
+ "name": "LightFrench",
+ "description": "Selects the Lucene stemming tokenizer for French that does light stemming."
+ },
+ {
+ "value": "minimalFrench",
+ "name": "MinimalFrench",
+ "description": "Selects the Lucene stemming tokenizer for French that does minimal stemming."
+ },
+ {
+ "value": "galician",
+ "name": "Galician",
+ "description": "Selects the Lucene stemming tokenizer for Galician."
+ },
+ {
+ "value": "minimalGalician",
+ "name": "MinimalGalician",
+ "description": "Selects the Lucene stemming tokenizer for Galician that does minimal stemming."
+ },
+ {
+ "value": "german",
+ "name": "German",
+ "description": "Selects the Lucene stemming tokenizer for German."
+ },
+ {
+ "value": "german2",
+ "name": "German2",
+ "description": "Selects the Lucene stemming tokenizer that uses the German variant algorithm."
+ },
+ {
+ "value": "lightGerman",
+ "name": "LightGerman",
+ "description": "Selects the Lucene stemming tokenizer for German that does light stemming."
+ },
+ {
+ "value": "minimalGerman",
+ "name": "MinimalGerman",
+ "description": "Selects the Lucene stemming tokenizer for German that does minimal stemming."
+ },
+ {
+ "value": "greek",
+ "name": "Greek",
+ "description": "Selects the Lucene stemming tokenizer for Greek."
+ },
+ {
+ "value": "hindi",
+ "name": "Hindi",
+ "description": "Selects the Lucene stemming tokenizer for Hindi."
+ },
+ {
+ "value": "hungarian",
+ "name": "Hungarian",
+ "description": "Selects the Lucene stemming tokenizer for Hungarian."
+ },
+ {
+ "value": "lightHungarian",
+ "name": "LightHungarian",
+ "description": "Selects the Lucene stemming tokenizer for Hungarian that does light stemming."
+ },
+ {
+ "value": "indonesian",
+ "name": "Indonesian",
+ "description": "Selects the Lucene stemming tokenizer for Indonesian."
+ },
+ {
+ "value": "irish",
+ "name": "Irish",
+ "description": "Selects the Lucene stemming tokenizer for Irish."
+ },
+ {
+ "value": "italian",
+ "name": "Italian",
+ "description": "Selects the Lucene stemming tokenizer for Italian."
+ },
+ {
+ "value": "lightItalian",
+ "name": "LightItalian",
+ "description": "Selects the Lucene stemming tokenizer for Italian that does light stemming."
+ },
+ {
+ "value": "sorani",
+ "name": "Sorani",
+ "description": "Selects the Lucene stemming tokenizer for Sorani."
+ },
+ {
+ "value": "latvian",
+ "name": "Latvian",
+ "description": "Selects the Lucene stemming tokenizer for Latvian."
+ },
+ {
+ "value": "norwegian",
+ "name": "Norwegian",
+ "description": "Selects the Lucene stemming tokenizer for Norwegian (Bokmål)."
+ },
+ {
+ "value": "lightNorwegian",
+ "name": "LightNorwegian",
+ "description": "Selects the Lucene stemming tokenizer for Norwegian (Bokmål) that does light stemming."
+ },
+ {
+ "value": "minimalNorwegian",
+ "name": "MinimalNorwegian",
+ "description": "Selects the Lucene stemming tokenizer for Norwegian (Bokmål) that does minimal stemming."
+ },
+ {
+ "value": "lightNynorsk",
+ "name": "LightNynorsk",
+ "description": "Selects the Lucene stemming tokenizer for Norwegian (Nynorsk) that does light stemming."
+ },
+ {
+ "value": "minimalNynorsk",
+ "name": "MinimalNynorsk",
+ "description": "Selects the Lucene stemming tokenizer for Norwegian (Nynorsk) that does minimal stemming."
+ },
+ {
+ "value": "portuguese",
+ "name": "Portuguese",
+ "description": "Selects the Lucene stemming tokenizer for Portuguese."
+ },
+ {
+ "value": "lightPortuguese",
+ "name": "LightPortuguese",
+ "description": "Selects the Lucene stemming tokenizer for Portuguese that does light stemming."
+ },
+ {
+ "value": "minimalPortuguese",
+ "name": "MinimalPortuguese",
+ "description": "Selects the Lucene stemming tokenizer for Portuguese that does minimal stemming."
+ },
+ {
+ "value": "portugueseRslp",
+ "name": "PortugueseRslp",
+ "description": "Selects the Lucene stemming tokenizer for Portuguese that uses the RSLP stemming algorithm."
+ },
+ {
+ "value": "romanian",
+ "name": "Romanian",
+ "description": "Selects the Lucene stemming tokenizer for Romanian."
+ },
+ {
+ "value": "russian",
+ "name": "Russian",
+ "description": "Selects the Lucene stemming tokenizer for Russian."
+ },
+ {
+ "value": "lightRussian",
+ "name": "LightRussian",
+ "description": "Selects the Lucene stemming tokenizer for Russian that does light stemming."
+ },
+ {
+ "value": "spanish",
+ "name": "Spanish",
+ "description": "Selects the Lucene stemming tokenizer for Spanish."
+ },
+ {
+ "value": "lightSpanish",
+ "name": "LightSpanish",
+ "description": "Selects the Lucene stemming tokenizer for Spanish that does light stemming."
+ },
+ {
+ "value": "swedish",
+ "name": "Swedish",
+ "description": "Selects the Lucene stemming tokenizer for Swedish."
+ },
+ {
+ "value": "lightSwedish",
+ "name": "LightSwedish",
+ "description": "Selects the Lucene stemming tokenizer for Swedish that does light stemming."
+ },
+ {
+ "value": "turkish",
+ "name": "Turkish",
+ "description": "Selects the Lucene stemming tokenizer for Turkish."
+ }
+ ]
},
"description": "The language to use for a stemmer token filter."
},
@@ -4041,7 +5071,164 @@
],
"x-ms-enum": {
"name": "StopwordsList",
- "modelAsString": false
+ "modelAsString": false,
+ "values": [
+ {
+ "value": "arabic",
+ "name": "Arabic",
+ "description": "Selects the stopword list for Arabic."
+ },
+ {
+ "value": "armenian",
+ "name": "Armenian",
+ "description": "Selects the stopword list for Armenian."
+ },
+ {
+ "value": "basque",
+ "name": "Basque",
+ "description": "Selects the stopword list for Basque."
+ },
+ {
+ "value": "brazilian",
+ "name": "Brazilian",
+ "description": "Selects the stopword list for Portuguese (Brazil)."
+ },
+ {
+ "value": "bulgarian",
+ "name": "Bulgarian",
+ "description": "Selects the stopword list for Bulgarian."
+ },
+ {
+ "value": "catalan",
+ "name": "Catalan",
+ "description": "Selects the stopword list for Catalan."
+ },
+ {
+ "value": "czech",
+ "name": "Czech",
+ "description": "Selects the stopword list for Czech."
+ },
+ {
+ "value": "danish",
+ "name": "Danish",
+ "description": "Selects the stopword list for Danish."
+ },
+ {
+ "value": "dutch",
+ "name": "Dutch",
+ "description": "Selects the stopword list for Dutch."
+ },
+ {
+ "value": "english",
+ "name": "English",
+ "description": "Selects the stopword list for English."
+ },
+ {
+ "value": "finnish",
+ "name": "Finnish",
+ "description": "Selects the stopword list for Finnish."
+ },
+ {
+ "value": "french",
+ "name": "French",
+ "description": "Selects the stopword list for French."
+ },
+ {
+ "value": "galician",
+ "name": "Galician",
+ "description": "Selects the stopword list for Galician."
+ },
+ {
+ "value": "german",
+ "name": "German",
+ "description": "Selects the stopword list for German."
+ },
+ {
+ "value": "greek",
+ "name": "Greek",
+ "description": "Selects the stopword list for Greek."
+ },
+ {
+ "value": "hindi",
+ "name": "Hindi",
+ "description": "Selects the stopword list for Hindi."
+ },
+ {
+ "value": "hungarian",
+ "name": "Hungarian",
+ "description": "Selects the stopword list for Hungarian."
+ },
+ {
+ "value": "indonesian",
+ "name": "Indonesian",
+ "description": "Selects the stopword list for Indonesian."
+ },
+ {
+ "value": "irish",
+ "name": "Irish",
+ "description": "Selects the stopword list for Irish."
+ },
+ {
+ "value": "italian",
+ "name": "Italian",
+ "description": "Selects the stopword list for Italian."
+ },
+ {
+ "value": "latvian",
+ "name": "Latvian",
+ "description": "Selects the stopword list for Latvian."
+ },
+ {
+ "value": "norwegian",
+ "name": "Norwegian",
+ "description": "Selects the stopword list for Norwegian."
+ },
+ {
+ "value": "persian",
+ "name": "Persian",
+ "description": "Selects the stopword list for Persian."
+ },
+ {
+ "value": "portuguese",
+ "name": "Portuguese",
+ "description": "Selects the stopword list for Portuguese."
+ },
+ {
+ "value": "romanian",
+ "name": "Romanian",
+ "description": "Selects the stopword list for Romanian."
+ },
+ {
+ "value": "russian",
+ "name": "Russian",
+ "description": "Selects the stopword list for Russian."
+ },
+ {
+ "value": "sorani",
+ "name": "Sorani",
+ "description": "Selects the stopword list for Sorani."
+ },
+ {
+ "value": "spanish",
+ "name": "Spanish",
+ "description": "Selects the stopword list for Spanish."
+ },
+ {
+ "value": "swedish",
+ "name": "Swedish",
+ "description": "Selects the stopword list for Swedish."
+ },
+ {
+ "value": "thai",
+ "name": "Thai",
+ "description": "Selects the stopword list for Thai."
+ },
+ {
+ "value": "turkish",
+ "name": "Turkish",
+ "description": "Selects the stopword list for Turkish."
+ }
+ ]
},
"description": "Identifies a predefined list of language-specific stopwords."
},
@@ -4296,6 +5483,51 @@
"url": "https://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/pattern/PatternReplaceCharFilter.html"
}
},
+ "Similarity": {
+ "discriminator": "@odata.type",
+ "properties": {
+ "@odata.type": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "@odata.type"
+ ],
+ "description": "Base type for similarity algorithms. Similarity algorithms are used to calculate scores that tie queries to documents. The higher the score, the more relevant the document is to that specific query. Those scores are used to rank the search results.",
+ "externalDocs": {
+ "url": "https://docs.microsoft.com/azure/search/index-ranking-similarity"
+ }
+ },
+ "ClassicSimilarity": {
+ "x-ms-discriminator-value": "#Microsoft.Azure.Search.ClassicSimilarity",
+ "allOf": [
+ {
+ "$ref": "#/definitions/Similarity"
+ }
+ ],
+ "description": "Legacy similarity algorithm which uses the Lucene TFIDFSimilarity implementation of TF-IDF. This variation of TF-IDF introduces static document length normalization as well as coordinating factors that penalize documents that only partially match the searched queries."
+ },
+ "BM25Similarity": {
+ "x-ms-discriminator-value": "#Microsoft.Azure.Search.BM25Similarity",
+ "allOf": [
+ {
+ "$ref": "#/definitions/Similarity"
+ }
+ ],
+ "properties": {
+ "k1": {
+ "type": "number",
+ "format": "double",
+ "description": "This property controls the scaling function between the term frequency of each matching terms and the final relevance score of a document-query pair. By default, a value of 1.2 is used. A value of 0.0 means the score does not scale with an increase in term frequency."
+ },
+ "b": {
+ "type": "number",
+ "format": "double",
+ "description": "This property controls how the length of a document affects the relevance score. By default, a value of 0.75 is used. A value of 0.0 means no length normalization is applied, while a value of 1.0 means the score is fully normalized by the length of the document."
+ }
+ },
+ "description": "Ranking function based on the Okapi BM25 similarity algorithm. BM25 is a TF-IDF-like algorithm that includes length normalization (controlled by the 'b' parameter) as well as term frequency saturation (controlled by the 'k1' parameter)."
+ },
"DataSourceCredentials": {
"properties": {
"connectionString": {
@@ -4308,7 +5540,7 @@
},
"description": "Represents credentials that can be used to connect to a datasource."
},
- "DataContainer": {
+ "SearchIndexerDataContainer": {
"properties": {
"name": {
"type": "string",
@@ -4396,7 +5628,7 @@
}
}
},
- "DataSourceType": {
+ "SearchIndexerDataSourceType": {
"type": "string",
"enum": [
"azuresql",
@@ -4406,34 +5638,39 @@
"mysql"
],
"x-ms-enum": {
- "name": "DataSourceType",
+ "name": "SearchIndexerDataSourceType",
"modelAsString": true,
"values": [
{
"value": "azuresql",
- "name": "AzureSql"
+ "name": "AzureSql",
+ "description": "Indicates an Azure SQL datasource."
},
{
"value": "cosmosdb",
- "name": "CosmosDb"
+ "name": "CosmosDb",
+ "description": "Indicates a CosmosDB datasource."
},
{
"value": "azureblob",
- "name": "AzureBlob"
+ "name": "AzureBlob",
+ "description": "Indicates a Azure Blob datasource."
},
{
"value": "azuretable",
- "name": "AzureTable"
+ "name": "AzureTable",
+ "description": "Indicates a Azure Table datasource."
},
{
"value": "mysql",
- "name": "MySql"
+ "name": "MySql",
+ "description": "Indicates a MySql datasource."
}
]
},
"description": "Defines the type of a datasource."
},
- "DataSource": {
+ "SearchIndexerDataSource": {
"properties": {
"name": {
"externalDocs": {
@@ -4447,7 +5684,7 @@
"description": "The description of the datasource."
},
"type": {
- "$ref": "#/definitions/DataSourceType",
+ "$ref": "#/definitions/SearchIndexerDataSourceType",
"description": "The type of the datasource."
},
"credentials": {
@@ -4455,7 +5692,7 @@
"description": "Credentials for the datasource."
},
"container": {
- "$ref": "#/definitions/DataContainer",
+ "$ref": "#/definitions/SearchIndexerDataContainer",
"description": "The data container for the datasource."
},
"dataChangeDetectionPolicy": {
@@ -4469,7 +5706,7 @@
"@odata.etag": {
"x-ms-client-name": "ETag",
"type": "string",
- "description": "The ETag of the DataSource."
+ "description": "The ETag of the data source."
}
},
"required": [
@@ -4487,7 +5724,7 @@
"type": "array",
"readOnly": true,
"items": {
- "$ref": "#/definitions/DataSource"
+ "$ref": "#/definitions/SearchIndexerDataSource"
},
"description": "The datasources in the Search service."
}
@@ -4589,7 +5826,7 @@
"url": "https://docs.microsoft.com/azure/search/search-indexer-field-mappings"
}
},
- "Indexer": {
+ "SearchIndexer": {
"properties": {
"name": {
"externalDocs": {
@@ -4651,7 +5888,7 @@
"@odata.etag": {
"x-ms-client-name": "ETag",
"type": "string",
- "description": "The ETag of the Indexer."
+ "description": "The ETag of the indexer."
}
},
"required": [
@@ -4671,7 +5908,7 @@
"type": "array",
"readOnly": true,
"items": {
- "$ref": "#/definitions/Indexer"
+ "$ref": "#/definitions/SearchIndexer"
},
"description": "The indexers in the Search service."
}
@@ -4681,7 +5918,7 @@
],
"description": "Response from a List Indexers request. If successful, it includes the full definitions of all indexers."
},
- "ItemError": {
+ "SearchIndexerError": {
"properties": {
"key": {
"type": "string",
@@ -4722,7 +5959,7 @@
],
"description": "Represents an item- or document-level indexing error."
},
- "ItemWarning": {
+ "SearchIndexerWarning": {
"properties": {
"key": {
"type": "string",
@@ -4783,7 +6020,7 @@
"type": "array",
"readOnly": true,
"items": {
- "$ref": "#/definitions/ItemError"
+ "$ref": "#/definitions/SearchIndexerError"
},
"description": "The item-level indexing errors."
},
@@ -4791,7 +6028,7 @@
"type": "array",
"readOnly": true,
"items": {
- "$ref": "#/definitions/ItemWarning"
+ "$ref": "#/definitions/SearchIndexerWarning"
},
"description": "The item-level indexing warnings."
},
@@ -4841,12 +6078,34 @@
],
"x-ms-enum": {
"name": "IndexerExecutionStatus",
- "modelAsString": false
+ "modelAsString": false,
+ "values": [
+ {
+ "value": "transientFailure",
+ "name": "TransientFailure",
+ "description": "An indexer invocation has failed, but the failure may be transient. Indexer invocations will continue per schedule."
+ },
+ {
+ "value": "success",
+ "name": "Success",
+ "description": "Indexer execution completed successfully."
+ },
+ {
+ "value": "inProgress",
+ "name": "InProgress",
+ "description": "Indexer execution is in progress."
+ },
+ {
+ "value": "reset",
+ "name": "Reset",
+ "description": "Indexer has been reset."
+ }
+ ]
},
"x-nullable": false,
"description": "Represents the status of an individual indexer execution."
},
- "IndexerExecutionInfo": {
+ "SearchIndexerStatus": {
"properties": {
"status": {
"$ref": "#/definitions/IndexerStatus",
@@ -4867,7 +6126,7 @@
"description": "History of the recent indexer executions, sorted in reverse chronological order."
},
"limits": {
- "$ref": "#/definitions/IndexerLimits",
+ "$ref": "#/definitions/SearchIndexerLimits",
"readOnly": true,
"description": "The execution limits for the indexer."
}
@@ -4888,12 +6147,29 @@
],
"x-ms-enum": {
"name": "IndexerStatus",
- "modelAsString": false
+ "modelAsString": false,
+ "values": [
+ {
+ "value": "unknown",
+ "name": "Unknown",
+ "description": "Indicates that the indexer is in an unknown state."
+ },
+ {
+ "value": "error",
+ "name": "Error",
+ "description": "Indicates that the indexer experienced an error that cannot be corrected without human intervention."
+ },
+ {
+ "value": "running",
+ "name": "Running",
+ "description": "Indicates that the indexer is running normally."
+ }
+ ]
},
"x-nullable": false,
"description": "Represents the overall indexer status."
},
- "IndexerLimits": {
+ "SearchIndexerLimits": {
"properties": {
"maxRunTime": {
"type": "string",
@@ -4915,7 +6191,7 @@
}
}
},
- "Field": {
+ "SearchField": {
"properties": {
"name": {
"type": "string",
@@ -4925,7 +6201,7 @@
}
},
"type": {
- "$ref": "#/definitions/DataType",
+ "$ref": "#/definitions/SearchFieldDataType",
"description": "The data type of the field.",
"externalDocs": {
"url": "https://docs.microsoft.com/rest/api/searchservice/supported-data-types"
@@ -4959,21 +6235,21 @@
"externalDocs": {
"url": "https://docs.microsoft.com/rest/api/searchservice/Language-support"
},
- "$ref": "#/definitions/AnalyzerName",
+ "$ref": "#/definitions/LexicalAnalyzerName",
"description": "The name of the analyzer to use for the field. This option can be used only with searchable fields and it can't be set together with either searchAnalyzer or indexAnalyzer. Once the analyzer is chosen, it cannot be changed for the field. Must be null for complex fields."
},
"searchAnalyzer": {
"externalDocs": {
"url": "https://docs.microsoft.com/rest/api/searchservice/Language-support"
},
- "$ref": "#/definitions/AnalyzerName",
+ "$ref": "#/definitions/LexicalAnalyzerName",
"description": "The name of the analyzer used at search time for the field. This option can be used only with searchable fields. It must be set together with indexAnalyzer and it cannot be set together with the analyzer option. This property cannot be set to the name of a language analyzer; use the analyzer property instead if you need a language analyzer. This analyzer can be updated on an existing field. Must be null for complex fields."
},
"indexAnalyzer": {
"externalDocs": {
"url": "https://docs.microsoft.com/rest/api/searchservice/Language-support"
},
- "$ref": "#/definitions/AnalyzerName",
+ "$ref": "#/definitions/LexicalAnalyzerName",
"description": "The name of the analyzer used at indexing time for the field. This option can be used only with searchable fields. It must be set together with searchAnalyzer and it cannot be set together with the analyzer option. This property cannot be set to the name of a language analyzer; use the analyzer property instead if you need a language analyzer. Once the analyzer is chosen, it cannot be changed for the field. Must be null for complex fields."
},
"synonymMaps": {
@@ -4989,7 +6265,7 @@
"fields": {
"type": "array",
"items": {
- "$ref": "#/definitions/Field"
+ "$ref": "#/definitions/SearchField"
},
"description": "A list of sub-fields if this is a field of type Edm.ComplexType or Collection(Edm.ComplexType). Must be null or empty for simple fields."
}
@@ -5216,7 +6492,29 @@
],
"x-ms-enum": {
"name": "ScoringFunctionInterpolation",
- "modelAsString": false
+ "modelAsString": false,
+ "values": [
+ {
+ "value": "linear",
+ "name": "Linear",
+ "description": "Boosts scores by a linearly decreasing amount. This is the default interpolation for scoring functions."
+ },
+ {
+ "value": "constant",
+ "name": "Constant",
+ "description": "Boosts scores by a constant factor."
+ },
+ {
+ "value": "quadratic",
+ "name": "Quadratic",
+ "description": "Boosts scores by an amount that decreases quadratically. Boosts decrease slowly for higher scores, and more quickly as the scores decrease. This interpolation option is not allowed in tag scoring functions."
+ },
+ {
+ "value": "logarithmic",
+ "name": "Logarithmic",
+ "description": "Boosts scores by an amount that decreases logarithmically. Boosts decrease quickly for higher scores, and more slowly as the scores decrease. This interpolation option is not allowed in tag scoring functions."
+ }
+ ]
},
"description": "Defines the function used to interpolate score boosting across a range of documents."
},
@@ -5265,7 +6563,34 @@
],
"x-ms-enum": {
"name": "ScoringFunctionAggregation",
- "modelAsString": false
+ "modelAsString": false,
+ "values": [
+ {
+ "value": "sum",
+ "name": "Sum",
+ "description": "Boost scores by the sum of all scoring function results."
+ },
+ {
+ "value": "average",
+ "name": "Average",
+ "description": "Boost scores by the average of all scoring function results."
+ },
+ {
+ "value": "minimum",
+ "name": "Minimum",
+ "description": "Boost scores by the minimum of all scoring function results."
+ },
+ {
+ "value": "maximum",
+ "name": "Maximum",
+ "description": "Boost scores by the maximum of all scoring function results."
+ },
+ {
+ "value": "firstMatching",
+ "name": "FirstMatching",
+ "description": "Boost scores using the first applicable scoring function in the scoring profile."
+ }
+ ]
},
"description": "Defines the aggregation function used to combine the results of all the scoring functions in a scoring profile."
},
@@ -5304,8 +6629,15 @@
"analyzingInfixMatching"
],
"x-ms-enum": {
- "name": "searchMode",
- "modelAsString": false
+ "name": "SuggesterSearchMode",
+ "modelAsString": false,
+ "values": [
+ {
+ "value": "analyzingInfixMatching",
+ "name": "AnalyzingInfixMatching",
+ "description": "Matches consecutive whole terms and prefixes in a field. For example, for the field 'The fastest brown fox', the queries 'fast' and 'fastest brow' would both match."
+ }
+ ]
},
"description": "A value indicating the capabilities of the suggester."
},
@@ -5324,7 +6656,7 @@
],
"description": "Defines how the Suggest API should apply to a group of fields in the index."
},
- "Index": {
+ "SearchIndex": {
"properties": {
"name": {
"externalDocs": {
@@ -5336,7 +6668,7 @@
"fields": {
"type": "array",
"items": {
- "$ref": "#/definitions/Field"
+ "$ref": "#/definitions/SearchField"
},
"description": "The fields of the index."
},
@@ -5365,7 +6697,7 @@
"analyzers": {
"type": "array",
"items": {
- "$ref": "#/definitions/Analyzer"
+ "$ref": "#/definitions/LexicalAnalyzer"
},
"description": "The analyzers for the index.",
"externalDocs": {
@@ -5375,7 +6707,7 @@
"tokenizers": {
"type": "array",
"items": {
- "$ref": "#/definitions/Tokenizer"
+ "$ref": "#/definitions/LexicalTokenizer"
},
"description": "The tokenizers for the index.",
"externalDocs": {
@@ -5403,12 +6735,19 @@
}
},
"encryptionKey": {
- "$ref": "#/definitions/EncryptionKey",
+ "$ref": "#/definitions/SearchResourceEncryptionKey",
"description": "A description of an encryption key that you create in Azure Key Vault. This key is used to provide an additional level of encryption-at-rest for your data when you want full assurance that no one, not even Microsoft, can decrypt your data in Azure Cognitive Search. Once you have encrypted your data, it will always remain encrypted. Azure Cognitive Search will ignore attempts to set this property to null. You can change this property as needed if you want to rotate your encryption key; Your data will be unaffected. Encryption with customer-managed keys is not available for free search services, and is only available for paid services created on or after January 1, 2019.",
"externalDocs": {
"url": "https://aka.ms/azure-search-encryption-with-cmk"
}
},
+ "similarity": {
+ "$ref": "#/definitions/Similarity",
+ "description": "The type of similarity algorithm to be used when scoring and ranking the documents matching a search query. The similarity algorithm can only be defined at index creation time and cannot be modified on existing indexes. If null, the ClassicSimilarity algorithm is used.",
+ "externalDocs": {
+ "url": "https://docs.microsoft.com/azure/search/index-ranking-similarity"
+ }
+ },
"@odata.etag": {
"x-ms-client-name": "ETag",
"type": "string",
@@ -5451,7 +6790,7 @@
"type": "array",
"readOnly": true,
"items": {
- "$ref": "#/definitions/Index"
+ "$ref": "#/definitions/SearchIndex"
},
"description": "The indexes in the Search service."
}
@@ -5461,7 +6800,7 @@
],
"description": "Response from a List Indexes request. If successful, it includes the full definitions of all indexes."
},
- "Skillset": {
+ "SearchIndexerSkillset": {
"properties": {
"name": {
"type": "string",
@@ -5474,7 +6813,7 @@
"skills": {
"type": "array",
"items": {
- "$ref": "#/definitions/Skill"
+ "$ref": "#/definitions/SearchIndexerSkill"
},
"description": "A list of skills in the skillset."
},
@@ -5491,7 +6830,6 @@
},
"required": [
"name",
- "description",
"skills"
],
"externalDocs": {
@@ -5543,7 +6881,7 @@
"key"
]
},
- "Skill": {
+ "SearchIndexerSkill": {
"discriminator": "@odata.type",
"properties": {
"@odata.type": {
@@ -5637,7 +6975,7 @@
"x-ms-discriminator-value": "#Microsoft.Skills.Util.ConditionalSkill",
"allOf": [
{
- "$ref": "#/definitions/Skill"
+ "$ref": "#/definitions/SearchIndexerSkill"
}
],
"externalDocs": {
@@ -5649,7 +6987,7 @@
"x-ms-discriminator-value": "#Microsoft.Skills.Text.KeyPhraseExtractionSkill",
"allOf": [
{
- "$ref": "#/definitions/Skill"
+ "$ref": "#/definitions/SearchIndexerSkill"
}
],
"properties": {
@@ -5673,14 +7011,10 @@
"x-ms-discriminator-value": "#Microsoft.Skills.Vision.OcrSkill",
"allOf": [
{
- "$ref": "#/definitions/Skill"
+ "$ref": "#/definitions/SearchIndexerSkill"
}
],
"properties": {
- "textExtractionAlgorithm": {
- "$ref": "#/definitions/TextExtractionAlgorithm",
- "description": "A value indicating which algorithm to use for extracting text. Default is printed."
- },
"defaultLanguageCode": {
"$ref": "#/definitions/OcrSkillLanguage",
"description": "A value indicating which language code to use. Default is en."
@@ -5701,7 +7035,7 @@
"x-ms-discriminator-value": "#Microsoft.Skills.Vision.ImageAnalysisSkill",
"allOf": [
{
- "$ref": "#/definitions/Skill"
+ "$ref": "#/definitions/SearchIndexerSkill"
}
],
"properties": {
@@ -5735,7 +7069,7 @@
"x-ms-discriminator-value": "#Microsoft.Skills.Text.LanguageDetectionSkill",
"allOf": [
{
- "$ref": "#/definitions/Skill"
+ "$ref": "#/definitions/SearchIndexerSkill"
}
],
"externalDocs": {
@@ -5747,7 +7081,7 @@
"x-ms-discriminator-value": "#Microsoft.Skills.Util.ShaperSkill",
"allOf": [
{
- "$ref": "#/definitions/Skill"
+ "$ref": "#/definitions/SearchIndexerSkill"
}
],
"externalDocs": {
@@ -5759,7 +7093,7 @@
"x-ms-discriminator-value": "#Microsoft.Skills.Text.MergeSkill",
"allOf": [
{
- "$ref": "#/definitions/Skill"
+ "$ref": "#/definitions/SearchIndexerSkill"
}
],
"properties": {
@@ -5783,7 +7117,7 @@
"x-ms-discriminator-value": "#Microsoft.Skills.Text.EntityRecognitionSkill",
"allOf": [
{
- "$ref": "#/definitions/Skill"
+ "$ref": "#/definitions/SearchIndexerSkill"
}
],
"properties": {
@@ -5820,7 +7154,7 @@
"x-ms-discriminator-value": "#Microsoft.Skills.Text.SentimentSkill",
"allOf": [
{
- "$ref": "#/definitions/Skill"
+ "$ref": "#/definitions/SearchIndexerSkill"
}
],
"properties": {
@@ -5838,7 +7172,7 @@
"x-ms-discriminator-value": "#Microsoft.Skills.Text.SplitSkill",
"allOf": [
{
- "$ref": "#/definitions/Skill"
+ "$ref": "#/definitions/SearchIndexerSkill"
}
],
"properties": {
@@ -5867,7 +7201,7 @@
"x-ms-discriminator-value": "#Microsoft.Skills.Text.TranslationSkill",
"allOf": [
{
- "$ref": "#/definitions/Skill"
+ "$ref": "#/definitions/SearchIndexerSkill"
}
],
"properties": {
@@ -5896,7 +7230,7 @@
"x-ms-discriminator-value": "#Microsoft.Skills.Custom.WebApiSkill",
"allOf": [
{
- "$ref": "#/definitions/Skill"
+ "$ref": "#/definitions/SearchIndexerSkill"
}
],
"properties": {
@@ -5952,7 +7286,7 @@
"type": "array",
"readOnly": true,
"items": {
- "$ref": "#/definitions/Skillset"
+ "$ref": "#/definitions/SearchIndexerSkillset"
},
"description": "The skillsets defined in the Search service."
}
@@ -5960,19 +7294,7 @@
"required": [
"value"
],
- "description": "Response from a list Skillset request. If successful, it includes the full definitions of all skillsets."
- },
- "TextExtractionAlgorithm": {
- "type": "string",
- "enum": [
- "printed",
- "handwritten"
- ],
- "x-ms-enum": {
- "name": "TextExtractionAlgorithm",
- "modelAsString": false
- },
- "description": "A value indicating which algorithm to use. Default is printed."
+ "description": "Response from a list skillset request. If successful, it includes the full definitions of all skillsets."
},
"TextSplitMode": {
"type": "string",
@@ -5982,7 +7304,19 @@
],
"x-ms-enum": {
"name": "TextSplitMode",
- "modelAsString": false
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "pages",
+ "name": "Pages",
+ "description": "Split the text into individual pages."
+ },
+ {
+ "value": "sentences",
+ "name": "Sentences",
+ "description": "Split the text into individual sentences."
+ }
+ ]
},
"description": "A value indicating which split mode to perform."
},
@@ -5999,7 +7333,44 @@
],
"x-ms-enum": {
"name": "VisualFeature",
- "modelAsString": false
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "adult",
+ "name": "Adult",
+ "description": "Visual features recognized as adult persons."
+ },
+ {
+ "value": "brands",
+ "name": "Brands",
+ "description": "Visual features recognized as commercial brands."
+ },
+ {
+ "value": "categories",
+ "name": "Categories",
+ "description": "Categories."
+ },
+ {
+ "value": "description",
+ "name": "Description",
+ "description": "Description."
+ },
+ {
+ "value": "faces",
+ "name": "Faces",
+ "description": "Visual features recognized as people faces."
+ },
+ {
+ "value": "objects",
+ "name": "Objects",
+ "description": "Visual features recognized as objects."
+ },
+ {
+ "value": "tags",
+ "name": "Tags",
+ "description": "Tags."
+ }
+ ]
},
"description": "The strings indicating what visual feature types to return."
},
@@ -6011,7 +7382,19 @@
],
"x-ms-enum": {
"name": "ImageDetail",
- "modelAsString": false
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "celebrities",
+ "name": "Celebrities",
+ "description": "Details recognized as celebrities."
+ },
+ {
+ "value": "landmarks",
+ "name": "Landmarks",
+ "description": "Details recognized as landmarks."
+ }
+ ]
},
"description": "A string indicating which domain-specific details to return."
},
@@ -6028,7 +7411,44 @@
],
"x-ms-enum": {
"name": "EntityCategory",
- "modelAsString": false
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "location",
+ "name": "Location",
+ "description": "Entities describing a physical location."
+ },
+ {
+ "value": "organization",
+ "name": "Organization",
+ "description": "Entities describing an organization."
+ },
+ {
+ "value": "person",
+ "name": "Person",
+ "description": "Entities describing a person."
+ },
+ {
+ "value": "quantity",
+ "name": "Quantity",
+ "description": "Entities describing a quantity."
+ },
+ {
+ "value": "datetime",
+ "name": "Datetime",
+ "description": "Entities describing a date and time."
+ },
+ {
+ "value": "url",
+ "name": "Url",
+ "description": "Entities describing a URL."
+ },
+ {
+ "value": "email",
+ "name": "Email",
+ "description": "Entities describing an email address."
+ }
+ ]
},
"description": "A string indicating what entity categories to return."
},
@@ -6917,7 +8337,14 @@
],
"x-ms-enum": {
"name": "SynonymMapFormat",
- "modelAsString": false
+ "modelAsString": false,
+ "values": [
+ {
+ "value": "solr",
+ "name": "Solr",
+ "description": "Selects the SOLR format for synonym maps."
+ }
+ ]
},
"description": "The format of the synonym map. Only the 'solr' format is currently supported."
},
@@ -6929,7 +8356,7 @@
}
},
"encryptionKey": {
- "$ref": "#/definitions/EncryptionKey",
+ "$ref": "#/definitions/SearchResourceEncryptionKey",
"description": "A description of an encryption key that you create in Azure Key Vault. This key is used to provide an additional level of encryption-at-rest for your data when you want full assurance that no one, not even Microsoft, can decrypt your data in Azure Cognitive Search. Once you have encrypted your data, it will always remain encrypted. Azure Cognitive Search will ignore attempts to set this property to null. You can change this property as needed if you want to rotate your encryption key; Your data will be unaffected. Encryption with customer-managed keys is not available for free search services, and is only available for paid services created on or after January 1, 2019.",
"externalDocs": {
"url": "https://aka.ms/azure-search-encryption-with-cmk"
@@ -6965,17 +8392,20 @@
],
"description": "Response from a List SynonymMaps request. If successful, it includes the full definitions of all synonym maps."
},
- "EncryptionKey": {
+ "SearchResourceEncryptionKey": {
"properties": {
"keyVaultKeyName": {
+ "x-ms-client-name": "keyName",
"type": "string",
"description": "The name of your Azure Key Vault key to be used to encrypt your data at rest."
},
"keyVaultKeyVersion": {
+ "x-ms-client-name": "keyVersion",
"type": "string",
"description": "The version of your Azure Key Vault key to be used to encrypt your data at rest."
},
"keyVaultUri": {
+ "x-ms-client-name": "vaultUri",
"type": "string",
"description": "The URI of your Azure Key Vault, also referred to as DNS name, that contains the key to be used to encrypt your data at rest. An example URI might be https://my-keyvault-name.vault.azure.net."
},
@@ -7179,9 +8609,6 @@
"required": false,
"type": "string",
"description": "Defines the If-Match condition. The operation will be performed only if the ETag on the server matches this value.",
- "x-ms-parameter-grouping": {
- "name": "access-condition"
- },
"x-ms-parameter-location": "method"
},
"IfNoneMatchParameter": {
@@ -7190,9 +8617,6 @@
"required": false,
"type": "string",
"description": "Defines the If-None-Match condition. The operation will be performed only if the ETag on the server does not match this value.",
- "x-ms-parameter-grouping": {
- "name": "access-condition"
- },
"x-ms-parameter-location": "method"
},
"PreferHeaderParameter": {
diff --git a/specification/search/data-plane/Microsoft.Azure.Search.Data/preview/2019-05-06-preview/examples/SearchIndexSearchDocumentsGet.json b/specification/search/data-plane/Microsoft.Azure.Search.Data/preview/2019-05-06-preview/examples/SearchIndexSearchDocumentsGet.json
index d3eff019e3ac..e28054126c8e 100644
--- a/specification/search/data-plane/Microsoft.Azure.Search.Data/preview/2019-05-06-preview/examples/SearchIndexSearchDocumentsGet.json
+++ b/specification/search/data-plane/Microsoft.Azure.Search.Data/preview/2019-05-06-preview/examples/SearchIndexSearchDocumentsGet.json
@@ -21,7 +21,6 @@
],
"queryType": "simple",
"sessionId": "mysessionid",
- "featuresMode": "enabled",
"scoringStatistics": "global",
"scoringParameters": [
"currentLocation--122.123,44.77233"
@@ -77,16 +76,6 @@
"Fancy Hotel"
]
},
- "@search.features": {
- "description": {
- "uniqueTokenMatches": 1.0,
- "similarityScore": 0.023745812
- },
- "title": {
- "uniqueTokenMatches": 1.0,
- "similarityScore": 0.016049799
- }
- },
"description": "Best hotel in town",
"docId": "2",
"title": "Fancy Hotel"
diff --git a/specification/search/data-plane/Microsoft.Azure.Search.Data/preview/2019-05-06-preview/examples/SearchIndexSearchDocumentsPost.json b/specification/search/data-plane/Microsoft.Azure.Search.Data/preview/2019-05-06-preview/examples/SearchIndexSearchDocumentsPost.json
index c95e8c51acd2..b834f10417f1 100644
--- a/specification/search/data-plane/Microsoft.Azure.Search.Data/preview/2019-05-06-preview/examples/SearchIndexSearchDocumentsPost.json
+++ b/specification/search/data-plane/Microsoft.Azure.Search.Data/preview/2019-05-06-preview/examples/SearchIndexSearchDocumentsPost.json
@@ -24,7 +24,6 @@
"searchFields": "title,description",
"searchMode": "any",
"sessionId": "mysessionid",
- "featuresMode": "enabled",
"scoringStatistics": "global",
"select": "docId,title,description",
"skip": 0,
@@ -60,7 +59,6 @@
"orderby": "search.score() desc,rating desc",
"queryType": "simple",
"sessionId": "mysessionid",
- "featuresMode": "enabled",
"scoringStatistics": "global",
"scoringParameters": [
"currentLocation--122.123,44.77233"
@@ -92,16 +90,6 @@
"Fancy Hotel"
]
},
- "@search.features": {
- "description": {
- "uniqueTokenMatches": 1.0,
- "similarityScore": 0.023745812
- },
- "title": {
- "uniqueTokenMatches": 1.0,
- "similarityScore": 0.016049799
- }
- },
"description": "Best hotel in town",
"docId": "2",
"title": "Fancy Hotel"
diff --git a/specification/search/data-plane/Microsoft.Azure.Search.Data/preview/2019-05-06-preview/searchindex.json b/specification/search/data-plane/Microsoft.Azure.Search.Data/preview/2019-05-06-preview/searchindex.json
index 073df28cd754..e785feeed67d 100644
--- a/specification/search/data-plane/Microsoft.Azure.Search.Data/preview/2019-05-06-preview/searchindex.json
+++ b/specification/search/data-plane/Microsoft.Azure.Search.Data/preview/2019-05-06-preview/searchindex.json
@@ -248,24 +248,6 @@
"name": "SearchParameters"
}
},
- {
- "name": "featuresMode",
- "in": "query",
- "type": "string",
- "enum": [
- "disabled",
- "enabled"
- ],
- "x-ms-enum": {
- "name": "FeaturesMode",
- "modelAsString": false
- },
- "x-nullable": false,
- "description": "A value that specifies whether the results should include scoring features such as per field similarity.",
- "x-ms-parameter-grouping": {
- "name": "SearchParameters"
- }
- },
{
"name": "scoringStatistics",
"in": "query",
@@ -902,27 +884,6 @@
"additionalProperties": true,
"description": "A single bucket of a facet query result. Reports the number of documents with a field value falling within a particular range or having a particular value or interval."
},
- "SearchFeatures": {
- "properties": {
- "uniqueTokenMatches": {
- "type": "number",
- "readOnly": true,
- "format": "double",
- "description": "The number of unique tokens from the search query that matched this field."
- },
- "similarityScore": {
- "type": "number",
- "readOnly": true,
- "format": "double",
- "description": "The similarity score computed between the search query and this field."
- }
- },
- "required": [
- "uniqueTokenMatches",
- "similarityScore"
- ],
- "description": "A list of features describing the scoring of a specific field against the search query."
- },
"DocumentSearchResult": {
"properties": {
"@odata.count": {
@@ -996,15 +957,6 @@
"readOnly": true,
"x-ms-client-name": "Highlights",
"description": "Text fragments from the document that indicate the matching search terms, organized by each applicable field; null if hit highlighting was not enabled for the query."
- },
- "@search.features": {
- "type": "object",
- "additionalProperties": {
- "$ref": "#/definitions/SearchFeatures"
- },
- "readOnly": true,
- "x-ms-client-name": "Features",
- "description": "description for the feature"
}
},
"additionalProperties": true,
@@ -1114,18 +1066,6 @@
},
"description": "Specifies the syntax of the search query. The default is 'simple'. Use 'full' if your query uses the Lucene query syntax."
},
- "FeaturesMode": {
- "type": "string",
- "enum": [
- "disabled",
- "enabled"
- ],
- "x-ms-enum": {
- "name": "FeaturesMode",
- "modelAsString": false
- },
- "description": "A value that specifies whether the results should include scoring features, such as per field similarity. The default is 'disabled'. Use 'enabled' to expose additional scoring features."
- },
"ScoringStatistics": {
"type": "string",
"enum": [
@@ -1202,10 +1142,6 @@
"$ref": "#/definitions/QueryType",
"description": "A value that specifies the syntax of the search query. The default is 'simple'. Use 'full' if your query uses the Lucene query syntax."
},
- "featuresMode": {
- "$ref": "#/definitions/FeaturesMode",
- "description": "A value that specifies whether the results should include scoring features, such as per field similarity. The default is 'disabled'. Use 'enabled' to expose additional scoring features."
- },
"scoringStatistics": {
"$ref": "#/definitions/ScoringStatistics",
"description": "A value that specifies whether we want to calculate scoring statistics (such as document frequency) globally for more consistent scoring, or locally, for lower latency. The default is 'local'. Use 'global' to aggregate scoring statistics globally before scoring. Using global scoring statistics can increase latency of search queries."
diff --git a/specification/search/resource-manager/Microsoft.Search/preview/2019-10-01-preview/examples/ListSupportedPrivateLinkResources.json b/specification/search/resource-manager/Microsoft.Search/preview/2019-10-01-preview/examples/ListSupportedPrivateLinkResources.json
index a46985ecf05c..ffb6908fc3c2 100644
--- a/specification/search/resource-manager/Microsoft.Search/preview/2019-10-01-preview/examples/ListSupportedPrivateLinkResources.json
+++ b/specification/search/resource-manager/Microsoft.Search/preview/2019-10-01-preview/examples/ListSupportedPrivateLinkResources.json
@@ -62,30 +62,6 @@
"description": "Azure Cognitive Search can access keys in Azure Key Vault to encrypt search index and synonym map data"
}
},
- {
- "name": "MongoDB",
- "properties": {
- "type": "Microsoft.DocumentDB/databaseAccounts",
- "groupId": "MongoDB",
- "description": "Azure Cognitive Search indexers can connect to CosmosDB using the MongoDB head for reading data (data source, preview)."
- }
- },
- {
- "name": "Cassandra",
- "properties": {
- "type": "Microsoft.DocumentDB/databaseAccounts",
- "groupId": "Cassandra",
- "description": "Azure Cognitive Search indexers can connect to CosmosDB using the Cassandra head for reading data (data source, preview)."
- }
- },
- {
- "name": "Gremlin",
- "properties": {
- "type": "Microsoft.DocumentDB/databaseAccounts",
- "groupId": "Gremlin",
- "description": "Azure Cognitive Search indexers can connect to CosmosDB using the Gremlin head for reading data (data source, preview)."
- }
- },
{
"name": "plr",
"properties": {
diff --git a/specification/search/resource-manager/Microsoft.Search/stable/2020-03-13/examples/CreateOrUpdateSharedPrivateLinkResource.json b/specification/search/resource-manager/Microsoft.Search/stable/2020-03-13/examples/CreateOrUpdateSharedPrivateLinkResource.json
index ef0592e7e14f..9a595ad24cd6 100644
--- a/specification/search/resource-manager/Microsoft.Search/stable/2020-03-13/examples/CreateOrUpdateSharedPrivateLinkResource.json
+++ b/specification/search/resource-manager/Microsoft.Search/stable/2020-03-13/examples/CreateOrUpdateSharedPrivateLinkResource.json
@@ -6,7 +6,6 @@
"subscriptionId": "subid",
"sharedPrivateLinkResourceName": "testResource",
"sharedPrivateLinkResource": {
- "name": "testResource",
"properties": {
"requestMessage": "please approve",
"groupId": "blob",
diff --git a/specification/search/resource-manager/Microsoft.Search/stable/2020-03-13/examples/SearchCreateOrUpdateServiceToAllowAccessFromPrivateEndpoints.json b/specification/search/resource-manager/Microsoft.Search/stable/2020-03-13/examples/SearchCreateOrUpdateServiceToAllowAccessFromPrivateEndpoints.json
new file mode 100644
index 000000000000..c0c46c253951
--- /dev/null
+++ b/specification/search/resource-manager/Microsoft.Search/stable/2020-03-13/examples/SearchCreateOrUpdateServiceToAllowAccessFromPrivateEndpoints.json
@@ -0,0 +1,81 @@
+{
+ "parameters": {
+ "searchServiceName": "mysearchservice",
+ "resourceGroupName": "rg1",
+ "api-version": "2020-03-13",
+ "subscriptionId": "subid",
+ "service": {
+ "location": "westus",
+ "tags": {
+ "app-name": "My e-commerce app"
+ },
+ "sku": {
+ "name": "standard"
+ },
+ "properties": {
+ "replicaCount": 3,
+ "partitionCount": 1,
+ "publicNetworkAccess": "disabled",
+ "hostingMode": "default"
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice",
+ "name": "mysearchservice",
+ "location": "westus",
+ "type": "Microsoft.Search/searchServices",
+ "tags": {
+ "app-name": "My e-commerce app"
+ },
+ "sku": {
+ "name": "standard"
+ },
+ "properties": {
+ "replicaCount": 3,
+ "partitionCount": 1,
+ "status": "provisioning",
+ "statusDetails": "",
+ "hostingMode": "default",
+ "provisioningState": "provisioning",
+ "publicNetworkAccess": "disabled",
+ "networkRuleSet": {
+ "ipRules": []
+ },
+ "privateEndpointConnections": [],
+ "sharedPrivateLinkResources": []
+ }
+ }
+ },
+ "201": {
+ "body": {
+ "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice",
+ "name": "mysearchservice",
+ "location": "westus",
+ "type": "Microsoft.Search/searchServices",
+ "tags": {
+ "app-name": "My e-commerce app"
+ },
+ "sku": {
+ "name": "standard"
+ },
+ "properties": {
+ "replicaCount": 3,
+ "partitionCount": 1,
+ "status": "provisioning",
+ "statusDetails": "",
+ "hostingMode": "default",
+ "provisioningState": "provisioning",
+ "publicNetworkAccess": "disabled",
+ "networkRuleSet": {
+ "ipRules": []
+ },
+ "privateEndpointConnections": [],
+ "sharedPrivateLinkResources": []
+ }
+ }
+ }
+ }
+}
diff --git a/specification/search/resource-manager/Microsoft.Search/stable/2020-03-13/examples/SearchCreateOrUpdateServiceToAllowAccessFromPublicCustomIPs.json b/specification/search/resource-manager/Microsoft.Search/stable/2020-03-13/examples/SearchCreateOrUpdateServiceToAllowAccessFromPublicCustomIPs.json
new file mode 100644
index 000000000000..04a1a93a0753
--- /dev/null
+++ b/specification/search/resource-manager/Microsoft.Search/stable/2020-03-13/examples/SearchCreateOrUpdateServiceToAllowAccessFromPublicCustomIPs.json
@@ -0,0 +1,104 @@
+{
+ "parameters": {
+ "searchServiceName": "mysearchservice",
+ "resourceGroupName": "rg1",
+ "api-version": "2020-03-13",
+ "subscriptionId": "subid",
+ "service": {
+ "location": "westus",
+ "tags": {
+ "app-name": "My e-commerce app"
+ },
+ "sku": {
+ "name": "standard"
+ },
+ "properties": {
+ "replicaCount": 1,
+ "partitionCount": 1,
+ "networkRuleSet": {
+ "ipRules": [
+ {
+ "value": "123.4.5.6"
+ },
+ {
+ "value": "123.4.6.0/18"
+ }
+ ]
+ },
+ "hostingMode": "default"
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice",
+ "name": "mysearchservice",
+ "location": "westus",
+ "type": "Microsoft.Search/searchServices",
+ "tags": {
+ "app-name": "My e-commerce app"
+ },
+ "sku": {
+ "name": "standard"
+ },
+ "properties": {
+ "replicaCount": 1,
+ "partitionCount": 1,
+ "status": "provisioning",
+ "statusDetails": "",
+ "hostingMode": "default",
+ "provisioningState": "provisioning",
+ "publicNetworkAccess": "enabled",
+ "networkRuleSet": {
+ "ipRules": [
+ {
+ "value": "123.4.5.6"
+ },
+ {
+ "value": "123.4.6.0/18"
+ }
+ ]
+ },
+ "privateEndpointConnections": [],
+ "sharedPrivateLinkResources": []
+ }
+ }
+ },
+ "201": {
+ "body": {
+ "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice",
+ "name": "mysearchservice",
+ "location": "westus",
+ "type": "Microsoft.Search/searchServices",
+ "tags": {
+ "app-name": "My e-commerce app"
+ },
+ "sku": {
+ "name": "standard"
+ },
+ "properties": {
+ "replicaCount": 1,
+ "partitionCount": 1,
+ "status": "provisioning",
+ "statusDetails": "",
+ "hostingMode": "default",
+ "provisioningState": "provisioning",
+ "publicNetworkAccess": "enabled",
+ "networkRuleSet": {
+ "ipRules": [
+ {
+ "value": "123.4.5.6"
+ },
+ {
+ "value": "123.4.6.0/18"
+ }
+ ]
+ },
+ "privateEndpointConnections": [],
+ "sharedPrivateLinkResources": []
+ }
+ }
+ }
+ }
+}
diff --git a/specification/search/resource-manager/Microsoft.Search/stable/2020-03-13/examples/SearchUpdateServiceToAllowAccessFromPrivateEndpoints.json b/specification/search/resource-manager/Microsoft.Search/stable/2020-03-13/examples/SearchUpdateServiceToAllowAccessFromPrivateEndpoints.json
index 9ca6ab6cb3c4..cb73c5c6854a 100644
--- a/specification/search/resource-manager/Microsoft.Search/stable/2020-03-13/examples/SearchUpdateServiceToAllowAccessFromPrivateEndpoints.json
+++ b/specification/search/resource-manager/Microsoft.Search/stable/2020-03-13/examples/SearchUpdateServiceToAllowAccessFromPrivateEndpoints.json
@@ -8,9 +8,7 @@
"properties": {
"replicaCount": 1,
"partitionCount": 1,
- "networkRuleSet": {
- "ipRules": []
- }
+ "publicNetworkAccess": "disabled"
}
}
},
@@ -35,7 +33,7 @@
"statusDetails": "",
"hostingMode": "default",
"provisioningState": "succeeded",
- "publicNetworkAccess": "enabled",
+ "publicNetworkAccess": "disabled",
"networkRuleSet": {
"ipRules": []
},
diff --git a/specification/search/resource-manager/Microsoft.Search/stable/2020-03-13/examples/SearchUpdateServiceToAllowAccessFromCustomIPs.json b/specification/search/resource-manager/Microsoft.Search/stable/2020-03-13/examples/SearchUpdateServiceToAllowAccessFromPublicCustomIPs.json
similarity index 90%
rename from specification/search/resource-manager/Microsoft.Search/stable/2020-03-13/examples/SearchUpdateServiceToAllowAccessFromCustomIPs.json
rename to specification/search/resource-manager/Microsoft.Search/stable/2020-03-13/examples/SearchUpdateServiceToAllowAccessFromPublicCustomIPs.json
index 82fb1e0c8d88..2220cb66433a 100644
--- a/specification/search/resource-manager/Microsoft.Search/stable/2020-03-13/examples/SearchUpdateServiceToAllowAccessFromCustomIPs.json
+++ b/specification/search/resource-manager/Microsoft.Search/stable/2020-03-13/examples/SearchUpdateServiceToAllowAccessFromPublicCustomIPs.json
@@ -8,10 +8,14 @@
"properties": {
"replicaCount": 3,
"partitionCount": 1,
+ "publicNetworkAccess": "enabled",
"networkRuleSet": {
"ipRules": [
{
- "value": "10.2.3.4"
+ "value": "123.4.5.6"
+ },
+ {
+ "value": "123.4.6.0/18"
}
]
}
diff --git a/specification/search/resource-manager/Microsoft.Search/stable/2020-03-13/examples/UpdatePrivateEndpointConnection.json b/specification/search/resource-manager/Microsoft.Search/stable/2020-03-13/examples/UpdatePrivateEndpointConnection.json
index 00290d4e4d54..6aaee4ae003f 100644
--- a/specification/search/resource-manager/Microsoft.Search/stable/2020-03-13/examples/UpdatePrivateEndpointConnection.json
+++ b/specification/search/resource-manager/Microsoft.Search/stable/2020-03-13/examples/UpdatePrivateEndpointConnection.json
@@ -6,7 +6,6 @@
"subscriptionId": "subid",
"privateEndpointConnectionName": "testEndpoint.50bf4fbe-d7c1-4b48-a642-4f5892642546",
"privateEndpointConnection": {
- "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice/privateEndpointConnections/testEndpoint.50bf4fbe-d7c1-4b48-a642-4f5892642546",
"properties": {
"privateLinkServiceConnectionState": {
"status": "Rejected",
diff --git a/specification/search/resource-manager/Microsoft.Search/stable/2020-03-13/search.json b/specification/search/resource-manager/Microsoft.Search/stable/2020-03-13/search.json
index e96041380541..4fe1afbaa3af 100644
--- a/specification/search/resource-manager/Microsoft.Search/stable/2020-03-13/search.json
+++ b/specification/search/resource-manager/Microsoft.Search/stable/2020-03-13/search.json
@@ -344,6 +344,12 @@
"SearchCreateOrUpdateService": {
"$ref": "./examples/SearchCreateOrUpdateService.json"
},
+ "SearchCreateOrUpdateServiceToAllowAccessFromPublicCustomIPs": {
+ "$ref": "./examples/SearchCreateOrUpdateServiceToAllowAccessFromPublicCustomIPs.json"
+ },
+ "SearchCreateOrUpdateServiceToAllowAccessFromPrivateEndpoints": {
+ "$ref": "./examples/SearchCreateOrUpdateServiceToAllowAccessFromPrivateEndpoints.json"
+ },
"SearchCreateOrUpdateServiceWithIdentity": {
"$ref": "./examples/SearchCreateOrUpdateServiceWithIdentity.json"
}
@@ -416,8 +422,8 @@
"SearchUpdateServiceToRemoveIdentity": {
"$ref": "./examples/SearchUpdateServiceToRemoveIdentity.json"
},
- "searchUpdateServiceToAllowAccessFromCustomIPs": {
- "$ref": "./examples/SearchUpdateServiceToAllowAccessFromCustomIPs.json"
+ "searchUpdateServiceToAllowAccessFromPublicCustomIPs": {
+ "$ref": "./examples/SearchUpdateServiceToAllowAccessFromPublicCustomIPs.json"
},
"searchUpdateServiceToAllowAccessFromPrivateEndpoints": {
"$ref": "./examples/SearchUpdateServiceToAllowAccessFromPrivateEndpoints.json"
@@ -1287,6 +1293,11 @@
"$ref": "#/definitions/QueryKey"
},
"description": "The query keys for the Azure Cognitive Search service."
+ },
+ "nextLink": {
+ "readOnly": true,
+ "type": "string",
+ "description": "Request URL that can be used to query next page of query keys. Returned when the total number of requested query keys exceed maximum page size."
}
},
"description": "Response containing the query API keys for a given Azure Cognitive Search service.",
@@ -1318,8 +1329,10 @@
}
},
"PrivateEndpointConnection": {
+ "x-ms-azure-resource": true,
"properties": {
"id": {
+ "readOnly": true,
"type": "string",
"description": "The ID of the private endpoint connection. This can be used with the Azure Resource Manager to link resources together.",
"externalDocs": {
@@ -1350,7 +1363,7 @@
"properties": {
"ipRules": {
"type": "array",
- "description": "A list of IP restriction rules that defines the inbound network access to the search service endpoint. These restriction rules are applied only when the EndpointAccess of the search service is Public.",
+ "description": "A list of IP restriction rules that defines the inbound network(s) with allowing access to the search service endpoint. At the meantime, all other public IP networks are blocked by the firewall. These restriction rules are applied only when the 'publicNetworkAccess' of the search service is 'enabled'; otherwise, traffic over public interface is not allowed even with any public IP rules, and private endpoint connections would be the exclusive access method.",
"items": {
"$ref": "#/definitions/IpRule"
}
@@ -1419,20 +1432,37 @@
"$ref": "#/definitions/PrivateEndpointConnection"
},
"description": "The list of Private Endpoint connections."
+ },
+ "nextLink": {
+ "readOnly": true,
+ "type": "string",
+ "description": "Request URL that can be used to query next page of private endpoint connections. Returned when the total number of requested private endpoint connections exceed maximum page size."
}
},
"description": "Response containing a list of Private Endpoint connections.",
"x-ms-external": true
},
"SharedPrivateLinkResource": {
+ "x-ms-azure-resource": true,
"properties": {
"name": {
+ "readOnly": true,
"type": "string",
"description": "The name of the shared private link resource.",
"externalDocs": {
"url": "https://aka.ms/search-naming-rules"
}
},
+ "id": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The ID of the shared private link resource."
+ },
+ "type": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The resource type."
+ },
"properties": {
"$ref": "#/definitions/SharedPrivateLinkResourceProperties",
"description": "Describes the properties of a Shared Private Link Resource managed by the Azure Cognitive Search service."
@@ -1732,6 +1762,11 @@
"$ref": "#/definitions/SearchService"
},
"description": "The list of Search services."
+ },
+ "nextLink": {
+ "readOnly": true,
+ "type": "string",
+ "description": "Request URL that can be used to query next page of search services. Returned when the total number of requested search services exceed maximum page size."
}
},
"description": "Response containing a list of Azure Cognitive Search services.",
diff --git a/specification/search/resource-manager/readme.go.md b/specification/search/resource-manager/readme.go.md
index 6c95fee02859..0c4e0350036e 100644
--- a/specification/search/resource-manager/readme.go.md
+++ b/specification/search/resource-manager/readme.go.md
@@ -13,20 +13,10 @@ go:
``` yaml $(go) && $(multiapi)
batch:
- - tag: package-2020-03
- tag: package-2015-08
- tag: package-2015-02
```
-### 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-13/$(namespace)
-```
-
### Tag: package-2015-08 and go
These settings apply only when `--tag=package-2015-08 --go` is specified on the command line.
diff --git a/specification/search/resource-manager/readme.md b/specification/search/resource-manager/readme.md
index 2013e0992ec4..ea9072326d03 100644
--- a/specification/search/resource-manager/readme.md
+++ b/specification/search/resource-manager/readme.md
@@ -26,7 +26,7 @@ These are the global settings for the SearchManagementClient API.
``` yaml
openapi-type: arm
-tag: package-2015-08
+tag: package-2020-03
```
### Tag: package-2020-03
diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2019-01-01-preview/alertsSuppressionRules.json b/specification/security/resource-manager/Microsoft.Security/preview/2019-01-01-preview/alertsSuppressionRules.json
new file mode 100644
index 000000000000..87b002a47d20
--- /dev/null
+++ b/specification/security/resource-manager/Microsoft.Security/preview/2019-01-01-preview/alertsSuppressionRules.json
@@ -0,0 +1,337 @@
+{
+ "swagger": "2.0",
+ "info": {
+ "title": "Security Center",
+ "description": "API spec for Microsoft.Security (Azure Security Center) resource provider",
+ "version": "2019-01-01-preview"
+ },
+ "host": "management.azure.com",
+ "schemes": [
+ "https"
+ ],
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "security": [
+ {
+ "azure_auth": [
+ "user_impersonation"
+ ]
+ }
+ ],
+ "securityDefinitions": {
+ "azure_auth": {
+ "type": "oauth2",
+ "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize",
+ "flow": "implicit",
+ "description": "Azure Active Directory OAuth2 Flow",
+ "scopes": {
+ "user_impersonation": "impersonate your user account"
+ }
+ }
+ },
+ "paths": {
+ "/subscriptions/{subscriptionId}/providers/Microsoft.Security/alertsSuppressionRules": {
+ "get": {
+ "x-ms-examples": {
+ "Get suppression rules for subscription": {
+ "$ref": "./examples/AlertsSuppressionRules/GetAlertsSuppressionRules_example.json"
+ },
+ "Get suppression alert rule for subscription, filtered by AlertType": {
+ "$ref": "./examples/AlertsSuppressionRules/GetAlertsSuppressionRulesWithAlertType_example.json"
+ }
+ },
+ "tags": [
+ "AlertsSuppressionRules"
+ ],
+ "description": "List of all the dismiss rules for the given subscription",
+ "operationId": "AlertsSuppressionRules_List",
+ "parameters": [
+ {
+ "$ref": "../../../common/v1/types.json#/parameters/ApiVersion"
+ },
+ {
+ "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId"
+ },
+ {
+ "$ref": "#/parameters/AlertType"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/AlertsSuppressionRulesList"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common/v1/types.json#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/providers/Microsoft.Security/alertsSuppressionRules/{alertsSuppressionRuleName}": {
+ "get": {
+ "x-ms-examples": {
+ "Get suppression alert rule for subscription": {
+ "$ref": "./examples/AlertsSuppressionRules/GetAlertsSuppressionRule_example.json"
+ }
+ },
+ "tags": [
+ "AlertsSuppressionRules"
+ ],
+ "description": "Get dismiss rule, with name: {alertsSuppressionRuleName}, for the given subscription",
+ "operationId": "AlertsSuppressionRules_Get",
+ "parameters": [
+ {
+ "$ref": "../../../common/v1/types.json#/parameters/ApiVersion"
+ },
+ {
+ "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId"
+ },
+ {
+ "$ref": "#/parameters/AlertsSuppressionRuleName"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/AlertsSuppressionRule"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common/v1/types.json#/definitions/CloudError"
+ }
+ }
+ }
+ },
+ "put": {
+ "x-ms-examples": {
+ "Update or create suppression rule for subscription": {
+ "$ref": "./examples/AlertsSuppressionRules/PutAlertsSuppressionRule_example.json"
+ }
+ },
+ "tags": [
+ "AlertsSuppressionRules"
+ ],
+ "description": "Update existing rule or create new rule if it doesn't exist",
+ "operationId": "AlertsSuppressionRules_Update",
+ "parameters": [
+ {
+ "$ref": "../../../common/v1/types.json#/parameters/ApiVersion"
+ },
+ {
+ "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId"
+ },
+ {
+ "$ref": "#/parameters/AlertsSuppressionRuleName"
+ },
+ {
+ "$ref": "#/parameters/AlertsSuppressionRule"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/AlertsSuppressionRule"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common/v1/types.json#/definitions/CloudError"
+ }
+ }
+ }
+ },
+ "delete": {
+ "x-ms-examples": {
+ "Delete suppression rule data for a subscription": {
+ "$ref": "./examples/AlertsSuppressionRules/DeleteAlertsSuppressionRule_example.json"
+ }
+ },
+ "tags": [
+ "AlertsSuppressionRules"
+ ],
+ "description": "Delete dismiss alert rule for this subscription.",
+ "operationId": "AlertsSuppressionRules_Delete",
+ "parameters": [
+ {
+ "$ref": "../../../common/v1/types.json#/parameters/ApiVersion"
+ },
+ {
+ "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId"
+ },
+ {
+ "$ref": "#/parameters/AlertsSuppressionRuleName"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "OK, No Content"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common/v1/types.json#/definitions/CloudError"
+ }
+ }
+ }
+ }
+ }
+ },
+ "definitions": {
+ "AlertsSuppressionRulesList": {
+ "type": "object",
+ "description": "Suppression rules list for subscription.",
+ "properties": {
+ "value": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/AlertsSuppressionRule"
+ }
+ },
+ "nextLink": {
+ "readOnly": true,
+ "type": "string",
+ "description": "URI to fetch the next page."
+ }
+ },
+ "required": [
+ "value"
+ ]
+ },
+ "AlertsSuppressionRule": {
+ "type": "object",
+ "description": "Describes the suppression rule",
+ "properties": {
+ "properties": {
+ "x-ms-client-flatten": true,
+ "$ref": "#/definitions/AlertsSuppressionRuleProperties"
+ }
+ },
+ "allOf": [
+ {
+ "$ref": "../../../common/v1/types.json#/definitions/Resource"
+ }
+ ]
+ },
+ "AlertsSuppressionRuleProperties": {
+ "type": "object",
+ "description": "describes AlertsSuppressionRule properties",
+ "properties": {
+ "alertType": {
+ "type": "string",
+ "description": "Type of the alert to automatically suppress. For all alert types, use '*'"
+ },
+ "lastModifiedUtc": {
+ "readOnly": true,
+ "type": "string",
+ "format": "date-time",
+ "description": "The last time this rule was modified"
+ },
+ "expirationDateUtc": {
+ "type": "string",
+ "format": "date-time",
+ "description": "Expiration date of the rule, if value is not provided or provided as null this field will default to the maximum allowed expiration date."
+ },
+ "reason": {
+ "type": "string",
+ "description": "The reason for dismissing the alert"
+ },
+ "state": {
+ "type": "string",
+ "description": "Possible states of the rule",
+ "x-ms-enum": {
+ "name": "RuleState"
+ },
+ "enum": [
+ "Enabled",
+ "Disabled",
+ "Expired"
+ ]
+ },
+ "comment": {
+ "type": "string",
+ "description": "Any comment regarding the rule"
+ },
+ "suppressionAlertsScope": {
+ "type": "object",
+ "description": "The suppression conditions",
+ "$ref": "#/definitions/SuppressionAlertsScope"
+ }
+ },
+ "required": [
+ "alertType",
+ "reason",
+ "state"
+ ]
+ },
+ "ScopeElement": {
+ "type": "object",
+ "additionalProperties": true,
+ "description": "A more specific scope used to identify the alerts to suppress.",
+ "properties": {
+ "field": {
+ "type": "string",
+ "description": "The alert entity type to suppress by."
+ }
+ }
+ },
+ "SuppressionAlertsScope": {
+ "type": "object",
+ "properties": {
+ "allOf": {
+ "type": "array",
+ "description": "All the conditions inside need to be true in order to suppress the alert",
+ "items": {
+ "$ref": "#/definitions/ScopeElement"
+ }
+ }
+ },
+ "required": [
+ "allOf"
+ ]
+ }
+ },
+ "parameters": {
+ "AlertType": {
+ "name": "AlertType",
+ "in": "query",
+ "type": "string",
+ "description": "Type of the alert to get rules for",
+ "x-ms-parameter-location": "method"
+ },
+ "AlertsSuppressionRule": {
+ "name": "alertsSuppressionRule",
+ "in": "body",
+ "required": true,
+ "description": "Suppression rule object",
+ "schema": {
+ "$ref": "#/definitions/AlertsSuppressionRule"
+ },
+ "x-ms-parameter-location": "method"
+ },
+ "AlertsSuppressionRuleName": {
+ "name": "alertsSuppressionRuleName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The unique name of the suppression alert rule",
+ "x-ms-parameter-location": "method"
+ }
+ }
+}
diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2019-01-01-preview/examples/AlertsSuppressionRules/DeleteAlertsSuppressionRule_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2019-01-01-preview/examples/AlertsSuppressionRules/DeleteAlertsSuppressionRule_example.json
new file mode 100644
index 000000000000..d8663e727d45
--- /dev/null
+++ b/specification/security/resource-manager/Microsoft.Security/preview/2019-01-01-preview/examples/AlertsSuppressionRules/DeleteAlertsSuppressionRule_example.json
@@ -0,0 +1,10 @@
+{
+ "parameters": {
+ "api-version": "2019-01-01-preview",
+ "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23",
+ "alertsSuppressionRuleName": "dismissIpAnomalyAlerts"
+ },
+ "responses": {
+ "204": {}
+ }
+}
diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2019-01-01-preview/examples/AlertsSuppressionRules/GetAlertsSuppressionRule_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2019-01-01-preview/examples/AlertsSuppressionRules/GetAlertsSuppressionRule_example.json
new file mode 100644
index 000000000000..67228151c5fa
--- /dev/null
+++ b/specification/security/resource-manager/Microsoft.Security/preview/2019-01-01-preview/examples/AlertsSuppressionRules/GetAlertsSuppressionRule_example.json
@@ -0,0 +1,39 @@
+{
+ "parameters": {
+ "api-version": "2019-01-01-preview",
+ "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23",
+ "alertsSuppressionRuleName": "dismissIpAnomalyAlerts"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/alertsSuppressionRules/dismissIpAnomalyAlerts",
+ "name": "dismissIpAnomalyAlerts",
+ "type": "Microsoft.Security/alertsSuppressionRules",
+ "properties": {
+ "alertType": "IpAnomaly",
+ "lastModifiedUtc": "2019-07-31T19:50:47.083633Z",
+ "expirationDateUtc": "2019-12-01T19:50:47.083633Z",
+ "state": "Enabled",
+ "reason": "FalsePositive",
+ "comment": "Test VM",
+ "suppressionAlertsScope": {
+ "allOf": [
+ {
+ "field": "entities.ip.address",
+ "in": [
+ "104.215.95.187",
+ "52.164.206.56"
+ ]
+ },
+ {
+ "field": "entities.process.commandline",
+ "contains": "POWERSHELL.EXE"
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+}
diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2019-01-01-preview/examples/AlertsSuppressionRules/GetAlertsSuppressionRulesWithAlertType_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2019-01-01-preview/examples/AlertsSuppressionRules/GetAlertsSuppressionRulesWithAlertType_example.json
new file mode 100644
index 000000000000..a12282315400
--- /dev/null
+++ b/specification/security/resource-manager/Microsoft.Security/preview/2019-01-01-preview/examples/AlertsSuppressionRules/GetAlertsSuppressionRulesWithAlertType_example.json
@@ -0,0 +1,43 @@
+{
+ "parameters": {
+ "api-version": "2019-01-01-preview",
+ "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23",
+ "alertType": "IpAnomaly"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/alertsSuppressionRules/dismissIpAnomalyAlerts",
+ "name": "dismissIpAnomalyAlerts",
+ "type": "Microsoft.Security/alertsSuppressionRules",
+ "properties": {
+ "alertType": "IpAnomaly",
+ "lastModifiedUtc": "2019-07-31T19:50:47.083633Z",
+ "expirationDateUtc": "2019-12-01T19:50:47.083633Z",
+ "state": "Enabled",
+ "reason": "FalsePositive",
+ "comment": "Test VM",
+ "suppressionAlertsScope": {
+ "allOf": [
+ {
+ "field": "entities.ip.address",
+ "in": [
+ "104.215.95.187",
+ "52.164.206.56"
+ ]
+ },
+ {
+ "field": "entities.process.commandline",
+ "contains": "POWERSHELL.EXE"
+ }
+ ]
+ }
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2019-01-01-preview/examples/AlertsSuppressionRules/GetAlertsSuppressionRules_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2019-01-01-preview/examples/AlertsSuppressionRules/GetAlertsSuppressionRules_example.json
new file mode 100644
index 000000000000..493b914255bf
--- /dev/null
+++ b/specification/security/resource-manager/Microsoft.Security/preview/2019-01-01-preview/examples/AlertsSuppressionRules/GetAlertsSuppressionRules_example.json
@@ -0,0 +1,54 @@
+{
+ "parameters": {
+ "api-version": "2019-01-01-preview",
+ "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/alertsSuppressionRules/dismissIpAnomalyAlerts",
+ "name": "dismissIpAnomalyAlerts",
+ "type": "Microsoft.Security/alertsSuppressionRules",
+ "properties": {
+ "alertType": "IpAnomaly",
+ "lastModifiedUtc": "2019-07-31T19:50:47.083633Z",
+ "expirationDateUtc": "2019-12-01T19:50:47.083633Z",
+ "state": "Enabled",
+ "reason": "FalsePositive",
+ "comment": "Test VM",
+ "suppressionAlertsScope": {
+ "allOf": [
+ {
+ "field": "entities.ip.address",
+ "in": [
+ "104.215.95.187",
+ "52.164.206.56"
+ ]
+ },
+ {
+ "field": "entities.process.commandline",
+ "contains": "POWERSHELL.EXE"
+ }
+ ]
+ }
+ }
+ },
+ {
+ "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/alertsSuppressionRules/dismissDataExfiltrationAnomalyAlertsOnTestVMs",
+ "name": "dismissDataExfiltrationAnomalyAlertsOnTestVMs",
+ "type": "Microsoft.Security/alertsSuppressionRules",
+ "properties": {
+ "alertType": "DataExfiltrationAnomaly",
+ "lastModifiedUtc": "2019-07-31T19:50:47.083633Z",
+ "expirationDateUtc": "2019-12-01T19:50:47.083633Z",
+ "state": "Enabled",
+ "reason": "FalsePositive"
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2019-01-01-preview/examples/AlertsSuppressionRules/PutAlertsSuppressionRule_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2019-01-01-preview/examples/AlertsSuppressionRules/PutAlertsSuppressionRule_example.json
new file mode 100644
index 000000000000..efd66de8a29d
--- /dev/null
+++ b/specification/security/resource-manager/Microsoft.Security/preview/2019-01-01-preview/examples/AlertsSuppressionRules/PutAlertsSuppressionRule_example.json
@@ -0,0 +1,63 @@
+{
+ "parameters": {
+ "api-version": "2019-01-01-preview",
+ "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23",
+ "alertsSuppressionRuleName": "dismissIpAnomalyAlerts",
+ "alertsSuppressionRule": {
+ "properties": {
+ "alertType": "IpAnomaly",
+ "expirationDateUtc": "2019-12-01T19:50:47.083633Z",
+ "state": "Enabled",
+ "reason": "FalsePositive",
+ "comment": "Test VM",
+ "suppressionAlertsScope": {
+ "allOf": [
+ {
+ "field": "entities.ip.address",
+ "in": [
+ "104.215.95.187",
+ "52.164.206.56"
+ ]
+ },
+ {
+ "field": "entities.process.commandline",
+ "contains": "POWERSHELL.EXE"
+ }
+ ]
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/alertsSuppressionRules/dismissIpAnomalyAlerts",
+ "name": "dismissIpAnomalyAlerts",
+ "type": "Microsoft.Security/alertsSuppressionRules",
+ "properties": {
+ "alertType": "IpAnomaly",
+ "lastModifiedUtc": "2019-07-31T19:50:47.083633Z",
+ "expirationDateUtc": "2019-12-01T19:50:47.083633Z",
+ "state": "Enabled",
+ "reason": "FalsePositive",
+ "comment": "Test VM",
+ "suppressionAlertsScope": {
+ "allOf": [
+ {
+ "field": "entities.ip.address",
+ "in": [
+ "104.215.95.187",
+ "52.164.206.56"
+ ]
+ },
+ {
+ "field": "entities.process.commandline",
+ "contains": "POWERSHELL.EXE"
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+}
diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2020-01-01-preview/examples/secureScoreControlDefinitions/ListSecureScoreControlDefinitions_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2020-01-01-preview/examples/secureScoreControlDefinitions/ListSecureScoreControlDefinitions_example.json
new file mode 100644
index 000000000000..6556847ce39e
--- /dev/null
+++ b/specification/security/resource-manager/Microsoft.Security/preview/2020-01-01-preview/examples/secureScoreControlDefinitions/ListSecureScoreControlDefinitions_example.json
@@ -0,0 +1,58 @@
+{
+ "parameters": {
+ "api-version": "2020-01-01-preview"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "/providers/Microsoft.Security/SecureScoreControlDefinitions/a9909064-42b4-4d34-8143-275477afe18b",
+ "name": "a9909064-42b4-4d34-8143-275477afe18b",
+ "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/SecureScoreControlDefinitions/a000c66f-6da2-4f9d-826d-2364347d2588",
+ "name": "a000c66f-6da2-4f9d-826d-2364347d2588",
+ "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,
+ "assessmentDefinitions": [
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/35f45c95-27cf-4e52-891f-8390d1de5828"
+ },
+ {
+ "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/8e2b96ff-3de2-289b-b5c1-3b9921a3441e"
+ }
+ ]
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2020-01-01-preview/examples/secureScoreControlDefinitions/ListSecureScoreControlDefinitions_subscription_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2020-01-01-preview/examples/secureScoreControlDefinitions/ListSecureScoreControlDefinitions_subscription_example.json
new file mode 100644
index 000000000000..899b522bce20
--- /dev/null
+++ b/specification/security/resource-manager/Microsoft.Security/preview/2020-01-01-preview/examples/secureScoreControlDefinitions/ListSecureScoreControlDefinitions_subscription_example.json
@@ -0,0 +1,83 @@
+{
+ "parameters": {
+ "api-version": "2020-01-01-preview",
+ "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "/providers/Microsoft.Security/SecureScoreControlDefinitions/a9909064-42b4-4d34-8143-275477afe18b",
+ "name": "a9909064-42b4-4d34-8143-275477afe18b",
+ "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/SecureScoreControlDefinitions/34a42fb3-e6db-409c-b56b-7b1db6b8aee0",
+ "name": "34a42fb3-e6db-409c-b56b-7b1db6b8aee0",
+ "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/57e98606-6b1e-6193-0e3d-fe621387c16b"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/94290b00-4d0c-d7b4-7cea-064a9554e681"
+ }
+ ]
+ }
+ },
+ {
+ "id": "/providers/Microsoft.Security/SecureScoreControlDefinitions/a000c66f-6da2-4f9d-826d-2364347d2588",
+ "name": "a000c66f-6da2-4f9d-826d-2364347d2588",
+ "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,
+ "assessmentDefinitions": [
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/35f45c95-27cf-4e52-891f-8390d1de5828"
+ },
+ {
+ "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/8e2b96ff-3de2-289b-b5c1-3b9921a3441e"
+ }
+ ]
+ }
+ }
+ ]
+ }
+ }
+ }
+}
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
new file mode 100644
index 000000000000..58c0d683cb8c
--- /dev/null
+++ b/specification/security/resource-manager/Microsoft.Security/preview/2020-01-01-preview/examples/secureScores/GetSecureScoresSingle_example.json
@@ -0,0 +1,23 @@
+{
+ "parameters": {
+ "api-version": "2020-01-01-preview",
+ "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23",
+ "secureScoreName": "ascScore"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/secureScores/ascScore",
+ "name": "ascScore",
+ "type": "Microsoft.Security/secureScores",
+ "properties": {
+ "displayName": "ASC score",
+ "score": {
+ "max": 13,
+ "current": 3
+ }
+ }
+ }
+ }
+ }
+}
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
new file mode 100644
index 000000000000..99b0d5df2e2e
--- /dev/null
+++ b/specification/security/resource-manager/Microsoft.Security/preview/2020-01-01-preview/examples/secureScores/ListSecureScoreControlsForNameWithExpand_builtin_example.json
@@ -0,0 +1,133 @@
+{
+ "parameters": {
+ "api-version": "2020-01-01-preview",
+ "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23",
+ "secureScoreName": "ascScore",
+ "$expand": "definition"
+ },
+ "responses": {
+ "200": {
+ "parameters": {
+ "secureScoreName": "ascScore"
+ },
+ "body": {
+ "value": [
+ {
+ "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/SecureScoreControls/a9909064-42b4-4d34-8143-275477afe18b",
+ "name": "a9909064-42b4-4d34-8143-275477afe18b",
+ "type": "Microsoft.Security/secureScoreControls",
+ "properties": {
+ "displayName": "Protect applications against DDoS attacks",
+ "healthyResourceCount": 0,
+ "unhealthyResourceCount": 0,
+ "notApplicableResourceCount": 10,
+ "score": {
+ "max": 0,
+ "current": 0
+ },
+ "definition": {
+ "id": "/providers/Microsoft.Security/SecureScoreControlDefinitions/a9909064-42b4-4d34-8143-275477afe18b",
+ "name": "a9909064-42b4-4d34-8143-275477afe18b",
+ "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": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/SecureScoreControls/34a42fb3-e6db-409c-b56b-7b1db6b8aee0",
+ "name": "34a42fb3-e6db-409c-b56b-7b1db6b8aee0",
+ "type": "Microsoft.Security/SecureScoreControls",
+ "properties": {
+ "displayName": "Enable MFA",
+ "healthyResourceCount": 0,
+ "unhealthyResourceCount": 1,
+ "notApplicableResourceCount": 0,
+ "score": {
+ "max": 10,
+ "current": 0
+ },
+ "definition": {
+ "id": "/providers/Microsoft.Security/SecureScoreControlDefinitions/34a42fb3-e6db-409c-b56b-7b1db6b8aee0",
+ "name": "34a42fb3-e6db-409c-b56b-7b1db6b8aee0",
+ "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/57e98606-6b1e-6193-0e3d-fe621387c16b"
+ },
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/94290b00-4d0c-d7b4-7cea-064a9554e681"
+ }
+ ]
+ }
+ }
+ }
+ },
+ {
+ "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",
+ "properties": {
+ "displayName": "Apply adaptive application control",
+ "healthyResourceCount": 20,
+ "unhealthyResourceCount": 0,
+ "notApplicableResourceCount": 10,
+ "score": {
+ "max": 3,
+ "current": 3
+ },
+ "definition": {
+ "id": "/providers/Microsoft.Security/SecureScoreControlDefinitions/a000c66f-6da2-4f9d-826d-2364347d2588",
+ "name": "a000c66f-6da2-4f9d-826d-2364347d2588",
+ "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,
+ "assessmentDefinitions": [
+ {
+ "id": "/providers/Microsoft.Security/assessmentMetadata/35f45c95-27cf-4e52-891f-8390d1de5828"
+ },
+ {
+ "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/8e2b96ff-3de2-289b-b5c1-3b9921a3441e"
+ }
+ ]
+ }
+ }
+ }
+ }
+ ]
+ }
+ }
+ }
+}
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
new file mode 100644
index 000000000000..aae8856966ea
--- /dev/null
+++ b/specification/security/resource-manager/Microsoft.Security/preview/2020-01-01-preview/examples/secureScores/ListSecureScoreControlsForName_builtin_example.json
@@ -0,0 +1,60 @@
+{
+ "parameters": {
+ "api-version": "2020-01-01-preview",
+ "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23",
+ "secureScoreName": "ascScore"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/SecureScoreControls/a9909064-42b4-4d34-8143-275477afe18b",
+ "name": "a9909064-42b4-4d34-8143-275477afe18b",
+ "type": "Microsoft.Security/SecureScoreControls",
+ "properties": {
+ "displayName": "Protect applications against DDoS attacks",
+ "healthyResourceCount": 0,
+ "unhealthyResourceCount": 0,
+ "notApplicableResourceCount": 10,
+ "score": {
+ "max": 0,
+ "current": 0
+ }
+ }
+ },
+ {
+ "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/SecureScoreControls/34a42fb3-e6db-409c-b56b-7b1db6b8aee0",
+ "name": "34a42fb3-e6db-409c-b56b-7b1db6b8aee0",
+ "type": "Microsoft.Security/SecureScoreControls",
+ "properties": {
+ "displayName": "Enable MFA",
+ "healthyResourceCount": 0,
+ "unhealthyResourceCount": 1,
+ "notApplicableResourceCount": 0,
+ "score": {
+ "max": 10,
+ "current": 0
+ }
+ }
+ },
+ {
+ "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",
+ "properties": {
+ "displayName": "Apply adaptive application control",
+ "healthyResourceCount": 20,
+ "unhealthyResourceCount": 0,
+ "notApplicableResourceCount": 10,
+ "score": {
+ "max": 3,
+ "current": 3
+ }
+ }
+ }
+ ]
+ }
+ }
+ }
+}
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
new file mode 100644
index 000000000000..c3c4542a72f3
--- /dev/null
+++ b/specification/security/resource-manager/Microsoft.Security/preview/2020-01-01-preview/examples/secureScores/ListSecureScoreControls_example.json
@@ -0,0 +1,59 @@
+{
+ "parameters": {
+ "api-version": "2020-01-01-preview",
+ "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/SecureScoreControls/a9909064-42b4-4d34-8143-275477afe18b",
+ "name": "a9909064-42b4-4d34-8143-275477afe18b",
+ "type": "Microsoft.Security/SecureScoreControls",
+ "properties": {
+ "displayName": "Protect applications against DDoS attacks",
+ "healthyResourceCount": 0,
+ "unhealthyResourceCount": 0,
+ "notApplicableResourceCount": 10,
+ "score": {
+ "max": 0,
+ "current": 0
+ }
+ }
+ },
+ {
+ "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/SecureScoreControls/34a42fb3-e6db-409c-b56b-7b1db6b8aee0",
+ "name": "34a42fb3-e6db-409c-b56b-7b1db6b8aee0",
+ "type": "Microsoft.Security/SecureScoreControls",
+ "properties": {
+ "displayName": "Enable MFA",
+ "healthyResourceCount": 0,
+ "unhealthyResourceCount": 1,
+ "notApplicableResourceCount": 0,
+ "score": {
+ "max": 10,
+ "current": 0
+ }
+ }
+ },
+ {
+ "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",
+ "properties": {
+ "displayName": "Apply adaptive application control",
+ "healthyResourceCount": 20,
+ "unhealthyResourceCount": 0,
+ "notApplicableResourceCount": 10,
+ "score": {
+ "max": 3,
+ "current": 3
+ }
+ }
+ }
+ ]
+ }
+ }
+ }
+}
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
new file mode 100644
index 000000000000..c9fc267708c1
--- /dev/null
+++ b/specification/security/resource-manager/Microsoft.Security/preview/2020-01-01-preview/examples/secureScores/ListSecureScores_example.json
@@ -0,0 +1,26 @@
+{
+ "parameters": {
+ "api-version": "2020-01-01-preview",
+ "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/secureScores/ascScore",
+ "name": "ascScore",
+ "type": "Microsoft.Security/secureScores",
+ "properties": {
+ "displayName": "ASC score",
+ "score": {
+ "max": 13,
+ "current": 3.5
+ }
+ }
+ }
+ ]
+ }
+ }
+ }
+}
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
new file mode 100644
index 000000000000..3e742573ba4f
--- /dev/null
+++ b/specification/security/resource-manager/Microsoft.Security/preview/2020-01-01-preview/secureScore.json
@@ -0,0 +1,586 @@
+{
+ "swagger": "2.0",
+ "info": {
+ "title": "Security Center",
+ "description": "API spec for Microsoft.Security (Azure Security Center) resource provider",
+ "version": "2020-01-01-preview"
+ },
+ "host": "management.azure.com",
+ "schemes": [
+ "https"
+ ],
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "security": [
+ {
+ "azure_auth": [
+ "user_impersonation"
+ ]
+ }
+ ],
+ "securityDefinitions": {
+ "azure_auth": {
+ "type": "oauth2",
+ "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize",
+ "flow": "implicit",
+ "description": "Azure Active Directory OAuth2 Flow",
+ "scopes": {
+ "user_impersonation": "impersonate your user account"
+ }
+ }
+ },
+ "paths": {
+ "/subscriptions/{subscriptionId}/providers/Microsoft.Security/secureScores": {
+ "get": {
+ "x-ms-examples": {
+ "List secure scores": {
+ "$ref": "./examples/secureScores/ListSecureScores_example.json"
+ }
+ },
+ "tags": [
+ "Secure Score"
+ ],
+ "description": "List secure scores for all your Security Center initiatives within your current scope.",
+ "operationId": "SecureScores_List",
+ "parameters": [
+ {
+ "$ref": "../../../common/v1/types.json#/parameters/ApiVersion"
+ },
+ {
+ "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/SecureScoresList"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common/v1/types.json#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/providers/Microsoft.Security/secureScores/{secureScoreName}": {
+ "get": {
+ "x-ms-examples": {
+ "Get single secure score": {
+ "$ref": "./examples/secureScores/GetSecureScoresSingle_example.json"
+ }
+ },
+ "tags": [
+ "Secure Score"
+ ],
+ "description": "Get secure score for a specific Security Center initiative within your current scope. For the ASC Default initiative, use 'ascScore'.",
+ "operationId": "SecureScores_Get",
+ "parameters": [
+ {
+ "$ref": "../../../common/v1/types.json#/parameters/ApiVersion"
+ },
+ {
+ "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId"
+ },
+ {
+ "$ref": "#/parameters/secureScoreName"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/SecureScoreItem"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common/v1/types.json#/definitions/CloudError"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/providers/Microsoft.Security/secureScores/{secureScoreName}/secureScoreControls": {
+ "get": {
+ "x-ms-examples": {
+ "Get security controls and their current score for the specified initiative": {
+ "$ref": "./examples/secureScores/ListSecureScoreControlsForName_builtin_example.json"
+ },
+ "Get security controls and their current score for the specified initiative with the expand parameter": {
+ "$ref": "./examples/secureScores/ListSecureScoreControlsForNameWithExpand_builtin_example.json"
+ }
+ },
+ "tags": [
+ "Secure Score"
+ ],
+ "description": "Get all security controls for a specific initiative within a scope",
+ "operationId": "SecureScoreControls_ListBySecureScore",
+ "parameters": [
+ {
+ "$ref": "../../../common/v1/types.json#/parameters/ApiVersion"
+ },
+ {
+ "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId"
+ },
+ {
+ "$ref": "#/parameters/secureScoreName"
+ },
+ {
+ "$ref": "#/parameters/ExpandControlsDefinition"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/SecureScoreControlList"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common/v1/types.json#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/providers/Microsoft.Security/secureScoreControls": {
+ "get": {
+ "x-ms-examples": {
+ "List all secure scores controls": {
+ "$ref": "./examples/secureScores/ListSecureScoreControls_example.json"
+ }
+ },
+ "tags": [
+ "Secure Score Controls"
+ ],
+ "description": "Get all security controls within a scope",
+ "operationId": "SecureScoreControls_List",
+ "parameters": [
+ {
+ "$ref": "../../../common/v1/types.json#/parameters/ApiVersion"
+ },
+ {
+ "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId"
+ },
+ {
+ "$ref": "#/parameters/ExpandControlsDefinition"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/SecureScoreControlList"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common/v1/types.json#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/providers/Microsoft.Security/secureScoreControlDefinitions": {
+ "get": {
+ "x-ms-examples": {
+ "List security controls definition": {
+ "$ref": "./examples/secureScoreControlDefinitions/ListSecureScoreControlDefinitions_example.json"
+ }
+ },
+ "tags": [
+ "Secure Score Control Definitions"
+ ],
+ "description": "List the available security controls, their assessments, and the max score",
+ "operationId": "SecureScoreControlDefinitions_List",
+ "parameters": [
+ {
+ "$ref": "../../../common/v1/types.json#/parameters/ApiVersion"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/secureScoreControlDefinitionList"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common/v1/types.json#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/providers/Microsoft.Security/secureScoreControlDefinitions": {
+ "get": {
+ "x-ms-examples": {
+ "List security controls definition by subscription": {
+ "$ref": "./examples/secureScoreControlDefinitions/ListSecureScoreControlDefinitions_subscription_example.json"
+ }
+ },
+ "tags": [
+ "Secure Score Control Definitions"
+ ],
+ "description": "For a specified subscription, list the available security controls, their assessments, and the max score",
+ "operationId": "SecureScoreControlDefinitions_ListBySubscription",
+ "parameters": [
+ {
+ "$ref": "../../../common/v1/types.json#/parameters/ApiVersion"
+ },
+ {
+ "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/secureScoreControlDefinitionList"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common/v1/types.json#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ }
+ },
+ "definitions": {
+ "SecureScoresList": {
+ "type": "object",
+ "description": "List of secure scores",
+ "properties": {
+ "value": {
+ "description": "Collection of secure scores in this page",
+ "readOnly": true,
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/SecureScoreItem"
+ }
+ },
+ "nextLink": {
+ "description": "The URI to fetch the next page.",
+ "readOnly": true,
+ "type": "string"
+ }
+ }
+ },
+ "SecureScoreItem": {
+ "description": "Secure score item data model",
+ "readOnly": true,
+ "type": "object",
+ "properties": {
+ "properties": {
+ "description": "Secure score item",
+ "readOnly": true,
+ "x-ms-client-flatten": true,
+ "$ref": "#/definitions/SecureScoreItemProperties"
+ }
+ },
+ "allOf": [
+ {
+ "$ref": "../../../common/v1/types.json#/definitions/Resource"
+ }
+ ]
+ },
+ "SecureScoreItemProperties": {
+ "description": "Describes properties of a calculated secure score.",
+ "readOnly": true,
+ "type": "object",
+ "properties": {
+ "displayName": {
+ "description": "The initiative’s name",
+ "readOnly": true,
+ "type": "string"
+ },
+ "score": {
+ "description": "score object",
+ "readOnly": true,
+ "x-ms-client-flatten": true,
+ "$ref": "#/definitions/ScoreDetails"
+ }
+ }
+ },
+ "ScoreDetails": {
+ "description": "Calculation result data",
+ "readOnly": true,
+ "type": "object",
+ "properties": {
+ "max": {
+ "description": "Maximum score available",
+ "readOnly": true,
+ "type": "integer",
+ "format": "int32",
+ "minimum": 0,
+ "exclusiveMinimum": false
+ },
+ "current": {
+ "description": "Current score",
+ "readOnly": true,
+ "type": "number",
+ "format": "double",
+ "minimum": 0.00,
+ "exclusiveMinimum": false
+ }
+ }
+ },
+ "SecureScoreControlScore": {
+ "description": "Calculation result data",
+ "type": "object",
+ "properties": {
+ "max": {
+ "description": "Maximum control score (0..10)",
+ "readOnly": true,
+ "type": "integer",
+ "format": "int32",
+ "minimum": 0,
+ "maximum": 10,
+ "exclusiveMinimum": false
+ },
+ "current": {
+ "description": "Actual score for the control = (achieved points / total points) * max score. if total points is zeroed, the return number is 0.00",
+ "readOnly": true,
+ "type": "number",
+ "format": "double",
+ "minimum": 0.00,
+ "maximum": 10.00,
+ "exclusiveMinimum": false
+ }
+ }
+ },
+ "SecureScoreControlList": {
+ "description": "List of security controls",
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "Collection of security controls in this page",
+ "readOnly": true,
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/SecureScoreControlDetails"
+ }
+ },
+ "nextLink": {
+ "description": "The URI to fetch the next page.",
+ "readOnly": true,
+ "type": "string"
+ }
+ }
+ },
+ "SecureScoreControlDetails": {
+ "description": "Details of the security control, its score, and the health status of the relevant resources.",
+ "type": "object",
+ "properties": {
+ "properties": {
+ "x-ms-client-flatten": true,
+ "$ref": "#/definitions/SecureScoreControlScoreDetails"
+ }
+ },
+ "allOf": [
+ {
+ "$ref": "../../../common/v1/types.json#/definitions/Resource"
+ }
+ ]
+ },
+ "SecureScoreControlScoreDetails": {
+ "description": "Calculation result data in control level",
+ "type": "object",
+ "properties": {
+ "displayName": {
+ "description": "User friendly display name of the control",
+ "readOnly": true,
+ "type": "string"
+ },
+ "score": {
+ "description": "Actual score object for the control",
+ "x-ms-client-flatten": true,
+ "$ref": "#/definitions/ScoreDetails"
+ },
+ "healthyResourceCount": {
+ "description": "Number of healthy resources in the control",
+ "readOnly": true,
+ "type": "integer",
+ "format": "int32"
+ },
+ "unhealthyResourceCount": {
+ "description": "Number of unhealthy resources in the control",
+ "readOnly": true,
+ "type": "integer",
+ "format": "int32"
+ },
+ "notApplicableResourceCount": {
+ "description": "Number of not applicable resources in the control",
+ "readOnly": true,
+ "type": "integer",
+ "format": "int32"
+ },
+ "definition": {
+ "$ref": "#/definitions/SecureScoreControlDefinitionItem"
+ }
+ }
+ },
+ "secureScoreControlDefinitionList": {
+ "description": "List of security controls definition",
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "Collection of security controls definition in this page",
+ "readOnly": true,
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/SecureScoreControlDefinitionItem"
+ }
+ },
+ "nextLink": {
+ "description": "The URI to fetch the next page.",
+ "readOnly": true,
+ "type": "string"
+ }
+ }
+ },
+ "SecureScoreControlDefinitionItem": {
+ "description": "Information about the security control.",
+ "type": "object",
+ "properties": {
+ "properties": {
+ "x-ms-client-flatten": true,
+ "$ref": "#/definitions/SecureScoreControlDefinitionItemProperties"
+ }
+ },
+ "allOf": [
+ {
+ "$ref": "../../../common/v1/types.json#/definitions/Resource"
+ }
+ ]
+ },
+ "SecureScoreControlDefinitionItemProperties": {
+ "description": "Security Control Definition Properties.",
+ "type": "object",
+ "properties": {
+ "displayName": {
+ "description": "User friendly display name of the control",
+ "readOnly": true,
+ "type": "string"
+ },
+ "description": {
+ "description": "User friendly description of the control",
+ "readOnly": true,
+ "type": "string",
+ "maxLength": 256
+ },
+ "maxScore": {
+ "description": "Maximum control score (0..10)",
+ "readOnly": true,
+ "type": "integer",
+ "format": "int32",
+ "minimum": 0,
+ "maximum": 10,
+ "exclusiveMinimum": false
+ },
+ "source": {
+ "description": "Source object from which the control was created",
+ "readOnly": true,
+ "$ref": "#/definitions/SecureScoreControlDefinitionSource"
+ },
+ "assessmentDefinitions": {
+ "description": "Array of assessments metadata IDs that are included in this security control",
+ "readOnly": true,
+ "$ref": "../../../common/v1/types.json#/definitions/AzureResourceLinks"
+ }
+ }
+ },
+ "SecureScoreControlDefinitionSource": {
+ "description": "The type of the security control (For example, BuiltIn)",
+ "readOnly": true,
+ "type": "object",
+ "properties": {
+ "sourceType": {
+ "description": "The type of security control (for example, BuiltIn)",
+ "type": "string",
+ "enum": [
+ "BuiltIn",
+ "Custom"
+ ],
+ "x-ms-enum": {
+ "name": "controlType",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "BuiltIn",
+ "description": "Azure Security Center managed assessments"
+ },
+ {
+ "value": "Custom",
+ "description": "Non Azure Security Center managed assessments"
+ }
+ ]
+ }
+ }
+ }
+ }
+ },
+ "parameters": {
+ "ExpandControlsDefinition": {
+ "name": "$expand",
+ "in": "query",
+ "required": false,
+ "type": "string",
+ "description": "OData expand. Optional.",
+ "x-ms-parameter-location": "method",
+ "enum": [
+ "definition"
+ ],
+ "x-ms-enum": {
+ "name": "ExpandControlsEnum",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "definition",
+ "description": "Add definition object for each control"
+ }
+ ]
+ }
+ },
+ "secureScoreName": {
+ "name": "secureScoreName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The initiative name. For the ASC Default initiative, use 'ascScore' as in the sample request below.",
+ "x-ms-parameter-location": "method"
+ }
+ }
+}
diff --git a/specification/security/resource-manager/Microsoft.Security/stable/2019-01-01/alerts.json b/specification/security/resource-manager/Microsoft.Security/stable/2019-01-01/alerts.json
index 5f1aeadddebe..cc3894b377cb 100644
--- a/specification/security/resource-manager/Microsoft.Security/stable/2019-01-01/alerts.json
+++ b/specification/security/resource-manager/Microsoft.Security/stable/2019-01-01/alerts.json
@@ -39,6 +39,9 @@
"x-ms-examples": {
"Get security alerts on a subscription": {
"$ref": "./examples/Alerts/GetAlertsSubscription_example.json"
+ },
+ "Get security alerts, that were affected by auto dismiss rule, on a subscription": {
+ "$ref": "./examples/Alerts/GetAlertsSubscriptionWithAutoDismissRule_example.json"
}
},
"tags": [
@@ -61,6 +64,9 @@
},
{
"$ref": "#/parameters/ODataExpand"
+ },
+ {
+ "$ref": "#/parameters/AutoDismissRuleName"
}
],
"responses": {
@@ -87,6 +93,9 @@
"x-ms-examples": {
"Get security alerts on a resource group": {
"$ref": "./examples/Alerts/GetAlertsResourceGroup_example.json"
+ },
+ "Get security alerts, that should be dismissed by auto dismiss rule, on a resource group": {
+ "$ref": "./examples/Alerts/GetAlertsResourceGroupWithAutoDismissRule_example.json"
}
},
"tags": [
@@ -112,6 +121,9 @@
},
{
"$ref": "#/parameters/ODataExpand"
+ },
+ {
+ "$ref": "#/parameters/AutoDismissRuleName"
}
],
"responses": {
@@ -138,6 +150,9 @@
"x-ms-examples": {
"Get security alerts on a subscription from a security data location": {
"$ref": "./examples/Alerts/GetAlertsSubscriptionsLocation_example.json"
+ },
+ "Get security alerts, that should be dismissed by auto dismiss rule, on a subscription from a security data location": {
+ "$ref": "./examples/Alerts/GetAlertsSubscriptionsLocationWithAutoDismissRule_example.json"
}
},
"tags": [
@@ -163,6 +178,9 @@
},
{
"$ref": "#/parameters/ODataExpand"
+ },
+ {
+ "$ref": "#/parameters/AutoDismissRuleName"
}
],
"responses": {
@@ -189,6 +207,9 @@
"x-ms-examples": {
"Get security alerts on a resource group from a security data location": {
"$ref": "./examples/Alerts/GetAlertsResourceGroupLocation_example.json"
+ },
+ "Get security alerts, that should be dismissed by auto dismiss rule, on a resource group from a security data location": {
+ "$ref": "./examples/Alerts/GetAlertsResourceGroupLocationWithAutoDismissRule_example.json"
}
},
"tags": [
@@ -217,6 +238,9 @@
},
{
"$ref": "#/parameters/ODataExpand"
+ },
+ {
+ "$ref": "#/parameters/AutoDismissRuleName"
}
],
"responses": {
@@ -739,6 +763,13 @@
"type": "string",
"description": "Name of the alert object",
"x-ms-parameter-location": "method"
+ },
+ "AutoDismissRuleName": {
+ "name": "autoDismissRuleName",
+ "in": "query",
+ "type": "string",
+ "description": "The name of an existing auto dismiss rule. Use it to simulate the rule on existing alerts and get the alerts that would have been dismissed if the rule was enabled when the alert was created",
+ "x-ms-parameter-location": "method"
}
}
}
diff --git a/specification/security/resource-manager/Microsoft.Security/stable/2019-01-01/examples/Alerts/GetAlertsResourceGroupLocationWithAutoDismissRule_example.json b/specification/security/resource-manager/Microsoft.Security/stable/2019-01-01/examples/Alerts/GetAlertsResourceGroupLocationWithAutoDismissRule_example.json
new file mode 100644
index 000000000000..0815c5f5bd32
--- /dev/null
+++ b/specification/security/resource-manager/Microsoft.Security/stable/2019-01-01/examples/Alerts/GetAlertsResourceGroupLocationWithAutoDismissRule_example.json
@@ -0,0 +1,86 @@
+{
+ "parameters": {
+ "api-version": "2019-01-01",
+ "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23",
+ "resourceGroupName": "myRg1",
+ "ascLocation": "westeurope",
+ "autoDismissRuleName": "dismissThreatIntelligence"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg1/providers/Microsoft.Security/locations/westeurope/alerts/2518770965529163669_F144EE95-A3E5-42DA-A279-967D115809AA",
+ "name": "2518770965529163669_F144EE95-A3E5-42DA-A279-967D115809AA",
+ "type": "Microsoft.Security/Locations/alerts",
+ "properties": {
+ "vendorName": "Microsoft",
+ "alertDisplayName": "Threat Intelligence Alert",
+ "alertName": "ThreatIntelligence",
+ "detectedTimeUtc": "2018-05-01T19:50:47.083633Z",
+ "description": "Process was detected running on the host and is considered to be suspicious, verify that the user run it",
+ "remediationSteps": "verify that the user invoked this process\r\nrun antimalware scan of the VM",
+ "actionTaken": "Detected",
+ "reportedSeverity": "High",
+ "compromisedEntity": "vm1",
+ "associatedResource": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg1/providers/Microsoft.Compute/virtualMachines/vm1",
+ "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23",
+ "instanceId": "f144ee95-a3e5-42da-a279-967d115809aa",
+ "extendedProperties": {
+ "user Name": "administrator",
+ "domain Name": "Contoso",
+ "attacker IP": "192.0.2.1",
+ "resourceType": "Virtual Machine"
+ },
+ "state": "Dismissed",
+ "reportedTimeUtc": "2018-05-02T05:36:12.2089889Z",
+ "confidenceScore": 0.8,
+ "confidenceReasons": [
+ {
+ "type": "User",
+ "reason": "Some user reason"
+ },
+ {
+ "type": "Process",
+ "reason": "Some proccess reason"
+ },
+ {
+ "type": "Computer",
+ "reason": "Some computer reason"
+ }
+ ],
+ "canBeInvestigated": true,
+ "isIncident": false,
+ "entities": [
+ {
+ "address": "192.0.2.1",
+ "location": {
+ "countryCode": "gb",
+ "state": "wokingham",
+ "city": "sonning",
+ "longitude": -0.909,
+ "latitude": 51.468,
+ "asn": 6584
+ },
+ "threatIntelligence": [
+ {
+ "providerName": "Team Cymru",
+ "threatType": "C2",
+ "threatName": "rarog",
+ "confidence": 0.8,
+ "reportLink": "http://www.microsoft.com",
+ "threatDescription": "In bot armies, the controller is the server machine(s) that gives instructions to the controlled (zombied) hosts that connect to the command and control (C2) network. The controller host is usually running a botnet management application that is sending the commands to the zombied members of the bot army. These commands include, but are not limited to, the following: updating bitcoin wallet information, distributed denial-of-service (DDoS) target listings, updated C2 communication contact lists, and targeting data. C2 servers may be either directly controlled by the malware operators or run on hardware compromised by malware. There are multiple techniques for dynamically changing the control servers so that they are not isolated and brought down. Control servers utilize two general architectures: client-server and peer-to-peer. In a client-server model, all the hosts are controlled by a single server or a few control servers. In a peer-to-peer model, the infected hosts are both clients and servers, and they control other hosts so that instead of isolating the few control servers, all the hosts need to be removed."
+ }
+ ],
+ "type": "ip"
+ }
+ ],
+ "correlationKey": "Rkso6LFWxzCll5tqrk4hnrBJ+MY1BX806W6q6+0s9Jk="
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/security/resource-manager/Microsoft.Security/stable/2019-01-01/examples/Alerts/GetAlertsResourceGroupWithAutoDismissRule_example.json b/specification/security/resource-manager/Microsoft.Security/stable/2019-01-01/examples/Alerts/GetAlertsResourceGroupWithAutoDismissRule_example.json
new file mode 100644
index 000000000000..55f3b45eb732
--- /dev/null
+++ b/specification/security/resource-manager/Microsoft.Security/stable/2019-01-01/examples/Alerts/GetAlertsResourceGroupWithAutoDismissRule_example.json
@@ -0,0 +1,85 @@
+{
+ "parameters": {
+ "api-version": "2019-01-01",
+ "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23",
+ "resourceGroupName": "myRg1",
+ "autoDismissRuleName": "dismissThreatIntelligence"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg1/providers/Microsoft.Security/locations/westeurope/alerts/2518770965529163669_F144EE95-A3E5-42DA-A279-967D115809AA",
+ "name": "2518770965529163669_F144EE95-A3E5-42DA-A279-967D115809AA",
+ "type": "Microsoft.Security/Locations/alerts",
+ "properties": {
+ "vendorName": "Microsoft",
+ "alertDisplayName": "Threat Intelligence Alert",
+ "alertName": "ThreatIntelligence",
+ "detectedTimeUtc": "2018-05-01T19:50:47.083633Z",
+ "description": "Process was detected running on the host and is considered to be suspicious, verify that the user run it",
+ "remediationSteps": "verify that the user invoked this process\r\nrun antimalware scan of the VM",
+ "actionTaken": "Detected",
+ "reportedSeverity": "High",
+ "compromisedEntity": "vm1",
+ "associatedResource": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg1/providers/Microsoft.Compute/virtualMachines/vm1",
+ "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23",
+ "instanceId": "f144ee95-a3e5-42da-a279-967d115809aa",
+ "extendedProperties": {
+ "user Name": "administrator",
+ "domain Name": "Contoso",
+ "attacker IP": "192.0.2.1",
+ "resourceType": "Virtual Machine"
+ },
+ "state": "Dismissed",
+ "reportedTimeUtc": "2018-05-02T05:36:12.2089889Z",
+ "confidenceScore": 0.8,
+ "confidenceReasons": [
+ {
+ "type": "User",
+ "reason": "Some user reason"
+ },
+ {
+ "type": "Process",
+ "reason": "Some proccess reason"
+ },
+ {
+ "type": "Computer",
+ "reason": "Some computer reason"
+ }
+ ],
+ "canBeInvestigated": true,
+ "isIncident": false,
+ "entities": [
+ {
+ "address": "192.0.2.1",
+ "location": {
+ "countryCode": "gb",
+ "state": "wokingham",
+ "city": "sonning",
+ "longitude": -0.909,
+ "latitude": 51.468,
+ "asn": 6584
+ },
+ "threatIntelligence": [
+ {
+ "providerName": "Team Cymru",
+ "threatType": "C2",
+ "threatName": "rarog",
+ "confidence": 0.8,
+ "reportLink": "http://www.microsoft.com",
+ "threatDescription": "In bot armies, the controller is the server machine(s) that gives instructions to the controlled (zombied) hosts that connect to the command and control (C2) network. The controller host is usually running a botnet management application that is sending the commands to the zombied members of the bot army. These commands include, but are not limited to, the following: updating bitcoin wallet information, distributed denial-of-service (DDoS) target listings, updated C2 communication contact lists, and targeting data. C2 servers may be either directly controlled by the malware operators or run on hardware compromised by malware. There are multiple techniques for dynamically changing the control servers so that they are not isolated and brought down. Control servers utilize two general architectures: client-server and peer-to-peer. In a client-server model, all the hosts are controlled by a single server or a few control servers. In a peer-to-peer model, the infected hosts are both clients and servers, and they control other hosts so that instead of isolating the few control servers, all the hosts need to be removed."
+ }
+ ],
+ "type": "ip"
+ }
+ ],
+ "correlationKey": "Rkso6LFWxzCll5tqrk4hnrBJ+MY1BX806W6q6+0s9Jk="
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/security/resource-manager/Microsoft.Security/stable/2019-01-01/examples/Alerts/GetAlertsSubscriptionWithAutoDismissRule_example.json b/specification/security/resource-manager/Microsoft.Security/stable/2019-01-01/examples/Alerts/GetAlertsSubscriptionWithAutoDismissRule_example.json
new file mode 100644
index 000000000000..85011eda2695
--- /dev/null
+++ b/specification/security/resource-manager/Microsoft.Security/stable/2019-01-01/examples/Alerts/GetAlertsSubscriptionWithAutoDismissRule_example.json
@@ -0,0 +1,84 @@
+{
+ "parameters": {
+ "api-version": "2019-01-01",
+ "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23",
+ "autoDismissRuleName": "dismissThreatIntelligence"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg1/providers/Microsoft.Security/locations/westeurope/alerts/2518770965529163669_F144EE95-A3E5-42DA-A279-967D115809AA",
+ "name": "2518770965529163669_F144EE95-A3E5-42DA-A279-967D115809AA",
+ "type": "Microsoft.Security/Locations/alerts",
+ "properties": {
+ "vendorName": "Microsoft",
+ "alertDisplayName": "Threat Intelligence Alert",
+ "alertName": "ThreatIntelligence",
+ "detectedTimeUtc": "2018-05-01T19:50:47.083633Z",
+ "description": "Process was detected running on the host and is considered to be suspicious, verify that the user run it",
+ "remediationSteps": "verify that the user invoked this process\r\nrun antimalware scan of the VM",
+ "actionTaken": "Detected",
+ "reportedSeverity": "High",
+ "compromisedEntity": "vm1",
+ "associatedResource": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg1/providers/Microsoft.Compute/virtualMachines/vm1",
+ "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23",
+ "instanceId": "f144ee95-a3e5-42da-a279-967d115809aa",
+ "extendedProperties": {
+ "user Name": "administrator",
+ "domain Name": "Contoso",
+ "attacker IP": "192.0.2.1",
+ "resourceType": "Virtual Machine"
+ },
+ "state": "Dismissed",
+ "reportedTimeUtc": "2018-05-02T05:36:12.2089889Z",
+ "confidenceScore": 0.8,
+ "confidenceReasons": [
+ {
+ "type": "User",
+ "reason": "Some user reason"
+ },
+ {
+ "type": "Process",
+ "reason": "Some proccess reason"
+ },
+ {
+ "type": "Computer",
+ "reason": "Some computer reason"
+ }
+ ],
+ "canBeInvestigated": true,
+ "isIncident": false,
+ "entities": [
+ {
+ "address": "192.0.2.1",
+ "location": {
+ "countryCode": "gb",
+ "state": "wokingham",
+ "city": "sonning",
+ "longitude": -0.909,
+ "latitude": 51.468,
+ "asn": 6584
+ },
+ "threatIntelligence": [
+ {
+ "providerName": "Team Cymru",
+ "threatType": "C2",
+ "threatName": "rarog",
+ "confidence": 0.8,
+ "reportLink": "http://www.microsoft.com",
+ "threatDescription": "In bot armies, the controller is the server machine(s) that gives instructions to the controlled (zombied) hosts that connect to the command and control (C2) network. The controller host is usually running a botnet management application that is sending the commands to the zombied members of the bot army. These commands include, but are not limited to, the following: updating bitcoin wallet information, distributed denial-of-service (DDoS) target listings, updated C2 communication contact lists, and targeting data. C2 servers may be either directly controlled by the malware operators or run on hardware compromised by malware. There are multiple techniques for dynamically changing the control servers so that they are not isolated and brought down. Control servers utilize two general architectures: client-server and peer-to-peer. In a client-server model, all the hosts are controlled by a single server or a few control servers. In a peer-to-peer model, the infected hosts are both clients and servers, and they control other hosts so that instead of isolating the few control servers, all the hosts need to be removed."
+ }
+ ],
+ "type": "ip"
+ }
+ ],
+ "correlationKey": "Rkso6LFWxzCll5tqrk4hnrBJ+MY1BX806W6q6+0s9Jk="
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/security/resource-manager/Microsoft.Security/stable/2019-01-01/examples/Alerts/GetAlertsSubscriptionsLocationWithAutoDismissRule_example.json b/specification/security/resource-manager/Microsoft.Security/stable/2019-01-01/examples/Alerts/GetAlertsSubscriptionsLocationWithAutoDismissRule_example.json
new file mode 100644
index 000000000000..3b7698a86967
--- /dev/null
+++ b/specification/security/resource-manager/Microsoft.Security/stable/2019-01-01/examples/Alerts/GetAlertsSubscriptionsLocationWithAutoDismissRule_example.json
@@ -0,0 +1,85 @@
+{
+ "parameters": {
+ "api-version": "2019-01-01",
+ "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23",
+ "ascLocation": "westeurope",
+ "autoDismissRuleName": "dismissThreatIntelligence"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg1/providers/Microsoft.Security/locations/westeurope/alerts/2518770965529163669_F144EE95-A3E5-42DA-A279-967D115809AA",
+ "name": "2518770965529163669_F144EE95-A3E5-42DA-A279-967D115809AA",
+ "type": "Microsoft.Security/Locations/alerts",
+ "properties": {
+ "vendorName": "Microsoft",
+ "alertDisplayName": "Threat Intelligence Alert",
+ "alertName": "ThreatIntelligence",
+ "detectedTimeUtc": "2018-05-01T19:50:47.083633Z",
+ "description": "Process was detected running on the host and is considered to be suspicious, verify that the user run it",
+ "remediationSteps": "verify that the user invoked this process\r\nrun antimalware scan of the VM",
+ "actionTaken": "Detected",
+ "reportedSeverity": "High",
+ "compromisedEntity": "vm1",
+ "associatedResource": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg1/providers/Microsoft.Compute/virtualMachines/vm1",
+ "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23",
+ "instanceId": "f144ee95-a3e5-42da-a279-967d115809aa",
+ "extendedProperties": {
+ "user Name": "administrator",
+ "domain Name": "Contoso",
+ "attacker IP": "192.0.2.1",
+ "resourceType": "Virtual Machine"
+ },
+ "state": "Dismissed",
+ "reportedTimeUtc": "2018-05-02T05:36:12.2089889Z",
+ "confidenceScore": 0.8,
+ "confidenceReasons": [
+ {
+ "type": "User",
+ "reason": "Some user reason"
+ },
+ {
+ "type": "Process",
+ "reason": "Some proccess reason"
+ },
+ {
+ "type": "Computer",
+ "reason": "Some computer reason"
+ }
+ ],
+ "canBeInvestigated": true,
+ "isIncident": false,
+ "entities": [
+ {
+ "address": "192.0.2.1",
+ "location": {
+ "countryCode": "gb",
+ "state": "wokingham",
+ "city": "sonning",
+ "longitude": -0.909,
+ "latitude": 51.468,
+ "asn": 6584
+ },
+ "threatIntelligence": [
+ {
+ "providerName": "Team Cymru",
+ "threatType": "C2",
+ "threatName": "rarog",
+ "confidence": 0.8,
+ "reportLink": "http://www.microsoft.com",
+ "threatDescription": "In bot armies, the controller is the server machine(s) that gives instructions to the controlled (zombied) hosts that connect to the command and control (C2) network. The controller host is usually running a botnet management application that is sending the commands to the zombied members of the bot army. These commands include, but are not limited to, the following: updating bitcoin wallet information, distributed denial-of-service (DDoS) target listings, updated C2 communication contact lists, and targeting data. C2 servers may be either directly controlled by the malware operators or run on hardware compromised by malware. There are multiple techniques for dynamically changing the control servers so that they are not isolated and brought down. Control servers utilize two general architectures: client-server and peer-to-peer. In a client-server model, all the hosts are controlled by a single server or a few control servers. In a peer-to-peer model, the infected hosts are both clients and servers, and they control other hosts so that instead of isolating the few control servers, all the hosts need to be removed."
+ }
+ ],
+ "type": "ip"
+ }
+ ],
+ "correlationKey": "Rkso6LFWxzCll5tqrk4hnrBJ+MY1BX806W6q6+0s9Jk="
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/security/resource-manager/Microsoft.Security/stable/2019-01-01/examples/Settings/GetSetting_example.json b/specification/security/resource-manager/Microsoft.Security/stable/2019-01-01/examples/Settings/GetSetting_example.json
index 31c7b88df1db..808d5e9e47c4 100644
--- a/specification/security/resource-manager/Microsoft.Security/stable/2019-01-01/examples/Settings/GetSetting_example.json
+++ b/specification/security/resource-manager/Microsoft.Security/stable/2019-01-01/examples/Settings/GetSetting_example.json
@@ -9,7 +9,7 @@
"body": {
"id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/settings/MCAS",
"name": "MCAS",
- "kind": "DataExportSetting",
+ "kind": "DataExportSettings",
"type": "Microsoft.Security/settings",
"properties": {
"enabled": true
diff --git a/specification/security/resource-manager/Microsoft.Security/stable/2019-01-01/examples/Settings/GetSettings_example.json b/specification/security/resource-manager/Microsoft.Security/stable/2019-01-01/examples/Settings/GetSettings_example.json
index 87d7aa5a6c58..4def4e3f66c6 100644
--- a/specification/security/resource-manager/Microsoft.Security/stable/2019-01-01/examples/Settings/GetSettings_example.json
+++ b/specification/security/resource-manager/Microsoft.Security/stable/2019-01-01/examples/Settings/GetSettings_example.json
@@ -10,7 +10,7 @@
{
"id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/settings/MCAS",
"name": "MCAS",
- "kind": "DataExportSetting",
+ "kind": "DataExportSettings",
"type": "Microsoft.Security/settings",
"properties": {
"enabled": true
@@ -19,7 +19,7 @@
{
"id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/settings/WDATP",
"name": "WDATP",
- "kind": "DataExportSetting",
+ "kind": "DataExportSettings",
"type": "Microsoft.Security/settings",
"properties": {
"enabled": false
diff --git a/specification/security/resource-manager/Microsoft.Security/stable/2019-01-01/examples/Settings/UpdateSetting_example.json b/specification/security/resource-manager/Microsoft.Security/stable/2019-01-01/examples/Settings/UpdateSetting_example.json
index 789ebb7d6219..f0f251081910 100644
--- a/specification/security/resource-manager/Microsoft.Security/stable/2019-01-01/examples/Settings/UpdateSetting_example.json
+++ b/specification/security/resource-manager/Microsoft.Security/stable/2019-01-01/examples/Settings/UpdateSetting_example.json
@@ -4,10 +4,7 @@
"subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23",
"settingName": "MCAS",
"setting": {
- "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/settings/MCAS",
- "name": "MCAS",
- "kind": "DataExportSetting",
- "type": "Microsoft.Security/settings",
+ "kind": "DataExportSettings",
"properties": {
"enabled": true
}
@@ -18,7 +15,7 @@
"body": {
"id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/settings/MCAS",
"name": "MCAS",
- "kind": "DataExportSetting",
+ "kind": "DataExportSettings",
"type": "Microsoft.Security/settings",
"properties": {
"enabled": true
diff --git a/specification/security/resource-manager/Microsoft.Security/stable/2019-01-01/settings.json b/specification/security/resource-manager/Microsoft.Security/stable/2019-01-01/settings.json
index 15e9f74f8d87..e408c16ecaa8 100644
--- a/specification/security/resource-manager/Microsoft.Security/stable/2019-01-01/settings.json
+++ b/specification/security/resource-manager/Microsoft.Security/stable/2019-01-01/settings.json
@@ -175,7 +175,6 @@
"Setting": {
"type": "object",
"description": "Represents a security setting in Azure Security Center.",
- "discriminator": "kind",
"properties": {},
"allOf": [
{
@@ -183,10 +182,9 @@
}
]
},
- "DataExportSetting": {
+ "DataExportSettings": {
"type": "object",
"description": "Represents a data export setting",
- "x-ms-discriminator-value": "DataExportSetting",
"properties": {
"properties": {
"x-ms-client-flatten": true,
@@ -198,7 +196,8 @@
{
"$ref": "#/definitions/Setting"
}
- ]
+ ],
+ "x-ms-discriminator-value": "DataExportSettings"
},
"SettingResource": {
"type": "object",
@@ -206,9 +205,9 @@
"properties": {
"kind": {
"type": "string",
- "description": "the kind of the settings string (DataExportSetting)",
+ "description": "the kind of the settings string (DataExportSettings)",
"enum": [
- "DataExportSetting",
+ "DataExportSettings",
"AlertSuppressionSetting"
],
"x-ms-enum": {
@@ -216,7 +215,7 @@
"modelAsString": true,
"values": [
{
- "value": "DataExportSetting"
+ "value": "DataExportSettings"
},
{
"value": "AlertSuppressionSetting"
@@ -225,6 +224,7 @@
}
}
},
+ "discriminator": "kind",
"required": [
"kind"
],
diff --git a/specification/security/resource-manager/Microsoft.Security/stable/2019-08-01/iotSecuritySolutions.json b/specification/security/resource-manager/Microsoft.Security/stable/2019-08-01/iotSecuritySolutions.json
index 347b29d179dd..8ff974f8c864 100644
--- a/specification/security/resource-manager/Microsoft.Security/stable/2019-08-01/iotSecuritySolutions.json
+++ b/specification/security/resource-manager/Microsoft.Security/stable/2019-08-01/iotSecuritySolutions.json
@@ -482,7 +482,6 @@
},
"required": [
"iotHubs",
- "workspace",
"displayName"
]
},
diff --git a/specification/security/resource-manager/Microsoft.Security/stable/2020-01-01/discoveredSecuritySolutions.json b/specification/security/resource-manager/Microsoft.Security/stable/2020-01-01/discoveredSecuritySolutions.json
new file mode 100644
index 000000000000..ea7a8b9984c1
--- /dev/null
+++ b/specification/security/resource-manager/Microsoft.Security/stable/2020-01-01/discoveredSecuritySolutions.json
@@ -0,0 +1,263 @@
+{
+ "swagger": "2.0",
+ "info": {
+ "title": "Security Center",
+ "description": "API spec for Microsoft.Security (Azure Security Center) resource provider",
+ "version": "2020-01-01"
+ },
+ "host": "management.azure.com",
+ "schemes": [
+ "https"
+ ],
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "security": [
+ {
+ "azure_auth": [
+ "user_impersonation"
+ ]
+ }
+ ],
+ "securityDefinitions": {
+ "azure_auth": {
+ "type": "oauth2",
+ "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize",
+ "flow": "implicit",
+ "description": "Azure Active Directory OAuth2 Flow",
+ "scopes": {
+ "user_impersonation": "impersonate your user account"
+ }
+ }
+ },
+ "paths": {
+ "/subscriptions/{subscriptionId}/providers/Microsoft.Security/discoveredSecuritySolutions": {
+ "get": {
+ "x-ms-examples": {
+ "Get discovered security solutions": {
+ "$ref": "./examples/DiscoveredSecuritySolutions/GetDiscoveredSecuritySolutionsSubscription_example.json"
+ }
+ },
+ "tags": [
+ "DiscoveredSecuritySolutions"
+ ],
+ "description": "Gets a list of discovered Security Solutions for the subscription.",
+ "operationId": "DiscoveredSecuritySolutions_List",
+ "parameters": [
+ {
+ "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId"
+ },
+ {
+ "$ref": "../../../common/v1/types.json#/parameters/ApiVersion"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/DiscoveredSecuritySolutionList"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common/v1/types.json#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/providers/Microsoft.Security/locations/{ascLocation}/discoveredSecuritySolutions": {
+ "get": {
+ "x-ms-examples": {
+ "Get discovered security solutions from a security data location": {
+ "$ref": "./examples/DiscoveredSecuritySolutions/GetDiscoveredSecuritySolutionsSubscriptionLocation_example.json"
+ }
+ },
+ "tags": [
+ "DiscoveredSecuritySolutions"
+ ],
+ "description": "Gets a list of discovered Security Solutions for the subscription and location.",
+ "operationId": "DiscoveredSecuritySolutions_ListByHomeRegion",
+ "parameters": [
+ {
+ "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId"
+ },
+ {
+ "$ref": "../../../common/v1/types.json#/parameters/AscLocation"
+ },
+ {
+ "$ref": "../../../common/v1/types.json#/parameters/ApiVersion"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/DiscoveredSecuritySolutionList"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common/v1/types.json#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/locations/{ascLocation}/discoveredSecuritySolutions/{discoveredSecuritySolutionName}": {
+ "get": {
+ "x-ms-examples": {
+ "Get discovered security solution from a security data location": {
+ "$ref": "./examples/DiscoveredSecuritySolutions/GetDiscoveredSecuritySolutionResourceGroupLocation_example.json"
+ }
+ },
+ "tags": [
+ "DiscoveredSecuritySolutions"
+ ],
+ "description": "Gets a specific discovered Security Solution.",
+ "operationId": "DiscoveredSecuritySolutions_Get",
+ "parameters": [
+ {
+ "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId"
+ },
+ {
+ "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupName"
+ },
+ {
+ "$ref": "../../../common/v1/types.json#/parameters/AscLocation"
+ },
+ {
+ "$ref": "#/parameters/DiscoveredSecuritySolutionName"
+ },
+ {
+ "$ref": "../../../common/v1/types.json#/parameters/ApiVersion"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/DiscoveredSecuritySolution"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common/v1/types.json#/definitions/CloudError"
+ }
+ }
+ }
+ }
+ }
+ },
+ "definitions": {
+ "DiscoveredSecuritySolutionList": {
+ "type": "object",
+ "properties": {
+ "value": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/DiscoveredSecuritySolution"
+ }
+ },
+ "nextLink": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The URI to fetch the next page."
+ }
+ }
+ },
+ "DiscoveredSecuritySolution": {
+ "type": "object",
+ "properties": {
+ "properties": {
+ "x-ms-client-flatten": true,
+ "$ref": "#/definitions/DiscoveredSecuritySolutionProperties"
+ }
+ },
+ "required": [
+ "properties"
+ ],
+ "allOf": [
+ {
+ "$ref": "../../../common/v1/types.json#/definitions/Resource"
+ },
+ {
+ "$ref": "../../../common/v1/types.json#/definitions/Location"
+ }
+ ]
+ },
+ "DiscoveredSecuritySolutionProperties": {
+ "type": "object",
+ "properties": {
+ "securityFamily": {
+ "type": "string",
+ "description": "The security family of the discovered solution",
+ "enum": [
+ "Waf",
+ "Ngfw",
+ "SaasWaf",
+ "Va"
+ ],
+ "x-ms-enum": {
+ "name": "securityFamily",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "Waf"
+ },
+ {
+ "value": "Ngfw"
+ },
+ {
+ "value": "SaasWaf"
+ },
+ {
+ "value": "Va"
+ }
+ ]
+ }
+ },
+ "offer": {
+ "type": "string",
+ "description": "The security solutions' image offer"
+ },
+ "publisher": {
+ "type": "string",
+ "description": "The security solutions' image publisher"
+ },
+ "sku": {
+ "type": "string",
+ "description": "The security solutions' image sku"
+ }
+ },
+ "required": [
+ "securityFamily",
+ "offer",
+ "publisher",
+ "sku"
+ ]
+ }
+ },
+ "parameters": {
+ "DiscoveredSecuritySolutionName": {
+ "name": "discoveredSecuritySolutionName",
+ "type": "string",
+ "in": "path",
+ "required": true,
+ "description": "Name of a discovered security solution.",
+ "x-ms-parameter-location": "method"
+ }
+ }
+}
diff --git a/specification/security/resource-manager/Microsoft.Security/stable/2020-01-01/examples/DiscoveredSecuritySolutions/GetDiscoveredSecuritySolutionResourceGroupLocation_example.json b/specification/security/resource-manager/Microsoft.Security/stable/2020-01-01/examples/DiscoveredSecuritySolutions/GetDiscoveredSecuritySolutionResourceGroupLocation_example.json
new file mode 100644
index 000000000000..7fdd44705361
--- /dev/null
+++ b/specification/security/resource-manager/Microsoft.Security/stable/2020-01-01/examples/DiscoveredSecuritySolutions/GetDiscoveredSecuritySolutionResourceGroupLocation_example.json
@@ -0,0 +1,25 @@
+{
+ "parameters": {
+ "api-version": "2020-01-01",
+ "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23",
+ "resourceGroupName": "myRg2",
+ "ascLocation": "centralus",
+ "discoveredSecuritySolutionName": "paloalto7"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "properties": {
+ "securityFamily": "Ngfw",
+ "offer": "vmseries1",
+ "publisher": "paloaltonetworks",
+ "sku": "byol"
+ },
+ "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg2/providers/Microsoft.Security/locations/centralus/discoveredSecuritySolutions/paloalto7",
+ "name": "paloalto7",
+ "type": "Microsoft.Security/locations/discoveredSecuritySolutions",
+ "location": "eastus2"
+ }
+ }
+ }
+}
diff --git a/specification/security/resource-manager/Microsoft.Security/stable/2020-01-01/examples/DiscoveredSecuritySolutions/GetDiscoveredSecuritySolutionsSubscriptionLocation_example.json b/specification/security/resource-manager/Microsoft.Security/stable/2020-01-01/examples/DiscoveredSecuritySolutions/GetDiscoveredSecuritySolutionsSubscriptionLocation_example.json
new file mode 100644
index 000000000000..dd0249b47d48
--- /dev/null
+++ b/specification/security/resource-manager/Microsoft.Security/stable/2020-01-01/examples/DiscoveredSecuritySolutions/GetDiscoveredSecuritySolutionsSubscriptionLocation_example.json
@@ -0,0 +1,39 @@
+{
+ "parameters": {
+ "api-version": "2020-01-01",
+ "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23",
+ "ascLocation": "centralus"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "properties": {
+ "securityFamily": "Ngfw",
+ "offer": "cisco-asav",
+ "publisher": "cisco",
+ "sku": "asav-azure-byol"
+ },
+ "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg1/providers/Microsoft.Security/locations/centralus/discoveredSecuritySolutions/CP",
+ "name": "CP",
+ "type": "Microsoft.Security/locations/discoveredSecuritySolutions",
+ "location": "eastus"
+ },
+ {
+ "properties": {
+ "securityFamily": "Ngfw",
+ "offer": "vmseries1",
+ "publisher": "paloaltonetworks",
+ "sku": "byol"
+ },
+ "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg2/providers/Microsoft.Security/locations/centralus/discoveredSecuritySolutions/paloalto7",
+ "name": "paloalto7",
+ "type": "Microsoft.Security/locations/discoveredSecuritySolutions",
+ "location": "eastus2"
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/security/resource-manager/Microsoft.Security/stable/2020-01-01/examples/DiscoveredSecuritySolutions/GetDiscoveredSecuritySolutionsSubscription_example.json b/specification/security/resource-manager/Microsoft.Security/stable/2020-01-01/examples/DiscoveredSecuritySolutions/GetDiscoveredSecuritySolutionsSubscription_example.json
new file mode 100644
index 000000000000..d629d7ab5bfd
--- /dev/null
+++ b/specification/security/resource-manager/Microsoft.Security/stable/2020-01-01/examples/DiscoveredSecuritySolutions/GetDiscoveredSecuritySolutionsSubscription_example.json
@@ -0,0 +1,38 @@
+{
+ "parameters": {
+ "api-version": "2020-01-01",
+ "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "properties": {
+ "securityFamily": "Ngfw",
+ "offer": "cisco-asav",
+ "publisher": "cisco",
+ "sku": "asav-azure-byol"
+ },
+ "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg1/providers/Microsoft.Security/locations/centralus/discoveredSecuritySolutions/CP",
+ "name": "CP",
+ "type": "Microsoft.Security/locations/discoveredSecuritySolutions",
+ "location": "eastus"
+ },
+ {
+ "properties": {
+ "securityFamily": "Ngfw",
+ "offer": "vmseries1",
+ "publisher": "paloaltonetworks",
+ "sku": "byol"
+ },
+ "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg2/providers/Microsoft.Security/locations/centralus/discoveredSecuritySolutions/paloalto7",
+ "name": "paloalto7",
+ "type": "Microsoft.Security/locations/discoveredSecuritySolutions",
+ "location": "eastus2"
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/security/resource-manager/Microsoft.Security/stable/2020-01-01/examples/ExternalSecuritySolutions/GetExternalSecuritySolution_example.json b/specification/security/resource-manager/Microsoft.Security/stable/2020-01-01/examples/ExternalSecuritySolutions/GetExternalSecuritySolution_example.json
new file mode 100644
index 000000000000..063a365fcdf0
--- /dev/null
+++ b/specification/security/resource-manager/Microsoft.Security/stable/2020-01-01/examples/ExternalSecuritySolutions/GetExternalSecuritySolution_example.json
@@ -0,0 +1,28 @@
+{
+ "parameters": {
+ "api-version": "2020-01-01",
+ "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23",
+ "resourceGroupName": "defaultresourcegroup-eus",
+ "ascLocation": "centralus",
+ "externalSecuritySolutionsName": "aad_defaultworkspace-20ff7fc3-e762-44dd-bd96-b71116dcdc23-eus"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "kind": "AAD",
+ "properties": {
+ "connectivityState": "Discovered",
+ "deviceVendor": "Microsoft",
+ "deviceType": "Azure Active Directory Identity Protection",
+ "workspace": {
+ "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourcegroups/defaultresourcegroup-eus/providers/Microsoft.OperationalInsights/workspaces/defaultworkspace-20ff7fc3-e762-44dd-bd96-b71116dcdc23-eus"
+ }
+ },
+ "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/defaultresourcegroup-eus/providers/Microsoft.Security/locations/centralus/externalSecuritySolutions/aad_defaultworkspace-20ff7fc3-e762-44dd-bd96-b71116dcdc23-eus",
+ "name": "aad_defaultworkspace-20ff7fc3-e762-44dd-bd96-b71116dcdc23-eus",
+ "type": "Microsoft.Security/locations/externalSecuritySolutions",
+ "location": "eastus"
+ }
+ }
+ }
+}
diff --git a/specification/security/resource-manager/Microsoft.Security/stable/2020-01-01/examples/ExternalSecuritySolutions/GetExternalSecuritySolutionsSubscriptionLocation_example.json b/specification/security/resource-manager/Microsoft.Security/stable/2020-01-01/examples/ExternalSecuritySolutions/GetExternalSecuritySolutionsSubscriptionLocation_example.json
new file mode 100644
index 000000000000..26626803e57d
--- /dev/null
+++ b/specification/security/resource-manager/Microsoft.Security/stable/2020-01-01/examples/ExternalSecuritySolutions/GetExternalSecuritySolutionsSubscriptionLocation_example.json
@@ -0,0 +1,123 @@
+{
+ "parameters": {
+ "api-version": "2020-01-01",
+ "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23",
+ "ascLocation": "centralus"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "kind": "AAD",
+ "properties": {
+ "connectivityState": "Discovered",
+ "deviceVendor": "Microsoft",
+ "deviceType": "Azure Active Directory Identity Protection",
+ "workspace": {
+ "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourcegroups/defaultresourcegroup-eus/providers/Microsoft.OperationalInsights/workspaces/defaultworkspace-20ff7fc3-e762-44dd-bd96-b71116dcdc23-eus"
+ }
+ },
+ "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/defaultresourcegroup-eus/providers/Microsoft.Security/locations/centralus/externalSecuritySolutions/aad_defaultworkspace-20ff7fc3-e762-44dd-bd96-b71116dcdc23-eus",
+ "name": "aad_defaultworkspace-20ff7fc3-e762-44dd-bd96-b71116dcdc23-eus",
+ "type": "Microsoft.Security/locations/externalSecuritySolutions",
+ "location": "eastus"
+ },
+ {
+ "kind": "AAD",
+ "properties": {
+ "connectivityState": "Discovered",
+ "deviceVendor": "Microsoft",
+ "deviceType": "Azure Active Directory Identity Protection",
+ "workspace": {
+ "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourcegroups/defaultresourcegroup-weu/providers/Microsoft.OperationalInsights/workspaces/defaultworkspace-20ff7fc3-e762-44dd-bd96-b71116dcdc23-weu"
+ }
+ },
+ "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/defaultresourcegroup-weu/providers/Microsoft.Security/locations/centralus/externalSecuritySolutions/aad_defaultworkspace-20ff7fc3-e762-44dd-bd96-b71116dcdc23-weu",
+ "name": "aad_defaultworkspace-20ff7fc3-e762-44dd-bd96-b71116dcdc23-weu",
+ "type": "Microsoft.Security/locations/externalSecuritySolutions",
+ "location": "westeurope"
+ },
+ {
+ "kind": "CEF",
+ "properties": {
+ "lastEventReceived": "2018-05-09T10:30:11.523Z",
+ "hostname": "barracuda",
+ "deviceVendor": "barracudanetworks",
+ "deviceType": "WAF",
+ "workspace": {
+ "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourcegroups/unificationprod/providers/Microsoft.OperationalInsights/workspaces/omsprd"
+ }
+ },
+ "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/unificationprod/providers/Microsoft.Security/locations/centralus/externalSecuritySolutions/cef_omsprd_barracudanetworks_waf_barracuda",
+ "name": "cef_omsprd_barracudanetworks_waf_barracuda",
+ "type": "Microsoft.Security/locations/externalSecuritySolutions",
+ "location": "westcentralus"
+ },
+ {
+ "kind": "CEF",
+ "properties": {
+ "lastEventReceived": "2018-05-08T15:42:22.57Z",
+ "hostname": "demovm20",
+ "deviceVendor": "virtualHoneypot",
+ "deviceType": "Microsoft",
+ "workspace": {
+ "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourcegroups/unificationprod/providers/Microsoft.OperationalInsights/workspaces/omsprd"
+ }
+ },
+ "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/unificationprod/providers/Microsoft.Security/locations/centralus/externalSecuritySolutions/cef_omsprd_virtualhoneypot_Microsoft_demovm20",
+ "name": "cef_omsprd_virtualhoneypot_Microsoft_demovm20",
+ "type": "Microsoft.Security/locations/externalSecuritySolutions",
+ "location": "westcentralus"
+ },
+ {
+ "kind": "CEF",
+ "properties": {
+ "lastEventReceived": "2018-05-08T10:38:53.423Z",
+ "hostname": "demovm10",
+ "deviceVendor": "virtualHoneypot",
+ "deviceType": "Microsoft",
+ "workspace": {
+ "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourcegroups/unificationprod/providers/Microsoft.OperationalInsights/workspaces/omsprd"
+ }
+ },
+ "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/unificationprod/providers/Microsoft.Security/locations/centralus/externalSecuritySolutions/cef_omsprd_virtualhoneypot_Microsoft_demovm10",
+ "name": "cef_omsprd_virtualhoneypot_Microsoft_demovm10",
+ "type": "Microsoft.Security/locations/externalSecuritySolutions",
+ "location": "westcentralus"
+ },
+ {
+ "kind": "AAD",
+ "properties": {
+ "connectivityState": "Discovered",
+ "deviceVendor": "Microsoft",
+ "deviceType": "Azure Active Directory Identity Protection",
+ "workspace": {
+ "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourcegroups/unificationprod/providers/Microsoft.OperationalInsights/workspaces/omsprd"
+ }
+ },
+ "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/unificationprod/providers/Microsoft.Security/locations/centralus/externalSecuritySolutions/aad_omsprd",
+ "name": "aad_omsprd",
+ "type": "Microsoft.Security/locations/externalSecuritySolutions",
+ "location": "westcentralus"
+ },
+ {
+ "kind": "AAD",
+ "properties": {
+ "connectivityState": "Discovered",
+ "deviceVendor": "Microsoft",
+ "deviceType": "Azure Active Directory Identity Protection",
+ "workspace": {
+ "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourcegroups/defaultresourcegroup-ejp/providers/Microsoft.OperationalInsights/workspaces/defaultworkspace-20ff7fc3-e762-44dd-bd96-b71116dcdc23-ejp"
+ }
+ },
+ "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/defaultresourcegroup-ejp/providers/Microsoft.Security/locations/centralus/externalSecuritySolutions/aad_defaultworkspace-20ff7fc3-e762-44dd-bd96-b71116dcdc23-ejp",
+ "name": "aad_defaultworkspace-20ff7fc3-e762-44dd-bd96-b71116dcdc23-ejp",
+ "type": "Microsoft.Security/locations/externalSecuritySolutions",
+ "location": "japaneast"
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/security/resource-manager/Microsoft.Security/stable/2020-01-01/examples/ExternalSecuritySolutions/GetExternalSecuritySolutionsSubscription_example.json b/specification/security/resource-manager/Microsoft.Security/stable/2020-01-01/examples/ExternalSecuritySolutions/GetExternalSecuritySolutionsSubscription_example.json
new file mode 100644
index 000000000000..90c72216fc02
--- /dev/null
+++ b/specification/security/resource-manager/Microsoft.Security/stable/2020-01-01/examples/ExternalSecuritySolutions/GetExternalSecuritySolutionsSubscription_example.json
@@ -0,0 +1,122 @@
+{
+ "parameters": {
+ "api-version": "2020-01-01",
+ "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "kind": "AAD",
+ "properties": {
+ "connectivityState": "Discovered",
+ "deviceVendor": "Microsoft",
+ "deviceType": "Azure Active Directory Identity Protection",
+ "workspace": {
+ "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourcegroups/defaultresourcegroup-eus/providers/Microsoft.OperationalInsights/workspaces/defaultworkspace-20ff7fc3-e762-44dd-bd96-b71116dcdc23-eus"
+ }
+ },
+ "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/defaultresourcegroup-eus/providers/Microsoft.Security/locations/centralus/externalSecuritySolutions/aad_defaultworkspace-20ff7fc3-e762-44dd-bd96-b71116dcdc23-eus",
+ "name": "aad_defaultworkspace-20ff7fc3-e762-44dd-bd96-b71116dcdc23-eus",
+ "type": "Microsoft.Security/locations/externalSecuritySolutions",
+ "location": "eastus"
+ },
+ {
+ "kind": "AAD",
+ "properties": {
+ "connectivityState": "Discovered",
+ "deviceVendor": "Microsoft",
+ "deviceType": "Azure Active Directory Identity Protection",
+ "workspace": {
+ "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourcegroups/defaultresourcegroup-weu/providers/Microsoft.OperationalInsights/workspaces/defaultworkspace-20ff7fc3-e762-44dd-bd96-b71116dcdc23-weu"
+ }
+ },
+ "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/defaultresourcegroup-weu/providers/Microsoft.Security/locations/centralus/externalSecuritySolutions/aad_defaultworkspace-20ff7fc3-e762-44dd-bd96-b71116dcdc23-weu",
+ "name": "aad_defaultworkspace-20ff7fc3-e762-44dd-bd96-b71116dcdc23-weu",
+ "type": "Microsoft.Security/locations/externalSecuritySolutions",
+ "location": "westeurope"
+ },
+ {
+ "kind": "CEF",
+ "properties": {
+ "lastEventReceived": "2018-05-09T10:30:11.523Z",
+ "hostname": "barracuda",
+ "deviceVendor": "barracudanetworks",
+ "deviceType": "WAF",
+ "workspace": {
+ "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourcegroups/unificationprod/providers/Microsoft.OperationalInsights/workspaces/omsprd"
+ }
+ },
+ "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/unificationprod/providers/Microsoft.Security/locations/centralus/externalSecuritySolutions/cef_omsprd_barracudanetworks_waf_barracuda",
+ "name": "cef_omsprd_barracudanetworks_waf_barracuda",
+ "type": "Microsoft.Security/locations/externalSecuritySolutions",
+ "location": "westcentralus"
+ },
+ {
+ "kind": "CEF",
+ "properties": {
+ "lastEventReceived": "2018-05-08T15:42:22.57Z",
+ "hostname": "demovm20",
+ "deviceVendor": "virtualHoneypot",
+ "deviceType": "Microsoft",
+ "workspace": {
+ "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourcegroups/unificationprod/providers/Microsoft.OperationalInsights/workspaces/omsprd"
+ }
+ },
+ "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/unificationprod/providers/Microsoft.Security/locations/centralus/externalSecuritySolutions/cef_omsprd_virtualhoneypot_Microsoft_demovm20",
+ "name": "cef_omsprd_virtualhoneypot_Microsoft_demovm20",
+ "type": "Microsoft.Security/locations/externalSecuritySolutions",
+ "location": "westcentralus"
+ },
+ {
+ "kind": "CEF",
+ "properties": {
+ "lastEventReceived": "2018-05-08T10:38:53.423Z",
+ "hostname": "demovm10",
+ "deviceVendor": "virtualHoneypot",
+ "deviceType": "Microsoft",
+ "workspace": {
+ "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourcegroups/unificationprod/providers/Microsoft.OperationalInsights/workspaces/omsprd"
+ }
+ },
+ "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/unificationprod/providers/Microsoft.Security/locations/centralus/externalSecuritySolutions/cef_omsprd_virtualhoneypot_Microsoft_demovm10",
+ "name": "cef_omsprd_virtualhoneypot_Microsoft_demovm10",
+ "type": "Microsoft.Security/locations/externalSecuritySolutions",
+ "location": "westcentralus"
+ },
+ {
+ "kind": "AAD",
+ "properties": {
+ "connectivityState": "Discovered",
+ "deviceVendor": "Microsoft",
+ "deviceType": "Azure Active Directory Identity Protection",
+ "workspace": {
+ "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourcegroups/unificationprod/providers/Microsoft.OperationalInsights/workspaces/omsprd"
+ }
+ },
+ "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/unificationprod/providers/Microsoft.Security/locations/centralus/externalSecuritySolutions/aad_omsprd",
+ "name": "aad_omsprd",
+ "type": "Microsoft.Security/locations/externalSecuritySolutions",
+ "location": "westcentralus"
+ },
+ {
+ "kind": "AAD",
+ "properties": {
+ "connectivityState": "Discovered",
+ "deviceVendor": "Microsoft",
+ "deviceType": "Azure Active Directory Identity Protection",
+ "workspace": {
+ "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourcegroups/defaultresourcegroup-ejp/providers/Microsoft.OperationalInsights/workspaces/defaultworkspace-20ff7fc3-e762-44dd-bd96-b71116dcdc23-ejp"
+ }
+ },
+ "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/defaultresourcegroup-ejp/providers/Microsoft.Security/locations/centralus/externalSecuritySolutions/aad_defaultworkspace-20ff7fc3-e762-44dd-bd96-b71116dcdc23-ejp",
+ "name": "aad_defaultworkspace-20ff7fc3-e762-44dd-bd96-b71116dcdc23-ejp",
+ "type": "Microsoft.Security/locations/externalSecuritySolutions",
+ "location": "japaneast"
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2019-01-01-preview/examples/ServerVulnerabilityAssessments/CreateServerVulnerabilityAssessments_example.json b/specification/security/resource-manager/Microsoft.Security/stable/2020-01-01/examples/ServerVulnerabilityAssessments/CreateServerVulnerabilityAssessments_example.json
similarity index 96%
rename from specification/security/resource-manager/Microsoft.Security/preview/2019-01-01-preview/examples/ServerVulnerabilityAssessments/CreateServerVulnerabilityAssessments_example.json
rename to specification/security/resource-manager/Microsoft.Security/stable/2020-01-01/examples/ServerVulnerabilityAssessments/CreateServerVulnerabilityAssessments_example.json
index 1bccb5ea5cce..eaed80294950 100644
--- a/specification/security/resource-manager/Microsoft.Security/preview/2019-01-01-preview/examples/ServerVulnerabilityAssessments/CreateServerVulnerabilityAssessments_example.json
+++ b/specification/security/resource-manager/Microsoft.Security/stable/2020-01-01/examples/ServerVulnerabilityAssessments/CreateServerVulnerabilityAssessments_example.json
@@ -1,6 +1,6 @@
{
"parameters": {
- "api-version": "2019-01-01-preview",
+ "api-version": "2020-01-01",
"subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23",
"resourceGroupName": "rg1",
"resourceNamespace": "Microsoft.Compute",
diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2019-01-01-preview/examples/ServerVulnerabilityAssessments/DeleteServerVulnerabilityAssessments_example.json b/specification/security/resource-manager/Microsoft.Security/stable/2020-01-01/examples/ServerVulnerabilityAssessments/DeleteServerVulnerabilityAssessments_example.json
similarity index 88%
rename from specification/security/resource-manager/Microsoft.Security/preview/2019-01-01-preview/examples/ServerVulnerabilityAssessments/DeleteServerVulnerabilityAssessments_example.json
rename to specification/security/resource-manager/Microsoft.Security/stable/2020-01-01/examples/ServerVulnerabilityAssessments/DeleteServerVulnerabilityAssessments_example.json
index ebe431b2e5ae..b47510ee03bc 100644
--- a/specification/security/resource-manager/Microsoft.Security/preview/2019-01-01-preview/examples/ServerVulnerabilityAssessments/DeleteServerVulnerabilityAssessments_example.json
+++ b/specification/security/resource-manager/Microsoft.Security/stable/2020-01-01/examples/ServerVulnerabilityAssessments/DeleteServerVulnerabilityAssessments_example.json
@@ -1,6 +1,6 @@
{
"parameters": {
- "api-version": "2019-01-01-preview",
+ "api-version": "2020-01-01",
"subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23",
"resourceGroupName": "rg1",
"resourceNamespace": "Microsoft.Compute",
diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2019-01-01-preview/examples/ServerVulnerabilityAssessments/GetServerVulnerabilityAssessments_example.json b/specification/security/resource-manager/Microsoft.Security/stable/2020-01-01/examples/ServerVulnerabilityAssessments/GetServerVulnerabilityAssessments_example.json
similarity index 94%
rename from specification/security/resource-manager/Microsoft.Security/preview/2019-01-01-preview/examples/ServerVulnerabilityAssessments/GetServerVulnerabilityAssessments_example.json
rename to specification/security/resource-manager/Microsoft.Security/stable/2020-01-01/examples/ServerVulnerabilityAssessments/GetServerVulnerabilityAssessments_example.json
index aec69b3e88bf..59dddaa785dd 100644
--- a/specification/security/resource-manager/Microsoft.Security/preview/2019-01-01-preview/examples/ServerVulnerabilityAssessments/GetServerVulnerabilityAssessments_example.json
+++ b/specification/security/resource-manager/Microsoft.Security/stable/2020-01-01/examples/ServerVulnerabilityAssessments/GetServerVulnerabilityAssessments_example.json
@@ -1,6 +1,6 @@
{
"parameters": {
- "api-version": "2019-01-01-preview",
+ "api-version": "2020-01-01",
"subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23",
"resourceGroupName": "rg1",
"resourceNamespace": "Microsoft.Compute",
diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2019-01-01-preview/examples/ServerVulnerabilityAssessments/ListByExtendedResourceServerVulnerabilityAssessments_example.json b/specification/security/resource-manager/Microsoft.Security/stable/2020-01-01/examples/ServerVulnerabilityAssessments/ListByExtendedResourceServerVulnerabilityAssessments_example.json
similarity index 94%
rename from specification/security/resource-manager/Microsoft.Security/preview/2019-01-01-preview/examples/ServerVulnerabilityAssessments/ListByExtendedResourceServerVulnerabilityAssessments_example.json
rename to specification/security/resource-manager/Microsoft.Security/stable/2020-01-01/examples/ServerVulnerabilityAssessments/ListByExtendedResourceServerVulnerabilityAssessments_example.json
index d96e15730233..cdf6cd825bdb 100644
--- a/specification/security/resource-manager/Microsoft.Security/preview/2019-01-01-preview/examples/ServerVulnerabilityAssessments/ListByExtendedResourceServerVulnerabilityAssessments_example.json
+++ b/specification/security/resource-manager/Microsoft.Security/stable/2020-01-01/examples/ServerVulnerabilityAssessments/ListByExtendedResourceServerVulnerabilityAssessments_example.json
@@ -1,6 +1,6 @@
{
"parameters": {
- "api-version": "2019-01-01-preview",
+ "api-version": "2020-01-01",
"subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23",
"resourceGroupName": "rg1",
"resourceNamespace": "Microsoft.Compute",
diff --git a/specification/security/resource-manager/Microsoft.Security/stable/2020-01-01/externalSecuritySolutions.json b/specification/security/resource-manager/Microsoft.Security/stable/2020-01-01/externalSecuritySolutions.json
new file mode 100644
index 000000000000..3b8b3b072232
--- /dev/null
+++ b/specification/security/resource-manager/Microsoft.Security/stable/2020-01-01/externalSecuritySolutions.json
@@ -0,0 +1,388 @@
+{
+ "swagger": "2.0",
+ "info": {
+ "title": "Security Center",
+ "description": "API spec for Microsoft.Security (Azure Security Center) resource provider",
+ "version": "2020-01-01"
+ },
+ "host": "management.azure.com",
+ "schemes": [
+ "https"
+ ],
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "security": [
+ {
+ "azure_auth": [
+ "user_impersonation"
+ ]
+ }
+ ],
+ "securityDefinitions": {
+ "azure_auth": {
+ "type": "oauth2",
+ "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize",
+ "flow": "implicit",
+ "description": "Azure Active Directory OAuth2 Flow",
+ "scopes": {
+ "user_impersonation": "impersonate your user account"
+ }
+ }
+ },
+ "paths": {
+ "/subscriptions/{subscriptionId}/providers/Microsoft.Security/externalSecuritySolutions": {
+ "get": {
+ "x-ms-examples": {
+ "Get external security solutions on a subscription": {
+ "$ref": "./examples/ExternalSecuritySolutions/GetExternalSecuritySolutionsSubscription_example.json"
+ }
+ },
+ "description": "Gets a list of external security solutions for the subscription.",
+ "tags": [
+ "ExternalSecuritySolutions"
+ ],
+ "operationId": "ExternalSecuritySolutions_List",
+ "parameters": [
+ {
+ "$ref": "../../../common/v1/types.json#/parameters/ApiVersion"
+ },
+ {
+ "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/ExternalSecuritySolutionList"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common/v1/types.json#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/providers/Microsoft.Security/locations/{ascLocation}/ExternalSecuritySolutions": {
+ "get": {
+ "x-ms-examples": {
+ "Get external security solutions on a subscription from security data location": {
+ "$ref": "./examples/ExternalSecuritySolutions/GetExternalSecuritySolutionsSubscriptionLocation_example.json"
+ }
+ },
+ "description": "Gets a list of external Security Solutions for the subscription and location.",
+ "tags": [
+ "ExternalSecuritySolutions"
+ ],
+ "operationId": "ExternalSecuritySolutions_ListByHomeRegion",
+ "parameters": [
+ {
+ "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId"
+ },
+ {
+ "$ref": "../../../common/v1/types.json#/parameters/AscLocation"
+ },
+ {
+ "$ref": "../../../common/v1/types.json#/parameters/ApiVersion"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/ExternalSecuritySolutionList"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common/v1/types.json#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/locations/{ascLocation}/ExternalSecuritySolutions/{externalSecuritySolutionsName}": {
+ "get": {
+ "x-ms-examples": {
+ "Get external security solution": {
+ "$ref": "./examples/ExternalSecuritySolutions/GetExternalSecuritySolution_example.json"
+ }
+ },
+ "description": "Gets a specific external Security Solution.",
+ "tags": [
+ "ExternalSecuritySolutions"
+ ],
+ "operationId": "ExternalSecuritySolutions_Get",
+ "parameters": [
+ {
+ "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId"
+ },
+ {
+ "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupName"
+ },
+ {
+ "$ref": "../../../common/v1/types.json#/parameters/AscLocation"
+ },
+ {
+ "$ref": "#/parameters/ExternalSecuritySolutionsName"
+ },
+ {
+ "$ref": "../../../common/v1/types.json#/parameters/ApiVersion"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/ExternalSecuritySolution"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common/v1/types.json#/definitions/CloudError"
+ }
+ }
+ }
+ }
+ }
+ },
+ "definitions": {
+ "ExternalSecuritySolutionList": {
+ "properties": {
+ "value": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ExternalSecuritySolution"
+ }
+ },
+ "nextLink": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The URI to fetch the next page."
+ }
+ }
+ },
+ "ExternalSecuritySolution": {
+ "type": "object",
+ "description": "Represents a security solution external to Azure Security Center which sends information to an OMS workspace and whose data is displayed by Azure Security Center.",
+ "required": [
+ "kind"
+ ],
+ "discriminator": "kind",
+ "properties": {},
+ "allOf": [
+ {
+ "$ref": "../../../common/v1/types.json#/definitions/Resource"
+ },
+ {
+ "$ref": "#/definitions/ExternalSecuritySolutionKind"
+ },
+ {
+ "$ref": "../../../common/v1/types.json#/definitions/Location"
+ }
+ ]
+ },
+ "CefExternalSecuritySolution": {
+ "x-ms-discriminator-value": "CEF",
+ "type": "object",
+ "description": "Represents a security solution which sends CEF logs to an OMS workspace",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ExternalSecuritySolution"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/CefSolutionProperties"
+ }
+ }
+ },
+ "AtaExternalSecuritySolution": {
+ "x-ms-discriminator-value": "ATA",
+ "type": "object",
+ "description": "Represents an ATA security solution which sends logs to an OMS workspace",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ExternalSecuritySolution"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/AtaSolutionProperties"
+ }
+ }
+ },
+ "AadExternalSecuritySolution": {
+ "x-ms-discriminator-value": "AAD",
+ "type": "object",
+ "description": "Represents an AAD identity protection solution which sends logs to an OMS workspace.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ExternalSecuritySolution"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/AadSolutionProperties"
+ }
+ }
+ },
+ "ExternalSecuritySolutionKind": {
+ "type": "object",
+ "description": "Describes an Azure resource with kind",
+ "properties": {
+ "kind": {
+ "type": "string",
+ "description": "The kind of the external solution",
+ "enum": [
+ "CEF",
+ "ATA",
+ "AAD"
+ ],
+ "x-ms-enum": {
+ "name": "ExternalSecuritySolutionKind",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "CEF"
+ },
+ {
+ "value": "ATA"
+ },
+ {
+ "value": "AAD"
+ }
+ ]
+ }
+ }
+ }
+ },
+ "ExternalSecuritySolutionProperties": {
+ "type": "object",
+ "description": "The solution properties (correspond to the solution kind)",
+ "additionalProperties": true,
+ "properties": {
+ "deviceVendor": {
+ "type": "string"
+ },
+ "deviceType": {
+ "type": "string"
+ },
+ "workspace": {
+ "$ref": "#/definitions/ConnectedWorkspace"
+ }
+ }
+ },
+ "ConnectedWorkspace": {
+ "type": "object",
+ "title": "Represents an OMS workspace to which the solution is connected",
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "Azure resource ID of the connected OMS workspace"
+ }
+ }
+ },
+ "AadConnectivityState": {
+ "type": "object",
+ "description": "Describes an Azure resource with kind",
+ "properties": {
+ "connectivityState": {
+ "type": "string",
+ "title": "The connectivity state of the external AAD solution ",
+ "enum": [
+ "Discovered",
+ "NotLicensed",
+ "Connected"
+ ],
+ "x-ms-enum": {
+ "name": "AadConnectivityState",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "Discovered"
+ },
+ {
+ "value": "NotLicensed"
+ },
+ {
+ "value": "Connected"
+ }
+ ]
+ }
+ }
+ }
+ },
+ "AadSolutionProperties": {
+ "type": "object",
+ "title": "The external security solution properties for AAD solutions",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ExternalSecuritySolutionProperties"
+ },
+ {
+ "$ref": "#/definitions/AadConnectivityState"
+ }
+ ]
+ },
+ "CefSolutionProperties": {
+ "type": "object",
+ "title": "The external security solution properties for CEF solutions",
+ "properties": {
+ "hostname": {
+ "type": "string"
+ },
+ "agent": {
+ "type": "string"
+ },
+ "lastEventReceived": {
+ "type": "string"
+ }
+ },
+ "allOf": [
+ {
+ "$ref": "#/definitions/ExternalSecuritySolutionProperties"
+ }
+ ]
+ },
+ "AtaSolutionProperties": {
+ "type": "object",
+ "title": "The external security solution properties for ATA solutions",
+ "properties": {
+ "lastEventReceived": {
+ "type": "string"
+ }
+ },
+ "allOf": [
+ {
+ "$ref": "#/definitions/ExternalSecuritySolutionProperties"
+ }
+ ]
+ }
+ },
+ "parameters": {
+ "ExternalSecuritySolutionsName": {
+ "name": "externalSecuritySolutionsName",
+ "in": "path",
+ "description": "Name of an external security solution.",
+ "required": true,
+ "type": "string",
+ "x-ms-parameter-location": "method"
+ }
+ }
+}
diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2019-01-01-preview/serverVulnerabilityAssessments.json b/specification/security/resource-manager/Microsoft.Security/stable/2020-01-01/serverVulnerabilityAssessments.json
similarity index 99%
rename from specification/security/resource-manager/Microsoft.Security/preview/2019-01-01-preview/serverVulnerabilityAssessments.json
rename to specification/security/resource-manager/Microsoft.Security/stable/2020-01-01/serverVulnerabilityAssessments.json
index 534a37477127..d21a7bca94c7 100644
--- a/specification/security/resource-manager/Microsoft.Security/preview/2019-01-01-preview/serverVulnerabilityAssessments.json
+++ b/specification/security/resource-manager/Microsoft.Security/stable/2020-01-01/serverVulnerabilityAssessments.json
@@ -3,7 +3,7 @@
"info": {
"title": "Security Center",
"description": "API spec for Microsoft.Security (Azure Security Center) resource provider",
- "version": "2019-01-01-preview"
+ "version": "2020-01-01"
},
"host": "management.azure.com",
"schemes": [
diff --git a/specification/security/resource-manager/common/v1/types.json b/specification/security/resource-manager/common/v1/types.json
index 5996220fe2bc..48bec7b159a3 100644
--- a/specification/security/resource-manager/common/v1/types.json
+++ b/specification/security/resource-manager/common/v1/types.json
@@ -241,6 +241,25 @@
"sourceComputerId",
"machineName"
]
+ },
+ "AzureResourceLinks": {
+ "description": "array of azure resource IDs",
+ "readOnly": true,
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/AzureResourceLink"
+ }
+ },
+ "AzureResourceLink": {
+ "type": "object",
+ "description": "Describes an Azure resource with kind",
+ "properties": {
+ "id": {
+ "readOnly": true,
+ "type": "string",
+ "description": "Azure resource Id"
+ }
+ }
}
},
"parameters": {
@@ -284,7 +303,8 @@
"required": true,
"type": "string",
"description": "The identifier of the resource.",
- "x-ms-parameter-location": "method"
+ "x-ms-parameter-location": "method",
+ "x-ms-skip-url-encoding": true
},
"Scope": {
"name": "scope",
@@ -292,7 +312,8 @@
"required": true,
"type": "string",
"description": "Scope of the query, can be subscription (/subscriptions/0b06d9ea-afe6-4779-bd59-30e5c2d9d13f) or management group (/providers/Microsoft.Management/managementGroups/mgName).",
- "x-ms-parameter-location": "method"
+ "x-ms-parameter-location": "method",
+ "x-ms-skip-url-encoding": true
},
"ODataFilter": {
"name": "$filter",
diff --git a/specification/security/resource-manager/readme.md b/specification/security/resource-manager/readme.md
index 701b7b442b90..982c3d005409 100644
--- a/specification/security/resource-manager/readme.md
+++ b/specification/security/resource-manager/readme.md
@@ -1,341 +1,362 @@
-# Security Center
-
-> see https://aka.ms/autorest
-
-This is the AutoRest configuration file for Security.
-
----
-
-## Getting Started
-
-To build the SDK for Security, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run:
-
-> `autorest`
-
-To see additional help and options, run:
-
-> `autorest --help`
-
----
-
-## Configuration
-
-## Suppression
-
-``` yaml
-directive:
- - suppress: ValidFormats
- from: securityContacts.json
- where: $.definitions.SecurityContactProperties.properties.email.format
- reason: email format is allowed
- - suppress: ValidFormats
- from: automations.json
- where: $.definitions.AutomationActionLogicApp.properties.uri.format
- reason: uri format is allowed
- - suppress: PageableOperation
- from: iotSecuritySolutionAnalytics.json
- where: '$.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/iotSecuritySolutions/{solutionName}/analyticsModels"].get'
- reason: The list returns limited number of items
-```
-
-### Basic Information
-
-These are the global settings for the Security API.
-
-``` yaml
-title: SecurityCenter
-description: API spec for Microsoft.Security (Azure Security Center) resource provider
-openapi-type: arm
-tag: package-composite-v3
-```
-
-## Composite packages
-
-The following packages may be composed from multiple api-versions.
-
-### Tag: package-composite-v1
-
-These settings apply only when `--tag=package-composite-v1` is specified on the command line.
-
-``` yaml $(tag) == 'package-composite-v1'
-input-file:
-- Microsoft.Security/preview/2019-01-01-preview/automations.json
-- Microsoft.Security/preview/2019-01-01-preview/subAssessments.json
-- Microsoft.Security/preview/2019-01-01-preview/regulatoryCompliance.json
-- Microsoft.Security/preview/2017-08-01-preview/pricings.json
-- Microsoft.Security/preview/2017-08-01-preview/securityContacts.json
-- Microsoft.Security/preview/2017-08-01-preview/workspaceSettings.json
-- Microsoft.Security/preview/2017-08-01-preview/autoProvisioningSettings.json
-- Microsoft.Security/preview/2017-08-01-preview/compliances.json
-- Microsoft.Security/preview/2017-08-01-preview/advancedThreatProtectionSettings.json
-- Microsoft.Security/preview/2017-08-01-preview/deviceSecurityGroups.json
-- Microsoft.Security/preview/2017-08-01-preview/settings.json
-- Microsoft.Security/preview/2017-08-01-preview/informationProtectionPolicies.json
-- Microsoft.Security/preview/2015-06-01-preview/operations.json
-- Microsoft.Security/preview/2015-06-01-preview/locations.json
-- Microsoft.Security/preview/2015-06-01-preview/tasks.json
-- Microsoft.Security/preview/2015-06-01-preview/alerts.json
-- Microsoft.Security/preview/2015-06-01-preview/discoveredSecuritySolutions.json
-- Microsoft.Security/preview/2015-06-01-preview/jitNetworkAccessPolicies.json
-- Microsoft.Security/preview/2015-06-01-preview/applicationWhitelistings.json
-- Microsoft.Security/preview/2015-06-01-preview/externalSecuritySolutions.json
-- Microsoft.Security/preview/2015-06-01-preview/topologies.json
-- Microsoft.Security/preview/2015-06-01-preview/allowedConnections.json
-- Microsoft.Security/preview/2015-06-01-preview/adaptiveNetworkHardenings.json
-
-# Needed when there is more than one input file
-override-info:
- title: SecurityCenter
-```
-
-### Tag: package-composite-v2
-
-These settings apply only when `--tag=package-composite-v2` is specified on the command line.
-
-``` yaml $(tag) == 'package-composite-v2'
-input-file:
-- Microsoft.Security/preview/2019-01-01-preview/automations.json
-- Microsoft.Security/preview/2019-01-01-preview/subAssessments.json
-- Microsoft.Security/preview/2019-01-01-preview/regulatoryCompliance.json
-- Microsoft.Security/stable/2018-06-01/pricings.json
-- Microsoft.Security/preview/2017-08-01-preview/securityContacts.json
-- Microsoft.Security/preview/2017-08-01-preview/workspaceSettings.json
-- Microsoft.Security/preview/2017-08-01-preview/autoProvisioningSettings.json
-- Microsoft.Security/preview/2017-08-01-preview/compliances.json
-- Microsoft.Security/preview/2017-08-01-preview/advancedThreatProtectionSettings.json
-- Microsoft.Security/preview/2017-08-01-preview/deviceSecurityGroups.json
-- Microsoft.Security/preview/2017-08-01-preview/settings.json
-- Microsoft.Security/preview/2017-08-01-preview/informationProtectionPolicies.json
-- Microsoft.Security/preview/2017-08-01-preview/iotSecuritySolutions.json
-- Microsoft.Security/preview/2017-08-01-preview/iotSecuritySolutionAnalytics.json
-- Microsoft.Security/preview/2015-06-01-preview/operations.json
-- Microsoft.Security/preview/2015-06-01-preview/locations.json
-- Microsoft.Security/preview/2015-06-01-preview/tasks.json
-- Microsoft.Security/stable/2019-01-01/alerts.json
-- Microsoft.Security/preview/2015-06-01-preview/discoveredSecuritySolutions.json
-- Microsoft.Security/preview/2015-06-01-preview/jitNetworkAccessPolicies.json
-- Microsoft.Security/preview/2015-06-01-preview/applicationWhitelistings.json
-- Microsoft.Security/preview/2015-06-01-preview/externalSecuritySolutions.json
-- Microsoft.Security/preview/2015-06-01-preview/topologies.json
-- Microsoft.Security/preview/2015-06-01-preview/allowedConnections.json
-- Microsoft.Security/preview/2015-06-01-preview/adaptiveNetworkHardenings.json
-
-# Needed when there is more than one input file
-override-info:
- title: SecurityCenter
-```
-
-### Tag: package-composite-v3
-
-These settings apply only when `--tag=package-composite-v3` is specified on the command line.
-
-``` yaml $(tag) == 'package-composite-v3'
-input-file:
-- Microsoft.Security/stable/2017-08-01/complianceResults.json
-- Microsoft.Security/stable/2018-06-01/pricings.json
-- Microsoft.Security/stable/2019-01-01/alerts.json
-- Microsoft.Security/stable/2019-01-01/settings.json
-- Microsoft.Security/stable/2019-01-01/advancedThreatProtectionSettings.json
-- Microsoft.Security/stable/2019-08-01/deviceSecurityGroups.json
-- Microsoft.Security/stable/2019-08-01/iotSecuritySolutions.json
-- Microsoft.Security/stable/2019-08-01/iotSecuritySolutionAnalytics.json
-- Microsoft.Security/preview/2015-06-01-preview/discoveredSecuritySolutions.json
-- Microsoft.Security/preview/2015-06-01-preview/externalSecuritySolutions.json
-- Microsoft.Security/preview/2015-06-01-preview/locations.json
-- Microsoft.Security/preview/2015-06-01-preview/operations.json
-- Microsoft.Security/preview/2015-06-01-preview/tasks.json
-- Microsoft.Security/preview/2017-08-01-preview/autoProvisioningSettings.json
-- Microsoft.Security/preview/2017-08-01-preview/compliances.json
-- Microsoft.Security/preview/2017-08-01-preview/informationProtectionPolicies.json
-- Microsoft.Security/preview/2017-08-01-preview/securityContacts.json
-- Microsoft.Security/preview/2017-08-01-preview/workspaceSettings.json
-- Microsoft.Security/preview/2019-01-01-preview/regulatoryCompliance.json
-- Microsoft.Security/preview/2019-01-01-preview/serverVulnerabilityAssessments.json
-- Microsoft.Security/preview/2019-01-01-preview/subAssessments.json
-- Microsoft.Security/preview/2019-01-01-preview/automations.json
-- Microsoft.Security/stable/2020-01-01/assessmentMetadata.json
-- Microsoft.Security/stable/2020-01-01/assessments.json
-- Microsoft.Security/stable/2020-01-01/applicationWhitelistings.json
-- Microsoft.Security/stable/2020-01-01/adaptiveNetworkHardenings.json
-- Microsoft.Security/stable/2020-01-01/allowedConnections.json
-- Microsoft.Security/stable/2020-01-01/topologies.json
-- Microsoft.Security/stable/2020-01-01/jitNetworkAccessPolicies.json
-
-# Needed when there is more than one input file
-override-info:
- title: SecurityCenter
-```
-
-### Tag: package-2015-06-preview-only
-
-These settings apply only when `--tag=package-2015-06-preview-only` is specified on the command line.
-
-``` yaml $(tag) == 'package-2015-06-preview-only'
-input-file:
-- Microsoft.Security/preview/2015-06-01-preview/adaptiveNetworkHardenings.json
-- Microsoft.Security/preview/2015-06-01-preview/alerts.json
-- Microsoft.Security/preview/2015-06-01-preview/allowedConnections.json
-- Microsoft.Security/preview/2015-06-01-preview/applicationWhitelistings.json
-- Microsoft.Security/preview/2015-06-01-preview/discoveredSecuritySolutions.json
-- Microsoft.Security/preview/2015-06-01-preview/externalSecuritySolutions.json
-- Microsoft.Security/preview/2015-06-01-preview/jitNetworkAccessPolicies.json
-- Microsoft.Security/preview/2015-06-01-preview/locations.json
-- Microsoft.Security/preview/2015-06-01-preview/operations.json
-- Microsoft.Security/preview/2015-06-01-preview/tasks.json
-- Microsoft.Security/preview/2015-06-01-preview/topologies.json
-
-# Needed when there is more than one input file
-override-info:
- title: SecurityCenter
-```
-
-### Tag: package-2017-08-preview-only
-
-These settings apply only when `--tag=package-2017-08-preview-only` is specified on the command line.
-
-``` yaml $(tag) == 'package-2017-08-preview-only'
-input-file:
-- Microsoft.Security/preview/2017-08-01-preview/advancedThreatProtectionSettings.json
-- Microsoft.Security/preview/2017-08-01-preview/autoProvisioningSettings.json
-- Microsoft.Security/preview/2017-08-01-preview/compliances.json
-- Microsoft.Security/preview/2017-08-01-preview/deviceSecurityGroups.json
-- Microsoft.Security/preview/2017-08-01-preview/informationProtectionPolicies.json
-- Microsoft.Security/preview/2017-08-01-preview/iotSecuritySolutionAnalytics.json
-- Microsoft.Security/preview/2017-08-01-preview/iotSecuritySolutions.json
-- Microsoft.Security/preview/2017-08-01-preview/pricings.json
-- Microsoft.Security/preview/2017-08-01-preview/securityContacts.json
-- Microsoft.Security/preview/2017-08-01-preview/settings.json
-- Microsoft.Security/preview/2017-08-01-preview/workspaceSettings.json
-
-# Needed when there is more than one input file
-override-info:
- title: SecurityCenter
-```
-
-### Tag: package-2019-01-preview-only
-
-These settings apply only when `--tag=package-2019-01-preview-only` is specified on the command line.
-
-``` yaml $(tag) == 'package-2019-01-preview-only'
-input-file:
-- Microsoft.Security/preview/2019-01-01-preview/regulatoryCompliance.json
-- Microsoft.Security/preview/2019-01-01-preview/serverVulnerabilityAssessments.json
-- Microsoft.Security/preview/2019-01-01-preview/assessmentMetadata.json
-- Microsoft.Security/preview/2019-01-01-preview/assessments.json
-
-# Needed when there is more than one input file
-override-info:
- title: SecurityCenter
-```
-
-### Tag: package-2017-08-only
-
-These settings apply only when `--tag=package-2017-08-only` is specified on the command line.
-
-``` yaml $(tag) == 'package-2017-08-only'
-input-file:
-- Microsoft.Security/stable/2017-08-01/complianceResults.json
-
-# Needed when there is more than one input file
-override-info:
- title: SecurityCenter
-```
-
-### Tag: package-2018-06-only
-
-These settings apply only when `--tag=package-2018-06-only` is specified on the command line.
-
-``` yaml $(tag) == 'package-2018-06-only'
-input-file:
-- Microsoft.Security/stable/2018-06-01/pricings.json
-
-# Needed when there is more than one input file
-override-info:
- title: SecurityCenter
-```
-
-### Tag: package-2019-01-only
-
-These settings apply only when `--tag=package-2019-01-only` is specified on the command line.
-
-``` yaml $(tag) == 'package-2019-01-only'
-input-file:
-- Microsoft.Security/stable/2019-01-01/alerts.json
-- Microsoft.Security/stable/2019-01-01/settings.json
-
-# Needed when there is more than one input file
-override-info:
- title: SecurityCenter
-```
-
-### Tag: package-2019-08-only
-
-These settings apply only when `--tag=package-2019-08-only` is specified on the command line.
-
-``` yaml $(tag) == 'package-2019-08-only'
-input-file:
-- Microsoft.Security/stable/2019-08-01/iotSecuritySolutionAnalytics.json
-- Microsoft.Security/stable/2019-08-01/iotSecuritySolutions.json
-
-# Needed when there is more than one input file
-override-info:
- title: SecurityCenter
-```
-
----
-
-# 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-go
- - repo: azure-sdk-for-python
- - repo: azure-sdk-for-js
- - repo: azure-sdk-for-node
-```
-
-## C#
-
-See configuration in [readme.csharp.md](./readme.csharp.md)
-
-## Go
-
-See configuration in [readme.go.md](./readme.go.md)
-
-## Python
-
-See configuration in [readme.python.md](./readme.python.md)
-
-## Node.js
-
-See configuration in [readme.nodejs.md](./readme.nodejs.md)
-
-## TypeScript
-
-See configuration in [readme.typescript.md](./readme.typescript.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!
-
+# Security Center
+
+> see https://aka.ms/autorest
+
+This is the AutoRest configuration file for Security.
+
+---
+
+## Getting Started
+
+To build the SDK for Security, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run:
+
+> `autorest`
+
+To see additional help and options, run:
+
+> `autorest --help`
+
+---
+
+## Configuration
+
+## Suppression
+
+``` yaml
+directive:
+ - suppress: ValidFormats
+ from: securityContacts.json
+ where: $.definitions.SecurityContactProperties.properties.email.format
+ reason: email format is allowed
+ - suppress: ValidFormats
+ from: automations.json
+ where: $.definitions.AutomationActionLogicApp.properties.uri.format
+ reason: uri format is allowed
+ - suppress: PageableOperation
+ from: iotSecuritySolutionAnalytics.json
+ where: '$.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/iotSecuritySolutions/{solutionName}/analyticsModels"].get'
+ reason: The list returns limited number of items
+```
+
+### Basic Information
+
+These are the global settings for the Security API.
+
+``` yaml
+title: SecurityCenter
+description: API spec for Microsoft.Security (Azure Security Center) resource provider
+openapi-type: arm
+tag: package-composite-v3
+```
+
+## Composite packages
+
+The following packages may be composed from multiple api-versions.
+
+### Tag: package-composite-v1
+
+These settings apply only when `--tag=package-composite-v1` is specified on the command line.
+
+``` yaml $(tag) == 'package-composite-v1'
+input-file:
+- Microsoft.Security/preview/2020-01-01-preview/secureScore.json
+- Microsoft.Security/preview/2019-01-01-preview/automations.json
+- Microsoft.Security/preview/2019-01-01-preview/subAssessments.json
+- Microsoft.Security/preview/2019-01-01-preview/regulatoryCompliance.json
+- Microsoft.Security/preview/2017-08-01-preview/pricings.json
+- Microsoft.Security/preview/2017-08-01-preview/securityContacts.json
+- Microsoft.Security/preview/2017-08-01-preview/workspaceSettings.json
+- Microsoft.Security/preview/2017-08-01-preview/autoProvisioningSettings.json
+- Microsoft.Security/preview/2017-08-01-preview/compliances.json
+- Microsoft.Security/preview/2017-08-01-preview/advancedThreatProtectionSettings.json
+- Microsoft.Security/preview/2017-08-01-preview/deviceSecurityGroups.json
+- Microsoft.Security/preview/2017-08-01-preview/settings.json
+- Microsoft.Security/preview/2017-08-01-preview/informationProtectionPolicies.json
+- Microsoft.Security/preview/2015-06-01-preview/operations.json
+- Microsoft.Security/preview/2015-06-01-preview/locations.json
+- Microsoft.Security/preview/2015-06-01-preview/tasks.json
+- Microsoft.Security/preview/2015-06-01-preview/alerts.json
+- Microsoft.Security/preview/2015-06-01-preview/discoveredSecuritySolutions.json
+- Microsoft.Security/preview/2015-06-01-preview/jitNetworkAccessPolicies.json
+- Microsoft.Security/preview/2015-06-01-preview/applicationWhitelistings.json
+- Microsoft.Security/preview/2015-06-01-preview/externalSecuritySolutions.json
+- Microsoft.Security/preview/2015-06-01-preview/topologies.json
+- Microsoft.Security/preview/2015-06-01-preview/allowedConnections.json
+- Microsoft.Security/preview/2015-06-01-preview/adaptiveNetworkHardenings.json
+- Microsoft.Security/preview/2019-01-01-preview/alertsSuppressionRules.json
+
+# Needed when there is more than one input file
+override-info:
+ title: SecurityCenter
+```
+
+### Tag: package-composite-v2
+
+These settings apply only when `--tag=package-composite-v2` is specified on the command line.
+
+``` yaml $(tag) == 'package-composite-v2'
+input-file:
+- Microsoft.Security/preview/2020-01-01-preview/secureScore.json
+- Microsoft.Security/preview/2019-01-01-preview/automations.json
+- Microsoft.Security/preview/2019-01-01-preview/subAssessments.json
+- Microsoft.Security/preview/2019-01-01-preview/regulatoryCompliance.json
+- Microsoft.Security/stable/2018-06-01/pricings.json
+- Microsoft.Security/preview/2017-08-01-preview/securityContacts.json
+- Microsoft.Security/preview/2017-08-01-preview/workspaceSettings.json
+- Microsoft.Security/preview/2017-08-01-preview/autoProvisioningSettings.json
+- Microsoft.Security/preview/2017-08-01-preview/compliances.json
+- Microsoft.Security/preview/2017-08-01-preview/advancedThreatProtectionSettings.json
+- Microsoft.Security/preview/2017-08-01-preview/deviceSecurityGroups.json
+- Microsoft.Security/preview/2017-08-01-preview/settings.json
+- Microsoft.Security/preview/2017-08-01-preview/informationProtectionPolicies.json
+- Microsoft.Security/preview/2017-08-01-preview/iotSecuritySolutions.json
+- Microsoft.Security/preview/2017-08-01-preview/iotSecuritySolutionAnalytics.json
+- Microsoft.Security/preview/2015-06-01-preview/operations.json
+- Microsoft.Security/preview/2015-06-01-preview/locations.json
+- Microsoft.Security/preview/2015-06-01-preview/tasks.json
+- Microsoft.Security/stable/2019-01-01/alerts.json
+- Microsoft.Security/preview/2015-06-01-preview/discoveredSecuritySolutions.json
+- Microsoft.Security/preview/2015-06-01-preview/jitNetworkAccessPolicies.json
+- Microsoft.Security/preview/2015-06-01-preview/applicationWhitelistings.json
+- Microsoft.Security/preview/2015-06-01-preview/externalSecuritySolutions.json
+- Microsoft.Security/preview/2015-06-01-preview/topologies.json
+- Microsoft.Security/preview/2015-06-01-preview/allowedConnections.json
+- Microsoft.Security/preview/2015-06-01-preview/adaptiveNetworkHardenings.json
+- Microsoft.Security/preview/2019-01-01-preview/alertsSuppressionRules.json
+
+# Needed when there is more than one input file
+override-info:
+ title: SecurityCenter
+```
+
+### Tag: package-composite-v3
+
+These settings apply only when `--tag=package-composite-v3` is specified on the command line.
+
+``` yaml $(tag) == 'package-composite-v3'
+input-file:
+- Microsoft.Security/stable/2017-08-01/complianceResults.json
+- Microsoft.Security/stable/2018-06-01/pricings.json
+- Microsoft.Security/stable/2019-01-01/alerts.json
+- Microsoft.Security/stable/2019-01-01/settings.json
+- Microsoft.Security/stable/2019-01-01/advancedThreatProtectionSettings.json
+- Microsoft.Security/stable/2019-08-01/deviceSecurityGroups.json
+- Microsoft.Security/stable/2019-08-01/iotSecuritySolutions.json
+- Microsoft.Security/stable/2019-08-01/iotSecuritySolutionAnalytics.json
+- Microsoft.Security/preview/2015-06-01-preview/locations.json
+- Microsoft.Security/preview/2015-06-01-preview/operations.json
+- Microsoft.Security/preview/2015-06-01-preview/tasks.json
+- Microsoft.Security/preview/2017-08-01-preview/autoProvisioningSettings.json
+- Microsoft.Security/preview/2017-08-01-preview/compliances.json
+- Microsoft.Security/preview/2017-08-01-preview/informationProtectionPolicies.json
+- Microsoft.Security/preview/2017-08-01-preview/securityContacts.json
+- Microsoft.Security/preview/2017-08-01-preview/workspaceSettings.json
+- Microsoft.Security/preview/2019-01-01-preview/regulatoryCompliance.json
+
+- Microsoft.Security/preview/2019-01-01-preview/subAssessments.json
+- Microsoft.Security/preview/2019-01-01-preview/automations.json
+- Microsoft.Security/preview/2019-01-01-preview/alertsSuppressionRules.json
+- Microsoft.Security/stable/2020-01-01/serverVulnerabilityAssessments.json
+- Microsoft.Security/stable/2020-01-01/assessmentMetadata.json
+- Microsoft.Security/stable/2020-01-01/assessments.json
+- Microsoft.Security/stable/2020-01-01/applicationWhitelistings.json
+- Microsoft.Security/stable/2020-01-01/adaptiveNetworkHardenings.json
+- Microsoft.Security/stable/2020-01-01/allowedConnections.json
+- Microsoft.Security/stable/2020-01-01/topologies.json
+- Microsoft.Security/stable/2020-01-01/jitNetworkAccessPolicies.json
+- Microsoft.Security/stable/2020-01-01/discoveredSecuritySolutions.json
+- Microsoft.Security/stable/2020-01-01/externalSecuritySolutions.json
+- Microsoft.Security/preview/2020-01-01-preview/secureScore.json
+
+# Needed when there is more than one input file
+override-info:
+ title: SecurityCenter
+```
+
+### Tag: package-2015-06-preview-only
+
+These settings apply only when `--tag=package-2015-06-preview-only` is specified on the command line.
+
+``` yaml $(tag) == 'package-2015-06-preview-only'
+input-file:
+- Microsoft.Security/preview/2015-06-01-preview/adaptiveNetworkHardenings.json
+- Microsoft.Security/preview/2015-06-01-preview/alerts.json
+- Microsoft.Security/preview/2015-06-01-preview/allowedConnections.json
+- Microsoft.Security/preview/2015-06-01-preview/applicationWhitelistings.json
+- Microsoft.Security/preview/2015-06-01-preview/discoveredSecuritySolutions.json
+- Microsoft.Security/preview/2015-06-01-preview/externalSecuritySolutions.json
+- Microsoft.Security/preview/2015-06-01-preview/jitNetworkAccessPolicies.json
+- Microsoft.Security/preview/2015-06-01-preview/locations.json
+- Microsoft.Security/preview/2015-06-01-preview/operations.json
+- Microsoft.Security/preview/2015-06-01-preview/tasks.json
+- Microsoft.Security/preview/2015-06-01-preview/topologies.json
+
+# Needed when there is more than one input file
+override-info:
+ title: SecurityCenter
+```
+
+### Tag: package-2017-08-preview-only
+
+These settings apply only when `--tag=package-2017-08-preview-only` is specified on the command line.
+
+``` yaml $(tag) == 'package-2017-08-preview-only'
+input-file:
+- Microsoft.Security/preview/2017-08-01-preview/advancedThreatProtectionSettings.json
+- Microsoft.Security/preview/2017-08-01-preview/autoProvisioningSettings.json
+- Microsoft.Security/preview/2017-08-01-preview/compliances.json
+- Microsoft.Security/preview/2017-08-01-preview/deviceSecurityGroups.json
+- Microsoft.Security/preview/2017-08-01-preview/informationProtectionPolicies.json
+- Microsoft.Security/preview/2017-08-01-preview/iotSecuritySolutionAnalytics.json
+- Microsoft.Security/preview/2017-08-01-preview/iotSecuritySolutions.json
+- Microsoft.Security/preview/2017-08-01-preview/pricings.json
+- Microsoft.Security/preview/2017-08-01-preview/securityContacts.json
+- Microsoft.Security/preview/2017-08-01-preview/settings.json
+- Microsoft.Security/preview/2017-08-01-preview/workspaceSettings.json
+
+# Needed when there is more than one input file
+override-info:
+ title: SecurityCenter
+```
+
+### Tag: package-2019-01-preview-only
+
+These settings apply only when `--tag=package-2019-01-preview-only` is specified on the command line.
+
+``` yaml $(tag) == 'package-2019-01-preview-only'
+input-file:
+- Microsoft.Security/preview/2019-01-01-preview/regulatoryCompliance.json
+- Microsoft.Security/preview/2019-01-01-preview/alertsSuppressionRules.json
+- Microsoft.Security/preview/2019-01-01-preview/assessmentMetadata.json
+- Microsoft.Security/preview/2019-01-01-preview/assessments.json
+
+# Needed when there is more than one input file
+override-info:
+ title: SecurityCenter
+```
+
+### Tag: package-2020-01-preview-only
+
+These settings apply only when `--tag=package-2020-01-preview-only` is specified on the command line.
+
+``` yaml $(tag) == 'package-2020-01-preview-only'
+input-file:
+- Microsoft.Security/preview/2020-01-01-preview/secureScore.json
+
+# Needed when there is more than one input file
+override-info:
+ title: SecurityCenter
+```
+
+### Tag: package-2017-08-only
+
+These settings apply only when `--tag=package-2017-08-only` is specified on the command line.
+
+``` yaml $(tag) == 'package-2017-08-only'
+input-file:
+- Microsoft.Security/stable/2017-08-01/complianceResults.json
+
+# Needed when there is more than one input file
+override-info:
+ title: SecurityCenter
+```
+
+### Tag: package-2018-06-only
+
+These settings apply only when `--tag=package-2018-06-only` is specified on the command line.
+
+``` yaml $(tag) == 'package-2018-06-only'
+input-file:
+- Microsoft.Security/stable/2018-06-01/pricings.json
+
+# Needed when there is more than one input file
+override-info:
+ title: SecurityCenter
+```
+
+### Tag: package-2019-01-only
+
+These settings apply only when `--tag=package-2019-01-only` is specified on the command line.
+
+``` yaml $(tag) == 'package-2019-01-only'
+input-file:
+- Microsoft.Security/stable/2019-01-01/alerts.json
+- Microsoft.Security/stable/2019-01-01/settings.json
+
+# Needed when there is more than one input file
+override-info:
+ title: SecurityCenter
+```
+
+### Tag: package-2019-08-only
+
+These settings apply only when `--tag=package-2019-08-only` is specified on the command line.
+
+``` yaml $(tag) == 'package-2019-08-only'
+input-file:
+- Microsoft.Security/stable/2019-08-01/iotSecuritySolutionAnalytics.json
+- Microsoft.Security/stable/2019-08-01/iotSecuritySolutions.json
+
+# Needed when there is more than one input file
+override-info:
+ title: SecurityCenter
+```
+
+---
+
+# 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-go
+ - repo: azure-sdk-for-python
+ - repo: azure-sdk-for-js
+ - repo: azure-sdk-for-node
+```
+
+## C#
+
+See configuration in [readme.csharp.md](./readme.csharp.md)
+
+## Go
+
+See configuration in [readme.go.md](./readme.go.md)
+
+## Python
+
+See configuration in [readme.python.md](./readme.python.md)
+
+## Node.js
+
+See configuration in [readme.nodejs.md](./readme.nodejs.md)
+
+## TypeScript
+
+See configuration in [readme.typescript.md](./readme.typescript.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.Security/preview/2020-01-01-preview/secureScore.json
- $(this-folder)/Microsoft.Security/preview/2019-01-01-preview/automations.json
- $(this-folder)/Microsoft.Security/preview/2019-01-01-preview/subAssessments.json
- $(this-folder)/Microsoft.Security/preview/2019-01-01-preview/regulatoryCompliance.json
@@ -359,6 +380,7 @@ input-file:
- $(this-folder)/Microsoft.Security/preview/2015-06-01-preview/topologies.json
- $(this-folder)/Microsoft.Security/preview/2015-06-01-preview/allowedConnections.json
- $(this-folder)/Microsoft.Security/preview/2015-06-01-preview/adaptiveNetworkHardenings.json
+ - $(this-folder)/Microsoft.Security/preview/2019-01-01-preview/alertsSuppressionRules.json
- $(this-folder)/Microsoft.Security/stable/2018-06-01/pricings.json
- $(this-folder)/Microsoft.Security/preview/2017-08-01-preview/iotSecuritySolutions.json
- $(this-folder)/Microsoft.Security/preview/2017-08-01-preview/iotSecuritySolutionAnalytics.json
@@ -369,7 +391,7 @@ input-file:
- $(this-folder)/Microsoft.Security/stable/2019-08-01/deviceSecurityGroups.json
- $(this-folder)/Microsoft.Security/stable/2019-08-01/iotSecuritySolutions.json
- $(this-folder)/Microsoft.Security/stable/2019-08-01/iotSecuritySolutionAnalytics.json
- - $(this-folder)/Microsoft.Security/preview/2019-01-01-preview/serverVulnerabilityAssessments.json
+ - $(this-folder)/Microsoft.Security/stable/2020-01-01/serverVulnerabilityAssessments.json
- $(this-folder)/Microsoft.Security/stable/2020-01-01/assessmentMetadata.json
- $(this-folder)/Microsoft.Security/stable/2020-01-01/assessments.json
- $(this-folder)/Microsoft.Security/stable/2020-01-01/applicationWhitelistings.json
@@ -377,15 +399,17 @@ input-file:
- $(this-folder)/Microsoft.Security/stable/2020-01-01/allowedConnections.json
- $(this-folder)/Microsoft.Security/stable/2020-01-01/topologies.json
- $(this-folder)/Microsoft.Security/stable/2020-01-01/jitNetworkAccessPolicies.json
+ - $(this-folder)/Microsoft.Security/stable/2020-01-01/discoveredSecuritySolutions.json
+ - $(this-folder)/Microsoft.Security/stable/2020-01-01/externalSecuritySolutions.json
- $(this-folder)/Microsoft.Security/preview/2019-01-01-preview/assessmentMetadata.json
- $(this-folder)/Microsoft.Security/preview/2019-01-01-preview/assessments.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
+```
+
+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/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 fd280dc50ef5..0bfdb0305304 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
@@ -1427,7 +1427,7 @@
"200": {
"description": "OK",
"schema": {
- "$ref": "#/definitions/BookmarkRelationList"
+ "$ref": "#/definitions/RelationList"
}
},
"default": {
@@ -1437,7 +1437,7 @@
}
}
},
- "x-ms-odata": "#/definitions/BookmarkRelation",
+ "x-ms-odata": "#/definitions/Relation",
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
@@ -1533,7 +1533,7 @@
"200": {
"description": "OK",
"schema": {
- "$ref": "#/definitions/BookmarkRelation"
+ "$ref": "#/definitions/Relation"
}
},
"default": {
@@ -1578,20 +1578,20 @@
"$ref": "#/parameters/RelationName"
},
{
- "$ref": "#/parameters/RelationInputModel"
+ "$ref": "#/parameters/Relation"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
- "$ref": "#/definitions/BookmarkRelation"
+ "$ref": "#/definitions/Relation"
}
},
"201": {
"description": "Created",
"schema": {
- "$ref": "#/definitions/BookmarkRelation"
+ "$ref": "#/definitions/Relation"
}
},
"default": {
@@ -2391,14 +2391,56 @@
}
}
},
- "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/settings/{settingsName}": {
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/settings": {
"get": {
"x-ms-examples": {
- "Get UEBA settings.": {
- "$ref": "./examples/settings/GetUebaSettings.json"
+ "Get EyesOn settings.": {
+ "$ref": "./examples/settings/GetAllSettings.json"
+ }
+ },
+ "tags": [
+ "Settings"
+ ],
+ "description": "List of all the settings",
+ "operationId": "ProductSettings_GetAll",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion"
},
- "Get Fusion settings.": {
- "$ref": "./examples/settings/GetFusionSettings.json"
+ {
+ "$ref": "#/parameters/SubscriptionId"
+ },
+ {
+ "$ref": "#/parameters/ResourceGroupName"
+ },
+ {
+ "$ref": "#/parameters/OperationalInsightsResourceProvider"
+ },
+ {
+ "$ref": "#/parameters/WorkspaceName"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/SettingList"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/settings/{settingsName}": {
+ "get": {
+ "x-ms-examples": {
+ "Get EyesOn settings.": {
+ "$ref": "./examples/settings/GetEyesOnSetting.json"
}
},
"tags": [
@@ -2441,16 +2483,62 @@
}
}
},
+ "delete": {
+ "x-ms-examples": {
+ "Delete EyesOn settings.": {
+ "$ref": "./examples/settings/DeleteEyesOnSetting.json"
+ }
+ },
+ "tags": [
+ "Settings"
+ ],
+ "description": "Delete setting of the product.",
+ "operationId": "ProductSettings_Delete",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionId"
+ },
+ {
+ "$ref": "#/parameters/ResourceGroupName"
+ },
+ {
+ "$ref": "#/parameters/OperationalInsightsResourceProvider"
+ },
+ {
+ "$ref": "#/parameters/WorkspaceName"
+ },
+ {
+ "$ref": "#/parameters/SettingsName"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK"
+ },
+ "204": {
+ "description": "No Content"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ }
+ },
"put": {
"x-ms-examples": {
- "Update UEBA settings.": {
- "$ref": "./examples/settings/UpdateUebaSettings.json"
+ "Update EyesOn settings.": {
+ "$ref": "./examples/settings/UpdateEyesOnSetting.json"
}
},
"tags": [
"Settings"
],
- "description": "Updates the setting.",
+ "description": "Updates setting.",
"operationId": "ProductSettings_Update",
"parameters": [
{
@@ -4076,73 +4164,6 @@
"bookmarkId"
]
},
- "BookmarkRelationList": {
- "description": "List of bookmark relations.",
- "properties": {
- "nextLink": {
- "readOnly": true,
- "description": "URL to fetch the next set of relations.",
- "type": "string"
- },
- "value": {
- "description": "Array of relations.",
- "type": "array",
- "items": {
- "$ref": "#/definitions/BookmarkRelation"
- }
- }
- },
- "required": [
- "value"
- ]
- },
- "BookmarkRelation": {
- "type": "object",
- "description": "Represents a bookmark relation",
- "allOf": [
- {
- "$ref": "#/definitions/RelationBase"
- }
- ],
- "properties": {
- "properties": {
- "x-ms-client-flatten": true,
- "description": "Bookmark relation properties",
- "$ref": "#/definitions/BookmarkRelationProperties"
- }
- }
- },
- "BookmarkRelationProperties": {
- "type": "object",
- "description": "Bookmark relation properties",
- "properties": {
- "relationName": {
- "type": "string",
- "description": "Name of relation"
- },
- "bookmarkId": {
- "type": "string",
- "description": "The case related bookmark id"
- },
- "caseIdentifier": {
- "type": "string",
- "description": "The case identifier"
- },
- "caseTitle": {
- "type": "string",
- "description": "The case title"
- },
- "caseSeverity": {
- "type": "string",
- "description": "The case severity"
- }
- },
- "required": [
- "relationName",
- "caseIdentifier",
- "bookmarkId"
- ]
- },
"RelationsModelInput": {
"type": "object",
"description": "Relation input model",
@@ -7142,6 +7163,7 @@
},
"relatedResourceName": {
"description": "The name of the related resource",
+ "readOnly": true,
"type": "string"
},
"relatedResourceType": {
@@ -7797,6 +7819,11 @@
"description": "The name of the vendor that raise the alert.",
"readOnly": true,
"type": "string"
+ },
+ "alertLink": {
+ "description": "The uri link of the alert.",
+ "readOnly": true,
+ "type": "string"
}
},
"type": "object"
@@ -7845,6 +7872,21 @@
},
"type": "object"
},
+ "SettingList": {
+ "description": "List of all the settings.",
+ "properties": {
+ "value": {
+ "description": "Array of settings.",
+ "items": {
+ "$ref": "#/definitions/Settings"
+ },
+ "type": "array"
+ }
+ },
+ "required": [
+ "value"
+ ]
+ },
"Settings": {
"allOf": [
{
@@ -7856,10 +7898,7 @@
],
"description": "The Setting.",
"discriminator": "kind",
- "type": "object",
- "required": [
- "kind"
- ]
+ "type": "object"
},
"SettingsKind": {
"description": "Describes an Azure resource with kind.",
@@ -7867,8 +7906,7 @@
"kind": {
"description": "The kind of the setting",
"enum": [
- "UebaSettings",
- "ToggleSettings"
+ "EyesOn"
],
"type": "string",
"x-ms-enum": {
@@ -8090,7 +8128,7 @@
},
"type": "object"
},
- "ToggleSettings": {
+ "EyesOn": {
"allOf": [
{
"$ref": "#/definitions/Settings"
@@ -8099,73 +8137,21 @@
"description": "Settings with single toggle.",
"properties": {
"properties": {
- "$ref": "#/definitions/ToggleSettingsProperties",
- "description": "toggle properties",
+ "$ref": "#/definitions/EyesOnSettingsProperties",
+ "description": "EyesOn properties",
"x-ms-client-flatten": true
}
},
"type": "object",
- "x-ms-discriminator-value": "ToggleSettings"
+ "x-ms-discriminator-value": "EyesOn"
},
- "ToggleSettingsProperties": {
- "description": "toggle property bag.",
+ "EyesOnSettingsProperties": {
+ "description": "EyesOn property bag.",
"properties": {
"isEnabled": {
"description": "Determines whether the setting is enable or disabled.",
- "type": "boolean"
- }
- },
- "type": "object"
- },
- "UebaSettings": {
- "allOf": [
- {
- "$ref": "#/definitions/Settings"
- }
- ],
- "description": "Represents settings for User and Entity Behavior Analytics enablement.",
- "properties": {
- "properties": {
- "$ref": "#/definitions/UebaSettingsProperties",
- "description": "User and Entity Behavior Analytics settings properties",
- "x-ms-client-flatten": true
- }
- },
- "type": "object",
- "x-ms-discriminator-value": "UebaSettings"
- },
- "UebaSettingsProperties": {
- "description": "User and Entity Behavior Analytics settings property bag.",
- "properties": {
- "atpLicenseStatus": {
- "description": "Determines whether the tenant has ATP (Advanced Threat Protection) license.",
- "enum": [
- "Enabled",
- "Disabled"
- ],
"readOnly": true,
- "type": "string",
- "x-ms-enum": {
- "modelAsString": true,
- "name": "LicenseStatus"
- }
- },
- "isEnabled": {
- "description": "Determines whether User and Entity Behavior Analytics is enabled for this workspace.",
"type": "boolean"
- },
- "statusInMcas": {
- "description": "Determines whether User and Entity Behavior Analytics is enabled from MCAS (Microsoft Cloud App Security).",
- "enum": [
- "Enabled",
- "Disabled"
- ],
- "readOnly": true,
- "type": "string",
- "x-ms-enum": {
- "modelAsString": true,
- "name": "StatusInMcas"
- }
}
},
"type": "object"
@@ -8675,7 +8661,7 @@
"x-ms-parameter-location": "method"
},
"SettingsName": {
- "description": "The setting name. Supports- Fusion, UEBA",
+ "description": "The setting name. Supports- EyesOn",
"in": "path",
"name": "settingsName",
"required": true,
diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/examples/actions/CreateActionOfAlertRule.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/examples/actions/CreateActionOfAlertRule.json
index b50eaeec2581..70983078afb8 100644
--- a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/examples/actions/CreateActionOfAlertRule.json
+++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/examples/actions/CreateActionOfAlertRule.json
@@ -8,9 +8,6 @@
"ruleId": "73e01a99-5cd7-4139-a149-9f2736ff2ab5",
"actionId": "912bec42-cb66-4c03-ac63-1761b6898c3e",
"action": {
- "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/alertRules/73e01a99-5cd7-4139-a149-9f2736ff2ab5/actions/912bec42-cb66-4c03-ac63-1761b6898c3e",
- "name": "912bec42-cb66-4c03-ac63-1761b6898c3e",
- "type": "Microsoft.SecurityInsights/alertRules/actions",
"etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"",
"properties": {
"triggerUri": "https://prod-31.northcentralus.logic.azure.com:443/workflows/cd3765391efd48549fd7681ded1d48d7/triggers/manual/paths/invoke?api-version=2016-10-01&sp=%2Ftriggers%2Fmanual%2Frun&sv=1.0&sig=signature",
diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/examples/alertRules/CreateFusionAlertRule.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/examples/alertRules/CreateFusionAlertRule.json
index d3fc30ca7c5c..5e14cc180679 100644
--- a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/examples/alertRules/CreateFusionAlertRule.json
+++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/examples/alertRules/CreateFusionAlertRule.json
@@ -10,7 +10,7 @@
"kind": "Fusion",
"etag": "3d00c3ca-0000-0100-0000-5d42d5010000",
"properties": {
- "enabled": "true",
+ "enabled": true,
"alertRuleTemplateName": "f71aba3d-28fb-450b-b192-4e76a83015c8"
}
}
diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/examples/bookmarks/CreateBookmark.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/examples/bookmarks/CreateBookmark.json
index 13ff09f12a8f..af9c4dc03c91 100644
--- a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/examples/bookmarks/CreateBookmark.json
+++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/examples/bookmarks/CreateBookmark.json
@@ -7,21 +7,14 @@
"operationalInsightsResourceProvider": "Microsoft.OperationalInsights",
"bookmarkId": "73e01a99-5cd7-4139-a149-9f2736ff2ab5",
"bookmark": {
- "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/bookmarks/73e01a99-5cd7-4139-a149-9f2736ff2ab5",
- "name": "73e01a99-5cd7-4139-a149-9f2736ff2ab5",
- "type": "Microsoft.SecurityInsights/bookmarks",
"etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"",
"properties": {
"displayName": "My bookmark",
"createdBy": {
- "objectId": "2046feea-040d-4a46-9e2b-91c2941bfa70",
- "email": "john@contoso.com",
- "name": "john doe"
+ "objectId": "2046feea-040d-4a46-9e2b-91c2941bfa70"
},
"updatedBy": {
- "objectId": "2046feea-040d-4a46-9e2b-91c2941bfa70",
- "email": "john@contoso.com",
- "name": "john doe"
+ "objectId": "2046feea-040d-4a46-9e2b-91c2941bfa70"
},
"updated": "2019-01-01T13:15:30Z",
"created": "2019-01-01T13:15:30Z",
diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/examples/bookmarks/relations/CreateBookmarkRelation.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/examples/bookmarks/relations/CreateBookmarkRelation.json
index 7f15971e4f2b..9c539588f1f8 100644
--- a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/examples/bookmarks/relations/CreateBookmarkRelation.json
+++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/examples/bookmarks/relations/CreateBookmarkRelation.json
@@ -7,16 +7,9 @@
"operationalInsightsResourceProvider": "Microsoft.OperationalInsights",
"bookmarkId": "2216d0e1-91e3-4902-89fd-d2df8c535096",
"relationName": "4bb36b7b-26ff-4d1c-9cbe-0d8ab3da0014",
- "relationInputModel": {
+ "relation": {
"properties": {
- "sourceRelationNode": {
- "relationNodeId": "afbd324f-6c48-459c-8710-8d1e1cd03812",
- "relationNodeKind": "Case"
- },
- "targetRelationNode": {
- "relationNodeId": "2216d0e1-91e3-4902-89fd-d2df8c535096",
- "relationNodeKind": "Bookmark"
- }
+ "relatedResourceId": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/incidents/afbd324f-6c48-459c-8710-8d1e1cd03812"
}
}
},
@@ -26,14 +19,11 @@
"id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/bookmarks/2216d0e1-91e3-4902-89fd-d2df8c535096/relations/4bb36b7b-26ff-4d1c-9cbe-0d8ab3da0014",
"name": "4bb36b7b-26ff-4d1c-9cbe-0d8ab3da0014",
"type": "Microsoft.SecurityInsights/bookmarks/relations",
- "kind": "CasesToBookmarks",
"etag": "190057d0-0000-0d00-0000-5c6f5adb0000",
"properties": {
- "relationName": "4bb36b7b-26ff-4d1c-9cbe-0d8ab3da0014",
- "bookmarkId": "2216d0e1-91e3-4902-89fd-d2df8c535096",
- "caseIdentifier": "afbd324f-6c48-459c-8710-8d1e1cd03812",
- "caseTitle": "Test case",
- "caseSeverity": "High"
+ "relatedResourceId": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/incidents/afbd324f-6c48-459c-8710-8d1e1cd03812",
+ "relatedResourceName": "afbd324f-6c48-459c-8710-8d1e1cd03812",
+ "relatedResourceType": "Microsoft.SecurityInsights/incidents"
}
}
},
@@ -42,14 +32,11 @@
"id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/bookmarks/2216d0e1-91e3-4902-89fd-d2df8c535096/relations/4bb36b7b-26ff-4d1c-9cbe-0d8ab3da0014",
"name": "4bb36b7b-26ff-4d1c-9cbe-0d8ab3da0014",
"type": "Microsoft.SecurityInsights/bookmarks/relations",
- "kind": "CasesToBookmarks",
"etag": "190057d0-0000-0d00-0000-5c6f5adb0000",
"properties": {
- "relationName": "4bb36b7b-26ff-4d1c-9cbe-0d8ab3da0014",
- "bookmarkId": "2216d0e1-91e3-4902-89fd-d2df8c535096",
- "caseIdentifier": "afbd324f-6c48-459c-8710-8d1e1cd03812",
- "caseTitle": "Test case",
- "caseSeverity": "High"
+ "relatedResourceId": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/incidents/afbd324f-6c48-459c-8710-8d1e1cd03812",
+ "relatedResourceName": "afbd324f-6c48-459c-8710-8d1e1cd03812",
+ "relatedResourceType": "Microsoft.SecurityInsights/incidents"
}
}
}
diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/examples/bookmarks/relations/GetAllBookmarkRelations.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/examples/bookmarks/relations/GetAllBookmarkRelations.json
index ebef2304130a..f9648d084a97 100644
--- a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/examples/bookmarks/relations/GetAllBookmarkRelations.json
+++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/examples/bookmarks/relations/GetAllBookmarkRelations.json
@@ -15,14 +15,11 @@
"id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/bookmarks/2216d0e1-91e3-4902-89fd-d2df8c535096/relations/4bb36b7b-26ff-4d1c-9cbe-0d8ab3da0014",
"name": "4bb36b7b-26ff-4d1c-9cbe-0d8ab3da0014",
"type": "Microsoft.SecurityInsights/bookmarks/relations",
- "kind": "CasesToBookmarks",
"etag": "190057d0-0000-0d00-0000-5c6f5adb0000",
"properties": {
- "bookmarkId": "2216d0e1-91e3-4902-89fd-d2df8c535096",
- "caseIdentifier": "afbd324f-6c48-459c-8710-8d1e1cd03812",
- "caseTitle": "Test case",
- "caseSeverity": "High",
- "relationName": "4bb36b7b-26ff-4d1c-9cbe-0d8ab3da0014"
+ "relatedResourceId": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/incidents/afbd324f-6c48-459c-8710-8d1e1cd03812",
+ "relatedResourceName": "afbd324f-6c48-459c-8710-8d1e1cd03812",
+ "relatedResourceType": "Microsoft.SecurityInsights/incidents"
}
}
]
diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/examples/bookmarks/relations/GetBookmarkRelationByName.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/examples/bookmarks/relations/GetBookmarkRelationByName.json
index 2037ee51571e..f03b116a69f2 100644
--- a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/examples/bookmarks/relations/GetBookmarkRelationByName.json
+++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/examples/bookmarks/relations/GetBookmarkRelationByName.json
@@ -14,14 +14,11 @@
"id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/bookmarks/2216d0e1-91e3-4902-89fd-d2df8c535096/relations/4bb36b7b-26ff-4d1c-9cbe-0d8ab3da0014",
"name": "4bb36b7b-26ff-4d1c-9cbe-0d8ab3da0014",
"type": "Microsoft.SecurityInsights/bookmarks/relations",
- "kind": "CasesToBookmarks",
"etag": "190057d0-0000-0d00-0000-5c6f5adb0000",
"properties": {
- "bookmarkId": "2216d0e1-91e3-4902-89fd-d2df8c535096",
- "caseIdentifier": "afbd324f-6c48-459c-8710-8d1e1cd03812",
- "caseTitle": "Test case",
- "caseSeverity": "High",
- "relationName": "4bb36b7b-26ff-4d1c-9cbe-0d8ab3da0014"
+ "relatedResourceId": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/incidents/afbd324f-6c48-459c-8710-8d1e1cd03812",
+ "relatedResourceName": "afbd324f-6c48-459c-8710-8d1e1cd03812",
+ "relatedResourceType": "Microsoft.SecurityInsights/incidents"
}
}
}
diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/examples/cases/relations/CreateCaseRelation.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/examples/cases/relations/CreateCaseRelation.json
index 419bc9cee31f..ee9a7c92b6c6 100644
--- a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/examples/cases/relations/CreateCaseRelation.json
+++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/examples/cases/relations/CreateCaseRelation.json
@@ -10,12 +10,10 @@
"relationInputModel": {
"properties": {
"sourceRelationNode": {
- "relationNodeId": "afbd324f-6c48-459c-8710-8d1e1cd03812",
- "relationNodeKind": "Case"
+ "relationNodeId": "afbd324f-6c48-459c-8710-8d1e1cd03812"
},
"targetRelationNode": {
- "relationNodeId": "2216d0e1-91e3-4902-89fd-d2df8c535096",
- "relationNodeKind": "Bookmark"
+ "relationNodeId": "2216d0e1-91e3-4902-89fd-d2df8c535096"
}
}
}
diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/examples/dataConnectors/CreateOfficeDataConnetor.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/examples/dataConnectors/CreateOfficeDataConnetor.json
index efa14f9e4652..5a843a956be8 100644
--- a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/examples/dataConnectors/CreateOfficeDataConnetor.json
+++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/examples/dataConnectors/CreateOfficeDataConnetor.json
@@ -7,9 +7,6 @@
"operationalInsightsResourceProvider": "Microsoft.OperationalInsights",
"dataConnectorId": "73e01a99-5cd7-4139-a149-9f2736ff2ab5",
"dataConnector": {
- "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/dataConnectors/73e01a99-5cd7-4139-a149-9f2736ff2ab5",
- "name": "73e01a99-5cd7-4139-a149-9f2736ff2ab5",
- "type": "Microsoft.SecurityInsights/dataConnectors",
"kind": "Office365",
"etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"",
"properties": {
diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/examples/entities/GetSecurityAlertEntityById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/examples/entities/GetSecurityAlertEntityById.json
index af742bb18b0a..640d2f28fa68 100644
--- a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/examples/entities/GetSecurityAlertEntityById.json
+++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/examples/entities/GetSecurityAlertEntityById.json
@@ -43,7 +43,8 @@
"Search Query Results Overall Count": "203",
"Total Account Entities": "1"
},
- "friendlyName": "Suspicious account detected"
+ "friendlyName": "Suspicious account detected",
+ "alertLink": "https://portal.azure.com/#blade/Microsoft_Azure_Security/AlertBlade/alertId/2518119885989999999_4aa486e0-6f85-41af-99ea-7acdce7be6c8/subscriptionId/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/myRg/myWorkspace/referencedFrom/alertDeepLink/location/centralus"
}
}
}
diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/examples/settings/DeleteEyesOnSetting.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/examples/settings/DeleteEyesOnSetting.json
new file mode 100644
index 000000000000..1190612db5e6
--- /dev/null
+++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/examples/settings/DeleteEyesOnSetting.json
@@ -0,0 +1,14 @@
+{
+ "parameters": {
+ "api-version": "2019-01-01-preview",
+ "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0",
+ "resourceGroupName": "myRg",
+ "workspaceName": "myWorkspace",
+ "operationalInsightsResourceProvider": "Microsoft.OperationalIinsights",
+ "settingsName": "EyesOn"
+ },
+ "responses": {
+ "200": {},
+ "204": {}
+ }
+}
diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/examples/settings/GetAllSettings.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/examples/settings/GetAllSettings.json
new file mode 100644
index 000000000000..6bd881fec292
--- /dev/null
+++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/examples/settings/GetAllSettings.json
@@ -0,0 +1,26 @@
+{
+ "parameters": {
+ "api-version": "2019-01-01-preview",
+ "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0",
+ "resourceGroupName": "myRg",
+ "workspaceName": "myWorkspace",
+ "operationalInsightsResourceProvider": "Microsoft.OperationalIinsights"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "/subscriptions/bd794837-4d29-4647-9105-6339bfdb4e6a/resourceGroups/mms-eus/providers/Microsoft.OperationalInsights/workspaces/avdvirInt/providers/Microsoft.SecurityInsights/settings/EyesOn",
+ "name": "EyesOn",
+ "type": "Microsoft.SecurityInsights/settings",
+ "kind": "EyesOn",
+ "properties": {
+ "isEnabled": true
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/examples/settings/GetFusionSettings.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/examples/settings/GetEyesOnSetting.json
similarity index 56%
rename from specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/examples/settings/GetFusionSettings.json
rename to specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/examples/settings/GetEyesOnSetting.json
index e3bea3867310..de6a916d486f 100644
--- a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/examples/settings/GetFusionSettings.json
+++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/examples/settings/GetEyesOnSetting.json
@@ -5,16 +5,15 @@
"resourceGroupName": "myRg",
"workspaceName": "myWorkspace",
"operationalInsightsResourceProvider": "Microsoft.OperationalIinsights",
- "settingsName": "Fusion"
+ "settingsName": "EyesOn"
},
"responses": {
"200": {
"body": {
- "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/settings/Fusion",
- "name": "Fusion",
+ "id": "/subscriptions/bd794837-4d29-4647-9105-6339bfdb4e6a/resourceGroups/mms-eus/providers/Microsoft.OperationalInsights/workspaces/avdvirInt/providers/Microsoft.SecurityInsights/settings/EyesOn",
+ "name": "EyesOn",
"type": "Microsoft.SecurityInsights/settings",
- "kind": "ToggleSettings",
- "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"",
+ "kind": "EyesOn",
"properties": {
"isEnabled": true
}
diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/examples/settings/GetUebaSettings.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/examples/settings/UpdateEyesOnSetting.json
similarity index 51%
rename from specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/examples/settings/GetUebaSettings.json
rename to specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/examples/settings/UpdateEyesOnSetting.json
index 615415059d28..6da0f3ed95de 100644
--- a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/examples/settings/GetUebaSettings.json
+++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/examples/settings/UpdateEyesOnSetting.json
@@ -4,21 +4,24 @@
"subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0",
"resourceGroupName": "myRg",
"workspaceName": "myWorkspace",
- "operationalInsightsResourceProvider": "Microsoft.OperationalIinsights",
- "settingsName": "UEBA"
+ "operationalInsightsResourceProvider": "Microsoft.OperationalInsights",
+ "settingsName": "EyesOn",
+ "settings": {
+ "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"",
+ "kind": "EyesOn",
+ "properties": {}
+ }
},
"responses": {
"200": {
"body": {
- "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/settings/UEBA",
- "name": "UEBA",
+ "id": "/subscriptions/bd794837-4d29-4647-9105-6339bfdb4e6a/resourceGroups/mms-eus/providers/Microsoft.OperationalInsights/workspaces/avdvirInt/providers/Microsoft.SecurityInsights/settings/EyesOn",
+ "name": "EyesOn",
"type": "Microsoft.SecurityInsights/settings",
- "kind": "UebaSettings",
"etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"",
+ "kind": "EyesOn",
"properties": {
- "isEnabled": true,
- "statusInMcas": "Enabled",
- "atpLicenseStatus": "Enabled"
+ "isEnabled": true
}
}
}
diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/examples/settings/UpdateUebaSettings.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/examples/settings/UpdateUebaSettings.json
deleted file mode 100644
index 59b8b92e4892..000000000000
--- a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/examples/settings/UpdateUebaSettings.json
+++ /dev/null
@@ -1,38 +0,0 @@
-{
- "parameters": {
- "api-version": "2019-01-01-preview",
- "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0",
- "resourceGroupName": "myRg",
- "workspaceName": "myWorkspace",
- "operationalInsightsResourceProvider": "Microsoft.OperationalInsights",
- "settingsName": "UEBA",
- "settings": {
- "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/settings/UEBA",
- "name": "UEBA",
- "type": "Microsoft.SecurityInsights/settings",
- "kind": "UebaSettings",
- "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"",
- "properties": {
- "isEnabled": true,
- "statusInMcas": "Enabled",
- "atpLicenseStatus": "Enabled"
- }
- }
- },
- "responses": {
- "200": {
- "body": {
- "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/settings/UEBA",
- "name": "UEBA",
- "type": "Microsoft.SecurityInsights/settings",
- "kind": "UebaSettings",
- "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"",
- "properties": {
- "isEnabled": true,
- "statusInMcas": "Enabled",
- "atpLicenseStatus": "Enabled"
- }
- }
- }
- }
-}
diff --git a/specification/securityinsights/resource-manager/readme.az.md b/specification/securityinsights/resource-manager/readme.az.md
new file mode 100644
index 000000000000..eddcad53399f
--- /dev/null
+++ b/specification/securityinsights/resource-manager/readme.az.md
@@ -0,0 +1,24 @@
+## AZ
+
+These settings apply only when `--az` is specified on the command line.
+
+``` yaml $(az)
+az:
+ extensions: sentinel
+ namespace: azure.mgmt.securityinsight
+ package-name: azure-mgmt-securityinsight
+az-output-folder: $(azure-cli-extension-folder)/src/securityinsight
+python-sdk-output-folder: "$(az-output-folder)/azext_sentinel/vendored_sdks/securityinsight"
+
+#cli:
+# cli-directive:
+# directive on operationGroup
+# - select: 'operationGroup'
+# where:
+# operationGroup: 'operations'
+# hidden: true
+# - where:
+# parameter: location
+# required: true
+
+```
diff --git a/specification/securityinsights/resource-manager/readme.cli.md b/specification/securityinsights/resource-manager/readme.cli.md
new file mode 100644
index 000000000000..a9e918eefe21
--- /dev/null
+++ b/specification/securityinsights/resource-manager/readme.cli.md
@@ -0,0 +1,9 @@
+ CLI
+
+These settings apply only when `--cli` is specified on the command line.
+
+``` yaml $(cli)
+#cli:
+# test-scenario:
+# - name: Factories_CreateOrUpdate
+```
diff --git a/specification/securityinsights/resource-manager/readme.go.md b/specification/securityinsights/resource-manager/readme.go.md
index 639ffd574a13..0d9fb50cbd7c 100644
--- a/specification/securityinsights/resource-manager/readme.go.md
+++ b/specification/securityinsights/resource-manager/readme.go.md
@@ -14,6 +14,7 @@ go:
```yaml $(go) && $(multiapi)
batch:
- tag: package-composite-v1
+ - tag: package-2019-01-preview-only
```
### Tag: package-composite-v1 and go
@@ -22,5 +23,14 @@ These settings apply only when `--tag=package-composite-v1 --go` is specified on
Please also specify `--go-sdk-folder=`.
```yaml $(tag) == 'package-composite-v1' && $(go)
-output-folder: $(go-sdk-folder)/services/preview/$(namespace)/mgmt/2017-08-01-preview/$(namespace)
+output-folder: $(go-sdk-folder)/services/preview/$(namespace)/mgmt/v1.0/$(namespace)
+```
+
+### Tag: package-2019-01-preview-only and go
+
+These settings apply only when `--tag=package-2019-01-preview-only --go` is specified on the command line.
+Please also specify `--go-sdk-folder=`.
+
+```yaml $(tag) == 'package-2019-01-preview-only' && $(go)
+output-folder: $(go-sdk-folder)/services/preview/$(namespace)/mgmt/2019-01-01-preview/$(namespace)
```
diff --git a/specification/securityinsights/resource-manager/readme.md b/specification/securityinsights/resource-manager/readme.md
index a95268a0903a..c49bc63d957a 100644
--- a/specification/securityinsights/resource-manager/readme.md
+++ b/specification/securityinsights/resource-manager/readme.md
@@ -70,6 +70,7 @@ swagger-to-sdk:
- repo: azure-sdk-for-python
- repo: azure-sdk-for-js
- repo: azure-sdk-for-node
+ - repo: azure-cli-extensions
```
## C#
diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/BackupPartition-1.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/BackupPartition-1.json
new file mode 100644
index 000000000000..2a7638588821
--- /dev/null
+++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/BackupPartition-1.json
@@ -0,0 +1,12 @@
+{
+ "operationId": "BackupPartition",
+ "description": "This example shows how to trigger backup of a partition now, which is already configured for periodic backups. The newly created backup will be saved at the same location where the periodic backups are being saved.",
+ "parameters": {
+ "api-version": "6.4",
+ "partitionId": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d",
+ "BackupPartitionDescription": {}
+ },
+ "responses": {
+ "202": {}
+ }
+}
diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/BackupPartition-2.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/BackupPartition-2.json
new file mode 100644
index 000000000000..9aa037a4d490
--- /dev/null
+++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/BackupPartition-2.json
@@ -0,0 +1,18 @@
+{
+ "operationId": "BackupPartition",
+ "description": "This example shows how to trigger backup of a partition now, and save the backup to a specific Azure blob storage account.",
+ "parameters": {
+ "api-version": "6.4",
+ "partitionId": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d",
+ "BackupPartitionDescription": {
+ "BackupStorage": {
+ "StorageKind": "AzureBlobStore",
+ "ConnectionString": "DefaultEndpointsProtocol=https;AccountName=storagesample;AccountKey=",
+ "ContainerName": "BackupContainer"
+ }
+ }
+ },
+ "responses": {
+ "202": {}
+ }
+}
diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/BackupPartition-3.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/BackupPartition-3.json
new file mode 100644
index 000000000000..3d9ef05b08e4
--- /dev/null
+++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/BackupPartition-3.json
@@ -0,0 +1,19 @@
+{
+ "operationId": "BackupPartition",
+ "description": "This example shows how to trigger backup of a partition now, and save the backup to a specific file share accessible from all cluster nodes.",
+ "parameters": {
+ "api-version": "6.4",
+ "partitionId": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d",
+ "BackupPartitionDescription": {
+ "BackupStorage": {
+ "StorageKind": "FileShare",
+ "Path": "\\\\myshare\\backupshare",
+ "PrimaryUserName": "mydomain\\backupaccount",
+ "PrimaryPassword": "abcd1234"
+ }
+ }
+ },
+ "responses": {
+ "202": {}
+ }
+}
diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/CreateApplication-1.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/CreateApplication-1.json
new file mode 100644
index 000000000000..815b59ce3e50
--- /dev/null
+++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/CreateApplication-1.json
@@ -0,0 +1,15 @@
+{
+ "operationId": "CreateApplication",
+ "description": "This example shows how to create a Service Fabric application without overriding any application parameter values.",
+ "parameters": {
+ "api-version": "6.0",
+ "ApplicationDescription": {
+ "Name": "fabric:/samples/CalcApp",
+ "TypeVersion": "1.0",
+ "TypeName": "CalculatorApp"
+ }
+ },
+ "responses": {
+ "201": {}
+ }
+}
diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/CreateBackupPolicy-1.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/CreateBackupPolicy-1.json
new file mode 100644
index 000000000000..a2bb056ee6d0
--- /dev/null
+++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/CreateBackupPolicy-1.json
@@ -0,0 +1,34 @@
+{
+ "operationId": "CreateBackupPolicy",
+ "description": "This example shows how to create a backup policy which takes backup twice everyday at 9 AM and 5 PM UTC which shall get deleted after 3 months, with Azure blob store as the backup location.",
+ "parameters": {
+ "api-version": "6.4",
+ "BackupPolicyDescription": {
+ "Name": "DailyAzureBackupPolicy",
+ "AutoRestoreOnDataLoss": false,
+ "MaxIncrementalBackups": 3,
+ "Schedule": {
+ "ScheduleKind": "TimeBased",
+ "ScheduleFrequencyType": "Daily",
+ "RunTimes": [
+ "0001-01-01T09:00:00Z",
+ "0001-01-01T17:00:00Z"
+ ]
+ },
+ "Storage": {
+ "StorageKind": "AzureBlobStore",
+ "FriendlyName": "Azure_storagesample",
+ "ConnectionString": "DefaultEndpointsProtocol=https;AccountName=storagesample;AccountKey=",
+ "ContainerName": "BackupContainer"
+ },
+ "RetentionPolicy": {
+ "RetentionPolicyType": "Basic",
+ "MinimumNumberOfBackups": 20,
+ "RetentionDuration": "P3M"
+ }
+ }
+ },
+ "responses": {
+ "201": {}
+ }
+}
diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/CreateBackupPolicy-2.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/CreateBackupPolicy-2.json
new file mode 100644
index 000000000000..f688def9e59e
--- /dev/null
+++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/CreateBackupPolicy-2.json
@@ -0,0 +1,31 @@
+{
+ "operationId": "CreateBackupPolicy",
+ "description": "This example shows how to create a backup policy which takes backup every 10 minutes which shall get deleted after 20 days, with file share as the backup location.",
+ "parameters": {
+ "api-version": "6.4",
+ "BackupPolicyDescription": {
+ "Name": "FileShare10MinBackupPolicy",
+ "AutoRestoreOnDataLoss": false,
+ "MaxIncrementalBackups": 3,
+ "Schedule": {
+ "ScheduleKind": "FrequencyBased",
+ "Interval": "PT10M"
+ },
+ "Storage": {
+ "StorageKind": "FileShare",
+ "FriendlyName": "FileShare_myshare",
+ "Path": "\\\\myshare\\backupshare",
+ "PrimaryUserName": "backupaccount",
+ "PrimaryPassword": "abcd1234"
+ },
+ "RetentionPolicy": {
+ "RetentionPolicyType": "Basic",
+ "MinimumNumberOfBackups": 20,
+ "RetentionDuration": "P20D"
+ }
+ }
+ },
+ "responses": {
+ "201": {}
+ }
+}
diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/CreateName-1.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/CreateName-1.json
new file mode 100644
index 000000000000..39588770e334
--- /dev/null
+++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/CreateName-1.json
@@ -0,0 +1,13 @@
+{
+ "operationId": "CreateName",
+ "description": "This example shows how to create a new Service Fabric name. The name can be created under an existing name that represents an appliction or a service or under a completely new name.",
+ "parameters": {
+ "api-version": "6.0",
+ "NameDescription": {
+ "Name": "fabric:/samples/CalculatorApp/CalculatorService/Name-1"
+ }
+ },
+ "responses": {
+ "201": {}
+ }
+}
diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/CreateService-1.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/CreateService-1.json
new file mode 100644
index 000000000000..a969c12cd8a9
--- /dev/null
+++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/CreateService-1.json
@@ -0,0 +1,21 @@
+{
+ "operationId": "CreateService",
+ "description": "This example shows how to create a basic stateless Service Fabric service.",
+ "parameters": {
+ "applicationId": "test",
+ "api-version": "6.0",
+ "ServiceDescription": {
+ "ServiceKind": "Stateless",
+ "ApplicationName": "fabric:/test",
+ "ServiceName": "fabric:/test/test1",
+ "ServiceTypeName": "StatelessFrontendService",
+ "PartitionDescription": {
+ "PartitionScheme": "Singleton"
+ },
+ "InstanceCount": 4
+ }
+ },
+ "responses": {
+ "202": {}
+ }
+}
diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/CreateService-2.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/CreateService-2.json
new file mode 100644
index 000000000000..bc7ada6bb8be
--- /dev/null
+++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/CreateService-2.json
@@ -0,0 +1,23 @@
+{
+ "operationId": "CreateService",
+ "description": "This example shows how to create a basic stateful Service Fabric service.",
+ "parameters": {
+ "applicationId": "test",
+ "api-version": "6.0",
+ "ServiceDescription": {
+ "ServiceKind": "Stateful",
+ "ApplicationName": "fabric:/test",
+ "ServiceName": "fabric:/test/test2",
+ "ServiceTypeName": "StatefulBackendService",
+ "PartitionDescription": {
+ "PartitionScheme": "Singleton"
+ },
+ "TargetReplicaSetSize": 3,
+ "MinReplicaSetSize": 2,
+ "HasPersistedState": false
+ }
+ },
+ "responses": {
+ "202": {}
+ }
+}
diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/CreateService-3.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/CreateService-3.json
new file mode 100644
index 000000000000..75eaaea023df
--- /dev/null
+++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/CreateService-3.json
@@ -0,0 +1,47 @@
+{
+ "operationId": "CreateService",
+ "description": "This example shows how to create a stateless Service Fabric service with a dns name definied and auto scaling based on cpu usage.",
+ "parameters": {
+ "applicationId": "test",
+ "api-version": "6.0",
+ "ServiceDescription": {
+ "ServiceKind": "Stateless",
+ "ApplicationName": "fabric:/test",
+ "ServiceName": "fabric:/test/test1",
+ "ServiceTypeName": "StatelessFrontendService",
+ "InitializationData": [],
+ "PartitionDescription": {
+ "PartitionScheme": "Singleton"
+ },
+ "InstanceCount": 2,
+ "PlacementConstraints": "Color==Blue",
+ "CorrelationScheme": [],
+ "ServiceLoadMetrics": [],
+ "ServicePlacementPolicies": [],
+ "DefaultMoveCost": "Low",
+ "IsDefaultMoveCostSpecified": true,
+ "ServicePackageActivationMode": "ExclusiveProcess",
+ "ServiceDnsName": "test1.test",
+ "ScalingPolicies": [
+ {
+ "ScalingTrigger": {
+ "Kind": "AveragePartitionLoad",
+ "MetricName": "servicefabric:/_CpuCores",
+ "LowerLoadThreshold": "0.300000",
+ "UpperLoadThreshold": "0.800000",
+ "ScaleIntervalInSeconds": 600
+ },
+ "ScalingMechanism": {
+ "Kind": "PartitionInstanceCount",
+ "MinInstanceCount": 1,
+ "MaxInstanceCount": 6,
+ "ScaleIncrement": 2
+ }
+ }
+ ]
+ }
+ },
+ "responses": {
+ "202": {}
+ }
+}
diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/CreateService-4.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/CreateService-4.json
new file mode 100644
index 000000000000..2211ae300e4b
--- /dev/null
+++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/CreateService-4.json
@@ -0,0 +1,46 @@
+{
+ "operationId": "CreateService",
+ "description": "This example shows how to create a stateful Service Fabric service with named partitions and scaling enabled based on memory usage.",
+ "parameters": {
+ "applicationId": "test",
+ "api-version": "6.0",
+ "ServiceDescription": {
+ "ServiceKind": "Stateful",
+ "ApplicationName": "fabric:/test",
+ "ServiceName": "fabric:/test/test2",
+ "ServiceTypeName": "StatefulBackendService",
+ "InitializationData": [],
+ "PartitionDescription": {
+ "PartitionScheme": "Named",
+ "Count": 1,
+ "Names": [
+ "0"
+ ]
+ },
+ "TargetReplicaSetSize": 3,
+ "MinReplicaSetSize": 2,
+ "HasPersistedState": true,
+ "ServicePackageActivationMode": "ExclusiveProcess",
+ "ScalingPolicies": [
+ {
+ "ScalingTrigger": {
+ "Kind": "AverageServiceLoad",
+ "MetricName": "servicefabric:/_MemoryInMB",
+ "LowerLoadThreshold": "500",
+ "UpperLoadThreshold": "900",
+ "ScaleIntervalInSeconds": 600
+ },
+ "ScalingMechanism": {
+ "Kind": "AddRemoveIncrementalNamedPartition",
+ "MinPartitionCount": 1,
+ "MaxPartitionCount": 3,
+ "ScaleIncrement": 1
+ }
+ }
+ ]
+ }
+ },
+ "responses": {
+ "202": {}
+ }
+}
diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/DeleteBackupPolicy.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/DeleteBackupPolicy.json
new file mode 100644
index 000000000000..d4796b5ede08
--- /dev/null
+++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/DeleteBackupPolicy.json
@@ -0,0 +1,11 @@
+{
+ "operationId": "DeleteBackupPolicy",
+ "description": "This example shows how to delete an existing backup policy which is currently not associated with any backup entity.",
+ "parameters": {
+ "api-version": "6.4",
+ "backupPolicyName": "SampleBackupPolicy"
+ },
+ "responses": {
+ "200": {}
+ }
+}
diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/DisableApplicationBackup.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/DisableApplicationBackup.json
new file mode 100644
index 000000000000..964fdaa8c3f3
--- /dev/null
+++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/DisableApplicationBackup.json
@@ -0,0 +1,14 @@
+{
+ "operationId": "DisableApplicationBackup",
+ "description": "This example shows how to disable periodic backup for a stateful application which was previously enabled.",
+ "parameters": {
+ "api-version": "6.4",
+ "applicationId": "CalcApp",
+ "DisableBackupDescription": {
+ "CleanBackup": true
+ }
+ },
+ "responses": {
+ "202": {}
+ }
+}
diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/DisablePartitionBackup.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/DisablePartitionBackup.json
new file mode 100644
index 000000000000..1f6cc6b32ed3
--- /dev/null
+++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/DisablePartitionBackup.json
@@ -0,0 +1,14 @@
+{
+ "operationId": "DisablePartitionBackup",
+ "description": "This example shows how to disable periodic backup for a stateful partition which was previously enabled.",
+ "parameters": {
+ "api-version": "6.4",
+ "partitionId": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d",
+ "DisableBackupDescription": {
+ "CleanBackup": false
+ }
+ },
+ "responses": {
+ "202": {}
+ }
+}
diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/DisableServiceBackup.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/DisableServiceBackup.json
new file mode 100644
index 000000000000..14ca9acf4e25
--- /dev/null
+++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/DisableServiceBackup.json
@@ -0,0 +1,14 @@
+{
+ "operationId": "DisableServiceBackup",
+ "description": "This example shows how to disable periodic backup for a stateful service which was previously enabled.",
+ "parameters": {
+ "api-version": "6.4",
+ "serviceId": "CalcApp/CalcService",
+ "DisableBackupDescription": {
+ "CleanBackup": true
+ }
+ },
+ "responses": {
+ "202": {}
+ }
+}
diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/EnableApplicationBackup.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/EnableApplicationBackup.json
new file mode 100644
index 000000000000..b0e24cd35f67
--- /dev/null
+++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/EnableApplicationBackup.json
@@ -0,0 +1,14 @@
+{
+ "operationId": "EnableApplicationBackup",
+ "description": "This example shows how to enable periodic backup for a stateful application.",
+ "parameters": {
+ "api-version": "6.4",
+ "applicationId": "CalcApp",
+ "EnableBackupDescription": {
+ "BackupPolicyName": "DailyAzureBackupPolicy"
+ }
+ },
+ "responses": {
+ "202": {}
+ }
+}
diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/EnablePartitionBackup.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/EnablePartitionBackup.json
new file mode 100644
index 000000000000..739bd06ce60e
--- /dev/null
+++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/EnablePartitionBackup.json
@@ -0,0 +1,14 @@
+{
+ "operationId": "EnablePartitionBackup",
+ "description": "This example shows how to enable periodic backup for a stateful partition.",
+ "parameters": {
+ "api-version": "6.4",
+ "partitionId": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d",
+ "EnableBackupDescription": {
+ "BackupPolicyName": "DailyAzureBackupPolicy"
+ }
+ },
+ "responses": {
+ "202": {}
+ }
+}
diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/EnableServiceBackup.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/EnableServiceBackup.json
new file mode 100644
index 000000000000..0fe38fd714bc
--- /dev/null
+++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/EnableServiceBackup.json
@@ -0,0 +1,14 @@
+{
+ "operationId": "EnableServiceBackup",
+ "description": "This example shows how to enable periodic backup for a stateful service.",
+ "parameters": {
+ "api-version": "6.4",
+ "serviceId": "CalcApp/CalcService",
+ "EnableBackupDescription": {
+ "BackupPolicyName": "DailyAzureBackupPolicy"
+ }
+ },
+ "responses": {
+ "202": {}
+ }
+}
diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetAllEntitiesBackedUpByPolicy-1.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetAllEntitiesBackedUpByPolicy-1.json
new file mode 100644
index 000000000000..9f4e37d7fdf9
--- /dev/null
+++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetAllEntitiesBackedUpByPolicy-1.json
@@ -0,0 +1,27 @@
+{
+ "operationId": "GetAllEntitiesBackedUpByPolicy",
+ "description": "This example shows how to get list of backup entities that are currently associated with a backup policy. The number of results in a page are limited to maximum of two using the MaxResult parameter.",
+ "parameters": {
+ "api-version": "6.4",
+ "backupPolicyName": "DailyAzureBackupPolicy",
+ "MaxResults": 2
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": {
+ "ContinuationToken": "fabric:/DemoApp",
+ "Items": [
+ {
+ "EntityKind": "Application",
+ "ApplicationName": "fabric:/CalcApp"
+ },
+ {
+ "EntityKind": "Application",
+ "ApplicationName": "fabric:/DemoApp"
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetAllEntitiesBackedUpByPolicy-2.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetAllEntitiesBackedUpByPolicy-2.json
new file mode 100644
index 000000000000..18f3467fc9ed
--- /dev/null
+++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetAllEntitiesBackedUpByPolicy-2.json
@@ -0,0 +1,24 @@
+{
+ "operationId": "GetAllEntitiesBackedUpByPolicy",
+ "description": "This example shows how to get list of backup entities that are currently associated with a backup policy. This example uses the ContinuationToken parameter. The value of this parameter is provided from the previous query; in this case the example shown above. The response contains the remaining results and an empty ContinuationToken. The empty ContinuationToken indicates that additional results are not available.",
+ "parameters": {
+ "api-version": "6.4",
+ "backupPolicyName": "DailyAzureBackupPolicy",
+ "MaxResults": 2,
+ "ContinuationToken": "fabric:/DemoApp"
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": {
+ "ContinuationToken": "",
+ "Items": [
+ {
+ "EntityKind": "Service",
+ "ServiceName": "fabric:/VotingApp/VotingActorService"
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetApplicationBackupConfigurationInfo-1.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetApplicationBackupConfigurationInfo-1.json
new file mode 100644
index 000000000000..3d396dbf082d
--- /dev/null
+++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetApplicationBackupConfigurationInfo-1.json
@@ -0,0 +1,39 @@
+{
+ "operationId": "GetApplicationBackupConfigurationInfo",
+ "description": "This example shows how to get list of backup configuration for this application and entities (services and partitions) under this application. The number of results in a page are limited to maximum of two using the MaxResult parameter.",
+ "parameters": {
+ "api-version": "6.4",
+ "applicationId": "CalcApp",
+ "MaxResults": 2
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": {
+ "ContinuationToken": "fabric:/CalcApp/CalcService",
+ "Items": [
+ {
+ "Kind": "Application",
+ "PolicyName": "BackupPolicy1",
+ "PolicyInheritedFrom": "Application",
+ "ApplicationName": "fabric:/CalcApp",
+ "SuspensionInfo": {
+ "IsSuspended": false,
+ "SuspensionInheritedFrom": "Invalid"
+ }
+ },
+ {
+ "Kind": "Service",
+ "PolicyName": "BackupPolicy2",
+ "PolicyInheritedFrom": "Service",
+ "ServiceName": "fabric:/CalcApp/CalcService",
+ "SuspensionInfo": {
+ "IsSuspended": false,
+ "SuspensionInheritedFrom": "Invalid"
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetApplicationBackupConfigurationInfo-2.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetApplicationBackupConfigurationInfo-2.json
new file mode 100644
index 000000000000..1ca86bee1983
--- /dev/null
+++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetApplicationBackupConfigurationInfo-2.json
@@ -0,0 +1,31 @@
+{
+ "operationId": "GetApplicationBackupConfigurationInfo",
+ "description": "This example shows how to get list of backup configuration for this application and entities (services and partitions) under this application. The number of results in a page are limited to maximum of two using the MaxResult parameter. This example uses the ContinuationToken parameter. The value of this parameter is provided from the previous query; in this case the example shown above. The response contains the remaining results and an empty ContinuationToken. The empty ContinuationToken indicates that additional results are not available.",
+ "parameters": {
+ "api-version": "6.4",
+ "applicationId": "CalcApp",
+ "MaxResults": 2,
+ "ContinuationToken": "fabric:/CalcApp/CalcService"
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": {
+ "ContinuationToken": "",
+ "Items": [
+ {
+ "Kind": "Partition",
+ "PolicyName": "BackupPolicy2",
+ "PolicyInheritedFrom": "Service",
+ "ServiceName": "fabric:/CalcApp/CalcService",
+ "PartitionId": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d",
+ "SuspensionInfo": {
+ "IsSuspended": true,
+ "SuspensionInheritedFrom": "Partition"
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetApplicationBackupList-1.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetApplicationBackupList-1.json
new file mode 100644
index 000000000000..bc89f402c6bd
--- /dev/null
+++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetApplicationBackupList-1.json
@@ -0,0 +1,108 @@
+{
+ "operationId": "GetApplicationBackupList",
+ "description": "This example shows how to get list of application backups within a time range.",
+ "parameters": {
+ "api-version": "6.4",
+ "applicationId": "CalcApp",
+ "StartDateTimeFilter": "2018-01-01T00:00:00Z",
+ "EndDateTimeFilter": "2018-01-01T23:59:59Z"
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": {
+ "ContinuationToken": "",
+ "Items": [
+ {
+ "BackupId": "3a056ac9-7206-43c3-8424-6f6103003eba",
+ "BackupChainId": "3a056ac9-7206-43c3-8424-6f6103003eba",
+ "ApplicationName": "fabric:/CalcApp",
+ "ServiceName": "fabric:/CalcApp/CalcService",
+ "PartitionInformation": {
+ "LowKey": "-9223372036854775808",
+ "HighKey": "9223372036854775807",
+ "ServicePartitionKind": "Int64Range",
+ "Id": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d"
+ },
+ "BackupLocation": "CalcApp\\CalcService\\1daae3f5-7fd6-42e9-b1ba-8c05f873994d\\2018-01-01 09.00.55.zip",
+ "BackupType": "Full",
+ "ServiceManifestVersion": "1.0.0",
+ "EpochOfLastBackupRecord": {
+ "DataLossVersion": "131462452931584510",
+ "ConfigurationVersion": "8589934592"
+ },
+ "LsnOfLastBackupRecord": "261",
+ "CreationTimeUtc": "2018-01-01T09:00:55Z",
+ "FailureError": null
+ },
+ {
+ "BackupId": "7903dc2a-228d-44b0-b7c8-a13a6c9b46bd",
+ "BackupChainId": "3a056ac9-7206-43c3-8424-6f6103003eba",
+ "ApplicationName": "fabric:/CalcApp",
+ "ServiceManifestVersion": "1.0.0",
+ "ServiceName": "fabric:/CalcApp/CalcService",
+ "PartitionInformation": {
+ "LowKey": "-9223372036854775808",
+ "HighKey": "9223372036854775807",
+ "ServicePartitionKind": "Int64Range",
+ "Id": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d"
+ },
+ "BackupLocation": "CalcApp\\CalcService\\1daae3f5-7fd6-42e9-b1ba-8c05f873994d\\2018-01-01 17.01.02.zip",
+ "BackupType": "Incremental",
+ "EpochOfLastBackupRecord": {
+ "DataLossVersion": "131462452931584510",
+ "ConfigurationVersion": "8589934592"
+ },
+ "LsnOfLastBackupRecord": "446",
+ "CreationTimeUtc": "2018-01-01T17:01:02Z",
+ "FailureError": null
+ },
+ {
+ "BackupId": "0ff4fdbe-131c-4dfb-8249-7b4029ddc014",
+ "BackupChainId": "0ff4fdbe-131c-4dfb-8249-7b4029ddc014",
+ "ApplicationName": "fabric:/CalcApp",
+ "ServiceName": "fabric:/CalcApp/CalcService",
+ "ServiceManifestVersion": "1.0.0",
+ "PartitionInformation": {
+ "LowKey": "-9223372036854775808",
+ "HighKey": "9223372036854775807",
+ "ServicePartitionKind": "Int64Range",
+ "Id": "81645ec7-d260-4c59-9533-8f129bde8e83"
+ },
+ "BackupLocation": "CalcApp\\CalcService\\81645ec7-d260-4c59-9533-8f129bde8e83\\2018-01-01 09.01.02.zip",
+ "BackupType": "Full",
+ "EpochOfLastBackupRecord": {
+ "DataLossVersion": "131462452931584510",
+ "ConfigurationVersion": "8589934592"
+ },
+ "LsnOfLastBackupRecord": "161",
+ "CreationTimeUtc": "2018-01-01T09:01:02Z",
+ "FailureError": null
+ },
+ {
+ "BackupId": "d55a2d98-258b-4a34-8fe5-2063e81af9dc",
+ "BackupChainId": "0ff4fdbe-131c-4dfb-8249-7b4029ddc014",
+ "ApplicationName": "fabric:/CalcApp",
+ "ServiceName": "fabric:/CalcApp/CalcService",
+ "ServiceManifestVersion": "1.0.0",
+ "PartitionInformation": {
+ "LowKey": "-9223372036854775808",
+ "HighKey": "9223372036854775807",
+ "ServicePartitionKind": "Int64Range",
+ "Id": "81645ec7-d260-4c59-9533-8f129bde8e83"
+ },
+ "BackupLocation": "CalcApp\\CalcService\\81645ec7-d260-4c59-9533-8f129bde8e83\\2018-01-01 17.00.34.zip",
+ "BackupType": "Incremental",
+ "EpochOfLastBackupRecord": {
+ "DataLossVersion": "131462452931584510",
+ "ConfigurationVersion": "8589934592"
+ },
+ "LsnOfLastBackupRecord": "246",
+ "CreationTimeUtc": "2018-01-01T17:00:34Z",
+ "FailureError": null
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetApplicationBackupList-2.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetApplicationBackupList-2.json
new file mode 100644
index 000000000000..adb11bc306b8
--- /dev/null
+++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetApplicationBackupList-2.json
@@ -0,0 +1,63 @@
+{
+ "operationId": "GetApplicationBackupList",
+ "description": "This example shows how to get the latest backup for each partition within an application.",
+ "parameters": {
+ "api-version": "6.4",
+ "applicationId": "CalcApp",
+ "Latest": true
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": {
+ "ContinuationToken": "",
+ "Items": [
+ {
+ "BackupId": "7903dc2a-228d-44b0-b7c8-a13a6c9b46bd",
+ "BackupChainId": "3a056ac9-7206-43c3-8424-6f6103003eba",
+ "ApplicationName": "fabric:/CalcApp",
+ "ServiceName": "fabric:/CalcApp/CalcService",
+ "ServiceManifestVersion": "1.0.0",
+ "PartitionInformation": {
+ "LowKey": "-9223372036854775808",
+ "HighKey": "9223372036854775807",
+ "ServicePartitionKind": "Int64Range",
+ "Id": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d"
+ },
+ "BackupLocation": "CalcApp\\CalcService\\1daae3f5-7fd6-42e9-b1ba-8c05f873994d\\2018-01-01 17.01.02.zip",
+ "BackupType": "Incremental",
+ "EpochOfLastBackupRecord": {
+ "DataLossVersion": "131462452931584510",
+ "ConfigurationVersion": "8589934592"
+ },
+ "LsnOfLastBackupRecord": "446",
+ "CreationTimeUtc": "2018-01-01T17:01:02Z",
+ "FailureError": null
+ },
+ {
+ "BackupId": "d55a2d98-258b-4a34-8fe5-2063e81af9dc",
+ "BackupChainId": "0ff4fdbe-131c-4dfb-8249-7b4029ddc014",
+ "ApplicationName": "fabric:/CalcApp",
+ "ServiceManifestVersion": "1.0.0",
+ "ServiceName": "fabric:/CalcApp/CalcService",
+ "PartitionInformation": {
+ "LowKey": "-9223372036854775808",
+ "HighKey": "9223372036854775807",
+ "ServicePartitionKind": "Int64Range",
+ "Id": "81645ec7-d260-4c59-9533-8f129bde8e83"
+ },
+ "BackupLocation": "CalcApp\\CalcService\\81645ec7-d260-4c59-9533-8f129bde8e83\\2018-01-01 17.00.34.zip",
+ "BackupType": "Incremental",
+ "EpochOfLastBackupRecord": {
+ "DataLossVersion": "131462452931584510",
+ "ConfigurationVersion": "8589934592"
+ },
+ "LsnOfLastBackupRecord": "246",
+ "CreationTimeUtc": "2018-01-01T17:00:34Z",
+ "FailureError": null
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetApplicationBackupList-3.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetApplicationBackupList-3.json
new file mode 100644
index 000000000000..189ba7d18cbf
--- /dev/null
+++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetApplicationBackupList-3.json
@@ -0,0 +1,63 @@
+{
+ "operationId": "GetApplicationBackupList",
+ "description": "This example shows how to get list of application backups. The number of results in a page are limited to maximum of two using the MaxResult parameter.",
+ "parameters": {
+ "api-version": "6.4",
+ "applicationId": "CalcApp",
+ "MaxResults": 2
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": {
+ "ContinuationToken": "fabric:/CalcApp/CalcService#1daae3f5-7fd6-42e9-b1ba-8c05f873994d#7903dc2a-228d-44b0-b7c8-a13a6c9b46bd",
+ "Items": [
+ {
+ "BackupId": "3a056ac9-7206-43c3-8424-6f6103003eba",
+ "BackupChainId": "3a056ac9-7206-43c3-8424-6f6103003eba",
+ "ApplicationName": "fabric:/CalcApp",
+ "ServiceManifestVersion": "1.0.0",
+ "ServiceName": "fabric:/CalcApp/CalcService",
+ "PartitionInformation": {
+ "LowKey": "-9223372036854775808",
+ "HighKey": "9223372036854775807",
+ "ServicePartitionKind": "Int64Range",
+ "Id": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d"
+ },
+ "BackupLocation": "CalcApp\\CalcService\\1daae3f5-7fd6-42e9-b1ba-8c05f873994d\\2018-01-01 09.00.55.zip",
+ "BackupType": "Full",
+ "EpochOfLastBackupRecord": {
+ "DataLossVersion": "131462452931584510",
+ "ConfigurationVersion": "8589934592"
+ },
+ "LsnOfLastBackupRecord": "261",
+ "CreationTimeUtc": "2018-01-01T09:00:55Z",
+ "FailureError": null
+ },
+ {
+ "BackupId": "7903dc2a-228d-44b0-b7c8-a13a6c9b46bd",
+ "BackupChainId": "3a056ac9-7206-43c3-8424-6f6103003eba",
+ "ApplicationName": "fabric:/CalcApp",
+ "ServiceManifestVersion": "1.0.0",
+ "ServiceName": "fabric:/CalcApp/CalcService",
+ "PartitionInformation": {
+ "LowKey": "-9223372036854775808",
+ "HighKey": "9223372036854775807",
+ "ServicePartitionKind": "Int64Range",
+ "Id": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d"
+ },
+ "BackupLocation": "CalcApp\\CalcService\\1daae3f5-7fd6-42e9-b1ba-8c05f873994d\\2018-01-01 17.01.02.zip",
+ "BackupType": "Incremental",
+ "EpochOfLastBackupRecord": {
+ "DataLossVersion": "131462452931584510",
+ "ConfigurationVersion": "8589934592"
+ },
+ "LsnOfLastBackupRecord": "446",
+ "CreationTimeUtc": "2018-01-01T17:01:02Z",
+ "FailureError": null
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetApplicationBackupList-4.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetApplicationBackupList-4.json
new file mode 100644
index 000000000000..537af235a0e2
--- /dev/null
+++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetApplicationBackupList-4.json
@@ -0,0 +1,64 @@
+{
+ "operationId": "GetApplicationBackupList",
+ "description": "This example shows how to get list of application backups. The number of results in a page are limited to maximum of two using the MaxResult parameter. This example uses the ContinuationToken parameter. The value of this parameter is provided from the previous query; in this case the example shown above. The response contains the remaining results and an empty ContinuationToken. The empty ContinuationToken indicates that additional results are not available.",
+ "parameters": {
+ "api-version": "6.4",
+ "applicationId": "CalcApp",
+ "MaxResults": 2,
+ "ContinuationToken": "fabric:/CalcApp/CalcService#1daae3f5-7fd6-42e9-b1ba-8c05f873994d#7903dc2a-228d-44b0-b7c8-a13a6c9b46bd"
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": {
+ "ContinuationToken": "",
+ "Items": [
+ {
+ "BackupId": "0ff4fdbe-131c-4dfb-8249-7b4029ddc014",
+ "BackupChainId": "0ff4fdbe-131c-4dfb-8249-7b4029ddc014",
+ "ApplicationName": "fabric:/CalcApp",
+ "ServiceManifestVersion": "1.0.0",
+ "ServiceName": "fabric:/CalcApp/CalcService",
+ "PartitionInformation": {
+ "LowKey": "-9223372036854775808",
+ "HighKey": "9223372036854775807",
+ "ServicePartitionKind": "Int64Range",
+ "Id": "81645ec7-d260-4c59-9533-8f129bde8e83"
+ },
+ "BackupLocation": "CalcApp\\CalcService\\81645ec7-d260-4c59-9533-8f129bde8e83\\2018-01-01 09.01.02.zip",
+ "BackupType": "Full",
+ "EpochOfLastBackupRecord": {
+ "DataLossVersion": "131462452931584510",
+ "ConfigurationVersion": "8589934592"
+ },
+ "LsnOfLastBackupRecord": "161",
+ "CreationTimeUtc": "2018-01-01T09:01:02Z",
+ "FailureError": null
+ },
+ {
+ "BackupId": "d55a2d98-258b-4a34-8fe5-2063e81af9dc",
+ "BackupChainId": "0ff4fdbe-131c-4dfb-8249-7b4029ddc014",
+ "ApplicationName": "fabric:/CalcApp",
+ "ServiceManifestVersion": "1.0.0",
+ "ServiceName": "fabric:/CalcApp/CalcService",
+ "PartitionInformation": {
+ "LowKey": "-9223372036854775808",
+ "HighKey": "9223372036854775807",
+ "ServicePartitionKind": "Int64Range",
+ "Id": "81645ec7-d260-4c59-9533-8f129bde8e83"
+ },
+ "BackupLocation": "CalcApp\\CalcService\\81645ec7-d260-4c59-9533-8f129bde8e83\\2018-01-01 17.00.34.zip",
+ "BackupType": "Incremental",
+ "EpochOfLastBackupRecord": {
+ "DataLossVersion": "131462452931584510",
+ "ConfigurationVersion": "8589934592"
+ },
+ "LsnOfLastBackupRecord": "246",
+ "CreationTimeUtc": "2018-01-01T17:00:34Z",
+ "FailureError": null
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetApplicationEventList.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetApplicationEventList.json
new file mode 100644
index 000000000000..32bca288ae42
--- /dev/null
+++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetApplicationEventList.json
@@ -0,0 +1,27 @@
+{
+ "operationId": "GetApplicationEventList",
+ "description": "This example shows how to get all application-related events during a certain time window.",
+ "parameters": {
+ "applicationId": "app1",
+ "api-version": "6.4",
+ "StartTimeUtc": "2018-04-03T18:00:00Z",
+ "EndTimeUtc": "2018-04-04T18:00:00Z"
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": [
+ {
+ "Kind": "ApplicationCreated",
+ "ApplicationTypeName": "App1Type",
+ "ApplicationTypeVersion": "1.0.1",
+ "ApplicationDefinitionKind": "ServiceFabricApplicationDescription",
+ "ApplicationId": "app1",
+ "EventInstanceId": "8a7a0c42-67ca-4cd3-9160-edcdb822db10",
+ "TimeStamp": "2018-04-03T20:21:23.5774199Z",
+ "HasCorrelatedEvents": false
+ }
+ ]
+ }
+ }
+}
diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetApplicationInfoByName-1.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetApplicationInfoByName-1.json
new file mode 100644
index 000000000000..6d9746679571
--- /dev/null
+++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetApplicationInfoByName-1.json
@@ -0,0 +1,24 @@
+{
+ "operationId": "GetApplicationInfo",
+ "description": "This example shows how to get information about an application using it's identifier. If the application is found, information about it is returned with 200 status code. If the application is not found, empty content is returned with 204 status code.",
+ "parameters": {
+ "api-version": "6.0",
+ "applicationId": "samples~CalculatorApp"
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": {
+ "Id": "samples~CalculatorApp",
+ "Name": "fabric:/samples/CalculatorApp",
+ "TypeName": "CalculatorApp",
+ "TypeVersion": "1.0",
+ "Status": "Ready",
+ "Parameters": [],
+ "HealthState": "Ok",
+ "ApplicationDefinitionKind": "ServiceFabricApplicationDescription"
+ }
+ },
+ "204": {}
+ }
+}
diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetApplicationInfoList-1.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetApplicationInfoList-1.json
new file mode 100644
index 000000000000..2ca46b64e3a4
--- /dev/null
+++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetApplicationInfoList-1.json
@@ -0,0 +1,38 @@
+{
+ "operationId": "GetApplicationInfoList",
+ "description": "This example shows how to get information about applications on the cluster. The number of results in a page are limited to maximum of two using the MaxResult parameter.",
+ "parameters": {
+ "api-version": "6.1",
+ "MaxResults": 2
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": {
+ "ContinuationToken": "fabric:/samples/PQueueApp1",
+ "Items": [
+ {
+ "Id": "samples~CalculatorApp",
+ "Name": "fabric:/samples/CalculatorApp",
+ "TypeName": "CalculatorApp",
+ "TypeVersion": "1.0",
+ "Status": "Ready",
+ "Parameters": [],
+ "HealthState": "Ok",
+ "ApplicationDefinitionKind": "ServiceFabricApplicationDescription"
+ },
+ {
+ "Id": "samples~PQueueApp1",
+ "Name": "fabric:/samples/PQueueApp1",
+ "TypeName": "PersistentQueueApp",
+ "TypeVersion": "1.0",
+ "Status": "Ready",
+ "Parameters": [],
+ "HealthState": "Ok",
+ "ApplicationDefinitionKind": "ServiceFabricApplicationDescription"
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetApplicationInfoList-2.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetApplicationInfoList-2.json
new file mode 100644
index 000000000000..c0755d26e14b
--- /dev/null
+++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetApplicationInfoList-2.json
@@ -0,0 +1,29 @@
+{
+ "operationId": "GetApplicationInfoList",
+ "description": "This example shows how to page through the information about applications on the cluster using the ContinuationToken parameter. The value of this parameter is provided from the previous query, in this case the example shown above. The response contains the remaining one result and an empty ContinuationToken. The empty ContinuationToken indicates that additional results are not available.",
+ "parameters": {
+ "api-version": "6.1",
+ "MaxResults": 2,
+ "ContinuationToken": "fabric:/samples/PQueueApp1"
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": {
+ "ContinuationToken": "",
+ "Items": [
+ {
+ "Id": "samples~VQueueApp1",
+ "Name": "fabric:/samples/VQueueApp1",
+ "TypeName": "VolatileQueueApp",
+ "TypeVersion": "1.0",
+ "Status": "Ready",
+ "Parameters": [],
+ "HealthState": "Ok",
+ "ApplicationDefinitionKind": "ServiceFabricApplicationDescription"
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetApplicationTypeInfoList-1.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetApplicationTypeInfoList-1.json
new file mode 100644
index 000000000000..bcb6a4e5e3b7
--- /dev/null
+++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetApplicationTypeInfoList-1.json
@@ -0,0 +1,85 @@
+{
+ "operationId": "GetApplicationTypeInfoList",
+ "description": "This example shows how to get information about application types that are provisioned or being provisioned in the cluster. The number of results in a page are limited to maximum of five using MaxResult parameter.",
+ "parameters": {
+ "api-version": "6.0",
+ "MaxResults": 5
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": {
+ "ContinuationToken": "PersistentQueueApp+2.0",
+ "Items": [
+ {
+ "Name": "CalculatorApp",
+ "Version": "1.0",
+ "DefaultParameterList": [
+ {
+ "Key": "ServiceInstanceCount",
+ "Value": "3"
+ }
+ ],
+ "Status": "Available"
+ },
+ {
+ "Name": "CalculatorApp",
+ "Version": "2.0",
+ "DefaultParameterList": [
+ {
+ "Key": "ServiceInstanceCount",
+ "Value": "3"
+ }
+ ],
+ "Status": "Available"
+ },
+ {
+ "Name": "GatewayApp",
+ "Version": "1.0",
+ "DefaultParameterList": [
+ {
+ "Key": "GatewayPort",
+ "Value": "8505"
+ },
+ {
+ "Key": "ServiceInstanceCount",
+ "Value": "1000"
+ }
+ ],
+ "Status": "Available"
+ },
+ {
+ "Name": "PersistentQueueApp",
+ "Version": "1.0",
+ "DefaultParameterList": [
+ {
+ "Key": "MinReplicaSetSize",
+ "Value": "2"
+ },
+ {
+ "Key": "TargetReplicaSetSize",
+ "Value": "3"
+ }
+ ],
+ "Status": "Available"
+ },
+ {
+ "Name": "PersistentQueueApp",
+ "Version": "2.0",
+ "DefaultParameterList": [
+ {
+ "Key": "MinReplicaSetSize",
+ "Value": "2"
+ },
+ {
+ "Key": "TargetReplicaSetSize",
+ "Value": "3"
+ }
+ ],
+ "Status": "Available"
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetApplicationTypeInfoList-2.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetApplicationTypeInfoList-2.json
new file mode 100644
index 000000000000..a7c38cdedbe7
--- /dev/null
+++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetApplicationTypeInfoList-2.json
@@ -0,0 +1,49 @@
+{
+ "operationId": "GetApplicationTypeInfoList",
+ "description": "This example shows how to page through the information about application types that are provisioned or being provisioned in the cluster using ContinuationToken parameter. The value of this parameter is provided from the previous query, in this case the example shown above. The response contains the remaining two results and an empty ContinuationToken. The empty ContinuationToken indicates that additional results are not available.",
+ "parameters": {
+ "api-version": "6.0",
+ "MaxResults": 5,
+ "ContinuationToken": "PersistentQueueApp+2.0"
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": {
+ "ContinuationToken": "",
+ "Items": [
+ {
+ "Name": "VolatileQueueApp",
+ "Version": "1.0",
+ "DefaultParameterList": [
+ {
+ "Key": "MinReplicaSetSize",
+ "Value": "2"
+ },
+ {
+ "Key": "TargetReplicaSetSize",
+ "Value": "3"
+ }
+ ],
+ "Status": "Available"
+ },
+ {
+ "Name": "VolatileQueueApp",
+ "Version": "2.0",
+ "DefaultParameterList": [
+ {
+ "Key": "MinReplicaSetSize",
+ "Value": "2"
+ },
+ {
+ "Key": "TargetReplicaSetSize",
+ "Value": "3"
+ }
+ ],
+ "Status": "Available"
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetApplicationTypeInfoList-3.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetApplicationTypeInfoList-3.json
new file mode 100644
index 000000000000..473565e56c6d
--- /dev/null
+++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetApplicationTypeInfoList-3.json
@@ -0,0 +1,60 @@
+{
+ "operationId": "GetApplicationTypeInfoList",
+ "description": "This example shows how to exclude application parameter in the result when getting the information about application types that are provisioned or being provisioned in the cluster.",
+ "parameters": {
+ "api-version": "6.0",
+ "ExcludeApplicationParameters": true
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": {
+ "ContinuationToken": "",
+ "Items": [
+ {
+ "Name": "CalculatorApp",
+ "Version": "1.0",
+ "DefaultParameterList": [],
+ "Status": "Available"
+ },
+ {
+ "Name": "CalculatorApp",
+ "Version": "2.0",
+ "DefaultParameterList": [],
+ "Status": "Available"
+ },
+ {
+ "Name": "GatewayApp",
+ "Version": "1.0",
+ "DefaultParameterList": [],
+ "Status": "Available"
+ },
+ {
+ "Name": "PersistentQueueApp",
+ "Version": "1.0",
+ "DefaultParameterList": [],
+ "Status": "Available"
+ },
+ {
+ "Name": "PersistentQueueApp",
+ "Version": "2.0",
+ "DefaultParameterList": [],
+ "Status": "Available"
+ },
+ {
+ "Name": "VolatileQueueApp",
+ "Version": "1.0",
+ "DefaultParameterList": [],
+ "Status": "Available"
+ },
+ {
+ "Name": "VolatileQueueApp",
+ "Version": "2.0",
+ "DefaultParameterList": [],
+ "Status": "Available"
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetApplicationsEventList.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetApplicationsEventList.json
new file mode 100644
index 000000000000..fa65ec159120
--- /dev/null
+++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetApplicationsEventList.json
@@ -0,0 +1,36 @@
+{
+ "operationId": "GetApplicationsEventList",
+ "description": "This example shows how to get all applications-related events during a certain time window.",
+ "parameters": {
+ "api-version": "6.4",
+ "StartTimeUtc": "2018-04-03T18:00:00Z",
+ "EndTimeUtc": "2018-04-04T18:00:00Z"
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": [
+ {
+ "Kind": "ApplicationCreated",
+ "ApplicationTypeName": "App1Type",
+ "ApplicationTypeVersion": "1.0.1",
+ "ApplicationDefinitionKind": "ServiceFabricApplicationDescription",
+ "ApplicationId": "app1",
+ "EventInstanceId": "8a7a0c42-67ca-4cd3-9160-edcdb822db10",
+ "TimeStamp": "2018-04-03T20:21:23.5774199Z",
+ "HasCorrelatedEvents": false
+ },
+ {
+ "Kind": "ApplicationCreated",
+ "ApplicationTypeName": "App2Type",
+ "ApplicationTypeVersion": "4.0.1",
+ "ApplicationDefinitionKind": "ServiceFabricApplicationDescription",
+ "ApplicationId": "app2",
+ "EventInstanceId": "d50574bc-6a31-4945-8275-7639bec7a0b3",
+ "TimeStamp": "2018-04-03T20:21:59.74842Z",
+ "HasCorrelatedEvents": false
+ }
+ ]
+ }
+ }
+}
diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetBackupPolicyByName.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetBackupPolicyByName.json
new file mode 100644
index 000000000000..411b836109b2
--- /dev/null
+++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetBackupPolicyByName.json
@@ -0,0 +1,36 @@
+{
+ "operationId": "GetBackupPolicyByName",
+ "description": "This example shows how to query a backup policy by name.",
+ "parameters": {
+ "api-version": "6.4",
+ "backupPolicyName": "DailyAzureBackupPolicy"
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": {
+ "Name": "DailyAzureBackupPolicy",
+ "AutoRestoreOnDataLoss": false,
+ "MaxIncrementalBackups": 3,
+ "Schedule": {
+ "ScheduleKind": "TimeBased",
+ "ScheduleFrequencyType": "Daily",
+ "RunTimes": [
+ "0001-01-01T09:00:00Z",
+ "0001-01-01T17:00:00Z"
+ ]
+ },
+ "Storage": {
+ "StorageKind": "AzureBlobStore",
+ "ConnectionString": "DefaultEndpointsProtocol=https;AccountName=storagesample;AccountKey=",
+ "ContainerName": "BackupContainer"
+ },
+ "RetentionPolicy": {
+ "RetentionPolicyType": "Basic",
+ "MinimumNumberOfBackups": 20,
+ "RetentionDuration": "P20D"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetBackupPolicyList-1.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetBackupPolicyList-1.json
new file mode 100644
index 000000000000..d4ac30f0658a
--- /dev/null
+++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetBackupPolicyList-1.json
@@ -0,0 +1,63 @@
+{
+ "operationId": "GetBackupPolicyList",
+ "description": "This example shows how to get list of backup policies. The number of results in a page are limited to maximum of two using the MaxResult parameter.",
+ "parameters": {
+ "api-version": "6.4",
+ "MaxResults": 2
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": {
+ "ContinuationToken": "FileShare10MinBackupPolicy",
+ "Items": [
+ {
+ "Name": "DailyAzureBackupPolicy",
+ "AutoRestoreOnDataLoss": false,
+ "MaxIncrementalBackups": 3,
+ "Schedule": {
+ "ScheduleKind": "TimeBased",
+ "ScheduleFrequencyType": "Daily",
+ "RunTimes": [
+ "0001-01-01T09:00:00Z",
+ "0001-01-01T17:00:00Z"
+ ]
+ },
+ "Storage": {
+ "StorageKind": "AzureBlobStore",
+ "FriendlyName": "Azure_storagesample",
+ "ConnectionString": "DefaultEndpointsProtocol=https;AccountName=storagesample;AccountKey=",
+ "ContainerName": "BackupContainer"
+ },
+ "RetentionPolicy": {
+ "RetentionPolicyType": "Basic",
+ "MinimumNumberOfBackups": 30,
+ "RetentionDuration": "P29D"
+ }
+ },
+ {
+ "Name": "FileShare10MinBackupPolicy",
+ "AutoRestoreOnDataLoss": false,
+ "MaxIncrementalBackups": 3,
+ "Schedule": {
+ "ScheduleKind": "FrequencyBased",
+ "Interval": "PT10M"
+ },
+ "Storage": {
+ "StorageKind": "FileShare",
+ "FriendlyName": "FileShare_myshare",
+ "Path": "\\\\myshare\\backupshare",
+ "PrimaryUserName": "backupaccount",
+ "PrimaryPassword": "****"
+ },
+ "RetentionPolicy": {
+ "RetentionPolicyType": "Basic",
+ "MinimumNumberOfBackups": 20,
+ "RetentionDuration": "P20D"
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetBackupPolicyList-2.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetBackupPolicyList-2.json
new file mode 100644
index 000000000000..ad0e9a860ae4
--- /dev/null
+++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetBackupPolicyList-2.json
@@ -0,0 +1,42 @@
+{
+ "operationId": "GetBackupPolicyList",
+ "description": "This example shows how to get list of backup policies. The number of results in a page are limited to maximum of two using the MaxResult parameter. This example uses the ContinuationToken parameter. The value of this parameter is provided from the previous query; in this case the example shown above. The response contains the remaining results and an empty ContinuationToken. The empty ContinuationToken indicates that additional results are not available.",
+ "parameters": {
+ "api-version": "6.4",
+ "MaxResults": 2,
+ "ContinuationToken": "FileShare10MinBackupPolicy"
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": {
+ "ContinuationToken": "",
+ "Items": [
+ {
+ "AutoRestoreOnDataLoss": false,
+ "Name": "SampleBackupPolicy",
+ "MaxIncrementalBackups": 5,
+ "Schedule": {
+ "ScheduleKind": "FrequencyBased",
+ "Interval": "PT4H5M"
+ },
+ "Storage": {
+ "Path": "\\\\myshare\\BackupStore",
+ "PrimaryUserName": "myuser1",
+ "PrimaryPassword": "****",
+ "SecondaryUserName": "myuser2",
+ "SecondaryPassword": "****",
+ "StorageKind": "FileShare",
+ "FriendlyName": ""
+ },
+ "RetentionPolicy": {
+ "RetentionPolicyType": "Basic",
+ "MinimumNumberOfBackups": 0,
+ "RetentionDuration": "P20D"
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetBackupsFromBackupLocation-1.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetBackupsFromBackupLocation-1.json
new file mode 100644
index 000000000000..6925de02aeb5
--- /dev/null
+++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetBackupsFromBackupLocation-1.json
@@ -0,0 +1,73 @@
+{
+ "operationId": "GetBackupsFromBackupLocation",
+ "description": "This example shows how to get list of application backups from a specified backup location. The number of results in a page are limited to maximum of two using the MaxResult parameter.",
+ "parameters": {
+ "api-version": "6.4",
+ "MaxResults": 2,
+ "GetBackupByStorageQueryDescription": {
+ "Storage": {
+ "StorageKind": "AzureBlobStore",
+ "ConnectionString": "DefaultEndpointsProtocol=https;AccountName=storagesample;AccountKey=",
+ "ContainerName": "BackupContainer"
+ },
+ "BackupEntity": {
+ "EntityKind": "Application",
+ "ApplicationName": "fabric:/CalcApp"
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": {
+ "ContinuationToken": "fabric:/CalcApp/CalcService#1daae3f5-7fd6-42e9-b1ba-8c05f873994d#7903dc2a-228d-44b0-b7c8-a13a6c9b46bd",
+ "Items": [
+ {
+ "BackupId": "3a056ac9-7206-43c3-8424-6f6103003eba",
+ "BackupChainId": "3a056ac9-7206-43c3-8424-6f6103003eba",
+ "ApplicationName": "fabric:/CalcApp",
+ "ServiceManifestVersion": "1.0.0",
+ "ServiceName": "fabric:/CalcApp/CalcService",
+ "PartitionInformation": {
+ "LowKey": "-9223372036854775808",
+ "HighKey": "9223372036854775807",
+ "ServicePartitionKind": "Int64Range",
+ "Id": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d"
+ },
+ "BackupLocation": "CalcApp\\CalcService\\1daae3f5-7fd6-42e9-b1ba-8c05f873994d\\2018-01-01 09.00.55.zip",
+ "BackupType": "Full",
+ "EpochOfLastBackupRecord": {
+ "DataLossVersion": "131462452931584510",
+ "ConfigurationVersion": "8589934592"
+ },
+ "LsnOfLastBackupRecord": "261",
+ "CreationTimeUtc": "2018-01-01T09:00:55Z",
+ "FailureError": null
+ },
+ {
+ "BackupId": "7903dc2a-228d-44b0-b7c8-a13a6c9b46bd",
+ "BackupChainId": "3a056ac9-7206-43c3-8424-6f6103003eba",
+ "ApplicationName": "fabric:/CalcApp",
+ "ServiceManifestVersion": "1.0.0",
+ "ServiceName": "fabric:/CalcApp/CalcService",
+ "PartitionInformation": {
+ "LowKey": "-9223372036854775808",
+ "HighKey": "9223372036854775807",
+ "ServicePartitionKind": "Int64Range",
+ "Id": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d"
+ },
+ "BackupLocation": "CalcApp\\CalcService\\1daae3f5-7fd6-42e9-b1ba-8c05f873994d\\2018-01-01 17.01.02.zip",
+ "BackupType": "Incremental",
+ "EpochOfLastBackupRecord": {
+ "DataLossVersion": "131462452931584510",
+ "ConfigurationVersion": "8589934592"
+ },
+ "LsnOfLastBackupRecord": "446",
+ "CreationTimeUtc": "2018-01-01T17:01:02Z",
+ "FailureError": null
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetBackupsFromBackupLocation-2.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetBackupsFromBackupLocation-2.json
new file mode 100644
index 000000000000..190f318797ab
--- /dev/null
+++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetBackupsFromBackupLocation-2.json
@@ -0,0 +1,74 @@
+{
+ "operationId": "GetBackupsFromBackupLocation",
+ "description": "This example shows how to get list of application backups. The number of results in a page are limited to maximum of two using the MaxResult parameter. This example uses the ContinuationToken parameter. The value of this parameter is provided from the previous query; in this case the example shown above. The response contains the remaining results and an empty ContinuationToken. The empty ContinuationToken indicates that additional results are not available.",
+ "parameters": {
+ "api-version": "6.4",
+ "MaxResults": 2,
+ "GetBackupByStorageQueryDescription": {
+ "Storage": {
+ "StorageKind": "AzureBlobStore",
+ "ConnectionString": "DefaultEndpointsProtocol=https;AccountName=storagesample;AccountKey=",
+ "ContainerName": "BackupContainer"
+ },
+ "BackupEntity": {
+ "EntityKind": "Application",
+ "ApplicationName": "fabric:/CalcApp"
+ }
+ },
+ "ContinuationToken": "fabric:/CalcApp/CalcService#1daae3f5-7fd6-42e9-b1ba-8c05f873994d#7903dc2a-228d-44b0-b7c8-a13a6c9b46bd"
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": {
+ "ContinuationToken": "",
+ "Items": [
+ {
+ "BackupId": "0ff4fdbe-131c-4dfb-8249-7b4029ddc014",
+ "BackupChainId": "0ff4fdbe-131c-4dfb-8249-7b4029ddc014",
+ "ApplicationName": "fabric:/CalcApp",
+ "ServiceManifestVersion": "1.0.0",
+ "ServiceName": "fabric:/CalcApp/CalcService",
+ "PartitionInformation": {
+ "LowKey": "-9223372036854775808",
+ "HighKey": "9223372036854775807",
+ "ServicePartitionKind": "Int64Range",
+ "Id": "81645ec7-d260-4c59-9533-8f129bde8e83"
+ },
+ "BackupLocation": "CalcApp\\CalcService\\81645ec7-d260-4c59-9533-8f129bde8e83\\2018-01-01 09.01.02.zip",
+ "BackupType": "Full",
+ "EpochOfLastBackupRecord": {
+ "DataLossVersion": "131462452931584510",
+ "ConfigurationVersion": "8589934592"
+ },
+ "LsnOfLastBackupRecord": "161",
+ "CreationTimeUtc": "2018-01-01T09:01:02Z",
+ "FailureError": null
+ },
+ {
+ "BackupId": "d55a2d98-258b-4a34-8fe5-2063e81af9dc",
+ "BackupChainId": "0ff4fdbe-131c-4dfb-8249-7b4029ddc014",
+ "ApplicationName": "fabric:/CalcApp",
+ "ServiceManifestVersion": "1.0.0",
+ "ServiceName": "fabric:/CalcApp/CalcService",
+ "PartitionInformation": {
+ "LowKey": "-9223372036854775808",
+ "HighKey": "9223372036854775807",
+ "ServicePartitionKind": "Int64Range",
+ "Id": "81645ec7-d260-4c59-9533-8f129bde8e83"
+ },
+ "BackupLocation": "CalcApp\\CalcService\\81645ec7-d260-4c59-9533-8f129bde8e83\\2018-01-01 17.00.34.zip",
+ "BackupType": "Incremental",
+ "EpochOfLastBackupRecord": {
+ "DataLossVersion": "131462452931584510",
+ "ConfigurationVersion": "8589934592"
+ },
+ "LsnOfLastBackupRecord": "246",
+ "CreationTimeUtc": "2018-01-01T17:00:34Z",
+ "FailureError": null
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetChaosEvents.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetChaosEvents.json
new file mode 100644
index 000000000000..4e5d7bb0b4e3
--- /dev/null
+++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetChaosEvents.json
@@ -0,0 +1,62 @@
+{
+ "operationId": "GetChaosEvents",
+ "description": "This example shows how to get Chaos events in a single response message without the need for paging through ContinuationToken parameter.",
+ "parameters": {
+ "api-version": "6.2",
+ "StartTimeUtc": "0",
+ "EndTimeUtc": "3155378975999999999"
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": {
+ "ContinuationToken": "",
+ "History": [
+ {
+ "ChaosEvent": {
+ "Kind": "Started",
+ "TimeStampUtc": "2017-04-14T04:27:19.049Z",
+ "ChaosParameters": {
+ "MaxClusterStabilizationTimeoutInSeconds": 30,
+ "MaxConcurrentFaults": 3,
+ "WaitTimeBetweenIterationsInSeconds": 10,
+ "WaitTimeBetweenFaultsInSeconds": 1,
+ "TimeToRunInSeconds": "3600",
+ "EnableMoveReplicaFaults": true,
+ "ClusterHealthPolicy": {
+ "ConsiderWarningAsError": true,
+ "MaxPercentUnhealthyNodes": 0,
+ "MaxPercentUnhealthyApplications": 10,
+ "ApplicationTypeHealthPolicyMap": [
+ {
+ "Key": "myapp",
+ "Value": 3
+ }
+ ]
+ },
+ "Context": {
+ "Map": {
+ "k1": "v1",
+ "k2": "v2",
+ "k3": "v5"
+ }
+ }
+ }
+ }
+ },
+ {
+ "ChaosEvent": {
+ "Kind": "ExecutingFaults",
+ "TimeStampUtc": "2017-04-14T04:27:20.667Z",
+ "Faults": [
+ "ActionType: RestartReplica, ServiceUri: fabric:/TestApp1/PersistServ_6R_1, PartitionId: 6a91b09a-bd76-45da-afaa-ed0fd9bfe7d2, ReplicaId: 131366172775684622",
+ "ActionType: CodePackageRestart, NodeName: N0050, ApplicationName: fabric:/TestApp1, ServiceManifestName: SP1, ServiceManifestName: , CodePackageName: CP1.",
+ "ActionType: RestartReplica, ServiceUri: fabric:/TestApp1/PersistServ_6R_3, PartitionId: baa3a51e-5c42-435e-89d3-6e97b2164661, ReplicaId: 131366172988968762"
+ ]
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetClusterEventList.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetClusterEventList.json
new file mode 100644
index 000000000000..3a122bb8aec0
--- /dev/null
+++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetClusterEventList.json
@@ -0,0 +1,55 @@
+{
+ "operationId": "GetClusterEventList",
+ "description": "This example shows how to get all cluster-related events during a certain time window.",
+ "parameters": {
+ "api-version": "6.4",
+ "StartTimeUtc": "2018-04-03T18:00:00Z",
+ "EndTimeUtc": "2018-04-04T18:00:00Z"
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": [
+ {
+ "Kind": "ClusterUpgradeStarted",
+ "CurrentClusterVersion": "0.0.0.0:",
+ "TargetClusterVersion": "6.2:1.0",
+ "UpgradeType": "Rolling",
+ "RollingUpgradeMode": "UnmonitoredAuto",
+ "FailureAction": "Manual",
+ "EventInstanceId": "090add3c-8f56-4d35-8d57-a855745b6064",
+ "TimeStamp": "2018-04-03T20:18:59.4313064Z",
+ "HasCorrelatedEvents": false
+ },
+ {
+ "Kind": "ClusterUpgradeDomainCompleted",
+ "TargetClusterVersion": "6.2:1.0",
+ "UpgradeState": "RollingForward",
+ "UpgradeDomains": "(0 1 2)",
+ "UpgradeDomainElapsedTimeInMs": 78.5288,
+ "EventInstanceId": "090add3c-8f56-4d35-8d57-a855745b6064",
+ "TimeStamp": "2018-04-03T20:19:59.5729953Z",
+ "HasCorrelatedEvents": false
+ },
+ {
+ "Kind": "ClusterUpgradeDomainCompleted",
+ "TargetClusterVersion": "6.2:1.0",
+ "UpgradeState": "RollingForward",
+ "UpgradeDomains": "(3 4)",
+ "UpgradeDomainElapsedTimeInMs": 0.0,
+ "EventInstanceId": "090add3c-8f56-4d35-8d57-a855745b6064",
+ "TimeStamp": "2018-04-03T20:20:59.6271949Z",
+ "HasCorrelatedEvents": false
+ },
+ {
+ "Kind": "ClusterUpgradeCompleted",
+ "TargetClusterVersion": "6.2:1.0",
+ "OverallUpgradeElapsedTimeInMs": 120196.5212,
+ "EventInstanceId": "090add3c-8f56-4d35-8d57-a855745b6064",
+ "TimeStamp": "2018-04-03T20:20:59.8134457Z",
+ "HasCorrelatedEvents": false
+ }
+ ]
+ }
+ }
+}
diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetClusterVersion-1.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetClusterVersion-1.json
new file mode 100644
index 000000000000..fd3b6fbf55b8
--- /dev/null
+++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetClusterVersion-1.json
@@ -0,0 +1,15 @@
+{
+ "operationId": "GetClusterVersion",
+ "description": "This example retrieves the current (or lowest version during upgrade) cluster version.",
+ "parameters": {
+ "api-version": "6.4"
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": {
+ "Version": "6.4.514.9494"
+ }
+ }
+ }
+}
diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetContainerLogsDeployedOnNode-1.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetContainerLogsDeployedOnNode-1.json
new file mode 100644
index 000000000000..1be29fb8e6ef
--- /dev/null
+++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetContainerLogsDeployedOnNode-1.json
@@ -0,0 +1,19 @@
+{
+ "operationId": "GetContainerLogsDeployedOnNode",
+ "description": "This example shows how to get container logs for container deployed on a Service Fabric node for the given code package.",
+ "parameters": {
+ "api-version": "6.2",
+ "nodeName": "_Node_0",
+ "applicationId": "SimpleHttpServerApp",
+ "ServiceManifestName": "SimpleHttpServerSvcPkg",
+ "CodePackageName": "Code"
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": {
+ "Content": "HTTP Server started listening on port 8080\r\n"
+ }
+ }
+ }
+}
diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetContainerLogsDeployedOnNode-2.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetContainerLogsDeployedOnNode-2.json
new file mode 100644
index 000000000000..9f1025363561
--- /dev/null
+++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetContainerLogsDeployedOnNode-2.json
@@ -0,0 +1,20 @@
+{
+ "operationId": "GetContainerLogsDeployedOnNode",
+ "description": "This example shows how to get last 10 lines of container logs for container deployed on a Service Fabric node for the given code package.",
+ "parameters": {
+ "api-version": "6.2",
+ "nodeName": "_Node_0",
+ "applicationId": "SimpleHttpServerApp",
+ "ServiceManifestName": "SimpleHttpServerSvcPkg",
+ "CodePackageName": "Code",
+ "Tail": "10"
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": {
+ "Content": "UTC Time Now: 04/02/2018 22:06:31\r\nUTC Time Now: 04/02/2018 22:06:32\r\nUTC Time Now: 04/02/2018 22:06:33\r\nUTC Time Now: 04/02/2018 22:06:344\r\nUTC Time Now: 04/02/2018 22:06:35\r\nUTC Time Now: 04/02/2018 22:06:36\r\nUTC Time Now: 04/02/2018 22:06:37\r\nUTC Time Now: 04/02/2018 22:06:38\r\nUTC Time Now: 04/02/2018 22:06:39\r\nUTC Time Now: 04/02/2018 22:06:40\r\n"
+ }
+ }
+ }
+}
diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetContainerLogsDeployedOnNode-3.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetContainerLogsDeployedOnNode-3.json
new file mode 100644
index 000000000000..2ca6cad4f774
--- /dev/null
+++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetContainerLogsDeployedOnNode-3.json
@@ -0,0 +1,20 @@
+{
+ "operationId": "GetContainerLogsDeployedOnNode",
+ "description": "This example shows how to get container logs of previous dead container on a Service Fabric node for the given code package.",
+ "parameters": {
+ "api-version": "6.2",
+ "nodeName": "_Node_0",
+ "applicationId": "SimpleHttpServerApp",
+ "ServiceManifestName": "SimpleHttpServerSvcPkg",
+ "CodePackageName": "Code",
+ "Previous": true
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": {
+ "Content": "Exception encountered: System.Net.Http.HttpRequestException: Response status code does not indicate success: 500 (Internal Server Error).\r\n\tat System.Net.Http.HttpResponseMessage.EnsureSuccessStatusCode()\r\n"
+ }
+ }
+ }
+}
diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetCorrelatedEventList.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetCorrelatedEventList.json
new file mode 100644
index 000000000000..7e271b230d90
--- /dev/null
+++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetCorrelatedEventList.json
@@ -0,0 +1,31 @@
+{
+ "operationId": "GetCorrelatedEventList",
+ "description": "This example shows how to get all correlated events for a given eventInstanceId.",
+ "parameters": {
+ "eventInstanceId": "e00fa5b7-f747-40dd-9e09-f5a031e96de4",
+ "api-version": "6.4"
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": [
+ {
+ "Kind": "PartitionPrimaryMoveAnalysis",
+ "WhenMoveCompleted": "2018-04-03T20:06:55.966073Z",
+ "PreviousNode": "node3(b9d52c016a15a8f57673d3b8041e2d35)",
+ "CurrentNode": "node1(cf68563e16a44f808e86197a9cf83de5)",
+ "MoveReason": "ApplicationHostDown",
+ "RelevantTraces": "",
+ "PartitionId": "f2a6a893-39be-4c7d-b07f-72bc2d36de89",
+ "EventInstanceId": "59dde2bc-a833-412e-a56d-8f6ada0c7963",
+ "TimeStamp": "2018-04-03T20:07:55.966073Z",
+ "HasCorrelatedEvents": true,
+ "Metadata": {
+ "Delay": "00:00:20",
+ "Duration": "00:01:59"
+ }
+ }
+ ]
+ }
+ }
+}
diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetDataLossProgress-Running.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetDataLossProgress-Running.json
new file mode 100644
index 000000000000..90590fff4f2f
--- /dev/null
+++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetDataLossProgress-Running.json
@@ -0,0 +1,18 @@
+{
+ "operationId": "GetDataLossProgress",
+ "description": "This shows an example of output when a data loss operation is in a Running State. If the State has a value of Running, only the State field will have a value.",
+ "parameters": {
+ "serviceId": "fabric:/myapp/myservice",
+ "partitionId": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d",
+ "OperationId": "7216486c-1ee9-4b00-99b2-92b26fcb07f5",
+ "api-version": "6.0"
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": {
+ "State": "Running"
+ }
+ }
+ }
+}
diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetDataLossProgress.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetDataLossProgress.json
new file mode 100644
index 000000000000..89d341f05c26
--- /dev/null
+++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetDataLossProgress.json
@@ -0,0 +1,25 @@
+{
+ "operationId": "GetDataLossProgress",
+ "description": "This shows an example of possible output when GetDataLossProgress has reached a State of Completed. If the State has a value of Running, only the State field will have a value.",
+ "parameters": {
+ "serviceId": "fabric:/myapp/myservice",
+ "partitionId": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d",
+ "OperationId": "7216486c-1ee9-4b00-99b2-92b26fcb07f5",
+ "api-version": "6.0"
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": {
+ "State": "Completed",
+ "InvokeDataLossResult": {
+ "ErrorCode": 0,
+ "SelectedPartition": {
+ "ServiceName": "fabric:/myapp/myservice",
+ "PartitionId": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d"
+ }
+ }
+ }
+ }
+ }
+}
diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetDeployedApplicationInfoByName-1.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetDeployedApplicationInfoByName-1.json
new file mode 100644
index 000000000000..8552057cbe2f
--- /dev/null
+++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetDeployedApplicationInfoByName-1.json
@@ -0,0 +1,26 @@
+{
+ "operationId": "GetDeployedApplicationInfoList",
+ "description": "This example shows how to get information about an application deployed on a specified node by using an application identifier. If the application is found it's information is returned with 200 status code. An empty response with status code 204 is returned, if the specified application is not deployed on the node.",
+ "parameters": {
+ "api-version": "6.1",
+ "nodeName": "_Node_0",
+ "applicationId": "samples~CalculatorApp",
+ "IncludeHealthState": true
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": {
+ "Id": "samples~CalculatorApp",
+ "Name": "fabric:/samples/CalculatorApp",
+ "TypeName": "CalculatorApp",
+ "Status": "Active",
+ "WorkDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_1\\CalculatorApp_App0\\work",
+ "LogDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_1\\CalculatorApp_App0\\log",
+ "TempDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_1\\CalculatorApp_App0\\temp",
+ "HealthState": "Ok"
+ }
+ },
+ "204": {}
+ }
+}
diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetDeployedApplicationInfoList-1.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetDeployedApplicationInfoList-1.json
new file mode 100644
index 000000000000..c19d4e2a841c
--- /dev/null
+++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetDeployedApplicationInfoList-1.json
@@ -0,0 +1,39 @@
+{
+ "operationId": "GetDeployedApplicationInfoList",
+ "description": "This example shows how to specify the number of applications returned by the query when getting information about applications deployed on a specific node. The number of results in a page are limited to maximum of 2 using the MaxResult parameter. Health state is not requested in this example, so the returned health state will be Unknown.",
+ "parameters": {
+ "api-version": "6.1",
+ "nodeName": "_Node_0",
+ "MaxResults": 2
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": {
+ "ContinuationToken": "fabric:/samples/PQueueApp1",
+ "Items": [
+ {
+ "Id": "samples~CalculatorApp",
+ "Name": "fabric:/samples/CalculatorApp",
+ "TypeName": "CalculatorApp",
+ "Status": "Active",
+ "WorkDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\CalculatorApp_App0\\work",
+ "LogDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\CalculatorApp_App0\\log",
+ "TempDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\CalculatorApp_App0\\temp",
+ "HealthState": "Unknown"
+ },
+ {
+ "Id": "samples~PQueueApp1",
+ "Name": "fabric:/samples/PQueueApp1",
+ "TypeName": "PersistentQueueApp",
+ "Status": "Active",
+ "WorkDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\PersistentQueueApp_App1\\work",
+ "LogDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\PersistentQueueApp_App1\\log",
+ "TempDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\PersistentQueueApp_App1\\temp",
+ "HealthState": "Unknown"
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetDeployedApplicationInfoList-2.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetDeployedApplicationInfoList-2.json
new file mode 100644
index 000000000000..7f6320e69e6d
--- /dev/null
+++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetDeployedApplicationInfoList-2.json
@@ -0,0 +1,29 @@
+{
+ "operationId": "GetDeployedApplicationInfoListByName",
+ "description": "This example demonstrates the paging functionality available when getting information about applications deployed on a specific node. This example uses the ContinuationToken parameter. The value of this parameter is provided from the previous query; in this case the example shown above. The response contains the remaining results and an empty ContinuationToken. The empty ContinuationToken indicates that additional results are not available.",
+ "parameters": {
+ "api-version": "6.1",
+ "nodeName": "_Node_0",
+ "ContinuationToken": "fabric:/samples/PQueueApp1"
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": {
+ "ContinuationToken": "",
+ "Items": [
+ {
+ "Id": "samples~VQueueApp1",
+ "Name": "fabric:/samples/VQueueApp1",
+ "TypeName": "VolatileQueueApp",
+ "Status": "Active",
+ "WorkDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\VolatileQueueApp_App2\\work",
+ "LogDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\VolatileQueueApp_App2\\log",
+ "TempDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\VolatileQueueApp_App2\\temp",
+ "HealthState": "Unknown"
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetDeployedApplicationInfoList-3.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetDeployedApplicationInfoList-3.json
new file mode 100644
index 000000000000..01cad866d3c1
--- /dev/null
+++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetDeployedApplicationInfoList-3.json
@@ -0,0 +1,49 @@
+{
+ "operationId": "GetDeployedApplicationInfoList",
+ "description": "This example shows how to include the health state of each deployed application when getting information about applications deployed on a specific node.",
+ "parameters": {
+ "api-version": "6.1",
+ "nodeName": "_Node_0",
+ "IncludeHealthState": true
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": {
+ "ContinuationToken": "",
+ "Items": [
+ {
+ "Id": "samples~CalculatorApp",
+ "Name": "fabric:/samples/CalculatorApp",
+ "TypeName": "CalculatorApp",
+ "Status": "Active",
+ "WorkDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\CalculatorApp_App0\\work",
+ "LogDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\CalculatorApp_App0\\log",
+ "TempDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\CalculatorApp_App0\\temp",
+ "HealthState": "Ok"
+ },
+ {
+ "Id": "samples~PQueueApp1",
+ "Name": "fabric:/samples/PQueueApp1",
+ "TypeName": "PersistentQueueApp",
+ "Status": "Active",
+ "WorkDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\PersistentQueueApp_App1\\work",
+ "LogDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\PersistentQueueApp_App1\\log",
+ "TempDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\PersistentQueueApp_App1\\temp",
+ "HealthState": "Ok"
+ },
+ {
+ "Id": "samples~VQueueApp1",
+ "Name": "fabric:/samples/VQueueApp1",
+ "TypeName": "VolatileQueueApp",
+ "Status": "Active",
+ "WorkDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\VolatileQueueApp_App2\\work",
+ "LogDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\VolatileQueueApp_App2\\log",
+ "TempDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\VolatileQueueApp_App2\\temp",
+ "HealthState": "Ok"
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetFaultOperationList.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetFaultOperationList.json
new file mode 100644
index 000000000000..c7194dad614a
--- /dev/null
+++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetFaultOperationList.json
@@ -0,0 +1,51 @@
+{
+ "operationId": "GetFaultOperationList",
+ "description": "This shows an example of possible output for GetFaultOperationList",
+ "parameters": {
+ "TypeFilter": "0xFF",
+ "StateFilter": "0xFF",
+ "api-version": "6.0"
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": [
+ {
+ "OperationId": "00000000-0000-0000-0000-000000000010",
+ "State": "Completed",
+ "Type": "PartitionDataLoss"
+ },
+ {
+ "OperationId": "00000000-0000-0000-0000-000000000020",
+ "State": "Completed",
+ "Type": "PartitionQuorumLoss"
+ },
+ {
+ "OperationId": "00000000-0000-0000-0000-000000000030",
+ "State": "Completed",
+ "Type": "PartitionRestart"
+ },
+ {
+ "OperationId": "00000000-0000-0000-0000-000000000500",
+ "State": "Faulted",
+ "Type": "NodeTransition"
+ },
+ {
+ "OperationId": "00000000-0000-0000-0000-000000000700",
+ "State": "Completed",
+ "Type": "NodeTransition"
+ },
+ {
+ "OperationId": "00000000-0000-0000-0000-000000000710",
+ "State": "Completed",
+ "Type": "NodeTransition"
+ },
+ {
+ "OperationId": "88ef90f9-0b94-46b0-b817-a6ea20c07f8a",
+ "State": "Completed",
+ "Type": "PartitionRestart"
+ }
+ ]
+ }
+ }
+}
diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetImageStoreContent.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetImageStoreContent.json
new file mode 100644
index 000000000000..7e912c407a79
--- /dev/null
+++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetImageStoreContent.json
@@ -0,0 +1,91 @@
+{
+ "operationId": "GetImageStoreContent",
+ "description": "This example shows how to get image store content under the given relative path.",
+ "parameters": {
+ "api-version": "6.2",
+ "contentPath": "Store\\CalcServiceApp"
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": {
+ "StoreFiles": [
+ {
+ "StoreRelativePath": "Store\\CalcServiceApp\\ApplicationManifest.2.0.xml",
+ "FileVersion": {
+ "EpochDataLossNumber": "131510254310497004",
+ "VersionNumber": "23",
+ "EpochConfigurationNumber": "25769803776"
+ },
+ "FileSize": "897",
+ "ModifiedDate": "2017-09-28T17:44:22.609Z"
+ },
+ {
+ "StoreRelativePath": "Store\\CalcServiceApp\\CalcService.Code.2.0.checksum",
+ "FileVersion": {
+ "EpochDataLossNumber": "131510254310497004",
+ "VersionNumber": "25",
+ "EpochConfigurationNumber": "25769803776"
+ },
+ "FileSize": "66",
+ "ModifiedDate": "2017-09-28T17:44:22.468Z"
+ },
+ {
+ "StoreRelativePath": "Store\\CalcServiceApp\\CalcService.Config.1.0.checksum",
+ "FileVersion": {
+ "EpochDataLossNumber": "131510254310497004",
+ "VersionNumber": "26",
+ "EpochConfigurationNumber": "25769803776"
+ },
+ "FileSize": "66",
+ "ModifiedDate": "2017-09-28T17:44:22.468Z"
+ },
+ {
+ "StoreRelativePath": "Store\\CalcServiceApp\\CalcService.Data.2.0.checksum",
+ "FileVersion": {
+ "EpochDataLossNumber": "131510254310497004",
+ "VersionNumber": "27",
+ "EpochConfigurationNumber": "25769803776"
+ },
+ "FileSize": "66",
+ "ModifiedDate": "2017-09-28T17:44:22.468Z"
+ },
+ {
+ "StoreRelativePath": "Store\\CalcServiceApp\\CalcService.Manifest.2.0.xml",
+ "FileVersion": {
+ "EpochDataLossNumber": "131510254310497004",
+ "VersionNumber": "19",
+ "EpochConfigurationNumber": "25769803776"
+ },
+ "FileSize": "744",
+ "ModifiedDate": "2017-09-28T17:44:22.578Z"
+ },
+ {
+ "StoreRelativePath": "Store\\CalcServiceApp\\CalcService.Manifest.2.0.xml.checksum",
+ "FileVersion": {
+ "EpochDataLossNumber": "131510254310497004",
+ "VersionNumber": "24",
+ "EpochConfigurationNumber": "25769803776"
+ },
+ "FileSize": "66",
+ "ModifiedDate": "2017-09-28T17:44:22.484Z"
+ }
+ ],
+ "StoreFolders": [
+ {
+ "StoreRelativePath": "Store\\CalcServiceApp\\CalcService.Code.2.0",
+ "FileCount": "2"
+ },
+ {
+ "StoreRelativePath": "Store\\CalcServiceApp\\CalcService.Config.1.0",
+ "FileCount": "2"
+ },
+ {
+ "StoreRelativePath": "Store\\CalcServiceApp\\CalcService.Data.2.0",
+ "FileCount": "2"
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetImageStoreInfo.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetImageStoreInfo.json
new file mode 100644
index 000000000000..e4360622b5fd
--- /dev/null
+++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetImageStoreInfo.json
@@ -0,0 +1,36 @@
+{
+ "operationId": "GetImageStoreInfo",
+ "description": "This example shows how to get ImageStore information.",
+ "parameters": {
+ "api-version": "6.5"
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": [
+ {
+ "DiskInfo": {
+ "Capacity": "500090007552",
+ "AvailableSpace": "228851900416"
+ },
+ "UsedByMetadata": {
+ "UsedSpace": "23093248",
+ "FileCount": 6
+ },
+ "UsedByStaging": {
+ "UsedSpace": "6291456",
+ "FileCount": 9
+ },
+ "UsedByCopy": {
+ "UsedSpace": "4194304",
+ "FileCount": 2
+ },
+ "UsedByRegister": {
+ "UsedSpace": "4194304",
+ "FileCount": 3
+ }
+ }
+ ]
+ }
+ }
+}
diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetNodeEventList.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetNodeEventList.json
new file mode 100644
index 000000000000..4368ae718d58
--- /dev/null
+++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetNodeEventList.json
@@ -0,0 +1,32 @@
+{
+ "operationId": "GetNodeEventList",
+ "description": "This example shows how to get all node-related events during a certain time window.",
+ "parameters": {
+ "nodeName": "node1",
+ "api-version": "6.4",
+ "StartTimeUtc": "2018-04-03T18:00:00Z",
+ "EndTimeUtc": "2018-04-04T18:00:00Z"
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": [
+ {
+ "Kind": "NodeOpenSucceeded",
+ "NodeInstance": 131672596159209215,
+ "NodeId": "ba001a8bb353543e646be031afb10f1e",
+ "UpgradeDomain": "0",
+ "FaultDomain": "fd:/0",
+ "IpAddressOrFQDN": "100.78.240.56",
+ "Hostname": "RD0003FF5089AA",
+ "IsSeedNode": false,
+ "NodeVersion": "6.2:1.0",
+ "NodeName": "node1",
+ "EventInstanceId": "ecbce04a-a42b-4b70-a800-dfc6bc4f9b89",
+ "TimeStamp": "2018-04-03T20:06:55.966073Z",
+ "HasCorrelatedEvents": false
+ }
+ ]
+ }
+ }
+}
diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetNodeInfo-1.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetNodeInfo-1.json
new file mode 100644
index 000000000000..24b8cfac97f7
--- /dev/null
+++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetNodeInfo-1.json
@@ -0,0 +1,41 @@
+{
+ "operationId": "GetNodeInfo",
+ "description": "This example shows how to get information about an node using it's identifier. If the node is found, information about it is returned with 200 status code. If the node is not found, empty content is returned with 204 status code.",
+ "parameters": {
+ "api-version": "6.0",
+ "nodeName": "_Node_1"
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": {
+ "Name": "_testnode_0",
+ "IpAddressOrFQDN": "10.0.0.4",
+ "Type": "testnode",
+ "CodeVersion": "6.3.139.9494",
+ "ConfigVersion": "5",
+ "NodeStatus": "Up",
+ "NodeUpTimeInSeconds": "18688",
+ "HealthState": "Ok",
+ "IsSeedNode": true,
+ "UpgradeDomain": "0",
+ "FaultDomain": "fd:/0",
+ "Id": {
+ "Id": "2acb9f55540659b1c95f27cc128ab326"
+ },
+ "InstanceId": "131738240209152398",
+ "NodeDeactivationInfo": {
+ "NodeDeactivationIntent": "Invalid",
+ "NodeDeactivationStatus": "None",
+ "NodeDeactivationTask": [],
+ "PendingSafetyChecks": []
+ },
+ "IsStopped": false,
+ "NodeDownTimeInSeconds": "0",
+ "NodeUpAt": "2018-06-18T19:33:52.944Z",
+ "NodeDownAt": "2018-06-18T19:33:39.514Z"
+ }
+ },
+ "204": {}
+ }
+}
diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetNodeInfoList-1.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetNodeInfoList-1.json
new file mode 100644
index 000000000000..c494bff622c5
--- /dev/null
+++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetNodeInfoList-1.json
@@ -0,0 +1,72 @@
+{
+ "operationId": "GetNodeInfoList",
+ "description": "This example shows how to get information about the nodes in the cluster when the number of results returned is limited by the MaxResults parameter.",
+ "parameters": {
+ "api-version": "6.3",
+ "MaxResults": 2
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": {
+ "ContinuationToken": "2acb9f55540659b1c95f27cc128ab326",
+ "Items": [
+ {
+ "Name": "_testnode_1",
+ "IpAddressOrFQDN": "10.0.0.5",
+ "Type": "testnode",
+ "CodeVersion": "6.3.139.9494",
+ "ConfigVersion": "5",
+ "NodeStatus": "Up",
+ "NodeUpTimeInSeconds": "102016",
+ "HealthState": "Ok",
+ "IsSeedNode": true,
+ "UpgradeDomain": "1",
+ "FaultDomain": "fd:/1",
+ "Id": {
+ "Id": "ebd986a1134b3643a8117fb41b259bf"
+ },
+ "InstanceId": "131738274982501335",
+ "NodeDeactivationInfo": {
+ "NodeDeactivationIntent": "Invalid",
+ "NodeDeactivationStatus": "None",
+ "NodeDeactivationTask": [],
+ "PendingSafetyChecks": []
+ },
+ "IsStopped": false,
+ "NodeDownTimeInSeconds": "0",
+ "NodeUpAt": "2018-06-18T20:31:39.842Z",
+ "NodeDownAt": "2018-06-18T20:31:37.374Z"
+ },
+ {
+ "Name": "_testnode_0",
+ "IpAddressOrFQDN": "10.0.0.4",
+ "Type": "testnode",
+ "CodeVersion": "6.3.139.9494",
+ "ConfigVersion": "5",
+ "NodeStatus": "Up",
+ "NodeUpTimeInSeconds": "105483",
+ "HealthState": "Ok",
+ "IsSeedNode": true,
+ "UpgradeDomain": "0",
+ "FaultDomain": "fd:/0",
+ "Id": {
+ "Id": "2acb9f55540659b1c95f27cc128ab326"
+ },
+ "InstanceId": "131738240209152398",
+ "NodeDeactivationInfo": {
+ "NodeDeactivationIntent": "Invalid",
+ "NodeDeactivationStatus": "None",
+ "NodeDeactivationTask": [],
+ "PendingSafetyChecks": []
+ },
+ "IsStopped": false,
+ "NodeDownTimeInSeconds": "0",
+ "NodeUpAt": "2018-06-18T19:33:52.944Z",
+ "NodeDownAt": "2018-06-18T19:33:39.514Z"
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetNodeInfoList-2.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetNodeInfoList-2.json
new file mode 100644
index 000000000000..79bbd1bf1af7
--- /dev/null
+++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetNodeInfoList-2.json
@@ -0,0 +1,99 @@
+{
+ "operationId": "GetNodeInfoList",
+ "description": "This example shows how to get information about nodes in the cluster which appear on a sequential page, by using the ContinuationToken parameter.",
+ "parameters": {
+ "api-version": "6.3",
+ "ContinuationToken": "2acb9f55540659b1c95f27cc128ab326"
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": {
+ "ContinuationToken": "",
+ "Items": [
+ {
+ "Name": "_Node_4",
+ "IpAddressOrFQDN": "10.0.0.8",
+ "Type": "testnode",
+ "CodeVersion": "6.3.139.9494",
+ "ConfigVersion": "5",
+ "NodeStatus": "Up",
+ "NodeUpTimeInSeconds": "101547",
+ "HealthState": "Ok",
+ "IsSeedNode": true,
+ "UpgradeDomain": "4",
+ "FaultDomain": "fd:/4",
+ "Id": {
+ "Id": "ba9383d728221add7fa996bf67b757fb"
+ },
+ "InstanceId": "131737415865259763",
+ "NodeDeactivationInfo": {
+ "NodeDeactivationIntent": "Invalid",
+ "NodeDeactivationStatus": "None",
+ "NodeDeactivationTask": [],
+ "PendingSafetyChecks": []
+ },
+ "IsStopped": false,
+ "NodeDownTimeInSeconds": "0",
+ "NodeUpAt": "2018-06-17T20:40:07.378Z",
+ "NodeDownAt": "2018-06-17T20:33:11.877Z"
+ },
+ {
+ "Name": "_Node_3",
+ "IpAddressOrFQDN": "10.0.0.7",
+ "Type": "testnode",
+ "CodeVersion": "6.3.139.9494",
+ "ConfigVersion": "5",
+ "NodeStatus": "Up",
+ "NodeUpTimeInSeconds": "15615",
+ "HealthState": "Ok",
+ "IsSeedNode": true,
+ "UpgradeDomain": "3",
+ "FaultDomain": "fd:/3",
+ "Id": {
+ "Id": "d6a18a0935a3e39aeae2a049eb97255d"
+ },
+ "InstanceId": "131738275300526952",
+ "NodeDeactivationInfo": {
+ "NodeDeactivationIntent": "Invalid",
+ "NodeDeactivationStatus": "None",
+ "NodeDeactivationTask": [],
+ "PendingSafetyChecks": []
+ },
+ "IsStopped": false,
+ "NodeDownTimeInSeconds": "0",
+ "NodeUpAt": "2018-06-18T20:32:18.884Z",
+ "NodeDownAt": "2018-06-18T20:31:59.128Z"
+ },
+ {
+ "Name": "_Node_2",
+ "IpAddressOrFQDN": "10.0.0.6",
+ "Type": "testnode",
+ "CodeVersion": "6.3.139.9494",
+ "ConfigVersion": "5",
+ "NodeStatus": "Up",
+ "NodeUpTimeInSeconds": "19819",
+ "HealthState": "Ok",
+ "IsSeedNode": true,
+ "UpgradeDomain": "2",
+ "FaultDomain": "fd:/2",
+ "Id": {
+ "Id": "f2af91e5e9c8254dedb75b1424a9e3fc"
+ },
+ "InstanceId": "131738233282843485",
+ "NodeDeactivationInfo": {
+ "NodeDeactivationIntent": "Invalid",
+ "NodeDeactivationStatus": "None",
+ "NodeDeactivationTask": [],
+ "PendingSafetyChecks": []
+ },
+ "IsStopped": false,
+ "NodeDownTimeInSeconds": "0",
+ "NodeUpAt": "2018-06-18T19:22:15.272Z",
+ "NodeDownAt": "2018-06-18T19:22:02.740Z"
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetNodeInfoList.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetNodeInfoList.json
new file mode 100644
index 000000000000..d38a618440a9
--- /dev/null
+++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetNodeInfoList.json
@@ -0,0 +1,152 @@
+{
+ "operationId": "GetNodeInfoList",
+ "description": "This example shows how to get information about all the nodes in the cluster when the information fits in a single response message without the need for paging through ContinuationToken parameter.",
+ "parameters": {
+ "api-version": "6.3"
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": {
+ "ContinuationToken": "",
+ "Items": [
+ {
+ "Name": "_Node_1",
+ "IpAddressOrFQDN": "10.0.0.5",
+ "Type": "testnode",
+ "CodeVersion": "6.3.139.9494",
+ "ConfigVersion": "5",
+ "NodeStatus": "Up",
+ "NodeUpTimeInSeconds": "15275",
+ "HealthState": "Ok",
+ "IsSeedNode": true,
+ "UpgradeDomain": "1",
+ "FaultDomain": "fd:/1",
+ "Id": {
+ "Id": "ebd986a1134b3643a8117fb41b259bf"
+ },
+ "InstanceId": "131738274982501335",
+ "NodeDeactivationInfo": {
+ "NodeDeactivationIntent": "Invalid",
+ "NodeDeactivationStatus": "None",
+ "NodeDeactivationTask": [],
+ "PendingSafetyChecks": []
+ },
+ "IsStopped": false,
+ "NodeDownTimeInSeconds": "0",
+ "NodeUpAt": "2018-06-18T20:31:39.842Z",
+ "NodeDownAt": "2018-06-18T20:31:37.374Z"
+ },
+ {
+ "Name": "_Node_0",
+ "IpAddressOrFQDN": "10.0.0.4",
+ "Type": "testnode",
+ "CodeVersion": "6.3.139.9494",
+ "ConfigVersion": "5",
+ "NodeStatus": "Up",
+ "NodeUpTimeInSeconds": "18742",
+ "HealthState": "Ok",
+ "IsSeedNode": true,
+ "UpgradeDomain": "0",
+ "FaultDomain": "fd:/0",
+ "Id": {
+ "Id": "2acb9f55540659b1c95f27cc128ab326"
+ },
+ "InstanceId": "131738240209152398",
+ "NodeDeactivationInfo": {
+ "NodeDeactivationIntent": "Invalid",
+ "NodeDeactivationStatus": "None",
+ "NodeDeactivationTask": [],
+ "PendingSafetyChecks": []
+ },
+ "IsStopped": false,
+ "NodeDownTimeInSeconds": "0",
+ "NodeUpAt": "2018-06-18T19:33:52.944Z",
+ "NodeDownAt": "2018-06-18T19:33:39.514Z"
+ },
+ {
+ "Name": "_Node_4",
+ "IpAddressOrFQDN": "10.0.0.8",
+ "Type": "testnode",
+ "CodeVersion": "6.3.139.9494",
+ "ConfigVersion": "5",
+ "NodeStatus": "Up",
+ "NodeUpTimeInSeconds": "101168",
+ "HealthState": "Ok",
+ "IsSeedNode": true,
+ "UpgradeDomain": "4",
+ "FaultDomain": "fd:/4",
+ "Id": {
+ "Id": "ba9383d728221add7fa996bf67b757fb"
+ },
+ "InstanceId": "131737415865259763",
+ "NodeDeactivationInfo": {
+ "NodeDeactivationIntent": "Invalid",
+ "NodeDeactivationStatus": "None",
+ "NodeDeactivationTask": [],
+ "PendingSafetyChecks": []
+ },
+ "IsStopped": false,
+ "NodeDownTimeInSeconds": "0",
+ "NodeUpAt": "2018-06-17T20:40:07.378Z",
+ "NodeDownAt": "2018-06-17T20:33:11.877Z"
+ },
+ {
+ "Name": "_Node_3",
+ "IpAddressOrFQDN": "10.0.0.7",
+ "Type": "testnode",
+ "CodeVersion": "6.3.139.9494",
+ "ConfigVersion": "5",
+ "NodeStatus": "Up",
+ "NodeUpTimeInSeconds": "15236",
+ "HealthState": "Ok",
+ "IsSeedNode": true,
+ "UpgradeDomain": "3",
+ "FaultDomain": "fd:/3",
+ "Id": {
+ "Id": "d6a18a0935a3e39aeae2a049eb97255d"
+ },
+ "InstanceId": "131738275300526952",
+ "NodeDeactivationInfo": {
+ "NodeDeactivationIntent": "Invalid",
+ "NodeDeactivationStatus": "None",
+ "NodeDeactivationTask": [],
+ "PendingSafetyChecks": []
+ },
+ "IsStopped": false,
+ "NodeDownTimeInSeconds": "0",
+ "NodeUpAt": "2018-06-18T20:32:18.884Z",
+ "NodeDownAt": "2018-06-18T20:31:59.128Z"
+ },
+ {
+ "Name": "_Node_2",
+ "IpAddressOrFQDN": "10.0.0.6",
+ "Type": "testnode",
+ "CodeVersion": "6.3.139.9494",
+ "ConfigVersion": "5",
+ "NodeStatus": "Up",
+ "NodeUpTimeInSeconds": "19440",
+ "HealthState": "Ok",
+ "IsSeedNode": true,
+ "UpgradeDomain": "2",
+ "FaultDomain": "fd:/2",
+ "Id": {
+ "Id": "f2af91e5e9c8254dedb75b1424a9e3fc"
+ },
+ "InstanceId": "131738233282843485",
+ "NodeDeactivationInfo": {
+ "NodeDeactivationIntent": "Invalid",
+ "NodeDeactivationStatus": "None",
+ "NodeDeactivationTask": [],
+ "PendingSafetyChecks": []
+ },
+ "IsStopped": false,
+ "NodeDownTimeInSeconds": "0",
+ "NodeUpAt": "2018-06-18T19:22:15.272Z",
+ "NodeDownAt": "2018-06-18T19:22:02.740Z"
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetNodeTransitionProgress-Running.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetNodeTransitionProgress-Running.json
new file mode 100644
index 000000000000..62ad5c37ec58
--- /dev/null
+++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetNodeTransitionProgress-Running.json
@@ -0,0 +1,17 @@
+{
+ "operationId": "GetNodeTransitionProgress",
+ "description": "This shows an example of output when GetTransitionProgress has a State of Running.",
+ "parameters": {
+ "nodeName": "N0060",
+ "OperationId": "ed903556-acf1-489c-9f33-b484c31f9087",
+ "api-version": "6.0"
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": {
+ "State": "Running"
+ }
+ }
+ }
+}
diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetNodeTransitionProgress.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetNodeTransitionProgress.json
new file mode 100644
index 000000000000..474ab826b8df
--- /dev/null
+++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetNodeTransitionProgress.json
@@ -0,0 +1,24 @@
+{
+ "operationId": "GetNodeTransitionProgress",
+ "description": "This shows an example of possible output when GetTransitionProgress has reached a State of Completed. If the State has a value of Running, only the State field will have a value.",
+ "parameters": {
+ "nodeName": "N0060",
+ "OperationId": "a9c24269-88e9-4812-b4ad-a0bf2b724ad4",
+ "api-version": "6.0"
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": {
+ "State": "Completed",
+ "NodeTransitionResult": {
+ "ErrorCode": 0,
+ "NodeResult": {
+ "NodeName": "N0060",
+ "NodeInstanceId": "131366982707950527"
+ }
+ }
+ }
+ }
+ }
+}
diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetNodesEventList.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetNodesEventList.json
new file mode 100644
index 000000000000..7aed70b97f31
--- /dev/null
+++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetNodesEventList.json
@@ -0,0 +1,46 @@
+{
+ "operationId": "GetNodesEventList",
+ "description": "This example shows how to get all nodes-related events during a certain time window.",
+ "parameters": {
+ "api-version": "6.4",
+ "StartTimeUtc": "2018-04-03T18:00:00Z",
+ "EndTimeUtc": "2018-04-04T18:00:00Z"
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": [
+ {
+ "Kind": "NodeOpenSucceeded",
+ "NodeInstance": 131672596159209215,
+ "NodeId": "ba001a8bb353543e646be031afb10f1e",
+ "UpgradeDomain": "0",
+ "FaultDomain": "fd:/0",
+ "IpAddressOrFQDN": "100.78.240.56",
+ "Hostname": "RD0003FF5089AA",
+ "IsSeedNode": false,
+ "NodeVersion": "6.2:1.0",
+ "NodeName": "node1",
+ "EventInstanceId": "ecbce04a-a42b-4b70-a800-dfc6bc4f9b89",
+ "TimeStamp": "2018-04-03T20:06:55.966073Z",
+ "HasCorrelatedEvents": false
+ },
+ {
+ "Kind": "NodeOpenSucceeded",
+ "NodeInstance": 131672596186027906,
+ "NodeId": "ba03ef91259835c54d674889849a7cee",
+ "UpgradeDomain": "3",
+ "FaultDomain": "fd:/3",
+ "IpAddressOrFQDN": "100.72.76.122",
+ "Hostname": "RD0003FF6047A8",
+ "IsSeedNode": false,
+ "NodeVersion": "6.2:1.0",
+ "NodeName": "node2",
+ "EventInstanceId": "67730c48-752c-4209-bf28-3c121555a4c0",
+ "TimeStamp": "2018-04-03T20:06:58.6357365Z",
+ "HasCorrelatedEvents": false
+ }
+ ]
+ }
+ }
+}
diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetPartitionBackupConfigurationInfo.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetPartitionBackupConfigurationInfo.json
new file mode 100644
index 000000000000..dd97740de85f
--- /dev/null
+++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetPartitionBackupConfigurationInfo.json
@@ -0,0 +1,24 @@
+{
+ "operationId": "GetPartitionBackupConfigurationInfo",
+ "description": "This example shows how to get backup configuration for a partition.",
+ "parameters": {
+ "api-version": "6.4",
+ "partitionId": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d"
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": {
+ "Kind": "Partition",
+ "PolicyName": "BackupPolicy2",
+ "PolicyInheritedFrom": "Service",
+ "ServiceName": "fabric:/CalcApp/CalcService",
+ "PartitionId": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d",
+ "SuspensionInfo": {
+ "IsSuspended": true,
+ "SuspensionInheritedFrom": "Partition"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetPartitionBackupList-1.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetPartitionBackupList-1.json
new file mode 100644
index 000000000000..2c5fb63a2bc3
--- /dev/null
+++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetPartitionBackupList-1.json
@@ -0,0 +1,64 @@
+{
+ "operationId": "GetPartitionBackupList",
+ "description": "This example shows how to get list of partition backups within a time range.",
+ "parameters": {
+ "api-version": "6.4",
+ "partitionId": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d",
+ "StartDateTimeFilter": "2018-01-01T00:00:00Z",
+ "EndDateTimeFilter": "2018-01-01T23:59:59Z"
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": {
+ "ContinuationToken": "",
+ "Items": [
+ {
+ "BackupId": "3a056ac9-7206-43c3-8424-6f6103003eba",
+ "BackupChainId": "3a056ac9-7206-43c3-8424-6f6103003eba",
+ "ApplicationName": "fabric:/CalcApp",
+ "ServiceManifestVersion": "1.0.0",
+ "ServiceName": "fabric:/CalcApp/CalcService",
+ "PartitionInformation": {
+ "LowKey": "-9223372036854775808",
+ "HighKey": "9223372036854775807",
+ "ServicePartitionKind": "Int64Range",
+ "Id": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d"
+ },
+ "BackupLocation": "CalcApp\\CalcService\\1daae3f5-7fd6-42e9-b1ba-8c05f873994d\\2018-01-01 09.00.55.zip",
+ "BackupType": "Full",
+ "EpochOfLastBackupRecord": {
+ "DataLossVersion": "131462452931584510",
+ "ConfigurationVersion": "8589934592"
+ },
+ "LsnOfLastBackupRecord": "261",
+ "CreationTimeUtc": "2018-01-01T09:00:55Z",
+ "FailureError": null
+ },
+ {
+ "BackupId": "7903dc2a-228d-44b0-b7c8-a13a6c9b46bd",
+ "BackupChainId": "3a056ac9-7206-43c3-8424-6f6103003eba",
+ "ApplicationName": "fabric:/CalcApp",
+ "ServiceManifestVersion": "1.0.0",
+ "ServiceName": "fabric:/CalcApp/CalcService",
+ "PartitionInformation": {
+ "LowKey": "-9223372036854775808",
+ "HighKey": "9223372036854775807",
+ "ServicePartitionKind": "Int64Range",
+ "Id": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d"
+ },
+ "BackupLocation": "CalcApp\\CalcService\\1daae3f5-7fd6-42e9-b1ba-8c05f873994d\\2018-01-01 17.01.02.zip",
+ "BackupType": "Incremental",
+ "EpochOfLastBackupRecord": {
+ "DataLossVersion": "131462452931584510",
+ "ConfigurationVersion": "8589934592"
+ },
+ "LsnOfLastBackupRecord": "446",
+ "CreationTimeUtc": "2018-01-01T17:01:02Z",
+ "FailureError": null
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetPartitionBackupList-2.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetPartitionBackupList-2.json
new file mode 100644
index 000000000000..cc627b382457
--- /dev/null
+++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetPartitionBackupList-2.json
@@ -0,0 +1,41 @@
+{
+ "operationId": "GetPartitionBackupList",
+ "description": "This example shows how to get the latest backup for the specified partition.",
+ "parameters": {
+ "api-version": "6.4",
+ "partitionId": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d",
+ "Latest": true
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": {
+ "ContinuationToken": "",
+ "Items": [
+ {
+ "BackupId": "be06a49c-be67-4eb1-a602-b983605be862",
+ "BackupChainId": "be06a49c-be67-4eb1-a602-b983605be862",
+ "ApplicationName": "fabric:/CalcApp",
+ "ServiceManifestVersion": "1.0.0",
+ "ServiceName": "fabric:/CalcApp/CalcService",
+ "PartitionInformation": {
+ "LowKey": "-9223372036854775808",
+ "HighKey": "9223372036854775807",
+ "ServicePartitionKind": "Int64Range",
+ "Id": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d"
+ },
+ "BackupLocation": "CalcApp\\CalcService\\1daae3f5-7fd6-42e9-b1ba-8c05f873994d\\2018-01-02 08.59.53.zip",
+ "BackupType": "Full",
+ "EpochOfLastBackupRecord": {
+ "DataLossVersion": "131462452931584510",
+ "ConfigurationVersion": "8589934592"
+ },
+ "LsnOfLastBackupRecord": "639",
+ "CreationTimeUtc": "2018-01-02T08:59:53Z",
+ "FailureError": null
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetPartitionBackupList-3.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetPartitionBackupList-3.json
new file mode 100644
index 000000000000..2cddad80321f
--- /dev/null
+++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetPartitionBackupList-3.json
@@ -0,0 +1,63 @@
+{
+ "operationId": "GetPartitionBackupList",
+ "description": "This example shows how to get list of partition backups. The number of results in a page are limited to maximum of two using the MaxResult parameter.",
+ "parameters": {
+ "api-version": "6.4",
+ "partitionId": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d",
+ "MaxResults": 2
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": {
+ "ContinuationToken": "fabric:/CalcApp/CalcService#1daae3f5-7fd6-42e9-b1ba-8c05f873994d#7903dc2a-228d-44b0-b7c8-a13a6c9b46bd",
+ "Items": [
+ {
+ "BackupId": "3a056ac9-7206-43c3-8424-6f6103003eba",
+ "BackupChainId": "3a056ac9-7206-43c3-8424-6f6103003eba",
+ "ApplicationName": "fabric:/CalcApp",
+ "ServiceManifestVersion": "1.0.0",
+ "ServiceName": "fabric:/CalcApp/CalcService",
+ "PartitionInformation": {
+ "LowKey": "-9223372036854775808",
+ "HighKey": "9223372036854775807",
+ "ServicePartitionKind": "Int64Range",
+ "Id": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d"
+ },
+ "BackupLocation": "CalcApp\\CalcService\\1daae3f5-7fd6-42e9-b1ba-8c05f873994d\\2018-01-01 09.00.55.zip",
+ "BackupType": "Full",
+ "EpochOfLastBackupRecord": {
+ "DataLossVersion": "131462452931584510",
+ "ConfigurationVersion": "8589934592"
+ },
+ "LsnOfLastBackupRecord": "261",
+ "CreationTimeUtc": "2018-01-01T09:00:55Z",
+ "FailureError": null
+ },
+ {
+ "BackupId": "7903dc2a-228d-44b0-b7c8-a13a6c9b46bd",
+ "BackupChainId": "3a056ac9-7206-43c3-8424-6f6103003eba",
+ "ApplicationName": "fabric:/CalcApp",
+ "ServiceManifestVersion": "1.0.0",
+ "ServiceName": "fabric:/CalcApp/CalcService",
+ "PartitionInformation": {
+ "LowKey": "-9223372036854775808",
+ "HighKey": "9223372036854775807",
+ "ServicePartitionKind": "Int64Range",
+ "Id": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d"
+ },
+ "BackupLocation": "CalcApp\\CalcService\\1daae3f5-7fd6-42e9-b1ba-8c05f873994d\\2018-01-01 17.01.02.zip",
+ "BackupType": "Incremental",
+ "EpochOfLastBackupRecord": {
+ "DataLossVersion": "131462452931584510",
+ "ConfigurationVersion": "8589934592"
+ },
+ "LsnOfLastBackupRecord": "446",
+ "CreationTimeUtc": "2018-01-01T17:01:02Z",
+ "FailureError": null
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetPartitionBackupList-4.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetPartitionBackupList-4.json
new file mode 100644
index 000000000000..c73aaece09c8
--- /dev/null
+++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetPartitionBackupList-4.json
@@ -0,0 +1,42 @@
+{
+ "operationId": "GetPartitionBackupList",
+ "description": "This example shows how to get list of partition backups. The number of results in a page are limited to maximum of two using the MaxResult parameter. This example uses the ContinuationToken parameter. The value of this parameter is provided from the previous query; in this case the example shown above. The response contains the remaining results and an empty ContinuationToken. The empty ContinuationToken indicates that additional results are not available.",
+ "parameters": {
+ "api-version": "6.4",
+ "partitionId": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d",
+ "MaxResults": 2,
+ "ContinuationToken": "fabric:/CalcApp/CalcService#1daae3f5-7fd6-42e9-b1ba-8c05f873994d#7903dc2a-228d-44b0-b7c8-a13a6c9b46bd"
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": {
+ "ContinuationToken": "",
+ "Items": [
+ {
+ "BackupId": "be06a49c-be67-4eb1-a602-b983605be862",
+ "BackupChainId": "be06a49c-be67-4eb1-a602-b983605be862",
+ "ApplicationName": "fabric:/CalcApp",
+ "ServiceManifestVersion": "1.0.0",
+ "ServiceName": "fabric:/CalcApp/CalcService",
+ "PartitionInformation": {
+ "LowKey": "-9223372036854775808",
+ "HighKey": "9223372036854775807",
+ "ServicePartitionKind": "Int64Range",
+ "Id": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d"
+ },
+ "BackupLocation": "CalcApp\\CalcService\\1daae3f5-7fd6-42e9-b1ba-8c05f873994d\\2018-01-02 08.59.53.zip",
+ "BackupType": "Full",
+ "EpochOfLastBackupRecord": {
+ "DataLossVersion": "131462452931584510",
+ "ConfigurationVersion": "8589934592"
+ },
+ "LsnOfLastBackupRecord": "639",
+ "CreationTimeUtc": "2018-01-02T08:59:53Z",
+ "FailureError": null
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetPartitionBackupProgress.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetPartitionBackupProgress.json
new file mode 100644
index 000000000000..9d0df23312a6
--- /dev/null
+++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetPartitionBackupProgress.json
@@ -0,0 +1,25 @@
+{
+ "operationId": "GetPartitionBackupProgress",
+ "description": "This shows an example of possible output when GetPartitionBackupProgress has reached a BackupState of Success. If the BackupState has a value of BackupInProgress, only the BackupState field will have a value.",
+ "parameters": {
+ "partitionId": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d",
+ "api-version": "6.4"
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": {
+ "BackupState": "Success",
+ "TimeStampUtc": "2018-01-01T09:00:55Z",
+ "BackupId": "3a056ac9-7206-43c3-8424-6f6103003eba",
+ "BackupLocation": "CalcApp\\CalcService\\1daae3f5-7fd6-42e9-b1ba-8c05f873994d\\2018-01-01 09.00.55.zip",
+ "EpochOfLastBackupRecord": {
+ "DataLossVersion": "131462452931584510",
+ "ConfigurationVersion": "8589934592"
+ },
+ "LsnOfLastBackupRecord": "261",
+ "FailureError": null
+ }
+ }
+ }
+}
diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetPartitionEventList.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetPartitionEventList.json
new file mode 100644
index 000000000000..bbfca06712e9
--- /dev/null
+++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetPartitionEventList.json
@@ -0,0 +1,37 @@
+{
+ "operationId": "GetPartitionEventList",
+ "description": "This example shows how to get all partition-related events during a certain time window.",
+ "parameters": {
+ "partitionId": "f2a6a893-39be-4c7d-b07f-72bc2d36de89",
+ "api-version": "6.4",
+ "StartTimeUtc": "2018-04-03T18:00:00Z",
+ "EndTimeUtc": "2018-04-04T18:00:00Z"
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": [
+ {
+ "Kind": "PartitionReconfigured",
+ "NodeName": "node1",
+ "NodeInstanceId": "ba001a8bb353543e646be031afb10f1e",
+ "ServiceType": "Svc1Type",
+ "CcEpochDataLossVersion": 131672604833413107,
+ "CcEpochConfigVersion": 8589934595,
+ "ReconfigType": "Other",
+ "Result": "Completed",
+ "Phase0DurationMs": 0.0,
+ "Phase1DurationMs": 0.0,
+ "Phase2DurationMs": 203.1935,
+ "Phase3DurationMs": 0.0262,
+ "Phase4DurationMs": 628.8527,
+ "TotalDurationMs": 832.0724,
+ "PartitionId": "f2a6a893-39be-4c7d-b07f-72bc2d36de89",
+ "EventInstanceId": "e00fa5b7-f747-40dd-9e09-f5a031e96de4",
+ "TimeStamp": "2018-04-03T20:21:47.3778996Z",
+ "HasCorrelatedEvents": true
+ }
+ ]
+ }
+ }
+}
diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetPartitionRestartProgress.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetPartitionRestartProgress.json
new file mode 100644
index 000000000000..074289b470a2
--- /dev/null
+++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetPartitionRestartProgress.json
@@ -0,0 +1,25 @@
+{
+ "operationId": "GetPartitionRestartProgress",
+ "description": "This shows an example of possible output when GetPartitionRestartProgress has reached a State of Completed. If the State has a value of Running, only the State field will have a value.",
+ "parameters": {
+ "serviceId": "fabric:/myapp/myservice",
+ "partitionId": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d",
+ "OperationId": "6eb7f0d3-49ca-4cb1-81b7-ac2d56b5c5d1",
+ "api-version": "6.0"
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": {
+ "State": "Completed",
+ "RestartPartitionResult": {
+ "ErrorCode": 0,
+ "SelectedPartition": {
+ "ServiceName": "fabric:/myapp/myservice",
+ "PartitionId": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d"
+ }
+ }
+ }
+ }
+ }
+}
diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetPartitionRestoreProgress.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetPartitionRestoreProgress.json
new file mode 100644
index 000000000000..da52d1a100b9
--- /dev/null
+++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetPartitionRestoreProgress.json
@@ -0,0 +1,23 @@
+{
+ "operationId": "GetPartitionRestoreProgress",
+ "description": "This shows an example of possible output when GetPartitionRestoreProgress has reached a RestoreState of Success. If the RestoreState has a value of RestoreInProgress, only the RestoreState field will have a value.",
+ "parameters": {
+ "partitionId": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d",
+ "api-version": "6.4"
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": {
+ "RestoreState": "Success",
+ "TimeStampUtc": "2018-01-01T09:00:55Z",
+ "RestoredEpoch": {
+ "DataLossVersion": "131462452931584510",
+ "ConfigurationVersion": "8589934592"
+ },
+ "RestoredLsn": "261",
+ "FailureError": null
+ }
+ }
+ }
+}
diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetPartitionsEventList.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetPartitionsEventList.json
new file mode 100644
index 000000000000..e49c5e402b00
--- /dev/null
+++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetPartitionsEventList.json
@@ -0,0 +1,56 @@
+{
+ "operationId": "GetPartitionsEventList",
+ "description": "This example shows how to get all partitions-related events during a certain time window.",
+ "parameters": {
+ "api-version": "6.4",
+ "StartTimeUtc": "2018-04-03T18:00:00Z",
+ "EndTimeUtc": "2018-04-04T18:00:00Z"
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": [
+ {
+ "Kind": "PartitionReconfigured",
+ "NodeName": "node1",
+ "NodeInstanceId": "ba001a8bb353543e646be031afb10f1e",
+ "ServiceType": "Svc1Type",
+ "CcEpochDataLossVersion": 131672604833413107,
+ "CcEpochConfigVersion": 8589934595,
+ "ReconfigType": "Other",
+ "Result": "Completed",
+ "Phase0DurationMs": 0.0,
+ "Phase1DurationMs": 0.0,
+ "Phase2DurationMs": 203.1935,
+ "Phase3DurationMs": 0.0262,
+ "Phase4DurationMs": 628.8527,
+ "TotalDurationMs": 832.0724,
+ "PartitionId": "f2a6a893-39be-4c7d-b07f-72bc2d36de89",
+ "EventInstanceId": "e00fa5b7-f747-40dd-9e09-f5a031e96de4",
+ "TimeStamp": "2018-04-03T20:21:47.3778996Z",
+ "HasCorrelatedEvents": true
+ },
+ {
+ "Kind": "PartitionReconfigured",
+ "NodeName": "node2",
+ "NodeInstanceId": "ba0459d257b028296deba8bd5add33cb",
+ "ServiceType": "Svc1Type",
+ "CcEpochDataLossVersion": 131672604833413107,
+ "CcEpochConfigVersion": 8589934596,
+ "ReconfigType": "Other",
+ "Result": "Completed",
+ "Phase0DurationMs": 0.0,
+ "Phase1DurationMs": 0.0,
+ "Phase2DurationMs": 205.667,
+ "Phase3DurationMs": 407.7781,
+ "Phase4DurationMs": 630.0935,
+ "TotalDurationMs": 1243.5386,
+ "PartitionId": "e12acfb3-2a43-4a1a-a252-aa5388ef1aec",
+ "EventInstanceId": "9aeb234a-16ef-4e8a-974e-26c60d6f2b86",
+ "TimeStamp": "2018-04-03T20:21:49.5155104Z",
+ "HasCorrelatedEvents": false
+ }
+ ]
+ }
+ }
+}
diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetPropertyInfo-1.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetPropertyInfo-1.json
new file mode 100644
index 000000000000..ca5def4be2fb
--- /dev/null
+++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetPropertyInfo-1.json
@@ -0,0 +1,29 @@
+{
+ "operationId": "GetPropertyInfo",
+ "description": "This example shows how to get a Service Fabric property under a given name.",
+ "parameters": {
+ "api-version": "6.0",
+ "nameId": "samples/apps",
+ "PropertyName": "AppData"
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": {
+ "Name": "CalculatorAppData",
+ "Value": {
+ "Kind": "String",
+ "Data": "1+2=3"
+ },
+ "Metadata": {
+ "TypeId": "String",
+ "CustomTypeId": "EquationType",
+ "Parent": "fabric:/samples/apps",
+ "SizeInBytes": 12,
+ "LastModifiedUtcTimestamp": "2017-07-17T04:27:19.049Z",
+ "SequenceNumber": "12"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetPropertyInfoList-1.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetPropertyInfoList-1.json
new file mode 100644
index 000000000000..5729c6a4e4a2
--- /dev/null
+++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetPropertyInfoList-1.json
@@ -0,0 +1,41 @@
+{
+ "operationId": "GetPropertyInfoList",
+ "description": "This example shows how to get all Service Fabric properties under a given name.",
+ "parameters": {
+ "api-version": "6.0",
+ "nameId": "samples/apps"
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": {
+ "ContinuationToken": "PersistentQueueAppData$131439231986491349",
+ "IsConsistent": true,
+ "Properties": [
+ {
+ "Name": "CalculatorAppData",
+ "Metadata": {
+ "TypeId": "Int64",
+ "CustomTypeId": "",
+ "Parent": "fabric:/samples/apps",
+ "SizeInBytes": 5,
+ "LastModifiedUtcTimestamp": "2017-07-17T04:27:19.049Z",
+ "SequenceNumber": "10"
+ }
+ },
+ {
+ "Name": "PersistentQueueAppData",
+ "Metadata": {
+ "TypeId": "Binary",
+ "CustomTypeId": "InitializationDataType",
+ "Parent": "fabric:/samples/apps",
+ "SizeInBytes": 5,
+ "LastModifiedUtcTimestamp": "2017-07-17T04:36:19.049Z",
+ "SequenceNumber": "12"
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetPropertyInfoList-2.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetPropertyInfoList-2.json
new file mode 100644
index 000000000000..6a172f23f09a
--- /dev/null
+++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetPropertyInfoList-2.json
@@ -0,0 +1,56 @@
+{
+ "operationId": "GetPropertyInfoList",
+ "description": "This example shows how to get all Service Fabric properties and their values under a given name.",
+ "parameters": {
+ "api-version": "6.0",
+ "nameId": "samples/apps",
+ "IncludeValues": true
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": {
+ "ContinuationToken": "PersistentQueueAppData$131439231986491349",
+ "IsConsistent": true,
+ "Properties": [
+ {
+ "Name": "CalculatorAppData",
+ "Value": {
+ "Kind": "Int64",
+ "Data": "4534"
+ },
+ "Metadata": {
+ "TypeId": "Int64",
+ "CustomTypeId": "",
+ "Parent": "fabric:/samples/apps",
+ "SizeInBytes": 8,
+ "LastModifiedUtcTimestamp": "2017-07-17T04:27:19.049Z",
+ "SequenceNumber": "10"
+ }
+ },
+ {
+ "Name": "PersistentQueueAppData",
+ "Value": {
+ "Kind": "Binary",
+ "Data": [
+ 6,
+ 7,
+ 8,
+ 9,
+ 10
+ ]
+ },
+ "Metadata": {
+ "TypeId": "Binary",
+ "CustomTypeId": "InitializationDataType",
+ "Parent": "fabric:/samples/apps",
+ "SizeInBytes": 5,
+ "LastModifiedUtcTimestamp": "2017-07-17T04:36:19.049Z",
+ "SequenceNumber": "12"
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetPropertyInfoList-3.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetPropertyInfoList-3.json
new file mode 100644
index 000000000000..ce12465b6ce6
--- /dev/null
+++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetPropertyInfoList-3.json
@@ -0,0 +1,36 @@
+{
+ "operationId": "GetPropertyInfoList",
+ "description": "This example shows how to page through the information about properties under a given Service Fabric name using ContinuationToken parameter. The value of this parameter is provided from the previous query, in this case the example shown above. The response contains the remaining two results and an empty ContinuationToken. The empty ContinuationToken indicates that additional results are not available.",
+ "parameters": {
+ "api-version": "6.0",
+ "nameId": "samples/apps",
+ "IncludeValues": true,
+ "ContinuationToken": "PersistentQueueAppData$131439231986491349"
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": {
+ "ContinuationToken": "",
+ "IsConsistent": true,
+ "Properties": [
+ {
+ "Name": "VolatileQueueAppData",
+ "Value": {
+ "Kind": "Double",
+ "Data": 67.89
+ },
+ "Metadata": {
+ "TypeId": "Double",
+ "CustomTypeId": "",
+ "Parent": "fabric:/samples/apps",
+ "SizeInBytes": 8,
+ "LastModifiedUtcTimestamp": "2017-07-17T04:01:19.049Z",
+ "SequenceNumber": "8"
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetQuorumLossProgress-Running.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetQuorumLossProgress-Running.json
new file mode 100644
index 000000000000..203fb157db03
--- /dev/null
+++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetQuorumLossProgress-Running.json
@@ -0,0 +1,18 @@
+{
+ "operationId": "GetQuorumLossProgress",
+ "description": "This shows an example of possible output when GetQuorumLossProgress has a State of Running. If the State has a value of Running, only the State field will have a value.",
+ "parameters": {
+ "serviceId": "fabric:/myapp/myservice",
+ "partitionId": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d",
+ "OperationId": "81fbaee7-4f49-44bb-a350-4cb2b51dbf26",
+ "api-version": "6.0"
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": {
+ "State": "Running"
+ }
+ }
+ }
+}
diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetQuorumLossProgress.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetQuorumLossProgress.json
new file mode 100644
index 000000000000..c86fd0d2b31d
--- /dev/null
+++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetQuorumLossProgress.json
@@ -0,0 +1,25 @@
+{
+ "operationId": "GetQuorumLossProgress",
+ "description": "This shows an example of possible output when GetQuorumLossProgress has reached a State of Completed. If the State has a value of Running, only the State field will have a value.",
+ "parameters": {
+ "serviceId": "fabric:/myapp/myservice",
+ "partitionId": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d",
+ "OperationId": "81fbaee7-4f49-44bb-a350-4cb2b51dbf26",
+ "api-version": "6.0"
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": {
+ "State": "Completed",
+ "InvokeQuorumLossResult": {
+ "ErrorCode": 0,
+ "SelectedPartition": {
+ "ServiceName": "fabric:/myapp/myservice",
+ "PartitionId": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d"
+ }
+ }
+ }
+ }
+ }
+}
diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetReplicaEventList.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetReplicaEventList.json
new file mode 100644
index 000000000000..a3b517117bac
--- /dev/null
+++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetReplicaEventList.json
@@ -0,0 +1,35 @@
+{
+ "operationId": "GetPartitionReplicaEventList",
+ "description": "This example shows how to get all replica-related events during a certain time window.",
+ "parameters": {
+ "partitionId": "f2a6a893-39be-4c7d-b07f-72bc2d36de89",
+ "replicaId": 131672608994209130,
+ "api-version": "6.4",
+ "StartTimeUtc": "2018-04-03T18:00:00Z",
+ "EndTimeUtc": "2018-04-04T18:00:00Z"
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": [
+ {
+ "Kind": "StatefulReplicaNewHealthReport",
+ "ReplicaInstanceId": 131672608994209130,
+ "SourceId": "TestSource",
+ "Property": "",
+ "HealthState": "Error",
+ "TimeToLiveMs": 922337203685477,
+ "SequenceNumber": 131672654189677787,
+ "Description": "",
+ "RemoveWhenExpired": false,
+ "SourceUtcTimestamp": "2018-04-03T21:43:38Z",
+ "PartitionId": "f2a6a893-39be-4c7d-b07f-72bc2d36de89",
+ "ReplicaId": 131672608994209130,
+ "EventInstanceId": "b2684da3-df81-4add-8baa-201f73e9195d",
+ "TimeStamp": "2018-04-03T21:43:38.8904013Z",
+ "HasCorrelatedEvents": false
+ }
+ ]
+ }
+ }
+}
diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetReplicasEventList.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetReplicasEventList.json
new file mode 100644
index 000000000000..1d2e9212dfcc
--- /dev/null
+++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetReplicasEventList.json
@@ -0,0 +1,51 @@
+{
+ "operationId": "GetPartitionReplicasEventList",
+ "description": "This example shows how to get all replicas-related events during a certain time window.",
+ "parameters": {
+ "partitionId": "f2a6a893-39be-4c7d-b07f-72bc2d36de89",
+ "api-version": "6.4",
+ "StartTimeUtc": "2018-04-03T18:00:00Z",
+ "EndTimeUtc": "2018-04-04T18:00:00Z"
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": [
+ {
+ "Kind": "StatefulReplicaNewHealthReport",
+ "ReplicaInstanceId": 131672608994209130,
+ "SourceId": "TestSource",
+ "Property": "",
+ "HealthState": "Error",
+ "TimeToLiveMs": 922337203685477,
+ "SequenceNumber": 131672654189677787,
+ "Description": "",
+ "RemoveWhenExpired": false,
+ "SourceUtcTimestamp": "2018-04-03T21:43:38Z",
+ "PartitionId": "f2a6a893-39be-4c7d-b07f-72bc2d36de89",
+ "ReplicaId": 131672608994209130,
+ "EventInstanceId": "b2684da3-df81-4add-8baa-201f73e9195d",
+ "TimeStamp": "2018-04-03T21:43:38.8904013Z",
+ "HasCorrelatedEvents": false
+ },
+ {
+ "Kind": "StatefulReplicaNewHealthReport",
+ "ReplicaInstanceId": 177872608994339550,
+ "SourceId": "TestSource",
+ "Property": "",
+ "HealthState": "Error",
+ "TimeToLiveMs": 922337203685477,
+ "SequenceNumber": 131672654189677788,
+ "Description": "",
+ "RemoveWhenExpired": false,
+ "SourceUtcTimestamp": "2018-04-03T21:44:38Z",
+ "PartitionId": "f549f3b3-08c2-4ec4-adb4-415e024cb0ef",
+ "ReplicaId": 177872608994339550,
+ "EventInstanceId": "4a8851d8-35a3-4618-b4ac-03ffa191c350",
+ "TimeStamp": "2018-04-03T21:44:38.8904013Z",
+ "HasCorrelatedEvents": false
+ }
+ ]
+ }
+ }
+}
diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetServiceBackupConfigurationInfo-1.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetServiceBackupConfigurationInfo-1.json
new file mode 100644
index 000000000000..ab37c65b803f
--- /dev/null
+++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetServiceBackupConfigurationInfo-1.json
@@ -0,0 +1,40 @@
+{
+ "operationId": "GetServiceBackupConfigurationInfo",
+ "description": "This example shows how to get list of backup configuration for this service and partitions under this service. The number of results in a page are limited to maximum of two using the MaxResult parameter.",
+ "parameters": {
+ "api-version": "6.4",
+ "serviceId": "CalcApp/CalcService",
+ "MaxResults": 2
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": {
+ "ContinuationToken": "fabric:/CalcApp/CalcService#1daae3f5-7fd6-42e9-b1ba-8c05f873994d",
+ "Items": [
+ {
+ "Kind": "Service",
+ "PolicyName": "BackupPolicy1",
+ "PolicyInheritedFrom": "Application",
+ "ServiceName": "fabric:/CalcApp/CalcService",
+ "SuspensionInfo": {
+ "IsSuspended": false,
+ "SuspensionInheritedFrom": "Invalid"
+ }
+ },
+ {
+ "Kind": "Partition",
+ "PolicyName": "BackupPolicy2",
+ "PolicyInheritedFrom": "Partition",
+ "ServiceName": "fabric:/CalcApp/CalcService",
+ "PartitionId": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d",
+ "SuspensionInfo": {
+ "IsSuspended": false,
+ "SuspensionInheritedFrom": "Invalid"
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetServiceBackupConfigurationInfo-2.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetServiceBackupConfigurationInfo-2.json
new file mode 100644
index 000000000000..76e7e948550d
--- /dev/null
+++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetServiceBackupConfigurationInfo-2.json
@@ -0,0 +1,31 @@
+{
+ "operationId": "GetServiceBackupConfigurationInfo",
+ "description": "This example shows how to get list of backup configuration for this service and partitions under this service. The number of results in a page are limited to maximum of two using the MaxResult parameter. This example uses the ContinuationToken parameter. The value of this parameter is provided from the previous query; in this case the example shown above. The response contains the remaining results and an empty ContinuationToken. The empty ContinuationToken indicates that additional results are not available.",
+ "parameters": {
+ "api-version": "6.4",
+ "serviceId": "CalcApp/CalcService",
+ "MaxResults": 2,
+ "ContinuationToken": "fabric:/CalcApp/CalcService#1daae3f5-7fd6-42e9-b1ba-8c05f873994d"
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": {
+ "ContinuationToken": "",
+ "Items": [
+ {
+ "Kind": "Partition",
+ "PolicyName": "BackupPolicy1",
+ "PolicyInheritedFrom": "Application",
+ "ServiceName": "fabric:/CalcApp/CalcService",
+ "PartitionId": "7216486c-1ee9-4b00-99b2-92b26fcb07f6",
+ "SuspensionInfo": {
+ "IsSuspended": true,
+ "SuspensionInheritedFrom": "Partition"
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetServiceBackupList-1.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetServiceBackupList-1.json
new file mode 100644
index 000000000000..b561b1b20f84
--- /dev/null
+++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetServiceBackupList-1.json
@@ -0,0 +1,108 @@
+{
+ "operationId": "GetServiceBackupList",
+ "description": "This example shows how to get list of service backups within a time range.",
+ "parameters": {
+ "api-version": "6.4",
+ "serviceId": "CalcApp/CalcService",
+ "StartDateTimeFilter": "2018-01-01T00:00:00Z",
+ "EndDateTimeFilter": "2018-01-01T23:59:59Z"
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": {
+ "ContinuationToken": "",
+ "Items": [
+ {
+ "BackupId": "3a056ac9-7206-43c3-8424-6f6103003eba",
+ "BackupChainId": "3a056ac9-7206-43c3-8424-6f6103003eba",
+ "ApplicationName": "fabric:/CalcApp",
+ "ServiceManifestVersion": "1.0.0",
+ "ServiceName": "fabric:/CalcApp/CalcService",
+ "PartitionInformation": {
+ "LowKey": "-9223372036854775808",
+ "HighKey": "9223372036854775807",
+ "ServicePartitionKind": "Int64Range",
+ "Id": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d"
+ },
+ "BackupLocation": "CalcApp\\CalcService\\1daae3f5-7fd6-42e9-b1ba-8c05f873994d\\2018-01-01 09.00.55.zip",
+ "BackupType": "Full",
+ "EpochOfLastBackupRecord": {
+ "DataLossVersion": "131462452931584510",
+ "ConfigurationVersion": "8589934592"
+ },
+ "LsnOfLastBackupRecord": "261",
+ "CreationTimeUtc": "2018-01-01T09:00:55Z",
+ "FailureError": null
+ },
+ {
+ "BackupId": "7903dc2a-228d-44b0-b7c8-a13a6c9b46bd",
+ "BackupChainId": "3a056ac9-7206-43c3-8424-6f6103003eba",
+ "ApplicationName": "fabric:/CalcApp",
+ "ServiceManifestVersion": "1.0.0",
+ "ServiceName": "fabric:/CalcApp/CalcService",
+ "PartitionInformation": {
+ "LowKey": "-9223372036854775808",
+ "HighKey": "9223372036854775807",
+ "ServicePartitionKind": "Int64Range",
+ "Id": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d"
+ },
+ "BackupLocation": "CalcApp\\CalcService\\1daae3f5-7fd6-42e9-b1ba-8c05f873994d\\2018-01-01 17.01.02.zip",
+ "BackupType": "Incremental",
+ "EpochOfLastBackupRecord": {
+ "DataLossVersion": "131462452931584510",
+ "ConfigurationVersion": "8589934592"
+ },
+ "LsnOfLastBackupRecord": "446",
+ "CreationTimeUtc": "2018-01-01T17:01:02Z",
+ "FailureError": null
+ },
+ {
+ "BackupId": "0ff4fdbe-131c-4dfb-8249-7b4029ddc014",
+ "BackupChainId": "0ff4fdbe-131c-4dfb-8249-7b4029ddc014",
+ "ApplicationName": "fabric:/CalcApp",
+ "ServiceManifestVersion": "1.0.0",
+ "ServiceName": "fabric:/CalcApp/CalcService",
+ "PartitionInformation": {
+ "LowKey": "-9223372036854775808",
+ "HighKey": "9223372036854775807",
+ "ServicePartitionKind": "Int64Range",
+ "Id": "81645ec7-d260-4c59-9533-8f129bde8e83"
+ },
+ "BackupLocation": "CalcApp\\CalcService\\81645ec7-d260-4c59-9533-8f129bde8e83\\2018-01-01 09.01.02.zip",
+ "BackupType": "Full",
+ "EpochOfLastBackupRecord": {
+ "DataLossVersion": "131462452931584510",
+ "ConfigurationVersion": "8589934592"
+ },
+ "LsnOfLastBackupRecord": "161",
+ "CreationTimeUtc": "2018-01-01T09:01:02Z",
+ "FailureError": null
+ },
+ {
+ "BackupId": "d55a2d98-258b-4a34-8fe5-2063e81af9dc",
+ "BackupChainId": "0ff4fdbe-131c-4dfb-8249-7b4029ddc014",
+ "ApplicationName": "fabric:/CalcApp",
+ "ServiceManifestVersion": "1.0.0",
+ "ServiceName": "fabric:/CalcApp/CalcService",
+ "PartitionInformation": {
+ "LowKey": "-9223372036854775808",
+ "HighKey": "9223372036854775807",
+ "ServicePartitionKind": "Int64Range",
+ "Id": "81645ec7-d260-4c59-9533-8f129bde8e83"
+ },
+ "BackupLocation": "CalcApp\\CalcService\\81645ec7-d260-4c59-9533-8f129bde8e83\\2018-01-01 17.00.34.zip",
+ "BackupType": "Incremental",
+ "EpochOfLastBackupRecord": {
+ "DataLossVersion": "131462452931584510",
+ "ConfigurationVersion": "8589934592"
+ },
+ "LsnOfLastBackupRecord": "246",
+ "CreationTimeUtc": "2018-01-01T17:00:34Z",
+ "FailureError": null
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetServiceBackupList-2.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetServiceBackupList-2.json
new file mode 100644
index 000000000000..df570db76649
--- /dev/null
+++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetServiceBackupList-2.json
@@ -0,0 +1,63 @@
+{
+ "operationId": "GetServiceBackupList",
+ "description": "This example shows how to get the latest backup for each partition within a service.",
+ "parameters": {
+ "api-version": "6.4",
+ "serviceId": "CalcApp/CalcService",
+ "Latest": true
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": {
+ "ContinuationToken": "",
+ "Items": [
+ {
+ "BackupId": "7903dc2a-228d-44b0-b7c8-a13a6c9b46bd",
+ "BackupChainId": "3a056ac9-7206-43c3-8424-6f6103003eba",
+ "ApplicationName": "fabric:/CalcApp",
+ "ServiceManifestVersion": "1.0.0",
+ "ServiceName": "fabric:/CalcApp/CalcService",
+ "PartitionInformation": {
+ "LowKey": "-9223372036854775808",
+ "HighKey": "9223372036854775807",
+ "ServicePartitionKind": "Int64Range",
+ "Id": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d"
+ },
+ "BackupLocation": "CalcApp\\CalcService\\1daae3f5-7fd6-42e9-b1ba-8c05f873994d\\2018-01-01 17.01.02.zip",
+ "BackupType": "Incremental",
+ "EpochOfLastBackupRecord": {
+ "DataLossVersion": "131462452931584510",
+ "ConfigurationVersion": "8589934592"
+ },
+ "LsnOfLastBackupRecord": "446",
+ "CreationTimeUtc": "2018-01-01T17:01:02Z",
+ "FailureError": null
+ },
+ {
+ "BackupId": "d55a2d98-258b-4a34-8fe5-2063e81af9dc",
+ "BackupChainId": "0ff4fdbe-131c-4dfb-8249-7b4029ddc014",
+ "ApplicationName": "fabric:/CalcApp",
+ "ServiceManifestVersion": "1.0.0",
+ "ServiceName": "fabric:/CalcApp/CalcService",
+ "PartitionInformation": {
+ "LowKey": "-9223372036854775808",
+ "HighKey": "9223372036854775807",
+ "ServicePartitionKind": "Int64Range",
+ "Id": "81645ec7-d260-4c59-9533-8f129bde8e83"
+ },
+ "BackupLocation": "CalcApp\\CalcService\\81645ec7-d260-4c59-9533-8f129bde8e83\\2018-01-01 17.00.34.zip",
+ "BackupType": "Incremental",
+ "EpochOfLastBackupRecord": {
+ "DataLossVersion": "131462452931584510",
+ "ConfigurationVersion": "8589934592"
+ },
+ "LsnOfLastBackupRecord": "246",
+ "CreationTimeUtc": "2018-01-01T17:00:34Z",
+ "FailureError": null
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetServiceBackupList-3.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetServiceBackupList-3.json
new file mode 100644
index 000000000000..5b162231a889
--- /dev/null
+++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetServiceBackupList-3.json
@@ -0,0 +1,63 @@
+{
+ "operationId": "GetServiceBackupList",
+ "description": "This example shows how to get list of service backups. The number of results in a page are limited to maximum of two using the MaxResult parameter.",
+ "parameters": {
+ "api-version": "6.4",
+ "serviceId": "CalcApp/CalcService",
+ "MaxResults": 2
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": {
+ "ContinuationToken": "fabric:/CalcApp/CalcService#1daae3f5-7fd6-42e9-b1ba-8c05f873994d#7903dc2a-228d-44b0-b7c8-a13a6c9b46bd",
+ "Items": [
+ {
+ "BackupId": "3a056ac9-7206-43c3-8424-6f6103003eba",
+ "BackupChainId": "3a056ac9-7206-43c3-8424-6f6103003eba",
+ "ApplicationName": "fabric:/CalcApp",
+ "ServiceManifestVersion": "1.0.0",
+ "ServiceName": "fabric:/CalcApp/CalcService",
+ "PartitionInformation": {
+ "LowKey": "-9223372036854775808",
+ "HighKey": "9223372036854775807",
+ "ServicePartitionKind": "Int64Range",
+ "Id": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d"
+ },
+ "BackupLocation": "CalcApp\\CalcService\\1daae3f5-7fd6-42e9-b1ba-8c05f873994d\\2018-01-01 09.00.55.zip",
+ "BackupType": "Full",
+ "EpochOfLastBackupRecord": {
+ "DataLossVersion": "131462452931584510",
+ "ConfigurationVersion": "8589934592"
+ },
+ "LsnOfLastBackupRecord": "261",
+ "CreationTimeUtc": "2018-01-01T09:00:55Z",
+ "FailureError": null
+ },
+ {
+ "BackupId": "7903dc2a-228d-44b0-b7c8-a13a6c9b46bd",
+ "BackupChainId": "3a056ac9-7206-43c3-8424-6f6103003eba",
+ "ApplicationName": "fabric:/CalcApp",
+ "ServiceManifestVersion": "1.0.0",
+ "ServiceName": "fabric:/CalcApp/CalcService",
+ "PartitionInformation": {
+ "LowKey": "-9223372036854775808",
+ "HighKey": "9223372036854775807",
+ "ServicePartitionKind": "Int64Range",
+ "Id": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d"
+ },
+ "BackupLocation": "CalcApp\\CalcService\\1daae3f5-7fd6-42e9-b1ba-8c05f873994d\\2018-01-01 17.01.02.zip",
+ "BackupType": "Incremental",
+ "EpochOfLastBackupRecord": {
+ "DataLossVersion": "131462452931584510",
+ "ConfigurationVersion": "8589934592"
+ },
+ "LsnOfLastBackupRecord": "446",
+ "CreationTimeUtc": "2018-01-01T17:01:02Z",
+ "FailureError": null
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetServiceBackupList-4.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetServiceBackupList-4.json
new file mode 100644
index 000000000000..7420d61aca49
--- /dev/null
+++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetServiceBackupList-4.json
@@ -0,0 +1,64 @@
+{
+ "operationId": "GetServiceBackupList",
+ "description": "This example shows how to get list of service backups. The number of results in a page are limited to maximum of two using the MaxResult parameter. This example uses the ContinuationToken parameter. The value of this parameter is provided from the previous query; in this case the example shown above. The response contains the remaining results and an empty ContinuationToken. The empty ContinuationToken indicates that additional results are not available.",
+ "parameters": {
+ "api-version": "6.4",
+ "serviceId": "CalcApp/CalcService",
+ "MaxResults": 2,
+ "ContinuationToken": "fabric:/CalcApp/CalcService#1daae3f5-7fd6-42e9-b1ba-8c05f873994d#7903dc2a-228d-44b0-b7c8-a13a6c9b46bd"
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": {
+ "ContinuationToken": "",
+ "Items": [
+ {
+ "BackupId": "0ff4fdbe-131c-4dfb-8249-7b4029ddc014",
+ "BackupChainId": "0ff4fdbe-131c-4dfb-8249-7b4029ddc014",
+ "ApplicationName": "fabric:/CalcApp",
+ "ServiceManifestVersion": "1.0.0",
+ "ServiceName": "fabric:/CalcApp/CalcService",
+ "PartitionInformation": {
+ "LowKey": "-9223372036854775808",
+ "HighKey": "9223372036854775807",
+ "ServicePartitionKind": "Int64Range",
+ "Id": "81645ec7-d260-4c59-9533-8f129bde8e83"
+ },
+ "BackupLocation": "CalcApp\\CalcService\\81645ec7-d260-4c59-9533-8f129bde8e83\\2018-01-01 09.01.02.zip",
+ "BackupType": "Full",
+ "EpochOfLastBackupRecord": {
+ "DataLossVersion": "131462452931584510",
+ "ConfigurationVersion": "8589934592"
+ },
+ "LsnOfLastBackupRecord": "161",
+ "CreationTimeUtc": "2018-01-01T09:01:02Z",
+ "FailureError": null
+ },
+ {
+ "BackupId": "d55a2d98-258b-4a34-8fe5-2063e81af9dc",
+ "BackupChainId": "0ff4fdbe-131c-4dfb-8249-7b4029ddc014",
+ "ApplicationName": "fabric:/CalcApp",
+ "ServiceManifestVersion": "1.0.0",
+ "ServiceName": "fabric:/CalcApp/CalcService",
+ "PartitionInformation": {
+ "LowKey": "-9223372036854775808",
+ "HighKey": "9223372036854775807",
+ "ServicePartitionKind": "Int64Range",
+ "Id": "81645ec7-d260-4c59-9533-8f129bde8e83"
+ },
+ "BackupLocation": "CalcApp\\CalcService\\81645ec7-d260-4c59-9533-8f129bde8e83\\2018-01-01 17.00.34.zip",
+ "BackupType": "Incremental",
+ "EpochOfLastBackupRecord": {
+ "DataLossVersion": "131462452931584510",
+ "ConfigurationVersion": "8589934592"
+ },
+ "LsnOfLastBackupRecord": "246",
+ "CreationTimeUtc": "2018-01-01T17:00:34Z",
+ "FailureError": null
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetServiceEventList.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetServiceEventList.json
new file mode 100644
index 000000000000..fdaa115873cd
--- /dev/null
+++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetServiceEventList.json
@@ -0,0 +1,34 @@
+{
+ "operationId": "GetServiceEventList",
+ "description": "This example shows how to get all service-related events during a certain time window.",
+ "parameters": {
+ "serviceId": "app1~svc1",
+ "api-version": "6.4",
+ "StartTimeUtc": "2018-04-03T18:00:00Z",
+ "EndTimeUtc": "2018-04-04T18:00:00Z"
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": [
+ {
+ "Kind": "ServiceCreated",
+ "ServiceTypeName": "Svc1Type",
+ "ApplicationName": "fabric:/app1",
+ "ApplicationTypeName": "App1Type",
+ "ServiceInstance": 131672605579916062,
+ "IsStateful": true,
+ "PartitionCount": 2,
+ "TargetReplicaSetSize": 3,
+ "MinReplicaSetSize": 2,
+ "ServicePackageVersion": "1.0:1.0",
+ "PartitionId": "bd936249-183d-4e29-94ab-2e198e4e2e87",
+ "ServiceId": "app1/svc1",
+ "EventInstanceId": "8ba26506-4a93-4b8c-ae14-29a2841b3003",
+ "TimeStamp": "2018-04-03T20:22:38.0560496Z",
+ "HasCorrelatedEvents": false
+ }
+ ]
+ }
+ }
+}
diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetServiceTypeInfoByName-1.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetServiceTypeInfoByName-1.json
new file mode 100644
index 000000000000..4340954856fe
--- /dev/null
+++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetServiceTypeInfoByName-1.json
@@ -0,0 +1,36 @@
+{
+ "operationId": "GetServiceTypeInfoByName",
+ "description": "This example shows how to get information about a specific service type. A 204 response is returned if the specified service type is not found in the cluster.",
+ "parameters": {
+ "api-version": "6.0",
+ "applicationTypeName": "Application2Type",
+ "ApplicationTypeVersion": "1.0.0",
+ "serviceTypeName": "Actor1ActorServiceType"
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": {
+ "ServiceTypeDescription": {
+ "IsStateful": true,
+ "ServiceTypeName": "Actor1ActorServiceType",
+ "PlacementConstraints": "",
+ "HasPersistedState": true,
+ "Kind": "Stateful",
+ "Extensions": [
+ {
+ "Key": "__GeneratedServiceType__",
+ "Value": "\r\n \r\n \r\n \r\n \r\n \r\n \r\n "
+ }
+ ],
+ "LoadMetrics": [],
+ "ServicePlacementPolicies": []
+ },
+ "ServiceManifestVersion": "1.0.0",
+ "ServiceManifestName": "Actor1Pkg",
+ "IsServiceGroup": false
+ }
+ },
+ "204": {}
+ }
+}
diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetServiceTypeInfoList-1.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetServiceTypeInfoList-1.json
new file mode 100644
index 000000000000..a4481bfa08c0
--- /dev/null
+++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetServiceTypeInfoList-1.json
@@ -0,0 +1,36 @@
+{
+ "operationId": "GetServiceTypeInfoList",
+ "description": "This example shows how to get information about service types that are supported by a provisioned application type in a Service Fabric cluster.",
+ "parameters": {
+ "api-version": "6.0",
+ "applicationTypeName": "Application2Type",
+ "ApplicationTypeVersion": "1.0.0"
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": [
+ {
+ "ServiceTypeDescription": {
+ "IsStateful": true,
+ "ServiceTypeName": "Actor1ActorServiceType",
+ "PlacementConstraints": "",
+ "HasPersistedState": true,
+ "Kind": "Stateful",
+ "Extensions": [
+ {
+ "Key": "__GeneratedServiceType__",
+ "Value": "\r\n \r\n \r\n \r\n \r\n \r\n \r\n "
+ }
+ ],
+ "LoadMetrics": [],
+ "ServicePlacementPolicies": []
+ },
+ "ServiceManifestVersion": "1.0.0",
+ "ServiceManifestName": "Actor1Pkg",
+ "IsServiceGroup": false
+ }
+ ]
+ }
+ }
+}
diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetServicesEventList.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetServicesEventList.json
new file mode 100644
index 000000000000..2d5863180a5a
--- /dev/null
+++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetServicesEventList.json
@@ -0,0 +1,50 @@
+{
+ "operationId": "GetServicesEventList",
+ "description": "This example shows how to get all services-related events during a certain time window.",
+ "parameters": {
+ "api-version": "6.4",
+ "StartTimeUtc": "2018-04-03T18:00:00Z",
+ "EndTimeUtc": "2018-04-04T18:00:00Z"
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": [
+ {
+ "Kind": "ServiceCreated",
+ "ServiceTypeName": "Svc1Type",
+ "ApplicationName": "fabric:/app1",
+ "ApplicationTypeName": "App1Type",
+ "ServiceInstance": 131672605579916062,
+ "IsStateful": true,
+ "PartitionCount": 2,
+ "TargetReplicaSetSize": 3,
+ "MinReplicaSetSize": 2,
+ "ServicePackageVersion": "1.0:1.0",
+ "PartitionId": "bd936249-183d-4e29-94ab-2e198e4e2e87",
+ "ServiceId": "app1/svc1",
+ "EventInstanceId": "8ba26506-4a93-4b8c-ae14-29a2841b3003",
+ "TimeStamp": "2018-04-03T20:22:38.0560496Z",
+ "HasCorrelatedEvents": false
+ },
+ {
+ "Kind": "ServiceCreated",
+ "ServiceTypeName": "Svc2Type",
+ "ApplicationName": "fabric:/app1",
+ "ApplicationTypeName": "App1Type",
+ "ServiceInstance": 131672605579916062,
+ "IsStateful": true,
+ "PartitionCount": 2,
+ "TargetReplicaSetSize": 3,
+ "MinReplicaSetSize": 2,
+ "ServicePackageVersion": "1.0:1.0",
+ "PartitionId": "87413d64-0134-4b23-a439-c2692c4e3ec3",
+ "ServiceId": "app1/svc2",
+ "EventInstanceId": "03246d3b-77f5-4ca2-b065-7b8671711318",
+ "TimeStamp": "2018-04-03T20:22:38.056197Z",
+ "HasCorrelatedEvents": false
+ }
+ ]
+ }
+ }
+}
diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetSubNameInfoList-1.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetSubNameInfoList-1.json
new file mode 100644
index 000000000000..282319140d86
--- /dev/null
+++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetSubNameInfoList-1.json
@@ -0,0 +1,21 @@
+{
+ "operationId": "GetSubNameInfoList",
+ "description": "This example shows how to get information about all sub names of a given Service Fabric name.",
+ "parameters": {
+ "api-version": "6.0",
+ "nameId": "samples"
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": {
+ "ContinuationToken": "",
+ "IsConsistent": true,
+ "SubNames": [
+ "fabric:/samples/CalculatorApp",
+ "fabric:/samples/mynames"
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetSubNameInfoList-2.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetSubNameInfoList-2.json
new file mode 100644
index 000000000000..15391854f370
--- /dev/null
+++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetSubNameInfoList-2.json
@@ -0,0 +1,27 @@
+{
+ "operationId": "GetSubNameInfoList",
+ "description": "This example shows how to recursively get information about all child sub names of a given Service Fabric name.",
+ "parameters": {
+ "api-version": "6.0",
+ "nameId": "samples",
+ "Recursive": true
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": {
+ "ContinuationToken": "",
+ "IsConsistent": true,
+ "SubNames": [
+ "fabric:/samples/apps",
+ "fabric:/samples/data",
+ "fabric:/samples/CalculatorApp",
+ "fabric:/samples/CalculatorApp/CalculatorService",
+ "fabric:/samples/CalculatorApp/CalculatorService/Name-1",
+ "fabric:/samples/CalculatorApp/CalculatorService/Name-2",
+ "fabric:/samples/mynames/name-1"
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetSubNameInfoList-3.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetSubNameInfoList-3.json
new file mode 100644
index 000000000000..bf07c9c58bc4
--- /dev/null
+++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetSubNameInfoList-3.json
@@ -0,0 +1,23 @@
+{
+ "operationId": "GetSubNameInfoList",
+ "description": "This example shows how to page through the information about sub names under a given Service Fabric name using ContinuationToken parameter. The value of this parameter is provided from the previous query, in this case the example shown above. The response contains the remaining two results and an empty ContinuationToken. The empty ContinuationToken indicates that additional results are not available.",
+ "parameters": {
+ "api-version": "6.0",
+ "nameId": "samples",
+ "Recursive": true,
+ "ContinuationToken": "fabric:/samples/apps/PersistentQueueApp$131439231986491349"
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": {
+ "ContinuationToken": "",
+ "IsConsistent": true,
+ "SubNames": [
+ "fabric:/samples/apps/VolatileQueueApp",
+ "fabric:/samples/apps/NotepadApp"
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetUploadSessionById.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetUploadSessionById.json
new file mode 100644
index 000000000000..c565a13cfcbc
--- /dev/null
+++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetUploadSessionById.json
@@ -0,0 +1,33 @@
+{
+ "operationId": "GetImageStoreUploadSessionById",
+ "description": "This example shows how to get image store upload session by a given ID.",
+ "parameters": {
+ "api-version": "6.0",
+ "session-id": "4a2340e8-d8d8-497c-95fe-cdaa1052f33b"
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": {
+ "UploadSessions": [
+ {
+ "StoreRelativePath": "SwaggerTest\\Common.dll",
+ "SessionId": "4a2340e8-d8d8-497c-95fe-cdaa1052f33b",
+ "FileSize": "2097152",
+ "ModifiedDate": "2017-09-28T17:06:37.260Z",
+ "ExpectedRanges": [
+ {
+ "StartPosition": "0",
+ "EndPosition": "402128"
+ },
+ {
+ "StartPosition": "730105",
+ "EndPosition": "2097151"
+ }
+ ]
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetUploadSessionByPath.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetUploadSessionByPath.json
new file mode 100644
index 000000000000..8dc66b6d107d
--- /dev/null
+++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/GetUploadSessionByPath.json
@@ -0,0 +1,49 @@
+{
+ "operationId": "GetImageStoreUploadSessionByPath",
+ "description": "This example shows how to get image store upload session by a given relative path.",
+ "parameters": {
+ "api-version": "6.0",
+ "contentPath": "SwaggerTest\\Common.dll"
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": {
+ "UploadSessions": [
+ {
+ "StoreRelativePath": "SwaggerTest\\Common.dll",
+ "SessionId": "2032ac6c-a348-4594-86da-dab0f2bb1ae1",
+ "FileSize": "2097152",
+ "ModifiedDate": "2017-09-28T17:28:11.627Z",
+ "ExpectedRanges": [
+ {
+ "StartPosition": "0",
+ "EndPosition": "207615"
+ },
+ {
+ "StartPosition": "626977",
+ "EndPosition": "2097151"
+ }
+ ]
+ },
+ {
+ "StoreRelativePath": "SwaggerTest\\Common.dll",
+ "SessionId": "fb2da2b2-7cb4-45d2-a2e6-c4888d205bc5",
+ "FileSize": "2097152",
+ "ModifiedDate": "2017-09-28T17:28:11.643Z",
+ "ExpectedRanges": [
+ {
+ "StartPosition": "0",
+ "EndPosition": "616947"
+ },
+ {
+ "StartPosition": "1087529",
+ "EndPosition": "2097151"
+ }
+ ]
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/InvokeContainerApi.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/InvokeContainerApi.json
new file mode 100644
index 000000000000..bfe285758eec
--- /dev/null
+++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/InvokeContainerApi.json
@@ -0,0 +1,27 @@
+{
+ "operationId": "InvokeContainerApi",
+ "description": "This example shows how to call container API with HTTP GET for a code package deployed on a node.",
+ "parameters": {
+ "api-version": "6.2",
+ "nodeName": "Node01",
+ "applicationId": "samples/winnodejs",
+ "ServiceManifestName": "NodeServicePackage",
+ "CodePackageName": "NodeService.Code",
+ "CodePackageInstanceId": "131668159770315380",
+ "ContainerApiRequestBody": {
+ "UriPath": "/containers/{id}/logs?stdout=true&stderr=true"
+ }
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": {
+ "ContainerApiResult": {
+ "Status": 200,
+ "Content-Type": "text/plain; charset=utf-8",
+ "Body": "vEthernet (Container NIC ec5c19b2) 172.17.201.44\n"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/InvokeContainerApi_Post.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/InvokeContainerApi_Post.json
new file mode 100644
index 000000000000..0042fd341de0
--- /dev/null
+++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/InvokeContainerApi_Post.json
@@ -0,0 +1,29 @@
+{
+ "operationId": "InvokeContainerApi",
+ "description": "This example shows how to call container API with HTTP POST for a code package deployed on a node.",
+ "parameters": {
+ "api-version": "6.2",
+ "nodeName": "N0020",
+ "applicationId": "samples/nodejs1",
+ "ServiceManifestName": "NodeOnSF",
+ "CodePackageName": "Code",
+ "CodePackageInstanceId": "131673596679688285",
+ "ContainerApiRequestBody": {
+ "HttpVerb": "POST",
+ "UriPath": "/containers/{id}/update",
+ "Body": "{ \"CpuShares\": 512}"
+ }
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": {
+ "ContainerApiResult": {
+ "Status": 200,
+ "Content-Type": "application/json",
+ "Body": "{\"Warnings\":null}\n"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/PutProperty-1.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/PutProperty-1.json
new file mode 100644
index 000000000000..8eee209e7c7b
--- /dev/null
+++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/PutProperty-1.json
@@ -0,0 +1,25 @@
+{
+ "operationId": "PutProperty",
+ "description": "This example shows how to create or update a Service Fabric property under a given name.",
+ "parameters": {
+ "api-version": "6.0",
+ "nameId": "samples/apps/CalculatorApp",
+ "PropertyDescription": {
+ "PropertyName": "AppData",
+ "Value": {
+ "Kind": "Binary",
+ "Data": [
+ 0,
+ 1,
+ 2,
+ 3,
+ 4,
+ 5
+ ]
+ }
+ }
+ },
+ "responses": {
+ "200": {}
+ }
+}
diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/PutProperty-2.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/PutProperty-2.json
new file mode 100644
index 000000000000..5db6a9ad77f7
--- /dev/null
+++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/PutProperty-2.json
@@ -0,0 +1,19 @@
+{
+ "operationId": "PutProperty",
+ "description": "This example shows how to create or update a Service Fabric property under a given name with a custom type.",
+ "parameters": {
+ "api-version": "6.0",
+ "nameId": "samples/apps/CalculatorApp",
+ "PropertyDescription": {
+ "PropertyName": "AppData",
+ "Value": {
+ "Kind": "String",
+ "Data": "1+2=3"
+ },
+ "CustomTypeId": "EquationType"
+ }
+ },
+ "responses": {
+ "200": {}
+ }
+}
diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/Resources/Applications/Services/Replicas/CodePackages/get_logs.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/Resources/Applications/Services/Replicas/CodePackages/get_logs.json
new file mode 100644
index 000000000000..5f17ef376d9d
--- /dev/null
+++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/Resources/Applications/Services/Replicas/CodePackages/get_logs.json
@@ -0,0 +1,18 @@
+{
+ "operationId": "MeshCodePackage_GetContainerLogs",
+ "description": "This example shows how to get logs from the container of service replica. If the container exists, the logs are returned with an OK (200) status code, otherwise an error is returned with an appropriate status code.",
+ "parameters": {
+ "api-version": "6.4-preview",
+ "applicationResourceName": "sbzDocApp",
+ "serviceResourceName": "sbzDocService",
+ "replicaName": "0",
+ "codePackageName": "sbzDocCode"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "Content": " * Running on http://0.0.0.0:8080/ (Press CTRL+C to quit)\n * Downloading style https://assets-cdn.github.com/assets/frameworks-8f281eb0a8d2308ceb36e714ba3c3aec.css\n * Downloading style https://assets-cdn.github.com/assets/github-a698da0d53574b056d3c79ac732d4a70.css\n * Downloading style https://assets-cdn.github.com/assets/site-83dc1f7ebc9c7461fe1eab799b56c4c4.css\n * Cached all downloads in /root/.grip/cache-4.5.2\n167.220.0.83 - - [06/Apr/2018 07:16:02] \"GET / HTTP/1.1\" 200 -\n167.220.0.83 - - [06/Apr/2018 07:16:02] \"GET /__/grip/asset/frameworks-8f281eb0a8d2308ceb36e714ba3c3aec.css HTTP/1.1\" 200 -\n167.220.0.83 - - [06/Apr/2018 07:16:02] \"GET /__/grip/asset/site-83dc1f7ebc9c7461fe1eab799b56c4c4.css HTTP/1.1\" 200 -\n167.220.0.83 - - [06/Apr/2018 07:16:02] \"GET /__/grip/asset/github-a698da0d53574b056d3c79ac732d4a70.css HTTP/1.1\" 200 -\n167.220.0.83 - - [06/Apr/2018 07:16:02] \"GET /__/grip/static/octicons/octicons.css HTTP/1.1\" 200 -\n167.220.0.83 - - [06/Apr/2018 07:16:03] \"GET /__/grip/static/octicons/octicons.woff2?ef21c39f0ca9b1b5116e5eb7ac5eabe6 HTTP/1.1\" 200 -\n167.220.0.83 - - [06/Apr/2018 07:16:03] \"GET /__/grip/static/favicon.ico HTTP/1.1\" 200 -\n167.220.0.83 - - [06/Apr/2018 07:16:05] \"GET /seabreeze-index.md HTTP/1.1\" 200 -\n167.220.0.83 - - [06/Apr/2018 07:16:09] \"GET /seabreeze-api-application_get.md HTTP/1.1\" 200 -\n"
+ }
+ }
+ }
+}
diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/Resources/Applications/Services/Replicas/get.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/Resources/Applications/Services/Replicas/get.json
new file mode 100644
index 000000000000..bb373e90c328
--- /dev/null
+++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/Resources/Applications/Services/Replicas/get.json
@@ -0,0 +1,57 @@
+{
+ "operationId": "MeshServiceReplica_Get",
+ "description": "This example shows how to get information about given replica of a service. If the replica exists, its description is returned along with an OK (200) status code. If the replica does not exist, an error is returned with an appropriate status code.",
+ "parameters": {
+ "api-version": "6.4-preview",
+ "applicationResourceName": "sampleApplication",
+ "serviceResourceName": "helloWorldService",
+ "replicaName": "0"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "osType": "Linux",
+ "codePackages": [
+ {
+ "name": "helloWorldCode",
+ "image": "seabreeze/sbz-helloworld:1.0-alpine",
+ "endpoints": [
+ {
+ "name": "helloWorldListener",
+ "port": 80
+ }
+ ],
+ "resources": {
+ "requests": {
+ "memoryInGB": 1,
+ "cpu": 1
+ }
+ },
+ "instanceView": {
+ "restartCount": 1,
+ "currentState": {
+ "state": "Running",
+ "exitCode": "0"
+ },
+ "previousState": {
+ "state": "NotSpecified",
+ "exitCode": "0"
+ }
+ }
+ }
+ ],
+ "networkRefs": [
+ {
+ "name": "sampleNetwork",
+ "endpointRefs": [
+ {
+ "name": "helloWorldListener"
+ }
+ ]
+ }
+ ],
+ "replicaName": "0"
+ }
+ }
+ }
+}
diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/Resources/Applications/Services/Replicas/list.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/Resources/Applications/Services/Replicas/list.json
new file mode 100644
index 000000000000..1fe9b30fb836
--- /dev/null
+++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/Resources/Applications/Services/Replicas/list.json
@@ -0,0 +1,105 @@
+{
+ "operationId": "MeshServiceReplica_List",
+ "description": "This example shows how to list replicas of a service resources for a given application.",
+ "parameters": {
+ "api-version": "6.4-preview",
+ "applicationResourceName": "sampleApplication",
+ "serviceResourceName": "helloWorldService"
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": {
+ "ContinuationToken": "",
+ "Items": [
+ {
+ "osType": "Linux",
+ "codePackages": [
+ {
+ "name": "helloWorldCode",
+ "image": "seabreeze/sbz-helloworld:1.0-alpine",
+ "endpoints": [
+ {
+ "name": "helloWorldListener",
+ "port": 80
+ }
+ ],
+ "resources": {
+ "requests": {
+ "memoryInGB": 1,
+ "cpu": 1
+ }
+ },
+ "instanceView": {
+ "restartCount": 1,
+ "currentState": {
+ "state": "Running",
+ "exitCode": "0"
+ },
+ "previousState": {
+ "state": "NotSpecified",
+ "exitCode": "0"
+ }
+ }
+ }
+ ],
+ "networkRefs": [
+ {
+ "name": "sampleNetwork",
+ "endpointRefs": [
+ {
+ "name": "helloWorldListener"
+ }
+ ]
+ }
+ ],
+ "replicaName": "0"
+ },
+ {
+ "osType": "Linux",
+ "codePackages": [
+ {
+ "name": "helloWorldCode",
+ "image": "seabreeze/sbz-helloworld:1.0-alpine",
+ "endpoints": [
+ {
+ "name": "helloWorldListener",
+ "port": 80
+ }
+ ],
+ "resources": {
+ "requests": {
+ "memoryInGB": 1,
+ "cpu": 1
+ }
+ },
+ "instanceView": {
+ "restartCount": 1,
+ "currentState": {
+ "state": "Running",
+ "exitCode": "0"
+ },
+ "previousState": {
+ "state": "NotSpecified",
+ "exitCode": "0"
+ }
+ }
+ }
+ ],
+ "networkRefs": [
+ {
+ "name": "sampleNetwork",
+ "endpointRefs": [
+ {
+ "name": "helloWorldListener"
+ }
+ ]
+ }
+ ],
+ "replicaName": "1"
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/Resources/Applications/Services/get.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/Resources/Applications/Services/get.json
new file mode 100644
index 000000000000..45224d3a66f8
--- /dev/null
+++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/Resources/Applications/Services/get.json
@@ -0,0 +1,51 @@
+{
+ "operationId": "MeshService_Get",
+ "description": "This example shows how to get a service resource for a given application. If the service resource exists, its description is returned along with an OK (200) status code. If the service resource does not exist, an error is returned with an appropriate status code.",
+ "parameters": {
+ "api-version": "6.4-preview",
+ "applicationResourceName": "sampleApplication",
+ "serviceResourceName": "helloWorldService"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "name": "helloWorldService",
+ "properties": {
+ "osType": "Linux",
+ "codePackages": [
+ {
+ "name": "helloWorldCode",
+ "image": "seabreeze/sbz-helloworld:1.0-alpine",
+ "endpoints": [
+ {
+ "name": "helloWorldListener",
+ "port": 80
+ }
+ ],
+ "resources": {
+ "requests": {
+ "memoryInGB": 1,
+ "cpu": 1
+ }
+ }
+ }
+ ],
+ "networkRefs": [
+ {
+ "name": "sampleNetwork",
+ "endpointRefs": [
+ {
+ "name": "helloWorldListener"
+ }
+ ]
+ }
+ ],
+ "description": "SeaBreeze Hello World Service.",
+ "replicaCount": 1,
+ "healthState": "Ok",
+ "status": "Ready"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/Resources/Applications/Services/list.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/Resources/Applications/Services/list.json
new file mode 100644
index 000000000000..3df5e396c764
--- /dev/null
+++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/Resources/Applications/Services/list.json
@@ -0,0 +1,56 @@
+{
+ "operationId": "MeshService_List",
+ "description": "This example shows how to list all service resources for a given application.",
+ "parameters": {
+ "api-version": "6.4-preview",
+ "applicationResourceName": "sampleApplication"
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": {
+ "ContinuationToken": "",
+ "Items": [
+ {
+ "name": "helloWorldService",
+ "properties": {
+ "osType": "Linux",
+ "codePackages": [
+ {
+ "name": "helloWorldCode",
+ "image": "seabreeze/sbz-helloworld:1.0-alpine",
+ "endpoints": [
+ {
+ "name": "helloWorldListener",
+ "port": 80
+ }
+ ],
+ "resources": {
+ "requests": {
+ "memoryInGB": 1,
+ "cpu": 1
+ }
+ }
+ }
+ ],
+ "networkRefs": [
+ {
+ "name": "sampleNetwork",
+ "endpointRefs": [
+ {
+ "name": "helloWorldListener"
+ }
+ ]
+ }
+ ],
+ "description": "SeaBreeze Hello World Service.",
+ "replicaCount": 1,
+ "healthState": "Ok",
+ "status": "Ready"
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/Resources/Applications/create_update.autoscale.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/Resources/Applications/create_update.autoscale.json
new file mode 100644
index 000000000000..16b621f6a572
--- /dev/null
+++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/Resources/Applications/create_update.autoscale.json
@@ -0,0 +1,102 @@
+{
+ "operationId": "MeshApplication_CreateOrUpdate",
+ "description": "This example shows how to create or update a application resource with services that autoscale based on the policies.",
+ "parameters": {
+ "api-version": "6.4-preview",
+ "applicationResourceName": "sampleApplication",
+ "applicationResourceDescription": {
+ "name": "sampleApplication",
+ "properties": {
+ "description": "Service Fabric Mesh sample application.",
+ "services": [
+ {
+ "name": "helloWorldService",
+ "properties": {
+ "description": "SeaBreeze Hello World Service.",
+ "osType": "Linux",
+ "codePackages": [
+ {
+ "name": "helloWorldCode",
+ "image": "seabreeze/sbz-helloworld:1.0-alpine",
+ "endpoints": [
+ {
+ "name": "helloWorldListener",
+ "port": 80
+ }
+ ],
+ "resources": {
+ "requests": {
+ "memoryInGB": 1,
+ "cpu": 1
+ }
+ }
+ }
+ ],
+ "replicaCount": 1,
+ "autoScalingPolicies": [
+ {
+ "name": "MyAutoScaleRule",
+ "trigger": {
+ "kind": "AverageLoad",
+ "metric": {
+ "kind": "Resource",
+ "name": "cpu"
+ },
+ "lowerLoadThreshold": 0.3,
+ "upperLoadThreshold": 0.8,
+ "scaleIntervalInSeconds": 3600
+ },
+ "mechanism": {
+ "kind": "AddRemoveReplica",
+ "minCount": 1,
+ "maxCount": 4,
+ "scaleIncrement": 1
+ }
+ }
+ ],
+ "networkRefs": [
+ {
+ "name": "sampleNetwork",
+ "endpointRefs": [
+ {
+ "name": "helloWorldListener"
+ }
+ ]
+ }
+ ]
+ }
+ }
+ ]
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "name": "sampleApplication",
+ "properties": {
+ "description": "Service Fabric Mesh sample application.",
+ "serviceNames": [
+ "helloWorldService"
+ ],
+ "healthState": "Ok",
+ "status": "Ready"
+ }
+ }
+ },
+ "201": {
+ "body": {
+ "name": "sampleApplication",
+ "properties": {
+ "description": "Service Fabric Mesh sample application.",
+ "serviceNames": [
+ "helloWorldService"
+ ],
+ "healthState": "Unknown",
+ "status": "Creating"
+ }
+ }
+ },
+ "202": {}
+ }
+}
diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/Resources/Applications/create_update.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/Resources/Applications/create_update.json
new file mode 100644
index 000000000000..8066c046fd00
--- /dev/null
+++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/Resources/Applications/create_update.json
@@ -0,0 +1,139 @@
+{
+ "operationId": "MeshApplication_CreateOrUpdate",
+ "description": "This example shows how to create or update a application resource.",
+ "parameters": {
+ "api-version": "6.4-preview",
+ "applicationResourceName": "sampleApplication",
+ "applicationResourceDescription": {
+ "name": "sampleApplication",
+ "properties": {
+ "description": "Service Fabric Mesh sample application.",
+ "services": [
+ {
+ "name": "helloWorldService",
+ "properties": {
+ "description": "SeaBreeze Hello World Service.",
+ "identityRefs": [
+ {
+ "name": "ServiceIdentity1",
+ "identityRef": "/subscriptions/c1089427-83d3-4286-9f35-5af546a6eb67/resourcegroups/myGroup/providers/Microsoft.Identity/Identities/identity1"
+ },
+ {
+ "name": "ServiceIdentity2",
+ "identityRef": "SystemAssigned"
+ }
+ ],
+ "osType": "Linux",
+ "codePackages": [
+ {
+ "name": "helloWorldCode",
+ "image": "seabreeze/sbz-helloworld:1.0-alpine",
+ "endpoints": [
+ {
+ "name": "helloWorldListener",
+ "port": 80
+ }
+ ],
+ "resources": {
+ "requests": {
+ "memoryInGB": 1,
+ "cpu": 1
+ }
+ }
+ }
+ ],
+ "replicaCount": 1,
+ "networkRefs": [
+ {
+ "name": "sampleNetwork",
+ "endpointRefs": [
+ {
+ "name": "helloWorldListener"
+ }
+ ]
+ }
+ ]
+ }
+ }
+ ]
+ }
+ },
+ "identity": {
+ "type": "SystemAssigned,UserAssigned",
+ "tokenServiceEndpoint": "http://tokenservice",
+ "tenantId": "D47A6CD5-E870-4ADF-8C00-1C0B758BC567",
+ "principalId": "84DFA616-1F44-4D63-BC08-43B5F758D16C",
+ "userAssignedIdentities": {
+ "/subscriptions/c1089427-83d3-4286-9f35-5af546a6eb67/resourcegroups/myGroup/providers/Microsoft.Identity/Identities/identity1": {
+ "clientId": "5287A675-78D2-4E49-BF09-D3BFE02493D4",
+ "principalId": "7D6F0B1C-AF9F-4E21-9B3C-AE22F4D926F8"
+ },
+ "/subscriptions/c1089427-83d3-4286-9f35-5af546a6eb67/resourcegroups/myGroup/providers/Microsoft.Identity/Identities/identity2": {
+ "clientId": "AF1509EC-9B5F-43CC-8A6F-FA7CC84AEBE1",
+ "principalId": "31144ACF-46F4-4639-A711-A257229EE0C0"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "name": "sampleApplication",
+ "properties": {
+ "description": "Service Fabric Mesh sample application.",
+ "serviceNames": [
+ "helloWorldService"
+ ],
+ "healthState": "Ok",
+ "status": "Ready"
+ },
+ "identity": {
+ "type": "SystemAssigned,UserAssigned",
+ "tokenServiceEndpoint": "http://tokenservice",
+ "tenantId": "D47A6CD5-E870-4ADF-8C00-1C0B758BC567",
+ "principalId": "84DFA616-1F44-4D63-BC08-43B5F758D16C",
+ "userAssignedIdentities": {
+ "/subscriptions/c1089427-83d3-4286-9f35-5af546a6eb67/resourcegroups/myGroup/providers/Microsoft.Identity/Identities/identity1": {
+ "clientId": "5287A675-78D2-4E49-BF09-D3BFE02493D4",
+ "principalId": "7D6F0B1C-AF9F-4E21-9B3C-AE22F4D926F8"
+ },
+ "/subscriptions/c1089427-83d3-4286-9f35-5af546a6eb67/resourcegroups/myGroup/providers/Microsoft.Identity/Identities/identity2": {
+ "clientId": "AF1509EC-9B5F-43CC-8A6F-FA7CC84AEBE1",
+ "principalId": "31144ACF-46F4-4639-A711-A257229EE0C0"
+ }
+ }
+ }
+ }
+ },
+ "201": {
+ "body": {
+ "name": "sampleApplication",
+ "properties": {
+ "description": "Service Fabric Mesh sample application.",
+ "serviceNames": [
+ "helloWorldService"
+ ],
+ "healthState": "Unknown",
+ "status": "Creating"
+ },
+ "identity": {
+ "type": "SystemAssigned,UserAssigned",
+ "tokenServiceEndpoint": "http://tokenservice",
+ "tenantId": "D47A6CD5-E870-4ADF-8C00-1C0B758BC567",
+ "principalId": "84DFA616-1F44-4D63-BC08-43B5F758D16C",
+ "userAssignedIdentities": {
+ "/subscriptions/c1089427-83d3-4286-9f35-5af546a6eb67/resourcegroups/myGroup/providers/Microsoft.Identity/Identities/identity1": {
+ "clientId": "5287A675-78D2-4E49-BF09-D3BFE02493D4",
+ "principalId": "7D6F0B1C-AF9F-4E21-9B3C-AE22F4D926F8"
+ },
+ "/subscriptions/c1089427-83d3-4286-9f35-5af546a6eb67/resourcegroups/myGroup/providers/Microsoft.Identity/Identities/identity2": {
+ "clientId": "AF1509EC-9B5F-43CC-8A6F-FA7CC84AEBE1",
+ "principalId": "31144ACF-46F4-4639-A711-A257229EE0C0"
+ }
+ }
+ }
+ }
+ },
+ "202": {}
+ }
+}
diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/Resources/Applications/delete.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/Resources/Applications/delete.json
new file mode 100644
index 000000000000..b51511b0865d
--- /dev/null
+++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/Resources/Applications/delete.json
@@ -0,0 +1,13 @@
+{
+ "operationId": "MeshApplication_Delete",
+ "description": "This example shows how to delete an existing application resource. If the application resource exists and is deleted successfully, an empty response with 200 status code is returned. If the application resource does not exist, an empty response with 204 status code is returned.",
+ "parameters": {
+ "api-version": "6.4-preview",
+ "applicationResourceName": "sampleApplication"
+ },
+ "responses": {
+ "200": {},
+ "202": {},
+ "204": {}
+ }
+}
diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/Resources/Applications/get.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/Resources/Applications/get.json
new file mode 100644
index 000000000000..208ccd280bbd
--- /dev/null
+++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/Resources/Applications/get.json
@@ -0,0 +1,39 @@
+{
+ "operationId": "MeshApplication_Get",
+ "description": "This example shows how to get a application resource. If the application resource exists, its description is returned along with an OK (200) status code. If the application resource does not exist, an error is returned with an appropriate status code.",
+ "parameters": {
+ "api-version": "6.4-preview",
+ "applicationResourceName": "sampleApplication"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "name": "sampleApplication",
+ "properties": {
+ "description": "Service Fabric Mesh sample application.",
+ "serviceNames": [
+ "helloWorldService"
+ ],
+ "healthState": "Ok",
+ "status": "Ready"
+ },
+ "identity": {
+ "type": "SystemAssigned,UserAssigned",
+ "tokenServiceEndpoint": "http://tokenservice",
+ "tenantId": "D47A6CD5-E870-4ADF-8C00-1C0B758BC567",
+ "principalId": "84DFA616-1F44-4D63-BC08-43B5F758D16C",
+ "userAssignedIdentities": {
+ "/subscriptions/c1089427-83d3-4286-9f35-5af546a6eb67/resourcegroups/myGroup/providers/Microsoft.Identity/Identities/identity1": {
+ "clientId": "5287A675-78D2-4E49-BF09-D3BFE02493D4",
+ "principalId": "7D6F0B1C-AF9F-4E21-9B3C-AE22F4D926F8"
+ },
+ "/subscriptions/c1089427-83d3-4286-9f35-5af546a6eb67/resourcegroups/myGroup/providers/Microsoft.Identity/Identities/identity2": {
+ "clientId": "AF1509EC-9B5F-43CC-8A6F-FA7CC84AEBE1",
+ "principalId": "31144ACF-46F4-4639-A711-A257229EE0C0"
+ }
+ }
+ }
+ }
+ }
+ }
+}
diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/Resources/Applications/get_upgrade.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/Resources/Applications/get_upgrade.json
new file mode 100644
index 000000000000..61be95fa11b7
--- /dev/null
+++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/Resources/Applications/get_upgrade.json
@@ -0,0 +1,30 @@
+{
+ "operationId": "MeshApplication_GetUpgradeProgress",
+ "description": "This example shows how to get a application resource upgrade. If the application resource exists, its description is returned along with an OK (200) status code. If the application resource does not exist, an error is returned with an appropriate status code.",
+ "parameters": {
+ "api-version": "6.4-preview",
+ "applicationResourceName": "sampleApplication"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "Name": "sampleApplication",
+ "TargetApplicationTypeVersion": "v1",
+ "StartTimestampUtc": "0001-01-01T00:00:00.000Z",
+ "UpgradeState": "RollingForward",
+ "PercentCompleted": "0",
+ "ServiceUpgradeProgress": [
+ {
+ "ServiceName": "helloWorldService",
+ "CompletedReplicaCount": "0",
+ "PendingReplicaCount": "3"
+ }
+ ],
+ "RollingUpgradeMode": "Monitored",
+ "UpgradeDuration": "PT0H0M2.31669S",
+ "ApplicationUpgradeStatusDetails": "Deployment upgrading from version: v0 to version: v1.",
+ "UpgradeReplicaSetCheckTimeoutInSeconds": 4294967295
+ }
+ }
+ }
+}
diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/Resources/Applications/list.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/Resources/Applications/list.json
new file mode 100644
index 000000000000..2f34f40e3488
--- /dev/null
+++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/Resources/Applications/list.json
@@ -0,0 +1,44 @@
+{
+ "operationId": "MeshApplication_List",
+ "description": "This example shows how to list all application resources.",
+ "parameters": {
+ "api-version": "6.4-preview"
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": {
+ "ContinuationToken": "",
+ "Items": [
+ {
+ "name": "sampleApplication",
+ "properties": {
+ "description": "Service Fabric Mesh sample application.",
+ "serviceNames": [
+ "helloWorldService"
+ ],
+ "healthState": "Ok",
+ "status": "Ready"
+ },
+ "identity": {
+ "type": "SystemAssigned,UserAssigned",
+ "tokenServiceEndpoint": "http://tokenservice",
+ "tenantId": "D47A6CD5-E870-4ADF-8C00-1C0B758BC567",
+ "principalId": "84DFA616-1F44-4D63-BC08-43B5F758D16C",
+ "userAssignedIdentities": {
+ "/subscriptions/c1089427-83d3-4286-9f35-5af546a6eb67/resourcegroups/myGroup/providers/Microsoft.Identity/Identities/identity1": {
+ "clientId": "5287A675-78D2-4E49-BF09-D3BFE02493D4",
+ "principalId": "7D6F0B1C-AF9F-4E21-9B3C-AE22F4D926F8"
+ },
+ "/subscriptions/c1089427-83d3-4286-9f35-5af546a6eb67/resourcegroups/myGroup/providers/Microsoft.Identity/Identities/identity2": {
+ "clientId": "AF1509EC-9B5F-43CC-8A6F-FA7CC84AEBE1",
+ "principalId": "31144ACF-46F4-4639-A711-A257229EE0C0"
+ }
+ }
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/Resources/Gateways/create_update.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/Resources/Gateways/create_update.json
new file mode 100644
index 000000000000..2ded194ec7cc
--- /dev/null
+++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/Resources/Gateways/create_update.json
@@ -0,0 +1,193 @@
+{
+ "operationId": "MeshGateway_CreateOrUpdate",
+ "description": "This example shows how to create or update a gateway resource.",
+ "parameters": {
+ "api-version": "6.4-preview",
+ "gatewayResourceName": "sampleGateway",
+ "gatewayResourceDescription": {
+ "name": "sampleGateway",
+ "properties": {
+ "description": "Service Fabric Mesh sample gateway.",
+ "sourceNetwork": {
+ "name": "Open"
+ },
+ "destinationNetwork": {
+ "name": "helloWorldNetwork"
+ },
+ "tcp": [
+ {
+ "name": "web",
+ "port": 80,
+ "destination": {
+ "applicationName": "helloWorldApp",
+ "serviceName": "helloWorldService",
+ "endpointName": "helloWorldListener"
+ }
+ }
+ ],
+ "http": [
+ {
+ "name": "contosoWebsite",
+ "port": 8081,
+ "hosts": [
+ {
+ "name": "contoso.com",
+ "routes": [
+ {
+ "name": "index",
+ "match": {
+ "path": {
+ "value": "/index",
+ "rewrite": "/",
+ "type": "prefix"
+ },
+ "headers": [
+ {
+ "name": "accept",
+ "value": "application/json",
+ "type": "exact"
+ }
+ ]
+ },
+ "destination": {
+ "applicationName": "httpHelloWorldApp",
+ "serviceName": "indexService",
+ "endpointName": "indexHttpEndpoint"
+ }
+ }
+ ]
+ }
+ ]
+ }
+ ]
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "name": "sampleGateway",
+ "properties": {
+ "description": "Service Fabric Mesh sample gateway.",
+ "sourceNetwork": {
+ "name": "Open"
+ },
+ "destinationNetwork": {
+ "name": "helloWorldNetwork"
+ },
+ "tcp": [
+ {
+ "name": "web",
+ "port": 80,
+ "destination": {
+ "applicationName": "helloWorldApp",
+ "serviceName": "helloWorldService",
+ "endpointName": "helloWorldListener"
+ }
+ }
+ ],
+ "http": [
+ {
+ "name": "contosoWebsite",
+ "port": 8081,
+ "hosts": [
+ {
+ "name": "contoso.com",
+ "routes": [
+ {
+ "name": "index",
+ "match": {
+ "path": {
+ "value": "/index",
+ "rewrite": "/",
+ "type": "prefix"
+ },
+ "headers": [
+ {
+ "name": "accept",
+ "value": "application/json",
+ "type": "exact"
+ }
+ ]
+ },
+ "destination": {
+ "applicationName": "httpHelloWorldApp",
+ "serviceName": "indexService",
+ "endpointName": "indexHttpEndpoint"
+ }
+ }
+ ]
+ }
+ ]
+ }
+ ],
+ "status": "Ready",
+ "ipAddress": "192.168.1.1"
+ }
+ }
+ },
+ "201": {
+ "body": {
+ "name": "sampleGateway",
+ "properties": {
+ "description": "Service Fabric Mesh Hello World sample gateway.",
+ "sourceNetwork": {
+ "name": "Open"
+ },
+ "destinationNetwork": {
+ "name": "helloWorldNetwork"
+ },
+ "tcp": [
+ {
+ "name": "web",
+ "port": 80,
+ "destination": {
+ "applicationName": "helloWorldApp",
+ "serviceName": "helloWorldService",
+ "endpointName": "helloWorldListener"
+ }
+ }
+ ],
+ "http": [
+ {
+ "name": "contosoWebsite",
+ "port": 8081,
+ "hosts": [
+ {
+ "name": "contoso.com",
+ "routes": [
+ {
+ "name": "index",
+ "match": {
+ "path": {
+ "value": "/index",
+ "rewrite": "/",
+ "type": "prefix"
+ },
+ "headers": [
+ {
+ "name": "accept",
+ "value": "application/json",
+ "type": "exact"
+ }
+ ]
+ },
+ "destination": {
+ "applicationName": "httpHelloWorldApp",
+ "serviceName": "indexService",
+ "endpointName": "indexHttpEndpoint"
+ }
+ }
+ ]
+ }
+ ]
+ }
+ ],
+ "status": "Creating",
+ "ipAddress": ""
+ }
+ }
+ },
+ "202": {}
+ }
+}
diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/Resources/Gateways/delete.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/Resources/Gateways/delete.json
new file mode 100644
index 000000000000..63ed69926752
--- /dev/null
+++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/Resources/Gateways/delete.json
@@ -0,0 +1,13 @@
+{
+ "operationId": "MeshGateway_Delete",
+ "description": "This example shows how to delete an existing gateway resource. If the gateway resource exists and is deleted successfully, an empty response with 200 status code is returned. If the gateway resource does not exist, an empty response with 204 status code is returned.",
+ "parameters": {
+ "api-version": "6.4-preview",
+ "gatewayResourceName": "sampleGateway"
+ },
+ "responses": {
+ "200": {},
+ "202": {},
+ "204": {}
+ }
+}
diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/Resources/Gateways/get.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/Resources/Gateways/get.json
new file mode 100644
index 000000000000..c85b652cbc45
--- /dev/null
+++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/Resources/Gateways/get.json
@@ -0,0 +1,72 @@
+{
+ "operationId": "MeshGateway_Get",
+ "description": "This example shows how to get a gateway resource. If the gateway resource exists, its description is returned along with an OK (200) status code. If the gateway resource does not exist, an error is returned with an appropriate status code.",
+ "parameters": {
+ "api-version": "6.4-preview",
+ "gatewayResourceName": "sampleGateway"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "name": "sampleGateway",
+ "properties": {
+ "description": "Service Fabric Mesh sample gateway.",
+ "sourceNetwork": {
+ "name": "Open"
+ },
+ "destinationNetwork": {
+ "name": "helloWorldNetwork"
+ },
+ "tcp": [
+ {
+ "name": "web",
+ "port": 80,
+ "destination": {
+ "applicationName": "helloWorldApp",
+ "serviceName": "helloWorldService",
+ "endpointName": "helloWorldListener"
+ }
+ }
+ ],
+ "http": [
+ {
+ "name": "contosoWebsite",
+ "port": 8081,
+ "hosts": [
+ {
+ "name": "contoso.com",
+ "routes": [
+ {
+ "name": "index",
+ "match": {
+ "path": {
+ "value": "/index",
+ "rewrite": "/",
+ "type": "prefix"
+ },
+ "headers": [
+ {
+ "name": "accept",
+ "value": "application/json",
+ "type": "exact"
+ }
+ ]
+ },
+ "destination": {
+ "applicationName": "httpHelloWorldApp",
+ "serviceName": "indexService",
+ "endpointName": "indexHttpEndpoint"
+ }
+ }
+ ]
+ }
+ ]
+ }
+ ],
+ "status": "Ready",
+ "ipAddress": "192.168.1.1"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/Resources/Gateways/list.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/Resources/Gateways/list.json
new file mode 100644
index 000000000000..5ad53b7d580f
--- /dev/null
+++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/Resources/Gateways/list.json
@@ -0,0 +1,77 @@
+{
+ "operationId": "MeshGateway_List",
+ "description": "This example shows how to list all gateway resources.",
+ "parameters": {
+ "api-version": "6.4-preview"
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": {
+ "ContinuationToken": "",
+ "Items": [
+ {
+ "name": "sampleGateway",
+ "properties": {
+ "description": "Service Fabric Mesh sample gateway.",
+ "sourceNetwork": {
+ "name": "Open"
+ },
+ "destinationNetwork": {
+ "name": "helloWorldNetwork"
+ },
+ "tcp": [
+ {
+ "name": "web",
+ "port": 80,
+ "destination": {
+ "applicationName": "helloWorldApp",
+ "serviceName": "helloWorldService",
+ "endpointName": "helloWorldListener"
+ }
+ }
+ ],
+ "http": [
+ {
+ "name": "contosoWebsite",
+ "port": 8081,
+ "hosts": [
+ {
+ "name": "contoso.com",
+ "routes": [
+ {
+ "name": "index",
+ "match": {
+ "path": {
+ "value": "/index",
+ "rewrite": "/",
+ "type": "prefix"
+ },
+ "headers": [
+ {
+ "name": "accept",
+ "value": "application/json",
+ "type": "exact"
+ }
+ ]
+ },
+ "destination": {
+ "applicationName": "httpHelloWorldApp",
+ "serviceName": "indexService",
+ "endpointName": "indexHttpEndpoint"
+ }
+ }
+ ]
+ }
+ ]
+ }
+ ],
+ "status": "Ready",
+ "ipAddress": "192.168.1.1"
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/Resources/Networks/create_update.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/Resources/Networks/create_update.json
new file mode 100644
index 000000000000..faf2a3960b48
--- /dev/null
+++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/Resources/Networks/create_update.json
@@ -0,0 +1,41 @@
+{
+ "operationId": "MeshNetwork_CreateOrUpdate",
+ "description": "This example shows how to create or update a network resource.",
+ "parameters": {
+ "api-version": "6.4-preview",
+ "networkResourceName": "sampleNetwork",
+ "networkResourceDescription": {
+ "name": "sampleNetwork",
+ "properties": {
+ "kind": "Local",
+ "description": "Service Fabric Mesh sample network.",
+ "networkAddressPrefix": "2.0.0.0/16"
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "name": "sampleNetwork",
+ "properties": {
+ "kind": "Local",
+ "description": "Service Fabric Mesh sample network.",
+ "networkAddressPrefix": "2.0.0.0/16",
+ "status": "Ready"
+ }
+ }
+ },
+ "201": {
+ "body": {
+ "name": "sampleNetwork",
+ "properties": {
+ "kind": "Local",
+ "description": "Service Fabric Mesh sample network.",
+ "networkAddressPrefix": "2.0.0.0/16",
+ "status": "Creating"
+ }
+ }
+ },
+ "202": {}
+ }
+}
diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/Resources/Networks/delete.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/Resources/Networks/delete.json
new file mode 100644
index 000000000000..aea2170b7316
--- /dev/null
+++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/Resources/Networks/delete.json
@@ -0,0 +1,13 @@
+{
+ "operationId": "MeshGateway_Delete",
+ "description": "This example shows how to delete an existing network resource. If the network resource exists and is deleted successfully, an empty response with 200 status code is returned. If the network resource does not exist, an empty response with 204 status code is returned.",
+ "parameters": {
+ "api-version": "6.4-preview",
+ "networkResourceName": "sampleNetwork"
+ },
+ "responses": {
+ "200": {},
+ "202": {},
+ "204": {}
+ }
+}
diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/Resources/Networks/get.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/Resources/Networks/get.json
new file mode 100644
index 000000000000..1afaee298e7d
--- /dev/null
+++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/Resources/Networks/get.json
@@ -0,0 +1,21 @@
+{
+ "operationId": "MeshGateway_Get",
+ "description": "This example shows how to get a network resource. If the network resource exists, its description is returned along with an OK (200) status code. If the network resource does not exist, an error is returned with an appropriate status code.",
+ "parameters": {
+ "api-version": "6.4-preview",
+ "networkResourceName": "sampleNetwork"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "name": "sampleNetwork",
+ "properties": {
+ "kind": "Local",
+ "description": "Service Fabric Mesh sample network.",
+ "networkAddressPrefix": "2.0.0.0/16",
+ "status": "Ready"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/Resources/Networks/list.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/Resources/Networks/list.json
new file mode 100644
index 000000000000..6cf521d8582c
--- /dev/null
+++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/Resources/Networks/list.json
@@ -0,0 +1,26 @@
+{
+ "operationId": "MeshGateway_List",
+ "description": "This example shows how to list all network resources.",
+ "parameters": {
+ "api-version": "6.4-preview"
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": {
+ "ContinuationToken": "",
+ "Items": [
+ {
+ "name": "sampleNetwork",
+ "properties": {
+ "kind": "Local",
+ "description": "Service Fabric Mesh sample network.",
+ "networkAddressPrefix": "2.0.0.0/16",
+ "status": "Ready"
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/Resources/Secrets/create_update.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/Resources/Secrets/create_update.json
new file mode 100644
index 000000000000..aab0125db5a5
--- /dev/null
+++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/Resources/Secrets/create_update.json
@@ -0,0 +1,41 @@
+{
+ "operationId": "MeshSecret_CreateOrUpdate",
+ "description": "This example shows how to create or update a secret resource.",
+ "parameters": {
+ "api-version": "6.4-preview",
+ "secretResourceName": "dbConnectionString",
+ "secretResourceDescription": {
+ "name": "dbConnectionString",
+ "properties": {
+ "kind": "inlinedValue",
+ "contentType": "text/plain",
+ "description": "Mongo DB connection string for backend database!"
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "name": "dbConnectionString",
+ "properties": {
+ "kind": "inlinedValue",
+ "contentType": "text/plain",
+ "description": "Mongo DB connection string for backend database!",
+ "status": "Ready"
+ }
+ }
+ },
+ "201": {
+ "body": {
+ "name": "dbConnectionString",
+ "properties": {
+ "kind": "inlinedValue",
+ "contentType": "text/plain",
+ "description": "Mongo DB connection string for backend database!",
+ "status": "Creating"
+ }
+ }
+ },
+ "202": {}
+ }
+}
diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/Resources/Secrets/delete.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/Resources/Secrets/delete.json
new file mode 100644
index 000000000000..ffe68fd3ddc7
--- /dev/null
+++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/Resources/Secrets/delete.json
@@ -0,0 +1,13 @@
+{
+ "operationId": "MeshSecret_Delete",
+ "description": "This example shows how to delete an existing secret resource. If the secret resource exists and is deleted successfully, an empty response with 200 status code is returned. If the secret resource does not exist, an empty response with 204 status code is returned.",
+ "parameters": {
+ "api-version": "6.4-preview",
+ "secretResourceName": "dbConnectionString"
+ },
+ "responses": {
+ "200": {},
+ "202": {},
+ "204": {}
+ }
+}
diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/Resources/Secrets/get.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/Resources/Secrets/get.json
new file mode 100644
index 000000000000..f358e51722dd
--- /dev/null
+++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/Resources/Secrets/get.json
@@ -0,0 +1,21 @@
+{
+ "operationId": "MeshSecret_Get",
+ "description": "This example shows how to get a secret resource. If the secret resource exists, its description is returned along with an OK (200) status code. If the secret resource does not exist, an error is returned with an appropriate status code.",
+ "parameters": {
+ "api-version": "6.4-preview",
+ "secretResourceName": "dbConnectionString"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "name": "dbConnectionString",
+ "properties": {
+ "kind": "inlinedValue",
+ "contentType": "text/plain",
+ "description": "Mongo DB connection string for backend database!",
+ "status": "Ready"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/Resources/Secrets/list.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/Resources/Secrets/list.json
new file mode 100644
index 000000000000..b46d7f8ff341
--- /dev/null
+++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/Resources/Secrets/list.json
@@ -0,0 +1,35 @@
+{
+ "operationId": "MeshSecret_List",
+ "description": "This example shows how to list all secret resources.",
+ "parameters": {
+ "api-version": "6.4-preview"
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": {
+ "ContinuationToken": "",
+ "Items": [
+ {
+ "name": "dbConnectionString",
+ "properties": {
+ "kind": "inlinedValue",
+ "contentType": "text/plain",
+ "description": "Mongo DB connection string for backend database!",
+ "status": "Ready"
+ }
+ },
+ {
+ "name": "contosoServiceApiKey",
+ "properties": {
+ "kind": "inlinedValue",
+ "contentType": "text/plain",
+ "description": "API Key to access contoso service APIs",
+ "status": "Ready"
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/Resources/Secrets/values/create.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/Resources/Secrets/values/create.json
new file mode 100644
index 000000000000..8cd0824452fd
--- /dev/null
+++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/Resources/Secrets/values/create.json
@@ -0,0 +1,34 @@
+{
+ "operationId": "MeshSecretValue_AddValue",
+ "description": "This example shows how to add a new value of a secret resource; the secret value is provided as plaintext.",
+ "parameters": {
+ "api-version": "6.4-preview",
+ "secretResourceName": "dbConnectionString",
+ "secretValueResourceName": "v1",
+ "secretValueResourceDescription": {
+ "name": "v1",
+ "properties": {
+ "value": "mongodb://contoso123:0Fc3IolnL12312asdfawejunASDF@asdfYXX2t8a97kghVcUzcDv98hawelufhawefafnoQRGwNj2nMPL1Y9qsIr9Srdw==@contoso123.documents.azure.com:10255/mydatabase?ssl=true"
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "name": "v1",
+ "properties": {
+ "value": null
+ }
+ }
+ },
+ "201": {
+ "body": {
+ "name": "v1",
+ "properties": {
+ "value": null
+ }
+ }
+ },
+ "202": {}
+ }
+}
diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/Resources/Secrets/values/delete.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/Resources/Secrets/values/delete.json
new file mode 100644
index 000000000000..ad4b3ef9540b
--- /dev/null
+++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/Resources/Secrets/values/delete.json
@@ -0,0 +1,14 @@
+{
+ "operationId": "MeshSecretValue_Delete",
+ "description": "This example shows how to delete a secret value. If the specified named value exists and is deleted successfully, an empty response with 200 status code is returned. If the specified named value does not exist, an empty response with 204 status code is returned.",
+ "parameters": {
+ "api-version": "6.4-preview",
+ "secretResourceName": "dbConnectionString",
+ "secretValueResourceName": "v1"
+ },
+ "responses": {
+ "200": {},
+ "202": {},
+ "204": {}
+ }
+}
diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/Resources/Secrets/values/get.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/Resources/Secrets/values/get.json
new file mode 100644
index 000000000000..a6491634ef44
--- /dev/null
+++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/Resources/Secrets/values/get.json
@@ -0,0 +1,19 @@
+{
+ "operationId": "MeshSecretValue_Get",
+ "description": "This example shows how to get the specified secret value resource. If the specified named value exists, its information is returned along with status code 200. The information does not include the value. To get the unecnrypted value use ListMeshSecretValue operation. If the specified named value does not exist, an error is returned with an appropriate status code.",
+ "parameters": {
+ "api-version": "6.4-preview",
+ "secretResourceName": "dbConnectionString",
+ "secretValueResourceName": "v1"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "name": "v1",
+ "properties": {
+ "value": null
+ }
+ }
+ }
+ }
+}
diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/Resources/Secrets/values/list.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/Resources/Secrets/values/list.json
new file mode 100644
index 000000000000..0610d6d83c48
--- /dev/null
+++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/Resources/Secrets/values/list.json
@@ -0,0 +1,29 @@
+{
+ "operationId": "MeshSecretValue_List",
+ "description": "This example shows how to list names of all values of a secret resource, not including their respective values.",
+ "parameters": {
+ "api-version": "6.4-preview",
+ "secretResourceName": "dbConnectionString"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "ContinuationToken": "",
+ "Items": [
+ {
+ "name": "v1",
+ "properties": {
+ "value": null
+ }
+ },
+ {
+ "name": "v2",
+ "properties": {
+ "value": null
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/Resources/Secrets/values/list_value.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/Resources/Secrets/values/list_value.json
new file mode 100644
index 000000000000..b8d09ce2e23c
--- /dev/null
+++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/Resources/Secrets/values/list_value.json
@@ -0,0 +1,16 @@
+{
+ "operationId": "MeshSecretValue_Show",
+ "description": "This example shows how to get the unencrypted value of the secret. If the specified named value resource exists, its unencrypted value is returned along with status code 200. If the specified named value does not exist, an error is returned with an appropriate status code.",
+ "parameters": {
+ "api-version": "6.4-preview",
+ "secretResourceName": "dbConnectionString",
+ "secretValueResourceName": "v1"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": "mongodb://contoso123:0Fc3IolnL12312asdfawejunASDF@asdfYXX2t8a97kghVcUzcDv98hawelufhawefafnoQRGwNj2nMPL1Y9qsIr9Srdw==@contoso123.documents.azure.com:10255/mydatabase?ssl=true"
+ }
+ }
+ }
+}
diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/Resources/Volumes/create_update.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/Resources/Volumes/create_update.json
new file mode 100644
index 000000000000..ba2623cdc556
--- /dev/null
+++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/Resources/Volumes/create_update.json
@@ -0,0 +1,53 @@
+{
+ "operationId": "MeshVolume_CreateOrUpdate",
+ "description": "This example shows how to create or update a volume resource.",
+ "parameters": {
+ "api-version": "6.4-preview",
+ "volumeResourceName": "sampleVolume",
+ "volumeResourceDescription": {
+ "name": "sampleVolume",
+ "properties": {
+ "description": "Service Fabric Mesh sample volume.",
+ "provider": "SFAzureFile",
+ "azureFileParameters": {
+ "accountName": "sbzdemoaccount",
+ "accountKey": "provide-account-key-here",
+ "shareName": "sharel"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "name": "sampleVolume",
+ "properties": {
+ "description": "Service Fabric Mesh sample volume.",
+ "provider": "SFAzureFile",
+ "azureFileParameters": {
+ "accountName": "sbzdemoaccount",
+ "accountKey": null,
+ "shareName": "sharel"
+ },
+ "status": "Ready"
+ }
+ }
+ },
+ "201": {
+ "body": {
+ "name": "sampleVolume",
+ "properties": {
+ "description": "Service Fabric Mesh Hello World sample volume.",
+ "provider": "SFAzureFile",
+ "azureFileParameters": {
+ "accountName": "sbzdemoaccount",
+ "accountKey": null,
+ "shareName": "sharel"
+ },
+ "status": "Creating"
+ }
+ }
+ },
+ "202": {}
+ }
+}
diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/Resources/Volumes/delete.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/Resources/Volumes/delete.json
new file mode 100644
index 000000000000..efaa1f836ae1
--- /dev/null
+++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/Resources/Volumes/delete.json
@@ -0,0 +1,13 @@
+{
+ "operationId": "MeshVolume_Delete",
+ "description": "This example shows how to delete an existing volume resource. If the volume resource exists and is deleted successfully, an empty response with 200 status code is returned. If the volume resource does not exist, an empty response with 204 status code is returned.",
+ "parameters": {
+ "api-version": "6.4-preview",
+ "volumeResourceName": "sampleVolume"
+ },
+ "responses": {
+ "200": {},
+ "202": {},
+ "204": {}
+ }
+}
diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/Resources/Volumes/get.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/Resources/Volumes/get.json
new file mode 100644
index 000000000000..9d08f3b00a82
--- /dev/null
+++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/Resources/Volumes/get.json
@@ -0,0 +1,25 @@
+{
+ "operationId": "MeshVolume_Get",
+ "description": "This example shows how to get a volume resource. If the volume resource exists, its description is returned along with an OK (200) status code. If the volume resource does not exist, an error is returned with an appropriate status code.",
+ "parameters": {
+ "api-version": "6.4-preview",
+ "volumeResourceName": "sampleVolume"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "name": "sampleVolume",
+ "properties": {
+ "description": "Service Fabric Mesh sample volume.",
+ "provider": "SFAzureFile",
+ "azureFileParameters": {
+ "accountName": "sbzdemoaccount",
+ "accountKey": null,
+ "shareName": "sharel"
+ },
+ "status": "Ready"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/Resources/Volumes/list.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/Resources/Volumes/list.json
new file mode 100644
index 000000000000..3bf83798904b
--- /dev/null
+++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/Resources/Volumes/list.json
@@ -0,0 +1,30 @@
+{
+ "operationId": "MeshVolume_List",
+ "description": "This example shows how to list all volume resources.",
+ "parameters": {
+ "api-version": "6.4-preview"
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": {
+ "ContinuationToken": "",
+ "Items": [
+ {
+ "name": "sampleVolume",
+ "properties": {
+ "description": "Service Fabric Mesh sample volume.",
+ "provider": "SFAzureFile",
+ "azureFileParameters": {
+ "accountName": "sbzdemoaccount",
+ "accountKey": null,
+ "shareName": "sharel"
+ },
+ "status": "Ready"
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/RestorePartition.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/RestorePartition.json
new file mode 100644
index 000000000000..1e97e0557113
--- /dev/null
+++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/RestorePartition.json
@@ -0,0 +1,20 @@
+{
+ "operationId": "RestorePartition",
+ "description": "This example shows how to trigger restore of a partition now by specifying the backup to be used to restore.",
+ "parameters": {
+ "api-version": "6.4",
+ "partitionId": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d",
+ "RestorePartitionDescription": {
+ "BackupId": "3a056ac9-7206-43c3-8424-6f6103003eba",
+ "BackupStorage": {
+ "StorageKind": "AzureBlobStore",
+ "ConnectionString": "DefaultEndpointsProtocol=https;AccountName=storagesample;AccountKey=",
+ "ContainerName": "BackupContainer"
+ },
+ "BackupLocation": "CalcApp\\CalcService\\1daae3f5-7fd6-42e9-b1ba-8c05f873994d\\2018-01-01 09.00.55.zip"
+ }
+ },
+ "responses": {
+ "202": {}
+ }
+}
diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/ResumeApplicationBackup.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/ResumeApplicationBackup.json
new file mode 100644
index 000000000000..b25a7ac545ec
--- /dev/null
+++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/ResumeApplicationBackup.json
@@ -0,0 +1,11 @@
+{
+ "operationId": "ResumeApplicationBackup",
+ "description": "This example shows how to resume periodic backup for a stateful application which was previously suspended.",
+ "parameters": {
+ "api-version": "6.4",
+ "applicationId": "CalcApp"
+ },
+ "responses": {
+ "202": {}
+ }
+}
diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/ResumePartitionBackup.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/ResumePartitionBackup.json
new file mode 100644
index 000000000000..feb701118438
--- /dev/null
+++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/ResumePartitionBackup.json
@@ -0,0 +1,11 @@
+{
+ "operationId": "ResumePartitionBackup",
+ "description": "This example shows how to resume periodic backup for a stateful partition which was previously suspended.",
+ "parameters": {
+ "api-version": "6.4",
+ "partitionId": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d"
+ },
+ "responses": {
+ "202": {}
+ }
+}
diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/ResumeServiceBackup.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/ResumeServiceBackup.json
new file mode 100644
index 000000000000..9037dfa23d9e
--- /dev/null
+++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/ResumeServiceBackup.json
@@ -0,0 +1,11 @@
+{
+ "operationId": "ResumeServiceBackup",
+ "description": "This example shows how to resume periodic backup for a stateful service which was previously suspended.",
+ "parameters": {
+ "api-version": "6.4",
+ "serviceId": "CalcApp/CalcService"
+ },
+ "responses": {
+ "202": {}
+ }
+}
diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/StartClusterConfigurationUpgrade-1.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/StartClusterConfigurationUpgrade-1.json
new file mode 100644
index 000000000000..2f8fd59a474e
--- /dev/null
+++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/StartClusterConfigurationUpgrade-1.json
@@ -0,0 +1,40 @@
+{
+ "operationId": "StartClusterConfigurationUpgrade",
+ "description": "This example shows how to start upgrading the configuration of a Service Fabric standalone cluster.",
+ "parameters": {
+ "api-version": "6.0",
+ "nameId": "samples/apps/CalculatorApp",
+ "ClusterConfigurationUpgradeDescription": {
+ "ClusterConfig": "",
+ "ApplicationHealthPolicies": {
+ "ApplicationHealthPolicyMap": [
+ {
+ "Key": "fabric:/samples/CalculatorApp",
+ "Value": {
+ "ConsiderWarningAsError": true,
+ "MaxPercentUnhealthyDeployedApplications": 10,
+ "DefaultServiceTypeHealthPolicy": {
+ "MaxPercentUnhealthyPartitionsPerService": 0,
+ "MaxPercentUnhealthyReplicasPerPartition": 0,
+ "MaxPercentUnhealthyServices": 0
+ },
+ "ServiceTypeHealthPolicyMap": [
+ {
+ "Key": "Svc1Type",
+ "Value": {
+ "MaxPercentUnhealthyPartitionsPerService": 0,
+ "MaxPercentUnhealthyReplicasPerPartition": 0,
+ "MaxPercentUnhealthyServices": 10
+ }
+ }
+ ]
+ }
+ }
+ ]
+ }
+ }
+ },
+ "responses": {
+ "202": {}
+ }
+}
diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/SubmitPropertyBatch-1.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/SubmitPropertyBatch-1.json
new file mode 100644
index 000000000000..05410c96edc2
--- /dev/null
+++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/SubmitPropertyBatch-1.json
@@ -0,0 +1,71 @@
+{
+ "operationId": "SubmitPropertyBatch",
+ "description": "This example shows how to submit a property batch. This batch ensures that a property exists, checks that the property has the expected sequence number, and edits the property only if the previous conditions succeed. It then performs a get operation to get the property's current info. \r\n If all of the operations succeed, the batch is committed in a transactional manner and a success response is returned with 200 status code. \r\n If the batch fails then a failed response is returned with 409 status code. The failed response below shows batch failure because the property does not have expected sequence number.",
+ "parameters": {
+ "api-version": "6.0",
+ "nameId": "samples/apps",
+ "PropertyBatchDescriptionList": {
+ "Operations": [
+ {
+ "Kind": "CheckExists",
+ "PropertyName": "PersistentQueueAppData",
+ "Exists": true
+ },
+ {
+ "Kind": "CheckSequence",
+ "PropertyName": "PersistentQueueAppData",
+ "SequenceNumber": "12"
+ },
+ {
+ "Kind": "Put",
+ "PropertyName": "PersistentQueueAppData",
+ "Value": {
+ "Kind": "Binary",
+ "Data": [
+ 1,
+ 2,
+ 3,
+ 4,
+ 5
+ ]
+ },
+ "CustomTypeId": "InitializationData"
+ },
+ {
+ "Kind": "Get",
+ "PropertyName": "PersistentQueueAppData",
+ "IncludeValue": false
+ }
+ ]
+ }
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": {
+ "Kind": "Successful",
+ "Properties": {
+ "3": {
+ "Name": "PersistentQueueAppData",
+ "Metadata": {
+ "TypeId": "Binary",
+ "CustomTypeId": "InitializationData",
+ "Parent": "fabric:/samples/apps",
+ "SizeInBytes": 5,
+ "LastModifiedUtcTimestamp": "2017-07-17T05:01:19.049Z",
+ "SequenceNumber": "13"
+ }
+ }
+ }
+ }
+ },
+ "409": {
+ "headers": {},
+ "body": {
+ "Kind": "Failed",
+ "ErrorMessage": "FABRIC_E_PROPERTY_CHECK_FAILED",
+ "OperationIndex": 1
+ }
+ }
+ }
+}
diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/SuspendApplicationBackup.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/SuspendApplicationBackup.json
new file mode 100644
index 000000000000..75bdad71a95e
--- /dev/null
+++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/SuspendApplicationBackup.json
@@ -0,0 +1,11 @@
+{
+ "operationId": "SuspendApplicationBackup",
+ "description": "This example shows how to suspend backup for a stateful application which is configured for periodic backup.",
+ "parameters": {
+ "api-version": "6.4",
+ "applicationId": "CalcApp"
+ },
+ "responses": {
+ "202": {}
+ }
+}
diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/SuspendPartitionBackup.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/SuspendPartitionBackup.json
new file mode 100644
index 000000000000..b14619dd6fe8
--- /dev/null
+++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/SuspendPartitionBackup.json
@@ -0,0 +1,11 @@
+{
+ "operationId": "SuspendPartitionBackup",
+ "description": "This example shows how to suspend backup for a stateful partition which is configured for periodic backup.",
+ "parameters": {
+ "api-version": "6.4",
+ "partitionId": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d"
+ },
+ "responses": {
+ "202": {}
+ }
+}
diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/SuspendServiceBackup.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/SuspendServiceBackup.json
new file mode 100644
index 000000000000..14d0575c509e
--- /dev/null
+++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/SuspendServiceBackup.json
@@ -0,0 +1,11 @@
+{
+ "operationId": "SuspendServiceBackup",
+ "description": "This example shows how to suspend backup for a stateful service which is configured for periodic backup.",
+ "parameters": {
+ "api-version": "6.4",
+ "serviceId": "CalcApp/CalcService"
+ },
+ "responses": {
+ "202": {}
+ }
+}
diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/UpdateBackupPolicy.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/UpdateBackupPolicy.json
new file mode 100644
index 000000000000..3129817ddb68
--- /dev/null
+++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/UpdateBackupPolicy.json
@@ -0,0 +1,35 @@
+{
+ "operationId": "UpdateBackupPolicy",
+ "description": "This example shows how to update the schedule of a backup policy to take backup twice everyday at 9 AM and 5 PM UTC which shall get deleted after 30 days, with Azure blob store as the backup location.",
+ "parameters": {
+ "api-version": "6.4",
+ "backupPolicyName": "DailyAzureBackupPolicy",
+ "BackupPolicyDescription": {
+ "Name": "DailyAzureBackupPolicy",
+ "AutoRestoreOnDataLoss": false,
+ "MaxIncrementalBackups": 3,
+ "Schedule": {
+ "ScheduleKind": "TimeBased",
+ "ScheduleFrequencyType": "Daily",
+ "RunTimes": [
+ "0001-01-01T09:00:00Z",
+ "0001-01-01T17:00:00Z"
+ ]
+ },
+ "Storage": {
+ "StorageKind": "AzureBlobStore",
+ "FriendlyName": "Azure_storagesample",
+ "ConnectionString": "DefaultEndpointsProtocol=https;AccountName=storagesample;AccountKey=",
+ "ContainerName": "BackupContainer"
+ },
+ "RetentionPolicy": {
+ "RetentionPolicyType": "Basic",
+ "MinimumNumberOfBackups": 60,
+ "RetentionDuration": "P30D"
+ }
+ }
+ },
+ "responses": {
+ "200": {}
+ }
+}
diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/UpdateService-1.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/UpdateService-1.json
new file mode 100644
index 000000000000..3dd7f5950427
--- /dev/null
+++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/UpdateService-1.json
@@ -0,0 +1,34 @@
+{
+ "operationId": "UpdateService",
+ "description": "This example shows how to update placement and load balancing related settings of a stateless Service Fabric service.",
+ "parameters": {
+ "serviceId": "test~test1",
+ "api-version": "6.0",
+ "ServiceUpdateDescription": {
+ "ServiceKind": "Stateless",
+ "Flags": "1568",
+ "PlacementConstraints": "Color==Red",
+ "DefaultMoveCost": "High",
+ "ScalingPolicies": [
+ {
+ "ScalingTrigger": {
+ "Kind": "AveragePartitionLoad",
+ "MetricName": "servicefabric:/_CpuCores",
+ "LowerLoadThreshold": "0.500000",
+ "UpperLoadThreshold": "0.800000",
+ "ScaleIntervalInSeconds": 900
+ },
+ "ScalingMechanism": {
+ "Kind": "PartitionInstanceCount",
+ "MinInstanceCount": 4,
+ "MaxInstanceCount": 6,
+ "ScaleIncrement": 2
+ }
+ }
+ ]
+ }
+ },
+ "responses": {
+ "200": {}
+ }
+}
diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/UpdateService-2.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/UpdateService-2.json
new file mode 100644
index 000000000000..cdb1368dbdd6
--- /dev/null
+++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/examples/UpdateService-2.json
@@ -0,0 +1,17 @@
+{
+ "operationId": "UpdateService",
+ "description": "This example shows how to update placement and load balancing related settings of a stateful Service Fabric service.",
+ "parameters": {
+ "serviceId": "test~test2",
+ "api-version": "6.0",
+ "ServiceUpdateDescription": {
+ "ServiceKind": "Stateful",
+ "Flags": "40",
+ "PlacementConstraints": "Color==Green",
+ "StandByReplicaKeepDurationSeconds": "1000"
+ }
+ },
+ "responses": {
+ "200": {}
+ }
+}
diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/servicefabric.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/servicefabric.json
new file mode 100644
index 000000000000..fe543ad5b773
--- /dev/null
+++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/7.1/servicefabric.json
@@ -0,0 +1,28452 @@
+{
+ "swagger": "2.0",
+ "info": {
+ "title": "Service Fabric Client APIs",
+ "description": "Service Fabric REST Client APIs allows management of Service Fabric clusters, applications and services.",
+ "version": "7.1.0.45"
+ },
+ "host": "localhost:19080",
+ "schemes": [
+ "http",
+ "https"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "paths": {
+ "/$/GetClusterManifest": {
+ "get": {
+ "operationId": "GetClusterManifest",
+ "summary": "Get the Service Fabric cluster manifest.",
+ "description": "Get the Service Fabric cluster manifest. The cluster manifest contains properties of the cluster that include different node types on the cluster,\nsecurity configurations, fault, and upgrade domain topologies, etc.\n\nThese properties are specified as part of the ClusterConfig.JSON file while deploying a stand-alone cluster. However, most of the information in the cluster manifest\nis generated internally by service fabric during cluster deployment in other deployment scenarios (e.g. when using Azure portal).\n\nThe contents of the cluster manifest are for informational purposes only and users are not expected to take a dependency on the format of the file contents or its interpretation.",
+ "tags": [
+ "Cluster"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "A successful operation will return 200 status code and the requested cluster manifest information.",
+ "schema": {
+ "$ref": "#/definitions/ClusterManifest"
+ }
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/$/GetClusterHealth": {
+ "get": {
+ "operationId": "GetClusterHealth",
+ "summary": "Gets the health of a Service Fabric cluster.",
+ "description": "Use EventsHealthStateFilter to filter the collection of health events reported on the cluster based on the health state.\nSimilarly, use NodesHealthStateFilter and ApplicationsHealthStateFilter to filter the collection of nodes and applications returned based on their aggregated health state.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/NodesHealthStateFilterOptionalQueryParam"
+ },
+ {
+ "$ref": "#/parameters/ApplicationsHealthStateFilterOptionalQueryParam"
+ },
+ {
+ "$ref": "#/parameters/EventsHealthStateFilterOptionalQueryParam"
+ },
+ {
+ "$ref": "#/parameters/ExcludeHealthStatisticsOptionalQueryParam"
+ },
+ {
+ "$ref": "#/parameters/IncludeSystemApplicationHealthStatisticsOptionalQueryParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "tags": [
+ "Cluster"
+ ],
+ "responses": {
+ "200": {
+ "description": "A successful operation will return 200 status code and the requested cluster health information.",
+ "schema": {
+ "$ref": "#/definitions/ClusterHealth"
+ }
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ },
+ "post": {
+ "operationId": "GetClusterHealthUsingPolicy",
+ "summary": "Gets the health of a Service Fabric cluster using the specified policy.",
+ "description": "Use EventsHealthStateFilter to filter the collection of health events reported on the cluster based on the health state.\nSimilarly, use NodesHealthStateFilter and ApplicationsHealthStateFilter to filter the collection of nodes and applications returned based on their aggregated health state.\nUse ClusterHealthPolicies to override the health policies used to evaluate the health.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/NodesHealthStateFilterOptionalQueryParam"
+ },
+ {
+ "$ref": "#/parameters/ApplicationsHealthStateFilterOptionalQueryParam"
+ },
+ {
+ "$ref": "#/parameters/EventsHealthStateFilterOptionalQueryParam"
+ },
+ {
+ "$ref": "#/parameters/ExcludeHealthStatisticsOptionalQueryParam"
+ },
+ {
+ "$ref": "#/parameters/IncludeSystemApplicationHealthStatisticsOptionalQueryParam"
+ },
+ {
+ "$ref": "#/parameters/ClusterHealthPoliciesOptionalBodyParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "tags": [
+ "Cluster"
+ ],
+ "responses": {
+ "200": {
+ "description": "A successful operation will return 200 status code and the requested cluster health information.",
+ "schema": {
+ "$ref": "#/definitions/ClusterHealth"
+ }
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/$/GetClusterHealthChunk": {
+ "get": {
+ "operationId": "GetClusterHealthChunk",
+ "summary": "Gets the health of a Service Fabric cluster using health chunks.",
+ "description": "Gets the health of a Service Fabric cluster using health chunks. Includes the aggregated health state of the cluster, but none of the cluster entities.\nTo expand the cluster health and get the health state of all or some of the entities, use the POST URI and specify the cluster health chunk query description.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "tags": [
+ "Cluster"
+ ],
+ "responses": {
+ "200": {
+ "description": "A successful operation will return 200 status code and the requested cluster health chunk information.",
+ "schema": {
+ "$ref": "#/definitions/ClusterHealthChunk"
+ }
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ },
+ "post": {
+ "operationId": "GetClusterHealthChunkUsingPolicyAndAdvancedFilters",
+ "summary": "Gets the health of a Service Fabric cluster using health chunks.",
+ "description": "Gets the health of a Service Fabric cluster using health chunks. The health evaluation is done based on the input cluster health chunk query description.\nThe query description allows users to specify health policies for evaluating the cluster and its children.\nUsers can specify very flexible filters to select which cluster entities to return. The selection can be done based on the entities health state and based on the hierarchy.\nThe query can return multi-level children of the entities based on the specified filters. For example, it can return one application with a specified name, and for this application, return\nonly services that are in Error or Warning, and all partitions and replicas for one of these services.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/ClusterHealthChunkQueryDescriptionOptionalBodyParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "tags": [
+ "Cluster"
+ ],
+ "responses": {
+ "200": {
+ "description": "A successful operation will return 200 status code and the requested cluster health chunk information.",
+ "schema": {
+ "$ref": "#/definitions/ClusterHealthChunk"
+ }
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/$/ReportClusterHealth": {
+ "post": {
+ "operationId": "ReportClusterHealth",
+ "summary": "Sends a health report on the Service Fabric cluster.",
+ "description": "Sends a health report on a Service Fabric cluster. The report must contain the information about the source of the health report and property on which it is reported.\nThe report is sent to a Service Fabric gateway node, which forwards to the health store.\nThe report may be accepted by the gateway, but rejected by the health store after extra validation.\nFor example, the health store may reject the report because of an invalid parameter, like a stale sequence number.\nTo see whether the report was applied in the health store, run GetClusterHealth and check that the report appears in the HealthEvents section.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/HealthInformationRequiredBodyParam"
+ },
+ {
+ "$ref": "#/parameters/ImmediateOptionalQueryParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "tags": [
+ "Cluster"
+ ],
+ "responses": {
+ "200": {
+ "description": "A successful operation will return 200 status code when the cluster health report is accepted for processing."
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/$/GetProvisionedCodeVersions": {
+ "get": {
+ "operationId": "GetProvisionedFabricCodeVersionInfoList",
+ "summary": "Gets a list of fabric code versions that are provisioned in a Service Fabric cluster.",
+ "description": "Gets a list of information about fabric code versions that are provisioned in the cluster. The parameter CodeVersion can be used to optionally filter the output to only that particular version.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/CodeVersionOptionalQueryParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "tags": [
+ "Cluster"
+ ],
+ "responses": {
+ "200": {
+ "description": "A successful operation will return 200 status code and the requested provisioned code versions information.",
+ "schema": {
+ "$ref": "#/definitions/FabricCodeVersionInfoList"
+ }
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/$/GetProvisionedConfigVersions": {
+ "get": {
+ "operationId": "GetProvisionedFabricConfigVersionInfoList",
+ "summary": "Gets a list of fabric config versions that are provisioned in a Service Fabric cluster.",
+ "description": "Gets a list of information about fabric config versions that are provisioned in the cluster. The parameter ConfigVersion can be used to optionally filter the output to only that particular version.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/ConfigVersionOptionalQueryParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "tags": [
+ "Cluster"
+ ],
+ "responses": {
+ "200": {
+ "description": "A successful operation will return 200 status code and the requested provisioned config versions information.",
+ "schema": {
+ "$ref": "#/definitions/FabricConfigVersionInfoList"
+ }
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/$/GetUpgradeProgress": {
+ "get": {
+ "operationId": "GetClusterUpgradeProgress",
+ "summary": "Gets the progress of the current cluster upgrade.",
+ "description": "Gets the current progress of the ongoing cluster upgrade. If no upgrade is currently in progress, get the last state of the previous cluster upgrade.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "tags": [
+ "Cluster"
+ ],
+ "responses": {
+ "200": {
+ "description": "A successful operation will return 200 status code and the requested cluster upgrade progress.",
+ "schema": {
+ "$ref": "#/definitions/ClusterUpgradeProgressObject"
+ }
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/$/GetClusterConfiguration": {
+ "get": {
+ "operationId": "GetClusterConfiguration",
+ "summary": "Get the Service Fabric standalone cluster configuration.",
+ "description": "The cluster configuration contains properties of the cluster that include different node types on the cluster,\nsecurity configurations, fault, and upgrade domain topologies, etc.",
+ "tags": [
+ "Cluster"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/ConfigurationApiVersionRequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "A successful operation will return 200 status code and the requested cluster configuration information.",
+ "schema": {
+ "$ref": "#/definitions/ClusterConfiguration"
+ }
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/$/GetClusterConfigurationUpgradeStatus": {
+ "get": {
+ "operationId": "GetClusterConfigurationUpgradeStatus",
+ "summary": "Get the cluster configuration upgrade status of a Service Fabric standalone cluster.",
+ "description": "Get the cluster configuration upgrade status details of a Service Fabric standalone cluster.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "tags": [
+ "Cluster"
+ ],
+ "responses": {
+ "200": {
+ "description": "A successful operation will return 200 status code and the requested cluster configuration upgrade status.",
+ "schema": {
+ "$ref": "#/definitions/ClusterConfigurationUpgradeStatusInfo"
+ }
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/$/GetUpgradeOrchestrationServiceState": {
+ "get": {
+ "operationId": "GetUpgradeOrchestrationServiceState",
+ "summary": "Get the service state of Service Fabric Upgrade Orchestration Service.",
+ "description": "Get the service state of Service Fabric Upgrade Orchestration Service. This API is internally used for support purposes.",
+ "tags": [
+ "Cluster"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "A successful operation will return 200 status code and the requested service state of Service Fabric Upgrade Orchestration Service.",
+ "schema": {
+ "$ref": "#/definitions/UpgradeOrchestrationServiceState"
+ }
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/$/SetUpgradeOrchestrationServiceState": {
+ "post": {
+ "operationId": "SetUpgradeOrchestrationServiceState",
+ "summary": "Update the service state of Service Fabric Upgrade Orchestration Service.",
+ "description": "Update the service state of Service Fabric Upgrade Orchestration Service. This API is internally used for support purposes.",
+ "tags": [
+ "Cluster"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/UpgradeOrchestrationServiceStateRequiredBodyParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "A successful response means that the service state of Service Fabric Upgrade Orchestration Service has been updated.",
+ "schema": {
+ "$ref": "#/definitions/UpgradeOrchestrationServiceStateSummary"
+ }
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/$/Provision": {
+ "post": {
+ "summary": "Provision the code or configuration packages of a Service Fabric cluster.",
+ "description": "Validate and provision the code or configuration packages of a Service Fabric cluster.",
+ "operationId": "ProvisionCluster",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/ProvisionFabricDescriptionRequiredBodyParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "tags": [
+ "Cluster"
+ ],
+ "responses": {
+ "200": {
+ "description": "A successful response means that the code or configuration packages have been provisioned."
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/$/Unprovision": {
+ "post": {
+ "summary": "Unprovision the code or configuration packages of a Service Fabric cluster.",
+ "description": "It is supported to unprovision code and configuration separately.",
+ "operationId": "UnprovisionCluster",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/UnprovisionFabricDescriptionRequiredBodyParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "tags": [
+ "Cluster"
+ ],
+ "responses": {
+ "200": {
+ "description": "A successful response means that the code or configuration packages have been unprovisioned."
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/$/RollbackUpgrade": {
+ "post": {
+ "summary": "Roll back the upgrade of a Service Fabric cluster.",
+ "description": "Roll back the code or configuration upgrade of a Service Fabric cluster.",
+ "operationId": "RollbackClusterUpgrade",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "tags": [
+ "Cluster"
+ ],
+ "responses": {
+ "202": {
+ "description": "A successful response means that the rollback of a cluster upgrade has been initiated."
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/$/MoveToNextUpgradeDomain": {
+ "post": {
+ "summary": "Make the cluster upgrade move on to the next upgrade domain.",
+ "description": "Make the cluster code or configuration upgrade move on to the next upgrade domain if appropriate.",
+ "operationId": "ResumeClusterUpgrade",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/ResumeClusterUpgradeDescriptionRequiredBodyParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "tags": [
+ "Cluster"
+ ],
+ "responses": {
+ "200": {
+ "description": "A successful response means that the cluster upgrade has moved on to the next upgrade domain."
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/$/Upgrade": {
+ "post": {
+ "summary": "Start upgrading the code or configuration version of a Service Fabric cluster.",
+ "description": "Validate the supplied upgrade parameters and start upgrading the code or configuration version of a Service Fabric cluster if the parameters are valid.",
+ "operationId": "StartClusterUpgrade",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/StartClusterUpgradeDescriptionRequiredBodyParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "tags": [
+ "Cluster"
+ ],
+ "responses": {
+ "202": {
+ "description": "A successful response means that the cluster code or configuration upgrade has started. Use GetUpgradeProgress operation to get the status of the upgrade."
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/$/StartClusterConfigurationUpgrade": {
+ "post": {
+ "summary": "Start upgrading the configuration of a Service Fabric standalone cluster.",
+ "description": "Validate the supplied configuration upgrade parameters and start upgrading the cluster configuration if the parameters are valid.",
+ "operationId": "StartClusterConfigurationUpgrade",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/ClusterConfigurationUpgradeDescriptionRequiredBodyParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "tags": [
+ "Cluster"
+ ],
+ "x-ms-examples": {
+ "Start upgrading the configuration of a Service Fabric standalone cluster": {
+ "$ref": "./examples/StartClusterConfigurationUpgrade-1.json"
+ }
+ },
+ "responses": {
+ "202": {
+ "description": "A successful response means that the cluster configuration upgrade has started. Use GetClusterConfigurationUpgradeStatus operation to get the status of the upgrade."
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/$/UpdateUpgrade": {
+ "post": {
+ "operationId": "UpdateClusterUpgrade",
+ "summary": "Update the upgrade parameters of a Service Fabric cluster upgrade.",
+ "description": "Update the upgrade parameters used during a Service Fabric cluster upgrade.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/UpdateClusterUpgradeDescriptionRequiredBodyParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "tags": [
+ "Cluster"
+ ],
+ "responses": {
+ "200": {
+ "description": "A successful operation returns 200 status code."
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/$/GetAadMetadata": {
+ "get": {
+ "operationId": "GetAadMetadata",
+ "summary": "Gets the Azure Active Directory metadata used for secured connection to cluster.",
+ "description": "Gets the Azure Active Directory metadata used for secured connection to cluster.\nThis API is not supposed to be called separately. It provides information needed to set up an Azure Active Directory secured connection with a Service Fabric cluster.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "schemes": [
+ "https"
+ ],
+ "tags": [
+ "Cluster"
+ ],
+ "responses": {
+ "200": {
+ "description": "A successful operation will return 200 status code and the Azure Active Directory metadata.",
+ "schema": {
+ "$ref": "#/definitions/AadMetadataObject"
+ }
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/$/GetClusterVersion": {
+ "get": {
+ "operationId": "GetClusterVersion",
+ "summary": "Get the current Service Fabric cluster version.",
+ "description": "If a cluster upgrade is happening, then this API will return the lowest (older) version of the current and target cluster runtime versions.",
+ "tags": [
+ "Cluster"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-4_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "x-ms-examples": {
+ "Get cluster version": {
+ "$ref": "./examples/GetClusterVersion-1.json"
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "A successful operation will return 200 status code and the requested cluster version information.",
+ "schema": {
+ "$ref": "#/definitions/ClusterVersion"
+ }
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/$/GetLoadInformation": {
+ "get": {
+ "operationId": "GetClusterLoad",
+ "summary": "Gets the load of a Service Fabric cluster.",
+ "description": "Retrieves the load information of a Service Fabric cluster for all the metrics that have load or capacity defined.",
+ "tags": [
+ "Cluster"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "A successful operation will return 200 status code and the requested cluster load information.",
+ "schema": {
+ "$ref": "#/definitions/ClusterLoadInfo"
+ }
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/$/ToggleVerboseServicePlacementHealthReporting": {
+ "post": {
+ "operationId": "ToggleVerboseServicePlacementHealthReporting",
+ "summary": "Changes the verbosity of service placement health reporting.",
+ "description": "If verbosity is set to true, then detailed health reports will be generated when replicas cannot be placed or dropped.\nIf verbosity is set to false, then no health reports will be generated when replicas cannot be placed or dropped.",
+ "tags": [
+ "Cluster"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-4_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/VerboseServicePlacementHealthReportingParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "A successful response means that the verbosity of service placement health reporting was updated."
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/Nodes": {
+ "get": {
+ "summary": "Gets the list of nodes in the Service Fabric cluster.",
+ "description": "The response includes the name, status, ID, health, uptime, and other details about the nodes.",
+ "operationId": "GetNodeInfoList",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-3_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/ContinuationTokenOptionalQueryParam"
+ },
+ {
+ "$ref": "#/parameters/NodeStatusFilterOptionalQueryParam"
+ },
+ {
+ "$ref": "#/parameters/MaxResultsOptionalQueryParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "tags": [
+ "Node"
+ ],
+ "x-ms-examples": {
+ "Get information about all nodes": {
+ "$ref": "./examples/GetNodeInfoList.json"
+ },
+ "Limit maximum results": {
+ "$ref": "./examples/GetNodeInfoList-1.json"
+ },
+ "Page using continuation token": {
+ "$ref": "./examples/GetNodeInfoList-2.json"
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "List of nodes in the cluster.",
+ "schema": {
+ "$ref": "#/definitions/PagedNodeInfoList"
+ }
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/Nodes/{nodeName}": {
+ "get": {
+ "summary": "Gets the information about a specific node in the Service Fabric cluster.",
+ "description": "The response includes the name, status, ID, health, uptime, and other details about the node.",
+ "operationId": "GetNodeInfo",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/NodeNameRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "tags": [
+ "Node"
+ ],
+ "x-ms-examples": {
+ "Get a specific node by node name": {
+ "$ref": "./examples/GetNodeInfo-1.json"
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "A successful operation will return information about the node with the specified nodeName.",
+ "schema": {
+ "$ref": "#/definitions/NodeInfo"
+ }
+ },
+ "204": {
+ "description": "An empty response is returned if the specified nodeName is not found."
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/Nodes/{nodeName}/$/GetHealth": {
+ "get": {
+ "operationId": "GetNodeHealth",
+ "summary": "Gets the health of a Service Fabric node.",
+ "description": "Gets the health of a Service Fabric node. Use EventsHealthStateFilter to filter the collection of health events reported on the node based on the health state. If the node that you specify by name does not exist in the health store, this returns an error.",
+ "tags": [
+ "Node"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/NodeNameRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/EventsHealthStateFilterOptionalQueryParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "A successful operation will return 200 status code and the requested node health information.",
+ "schema": {
+ "$ref": "#/definitions/NodeHealth"
+ }
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ },
+ "post": {
+ "operationId": "GetNodeHealthUsingPolicy",
+ "summary": "Gets the health of a Service Fabric node, by using the specified health policy.",
+ "description": "Gets the health of a Service Fabric node. Use EventsHealthStateFilter to filter the collection of health events reported on the node based on the health state. Use ClusterHealthPolicy in the POST body to override the health policies used to evaluate the health. If the node that you specify by name does not exist in the health store, this returns an error.",
+ "tags": [
+ "Node"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/NodeNameRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/EventsHealthStateFilterOptionalQueryParam"
+ },
+ {
+ "$ref": "#/parameters/ClusterHealthPolicyOptionalBodyParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "A successful operation will return 200 status code and the requested node health information.",
+ "schema": {
+ "$ref": "#/definitions/NodeHealth"
+ }
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/Nodes/{nodeName}/$/ReportHealth": {
+ "post": {
+ "operationId": "ReportNodeHealth",
+ "summary": "Sends a health report on the Service Fabric node.",
+ "description": "Reports health state of the specified Service Fabric node. The report must contain the information about the source of the health report and property on which it is reported.\nThe report is sent to a Service Fabric gateway node, which forwards to the health store.\nThe report may be accepted by the gateway, but rejected by the health store after extra validation.\nFor example, the health store may reject the report because of an invalid parameter, like a stale sequence number.\nTo see whether the report was applied in the health store, run GetNodeHealth and check that the report appears in the HealthEvents section.",
+ "tags": [
+ "Node"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/NodeNameRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/HealthInformationRequiredBodyParam"
+ },
+ {
+ "$ref": "#/parameters/ImmediateOptionalQueryParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "A successful operation will return 200 status code."
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/Nodes/{nodeName}/$/GetLoadInformation": {
+ "get": {
+ "operationId": "GetNodeLoadInfo",
+ "summary": "Gets the load information of a Service Fabric node.",
+ "description": "Retrieves the load information of a Service Fabric node for all the metrics that have load or capacity defined.",
+ "tags": [
+ "Node"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/NodeNameRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "A successful operation will return 200 status code and the requested node load information.",
+ "schema": {
+ "$ref": "#/definitions/NodeLoadInfo"
+ }
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/Nodes/{nodeName}/$/Deactivate": {
+ "post": {
+ "operationId": "DisableNode",
+ "summary": "Deactivate a Service Fabric cluster node with the specified deactivation intent.",
+ "description": "Deactivate a Service Fabric cluster node with the specified deactivation intent. Once the deactivation is in progress, the deactivation intent can be increased, but not decreased (for example, a node that is deactivated with the Pause intent can be deactivated further with Restart, but not the other way around. Nodes may be reactivated using the Activate a node operation any time after they are deactivated. If the deactivation is not complete, this will cancel the deactivation. A node that goes down and comes back up while deactivated will still need to be reactivated before services will be placed on that node.",
+ "tags": [
+ "Node"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/NodeNameRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/DeactivationIntentDescriptionRequiredBodyParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "A successful operation will return 200 status code."
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/Nodes/{nodeName}/$/Activate": {
+ "post": {
+ "operationId": "EnableNode",
+ "summary": "Activate a Service Fabric cluster node that is currently deactivated.",
+ "description": "Activates a Service Fabric cluster node that is currently deactivated. Once activated, the node will again become a viable target for placing new replicas, and any deactivated replicas remaining on the node will be reactivated.",
+ "tags": [
+ "Node"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/NodeNameRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "A successful operation will return 200 status code."
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/Nodes/{nodeName}/$/RemoveNodeState": {
+ "post": {
+ "operationId": "RemoveNodeState",
+ "summary": "Notifies Service Fabric that the persisted state on a node has been permanently removed or lost.",
+ "description": "This implies that it is not possible to recover the persisted state of that node. This generally happens if a hard disk has been wiped clean, or if a hard disk crashes. The node has to be down for this operation to be successful. This operation lets Service Fabric know that the replicas on that node no longer exist, and that Service Fabric should stop waiting for those replicas to come back up. Do not run this cmdlet if the state on the node has not been removed and the node can come back up with its state intact. Starting from Service Fabric 6.5, in order to use this API for seed nodes, please change the seed nodes to regular (non-seed) nodes and then invoke this API to remove the node state. If the cluster is running on Azure, after the seed node goes down, Service Fabric will try to change it to a non-seed node automatically. To make this happen, make sure the number of non-seed nodes in the primary node type is no less than the number of Down seed nodes. If necessary, add more nodes to the primary node type to achieve this. For standalone cluster, if the Down seed node is not expected to come back up with its state intact, please remove the node from the cluster, see https://docs.microsoft.com/azure/service-fabric/service-fabric-cluster-windows-server-add-remove-nodes",
+ "tags": [
+ "Node"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/NodeNameRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "A successful operation will return 200 status code."
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/Nodes/{nodeName}/$/Restart": {
+ "post": {
+ "operationId": "RestartNode",
+ "summary": "Restarts a Service Fabric cluster node.",
+ "description": "Restarts a Service Fabric cluster node that is already started.",
+ "tags": [
+ "Node"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/NodeNameRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/RestartNodeDescriptionRequiredBodyParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "A successful operation will return 200 status code. A successful operation means that the restart command was received by the node and it is in the process of restarting. Check the status of the node by calling GetNode operation."
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/Nodes/{nodeName}/$/RemoveConfigurationOverrides": {
+ "delete": {
+ "operationId": "RemoveConfigurationOverrides",
+ "summary": "Removes configuration overrides on the specified node.",
+ "description": "This api allows removing all existing configuration overrides on specified node.",
+ "tags": [
+ "Node"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_7-0_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/NodeNameRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "A successful operation will return 200 status code."
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/Nodes/{nodeName}/$/GetConfigurationOverrides": {
+ "get": {
+ "operationId": "GetConfigurationOverrides",
+ "summary": "Gets the list of configuration overrides on the specified node.",
+ "description": "This api allows getting all existing configuration overrides on the specified node.",
+ "tags": [
+ "Node"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_7-0_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/NodeNameRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "List of configuration overrides on the node.",
+ "schema": {
+ "$ref": "#/definitions/ConfigParameterOverrideList"
+ }
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/Nodes/{nodeName}/$/AddConfigurationParameterOverrides": {
+ "post": {
+ "operationId": "AddConfigurationParameterOverrides",
+ "summary": "Adds the list of configuration overrides on the specified node.",
+ "description": "This api allows adding all existing configuration overrides on the specified node.",
+ "tags": [
+ "Node"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_7-0_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/NodeNameRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/ConfigurationOverrideListRequiredParam"
+ },
+ {
+ "$ref": "#/parameters/ForceConfigurationOverrideOptionalParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "A successful operation will return 200 status code."
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/ApplicationTypes": {
+ "get": {
+ "summary": "Gets the list of application types in the Service Fabric cluster.",
+ "description": "Returns the information about the application types that are provisioned or in the process of being provisioned in the Service Fabric cluster. Each version of an application type is returned as one application type. The response includes the name, version, status, and other details about the application type. This is a paged query, meaning that if not all of the application types fit in a page, one page of results is returned as well as a continuation token, which can be used to get the next page. For example, if there are 10 application types but a page only fits the first three application types, or if max results is set to 3, then three is returned. To access the rest of the results, retrieve subsequent pages by using the returned continuation token in the next query. An empty continuation token is returned if there are no subsequent pages.",
+ "operationId": "GetApplicationTypeInfoList",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/ApplicationTypeDefinitionKindFilterOptionalQueryParam"
+ },
+ {
+ "$ref": "#/parameters/ExcludeApplicationParametersOptionalQueryParam"
+ },
+ {
+ "$ref": "#/parameters/ContinuationTokenOptionalQueryParam"
+ },
+ {
+ "$ref": "#/parameters/MaxResultsOptionalQueryParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "x-ms-examples": {
+ "Limit maximum results": {
+ "$ref": "./examples/GetApplicationTypeInfoList-1.json"
+ },
+ "Page using continuation token": {
+ "$ref": "./examples/GetApplicationTypeInfoList-2.json"
+ },
+ "Exclude application parameters from the result": {
+ "$ref": "./examples/GetApplicationTypeInfoList-3.json"
+ }
+ },
+ "tags": [
+ "ApplicationType"
+ ],
+ "responses": {
+ "200": {
+ "description": "List of application types in the cluster.",
+ "schema": {
+ "$ref": "#/definitions/PagedApplicationTypeInfoList"
+ }
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/ApplicationTypes/{applicationTypeName}": {
+ "get": {
+ "summary": "Gets the list of application types in the Service Fabric cluster matching exactly the specified name.",
+ "description": "Returns the information about the application types that are provisioned or in the process of being provisioned in the Service Fabric cluster. These results are of application types whose name match exactly the one specified as the parameter, and which comply with the given query parameters. All versions of the application type matching the application type name are returned, with each version returned as one application type. The response includes the name, version, status, and other details about the application type. This is a paged query, meaning that if not all of the application types fit in a page, one page of results is returned as well as a continuation token, which can be used to get the next page. For example, if there are 10 application types but a page only fits the first three application types, or if max results is set to 3, then three is returned. To access the rest of the results, retrieve subsequent pages by using the returned continuation token in the next query. An empty continuation token is returned if there are no subsequent pages.",
+ "operationId": "GetApplicationTypeInfoListByName",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/ApplicationTypeNameRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/ApplicationTypeVersionOptionalQueryParam"
+ },
+ {
+ "$ref": "#/parameters/ExcludeApplicationParametersOptionalQueryParam"
+ },
+ {
+ "$ref": "#/parameters/ContinuationTokenOptionalQueryParam"
+ },
+ {
+ "$ref": "#/parameters/MaxResultsOptionalQueryParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "tags": [
+ "ApplicationType"
+ ],
+ "responses": {
+ "200": {
+ "description": "List of application types in the cluster.",
+ "schema": {
+ "$ref": "#/definitions/PagedApplicationTypeInfoList"
+ }
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/ApplicationTypes/$/Provision": {
+ "post": {
+ "operationId": "ProvisionApplicationType",
+ "summary": "Provisions or registers a Service Fabric application type with the cluster using the '.sfpkg' package in the external store or using the application package in the image store.",
+ "description": "Provisions a Service Fabric application type with the cluster. The provision is required before any new applications can be instantiated.\nThe provision operation can be performed either on the application package specified by the relativePathInImageStore, or by using the URI of the external '.sfpkg'.",
+ "tags": [
+ "ApplicationType"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-2_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/ProvisionApplicationTypeDescriptionBaseRequiredBodyParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "A successful provision will return 200 status code."
+ },
+ "202": {
+ "description": "A 202 status code indicates the operation was accepted and the provision operation has been initiated."
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/ApplicationTypes/{applicationTypeName}/$/Unprovision": {
+ "post": {
+ "operationId": "UnprovisionApplicationType",
+ "summary": "Removes or unregisters a Service Fabric application type from the cluster.",
+ "description": "This operation can only be performed if all application instances of the application type have been deleted. Once the application type is unregistered, no new application instances can be created for this particular application type.",
+ "tags": [
+ "ApplicationType"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/ApplicationTypeNameRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/UnprovisionApplicationTypeRequiredBodyParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "A successful provision will return 200 status code."
+ },
+ "202": {
+ "description": "A 202 status code indicates the operation was accepted."
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/ApplicationTypes/{applicationTypeName}/$/GetServiceTypes": {
+ "get": {
+ "summary": "Gets the list containing the information about service types that are supported by a provisioned application type in a Service Fabric cluster.",
+ "description": "Gets the list containing the information about service types that are supported by a provisioned application type in a Service Fabric cluster. The provided application type must exist. Otherwise, a 404 status is returned.",
+ "operationId": "GetServiceTypeInfoList",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/ApplicationTypeNameRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/ApplicationTypeVersionRequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "tags": [
+ "ServiceType"
+ ],
+ "x-ms-examples": {
+ "Get information about all nodes.": {
+ "$ref": "./examples/GetServiceTypeInfoList-1.json"
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "List of service types that are supported by a provisioned application type.",
+ "schema": {
+ "$ref": "#/definitions/ServiceTypeInfoList"
+ }
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/ApplicationTypes/{applicationTypeName}/$/GetServiceTypes/{serviceTypeName}": {
+ "get": {
+ "summary": "Gets the information about a specific service type that is supported by a provisioned application type in a Service Fabric cluster.",
+ "description": "Gets the information about a specific service type that is supported by a provisioned application type in a Service Fabric cluster. The provided application type must exist. Otherwise, a 404 status is returned. A 204 response is returned if the specified service type is not found in the cluster.",
+ "operationId": "GetServiceTypeInfoByName",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/ApplicationTypeNameRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/ApplicationTypeVersionRequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/ServiceTypeNameRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "tags": [
+ "ServiceType"
+ ],
+ "x-ms-examples": {
+ "Get information about all nodes.": {
+ "$ref": "./examples/GetServiceTypeInfoByName-1.json"
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "A specific service type which supported by a provisioned application type.",
+ "schema": {
+ "$ref": "#/definitions/ServiceTypeInfo"
+ }
+ },
+ "204": {
+ "description": "A 204 response is returned if the specified service type is not found in the cluster."
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/ApplicationTypes/{applicationTypeName}/$/GetServiceManifest": {
+ "get": {
+ "summary": "Gets the manifest describing a service type.",
+ "description": "Gets the manifest describing a service type. The response contains the service manifest XML as a string.",
+ "operationId": "GetServiceManifest",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/ApplicationTypeNameRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/ApplicationTypeVersionRequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/ServiceManifestNameRequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "tags": [
+ "ServiceType"
+ ],
+ "responses": {
+ "200": {
+ "description": "Information about the service type.",
+ "schema": {
+ "$ref": "#/definitions/ServiceTypeManifest"
+ }
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/Nodes/{nodeName}/$/GetApplications/{applicationId}/$/GetServiceTypes": {
+ "get": {
+ "summary": "Gets the list containing the information about service types from the applications deployed on a node in a Service Fabric cluster.",
+ "description": "Gets the list containing the information about service types from the applications deployed on a node in a Service Fabric cluster. The response includes the name of the service type, its registration status, the code package that registered it and activation ID of the service package.",
+ "operationId": "GetDeployedServiceTypeInfoList",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/NodeNameRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/ApplicationIdRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/DeployedServiceType_ServiceManifestNameOptionalQueryParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "tags": [
+ "ServiceType"
+ ],
+ "responses": {
+ "200": {
+ "description": "List of information about service types of an application deployed on a node.",
+ "schema": {
+ "$ref": "#/definitions/DeployedServiceTypeInfoList"
+ }
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/Nodes/{nodeName}/$/GetApplications/{applicationId}/$/GetServiceTypes/{serviceTypeName}": {
+ "get": {
+ "summary": "Gets the information about a specified service type of the application deployed on a node in a Service Fabric cluster.",
+ "description": "Gets the list containing the information about a specific service type from the applications deployed on a node in a Service Fabric cluster. The response includes the name of the service type, its registration status, the code package that registered it and activation ID of the service package. Each entry represents one activation of a service type, differentiated by the activation ID.",
+ "operationId": "GetDeployedServiceTypeInfoByName",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/NodeNameRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/ApplicationIdRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/ServiceTypeNameRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/DeployedServiceType_ServiceManifestNameOptionalQueryParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "tags": [
+ "ServiceType"
+ ],
+ "responses": {
+ "200": {
+ "description": "Information about service types of an application deployed on a node.",
+ "schema": {
+ "$ref": "#/definitions/DeployedServiceTypeInfoList"
+ }
+ },
+ "204": {
+ "description": "An empty response is returned if the specified service type of the application is not deployed on the node."
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/Applications/$/Create": {
+ "post": {
+ "summary": "Creates a Service Fabric application.",
+ "description": "Creates a Service Fabric application using the specified description.",
+ "operationId": "CreateApplication",
+ "x-ms-examples": {
+ "Create application.": {
+ "$ref": "./examples/CreateApplication-1.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/ApplicationDescriptionRequiredBodyParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "tags": [
+ "Application"
+ ],
+ "responses": {
+ "201": {
+ "description": "A successful response means that the application creation has been started. Use GetApplication operation to get the status of the application. Once GetApplicationInfo successfully returns application information, the application is created. If the application has default services those may be in the process of being created. Use GetServiceInfo operation to get the status of the service within the application."
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/Applications/{applicationId}/$/Delete": {
+ "post": {
+ "summary": "Deletes an existing Service Fabric application.",
+ "description": "An application must be created before it can be deleted. Deleting an application will delete all services that are part of that application. By default, Service Fabric will try to close service replicas in a graceful manner and then delete the service. However, if a service is having issues closing the replica gracefully, the delete operation may take a long time or get stuck. Use the optional ForceRemove flag to skip the graceful close sequence and forcefully delete the application and all of its services.",
+ "operationId": "DeleteApplication",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/ApplicationIdRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/ForceRemoveOptionalQueryParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "tags": [
+ "Application"
+ ],
+ "responses": {
+ "200": {
+ "description": "A successful operation will return 200 status code."
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/Applications/{applicationId}/$/GetLoadInformation": {
+ "get": {
+ "summary": "Gets load information about a Service Fabric application.",
+ "description": "Returns the load information about the application that was created or in the process of being created in the Service Fabric cluster and whose name matches the one specified as the parameter. The response includes the name, minimum nodes, maximum nodes, the number of nodes the application is occupying currently, and application load metric information about the application.",
+ "operationId": "GetApplicationLoadInfo",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/ApplicationIdRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "tags": [
+ "Application"
+ ],
+ "responses": {
+ "200": {
+ "description": "Information about the application load.",
+ "schema": {
+ "$ref": "#/definitions/ApplicationLoadInfo"
+ }
+ },
+ "204": {
+ "description": "An empty response is returned if the specified applicationId is not found in the cluster."
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/Applications": {
+ "get": {
+ "summary": "Gets the list of applications created in the Service Fabric cluster that match the specified filters.",
+ "description": "Gets the information about the applications that were created or in the process of being created in the Service Fabric cluster and match the specified filters. The response includes the name, type, status, parameters, and other details about the application. If the applications do not fit in a page, one page of results is returned as well as a continuation token, which can be used to get the next page. Filters ApplicationTypeName and ApplicationDefinitionKindFilter cannot be specified at the same time.",
+ "operationId": "GetApplicationInfoList",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-1_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/ApplicationDefinitionKindFilterOptionalQueryParam"
+ },
+ {
+ "$ref": "#/parameters/ApplicationTypeNameOptionalQueryParam"
+ },
+ {
+ "$ref": "#/parameters/ExcludeApplicationParametersOptionalQueryParam"
+ },
+ {
+ "$ref": "#/parameters/ContinuationTokenOptionalQueryParam"
+ },
+ {
+ "$ref": "#/parameters/MaxResultsOptionalQueryParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "tags": [
+ "Application"
+ ],
+ "x-ms-examples": {
+ "Limit maximum results": {
+ "$ref": "./examples/GetApplicationInfoList-1.json"
+ },
+ "Page using continuation token": {
+ "$ref": "./examples/GetApplicationInfoList-2.json"
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "List of applications created in the cluster.",
+ "schema": {
+ "$ref": "#/definitions/PagedApplicationInfoList"
+ }
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/Applications/{applicationId}": {
+ "get": {
+ "summary": "Gets information about a Service Fabric application.",
+ "description": "Returns the information about the application that was created or in the process of being created in the Service Fabric cluster and whose name matches the one specified as the parameter. The response includes the name, type, status, parameters, and other details about the application.",
+ "operationId": "GetApplicationInfo",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/ApplicationIdRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/ExcludeApplicationParametersOptionalQueryParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "tags": [
+ "Application"
+ ],
+ "x-ms-examples": {
+ "Get a specific application by application id": {
+ "$ref": "./examples/GetApplicationInfoByName-1.json"
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Information about the application.",
+ "schema": {
+ "$ref": "#/definitions/ApplicationInfo"
+ }
+ },
+ "204": {
+ "description": "An empty response is returned if the specified applicationId is not found in the cluster."
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/Applications/{applicationId}/$/GetHealth": {
+ "get": {
+ "summary": "Gets the health of the service fabric application.",
+ "description": "Returns the heath state of the service fabric application. The response reports either Ok, Error or Warning health state. If the entity is not found in the health store, it will return Error.",
+ "operationId": "GetApplicationHealth",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApplicationIdRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/EventsHealthStateFilterOptionalQueryParam"
+ },
+ {
+ "$ref": "#/parameters/DeployedApplicationsHealthStateFilterOptionalQueryParam"
+ },
+ {
+ "$ref": "#/parameters/ServicesHealthStateFilterOptionalQueryParam"
+ },
+ {
+ "$ref": "#/parameters/ExcludeHealthStatisticsOptionalQueryParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "tags": [
+ "Application"
+ ],
+ "responses": {
+ "200": {
+ "description": "A successful operation will return 200 status code and the requested application health information.",
+ "schema": {
+ "$ref": "#/definitions/ApplicationHealth"
+ }
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ },
+ "post": {
+ "operationId": "GetApplicationHealthUsingPolicy",
+ "summary": "Gets the health of a Service Fabric application using the specified policy.",
+ "description": "Gets the health of a Service Fabric application. Use EventsHealthStateFilter to filter the collection of health events reported on the node based on the health state. Use ClusterHealthPolicies to override the health policies used to evaluate the health.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApplicationIdRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/EventsHealthStateFilterOptionalQueryParam"
+ },
+ {
+ "$ref": "#/parameters/DeployedApplicationsHealthStateFilterOptionalQueryParam"
+ },
+ {
+ "$ref": "#/parameters/ServicesHealthStateFilterOptionalQueryParam"
+ },
+ {
+ "$ref": "#/parameters/ExcludeHealthStatisticsOptionalQueryParam"
+ },
+ {
+ "$ref": "#/parameters/ApplicationHealthPolicyOptionalBodyParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "tags": [
+ "Application"
+ ],
+ "responses": {
+ "200": {
+ "description": "A successful operation will return 200 status code and the requested node health information.",
+ "schema": {
+ "$ref": "#/definitions/ApplicationHealth"
+ }
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/Applications/{applicationId}/$/ReportHealth": {
+ "post": {
+ "operationId": "ReportApplicationHealth",
+ "summary": "Sends a health report on the Service Fabric application.",
+ "description": "Reports health state of the specified Service Fabric application. The report must contain the information about the source of the health report and property on which it is reported.\nThe report is sent to a Service Fabric gateway Application, which forwards to the health store.\nThe report may be accepted by the gateway, but rejected by the health store after extra validation.\nFor example, the health store may reject the report because of an invalid parameter, like a stale sequence number.\nTo see whether the report was applied in the health store, get application health and check that the report appears in the HealthEvents section.",
+ "tags": [
+ "Application"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/ApplicationIdRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/HealthInformationRequiredBodyParam"
+ },
+ {
+ "$ref": "#/parameters/ImmediateOptionalQueryParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "A successful operation will return 200 status code."
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/Applications/{applicationId}/$/Upgrade": {
+ "post": {
+ "summary": "Starts upgrading an application in the Service Fabric cluster.",
+ "description": "Validates the supplied application upgrade parameters and starts upgrading the application if the parameters are valid.",
+ "operationId": "StartApplicationUpgrade",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/ApplicationIdRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/ApplicationUpgradeDescriptionRequiredBodyParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "tags": [
+ "Application"
+ ],
+ "responses": {
+ "200": {
+ "description": "A successful response means that the application upgrade has started. Use GetApplicationUpgrade operation to get the status of the upgrade."
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/Applications/{applicationId}/$/GetUpgradeProgress": {
+ "get": {
+ "summary": "Gets details for the latest upgrade performed on this application.",
+ "description": "Returns information about the state of the latest application upgrade along with details to aid debugging application health issues.",
+ "operationId": "GetApplicationUpgrade",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/ApplicationIdRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "tags": [
+ "Application"
+ ],
+ "responses": {
+ "200": {
+ "description": "The application upgrade details.",
+ "schema": {
+ "$ref": "#/definitions/ApplicationUpgradeProgressInfo"
+ }
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/Applications/{applicationId}/$/UpdateUpgrade": {
+ "post": {
+ "summary": "Updates an ongoing application upgrade in the Service Fabric cluster.",
+ "description": "Updates the parameters of an ongoing application upgrade from the ones specified at the time of starting the application upgrade. This may be required to mitigate stuck application upgrades due to incorrect parameters or issues in the application to make progress.",
+ "operationId": "UpdateApplicationUpgrade",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/ApplicationIdRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/ApplicationUpgradeUpdateDescriptionRequiredBodyParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "tags": [
+ "Application"
+ ],
+ "responses": {
+ "200": {
+ "description": "A successful response means that the application upgrade has updated with the specified parameters. Use GetApplicationUpgrade operation to get the status of the upgrade."
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/Applications/{applicationId}/$/MoveToNextUpgradeDomain": {
+ "post": {
+ "summary": "Resumes upgrading an application in the Service Fabric cluster.",
+ "description": "Resumes an unmonitored manual Service Fabric application upgrade. Service Fabric upgrades one upgrade domain at a time. For unmonitored manual upgrades, after Service Fabric finishes an upgrade domain, it waits for you to call this API before proceeding to the next upgrade domain.",
+ "operationId": "ResumeApplicationUpgrade",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/ApplicationIdRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/ResumeApplicationUpgradeDescriptionRequiredBodyParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "tags": [
+ "Application"
+ ],
+ "responses": {
+ "200": {
+ "description": "A successful response means that the application upgrade has been resumed in the specified upgrade domain. Use GetApplicationUpgrade operation to get the status of the upgrade."
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/Applications/{applicationId}/$/RollbackUpgrade": {
+ "post": {
+ "summary": "Starts rolling back the currently on-going upgrade of an application in the Service Fabric cluster.",
+ "description": "Starts rolling back the current application upgrade to the previous version. This API can only be used to roll back the current in-progress upgrade that is rolling forward to new version. If the application is not currently being upgraded use StartApplicationUpgrade API to upgrade it to desired version, including rolling back to a previous version.",
+ "operationId": "RollbackApplicationUpgrade",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/ApplicationIdRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "tags": [
+ "Application"
+ ],
+ "responses": {
+ "200": {
+ "description": "A successful response means that the application has started to roll back. Use GetApplicationUpgrade operation to get the status of the upgrade."
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/Nodes/{nodeName}/$/GetApplications": {
+ "get": {
+ "operationId": "GetDeployedApplicationInfoList",
+ "summary": "Gets the list of applications deployed on a Service Fabric node.",
+ "description": "Gets the list of applications deployed on a Service Fabric node. The results do not include information about deployed system applications unless explicitly queried for by ID. Results encompass deployed applications in active, activating, and downloading states. This query requires that the node name corresponds to a node on the cluster. The query fails if the provided node name does not point to any active Service Fabric nodes on the cluster.",
+ "tags": [
+ "Application"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-1_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/NodeNameRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ },
+ {
+ "$ref": "#/parameters/IncludeHealthStateOptionalQueryParam"
+ },
+ {
+ "$ref": "#/parameters/ContinuationTokenOptionalQueryParam"
+ },
+ {
+ "$ref": "#/parameters/MaxResultsOptionalQueryParam"
+ }
+ ],
+ "x-ms-examples": {
+ "Limit maximum results": {
+ "$ref": "./examples/GetDeployedApplicationInfoList-1.json"
+ },
+ "Page using continuation token": {
+ "$ref": "./examples/GetDeployedApplicationInfoList-2.json"
+ },
+ "Include health state in the result": {
+ "$ref": "./examples/GetDeployedApplicationInfoList-3.json"
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "A successful operation will return 200 status code and the list of deployed application information.",
+ "schema": {
+ "$ref": "#/definitions/PagedDeployedApplicationInfoList"
+ }
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/Nodes/{nodeName}/$/GetApplications/{applicationId}": {
+ "get": {
+ "operationId": "GetDeployedApplicationInfo",
+ "summary": "Gets the information about an application deployed on a Service Fabric node.",
+ "description": "This query returns system application information if the application ID provided is for system application. Results encompass deployed applications in active, activating, and downloading states. This query requires that the node name corresponds to a node on the cluster. The query fails if the provided node name does not point to any active Service Fabric nodes on the cluster.",
+ "tags": [
+ "Application"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-1_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/NodeNameRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/ApplicationIdRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ },
+ {
+ "$ref": "#/parameters/IncludeHealthStateOptionalQueryParam"
+ }
+ ],
+ "x-ms-examples": {
+ "Get a specific deployed application by application ID and include the health state in the result": {
+ "$ref": "./examples/GetDeployedApplicationInfoByName-1.json"
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "A successful operation will return 200 status code and the information about the deployed application.",
+ "schema": {
+ "$ref": "#/definitions/DeployedApplicationInfo"
+ }
+ },
+ "204": {
+ "description": "An empty response is returned if the specified application is not deployed on the node."
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/Nodes/{nodeName}/$/GetApplications/{applicationId}/$/GetHealth": {
+ "get": {
+ "operationId": "GetDeployedApplicationHealth",
+ "summary": "Gets the information about health of an application deployed on a Service Fabric node.",
+ "description": "Gets the information about health of an application deployed on a Service Fabric node. Use EventsHealthStateFilter to optionally filter for the collection of HealthEvent objects reported on the deployed application based on health state. Use DeployedServicePackagesHealthStateFilter to optionally filter for DeployedServicePackageHealth children based on health state.",
+ "tags": [
+ "Application"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/NodeNameRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/ApplicationIdRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/EventsHealthStateFilterOptionalQueryParam"
+ },
+ {
+ "$ref": "#/parameters/DeployedServicePackagesHealthStateFilterOptionalQueryParam"
+ },
+ {
+ "$ref": "#/parameters/ExcludeHealthStatisticsOptionalQueryParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "A successful operation will return 200 status code and the health information of the deployed application.",
+ "schema": {
+ "$ref": "#/definitions/DeployedApplicationHealth"
+ }
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ },
+ "post": {
+ "operationId": "GetDeployedApplicationHealthUsingPolicy",
+ "summary": "Gets the information about health of an application deployed on a Service Fabric node. using the specified policy.",
+ "description": "Gets the information about health of an application deployed on a Service Fabric node using the specified policy. Use EventsHealthStateFilter to optionally filter for the collection of HealthEvent objects reported on the deployed application based on health state. Use DeployedServicePackagesHealthStateFilter to optionally filter for DeployedServicePackageHealth children based on health state. Use ApplicationHealthPolicy to optionally override the health policies used to evaluate the health. This API only uses 'ConsiderWarningAsError' field of the ApplicationHealthPolicy. The rest of the fields are ignored while evaluating the health of the deployed application.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/NodeNameRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/ApplicationIdRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/EventsHealthStateFilterOptionalQueryParam"
+ },
+ {
+ "$ref": "#/parameters/DeployedServicePackagesHealthStateFilterOptionalQueryParam"
+ },
+ {
+ "$ref": "#/parameters/ApplicationHealthPolicyOptionalBodyParam"
+ },
+ {
+ "$ref": "#/parameters/ExcludeHealthStatisticsOptionalQueryParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "tags": [
+ "Application"
+ ],
+ "responses": {
+ "200": {
+ "description": "A successful operation will return 200 status code and the health information of the deployed application.",
+ "schema": {
+ "$ref": "#/definitions/DeployedApplicationHealth"
+ }
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/Nodes/{nodeName}/$/GetApplications/{applicationId}/$/ReportHealth": {
+ "post": {
+ "operationId": "ReportDeployedApplicationHealth",
+ "summary": "Sends a health report on the Service Fabric application deployed on a Service Fabric node.",
+ "description": "Reports health state of the application deployed on a Service Fabric node. The report must contain the information about the source of the health report and property on which it is reported.\nThe report is sent to a Service Fabric gateway Service, which forwards to the health store.\nThe report may be accepted by the gateway, but rejected by the health store after extra validation.\nFor example, the health store may reject the report because of an invalid parameter, like a stale sequence number.\nTo see whether the report was applied in the health store, get deployed application health and check that the report appears in the HealthEvents section.",
+ "tags": [
+ "Application"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/NodeNameRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/ApplicationIdRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/HealthInformationRequiredBodyParam"
+ },
+ {
+ "$ref": "#/parameters/ImmediateOptionalQueryParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "A successful operation will return 200 status code."
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/ApplicationTypes/{applicationTypeName}/$/GetApplicationManifest": {
+ "get": {
+ "summary": "Gets the manifest describing an application type.",
+ "description": "The response contains the application manifest XML as a string.",
+ "operationId": "GetApplicationManifest",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/ApplicationTypeNameRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/ApplicationTypeVersionRequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "tags": [
+ "ApplicationType"
+ ],
+ "responses": {
+ "200": {
+ "description": "Information about the node.",
+ "schema": {
+ "$ref": "#/definitions/ApplicationTypeManifest"
+ }
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/Applications/{applicationId}/$/GetServices": {
+ "get": {
+ "summary": "Gets the information about all services belonging to the application specified by the application ID.",
+ "description": "Returns the information about all services belonging to the application specified by the application ID.",
+ "operationId": "GetServiceInfoList",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApplicationIdRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/ServiceTypeNameOptionalQueryParam"
+ },
+ {
+ "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/ContinuationTokenOptionalQueryParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "tags": [
+ "Service"
+ ],
+ "responses": {
+ "200": {
+ "description": "List of services in the cluster for the specified application.",
+ "schema": {
+ "$ref": "#/definitions/PagedServiceInfoList"
+ }
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/Applications/{applicationId}/$/GetServices/{serviceId}": {
+ "get": {
+ "summary": "Gets the information about the specific service belonging to the Service Fabric application.",
+ "description": "Returns the information about the specified service belonging to the specified Service Fabric application.",
+ "operationId": "GetServiceInfo",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApplicationIdRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/ServiceIdRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "tags": [
+ "Service"
+ ],
+ "responses": {
+ "200": {
+ "description": "Information about the specified service.",
+ "schema": {
+ "$ref": "#/definitions/ServiceInfo"
+ }
+ },
+ "204": {
+ "description": "An empty response is returned if the specified service is not part of the specified application."
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/Services/{serviceId}/$/GetApplicationName": {
+ "get": {
+ "summary": "Gets the name of the Service Fabric application for a service.",
+ "description": "Gets the name of the application for the specified service. A 404 FABRIC_E_SERVICE_DOES_NOT_EXIST error is returned if a service with the provided service ID does not exist.",
+ "operationId": "GetApplicationNameInfo",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/ServiceIdRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "tags": [
+ "Service"
+ ],
+ "responses": {
+ "200": {
+ "description": "Information about the name of the application for the specified service.",
+ "schema": {
+ "$ref": "#/definitions/ApplicationNameInfo"
+ }
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/Applications/{applicationId}/$/GetServices/$/Create": {
+ "post": {
+ "operationId": "CreateService",
+ "summary": "Creates the specified Service Fabric service.",
+ "description": "This api allows creating a new Service Fabric stateless or stateful service under a specified Service Fabric application. The description for creating the service includes partitioning information and optional properties for placement and load balancing. Some of the properties can later be modified using `UpdateService` API.",
+ "x-ms-examples": {
+ "Basic stateless service": {
+ "$ref": "./examples/CreateService-1.json"
+ },
+ "Basic stateful service": {
+ "$ref": "./examples/CreateService-2.json"
+ },
+ "Stateless service with dns name and auto scaling": {
+ "$ref": "./examples/CreateService-3.json"
+ },
+ "Stateful service with named partitions and auto scaling": {
+ "$ref": "./examples/CreateService-4.json"
+ }
+ },
+ "tags": [
+ "Service"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/ApplicationIdRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/ServiceDescriptionRequiredBodyParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "responses": {
+ "202": {
+ "description": "A successful operation will return 202 status code."
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/Applications/{applicationId}/$/GetServices/$/CreateFromTemplate": {
+ "post": {
+ "summary": "Creates a Service Fabric service from the service template.",
+ "description": "Creates a Service Fabric service from the service template defined in the application manifest. A service template contains the properties that will be same for the service instance of the same type. The API allows overriding the properties that are usually different for different services of the same service type.",
+ "operationId": "CreateServiceFromTemplate",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/ApplicationIdRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/CreateServiceFromTemplateRequiredBodyParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "tags": [
+ "Service"
+ ],
+ "responses": {
+ "202": {
+ "description": "A successful operation will return 202 status code."
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/Services/{serviceId}/$/Delete": {
+ "post": {
+ "summary": "Deletes an existing Service Fabric service.",
+ "description": "A service must be created before it can be deleted. By default, Service Fabric will try to close service replicas in a graceful manner and then delete the service. However, if the service is having issues closing the replica gracefully, the delete operation may take a long time or get stuck. Use the optional ForceRemove flag to skip the graceful close sequence and forcefully delete the service.",
+ "operationId": "DeleteService",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/ServiceIdRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/ForceRemoveOptionalQueryParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "tags": [
+ "Service"
+ ],
+ "responses": {
+ "200": {
+ "description": "A successful operation will return 200 status code."
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/Services/{serviceId}/$/Update": {
+ "post": {
+ "operationId": "UpdateService",
+ "summary": "Updates a Service Fabric service using the specified update description.",
+ "description": "This API allows updating properties of a running Service Fabric service. The set of properties that can be updated are a subset of the properties that were specified at the time of creating the service. The current set of properties can be obtained using `GetServiceDescription` API. Note that updating the properties of a running service is different than upgrading your application using `StartApplicationUpgrade` API. The upgrade is a long running background operation that involves moving the application from one version to another, one upgrade domain at a time, whereas update applies the new properties immediately to the service.",
+ "x-ms-examples": {
+ "Stateless service": {
+ "$ref": "./examples/UpdateService-1.json"
+ },
+ "Stateful service": {
+ "$ref": "./examples/UpdateService-2.json"
+ }
+ },
+ "tags": [
+ "Service"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/ServiceIdRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/ServiceUpdateDescriptionRequiredBodyParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "A successful operation will return 202 status code."
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/Services/{serviceId}/$/GetDescription": {
+ "get": {
+ "summary": "Gets the description of an existing Service Fabric service.",
+ "description": "Gets the description of an existing Service Fabric service. A service must be created before its description can be obtained.",
+ "operationId": "GetServiceDescription",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/ServiceIdRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "tags": [
+ "Service"
+ ],
+ "responses": {
+ "200": {
+ "description": "A successful operation will return 200 status code.",
+ "schema": {
+ "$ref": "#/definitions/ServiceDescription"
+ }
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/Services/{serviceId}/$/GetHealth": {
+ "get": {
+ "summary": "Gets the health of the specified Service Fabric service.",
+ "description": "Gets the health information of the specified service.\nUse EventsHealthStateFilter to filter the collection of health events reported on the service based on the health state.\nUse PartitionsHealthStateFilter to filter the collection of partitions returned.\nIf you specify a service that does not exist in the health store, this request returns an error.",
+ "operationId": "GetServiceHealth",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/ServiceIdRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/EventsHealthStateFilterOptionalQueryParam"
+ },
+ {
+ "$ref": "#/parameters/PartitionsHealthStateFilterOptionalQueryParam"
+ },
+ {
+ "$ref": "#/parameters/ExcludeHealthStatisticsOptionalQueryParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "tags": [
+ "Service"
+ ],
+ "responses": {
+ "200": {
+ "description": "A successful operation will return 200 status code and the health information of the specified service.",
+ "schema": {
+ "$ref": "#/definitions/ServiceHealth"
+ }
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ },
+ "post": {
+ "summary": "Gets the health of the specified Service Fabric service, by using the specified health policy.",
+ "description": "Gets the health information of the specified service.\nIf the application health policy is specified, the health evaluation uses it to get the aggregated health state.\nIf the policy is not specified, the health evaluation uses the application health policy defined in the application manifest, or the default health policy, if no policy is defined in the manifest.\nUse EventsHealthStateFilter to filter the collection of health events reported on the service based on the health state.\nUse PartitionsHealthStateFilter to filter the collection of partitions returned.\nIf you specify a service that does not exist in the health store, this request returns an error.",
+ "operationId": "GetServiceHealthUsingPolicy",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/ServiceIdRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/EventsHealthStateFilterOptionalQueryParam"
+ },
+ {
+ "$ref": "#/parameters/PartitionsHealthStateFilterOptionalQueryParam"
+ },
+ {
+ "$ref": "#/parameters/ApplicationHealthPolicyOptionalBodyParam"
+ },
+ {
+ "$ref": "#/parameters/ExcludeHealthStatisticsOptionalQueryParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "tags": [
+ "Service"
+ ],
+ "responses": {
+ "200": {
+ "description": "A successful operation will return 200 status code and the health information of the specified service.",
+ "schema": {
+ "$ref": "#/definitions/ServiceHealth"
+ }
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/Services/{serviceId}/$/ReportHealth": {
+ "post": {
+ "operationId": "ReportServiceHealth",
+ "summary": "Sends a health report on the Service Fabric service.",
+ "description": "Reports health state of the specified Service Fabric service. The report must contain the information about the source of the health report and property on which it is reported.\nThe report is sent to a Service Fabric gateway Service, which forwards to the health store.\nThe report may be accepted by the gateway, but rejected by the health store after extra validation.\nFor example, the health store may reject the report because of an invalid parameter, like a stale sequence number.\nTo see whether the report was applied in the health store, run GetServiceHealth and check that the report appears in the HealthEvents section.",
+ "tags": [
+ "Service"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/ServiceIdRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/HealthInformationRequiredBodyParam"
+ },
+ {
+ "$ref": "#/parameters/ImmediateOptionalQueryParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "A successful operation will return 200 status code."
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/Services/{serviceId}/$/ResolvePartition": {
+ "get": {
+ "operationId": "ResolveService",
+ "summary": "Resolve a Service Fabric partition.",
+ "description": "Resolve a Service Fabric service partition to get the endpoints of the service replicas.",
+ "tags": [
+ "Service"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/ServiceIdRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/PartitionKeyTypeOptionalQueryParam"
+ },
+ {
+ "$ref": "#/parameters/PartitionKeyValueOptionalQueryParam"
+ },
+ {
+ "$ref": "#/parameters/PreviousRspVersionOptionalQueryParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "A successful operation will return 200 status code.",
+ "schema": {
+ "$ref": "#/definitions/ResolvedServicePartition"
+ }
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/Services/{serviceId}/$/GetUnplacedReplicaInformation": {
+ "get": {
+ "summary": "Gets the information about unplaced replica of the service.",
+ "description": "Returns the information about the unplaced replicas of the service.\nIf PartitionId is specified, then result will contain information only about unplaced replicas for that partition.\nIf PartitionId is not specified, then result will contain information about unplaced replicas for all partitions of that service.\nIf OnlyQueryPrimaries is set to true, then result will contain information only about primary replicas, and will ignore unplaced secondary replicas.",
+ "operationId": "GetUnplacedReplicaInformation",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-4_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/ServiceIdRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/PartitionIdOptionalQueryParam"
+ },
+ {
+ "$ref": "#/parameters/OnlyQueryPrimariesOptionalQueryParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "tags": [
+ "Service"
+ ],
+ "responses": {
+ "200": {
+ "description": "Information about the specified service.",
+ "schema": {
+ "$ref": "#/definitions/UnplacedReplicaInformation"
+ }
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/Services/{serviceId}/$/GetPartitions": {
+ "get": {
+ "summary": "Gets the list of partitions of a Service Fabric service.",
+ "description": "The response includes the partition ID, partitioning scheme information, keys supported by the partition, status, health, and other details about the partition.",
+ "operationId": "GetPartitionInfoList",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-4_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/ServiceIdRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/ContinuationTokenOptionalQueryParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "tags": [
+ "Partition"
+ ],
+ "responses": {
+ "200": {
+ "description": "List of partitions of a Service Fabric service.",
+ "schema": {
+ "$ref": "#/definitions/PagedServicePartitionInfoList"
+ }
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/Partitions/{partitionId}": {
+ "get": {
+ "summary": "Gets the information about a Service Fabric partition.",
+ "description": "Gets the information about the specified partition. The response includes the partition ID, partitioning scheme information, keys supported by the partition, status, health, and other details about the partition.",
+ "operationId": "GetPartitionInfo",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/PartitionIdRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "tags": [
+ "Partition"
+ ],
+ "responses": {
+ "200": {
+ "description": "Information about the specified partition.",
+ "schema": {
+ "$ref": "#/definitions/ServicePartitionInfo"
+ }
+ },
+ "204": {
+ "description": "An empty response is returned if the specified partitionId is not found in the cluster."
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/Partitions/{partitionId}/$/GetServiceName": {
+ "get": {
+ "summary": "Gets the name of the Service Fabric service for a partition.",
+ "description": "Gets name of the service for the specified partition. A 404 error is returned if the partition ID does not exist in the cluster.",
+ "operationId": "GetServiceNameInfo",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/PartitionIdRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "tags": [
+ "Partition"
+ ],
+ "responses": {
+ "200": {
+ "description": "Information about the name of the service for the specified partition.",
+ "schema": {
+ "$ref": "#/definitions/ServiceNameInfo"
+ }
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/Partitions/{partitionId}/$/GetHealth": {
+ "get": {
+ "summary": "Gets the health of the specified Service Fabric partition.",
+ "description": "Use EventsHealthStateFilter to filter the collection of health events reported on the service based on the health state.\nUse ReplicasHealthStateFilter to filter the collection of ReplicaHealthState objects on the partition.\nIf you specify a partition that does not exist in the health store, this request returns an error.",
+ "operationId": "GetPartitionHealth",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/PartitionIdRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/EventsHealthStateFilterOptionalQueryParam"
+ },
+ {
+ "$ref": "#/parameters/ReplicasHealthStateFilerOptionalQueryParam"
+ },
+ {
+ "$ref": "#/parameters/ExcludeHealthStatisticsOptionalQueryParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "tags": [
+ "Partition"
+ ],
+ "responses": {
+ "200": {
+ "description": "A successful operation will return 200 status code and the health information about the specified partition.",
+ "schema": {
+ "$ref": "#/definitions/PartitionHealth"
+ }
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ },
+ "post": {
+ "summary": "Gets the health of the specified Service Fabric partition, by using the specified health policy.",
+ "description": "Gets the health information of the specified partition.\nIf the application health policy is specified, the health evaluation uses it to get the aggregated health state.\nIf the policy is not specified, the health evaluation uses the application health policy defined in the application manifest, or the default health policy, if no policy is defined in the manifest.\nUse EventsHealthStateFilter to filter the collection of health events reported on the partition based on the health state.\nUse ReplicasHealthStateFilter to filter the collection of ReplicaHealthState objects on the partition. Use ApplicationHealthPolicy in the POST body to override the health policies used to evaluate the health.\nIf you specify a partition that does not exist in the health store, this request returns an error.",
+ "operationId": "GetPartitionHealthUsingPolicy",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/PartitionIdRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/EventsHealthStateFilterOptionalQueryParam"
+ },
+ {
+ "$ref": "#/parameters/ReplicasHealthStateFilerOptionalQueryParam"
+ },
+ {
+ "$ref": "#/parameters/ApplicationHealthPolicyOptionalBodyParam"
+ },
+ {
+ "$ref": "#/parameters/ExcludeHealthStatisticsOptionalQueryParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "tags": [
+ "Partition"
+ ],
+ "responses": {
+ "200": {
+ "description": "A successful operation will return 200 status code and the health information about the specified partition.",
+ "schema": {
+ "$ref": "#/definitions/PartitionHealth"
+ }
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/Partitions/{partitionId}/$/ReportHealth": {
+ "post": {
+ "operationId": "ReportPartitionHealth",
+ "summary": "Sends a health report on the Service Fabric partition.",
+ "description": "Reports health state of the specified Service Fabric partition. The report must contain the information about the source of the health report and property on which it is reported.\nThe report is sent to a Service Fabric gateway Partition, which forwards to the health store.\nThe report may be accepted by the gateway, but rejected by the health store after extra validation.\nFor example, the health store may reject the report because of an invalid parameter, like a stale sequence number.\nTo see whether the report was applied in the health store, run GetPartitionHealth and check that the report appears in the HealthEvents section.",
+ "tags": [
+ "Partition"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/PartitionIdRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/HealthInformationRequiredBodyParam"
+ },
+ {
+ "$ref": "#/parameters/ImmediateOptionalQueryParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "A successful operation will return 200 status code."
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/Partitions/{partitionId}/$/GetLoadInformation": {
+ "get": {
+ "summary": "Gets the load information of the specified Service Fabric partition.",
+ "description": "Returns information about the load of a specified partition.\nThe response includes a list of load reports for a Service Fabric partition.\nEach report includes the load metric name, value, and last reported time in UTC.",
+ "operationId": "GetPartitionLoadInformation",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/PartitionIdRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "tags": [
+ "Partition"
+ ],
+ "responses": {
+ "200": {
+ "description": "Information about the specified partition's last reported load metrics.",
+ "schema": {
+ "$ref": "#/definitions/PartitionLoadInformation"
+ }
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/Partitions/{partitionId}/$/ResetLoad": {
+ "post": {
+ "operationId": "ResetPartitionLoad",
+ "summary": "Resets the current load of a Service Fabric partition.",
+ "description": "Resets the current load of a Service Fabric partition to the default load for the service.",
+ "tags": [
+ "Partition"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/PartitionIdRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "A successful operation request will return 200 status code."
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/Partitions/{partitionId}/$/Recover": {
+ "post": {
+ "operationId": "RecoverPartition",
+ "summary": "Indicates to the Service Fabric cluster that it should attempt to recover a specific partition that is currently stuck in quorum loss.",
+ "description": "This operation should only be performed if it is known that the replicas that are down cannot be recovered. Incorrect use of this API can cause potential data loss.",
+ "tags": [
+ "Partition"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/PartitionIdRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "A successful operation request will return 200 status code."
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/Services/$/{serviceId}/$/GetPartitions/$/Recover": {
+ "post": {
+ "operationId": "RecoverServicePartitions",
+ "summary": "Indicates to the Service Fabric cluster that it should attempt to recover the specified service that is currently stuck in quorum loss.",
+ "description": "Indicates to the Service Fabric cluster that it should attempt to recover the specified service that is currently stuck in quorum loss. This operation should only be performed if it is known that the replicas that are down cannot be recovered. Incorrect use of this API can cause potential data loss.",
+ "tags": [
+ "Partition"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/ServiceIdRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "A successful operation request will return 200 status code."
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/$/RecoverSystemPartitions": {
+ "post": {
+ "operationId": "RecoverSystemPartitions",
+ "summary": "Indicates to the Service Fabric cluster that it should attempt to recover the system services that are currently stuck in quorum loss.",
+ "description": "Indicates to the Service Fabric cluster that it should attempt to recover the system services that are currently stuck in quorum loss. This operation should only be performed if it is known that the replicas that are down cannot be recovered. Incorrect use of this API can cause potential data loss.",
+ "tags": [
+ "Partition"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "A successful operation request will return 200 status code."
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/$/RecoverAllPartitions": {
+ "post": {
+ "operationId": "RecoverAllPartitions",
+ "summary": "Indicates to the Service Fabric cluster that it should attempt to recover any services (including system services) which are currently stuck in quorum loss.",
+ "description": "This operation should only be performed if it is known that the replicas that are down cannot be recovered. Incorrect use of this API can cause potential data loss.",
+ "tags": [
+ "Partition"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "A successful operation request will return 200 status code."
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/Partitions/{partitionId}/$/MovePrimaryReplica": {
+ "post": {
+ "operationId": "MovePrimaryReplica",
+ "summary": "Moves the primary replica of a partition of a stateful service.",
+ "description": "This command moves the primary replica of a partition of a stateful service, respecting all constraints.\nIf NodeName parameter is specified, primary will be moved to the specified node (if constraints allow it).\nIf NodeName parameter is not specified, primary replica will be moved to a random node in the cluster.\nIf IgnoreConstraints parameter is specified and set to true, then primary will be moved regardless of the constraints.",
+ "tags": [
+ "Partition"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-5_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/PartitionIdRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/NodeNameOptionalParam"
+ },
+ {
+ "$ref": "#/parameters/IgnoreConstraintsOptionalParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "A successful operation request will return 200 status code."
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/Partitions/{partitionId}/$/MoveSecondaryReplica": {
+ "post": {
+ "operationId": "MoveSecondaryReplica",
+ "summary": "Moves the secondary replica of a partition of a stateful service.",
+ "description": "This command moves the secondary replica of a partition of a stateful service, respecting all constraints.\nCurrentNodeName parameter must be specified to identify the replica that is moved.\nSource node name must be specified, but new node name can be omitted, and in that case replica is moved to a random node.\nIf IgnoreConstraints parameter is specified and set to true, then secondary will be moved regardless of the constraints.",
+ "tags": [
+ "Partition"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-5_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/PartitionIdRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/CurrentNodeNameRequiredParam"
+ },
+ {
+ "$ref": "#/parameters/NewNodeNameOptionalParam"
+ },
+ {
+ "$ref": "#/parameters/IgnoreConstraintsOptionalParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "A successful operation request will return 200 status code."
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/$/CreateRepairTask": {
+ "post": {
+ "operationId": "CreateRepairTask",
+ "summary": "Creates a new repair task.",
+ "description": "For clusters that have the Repair Manager Service configured,\nthis API provides a way to create repair tasks that run automatically or manually.\nFor repair tasks that run automatically, an appropriate repair executor\nmust be running for each repair action to run automatically.\nThese are currently only available in specially-configured Azure Cloud Services.\n\nTo create a manual repair task, provide the set of impacted node names and the\nexpected impact. When the state of the created repair task changes to approved,\nyou can safely perform repair actions on those nodes.\n\nThis API supports the Service Fabric platform; it is not meant to be used directly from your code.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/RepairTaskRequiredBodyParam"
+ }
+ ],
+ "tags": [
+ "RepairManagement"
+ ],
+ "responses": {
+ "200": {
+ "description": "A successful operation will return 200 status code.\nThe response body provides information about the created repair task.",
+ "schema": {
+ "$ref": "#/definitions/RepairTaskUpdateInfo"
+ }
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/$/CancelRepairTask": {
+ "post": {
+ "operationId": "CancelRepairTask",
+ "summary": "Requests the cancellation of the given repair task.",
+ "description": "This API supports the Service Fabric platform; it is not meant to be used directly from your code.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/RepairTaskCancelDescriptionRequiredBodyParam"
+ }
+ ],
+ "tags": [
+ "RepairManagement"
+ ],
+ "responses": {
+ "200": {
+ "description": "A successful operation will return 200 status code.\nThe response body provides information about the updated repair task.\nSuccess indicates that the cancellation request was recorded, but does not guarantee that the repair task will be cancelled.\nClients may use the State property of the repair task to determine the current state of the repair task.",
+ "schema": {
+ "$ref": "#/definitions/RepairTaskUpdateInfo"
+ }
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/$/DeleteRepairTask": {
+ "post": {
+ "operationId": "DeleteRepairTask",
+ "summary": "Deletes a completed repair task.",
+ "description": "This API supports the Service Fabric platform; it is not meant to be used directly from your code.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/RepairTaskDeleteDescriptionRequiredBodyParam"
+ }
+ ],
+ "tags": [
+ "RepairManagement"
+ ],
+ "responses": {
+ "200": {
+ "description": "A successful operation will return 200 status code."
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/$/GetRepairTaskList": {
+ "get": {
+ "operationId": "GetRepairTaskList",
+ "summary": "Gets a list of repair tasks matching the given filters.",
+ "description": "This API supports the Service Fabric platform; it is not meant to be used directly from your code.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/RepairTaskIdFilterOptionalQueryParam"
+ },
+ {
+ "$ref": "#/parameters/RepairTaskStateFilterOptionalQueryParam"
+ },
+ {
+ "$ref": "#/parameters/RepairTaskExecutorFilterOptionalQueryParam"
+ }
+ ],
+ "tags": [
+ "RepairManagement"
+ ],
+ "responses": {
+ "200": {
+ "description": "A successful operation will return 200 status code.\nThe response body provides a list of repair tasks matching all of the given filters.",
+ "schema": {
+ "$ref": "#/definitions/RepairTaskList"
+ }
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/$/ForceApproveRepairTask": {
+ "post": {
+ "operationId": "ForceApproveRepairTask",
+ "summary": "Forces the approval of the given repair task.",
+ "description": "This API supports the Service Fabric platform; it is not meant to be used directly from your code.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/RepairTaskApproveDescriptionRequiredBodyParam"
+ }
+ ],
+ "tags": [
+ "RepairManagement"
+ ],
+ "responses": {
+ "200": {
+ "description": "A successful operation will return 200 status code.\nThe response body provides information about the updated repair task.",
+ "schema": {
+ "$ref": "#/definitions/RepairTaskUpdateInfo"
+ }
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/$/UpdateRepairTaskHealthPolicy": {
+ "post": {
+ "operationId": "UpdateRepairTaskHealthPolicy",
+ "summary": "Updates the health policy of the given repair task.",
+ "description": "This API supports the Service Fabric platform; it is not meant to be used directly from your code.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/RepairTaskUpdateHealthPolicyDescriptionRequiredBodyParam"
+ }
+ ],
+ "tags": [
+ "RepairManagement"
+ ],
+ "responses": {
+ "200": {
+ "description": "A successful operation will return 200 status code.\nThe response body provides information about the updated repair task.",
+ "schema": {
+ "$ref": "#/definitions/RepairTaskUpdateInfo"
+ }
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/$/UpdateRepairExecutionState": {
+ "post": {
+ "operationId": "UpdateRepairExecutionState",
+ "summary": "Updates the execution state of a repair task.",
+ "description": "This API supports the Service Fabric platform; it is not meant to be used directly from your code.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/RepairTaskRequiredBodyParam"
+ }
+ ],
+ "tags": [
+ "RepairManagement"
+ ],
+ "responses": {
+ "200": {
+ "description": "A successful operation will return 200 status code.\nThe response body provides information about the updated repair task.",
+ "schema": {
+ "$ref": "#/definitions/RepairTaskUpdateInfo"
+ }
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/Partitions/{partitionId}/$/GetReplicas": {
+ "get": {
+ "summary": "Gets the information about replicas of a Service Fabric service partition.",
+ "description": "The GetReplicas endpoint returns information about the replicas of the specified partition. The response includes the ID, role, status, health, node name, uptime, and other details about the replica.",
+ "operationId": "GetReplicaInfoList",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/PartitionIdRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/ContinuationTokenOptionalQueryParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "tags": [
+ "Replica"
+ ],
+ "responses": {
+ "200": {
+ "description": "Information about the replicas of the specified partition.",
+ "schema": {
+ "$ref": "#/definitions/PagedReplicaInfoList"
+ }
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/Partitions/{partitionId}/$/GetReplicas/{replicaId}": {
+ "get": {
+ "summary": "Gets the information about a replica of a Service Fabric partition.",
+ "description": "The response includes the ID, role, status, health, node name, uptime, and other details about the replica.",
+ "operationId": "GetReplicaInfo",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/PartitionIdRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/ReplicaIdRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "tags": [
+ "Replica"
+ ],
+ "responses": {
+ "200": {
+ "description": "Information about the specified replicas of the specified partition of a Service Fabric service.",
+ "schema": {
+ "$ref": "#/definitions/ReplicaInfo"
+ }
+ },
+ "204": {
+ "description": "An empty response is returned if the specified replicaId is not a replica of the specified partition."
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/Partitions/{partitionId}/$/GetReplicas/{replicaId}/$/GetHealth": {
+ "get": {
+ "operationId": "GetReplicaHealth",
+ "summary": "Gets the health of a Service Fabric stateful service replica or stateless service instance.",
+ "description": "Gets the health of a Service Fabric replica.\nUse EventsHealthStateFilter to filter the collection of health events reported on the replica based on the health state.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/PartitionIdRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/ReplicaIdRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/EventsHealthStateFilterOptionalQueryParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "tags": [
+ "Replica"
+ ],
+ "responses": {
+ "200": {
+ "description": "A successful operation will return 200 status code and the requested replica health.",
+ "schema": {
+ "$ref": "#/definitions/ReplicaHealth"
+ }
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ },
+ "post": {
+ "operationId": "GetReplicaHealthUsingPolicy",
+ "summary": "Gets the health of a Service Fabric stateful service replica or stateless service instance using the specified policy.",
+ "description": "Gets the health of a Service Fabric stateful service replica or stateless service instance.\nUse EventsHealthStateFilter to filter the collection of health events reported on the cluster based on the health state.\nUse ApplicationHealthPolicy to optionally override the health policies used to evaluate the health. This API only uses 'ConsiderWarningAsError' field of the ApplicationHealthPolicy. The rest of the fields are ignored while evaluating the health of the replica.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/PartitionIdRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/ReplicaIdRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/EventsHealthStateFilterOptionalQueryParam"
+ },
+ {
+ "$ref": "#/parameters/ApplicationHealthPolicyOptionalBodyParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "tags": [
+ "Replica"
+ ],
+ "responses": {
+ "200": {
+ "description": "A successful operation will return 200 status code and the requested replica health information.",
+ "schema": {
+ "$ref": "#/definitions/ReplicaHealth"
+ }
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/Partitions/{partitionId}/$/GetReplicas/{replicaId}/$/ReportHealth": {
+ "post": {
+ "operationId": "ReportReplicaHealth",
+ "summary": "Sends a health report on the Service Fabric replica.",
+ "description": "Reports health state of the specified Service Fabric replica. The report must contain the information about the source of the health report and property on which it is reported.\nThe report is sent to a Service Fabric gateway Replica, which forwards to the health store.\nThe report may be accepted by the gateway, but rejected by the health store after extra validation.\nFor example, the health store may reject the report because of an invalid parameter, like a stale sequence number.\nTo see whether the report was applied in the health store, run GetReplicaHealth and check that the report appears in the HealthEvents section.",
+ "tags": [
+ "Replica"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/PartitionIdRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/ReplicaIdRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/ReplicaHealthReportServiceKindRequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/HealthInformationRequiredBodyParam"
+ },
+ {
+ "$ref": "#/parameters/ImmediateOptionalQueryParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "A successful operation will return 200 status code."
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/Nodes/{nodeName}/$/GetApplications/{applicationId}/$/GetReplicas": {
+ "get": {
+ "operationId": "GetDeployedServiceReplicaInfoList",
+ "summary": "Gets the list of replicas deployed on a Service Fabric node.",
+ "description": "Gets the list containing the information about replicas deployed on a Service Fabric node. The information include partition ID, replica ID, status of the replica, name of the service, name of the service type, and other information. Use PartitionId or ServiceManifestName query parameters to return information about the deployed replicas matching the specified values for those parameters.",
+ "tags": [
+ "Replica"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/NodeNameRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/ApplicationIdRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/PartitionIdOptionalQueryParam"
+ },
+ {
+ "$ref": "#/parameters/ServiceManifestNameOptionalQueryParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "A successful operation will return 200 status code and the list of deployed service replica information.",
+ "schema": {
+ "$ref": "#/definitions/DeployedServiceReplicaInfoList"
+ }
+ },
+ "204": {
+ "description": "An empty response is returned if the specified applicationId is not found on the specified node. An empty response is also returned if there are no replicas matching the specified filter values for PartitionId or ServiceManifestName query parameters."
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/Nodes/{nodeName}/$/GetPartitions/{partitionId}/$/GetReplicas/{replicaId}/$/GetDetail": {
+ "get": {
+ "operationId": "GetDeployedServiceReplicaDetailInfo",
+ "summary": "Gets the details of replica deployed on a Service Fabric node.",
+ "description": "Gets the details of the replica deployed on a Service Fabric node. The information includes service kind, service name, current service operation, current service operation start date time, partition ID, replica/instance ID, reported load, and other information.",
+ "tags": [
+ "Replica"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/NodeNameRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/PartitionIdRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/ReplicaIdRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "A successful operation will return 200 status code and the list of deployed service replica information.",
+ "schema": {
+ "$ref": "#/definitions/DeployedServiceReplicaDetailInfo"
+ }
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/Nodes/{nodeName}/$/GetPartitions/{partitionId}/$/GetReplicas": {
+ "get": {
+ "operationId": "GetDeployedServiceReplicaDetailInfoByPartitionId",
+ "summary": "Gets the details of replica deployed on a Service Fabric node.",
+ "description": "Gets the details of the replica deployed on a Service Fabric node. The information includes service kind, service name, current service operation, current service operation start date time, partition ID, replica/instance ID, reported load, and other information.",
+ "tags": [
+ "Replica"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/NodeNameRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/PartitionIdRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "A successful operation will return 200 status code and the list of deployed service replica information.",
+ "schema": {
+ "$ref": "#/definitions/DeployedServiceReplicaDetailInfo"
+ }
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/Nodes/{nodeName}/$/GetPartitions/{partitionId}/$/GetReplicas/{replicaId}/$/Restart": {
+ "post": {
+ "operationId": "RestartReplica",
+ "summary": "Restarts a service replica of a persisted service running on a node.",
+ "description": "Restarts a service replica of a persisted service running on a node. Warning - There are no safety checks performed when this API is used. Incorrect use of this API can lead to availability loss for stateful services.",
+ "tags": [
+ "Replica"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/NodeNameRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/PartitionIdRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/ReplicaIdRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "A successful operation will return 200 status code. A successful operation means that the restart command was received by the replica on the node and it is in the process of restarting."
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/Nodes/{nodeName}/$/GetPartitions/{partitionId}/$/GetReplicas/{replicaId}/$/Delete": {
+ "post": {
+ "operationId": "RemoveReplica",
+ "summary": "Removes a service replica running on a node.",
+ "description": "This API simulates a Service Fabric replica failure by removing a replica from a Service Fabric cluster. The removal closes the replica, transitions the replica to the role None, and then removes all of the state information of the replica from the cluster. This API tests the replica state removal path, and simulates the report fault permanent path through client APIs. Warning - There are no safety checks performed when this API is used. Incorrect use of this API can lead to data loss for stateful services. In addition, the forceRemove flag impacts all other replicas hosted in the same process.",
+ "tags": [
+ "Replica"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/NodeNameRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/PartitionIdRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/ReplicaIdRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/ForceRemoveReplicaOptionalQueryParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "A successful operation will return 200 status code. A successful operation means that the restart command was received by the replica on the node and it is in the process of restarting."
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/Nodes/{nodeName}/$/GetApplications/{applicationId}/$/GetServicePackages": {
+ "get": {
+ "operationId": "GetDeployedServicePackageInfoList",
+ "summary": "Gets the list of service packages deployed on a Service Fabric node.",
+ "description": "Returns the information about the service packages deployed on a Service Fabric node for the given application.",
+ "tags": [
+ "Service Package"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/NodeNameRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/ApplicationIdRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "A successful operation will return 200 status code and the list of deployed service packages information.",
+ "schema": {
+ "$ref": "#/definitions/DeployedServicePackageInfoList"
+ }
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/Nodes/{nodeName}/$/GetApplications/{applicationId}/$/GetServicePackages/{servicePackageName}": {
+ "get": {
+ "operationId": "GetDeployedServicePackageInfoListByName",
+ "summary": "Gets the list of service packages deployed on a Service Fabric node matching exactly the specified name.",
+ "description": "Returns the information about the service packages deployed on a Service Fabric node for the given application. These results are of service packages whose name match exactly the service package name specified as the parameter.",
+ "tags": [
+ "Service Package"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/NodeNameRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/ApplicationIdRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/ServicePackageNameRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "A successful operation will return 200 status code and the list of deployed service packages information.",
+ "schema": {
+ "$ref": "#/definitions/DeployedServicePackageInfoList"
+ }
+ },
+ "204": {
+ "description": "An empty response is returned if the specified service package from the application is not deployed on the node."
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/Nodes/{nodeName}/$/GetApplications/{applicationId}/$/GetServicePackages/{servicePackageName}/$/GetHealth": {
+ "get": {
+ "operationId": "GetDeployedServicePackageHealth",
+ "summary": "Gets the information about health of a service package for a specific application deployed for a Service Fabric node and application.",
+ "description": "Gets the information about health of a service package for a specific application deployed on a Service Fabric node. Use EventsHealthStateFilter to optionally filter for the collection of HealthEvent objects reported on the deployed service package based on health state.",
+ "tags": [
+ "Service Package"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/NodeNameRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/ApplicationIdRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/ServicePackageNameRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/EventsHealthStateFilterOptionalQueryParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "A successful operation will return 200 status code and the health information of the deployed service package for a specific node and application.",
+ "schema": {
+ "$ref": "#/definitions/DeployedServicePackageHealth"
+ }
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ },
+ "post": {
+ "operationId": "GetDeployedServicePackageHealthUsingPolicy",
+ "summary": "Gets the information about health of service package for a specific application deployed on a Service Fabric node using the specified policy.",
+ "description": "Gets the information about health of a service package for a specific application deployed on a Service Fabric node. using the specified policy. Use EventsHealthStateFilter to optionally filter for the collection of HealthEvent objects reported on the deployed service package based on health state. Use ApplicationHealthPolicy to optionally override the health policies used to evaluate the health. This API only uses 'ConsiderWarningAsError' field of the ApplicationHealthPolicy. The rest of the fields are ignored while evaluating the health of the deployed service package.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/NodeNameRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/ApplicationIdRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/ServicePackageNameRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/EventsHealthStateFilterOptionalQueryParam"
+ },
+ {
+ "$ref": "#/parameters/ApplicationHealthPolicyOptionalBodyParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "tags": [
+ "Service Package"
+ ],
+ "responses": {
+ "200": {
+ "description": "A successful operation will return 200 status code and the health information of the deployed service package for a specific node and application.",
+ "schema": {
+ "$ref": "#/definitions/DeployedServicePackageHealth"
+ }
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/Nodes/{nodeName}/$/GetApplications/{applicationId}/$/GetServicePackages/{servicePackageName}/$/ReportHealth": {
+ "post": {
+ "operationId": "ReportDeployedServicePackageHealth",
+ "summary": "Sends a health report on the Service Fabric deployed service package.",
+ "description": "Reports health state of the service package of the application deployed on a Service Fabric node. The report must contain the information about the source of the health report and property on which it is reported.\nThe report is sent to a Service Fabric gateway Service, which forwards to the health store.\nThe report may be accepted by the gateway, but rejected by the health store after extra validation.\nFor example, the health store may reject the report because of an invalid parameter, like a stale sequence number.\nTo see whether the report was applied in the health store, get deployed service package health and check that the report appears in the HealthEvents section.",
+ "tags": [
+ "Service Package"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/NodeNameRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/ApplicationIdRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/ServicePackageNameRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/HealthInformationRequiredBodyParam"
+ },
+ {
+ "$ref": "#/parameters/ImmediateOptionalQueryParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "A successful operation will return 200 status code."
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/Nodes/{nodeName}/$/DeployServicePackage": {
+ "post": {
+ "operationId": "DeployServicePackageToNode",
+ "summary": "Downloads all of the code packages associated with specified service manifest on the specified node.",
+ "description": "This API provides a way to download code packages including the container images on a specific node outside of the normal application deployment and upgrade path. This is useful for the large code packages and container images to be present on the node before the actual application deployment and upgrade, thus significantly reducing the total time required for the deployment or upgrade.",
+ "tags": [
+ "Service Package"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/NodeNameRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/DeployServicePackageToNodeRequiredBodyParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "A successful operation will return 200 status code."
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/Nodes/{nodeName}/$/GetApplications/{applicationId}/$/GetCodePackages": {
+ "get": {
+ "operationId": "GetDeployedCodePackageInfoList",
+ "summary": "Gets the list of code packages deployed on a Service Fabric node.",
+ "description": "Gets the list of code packages deployed on a Service Fabric node for the given application.",
+ "tags": [
+ "Code Package"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/NodeNameRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/ApplicationIdRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/ServiceManifestNameOptionalQueryParam"
+ },
+ {
+ "$ref": "#/parameters/CodePackageNameOptionalQueryParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "A successful operation will return 200 status code and the list of deployed code packages information.",
+ "schema": {
+ "$ref": "#/definitions/DeployedCodePackageInfoList"
+ }
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/Nodes/{nodeName}/$/GetApplications/{applicationId}/$/GetCodePackages/$/Restart": {
+ "post": {
+ "operationId": "RestartDeployedCodePackage",
+ "summary": "Restarts a code package deployed on a Service Fabric node in a cluster.",
+ "description": "Restarts a code package deployed on a Service Fabric node in a cluster. This aborts the code package process, which will restart all the user service replicas hosted in that process.",
+ "tags": [
+ "Code Package"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/NodeNameRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/ApplicationIdRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/RestartDeployedCodePackageRequiredBodyParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "A successful operation will return 200 status code."
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/Nodes/{nodeName}/$/GetApplications/{applicationId}/$/GetCodePackages/$/ContainerLogs": {
+ "get": {
+ "operationId": "GetContainerLogsDeployedOnNode",
+ "summary": "Gets the container logs for container deployed on a Service Fabric node.",
+ "description": "Gets the container logs for container deployed on a Service Fabric node for the given code package.",
+ "tags": [
+ "Code Package"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-2_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/NodeNameRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/ApplicationIdRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/ServiceManifestNameRequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/CodePackageNameRequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/TailOptionalQueryParam"
+ },
+ {
+ "$ref": "#/parameters/PreviousOptionalQueryParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "x-ms-examples": {
+ "Get container logs for given code package": {
+ "$ref": "./examples/GetContainerLogsDeployedOnNode-1.json"
+ },
+ "Get last 10 lines of container logs": {
+ "$ref": "./examples/GetContainerLogsDeployedOnNode-2.json"
+ },
+ "Get container logs of previous dead container for given code package": {
+ "$ref": "./examples/GetContainerLogsDeployedOnNode-3.json"
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "A successful operation will return 200 status code and the container logs for container deployed on a Service Fabric node for the given code package.",
+ "schema": {
+ "$ref": "#/definitions/ContainerLogs"
+ }
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/Nodes/{nodeName}/$/GetApplications/{applicationId}/$/GetCodePackages/$/ContainerApi": {
+ "post": {
+ "operationId": "InvokeContainerApi",
+ "summary": "Invoke container API on a container deployed on a Service Fabric node.",
+ "description": "Invoke container API on a container deployed on a Service Fabric node for the given code package.",
+ "x-ms-examples": {
+ "Get container logs": {
+ "$ref": "./examples/InvokeContainerApi.json"
+ },
+ "Update container": {
+ "$ref": "./examples/InvokeContainerApi_Post.json"
+ }
+ },
+ "tags": [
+ "Code Package"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-2_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/NodeNameRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/ApplicationIdRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/ServiceManifestNameRequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/CodePackageNameRequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/CodePackageInstanceIdRequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ },
+ {
+ "$ref": "#/parameters/ContainerApiRequiredBodyParam"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "A successful operation will return 200 status code and container API response for a container deployed on a Service Fabric node for the given code package.",
+ "schema": {
+ "$ref": "#/definitions/ContainerApiResponse"
+ }
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/ComposeDeployments/$/Create": {
+ "put": {
+ "summary": "Creates a Service Fabric compose deployment.",
+ "description": "Compose is a file format that describes multi-container applications. This API allows deploying container based applications defined in compose format in a Service Fabric cluster. Once the deployment is created, its status can be tracked via the `GetComposeDeploymentStatus` API.",
+ "operationId": "CreateComposeDeployment",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-0-Preview_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/CreateComposeDeploymentRequiredBodyParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "tags": [
+ "Compose Deployment"
+ ],
+ "responses": {
+ "202": {
+ "description": "A successful operation will return 202 status code."
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/ComposeDeployments/{deploymentName}": {
+ "get": {
+ "summary": "Gets information about a Service Fabric compose deployment.",
+ "description": "Returns the status of the compose deployment that was created or in the process of being created in the Service Fabric cluster and whose name matches the one specified as the parameter. The response includes the name, status, and other details about the deployment.",
+ "operationId": "GetComposeDeploymentStatus",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-0-Preview_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/DeploymentNameRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "tags": [
+ "Compose Deployment"
+ ],
+ "responses": {
+ "200": {
+ "description": "Information about the compose deployment.",
+ "schema": {
+ "$ref": "#/definitions/ComposeDeploymentStatusInfo"
+ }
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/ComposeDeployments": {
+ "get": {
+ "summary": "Gets the list of compose deployments created in the Service Fabric cluster.",
+ "description": "Gets the status about the compose deployments that were created or in the process of being created in the Service Fabric cluster. The response includes the name, status, and other details about the compose deployments. If the list of deployments do not fit in a page, one page of results is returned as well as a continuation token, which can be used to get the next page.",
+ "operationId": "GetComposeDeploymentStatusList",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-0-Preview_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/ContinuationTokenOptionalQueryParam"
+ },
+ {
+ "$ref": "#/parameters/MaxResultsOptionalQueryParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "tags": [
+ "Compose Deployment"
+ ],
+ "responses": {
+ "200": {
+ "description": "List of status of compose deployments in the cluster.",
+ "schema": {
+ "$ref": "#/definitions/PagedComposeDeploymentStatusInfoList"
+ }
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/ComposeDeployments/{deploymentName}/$/GetUpgradeProgress": {
+ "get": {
+ "summary": "Gets details for the latest upgrade performed on this Service Fabric compose deployment.",
+ "description": "Returns the information about the state of the compose deployment upgrade along with details to aid debugging application health issues.",
+ "operationId": "GetComposeDeploymentUpgradeProgress",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-0-Preview_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/DeploymentNameRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "tags": [
+ "Compose Deployment"
+ ],
+ "responses": {
+ "200": {
+ "description": "Details about the compose deployment upgrade.",
+ "schema": {
+ "$ref": "#/definitions/ComposeDeploymentUpgradeProgressInfo"
+ }
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/ComposeDeployments/{deploymentName}/$/Delete": {
+ "post": {
+ "summary": "Deletes an existing Service Fabric compose deployment from cluster.",
+ "description": "Deletes an existing Service Fabric compose deployment.",
+ "operationId": "RemoveComposeDeployment",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-0-Preview_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/DeploymentNameRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "tags": [
+ "Compose Deployment"
+ ],
+ "responses": {
+ "202": {
+ "description": "A successful operation will return 202 status code."
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/ComposeDeployments/{deploymentName}/$/Upgrade": {
+ "post": {
+ "summary": "Starts upgrading a compose deployment in the Service Fabric cluster.",
+ "description": "Validates the supplied upgrade parameters and starts upgrading the deployment if the parameters are valid.",
+ "operationId": "StartComposeDeploymentUpgrade",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-0-Preview_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/DeploymentNameRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/ComposeDeploymentUpgradeDescriptionRequiredBodyParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "tags": [
+ "Compose Deployment"
+ ],
+ "responses": {
+ "202": {
+ "description": "A successful response means that the upgrade has started. Use GetComposeDeploymentUpgrade operation to get the status of the upgrade."
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/ComposeDeployments/{deploymentName}/$/RollbackUpgrade": {
+ "post": {
+ "summary": "Starts rolling back a compose deployment upgrade in the Service Fabric cluster.",
+ "description": "Rollback a service fabric compose deployment upgrade.",
+ "operationId": "StartRollbackComposeDeploymentUpgrade",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-4-Preview_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/DeploymentNameRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "tags": [
+ "Compose Deployment"
+ ],
+ "responses": {
+ "200": {
+ "description": "A successful response means that the rollback has started. Use GetComposeDeploymentUpgrade operation to get the status of the rollback."
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/Tools/Chaos": {
+ "get": {
+ "operationId": "GetChaos",
+ "summary": "Get the status of Chaos.",
+ "description": "Get the status of Chaos indicating whether or not Chaos is running, the Chaos parameters used for running Chaos and the status of the Chaos Schedule.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-2_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "tags": [
+ "Chaos"
+ ],
+ "responses": {
+ "200": {
+ "description": "A successful operation will return 200 status code and the status of Chaos.",
+ "schema": {
+ "$ref": "#/definitions/Chaos"
+ }
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/Tools/Chaos/$/Start": {
+ "post": {
+ "operationId": "StartChaos",
+ "summary": "Starts Chaos in the cluster.",
+ "description": "If Chaos is not already running in the cluster, it starts Chaos with the passed in Chaos parameters.\nIf Chaos is already running when this call is made, the call fails with the error code FABRIC_E_CHAOS_ALREADY_RUNNING.\nRefer to the article [Induce controlled Chaos in Service Fabric clusters](https://docs.microsoft.com/azure/service-fabric/service-fabric-controlled-chaos) for more details.",
+ "tags": [
+ "Chaos"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/ChaosParametersRequiredBodyParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "A successful operation will return 200 status code."
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/Tools/Chaos/$/Stop": {
+ "post": {
+ "operationId": "StopChaos",
+ "summary": "Stops Chaos if it is running in the cluster and put the Chaos Schedule in a stopped state.",
+ "description": "Stops Chaos from executing new faults. In-flight faults will continue to execute until they are complete. The current Chaos Schedule is put into a stopped state.\nOnce a schedule is stopped, it will stay in the stopped state and not be used to Chaos Schedule new runs of Chaos. A new Chaos Schedule must be set in order to resume scheduling.",
+ "tags": [
+ "Chaos"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "A successful operation will return 200 status code."
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/Tools/Chaos/Events": {
+ "get": {
+ "operationId": "GetChaosEvents",
+ "summary": "Gets the next segment of the Chaos events based on the continuation token or the time range.",
+ "description": "To get the next segment of the Chaos events, you can specify the ContinuationToken. To get the start of a new segment of Chaos events, you can specify the time range\nthrough StartTimeUtc and EndTimeUtc. You cannot specify both the ContinuationToken and the time range in the same call.\nWhen there are more than 100 Chaos events, the Chaos events are returned in multiple segments where a segment contains no more than 100 Chaos events and to get the next segment you make a call to this API with the continuation token.",
+ "x-ms-examples": {
+ "Get Chaos events given a time range": {
+ "$ref": "./examples/GetChaosEvents.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-2_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/ContinuationTokenOptionalQueryParam"
+ },
+ {
+ "$ref": "#/parameters/StartTimeUtcOptionalQueryParam"
+ },
+ {
+ "$ref": "#/parameters/EndTimeUtcOptionalQueryParam"
+ },
+ {
+ "$ref": "#/parameters/MaxResultsOptionalQueryParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "tags": [
+ "Chaos"
+ ],
+ "responses": {
+ "200": {
+ "description": "Next segment of Chaos events.",
+ "schema": {
+ "$ref": "#/definitions/ChaosEventsSegment"
+ }
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/Tools/Chaos/Schedule": {
+ "get": {
+ "operationId": "GetChaosSchedule",
+ "summary": "Get the Chaos Schedule defining when and how to run Chaos.",
+ "description": "Gets the version of the Chaos Schedule in use and the Chaos Schedule that defines when and how to run Chaos.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-2_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "tags": [
+ "Chaos"
+ ],
+ "responses": {
+ "200": {
+ "description": "A successful operation will return 200 status code and the schedule description including a Chaos Schedule used by Chaos and the version the Chaos Schedule is on.",
+ "schema": {
+ "$ref": "#/definitions/ChaosScheduleDescription"
+ }
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ },
+ "post": {
+ "operationId": "PostChaosSchedule",
+ "summary": "Set the schedule used by Chaos.",
+ "description": "Chaos will automatically schedule runs based on the Chaos Schedule.\nThe Chaos Schedule will be updated if the provided version matches the version on the server.\nWhen updating the Chaos Schedule, the version on the server is incremented by 1.\nThe version on the server will wrap back to 0 after reaching a large number.\nIf Chaos is running when this call is made, the call will fail.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-2_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ },
+ {
+ "$ref": "#/parameters/ChaosScheduleRequiredBodyParam"
+ }
+ ],
+ "tags": [
+ "Chaos"
+ ],
+ "responses": {
+ "200": {
+ "description": "A successful operation will return 200 status code."
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/ImageStore/{contentPath}": {
+ "put": {
+ "summary": "Uploads contents of the file to the image store.",
+ "description": "Uploads contents of the file to the image store. Use this API if the file is small enough to upload again if the connection fails. The file's data needs to be added to the request body. The contents will be uploaded to the specified path. Image store service uses a mark file to indicate the availability of the folder. The mark file is an empty file named \"_.dir\". The mark file is generated by the image store service when all files in a folder are uploaded. When using File-by-File approach to upload application package in REST, the image store service isn't aware of the file hierarchy of the application package; you need to create a mark file per folder and upload it last, to let the image store service know that the folder is complete.",
+ "operationId": "UploadFile",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/ImageStoreContentPathRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "tags": [
+ "ImageStore"
+ ],
+ "responses": {
+ "200": {
+ "description": "If the upload request succeeds, the server returns the HTTP 200 OK status code."
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ },
+ "get": {
+ "summary": "Gets the image store content information.",
+ "description": "Returns the information about the image store content at the specified contentPath. The contentPath is relative to the root of the image store.",
+ "operationId": "GetImageStoreContent",
+ "x-ms-examples": {
+ "Get information about image store content under a given relative path": {
+ "$ref": "./examples/GetImageStoreContent.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-2_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/ImageStoreContentPathRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "tags": [
+ "ImageStore"
+ ],
+ "responses": {
+ "200": {
+ "description": "A successful operation will return 200 status code and the requested image store content information.",
+ "schema": {
+ "$ref": "#/definitions/ImageStoreContent"
+ }
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ },
+ "delete": {
+ "summary": "Deletes existing image store content.",
+ "description": "Deletes existing image store content being found within the given image store relative path. This command can be used to delete uploaded application packages once they are provisioned.",
+ "operationId": "DeleteImageStoreContent",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/ImageStoreContentPathRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "tags": [
+ "ImageStore"
+ ],
+ "responses": {
+ "200": {
+ "description": "A successful operation will return 200 status code."
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/ImageStore": {
+ "get": {
+ "summary": "Gets the content information at the root of the image store.",
+ "description": "Returns the information about the image store content at the root of the image store.",
+ "operationId": "GetImageStoreRootContent",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "tags": [
+ "ImageStore"
+ ],
+ "responses": {
+ "200": {
+ "description": "A successful operation will return 200 status code and the requested image store content information.",
+ "schema": {
+ "$ref": "#/definitions/ImageStoreContent"
+ }
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/ImageStore/$/Copy": {
+ "post": {
+ "summary": "Copies image store content internally",
+ "description": "Copies the image store content from the source image store relative path to the destination image store relative path.",
+ "operationId": "CopyImageStoreContent",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/ImageStoreCopyDescriptionRequiredBodyParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "tags": [
+ "ImageStore"
+ ],
+ "responses": {
+ "200": {
+ "description": "A successful operation will return 200 status code."
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/ImageStore/$/DeleteUploadSession": {
+ "delete": {
+ "summary": "Cancels an image store upload session.",
+ "description": "The DELETE request will cause the existing upload session to expire and remove any previously uploaded file chunks.",
+ "operationId": "DeleteImageStoreUploadSession",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/UploadSessionIdRequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "tags": [
+ "ImageStore"
+ ],
+ "responses": {
+ "200": {
+ "description": "A successful operation will return 200 status code."
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/ImageStore/$/CommitUploadSession": {
+ "post": {
+ "summary": "Commit an image store upload session.",
+ "description": "When all file chunks have been uploaded, the upload session needs to be committed explicitly to complete the upload. Image store preserves the upload session until the expiration time, which is 30 minutes after the last chunk received. ",
+ "operationId": "CommitImageStoreUploadSession",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/UploadSessionIdRequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "tags": [
+ "ImageStore"
+ ],
+ "responses": {
+ "200": {
+ "description": "If the commit request succeeds, the server returns the HTTP 200 OK status code."
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/ImageStore/$/GetUploadSession": {
+ "get": {
+ "summary": "Get the image store upload session by ID.",
+ "description": "Gets the image store upload session identified by the given ID. User can query the upload session at any time during uploading. ",
+ "operationId": "GetImageStoreUploadSessionById",
+ "x-ms-examples": {
+ "Get information about image store upload session by a given ID": {
+ "$ref": "./examples/GetUploadSessionById.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/UploadSessionIdRequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "tags": [
+ "ImageStore"
+ ],
+ "responses": {
+ "200": {
+ "description": "A successful operation will return 200 status code and the requested image store upload session information.",
+ "schema": {
+ "$ref": "#/definitions/UploadSession"
+ }
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/ImageStore/{contentPath}/$/GetUploadSession": {
+ "get": {
+ "summary": "Get the image store upload session by relative path.",
+ "description": "Gets the image store upload session associated with the given image store relative path. User can query the upload session at any time during uploading. ",
+ "operationId": "GetImageStoreUploadSessionByPath",
+ "x-ms-examples": {
+ "Get information about image store upload session by a given relative path": {
+ "$ref": "./examples/GetUploadSessionByPath.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/ImageStoreContentPathRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "tags": [
+ "ImageStore"
+ ],
+ "responses": {
+ "200": {
+ "description": "A successful operation will return 200 status code and the requested image store upload session information.",
+ "schema": {
+ "$ref": "#/definitions/UploadSession"
+ }
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/ImageStore/{contentPath}/$/UploadChunk": {
+ "put": {
+ "summary": "Uploads a file chunk to the image store relative path.",
+ "description": "Uploads a file chunk to the image store with the specified upload session ID and image store relative path. This API allows user to resume the file upload operation. user doesn't have to restart the file upload from scratch whenever there is a network interruption. Use this option if the file size is large.\n\nTo perform a resumable file upload, user need to break the file into multiple chunks and upload these chunks to the image store one-by-one. Chunks don't have to be uploaded in order. If the file represented by the image store relative path already exists, it will be overwritten when the upload session commits.",
+ "operationId": "UploadFileChunk",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/ImageStoreContentPathRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/UploadSessionIdRequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/UploadFileChunkContentRangeHeaderParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "tags": [
+ "ImageStore"
+ ],
+ "responses": {
+ "200": {
+ "description": "A successful operation will return the HTTP 200 OK status code."
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/ImageStore/$/FolderSize": {
+ "get": {
+ "summary": "Get the folder size at the root of the image store.",
+ "description": "Returns the total size of files at the root and children folders in image store.",
+ "operationId": "GetImageStoreRootFolderSize",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-5_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "tags": [
+ "ImageStore"
+ ],
+ "responses": {
+ "200": {
+ "description": "A successful operation will return 200 status code and the requested folder size in image store.",
+ "schema": {
+ "$ref": "#/definitions/FolderSizeInfo"
+ }
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/ImageStore/{contentPath}/$/FolderSize": {
+ "get": {
+ "summary": "Get the size of a folder in image store",
+ "description": "Gets the total size of file under a image store folder, specified by contentPath. The contentPath is relative to the root of the image store.",
+ "operationId": "GetImageStoreFolderSize",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-5_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/ImageStoreContentPathRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "tags": [
+ "ImageStore"
+ ],
+ "responses": {
+ "200": {
+ "description": "A successful operation will return 200 status code and the requested folder size in image store.",
+ "schema": {
+ "$ref": "#/definitions/FolderSizeInfo"
+ }
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/ImageStore/$/Info": {
+ "get": {
+ "summary": "Gets the overall ImageStore information",
+ "description": "Returns information about the primary ImageStore replica, such as disk capacity and available disk space at the node it is on, and several categories of the ImageStore's file system usage.",
+ "operationId": "GetImageStoreInfo",
+ "x-ms-examples": {
+ "Gets the overall ImageStore information": {
+ "$ref": "./examples/GetImageStoreInfo.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-5_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "tags": [
+ "ImageStore"
+ ],
+ "responses": {
+ "200": {
+ "description": "A successful operation will return 200 status code and the requested ImageStore info",
+ "schema": {
+ "$ref": "#/definitions/ImageStoreInfo"
+ }
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/$/InvokeInfrastructureCommand": {
+ "post": {
+ "operationId": "InvokeInfrastructureCommand",
+ "summary": "Invokes an administrative command on the given Infrastructure Service instance.",
+ "description": "For clusters that have one or more instances of the Infrastructure Service configured,\nthis API provides a way to send infrastructure-specific commands to a particular\ninstance of the Infrastructure Service.\n\nAvailable commands and their corresponding response formats vary depending upon\nthe infrastructure on which the cluster is running.\n\nThis API supports the Service Fabric platform; it is not meant to be used directly from your code.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/InfrastructureCommandRequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/InfrastructureServiceIdOptionalQueryParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "tags": [
+ "Infrastructure"
+ ],
+ "responses": {
+ "200": {
+ "description": "The response from the infrastructure service. The response format is a JSON stream.\nThe contents of the response depend on which command was issued.",
+ "schema": {
+ "$ref": "#/definitions/InfrastructureServiceResponse"
+ }
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/$/InvokeInfrastructureQuery": {
+ "get": {
+ "operationId": "InvokeInfrastructureQuery",
+ "summary": "Invokes a read-only query on the given infrastructure service instance.",
+ "description": "For clusters that have one or more instances of the Infrastructure Service configured,\nthis API provides a way to send infrastructure-specific queries to a particular\ninstance of the Infrastructure Service.\n\nAvailable commands and their corresponding response formats vary depending upon\nthe infrastructure on which the cluster is running.\n\nThis API supports the Service Fabric platform; it is not meant to be used directly from your code.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/InfrastructureCommandRequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/InfrastructureServiceIdOptionalQueryParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "tags": [
+ "Infrastructure"
+ ],
+ "responses": {
+ "200": {
+ "description": "The response from the infrastructure service. The response format is a JSON stream.\nThe contents of the response depend on which command was issued.",
+ "schema": {
+ "$ref": "#/definitions/InfrastructureServiceResponse"
+ }
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/Faults/Services/{serviceId}/$/GetPartitions/{partitionId}/$/StartDataLoss": {
+ "post": {
+ "operationId": "StartDataLoss",
+ "summary": "This API will induce data loss for the specified partition. It will trigger a call to the OnDataLossAsync API of the partition.",
+ "description": "This API will induce data loss for the specified partition. It will trigger a call to the OnDataLoss API of the partition.\nActual data loss will depend on the specified DataLossMode.\n\n- PartialDataLoss - Only a quorum of replicas are removed and OnDataLoss is triggered for the partition but actual data loss depends on the presence of in-flight replication.\n- FullDataLoss - All replicas are removed hence all data is lost and OnDataLoss is triggered.\n\nThis API should only be called with a stateful service as the target.\n\nCalling this API with a system service as the target is not advised.\n\nNote: Once this API has been called, it cannot be reversed. Calling CancelOperation will only stop execution and clean up internal system state.\nIt will not restore data if the command has progressed far enough to cause data loss.\n\nCall the GetDataLossProgress API with the same OperationId to return information on the operation started with this API.",
+ "tags": [
+ "Faults"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/ServiceIdRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/PartitionIdRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/FaultOperationIdRequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/DataLossModeRequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "responses": {
+ "202": {
+ "description": "A 202 status code indicates the operation was accepted. Call the GetDataLossProgress API to get the progress."
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/Faults/Services/{serviceId}/$/GetPartitions/{partitionId}/$/GetDataLossProgress": {
+ "get": {
+ "summary": "Gets the progress of a partition data loss operation started using the StartDataLoss API.",
+ "description": "Gets the progress of a data loss operation started with StartDataLoss, using the OperationId.",
+ "operationId": "GetDataLossProgress",
+ "x-ms-examples": {
+ "Gets information about a partition data loss operation. In this case the operation has a State of Completed": {
+ "$ref": "./examples/GetDataLossProgress.json"
+ },
+ "Get information about a partition data loss operation. In this case the operation is a State of Running": {
+ "$ref": "./examples/GetDataLossProgress-Running.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/ServiceIdRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/PartitionIdRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/FaultOperationIdRequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "tags": [
+ "Faults"
+ ],
+ "responses": {
+ "200": {
+ "description": "Information about the progress of the partition data loss operation.",
+ "schema": {
+ "$ref": "#/definitions/PartitionDataLossProgress"
+ }
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/Faults/Services/{serviceId}/$/GetPartitions/{partitionId}/$/StartQuorumLoss": {
+ "post": {
+ "operationId": "StartQuorumLoss",
+ "summary": "Induces quorum loss for a given stateful service partition.",
+ "description": "This API is useful for a temporary quorum loss situation on your service.\n\nCall the GetQuorumLossProgress API with the same OperationId to return information on the operation started with this API.\n\nThis can only be called on stateful persisted (HasPersistedState==true) services. Do not use this API on stateless services or stateful in-memory only services.",
+ "tags": [
+ "Faults"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/ServiceIdRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/PartitionIdRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/FaultOperationIdRequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/QuorumLossModeRequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/QuorumLossDurationRequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "responses": {
+ "202": {
+ "description": "A 202 status code indicates the operation was accepted. Call the GetQuorumLossProgress API to get the progress."
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/Faults/Services/{serviceId}/$/GetPartitions/{partitionId}/$/GetQuorumLossProgress": {
+ "get": {
+ "summary": "Gets the progress of a quorum loss operation on a partition started using the StartQuorumLoss API.",
+ "description": "Gets the progress of a quorum loss operation started with StartQuorumLoss, using the provided OperationId.",
+ "operationId": "GetQuorumLossProgress",
+ "x-ms-examples": {
+ "Gets information about a completed quorum loss operation": {
+ "$ref": "./examples/GetQuorumLossProgress.json"
+ },
+ "Gets information about a running quorum operation operation": {
+ "$ref": "./examples/GetQuorumLossProgress-Running.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/ServiceIdRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/PartitionIdRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/FaultOperationIdRequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "tags": [
+ "Faults"
+ ],
+ "responses": {
+ "200": {
+ "description": "Information about the progress of a partition quorum loss operation.",
+ "schema": {
+ "$ref": "#/definitions/PartitionQuorumLossProgress"
+ }
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/Faults/Services/{serviceId}/$/GetPartitions/{partitionId}/$/StartRestart": {
+ "post": {
+ "operationId": "StartPartitionRestart",
+ "summary": "This API will restart some or all replicas or instances of the specified partition.",
+ "description": "This API is useful for testing failover.\n\nIf used to target a stateless service partition, RestartPartitionMode must be AllReplicasOrInstances.\n\nCall the GetPartitionRestartProgress API using the same OperationId to get the progress.",
+ "tags": [
+ "Faults"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/ServiceIdRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/PartitionIdRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/FaultOperationIdRequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/RestartPartitionModeRequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "responses": {
+ "202": {
+ "description": "A 202 status code indicates the operation was accepted. Call the GetPartitionRestartProgress API to get the progress."
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/Faults/Services/{serviceId}/$/GetPartitions/{partitionId}/$/GetRestartProgress": {
+ "get": {
+ "summary": "Gets the progress of a PartitionRestart operation started using StartPartitionRestart.",
+ "description": "Gets the progress of a PartitionRestart started with StartPartitionRestart using the provided OperationId.",
+ "operationId": "GetPartitionRestartProgress",
+ "x-ms-examples": {
+ "Get information a completed PartitionRestart operation": {
+ "$ref": "./examples/GetPartitionRestartProgress.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/ServiceIdRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/PartitionIdRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/FaultOperationIdRequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "tags": [
+ "Faults"
+ ],
+ "responses": {
+ "200": {
+ "description": "Information about the progress of a partition restart operation.",
+ "schema": {
+ "$ref": "#/definitions/PartitionRestartProgress"
+ }
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/Faults/Nodes/{nodeName}/$/StartTransition/": {
+ "post": {
+ "operationId": "StartNodeTransition",
+ "summary": "Starts or stops a cluster node.",
+ "description": "Starts or stops a cluster node. A cluster node is a process, not the OS instance itself. To start a node, pass in \"Start\" for the NodeTransitionType parameter.\nTo stop a node, pass in \"Stop\" for the NodeTransitionType parameter. This API starts the operation - when the API returns the node may not have finished transitioning yet.\nCall GetNodeTransitionProgress with the same OperationId to get the progress of the operation.",
+ "tags": [
+ "Faults"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/NodeNameRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/FaultOperationIdRequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/NodeTransitionTypeRequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/NodeInstanceIdRequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/StopDurationInSecondsRequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "responses": {
+ "202": {
+ "description": "A 202 status code indicates the operation was accepted. Call the GetNodeTransitionProgress API to get the progress."
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/Faults/Nodes/{nodeName}/$/GetTransitionProgress": {
+ "get": {
+ "summary": "Gets the progress of an operation started using StartNodeTransition.",
+ "description": "Gets the progress of an operation started with StartNodeTransition using the provided OperationId.",
+ "operationId": "GetNodeTransitionProgress",
+ "x-ms-examples": {
+ "Gets information about a completed NodeTransition operation": {
+ "$ref": "./examples/GetNodeTransitionProgress.json"
+ },
+ "Gets information about a running NodeTransition operation": {
+ "$ref": "./examples/GetNodeTransitionProgress-Running.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/NodeNameRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/FaultOperationIdRequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "tags": [
+ "Faults"
+ ],
+ "responses": {
+ "200": {
+ "description": "Information about the progress of a node transition operation.",
+ "schema": {
+ "$ref": "#/definitions/NodeTransitionProgress"
+ }
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/Faults/": {
+ "get": {
+ "operationId": "GetFaultOperationList",
+ "summary": "Gets a list of user-induced fault operations filtered by provided input.",
+ "description": "Gets the list of user-induced fault operations filtered by provided input.",
+ "x-ms-examples": {
+ "Gets information on fault operations": {
+ "$ref": "./examples/GetFaultOperationList.json"
+ }
+ },
+ "tags": [
+ "Faults"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/TypeFilterRequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/StateFilterRequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "A successful operation will return 200 status code.",
+ "schema": {
+ "$ref": "#/definitions/OperationStatusList"
+ }
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/Faults/$/Cancel": {
+ "post": {
+ "operationId": "CancelOperation",
+ "summary": "Cancels a user-induced fault operation.",
+ "description": "The following APIs start fault operations that may be cancelled by using CancelOperation: StartDataLoss, StartQuorumLoss, StartPartitionRestart, StartNodeTransition.\n\nIf force is false, then the specified user-induced operation will be gracefully stopped and cleaned up. If force is true, the command will be aborted, and some internal state\nmay be left behind. Specifying force as true should be used with care. Calling this API with force set to true is not allowed until this API has already\nbeen called on the same test command with force set to false first, or unless the test command already has an OperationState of OperationState.RollingBack.\nClarification: OperationState.RollingBack means that the system will be/is cleaning up internal system state caused by executing the command. It will not restore data if the\ntest command was to cause data loss. For example, if you call StartDataLoss then call this API, the system will only clean up internal state from running the command.\nIt will not restore the target partition's data, if the command progressed far enough to cause data loss.\n\nImportant note: if this API is invoked with force==true, internal state may be left behind.",
+ "tags": [
+ "Faults"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/FaultOperationIdRequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/ForceRequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "A successful operation will return 200 status code."
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/BackupRestore/BackupPolicies/$/Create": {
+ "post": {
+ "operationId": "CreateBackupPolicy",
+ "summary": "Creates a backup policy.",
+ "description": "Creates a backup policy which can be associated later with a Service Fabric application, service or a partition for periodic backup.",
+ "x-ms-examples": {
+ "Create a time based backup policy with Azure as backup location": {
+ "$ref": "./examples/CreateBackupPolicy-1.json"
+ },
+ "Create a frequency based backup policy with file share as backup location": {
+ "$ref": "./examples/CreateBackupPolicy-2.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/BackupPolicyDescriptionRequiredBodyParam"
+ },
+ {
+ "$ref": "#/parameters/ApiVersion_6-4_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "tags": [
+ "BackupRestore"
+ ],
+ "responses": {
+ "201": {
+ "description": "A successful operation returns 201 status code and creates a new backup policy."
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/BackupRestore/BackupPolicies/{backupPolicyName}/$/Delete": {
+ "post": {
+ "operationId": "DeleteBackupPolicy",
+ "summary": "Deletes the backup policy.",
+ "description": "Deletes an existing backup policy. A backup policy must be created before it can be deleted. A currently active backup policy, associated with any Service Fabric application, service or partition, cannot be deleted without first deleting the mapping.",
+ "x-ms-examples": {
+ "Delete backup policy": {
+ "$ref": "./examples/DeleteBackupPolicy.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/BackupPolicyNameRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/ApiVersion_6-4_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "tags": [
+ "BackupRestore"
+ ],
+ "responses": {
+ "200": {
+ "description": "A successful operation returns 200 status code and deletes the backup policy."
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/BackupRestore/BackupPolicies": {
+ "get": {
+ "operationId": "GetBackupPolicyList",
+ "summary": "Gets all the backup policies configured.",
+ "description": "Get a list of all the backup policies configured.",
+ "x-ms-examples": {
+ "Limit maximum results": {
+ "$ref": "./examples/GetBackupPolicyList-1.json"
+ },
+ "Page using continuation token": {
+ "$ref": "./examples/GetBackupPolicyList-2.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-4_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/ContinuationTokenOptionalQueryParam"
+ },
+ {
+ "$ref": "#/parameters/MaxResultsOptionalQueryParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "tags": [
+ "BackupRestore"
+ ],
+ "responses": {
+ "200": {
+ "description": "A successful operation will return 200 status code and paged list of backup policies.",
+ "schema": {
+ "$ref": "#/definitions/PagedBackupPolicyDescriptionList"
+ }
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/BackupRestore/BackupPolicies/{backupPolicyName}": {
+ "get": {
+ "operationId": "GetBackupPolicyByName",
+ "summary": "Gets a particular backup policy by name.",
+ "description": "Gets a particular backup policy identified by {backupPolicyName}",
+ "x-ms-examples": {
+ "Get backup policy by name": {
+ "$ref": "./examples/GetBackupPolicyByName.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/BackupPolicyNameRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/ApiVersion_6-4_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "tags": [
+ "BackupRestore"
+ ],
+ "responses": {
+ "200": {
+ "description": "A successful operation will return 200 status code and the backup policy description.",
+ "schema": {
+ "$ref": "#/definitions/BackupPolicyDescription"
+ }
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/BackupRestore/BackupPolicies/{backupPolicyName}/$/GetBackupEnabledEntities": {
+ "get": {
+ "operationId": "GetAllEntitiesBackedUpByPolicy",
+ "summary": "Gets the list of backup entities that are associated with this policy.",
+ "description": "Returns a list of Service Fabric application, service or partition which are associated with this backup policy.",
+ "x-ms-examples": {
+ "Limit maximum results": {
+ "$ref": "./examples/GetAllEntitiesBackedUpByPolicy-1.json"
+ },
+ "Page using continuation token": {
+ "$ref": "./examples/GetAllEntitiesBackedUpByPolicy-2.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/BackupPolicyNameRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/ApiVersion_6-4_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/ContinuationTokenOptionalQueryParam"
+ },
+ {
+ "$ref": "#/parameters/MaxResultsOptionalQueryParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "tags": [
+ "BackupRestore"
+ ],
+ "responses": {
+ "200": {
+ "description": "A successful operation will return 200 status code and a paged list of Service Fabric entities that are associated with this policy.",
+ "schema": {
+ "$ref": "#/definitions/PagedBackupEntityList"
+ }
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/BackupRestore/BackupPolicies/{backupPolicyName}/$/Update": {
+ "post": {
+ "operationId": "UpdateBackupPolicy",
+ "summary": "Updates the backup policy.",
+ "description": "Updates the backup policy identified by {backupPolicyName}",
+ "x-ms-examples": {
+ "Update backup policy": {
+ "$ref": "./examples/UpdateBackupPolicy.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/BackupPolicyDescriptionRequiredBodyParam"
+ },
+ {
+ "$ref": "#/parameters/BackupPolicyNameRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/ApiVersion_6-4_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "tags": [
+ "BackupRestore"
+ ],
+ "responses": {
+ "200": {
+ "description": "A successful operation returns 200 status code and updates the backup policy description."
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/Applications/{applicationId}/$/EnableBackup": {
+ "post": {
+ "operationId": "EnableApplicationBackup",
+ "summary": "Enables periodic backup of stateful partitions under this Service Fabric application.",
+ "description": "Enables periodic backup of stateful partitions which are part of this Service Fabric application. Each partition is backed up individually as per the specified backup policy description. \nNote only C# based Reliable Actor and Reliable Stateful services are currently supported for periodic backup.",
+ "x-ms-examples": {
+ "Enable application backup": {
+ "$ref": "./examples/EnableApplicationBackup.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApplicationIdRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/EnableBackupDescriptionRequiredBodyParam"
+ },
+ {
+ "$ref": "#/parameters/ApiVersion_6-4_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "tags": [
+ "BackupRestore"
+ ],
+ "responses": {
+ "202": {
+ "description": "A 202 status code indicates the request to enable application backup has been accepted."
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/Applications/{applicationId}/$/DisableBackup": {
+ "post": {
+ "operationId": "DisableApplicationBackup",
+ "summary": "Disables periodic backup of Service Fabric application.",
+ "description": "Disables periodic backup of Service Fabric application which was previously enabled.",
+ "x-ms-examples": {
+ "Disable application backup": {
+ "$ref": "./examples/DisableApplicationBackup.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApplicationIdRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/ApiVersion_6-4_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ },
+ {
+ "$ref": "#/parameters/DisableBackupDescriptionOptionalBodyParam"
+ }
+ ],
+ "tags": [
+ "BackupRestore"
+ ],
+ "responses": {
+ "202": {
+ "description": "A 202 status code indicates the request to disable application backup has been accepted."
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/Applications/{applicationId}/$/GetBackupConfigurationInfo": {
+ "get": {
+ "operationId": "GetApplicationBackupConfigurationInfo",
+ "summary": "Gets the Service Fabric application backup configuration information.",
+ "description": "Gets the Service Fabric backup configuration information for the application and the services and partitions under this application.",
+ "x-ms-examples": {
+ "Limit maximum results": {
+ "$ref": "./examples/GetApplicationBackupConfigurationInfo-1.json"
+ },
+ "Page using continuation token": {
+ "$ref": "./examples/GetApplicationBackupConfigurationInfo-2.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApplicationIdRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/ApiVersion_6-4_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/ContinuationTokenOptionalQueryParam"
+ },
+ {
+ "$ref": "#/parameters/MaxResultsOptionalQueryParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "tags": [
+ "BackupRestore"
+ ],
+ "responses": {
+ "200": {
+ "description": "A successful operation will return 200 status code and a paged list of backup configuration information for the application, and the services and partitions under this application, for which backup configuration has been overridden.",
+ "schema": {
+ "$ref": "#/definitions/PagedBackupConfigurationInfoList"
+ }
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/Applications/{applicationId}/$/GetBackups": {
+ "get": {
+ "operationId": "GetApplicationBackupList",
+ "summary": "Gets the list of backups available for every partition in this application.",
+ "description": "Returns a list of backups available for every partition in this Service Fabric application. The server enumerates all the backups available at the backup location configured in the backup policy. It also allows filtering of the result based on start and end datetime or just fetching the latest available backup for every partition.",
+ "x-ms-examples": {
+ "Get application backups within a time range": {
+ "$ref": "./examples/GetApplicationBackupList-1.json"
+ },
+ "Get latest backup": {
+ "$ref": "./examples/GetApplicationBackupList-2.json"
+ },
+ "Limit maximum results": {
+ "$ref": "./examples/GetApplicationBackupList-3.json"
+ },
+ "Page using continuation token": {
+ "$ref": "./examples/GetApplicationBackupList-4.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApplicationIdRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/ApiVersion_6-4_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ },
+ {
+ "$ref": "#/parameters/LatestOptionalQueryParam"
+ },
+ {
+ "$ref": "#/parameters/StartDateTimeFilterOptionalQueryParam"
+ },
+ {
+ "$ref": "#/parameters/EndDateTimeFilterOptionalQueryParam"
+ },
+ {
+ "$ref": "#/parameters/ContinuationTokenOptionalQueryParam"
+ },
+ {
+ "$ref": "#/parameters/MaxResultsOptionalQueryParam"
+ }
+ ],
+ "tags": [
+ "BackupRestore"
+ ],
+ "responses": {
+ "200": {
+ "description": "A successful operation will return 200 status code and a paged list of backup information.",
+ "schema": {
+ "$ref": "#/definitions/PagedBackupInfoList"
+ }
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/Applications/{applicationId}/$/SuspendBackup": {
+ "post": {
+ "operationId": "SuspendApplicationBackup",
+ "summary": "Suspends periodic backup for the specified Service Fabric application.",
+ "description": "The application which is configured to take periodic backups, is suspended for taking further backups till it is resumed again. This operation applies to the entire application's hierarchy. It means all the services and partitions under this application are now suspended for backup.",
+ "x-ms-examples": {
+ "Suspend application backup": {
+ "$ref": "./examples/SuspendApplicationBackup.json"
+ }
+ },
+ "tags": [
+ "BackupRestore"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApplicationIdRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/ApiVersion_6-4_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "responses": {
+ "202": {
+ "description": "A 202 status code indicates the operation request was accepted and application backup will be suspended."
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/Applications/{applicationId}/$/ResumeBackup": {
+ "post": {
+ "operationId": "ResumeApplicationBackup",
+ "summary": "Resumes periodic backup of a Service Fabric application which was previously suspended.",
+ "description": "The previously suspended Service Fabric application resumes taking periodic backup as per the backup policy currently configured for the same.",
+ "x-ms-examples": {
+ "Resume application backup": {
+ "$ref": "./examples/ResumeApplicationBackup.json"
+ }
+ },
+ "tags": [
+ "BackupRestore"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApplicationIdRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/ApiVersion_6-4_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "responses": {
+ "202": {
+ "description": "A 202 status code indicates the operation request was accepted and application backup will be resumed."
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/Services/{serviceId}/$/EnableBackup": {
+ "post": {
+ "operationId": "EnableServiceBackup",
+ "summary": "Enables periodic backup of stateful partitions under this Service Fabric service.",
+ "description": "Enables periodic backup of stateful partitions which are part of this Service Fabric service. Each partition is backed up individually as per the specified backup policy description. In case the application, which the service is part of, is already enabled for backup then this operation would override the policy being used to take the periodic backup for this service and its partitions (unless explicitly overridden at the partition level).\nNote only C# based Reliable Actor and Reliable Stateful services are currently supported for periodic backup.",
+ "x-ms-examples": {
+ "Enable service backup": {
+ "$ref": "./examples/EnableServiceBackup.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/ServiceIdRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/EnableBackupDescriptionRequiredBodyParam"
+ },
+ {
+ "$ref": "#/parameters/ApiVersion_6-4_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "tags": [
+ "BackupRestore"
+ ],
+ "responses": {
+ "202": {
+ "description": "A 202 status code indicates the request to enable service backup has been accepted."
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/Services/{serviceId}/$/DisableBackup": {
+ "post": {
+ "operationId": "DisableServiceBackup",
+ "summary": "Disables periodic backup of Service Fabric service which was previously enabled.",
+ "description": "Disables periodic backup of Service Fabric service which was previously enabled. Backup must be explicitly enabled before it can be disabled.\nIn case the backup is enabled for the Service Fabric application, which this service is part of, this service would continue to be periodically backed up as per the policy mapped at the application level.",
+ "x-ms-examples": {
+ "Disable service backup": {
+ "$ref": "./examples/DisableServiceBackup.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/ServiceIdRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/ApiVersion_6-4_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/DisableBackupDescriptionOptionalBodyParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "tags": [
+ "BackupRestore"
+ ],
+ "responses": {
+ "202": {
+ "description": "A 202 status code indicates the request to disable service backup has been accepted."
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/Services/{serviceId}/$/GetBackupConfigurationInfo": {
+ "get": {
+ "operationId": "GetServiceBackupConfigurationInfo",
+ "summary": "Gets the Service Fabric service backup configuration information.",
+ "description": "Gets the Service Fabric backup configuration information for the service and the partitions under this service.",
+ "x-ms-examples": {
+ "Limit maximum results": {
+ "$ref": "./examples/GetServiceBackupConfigurationInfo-1.json"
+ },
+ "Page using continuation token": {
+ "$ref": "./examples/GetServiceBackupConfigurationInfo-2.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/ServiceIdRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/ApiVersion_6-4_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/ContinuationTokenOptionalQueryParam"
+ },
+ {
+ "$ref": "#/parameters/MaxResultsOptionalQueryParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "tags": [
+ "BackupRestore"
+ ],
+ "responses": {
+ "200": {
+ "description": "A successful operation will return 200 status code and a paged list of backup configuration information for the service, and the partitions under this service, for which backup configuration has been overridden.",
+ "schema": {
+ "$ref": "#/definitions/PagedBackupConfigurationInfoList"
+ }
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/Services/{serviceId}/$/GetBackups": {
+ "get": {
+ "operationId": "GetServiceBackupList",
+ "summary": "Gets the list of backups available for every partition in this service.",
+ "description": "Returns a list of backups available for every partition in this Service Fabric service. The server enumerates all the backups available in the backup store configured in the backup policy. It also allows filtering of the result based on start and end datetime or just fetching the latest available backup for every partition.",
+ "x-ms-examples": {
+ "Get application backups within a time range": {
+ "$ref": "./examples/GetServiceBackupList-1.json"
+ },
+ "Get latest backup": {
+ "$ref": "./examples/GetServiceBackupList-2.json"
+ },
+ "Limit maximum results": {
+ "$ref": "./examples/GetServiceBackupList-3.json"
+ },
+ "Page using continuation token": {
+ "$ref": "./examples/GetServiceBackupList-4.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/ServiceIdRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/ApiVersion_6-4_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ },
+ {
+ "$ref": "#/parameters/LatestOptionalQueryParam"
+ },
+ {
+ "$ref": "#/parameters/StartDateTimeFilterOptionalQueryParam"
+ },
+ {
+ "$ref": "#/parameters/EndDateTimeFilterOptionalQueryParam"
+ },
+ {
+ "$ref": "#/parameters/ContinuationTokenOptionalQueryParam"
+ },
+ {
+ "$ref": "#/parameters/MaxResultsOptionalQueryParam"
+ }
+ ],
+ "tags": [
+ "BackupRestore"
+ ],
+ "responses": {
+ "200": {
+ "description": "A successful operation will return 200 status code and a paged list of backup information.",
+ "schema": {
+ "$ref": "#/definitions/PagedBackupInfoList"
+ }
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/Services/{serviceId}/$/SuspendBackup": {
+ "post": {
+ "operationId": "SuspendServiceBackup",
+ "summary": "Suspends periodic backup for the specified Service Fabric service.",
+ "description": "The service which is configured to take periodic backups, is suspended for taking further backups till it is resumed again. This operation applies to the entire service's hierarchy. It means all the partitions under this service are now suspended for backup.",
+ "x-ms-examples": {
+ "Suspend service backup": {
+ "$ref": "./examples/SuspendServiceBackup.json"
+ }
+ },
+ "tags": [
+ "BackupRestore"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/ServiceIdRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/ApiVersion_6-4_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "responses": {
+ "202": {
+ "description": "A 202 status code indicates the operation request was accepted and service backup will be suspended."
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/Services/{serviceId}/$/ResumeBackup": {
+ "post": {
+ "operationId": "ResumeServiceBackup",
+ "summary": "Resumes periodic backup of a Service Fabric service which was previously suspended.",
+ "description": "The previously suspended Service Fabric service resumes taking periodic backup as per the backup policy currently configured for the same.",
+ "x-ms-examples": {
+ "Resume service backup": {
+ "$ref": "./examples/ResumeServiceBackup.json"
+ }
+ },
+ "tags": [
+ "BackupRestore"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/ServiceIdRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/ApiVersion_6-4_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "responses": {
+ "202": {
+ "description": "A 202 status code indicates the operation request was accepted and service backup will be resumed."
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/Partitions/{partitionId}/$/EnableBackup": {
+ "post": {
+ "operationId": "EnablePartitionBackup",
+ "summary": "Enables periodic backup of the stateful persisted partition.",
+ "description": "Enables periodic backup of stateful persisted partition. Each partition is backed up as per the specified backup policy description. In case the application or service, which is partition is part of, is already enabled for backup then this operation would override the policy being used to take the periodic backup of this partition.\nNote only C# based Reliable Actor and Reliable Stateful services are currently supported for periodic backup.",
+ "x-ms-examples": {
+ "Enable partition backup": {
+ "$ref": "./examples/EnablePartitionBackup.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/PartitionIdRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/EnableBackupDescriptionRequiredBodyParam"
+ },
+ {
+ "$ref": "#/parameters/ApiVersion_6-4_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "tags": [
+ "BackupRestore"
+ ],
+ "responses": {
+ "202": {
+ "description": "A 202 status code indicates the request to enable partition backup has been accepted."
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/Partitions/{partitionId}/$/DisableBackup": {
+ "post": {
+ "operationId": "DisablePartitionBackup",
+ "summary": "Disables periodic backup of Service Fabric partition which was previously enabled.",
+ "description": "Disables periodic backup of partition which was previously enabled. Backup must be explicitly enabled before it can be disabled. \nIn case the backup is enabled for the Service Fabric application or service, which this partition is part of, this partition would continue to be periodically backed up as per the policy mapped at the higher level entity.",
+ "x-ms-examples": {
+ "Disable partition backup": {
+ "$ref": "./examples/DisablePartitionBackup.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/PartitionIdRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/ApiVersion_6-4_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/DisableBackupDescriptionOptionalBodyParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "tags": [
+ "BackupRestore"
+ ],
+ "responses": {
+ "202": {
+ "description": "A 202 status code indicates the request to disable partition backup has been accepted."
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/Partitions/{partitionId}/$/GetBackupConfigurationInfo": {
+ "get": {
+ "operationId": "GetPartitionBackupConfigurationInfo",
+ "summary": "Gets the partition backup configuration information",
+ "description": "Gets the Service Fabric Backup configuration information for the specified partition.",
+ "x-ms-examples": {
+ "Get partition backup configuration information": {
+ "$ref": "./examples/GetPartitionBackupConfigurationInfo.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/PartitionIdRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/ApiVersion_6-4_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "tags": [
+ "BackupRestore"
+ ],
+ "responses": {
+ "200": {
+ "description": "A successful operation will return 200 status code and gets the partition's backup configuration information.",
+ "schema": {
+ "$ref": "#/definitions/PartitionBackupConfigurationInfo"
+ }
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/Partitions/{partitionId}/$/GetBackups": {
+ "get": {
+ "operationId": "GetPartitionBackupList",
+ "summary": "Gets the list of backups available for the specified partition.",
+ "description": "Returns a list of backups available for the specified partition. The server enumerates all the backups available in the backup store configured in the backup policy. It also allows filtering of the result based on start and end datetime or just fetching the latest available backup for the partition.",
+ "x-ms-examples": {
+ "Get application backups within a time range": {
+ "$ref": "./examples/GetPartitionBackupList-1.json"
+ },
+ "Get latest backup": {
+ "$ref": "./examples/GetPartitionBackupList-2.json"
+ },
+ "Limit maximum results": {
+ "$ref": "./examples/GetPartitionBackupList-3.json"
+ },
+ "Page using continuation token": {
+ "$ref": "./examples/GetPartitionBackupList-4.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/PartitionIdRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/ApiVersion_6-4_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ },
+ {
+ "$ref": "#/parameters/LatestOptionalQueryParam"
+ },
+ {
+ "$ref": "#/parameters/StartDateTimeFilterOptionalQueryParam"
+ },
+ {
+ "$ref": "#/parameters/EndDateTimeFilterOptionalQueryParam"
+ }
+ ],
+ "tags": [
+ "BackupRestore"
+ ],
+ "responses": {
+ "200": {
+ "description": "A successful operation will return 200 status code and a paged list of backup information.",
+ "schema": {
+ "$ref": "#/definitions/PagedBackupInfoList"
+ }
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/Partitions/{partitionId}/$/SuspendBackup": {
+ "post": {
+ "operationId": "SuspendPartitionBackup",
+ "summary": "Suspends periodic backup for the specified partition.",
+ "description": "The partition which is configured to take periodic backups, is suspended for taking further backups till it is resumed again.",
+ "x-ms-examples": {
+ "Suspend partition backup": {
+ "$ref": "./examples/SuspendPartitionBackup.json"
+ }
+ },
+ "tags": [
+ "BackupRestore"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/PartitionIdRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/ApiVersion_6-4_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "responses": {
+ "202": {
+ "description": "A 202 status code indicates the operation request was accepted and partition backup will be suspended."
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/Partitions/{partitionId}/$/ResumeBackup": {
+ "post": {
+ "operationId": "ResumePartitionBackup",
+ "summary": "Resumes periodic backup of partition which was previously suspended.",
+ "description": "The previously suspended partition resumes taking periodic backup as per the backup policy currently configured for the same.",
+ "x-ms-examples": {
+ "Resume partition backup": {
+ "$ref": "./examples/ResumePartitionBackup.json"
+ }
+ },
+ "tags": [
+ "BackupRestore"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/PartitionIdRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/ApiVersion_6-4_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "responses": {
+ "202": {
+ "description": "A 202 status code indicates the operation request was accepted and partition backup will be resumed."
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/Partitions/{partitionId}/$/Backup": {
+ "post": {
+ "operationId": "BackupPartition",
+ "summary": "Triggers backup of the partition's state.",
+ "description": "Creates a backup of the stateful persisted partition's state. In case the partition is already being periodically backed up, then by default the new backup is created at the same backup storage. One can also override the same by specifying the backup storage details as part of the request body. Once the backup is initiated, its progress can be tracked using the GetBackupProgress operation. \nIn case, the operation times out, specify a greater backup timeout value in the query parameter.",
+ "x-ms-examples": {
+ "Backup partition": {
+ "$ref": "./examples/BackupPartition-1.json"
+ },
+ "Backup partition to a specific Azure storage account": {
+ "$ref": "./examples/BackupPartition-2.json"
+ },
+ "Backup partition to a specific on-premise file share": {
+ "$ref": "./examples/BackupPartition-3.json"
+ }
+ },
+ "tags": [
+ "BackupRestore"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/PartitionIdRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/BackupPartitionDescriptionOptionalBodyParam"
+ },
+ {
+ "$ref": "#/parameters/BackupTimeoutOptionalQueryParam"
+ },
+ {
+ "$ref": "#/parameters/ApiVersion_6-4_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "responses": {
+ "202": {
+ "description": "A 202 status code indicates the operation request was accepted and backup will be initiated. Use GetPartitionBackupProgress operation to get the status of the backup operation."
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/Partitions/{partitionId}/$/GetBackupProgress": {
+ "get": {
+ "operationId": "GetPartitionBackupProgress",
+ "summary": "Gets details for the latest backup triggered for this partition.",
+ "description": "Returns information about the state of the latest backup along with details or failure reason in case of completion.",
+ "x-ms-examples": {
+ "Get backup operation progress": {
+ "$ref": "./examples/GetPartitionBackupProgress.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/PartitionIdRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/ApiVersion_6-4_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "tags": [
+ "BackupRestore"
+ ],
+ "responses": {
+ "200": {
+ "description": "A successful operation returns 200 status code and backup progress details.",
+ "schema": {
+ "$ref": "#/definitions/BackupProgressInfo"
+ }
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/Partitions/{partitionId}/$/Restore": {
+ "post": {
+ "operationId": "RestorePartition",
+ "summary": "Triggers restore of the state of the partition using the specified restore partition description.",
+ "description": "Restores the state of a of the stateful persisted partition using the specified backup point. In case the partition is already being periodically backed up, then by default the backup point is looked for in the storage specified in backup policy. One can also override the same by specifying the backup storage details as part of the restore partition description in body. Once the restore is initiated, its progress can be tracked using the GetRestoreProgress operation. \nIn case, the operation times out, specify a greater restore timeout value in the query parameter.",
+ "x-ms-examples": {
+ "Trigger partition restore": {
+ "$ref": "./examples/RestorePartition.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/PartitionIdRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/RestorePartitionDescriptionRequiredBodyParam"
+ },
+ {
+ "$ref": "#/parameters/RestoreTimeoutOptionalQueryParam"
+ },
+ {
+ "$ref": "#/parameters/ApiVersion_6-4_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "tags": [
+ "BackupRestore"
+ ],
+ "responses": {
+ "202": {
+ "description": "A 202 status code indicates the operation request was accepted and restore will be initiated. Use GetPartitionRestoreProgress operation to get the status of the restore operation."
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/Partitions/{partitionId}/$/GetRestoreProgress": {
+ "get": {
+ "operationId": "GetPartitionRestoreProgress",
+ "summary": "Gets details for the latest restore operation triggered for this partition.",
+ "description": "Returns information about the state of the latest restore operation along with details or failure reason in case of completion.",
+ "x-ms-examples": {
+ "Get restore operation progress": {
+ "$ref": "./examples/GetPartitionRestoreProgress.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/PartitionIdRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/ApiVersion_6-4_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "tags": [
+ "BackupRestore"
+ ],
+ "responses": {
+ "200": {
+ "description": "A successful operation returns 200 status code and restore progress details.",
+ "schema": {
+ "$ref": "#/definitions/RestoreProgressInfo"
+ }
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/BackupRestore/$/GetBackups": {
+ "post": {
+ "operationId": "GetBackupsFromBackupLocation",
+ "summary": "Gets the list of backups available for the specified backed up entity at the specified backup location.",
+ "description": "Gets the list of backups available for the specified backed up entity (Application, Service or Partition) at the specified backup location (FileShare or Azure Blob Storage).",
+ "x-ms-examples": {
+ "Limit maximum results": {
+ "$ref": "./examples/GetBackupsFromBackupLocation-1.json"
+ },
+ "Page using continuation token": {
+ "$ref": "./examples/GetBackupsFromBackupLocation-2.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-4_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ },
+ {
+ "$ref": "#/parameters/ContinuationTokenOptionalQueryParam"
+ },
+ {
+ "$ref": "#/parameters/MaxResultsOptionalQueryParam"
+ },
+ {
+ "$ref": "#/parameters/GetBackupByStorageQueryDescriptionRequiredBodyParam"
+ }
+ ],
+ "tags": [
+ "BackupRestore"
+ ],
+ "responses": {
+ "200": {
+ "description": "A successful operation will return 200 status code and a paged list of backup information.",
+ "schema": {
+ "$ref": "#/definitions/PagedBackupInfoList"
+ }
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/Names/$/Create": {
+ "post": {
+ "summary": "Creates a Service Fabric name.",
+ "description": "Creates the specified Service Fabric name.",
+ "operationId": "CreateName",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/NameDescriptionRequiredBodyParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "x-ms-examples": {
+ "Create new name": {
+ "$ref": "examples/CreateName-1.json"
+ }
+ },
+ "tags": [
+ "Property Management"
+ ],
+ "responses": {
+ "201": {
+ "description": "A successful response means that the name has been created."
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/Names/{nameId}": {
+ "get": {
+ "summary": "Returns whether the Service Fabric name exists.",
+ "description": "Returns whether the specified Service Fabric name exists.",
+ "operationId": "GetNameExistsInfo",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/NameIdRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "tags": [
+ "Property Management"
+ ],
+ "responses": {
+ "200": {
+ "description": "A successful response means that the Service Fabric name exists."
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ },
+ "delete": {
+ "summary": "Deletes a Service Fabric name.",
+ "description": "Deletes the specified Service Fabric name. A name must be created before it can be deleted. Deleting a name with child properties will fail.",
+ "operationId": "DeleteName",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/NameIdRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "tags": [
+ "Property Management"
+ ],
+ "responses": {
+ "200": {
+ "description": "A successful response means that the Service Fabric name has been deleted."
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/Names/{nameId}/$/GetSubNames": {
+ "get": {
+ "summary": "Enumerates all the Service Fabric names under a given name.",
+ "description": "Enumerates all the Service Fabric names under a given name. If the subnames do not fit in a page, one page of results is returned as well as a continuation token, which can be used to get the next page. Querying a name that doesn't exist will fail.",
+ "operationId": "GetSubNameInfoList",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/NameIdRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/RecursiveOptionalQueryParam"
+ },
+ {
+ "$ref": "#/parameters/ContinuationTokenOptionalQueryParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "x-ms-examples": {
+ "Get sub names": {
+ "$ref": "examples/GetSubNameInfoList-1.json"
+ },
+ "Recursively search sub names": {
+ "$ref": "examples/GetSubNameInfoList-2.json"
+ },
+ "Page using continuation token": {
+ "$ref": "examples/GetSubNameInfoList-3.json"
+ }
+ },
+ "tags": [
+ "Property Management"
+ ],
+ "responses": {
+ "200": {
+ "description": "A paged list of Service Fabric names.",
+ "schema": {
+ "$ref": "#/definitions/PagedSubNameInfoList"
+ }
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/Names/{nameId}/$/GetProperties": {
+ "get": {
+ "summary": "Gets information on all Service Fabric properties under a given name.",
+ "description": "A Service Fabric name can have one or more named properties that store custom information. This operation gets the information about these properties in a paged list. The information includes name, value, and metadata about each of the properties.",
+ "operationId": "GetPropertyInfoList",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/NameIdRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/IncludeValuesOptionalQueryParam"
+ },
+ {
+ "$ref": "#/parameters/ContinuationTokenOptionalQueryParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "x-ms-examples": {
+ "Get property info list": {
+ "$ref": "examples/GetPropertyInfoList-1.json"
+ },
+ "Get property info list with values": {
+ "$ref": "examples/GetPropertyInfoList-2.json"
+ },
+ "Page using continuation token": {
+ "$ref": "examples/GetPropertyInfoList-3.json"
+ }
+ },
+ "tags": [
+ "Property Management"
+ ],
+ "responses": {
+ "200": {
+ "description": "A paged list of Service Fabric properties.",
+ "schema": {
+ "$ref": "#/definitions/PagedPropertyInfoList"
+ }
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/Names/{nameId}/$/GetProperty": {
+ "put": {
+ "summary": "Creates or updates a Service Fabric property.",
+ "description": "Creates or updates the specified Service Fabric property under a given name.",
+ "operationId": "PutProperty",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/NameIdRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/PropertyDescriptionRequiredBodyParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "x-ms-examples": {
+ "Put property": {
+ "$ref": "examples/PutProperty-1.json"
+ },
+ "Put custom property": {
+ "$ref": "examples/PutProperty-2.json"
+ }
+ },
+ "tags": [
+ "Property Management"
+ ],
+ "responses": {
+ "200": {
+ "description": "A successful response means that the property has been created or updated."
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ },
+ "get": {
+ "summary": "Gets the specified Service Fabric property.",
+ "description": "Gets the specified Service Fabric property under a given name. This will always return both value and metadata.",
+ "operationId": "GetPropertyInfo",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/NameIdRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/PropertyNameRequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "x-ms-examples": {
+ "Get property info": {
+ "$ref": "examples/GetPropertyInfo-1.json"
+ }
+ },
+ "tags": [
+ "Property Management"
+ ],
+ "responses": {
+ "200": {
+ "description": "Details on the Service Fabric property.",
+ "schema": {
+ "$ref": "#/definitions/PropertyInfo"
+ }
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ },
+ "delete": {
+ "summary": "Deletes the specified Service Fabric property.",
+ "description": "Deletes the specified Service Fabric property under a given name. A property must be created before it can be deleted.",
+ "operationId": "DeleteProperty",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/NameIdRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/PropertyNameRequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "tags": [
+ "Property Management"
+ ],
+ "responses": {
+ "200": {
+ "description": "A successful response means that the property has been deleted."
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/Names/{nameId}/$/GetProperties/$/SubmitBatch": {
+ "post": {
+ "summary": "Submits a property batch.",
+ "description": "Submits a batch of property operations. Either all or none of the operations will be committed.",
+ "operationId": "SubmitPropertyBatch",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/NameIdRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/PropertyBatchDescriptionListRequiredBodyParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "x-ms-examples": {
+ "Property batch operation": {
+ "$ref": "examples/SubmitPropertyBatch-1.json"
+ }
+ },
+ "tags": [
+ "Property Management"
+ ],
+ "responses": {
+ "200": {
+ "description": "A successful response means that the property batch succeeded.",
+ "schema": {
+ "$ref": "#/definitions/SuccessfulPropertyBatchInfo"
+ }
+ },
+ "409": {
+ "description": "A 409 response means that one of the property batch operations failed, and contains more information about the failure. None of the operations were committed.",
+ "schema": {
+ "$ref": "#/definitions/FailedPropertyBatchInfo"
+ }
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/EventsStore/Cluster/Events": {
+ "get": {
+ "summary": "Gets all Cluster-related events.",
+ "description": "The response is list of ClusterEvent objects.",
+ "operationId": "GetClusterEventList",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-4_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ },
+ {
+ "$ref": "#/parameters/StartTimeUtcRequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/EndTimeUtcRequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/EventsTypesFilterOptionalQueryParam"
+ },
+ {
+ "$ref": "#/parameters/ExcludeAnalysisEventsOptionalQueryParam"
+ },
+ {
+ "$ref": "#/parameters/SkipCorrelationLookupOptionalQueryParam"
+ }
+ ],
+ "tags": [
+ "EventsStore"
+ ],
+ "x-ms-examples": {
+ "Get Cluster-related events": {
+ "$ref": "./examples/GetClusterEventList.json"
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "List of events objects with base type ClusterEvent.",
+ "schema": {
+ "$ref": "#/definitions/ClusterEventList"
+ }
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/EventsStore/Containers/Events": {
+ "get": {
+ "summary": "Gets all Containers-related events.",
+ "description": "The response is list of ContainerInstanceEvent objects.",
+ "operationId": "GetContainersEventList",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-2-Preview_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ },
+ {
+ "$ref": "#/parameters/StartTimeUtcRequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/EndTimeUtcRequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/EventsTypesFilterOptionalQueryParam"
+ },
+ {
+ "$ref": "#/parameters/ExcludeAnalysisEventsOptionalQueryParam"
+ },
+ {
+ "$ref": "#/parameters/SkipCorrelationLookupOptionalQueryParam"
+ }
+ ],
+ "tags": [
+ "EventsStore"
+ ],
+ "responses": {
+ "200": {
+ "description": "List of events objects with base type ContainerInstanceEvent.",
+ "schema": {
+ "$ref": "#/definitions/ContainerInstanceEventList"
+ }
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/EventsStore/Nodes/{nodeName}/$/Events": {
+ "get": {
+ "summary": "Gets a Node-related events.",
+ "description": "The response is list of NodeEvent objects.",
+ "operationId": "GetNodeEventList",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-4_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/NodeNameRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ },
+ {
+ "$ref": "#/parameters/StartTimeUtcRequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/EndTimeUtcRequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/EventsTypesFilterOptionalQueryParam"
+ },
+ {
+ "$ref": "#/parameters/ExcludeAnalysisEventsOptionalQueryParam"
+ },
+ {
+ "$ref": "#/parameters/SkipCorrelationLookupOptionalQueryParam"
+ }
+ ],
+ "tags": [
+ "EventsStore"
+ ],
+ "x-ms-examples": {
+ "Get Node-related events": {
+ "$ref": "./examples/GetNodeEventList.json"
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "List of events objects with base type NodeEvent.",
+ "schema": {
+ "$ref": "#/definitions/NodeEventList"
+ }
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/EventsStore/Nodes/Events": {
+ "get": {
+ "summary": "Gets all Nodes-related Events.",
+ "description": "The response is list of NodeEvent objects.",
+ "operationId": "GetNodesEventList",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-4_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ },
+ {
+ "$ref": "#/parameters/StartTimeUtcRequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/EndTimeUtcRequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/EventsTypesFilterOptionalQueryParam"
+ },
+ {
+ "$ref": "#/parameters/ExcludeAnalysisEventsOptionalQueryParam"
+ },
+ {
+ "$ref": "#/parameters/SkipCorrelationLookupOptionalQueryParam"
+ }
+ ],
+ "tags": [
+ "EventsStore"
+ ],
+ "x-ms-examples": {
+ "Get Nodes-related events": {
+ "$ref": "./examples/GetNodesEventList.json"
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "List of events objects with base type NodeEvent.",
+ "schema": {
+ "$ref": "#/definitions/NodeEventList"
+ }
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/EventsStore/Applications/{applicationId}/$/Events": {
+ "get": {
+ "summary": "Gets an Application-related events.",
+ "description": "The response is list of ApplicationEvent objects.",
+ "operationId": "GetApplicationEventList",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-4_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/ApplicationIdRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ },
+ {
+ "$ref": "#/parameters/StartTimeUtcRequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/EndTimeUtcRequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/EventsTypesFilterOptionalQueryParam"
+ },
+ {
+ "$ref": "#/parameters/ExcludeAnalysisEventsOptionalQueryParam"
+ },
+ {
+ "$ref": "#/parameters/SkipCorrelationLookupOptionalQueryParam"
+ }
+ ],
+ "tags": [
+ "EventsStore"
+ ],
+ "x-ms-examples": {
+ "Get Application-related events": {
+ "$ref": "./examples/GetApplicationEventList.json"
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "List of events objects with base type ApplicationEvent.",
+ "schema": {
+ "$ref": "#/definitions/ApplicationEventList"
+ }
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/EventsStore/Applications/Events": {
+ "get": {
+ "summary": "Gets all Applications-related events.",
+ "description": "The response is list of ApplicationEvent objects.",
+ "operationId": "GetApplicationsEventList",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-4_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ },
+ {
+ "$ref": "#/parameters/StartTimeUtcRequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/EndTimeUtcRequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/EventsTypesFilterOptionalQueryParam"
+ },
+ {
+ "$ref": "#/parameters/ExcludeAnalysisEventsOptionalQueryParam"
+ },
+ {
+ "$ref": "#/parameters/SkipCorrelationLookupOptionalQueryParam"
+ }
+ ],
+ "tags": [
+ "EventsStore"
+ ],
+ "x-ms-examples": {
+ "Get Applications-related events": {
+ "$ref": "./examples/GetApplicationsEventList.json"
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "List of events objects with base type ApplicationEvent.",
+ "schema": {
+ "$ref": "#/definitions/ApplicationEventList"
+ }
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/EventsStore/Services/{serviceId}/$/Events": {
+ "get": {
+ "summary": "Gets a Service-related events.",
+ "description": "The response is list of ServiceEvent objects.",
+ "operationId": "GetServiceEventList",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-4_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/ServiceIdRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ },
+ {
+ "$ref": "#/parameters/StartTimeUtcRequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/EndTimeUtcRequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/EventsTypesFilterOptionalQueryParam"
+ },
+ {
+ "$ref": "#/parameters/ExcludeAnalysisEventsOptionalQueryParam"
+ },
+ {
+ "$ref": "#/parameters/SkipCorrelationLookupOptionalQueryParam"
+ }
+ ],
+ "tags": [
+ "EventsStore"
+ ],
+ "x-ms-examples": {
+ "Get Service-related events": {
+ "$ref": "./examples/GetServiceEventList.json"
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "List of events objects with base type ServiceEvent.",
+ "schema": {
+ "$ref": "#/definitions/ServiceEventList"
+ }
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/EventsStore/Services/Events": {
+ "get": {
+ "summary": "Gets all Services-related events.",
+ "description": "The response is list of ServiceEvent objects.",
+ "operationId": "GetServicesEventList",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-4_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ },
+ {
+ "$ref": "#/parameters/StartTimeUtcRequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/EndTimeUtcRequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/EventsTypesFilterOptionalQueryParam"
+ },
+ {
+ "$ref": "#/parameters/ExcludeAnalysisEventsOptionalQueryParam"
+ },
+ {
+ "$ref": "#/parameters/SkipCorrelationLookupOptionalQueryParam"
+ }
+ ],
+ "tags": [
+ "EventsStore"
+ ],
+ "x-ms-examples": {
+ "Get Services-related events": {
+ "$ref": "./examples/GetServicesEventList.json"
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "List of events objects with base type ServiceEvent.",
+ "schema": {
+ "$ref": "#/definitions/ServiceEventList"
+ }
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/EventsStore/Partitions/{partitionId}/$/Events": {
+ "get": {
+ "summary": "Gets a Partition-related events.",
+ "description": "The response is list of PartitionEvent objects.",
+ "operationId": "GetPartitionEventList",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-4_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/PartitionIdRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ },
+ {
+ "$ref": "#/parameters/StartTimeUtcRequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/EndTimeUtcRequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/EventsTypesFilterOptionalQueryParam"
+ },
+ {
+ "$ref": "#/parameters/ExcludeAnalysisEventsOptionalQueryParam"
+ },
+ {
+ "$ref": "#/parameters/SkipCorrelationLookupOptionalQueryParam"
+ }
+ ],
+ "tags": [
+ "EventsStore"
+ ],
+ "x-ms-examples": {
+ "Get Partition-related events": {
+ "$ref": "./examples/GetPartitionEventList.json"
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "List of events objects with base type PartitionEvent.",
+ "schema": {
+ "$ref": "#/definitions/PartitionEventList"
+ }
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/EventsStore/Partitions/Events": {
+ "get": {
+ "summary": "Gets all Partitions-related events.",
+ "description": "The response is list of PartitionEvent objects.",
+ "operationId": "GetPartitionsEventList",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-4_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ },
+ {
+ "$ref": "#/parameters/StartTimeUtcRequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/EndTimeUtcRequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/EventsTypesFilterOptionalQueryParam"
+ },
+ {
+ "$ref": "#/parameters/ExcludeAnalysisEventsOptionalQueryParam"
+ },
+ {
+ "$ref": "#/parameters/SkipCorrelationLookupOptionalQueryParam"
+ }
+ ],
+ "tags": [
+ "EventsStore"
+ ],
+ "x-ms-examples": {
+ "Get Partitions-related events": {
+ "$ref": "./examples/GetPartitionsEventList.json"
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "List of events objects with base type PartitionEvent.",
+ "schema": {
+ "$ref": "#/definitions/PartitionEventList"
+ }
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/EventsStore/Partitions/{partitionId}/$/Replicas/{replicaId}/$/Events": {
+ "get": {
+ "summary": "Gets a Partition Replica-related events.",
+ "description": "The response is list of ReplicaEvent objects.",
+ "operationId": "GetPartitionReplicaEventList",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-4_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/PartitionIdRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/ReplicaIdRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ },
+ {
+ "$ref": "#/parameters/StartTimeUtcRequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/EndTimeUtcRequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/EventsTypesFilterOptionalQueryParam"
+ },
+ {
+ "$ref": "#/parameters/ExcludeAnalysisEventsOptionalQueryParam"
+ },
+ {
+ "$ref": "#/parameters/SkipCorrelationLookupOptionalQueryParam"
+ }
+ ],
+ "tags": [
+ "EventsStore"
+ ],
+ "x-ms-examples": {
+ "Get Partition Replica-related events": {
+ "$ref": "./examples/GetReplicaEventList.json"
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "List of events objects with base type ReplicaEvent.",
+ "schema": {
+ "$ref": "#/definitions/ReplicaEventList"
+ }
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/EventsStore/Partitions/{partitionId}/$/Replicas/Events": {
+ "get": {
+ "summary": "Gets all Replicas-related events for a Partition.",
+ "description": "The response is list of ReplicaEvent objects.",
+ "operationId": "GetPartitionReplicasEventList",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-4_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/PartitionIdRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ },
+ {
+ "$ref": "#/parameters/StartTimeUtcRequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/EndTimeUtcRequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/EventsTypesFilterOptionalQueryParam"
+ },
+ {
+ "$ref": "#/parameters/ExcludeAnalysisEventsOptionalQueryParam"
+ },
+ {
+ "$ref": "#/parameters/SkipCorrelationLookupOptionalQueryParam"
+ }
+ ],
+ "tags": [
+ "EventsStore"
+ ],
+ "x-ms-examples": {
+ "Get Partition Replicas-related events": {
+ "$ref": "./examples/GetReplicasEventList.json"
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "List of events objects with base type ReplicaEvent.",
+ "schema": {
+ "$ref": "#/definitions/ReplicaEventList"
+ }
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/EventsStore/CorrelatedEvents/{eventInstanceId}/$/Events": {
+ "get": {
+ "summary": "Gets all correlated events for a given event.",
+ "description": "The response is list of FabricEvents.",
+ "operationId": "GetCorrelatedEventList",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-4_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/EventInstanceIdRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/TimeoutOptionalQueryParam"
+ }
+ ],
+ "tags": [
+ "EventsStore"
+ ],
+ "x-ms-examples": {
+ "Get Correlated events": {
+ "$ref": "./examples/GetCorrelatedEventList.json"
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "List of events objects with base type FabricEvent.",
+ "schema": {
+ "$ref": "#/definitions/EventList"
+ }
+ },
+ "default": {
+ "description": "The detailed error response.",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/Resources/Secrets/{secretResourceName}": {
+ "put": {
+ "operationId": "MeshSecret_CreateOrUpdate",
+ "x-ms-examples": {
+ "CreateOrUpdateMeshSecret": {
+ "$ref": "./examples/Resources/Secrets/create_update.json"
+ }
+ },
+ "summary": "Creates or updates a Secret resource.",
+ "description": "Creates a Secret resource with the specified name, description and properties. If Secret resource with the same name exists, then it is updated with the specified description and properties. Once created, the kind and contentType of a secret resource cannot be updated.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-4-Preview_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/SecretResourceNameRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/SecretResourceDescriptionRequiredBodyParam"
+ }
+ ],
+ "tags": [
+ "MeshSecrets"
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/SecretResourceDescription"
+ }
+ },
+ "201": {
+ "description": "Created",
+ "schema": {
+ "$ref": "#/definitions/SecretResourceDescription"
+ }
+ },
+ "202": {
+ "description": "Accepted"
+ },
+ "default": {
+ "description": "Error",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ },
+ "get": {
+ "operationId": "MeshSecret_Get",
+ "x-ms-examples": {
+ "GetSecretResource": {
+ "$ref": "./examples/Resources/Secrets/get.json"
+ }
+ },
+ "summary": "Gets the Secret resource with the given name.",
+ "description": "Gets the information about the Secret resource with the given name. The information include the description and other properties of the Secret.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-4-Preview_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/SecretResourceNameRequiredPathParam"
+ }
+ ],
+ "tags": [
+ "MeshSecrets"
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/SecretResourceDescription"
+ }
+ },
+ "default": {
+ "description": "Error",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ },
+ "delete": {
+ "operationId": "MeshSecret_Delete",
+ "x-ms-examples": {
+ "DeleteSecretResource": {
+ "$ref": "./examples/Resources/Secrets/delete.json"
+ }
+ },
+ "summary": "Deletes the Secret resource.",
+ "description": "Deletes the specified Secret resource and all of its named values.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-4-Preview_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/SecretResourceNameRequiredPathParam"
+ }
+ ],
+ "tags": [
+ "MeshSecrets"
+ ],
+ "responses": {
+ "200": {
+ "description": "OK"
+ },
+ "202": {
+ "description": "Accepted"
+ },
+ "204": {
+ "description": "No Content - the specified secret was not found."
+ },
+ "default": {
+ "description": "Error",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/Resources/Secrets": {
+ "get": {
+ "operationId": "MeshSecret_List",
+ "x-ms-examples": {
+ "ListMeshSecrets": {
+ "$ref": "./examples/Resources/Secrets/list.json"
+ }
+ },
+ "summary": "Lists all the secret resources.",
+ "description": "Gets the information about all secret resources in a given resource group. The information include the description and other properties of the Secret.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-4-Preview_RequiredQueryParam"
+ }
+ ],
+ "tags": [
+ "MeshSecrets"
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/PagedSecretResourceDescriptionList"
+ }
+ },
+ "default": {
+ "description": "Error",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/Resources/Secrets/{secretResourceName}/values/{secretValueResourceName}": {
+ "put": {
+ "operationId": "MeshSecretValue_AddValue",
+ "x-ms-examples": {
+ "CreateMeshSecretValue": {
+ "$ref": "./examples/Resources/Secrets/values/create.json"
+ }
+ },
+ "summary": "Adds the specified value as a new version of the specified secret resource.",
+ "description": "Creates a new value of the specified secret resource. The name of the value is typically the version identifier. Once created the value cannot be changed.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-4-Preview_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/SecretResourceNameRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/SecretValueResourceNameRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/SecretValueResourceDescriptionRequiredBodyParam"
+ }
+ ],
+ "tags": [
+ "MeshSecretValues"
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/SecretValueResourceDescription"
+ }
+ },
+ "201": {
+ "description": "Created",
+ "schema": {
+ "$ref": "#/definitions/SecretValueResourceDescription"
+ }
+ },
+ "202": {
+ "description": "Accepted"
+ },
+ "default": {
+ "description": "Error",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ },
+ "get": {
+ "operationId": "MeshSecretValue_Get",
+ "x-ms-examples": {
+ "GetMeshSecretValue": {
+ "$ref": "./examples/Resources/Secrets/values/get.json"
+ }
+ },
+ "summary": "Gets the specified secret value resource.",
+ "description": "Get the information about the specified named secret value resources. The information does not include the actual value of the secret.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-4-Preview_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/SecretResourceNameRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/SecretValueResourceNameRequiredPathParam"
+ }
+ ],
+ "tags": [
+ "MeshSecretValues"
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/SecretValueResourceDescription"
+ }
+ },
+ "default": {
+ "description": "Error",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ },
+ "delete": {
+ "operationId": "MeshSecretValue_Delete",
+ "x-ms-examples": {
+ "DeleteSecretValue": {
+ "$ref": "./examples/Resources/Secrets/values/delete.json"
+ }
+ },
+ "summary": "Deletes the specified value of the named secret resource.",
+ "description": "Deletes the secret value resource identified by the name. The name of the resource is typically the version associated with that value. Deletion will fail if the specified value is in use.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-4-Preview_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/SecretResourceNameRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/SecretValueResourceNameRequiredPathParam"
+ }
+ ],
+ "tags": [
+ "MeshSecretValues"
+ ],
+ "responses": {
+ "200": {
+ "description": "OK"
+ },
+ "202": {
+ "description": "Accepted"
+ },
+ "204": {
+ "description": "No Content - the specified secret value was not found."
+ },
+ "default": {
+ "description": "Error",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/Resources/Secrets/{secretResourceName}/values": {
+ "get": {
+ "operationId": "MeshSecretValue_List",
+ "x-ms-examples": {
+ "ListMeshSecretValues": {
+ "$ref": "./examples/Resources/Secrets/values/list.json"
+ }
+ },
+ "summary": "List names of all values of the specified secret resource.",
+ "description": "Gets information about all secret value resources of the specified secret resource. The information includes the names of the secret value resources, but not the actual values.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-4-Preview_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/SecretResourceNameRequiredPathParam"
+ }
+ ],
+ "tags": [
+ "MeshSecretValues"
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/PagedSecretValueResourceDescriptionList"
+ }
+ },
+ "default": {
+ "description": "Error",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/Resources/Secrets/{secretResourceName}/values/{secretValueResourceName}/list_value": {
+ "post": {
+ "operationId": "MeshSecretValue_Show",
+ "x-ms-examples": {
+ "ListMeshSecretValue": {
+ "$ref": "./examples/Resources/Secrets/values/list_value.json"
+ }
+ },
+ "summary": "Lists the specified value of the secret resource.",
+ "description": "Lists the decrypted value of the specified named value of the secret resource. This is a privileged operation.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-4-Preview_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/SecretResourceNameRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/SecretValueResourceNameRequiredPathParam"
+ }
+ ],
+ "tags": [
+ "MeshSecretValues"
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/SecretValue"
+ }
+ },
+ "default": {
+ "description": "Error",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/Resources/Volumes/{volumeResourceName}": {
+ "put": {
+ "operationId": "MeshVolume_CreateOrUpdate",
+ "x-ms-examples": {
+ "CreateOrUpdateMeshVolume": {
+ "$ref": "./examples/Resources/Volumes/create_update.json"
+ }
+ },
+ "summary": "Creates or updates a Volume resource.",
+ "description": "Creates a Volume resource with the specified name, description and properties. If Volume resource with the same name exists, then it is updated with the specified description and properties.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-4-Preview_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/VolumeResourceNameRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/VolumeResourceDescriptionRequiredBodyParam"
+ }
+ ],
+ "tags": [
+ "MeshVolumes"
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/VolumeResourceDescription"
+ }
+ },
+ "201": {
+ "description": "Created",
+ "schema": {
+ "$ref": "#/definitions/VolumeResourceDescription"
+ }
+ },
+ "202": {
+ "description": "Accepted"
+ },
+ "default": {
+ "description": "Error",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ },
+ "get": {
+ "operationId": "MeshVolume_Get",
+ "x-ms-examples": {
+ "GetVolumeResource": {
+ "$ref": "./examples/Resources/Volumes/get.json"
+ }
+ },
+ "summary": "Gets the Volume resource with the given name.",
+ "description": "Gets the information about the Volume resource with the given name. The information include the description and other properties of the Volume.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-4-Preview_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/VolumeResourceNameRequiredPathParam"
+ }
+ ],
+ "tags": [
+ "MeshVolumes"
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/VolumeResourceDescription"
+ }
+ },
+ "default": {
+ "description": "Error",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ },
+ "delete": {
+ "operationId": "MeshVolume_Delete",
+ "x-ms-examples": {
+ "DeleteVolumeResource": {
+ "$ref": "./examples/Resources/Volumes/delete.json"
+ }
+ },
+ "summary": "Deletes the Volume resource.",
+ "description": "Deletes the Volume resource identified by the name.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-4-Preview_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/VolumeResourceNameRequiredPathParam"
+ }
+ ],
+ "tags": [
+ "MeshVolumes"
+ ],
+ "responses": {
+ "200": {
+ "description": "OK"
+ },
+ "202": {
+ "description": "Accepted"
+ },
+ "204": {
+ "description": "No Content - the specified volume was not found."
+ },
+ "default": {
+ "description": "Error",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/Resources/Volumes": {
+ "get": {
+ "operationId": "MeshVolume_List",
+ "x-ms-examples": {
+ "ListMeshVolumes": {
+ "$ref": "./examples/Resources/Volumes/list.json"
+ }
+ },
+ "summary": "Lists all the volume resources.",
+ "description": "Gets the information about all volume resources in a given resource group. The information include the description and other properties of the Volume.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-4-Preview_RequiredQueryParam"
+ }
+ ],
+ "tags": [
+ "MeshVolumes"
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/PagedVolumeResourceDescriptionList"
+ }
+ },
+ "default": {
+ "description": "Error",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/Resources/Networks/{networkResourceName}": {
+ "put": {
+ "operationId": "MeshNetwork_CreateOrUpdate",
+ "x-ms-examples": {
+ "CreateOrUpdateMeshNetwork": {
+ "$ref": "./examples/Resources/Networks/create_update.json"
+ }
+ },
+ "summary": "Creates or updates a Network resource.",
+ "description": "Creates a Network resource with the specified name, description and properties. If Network resource with the same name exists, then it is updated with the specified description and properties. Network resource provides connectivity between application services.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-4-Preview_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/NetworkResourceNameRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/NetworkResourceDescriptionRequiredBodyParam"
+ }
+ ],
+ "tags": [
+ "MeshNetworks"
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/NetworkResourceDescription"
+ }
+ },
+ "201": {
+ "description": "Created",
+ "schema": {
+ "$ref": "#/definitions/NetworkResourceDescription"
+ }
+ },
+ "202": {
+ "description": "Accepted"
+ },
+ "default": {
+ "description": "Error",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ },
+ "get": {
+ "operationId": "MeshNetwork_Get",
+ "x-ms-examples": {
+ "GetNetworkResource": {
+ "$ref": "./examples/Resources/Networks/get.json"
+ }
+ },
+ "summary": "Gets the Network resource with the given name.",
+ "description": "Gets the information about the Network resource with the given name. The information include the description and other properties of the Network.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-4-Preview_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/NetworkResourceNameRequiredPathParam"
+ }
+ ],
+ "tags": [
+ "MeshNetworks"
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/NetworkResourceDescription"
+ }
+ },
+ "default": {
+ "description": "Error",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ },
+ "delete": {
+ "operationId": "MeshNetwork_Delete",
+ "x-ms-examples": {
+ "DeleteNetworkResource": {
+ "$ref": "./examples/Resources/Networks/delete.json"
+ }
+ },
+ "summary": "Deletes the Network resource.",
+ "description": "Deletes the Network resource identified by the name.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-4-Preview_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/NetworkResourceNameRequiredPathParam"
+ }
+ ],
+ "tags": [
+ "MeshNetworks"
+ ],
+ "responses": {
+ "200": {
+ "description": "OK"
+ },
+ "202": {
+ "description": "Accepted"
+ },
+ "204": {
+ "description": "No Content - the specified network was not found."
+ },
+ "default": {
+ "description": "Error",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/Resources/Networks": {
+ "get": {
+ "operationId": "MeshNetwork_List",
+ "x-ms-examples": {
+ "ListMeshNetworks": {
+ "$ref": "./examples/Resources/Networks/list.json"
+ }
+ },
+ "summary": "Lists all the network resources.",
+ "description": "Gets the information about all network resources in a given resource group. The information include the description and other properties of the Network.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-4-Preview_RequiredQueryParam"
+ }
+ ],
+ "tags": [
+ "MeshNetworks"
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/PagedNetworkResourceDescriptionList"
+ }
+ },
+ "default": {
+ "description": "Error",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/Resources/Applications/{applicationResourceName}": {
+ "put": {
+ "operationId": "MeshApplication_CreateOrUpdate",
+ "x-ms-examples": {
+ "CreateOrUpdateMeshApplication": {
+ "$ref": "./examples/Resources/Applications/create_update.json"
+ },
+ "CreateOrUpdateMeshApplicationWithAutoScale": {
+ "$ref": "./examples/Resources/Applications/create_update.autoscale.json"
+ }
+ },
+ "summary": "Creates or updates a Application resource.",
+ "description": "Creates a Application resource with the specified name, description and properties. If Application resource with the same name exists, then it is updated with the specified description and properties.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-4-Preview_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/ApplicationResourceNameRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/ApplicationResourceDescriptionRequiredBodyParam"
+ }
+ ],
+ "tags": [
+ "MeshApplications"
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/ApplicationResourceDescription"
+ }
+ },
+ "201": {
+ "description": "Created",
+ "schema": {
+ "$ref": "#/definitions/ApplicationResourceDescription"
+ }
+ },
+ "202": {
+ "description": "Accepted"
+ },
+ "default": {
+ "description": "Error",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ },
+ "get": {
+ "operationId": "MeshApplication_Get",
+ "x-ms-examples": {
+ "GetApplicationResource": {
+ "$ref": "./examples/Resources/Applications/get.json"
+ }
+ },
+ "summary": "Gets the Application resource with the given name.",
+ "description": "Gets the information about the Application resource with the given name. The information include the description and other properties of the Application.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-4-Preview_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/ApplicationResourceNameRequiredPathParam"
+ }
+ ],
+ "tags": [
+ "MeshApplications"
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/ApplicationResourceDescription"
+ }
+ },
+ "default": {
+ "description": "Error",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ },
+ "delete": {
+ "operationId": "MeshApplication_Delete",
+ "x-ms-examples": {
+ "DeleteApplicationResource": {
+ "$ref": "./examples/Resources/Applications/delete.json"
+ }
+ },
+ "summary": "Deletes the Application resource.",
+ "description": "Deletes the Application resource identified by the name.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-4-Preview_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/ApplicationResourceNameRequiredPathParam"
+ }
+ ],
+ "tags": [
+ "MeshApplications"
+ ],
+ "responses": {
+ "200": {
+ "description": "OK"
+ },
+ "202": {
+ "description": "Accepted"
+ },
+ "204": {
+ "description": "No Content - the specified application was not found."
+ },
+ "default": {
+ "description": "Error",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/Resources/Applications": {
+ "get": {
+ "operationId": "MeshApplication_List",
+ "x-ms-examples": {
+ "ListMeshApplications": {
+ "$ref": "./examples/Resources/Applications/list.json"
+ }
+ },
+ "summary": "Lists all the application resources.",
+ "description": "Gets the information about all application resources in a given resource group. The information include the description and other properties of the Application.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-4-Preview_RequiredQueryParam"
+ }
+ ],
+ "tags": [
+ "MeshApplications"
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/PagedApplicationResourceDescriptionList"
+ }
+ },
+ "default": {
+ "description": "Error",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/Resources/Applications/{applicationResourceName}/$/GetUpgradeProgress": {
+ "get": {
+ "operationId": "MeshApplication_GetUpgradeProgress",
+ "x-ms-examples": {
+ "GetApplicationResourceUpgrade": {
+ "$ref": "./examples/Resources/Applications/get_upgrade.json"
+ }
+ },
+ "summary": "Gets the progress of the latest upgrade performed on this application resource.",
+ "description": "Gets the upgrade progress information about the Application resource with the given name. The information include percentage of completion and other upgrade state information of the Application resource.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_7-0_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/ApplicationResourceNameRequiredPathParam"
+ }
+ ],
+ "tags": [
+ "MeshApplications"
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/ApplicationResourceUpgradeProgressInfo"
+ }
+ },
+ "default": {
+ "description": "Error",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/Resources/Applications/{applicationResourceName}/Services/{serviceResourceName}": {
+ "get": {
+ "operationId": "MeshService_Get",
+ "x-ms-examples": {
+ "GetServiceResource": {
+ "$ref": "./examples/Resources/Applications/Services/get.json"
+ }
+ },
+ "summary": "Gets the Service resource with the given name.",
+ "description": "Gets the information about the Service resource with the given name. The information include the description and other properties of the Service.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-4-Preview_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/ApplicationResourceNameRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/ServiceResourceNameRequiredPathParam"
+ }
+ ],
+ "tags": [
+ "MeshServices"
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/ServiceResourceDescription"
+ }
+ },
+ "default": {
+ "description": "Error",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/Resources/Applications/{applicationResourceName}/Services": {
+ "get": {
+ "operationId": "MeshService_List",
+ "x-ms-examples": {
+ "ListMeshServices": {
+ "$ref": "./examples/Resources/Applications/Services/list.json"
+ }
+ },
+ "summary": "Lists all the service resources.",
+ "description": "Gets the information about all services of an application resource. The information include the description and other properties of the Service.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-4-Preview_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/ApplicationResourceNameRequiredPathParam"
+ }
+ ],
+ "tags": [
+ "MeshServices"
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/PagedServiceResourceDescriptionList"
+ }
+ },
+ "default": {
+ "description": "Error",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/Resources/Applications/{applicationResourceName}/Services/{serviceResourceName}/Replicas/{replicaName}/CodePackages/{codePackageName}/Logs": {
+ "get": {
+ "operationId": "MeshCodePackage_GetContainerLogs",
+ "x-ms-examples": {
+ "GetContainerLogs": {
+ "$ref": "./examples/Resources/Applications/Services/Replicas/CodePackages/get_logs.json"
+ }
+ },
+ "summary": "Gets the logs from the container.",
+ "description": "Gets the logs for the container of the specified code package of the service replica.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-4-Preview_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/ApplicationResourceNameRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/ServiceResourceNameRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/ReplicaNameRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/CodePackageNameRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/TailOptionalQueryParam"
+ }
+ ],
+ "tags": [
+ "MeshCodePackages"
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/ContainerLogs"
+ }
+ },
+ "default": {
+ "description": "Error",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/Resources/Applications/{applicationResourceName}/Services/{serviceResourceName}/Replicas/{replicaName}": {
+ "get": {
+ "operationId": "MeshServiceReplica_Get",
+ "x-ms-examples": {
+ "GetServiceReplica": {
+ "$ref": "./examples/Resources/Applications/Services/Replicas/get.json"
+ }
+ },
+ "summary": "Gets the given replica of the service of an application.",
+ "description": "Gets the information about the service replica with the given name. The information include the description and other properties of the service replica.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-4-Preview_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/ApplicationResourceNameRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/ServiceResourceNameRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/ReplicaNameRequiredPathParam"
+ }
+ ],
+ "tags": [
+ "MeshServiceReplicas"
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/ServiceReplicaDescription"
+ }
+ },
+ "default": {
+ "description": "Error",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/Resources/Applications/{applicationResourceName}/Services/{serviceResourceName}/Replicas": {
+ "get": {
+ "operationId": "MeshServiceReplica_List",
+ "x-ms-examples": {
+ "ListMeshServiceReplicas": {
+ "$ref": "./examples/Resources/Applications/Services/Replicas/list.json"
+ }
+ },
+ "summary": "Lists all the replicas of a service.",
+ "description": "Gets the information about all replicas of a service. The information include the description and other properties of the service replica.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-4-Preview_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/ApplicationResourceNameRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/ServiceResourceNameRequiredPathParam"
+ }
+ ],
+ "tags": [
+ "MeshServiceReplicas"
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/PagedServiceReplicaDescriptionList"
+ }
+ },
+ "default": {
+ "description": "Error",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/Resources/Gateways/{gatewayResourceName}": {
+ "put": {
+ "operationId": "MeshGateway_CreateOrUpdate",
+ "x-ms-examples": {
+ "CreateOrUpdateMeshGateway": {
+ "$ref": "./examples/Resources/Gateways/create_update.json"
+ }
+ },
+ "summary": "Creates or updates a Gateway resource.",
+ "description": "Creates a Gateway resource with the specified name, description and properties. If Gateway resource with the same name exists, then it is updated with the specified description and properties. Use Gateway resource to provide public connectivity to application services.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-4-Preview_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/GatewayResourceNameRequiredPathParam"
+ },
+ {
+ "$ref": "#/parameters/GatewayResourceDescriptionRequiredBodyParam"
+ }
+ ],
+ "tags": [
+ "MeshGateways"
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/GatewayResourceDescription"
+ }
+ },
+ "201": {
+ "description": "Created",
+ "schema": {
+ "$ref": "#/definitions/GatewayResourceDescription"
+ }
+ },
+ "202": {
+ "description": "Accepted"
+ },
+ "default": {
+ "description": "Error",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ },
+ "get": {
+ "operationId": "MeshGateway_Get",
+ "x-ms-examples": {
+ "GetGatewayResource": {
+ "$ref": "./examples/Resources/Gateways/get.json"
+ }
+ },
+ "summary": "Gets the Gateway resource with the given name.",
+ "description": "Gets the information about the Gateway resource with the given name. The information include the description and other properties of the Gateway.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-4-Preview_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/GatewayResourceNameRequiredPathParam"
+ }
+ ],
+ "tags": [
+ "MeshGateways"
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/GatewayResourceDescription"
+ }
+ },
+ "default": {
+ "description": "Error",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ },
+ "delete": {
+ "operationId": "MeshGateway_Delete",
+ "x-ms-examples": {
+ "DeleteGatewayResource": {
+ "$ref": "./examples/Resources/Gateways/delete.json"
+ }
+ },
+ "summary": "Deletes the Gateway resource.",
+ "description": "Deletes the Gateway resource identified by the name.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-4-Preview_RequiredQueryParam"
+ },
+ {
+ "$ref": "#/parameters/GatewayResourceNameRequiredPathParam"
+ }
+ ],
+ "tags": [
+ "MeshGateways"
+ ],
+ "responses": {
+ "200": {
+ "description": "OK"
+ },
+ "202": {
+ "description": "Accepted"
+ },
+ "204": {
+ "description": "No Content - the specified gateway was not found."
+ },
+ "default": {
+ "description": "Error",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ },
+ "/Resources/Gateways": {
+ "get": {
+ "operationId": "MeshGateway_List",
+ "x-ms-examples": {
+ "ListMeshGateways": {
+ "$ref": "./examples/Resources/Gateways/list.json"
+ }
+ },
+ "summary": "Lists all the gateway resources.",
+ "description": "Gets the information about all gateway resources in a given resource group. The information include the description and other properties of the Gateway.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion_6-4-Preview_RequiredQueryParam"
+ }
+ ],
+ "tags": [
+ "MeshGateways"
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/PagedGatewayResourceDescriptionList"
+ }
+ },
+ "default": {
+ "description": "Error",
+ "schema": {
+ "$ref": "#/definitions/FabricError"
+ }
+ }
+ }
+ }
+ }
+ },
+ "definitions": {
+ "HealthState": {
+ "type": "string",
+ "description": "The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc.",
+ "enum": [
+ "Invalid",
+ "Ok",
+ "Warning",
+ "Error",
+ "Unknown"
+ ],
+ "x-ms-enum": {
+ "name": "HealthState",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "Invalid",
+ "description": "Indicates an invalid health state. All Service Fabric enumerations have the invalid type. The value is zero."
+ },
+ {
+ "value": "Ok",
+ "description": "Indicates the health state is okay. The value is 1."
+ },
+ {
+ "value": "Warning",
+ "description": "Indicates the health state is at a warning level. The value is 2."
+ },
+ {
+ "value": "Error",
+ "description": "Indicates the health state is at an error level. Error health state should be investigated, as they can impact the correct functionality of the cluster. The value is 3."
+ },
+ {
+ "value": "Unknown",
+ "description": "Indicates an unknown health status. The value is 65535."
+ }
+ ]
+ }
+ },
+ "FabricErrorCodes": {
+ "type": "string",
+ "description": "Defines the fabric error codes that be returned as part of the error object in response to Service Fabric API operations that are not successful. Following are the error code values that can be returned for a specific HTTP status code.\n\n - Possible values of the error code for HTTP status code 400 (Bad Request)\n - \"FABRIC_E_INVALID_PARTITION_KEY\"\n - \"FABRIC_E_IMAGEBUILDER_VALIDATION_ERROR\"\n - \"FABRIC_E_INVALID_ADDRESS\"\n - \"FABRIC_E_APPLICATION_NOT_UPGRADING\"\n - \"FABRIC_E_APPLICATION_UPGRADE_VALIDATION_ERROR\"\n - \"FABRIC_E_FABRIC_NOT_UPGRADING\"\n - \"FABRIC_E_FABRIC_UPGRADE_VALIDATION_ERROR\"\n - \"FABRIC_E_INVALID_CONFIGURATION\"\n - \"FABRIC_E_INVALID_NAME_URI\"\n - \"FABRIC_E_PATH_TOO_LONG\"\n - \"FABRIC_E_KEY_TOO_LARGE\"\n - \"FABRIC_E_SERVICE_AFFINITY_CHAIN_NOT_SUPPORTED\"\n - \"FABRIC_E_INVALID_ATOMIC_GROUP\"\n - \"FABRIC_E_VALUE_EMPTY\"\n - \"FABRIC_E_BACKUP_IS_ENABLED\"\n - \"FABRIC_E_RESTORE_SOURCE_TARGET_PARTITION_MISMATCH\"\n - \"FABRIC_E_INVALID_FOR_STATELESS_SERVICES\"\n - \"FABRIC_E_INVALID_SERVICE_SCALING_POLICY\"\n - \"E_INVALIDARG\"\n\n - Possible values of the error code for HTTP status code 404 (Not Found)\n - \"FABRIC_E_NODE_NOT_FOUND\"\n - \"FABRIC_E_APPLICATION_TYPE_NOT_FOUND\"\n - \"FABRIC_E_APPLICATION_NOT_FOUND\"\n - \"FABRIC_E_SERVICE_TYPE_NOT_FOUND\"\n - \"FABRIC_E_SERVICE_DOES_NOT_EXIST\"\n - \"FABRIC_E_SERVICE_TYPE_TEMPLATE_NOT_FOUND\"\n - \"FABRIC_E_CONFIGURATION_SECTION_NOT_FOUND\"\n - \"FABRIC_E_PARTITION_NOT_FOUND\"\n - \"FABRIC_E_REPLICA_DOES_NOT_EXIST\"\n - \"FABRIC_E_SERVICE_GROUP_DOES_NOT_EXIST\"\n - \"FABRIC_E_CONFIGURATION_PARAMETER_NOT_FOUND\"\n - \"FABRIC_E_DIRECTORY_NOT_FOUND\"\n - \"FABRIC_E_FABRIC_VERSION_NOT_FOUND\"\n - \"FABRIC_E_FILE_NOT_FOUND\"\n - \"FABRIC_E_NAME_DOES_NOT_EXIST\"\n - \"FABRIC_E_PROPERTY_DOES_NOT_EXIST\"\n - \"FABRIC_E_ENUMERATION_COMPLETED\"\n - \"FABRIC_E_SERVICE_MANIFEST_NOT_FOUND\"\n - \"FABRIC_E_KEY_NOT_FOUND\"\n - \"FABRIC_E_HEALTH_ENTITY_NOT_FOUND\"\n - \"FABRIC_E_BACKUP_NOT_ENABLED\"\n - \"FABRIC_E_BACKUP_POLICY_NOT_EXISTING\"\n - \"FABRIC_E_FAULT_ANALYSIS_SERVICE_NOT_EXISTING\"\n - \"FABRIC_E_IMAGEBUILDER_RESERVED_DIRECTORY_ERROR\"\n\n - Possible values of the error code for HTTP status code 409 (Conflict)\n - \"FABRIC_E_APPLICATION_TYPE_ALREADY_EXISTS\"\n - \"FABRIC_E_APPLICATION_ALREADY_EXISTS\"\n - \"FABRIC_E_APPLICATION_ALREADY_IN_TARGET_VERSION\"\n - \"FABRIC_E_APPLICATION_TYPE_PROVISION_IN_PROGRESS\"\n - \"FABRIC_E_APPLICATION_UPGRADE_IN_PROGRESS\"\n - \"FABRIC_E_SERVICE_ALREADY_EXISTS\"\n - \"FABRIC_E_SERVICE_GROUP_ALREADY_EXISTS\"\n - \"FABRIC_E_APPLICATION_TYPE_IN_USE\"\n - \"FABRIC_E_FABRIC_ALREADY_IN_TARGET_VERSION\"\n - \"FABRIC_E_FABRIC_VERSION_ALREADY_EXISTS\"\n - \"FABRIC_E_FABRIC_VERSION_IN_USE\"\n - \"FABRIC_E_FABRIC_UPGRADE_IN_PROGRESS\"\n - \"FABRIC_E_NAME_ALREADY_EXISTS\"\n - \"FABRIC_E_NAME_NOT_EMPTY\"\n - \"FABRIC_E_PROPERTY_CHECK_FAILED\"\n - \"FABRIC_E_SERVICE_METADATA_MISMATCH\"\n - \"FABRIC_E_SERVICE_TYPE_MISMATCH\"\n - \"FABRIC_E_HEALTH_STALE_REPORT\"\n - \"FABRIC_E_SEQUENCE_NUMBER_CHECK_FAILED\"\n - \"FABRIC_E_NODE_HAS_NOT_STOPPED_YET\"\n - \"FABRIC_E_INSTANCE_ID_MISMATCH\"\n - \"FABRIC_E_BACKUP_IN_PROGRESS\"\n - \"FABRIC_E_RESTORE_IN_PROGRESS\"\n - \"FABRIC_E_BACKUP_POLICY_ALREADY_EXISTING\"\n\n - Possible values of the error code for HTTP status code 413 (Request Entity Too Large)\n - \"FABRIC_E_VALUE_TOO_LARGE\"\n\n - Possible values of the error code for HTTP status code 500 (Internal Server Error)\n - \"FABRIC_E_NODE_IS_UP\"\n - \"E_FAIL\"\n - \"FABRIC_E_SINGLE_INSTANCE_APPLICATION_ALREADY_EXISTS\"\n - \"FABRIC_E_SINGLE_INSTANCE_APPLICATION_NOT_FOUND\"\n - \"FABRIC_E_VOLUME_ALREADY_EXISTS\"\n - \"FABRIC_E_VOLUME_NOT_FOUND\"\n - \"SerializationError\"\n\n - Possible values of the error code for HTTP status code 503 (Service Unavailable)\n - \"FABRIC_E_NO_WRITE_QUORUM\"\n - \"FABRIC_E_NOT_PRIMARY\"\n - \"FABRIC_E_NOT_READY\"\n - \"FABRIC_E_RECONFIGURATION_PENDING\"\n - \"FABRIC_E_SERVICE_OFFLINE\"\n - \"E_ABORT\"\n - \"FABRIC_E_VALUE_TOO_LARGE\"\n\n - Possible values of the error code for HTTP status code 504 (Gateway Timeout)\n - \"FABRIC_E_COMMUNICATION_ERROR\"\n - \"FABRIC_E_OPERATION_NOT_COMPLETE\"\n - \"FABRIC_E_TIMEOUT\"",
+ "enum": [
+ "FABRIC_E_INVALID_PARTITION_KEY",
+ "FABRIC_E_IMAGEBUILDER_VALIDATION_ERROR",
+ "FABRIC_E_INVALID_ADDRESS",
+ "FABRIC_E_APPLICATION_NOT_UPGRADING",
+ "FABRIC_E_APPLICATION_UPGRADE_VALIDATION_ERROR",
+ "FABRIC_E_FABRIC_NOT_UPGRADING",
+ "FABRIC_E_FABRIC_UPGRADE_VALIDATION_ERROR",
+ "FABRIC_E_INVALID_CONFIGURATION",
+ "FABRIC_E_INVALID_NAME_URI",
+ "FABRIC_E_PATH_TOO_LONG",
+ "FABRIC_E_KEY_TOO_LARGE",
+ "FABRIC_E_SERVICE_AFFINITY_CHAIN_NOT_SUPPORTED",
+ "FABRIC_E_INVALID_ATOMIC_GROUP",
+ "FABRIC_E_VALUE_EMPTY",
+ "FABRIC_E_NODE_NOT_FOUND",
+ "FABRIC_E_APPLICATION_TYPE_NOT_FOUND",
+ "FABRIC_E_APPLICATION_NOT_FOUND",
+ "FABRIC_E_SERVICE_TYPE_NOT_FOUND",
+ "FABRIC_E_SERVICE_DOES_NOT_EXIST",
+ "FABRIC_E_SERVICE_TYPE_TEMPLATE_NOT_FOUND",
+ "FABRIC_E_CONFIGURATION_SECTION_NOT_FOUND",
+ "FABRIC_E_PARTITION_NOT_FOUND",
+ "FABRIC_E_REPLICA_DOES_NOT_EXIST",
+ "FABRIC_E_SERVICE_GROUP_DOES_NOT_EXIST",
+ "FABRIC_E_CONFIGURATION_PARAMETER_NOT_FOUND",
+ "FABRIC_E_DIRECTORY_NOT_FOUND",
+ "FABRIC_E_FABRIC_VERSION_NOT_FOUND",
+ "FABRIC_E_FILE_NOT_FOUND",
+ "FABRIC_E_NAME_DOES_NOT_EXIST",
+ "FABRIC_E_PROPERTY_DOES_NOT_EXIST",
+ "FABRIC_E_ENUMERATION_COMPLETED",
+ "FABRIC_E_SERVICE_MANIFEST_NOT_FOUND",
+ "FABRIC_E_KEY_NOT_FOUND",
+ "FABRIC_E_HEALTH_ENTITY_NOT_FOUND",
+ "FABRIC_E_APPLICATION_TYPE_ALREADY_EXISTS",
+ "FABRIC_E_APPLICATION_ALREADY_EXISTS",
+ "FABRIC_E_APPLICATION_ALREADY_IN_TARGET_VERSION",
+ "FABRIC_E_APPLICATION_TYPE_PROVISION_IN_PROGRESS",
+ "FABRIC_E_APPLICATION_UPGRADE_IN_PROGRESS",
+ "FABRIC_E_SERVICE_ALREADY_EXISTS",
+ "FABRIC_E_SERVICE_GROUP_ALREADY_EXISTS",
+ "FABRIC_E_APPLICATION_TYPE_IN_USE",
+ "FABRIC_E_FABRIC_ALREADY_IN_TARGET_VERSION",
+ "FABRIC_E_FABRIC_VERSION_ALREADY_EXISTS",
+ "FABRIC_E_FABRIC_VERSION_IN_USE",
+ "FABRIC_E_FABRIC_UPGRADE_IN_PROGRESS",
+ "FABRIC_E_NAME_ALREADY_EXISTS",
+ "FABRIC_E_NAME_NOT_EMPTY",
+ "FABRIC_E_PROPERTY_CHECK_FAILED",
+ "FABRIC_E_SERVICE_METADATA_MISMATCH",
+ "FABRIC_E_SERVICE_TYPE_MISMATCH",
+ "FABRIC_E_HEALTH_STALE_REPORT",
+ "FABRIC_E_SEQUENCE_NUMBER_CHECK_FAILED",
+ "FABRIC_E_NODE_HAS_NOT_STOPPED_YET",
+ "FABRIC_E_INSTANCE_ID_MISMATCH",
+ "FABRIC_E_VALUE_TOO_LARGE",
+ "FABRIC_E_NO_WRITE_QUORUM",
+ "FABRIC_E_NOT_PRIMARY",
+ "FABRIC_E_NOT_READY",
+ "FABRIC_E_RECONFIGURATION_PENDING",
+ "FABRIC_E_SERVICE_OFFLINE",
+ "E_ABORT",
+ "FABRIC_E_COMMUNICATION_ERROR",
+ "FABRIC_E_OPERATION_NOT_COMPLETE",
+ "FABRIC_E_TIMEOUT",
+ "FABRIC_E_NODE_IS_UP",
+ "E_FAIL",
+ "FABRIC_E_BACKUP_IS_ENABLED",
+ "FABRIC_E_RESTORE_SOURCE_TARGET_PARTITION_MISMATCH",
+ "FABRIC_E_INVALID_FOR_STATELESS_SERVICES",
+ "FABRIC_E_BACKUP_NOT_ENABLED",
+ "FABRIC_E_BACKUP_POLICY_NOT_EXISTING",
+ "FABRIC_E_FAULT_ANALYSIS_SERVICE_NOT_EXISTING",
+ "FABRIC_E_BACKUP_IN_PROGRESS",
+ "FABRIC_E_RESTORE_IN_PROGRESS",
+ "FABRIC_E_BACKUP_POLICY_ALREADY_EXISTING",
+ "FABRIC_E_INVALID_SERVICE_SCALING_POLICY",
+ "E_INVALIDARG",
+ "FABRIC_E_SINGLE_INSTANCE_APPLICATION_ALREADY_EXISTS",
+ "FABRIC_E_SINGLE_INSTANCE_APPLICATION_NOT_FOUND",
+ "FABRIC_E_VOLUME_ALREADY_EXISTS",
+ "FABRIC_E_VOLUME_NOT_FOUND",
+ "SerializationError",
+ "FABRIC_E_IMAGEBUILDER_RESERVED_DIRECTORY_ERROR"
+ ],
+ "x-ms-enum": {
+ "name": "FabricErrorCodes",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "FABRIC_E_INVALID_PARTITION_KEY"
+ },
+ {
+ "value": "FABRIC_E_IMAGEBUILDER_VALIDATION_ERROR"
+ },
+ {
+ "value": "FABRIC_E_INVALID_ADDRESS"
+ },
+ {
+ "value": "FABRIC_E_APPLICATION_NOT_UPGRADING"
+ },
+ {
+ "value": "FABRIC_E_APPLICATION_UPGRADE_VALIDATION_ERROR"
+ },
+ {
+ "value": "FABRIC_E_FABRIC_NOT_UPGRADING"
+ },
+ {
+ "value": "FABRIC_E_FABRIC_UPGRADE_VALIDATION_ERROR"
+ },
+ {
+ "value": "FABRIC_E_INVALID_CONFIGURATION"
+ },
+ {
+ "value": "FABRIC_E_INVALID_NAME_URI"
+ },
+ {
+ "value": "FABRIC_E_PATH_TOO_LONG"
+ },
+ {
+ "value": "FABRIC_E_KEY_TOO_LARGE"
+ },
+ {
+ "value": "FABRIC_E_SERVICE_AFFINITY_CHAIN_NOT_SUPPORTED"
+ },
+ {
+ "value": "FABRIC_E_INVALID_ATOMIC_GROUP"
+ },
+ {
+ "value": "FABRIC_E_VALUE_EMPTY"
+ },
+ {
+ "value": "FABRIC_E_NODE_NOT_FOUND"
+ },
+ {
+ "value": "FABRIC_E_APPLICATION_TYPE_NOT_FOUND"
+ },
+ {
+ "value": "FABRIC_E_APPLICATION_NOT_FOUND"
+ },
+ {
+ "value": "FABRIC_E_SERVICE_TYPE_NOT_FOUND"
+ },
+ {
+ "value": "FABRIC_E_SERVICE_DOES_NOT_EXIST"
+ },
+ {
+ "value": "FABRIC_E_SERVICE_TYPE_TEMPLATE_NOT_FOUND"
+ },
+ {
+ "value": "FABRIC_E_CONFIGURATION_SECTION_NOT_FOUND"
+ },
+ {
+ "value": "FABRIC_E_PARTITION_NOT_FOUND"
+ },
+ {
+ "value": "FABRIC_E_REPLICA_DOES_NOT_EXIST"
+ },
+ {
+ "value": "FABRIC_E_SERVICE_GROUP_DOES_NOT_EXIST"
+ },
+ {
+ "value": "FABRIC_E_CONFIGURATION_PARAMETER_NOT_FOUND"
+ },
+ {
+ "value": "FABRIC_E_DIRECTORY_NOT_FOUND"
+ },
+ {
+ "value": "FABRIC_E_FABRIC_VERSION_NOT_FOUND"
+ },
+ {
+ "value": "FABRIC_E_FILE_NOT_FOUND"
+ },
+ {
+ "value": "FABRIC_E_NAME_DOES_NOT_EXIST"
+ },
+ {
+ "value": "FABRIC_E_PROPERTY_DOES_NOT_EXIST"
+ },
+ {
+ "value": "FABRIC_E_ENUMERATION_COMPLETED"
+ },
+ {
+ "value": "FABRIC_E_SERVICE_MANIFEST_NOT_FOUND"
+ },
+ {
+ "value": "FABRIC_E_KEY_NOT_FOUND"
+ },
+ {
+ "value": "FABRIC_E_HEALTH_ENTITY_NOT_FOUND"
+ },
+ {
+ "value": "FABRIC_E_APPLICATION_TYPE_ALREADY_EXISTS"
+ },
+ {
+ "value": "FABRIC_E_APPLICATION_ALREADY_EXISTS"
+ },
+ {
+ "value": "FABRIC_E_APPLICATION_ALREADY_IN_TARGET_VERSION"
+ },
+ {
+ "value": "FABRIC_E_APPLICATION_TYPE_PROVISION_IN_PROGRESS"
+ },
+ {
+ "value": "FABRIC_E_APPLICATION_UPGRADE_IN_PROGRESS"
+ },
+ {
+ "value": "FABRIC_E_SERVICE_ALREADY_EXISTS"
+ },
+ {
+ "value": "FABRIC_E_SERVICE_GROUP_ALREADY_EXISTS"
+ },
+ {
+ "value": "FABRIC_E_APPLICATION_TYPE_IN_USE"
+ },
+ {
+ "value": "FABRIC_E_FABRIC_ALREADY_IN_TARGET_VERSION"
+ },
+ {
+ "value": "FABRIC_E_FABRIC_VERSION_ALREADY_EXISTS"
+ },
+ {
+ "value": "FABRIC_E_FABRIC_VERSION_IN_USE"
+ },
+ {
+ "value": "FABRIC_E_FABRIC_UPGRADE_IN_PROGRESS"
+ },
+ {
+ "value": "FABRIC_E_NAME_ALREADY_EXISTS"
+ },
+ {
+ "value": "FABRIC_E_NAME_NOT_EMPTY"
+ },
+ {
+ "value": "FABRIC_E_PROPERTY_CHECK_FAILED"
+ },
+ {
+ "value": "FABRIC_E_SERVICE_METADATA_MISMATCH"
+ },
+ {
+ "value": "FABRIC_E_SERVICE_TYPE_MISMATCH"
+ },
+ {
+ "value": "FABRIC_E_HEALTH_STALE_REPORT"
+ },
+ {
+ "value": "FABRIC_E_SEQUENCE_NUMBER_CHECK_FAILED"
+ },
+ {
+ "value": "FABRIC_E_NODE_HAS_NOT_STOPPED_YET"
+ },
+ {
+ "value": "FABRIC_E_INSTANCE_ID_MISMATCH"
+ },
+ {
+ "value": "FABRIC_E_VALUE_TOO_LARGE"
+ },
+ {
+ "value": "FABRIC_E_NO_WRITE_QUORUM"
+ },
+ {
+ "value": "FABRIC_E_NOT_PRIMARY"
+ },
+ {
+ "value": "FABRIC_E_NOT_READY"
+ },
+ {
+ "value": "FABRIC_E_RECONFIGURATION_PENDING"
+ },
+ {
+ "value": "FABRIC_E_SERVICE_OFFLINE"
+ },
+ {
+ "value": "E_ABORT"
+ },
+ {
+ "value": "FABRIC_E_COMMUNICATION_ERROR"
+ },
+ {
+ "value": "FABRIC_E_OPERATION_NOT_COMPLETE"
+ },
+ {
+ "value": "FABRIC_E_TIMEOUT"
+ },
+ {
+ "value": "FABRIC_E_NODE_IS_UP"
+ },
+ {
+ "value": "E_FAIL"
+ },
+ {
+ "value": "FABRIC_E_BACKUP_IS_ENABLED"
+ },
+ {
+ "value": "FABRIC_E_RESTORE_SOURCE_TARGET_PARTITION_MISMATCH"
+ },
+ {
+ "value": "FABRIC_E_INVALID_FOR_STATELESS_SERVICES"
+ },
+ {
+ "value": "FABRIC_E_BACKUP_NOT_ENABLED"
+ },
+ {
+ "value": "FABRIC_E_BACKUP_POLICY_NOT_EXISTING"
+ },
+ {
+ "value": "FABRIC_E_FAULT_ANALYSIS_SERVICE_NOT_EXISTING"
+ },
+ {
+ "value": "FABRIC_E_BACKUP_IN_PROGRESS"
+ },
+ {
+ "value": "FABRIC_E_RESTORE_IN_PROGRESS"
+ },
+ {
+ "value": "FABRIC_E_BACKUP_POLICY_ALREADY_EXISTING"
+ },
+ {
+ "value": "FABRIC_E_INVALID_SERVICE_SCALING_POLICY"
+ },
+ {
+ "value": "E_INVALIDARG"
+ },
+ {
+ "value": "FABRIC_E_SINGLE_INSTANCE_APPLICATION_ALREADY_EXISTS"
+ },
+ {
+ "value": "FABRIC_E_SINGLE_INSTANCE_APPLICATION_NOT_FOUND"
+ },
+ {
+ "value": "FABRIC_E_VOLUME_ALREADY_EXISTS"
+ },
+ {
+ "value": "FABRIC_E_VOLUME_NOT_FOUND"
+ },
+ {
+ "value": "SerializationError"
+ },
+ {
+ "value": "FABRIC_E_IMAGEBUILDER_RESERVED_DIRECTORY_ERROR"
+ }
+ ]
+ }
+ },
+ "FabricError": {
+ "description": "The REST API operations for Service Fabric return standard HTTP status codes. This type defines the additional information returned from the Service Fabric API operations that are not successful.",
+ "properties": {
+ "Error": {
+ "$ref": "#/definitions/FabricErrorError",
+ "description": "Error object containing error code and error message."
+ }
+ },
+ "required": [
+ "Error"
+ ]
+ },
+ "FabricErrorError": {
+ "description": "Error object containing error code and error message.",
+ "properties": {
+ "Code": {
+ "$ref": "#/definitions/FabricErrorCodes",
+ "description": "Defines the fabric error codes that be returned as part of the error object in response to Service Fabric API operations that are not successful. Following are the error code values that can be returned for a specific HTTP status code.\n\n - Possible values of the error code for HTTP status code 400 (Bad Request)\n - \"FABRIC_E_INVALID_PARTITION_KEY\"\n - \"FABRIC_E_IMAGEBUILDER_VALIDATION_ERROR\"\n - \"FABRIC_E_INVALID_ADDRESS\"\n - \"FABRIC_E_APPLICATION_NOT_UPGRADING\"\n - \"FABRIC_E_APPLICATION_UPGRADE_VALIDATION_ERROR\"\n - \"FABRIC_E_FABRIC_NOT_UPGRADING\"\n - \"FABRIC_E_FABRIC_UPGRADE_VALIDATION_ERROR\"\n - \"FABRIC_E_INVALID_CONFIGURATION\"\n - \"FABRIC_E_INVALID_NAME_URI\"\n - \"FABRIC_E_PATH_TOO_LONG\"\n - \"FABRIC_E_KEY_TOO_LARGE\"\n - \"FABRIC_E_SERVICE_AFFINITY_CHAIN_NOT_SUPPORTED\"\n - \"FABRIC_E_INVALID_ATOMIC_GROUP\"\n - \"FABRIC_E_VALUE_EMPTY\"\n - \"FABRIC_E_BACKUP_IS_ENABLED\"\n - \"FABRIC_E_RESTORE_SOURCE_TARGET_PARTITION_MISMATCH\"\n - \"FABRIC_E_INVALID_FOR_STATELESS_SERVICES\"\n - \"FABRIC_E_INVALID_SERVICE_SCALING_POLICY\"\n - \"E_INVALIDARG\"\n\n - Possible values of the error code for HTTP status code 404 (Not Found)\n - \"FABRIC_E_NODE_NOT_FOUND\"\n - \"FABRIC_E_APPLICATION_TYPE_NOT_FOUND\"\n - \"FABRIC_E_APPLICATION_NOT_FOUND\"\n - \"FABRIC_E_SERVICE_TYPE_NOT_FOUND\"\n - \"FABRIC_E_SERVICE_DOES_NOT_EXIST\"\n - \"FABRIC_E_SERVICE_TYPE_TEMPLATE_NOT_FOUND\"\n - \"FABRIC_E_CONFIGURATION_SECTION_NOT_FOUND\"\n - \"FABRIC_E_PARTITION_NOT_FOUND\"\n - \"FABRIC_E_REPLICA_DOES_NOT_EXIST\"\n - \"FABRIC_E_SERVICE_GROUP_DOES_NOT_EXIST\"\n - \"FABRIC_E_CONFIGURATION_PARAMETER_NOT_FOUND\"\n - \"FABRIC_E_DIRECTORY_NOT_FOUND\"\n - \"FABRIC_E_FABRIC_VERSION_NOT_FOUND\"\n - \"FABRIC_E_FILE_NOT_FOUND\"\n - \"FABRIC_E_NAME_DOES_NOT_EXIST\"\n - \"FABRIC_E_PROPERTY_DOES_NOT_EXIST\"\n - \"FABRIC_E_ENUMERATION_COMPLETED\"\n - \"FABRIC_E_SERVICE_MANIFEST_NOT_FOUND\"\n - \"FABRIC_E_KEY_NOT_FOUND\"\n - \"FABRIC_E_HEALTH_ENTITY_NOT_FOUND\"\n - \"FABRIC_E_BACKUP_NOT_ENABLED\"\n - \"FABRIC_E_BACKUP_POLICY_NOT_EXISTING\"\n - \"FABRIC_E_FAULT_ANALYSIS_SERVICE_NOT_EXISTING\"\n - \"FABRIC_E_IMAGEBUILDER_RESERVED_DIRECTORY_ERROR\"\n\n - Possible values of the error code for HTTP status code 409 (Conflict)\n - \"FABRIC_E_APPLICATION_TYPE_ALREADY_EXISTS\"\n - \"FABRIC_E_APPLICATION_ALREADY_EXISTS\"\n - \"FABRIC_E_APPLICATION_ALREADY_IN_TARGET_VERSION\"\n - \"FABRIC_E_APPLICATION_TYPE_PROVISION_IN_PROGRESS\"\n - \"FABRIC_E_APPLICATION_UPGRADE_IN_PROGRESS\"\n - \"FABRIC_E_SERVICE_ALREADY_EXISTS\"\n - \"FABRIC_E_SERVICE_GROUP_ALREADY_EXISTS\"\n - \"FABRIC_E_APPLICATION_TYPE_IN_USE\"\n - \"FABRIC_E_FABRIC_ALREADY_IN_TARGET_VERSION\"\n - \"FABRIC_E_FABRIC_VERSION_ALREADY_EXISTS\"\n - \"FABRIC_E_FABRIC_VERSION_IN_USE\"\n - \"FABRIC_E_FABRIC_UPGRADE_IN_PROGRESS\"\n - \"FABRIC_E_NAME_ALREADY_EXISTS\"\n - \"FABRIC_E_NAME_NOT_EMPTY\"\n - \"FABRIC_E_PROPERTY_CHECK_FAILED\"\n - \"FABRIC_E_SERVICE_METADATA_MISMATCH\"\n - \"FABRIC_E_SERVICE_TYPE_MISMATCH\"\n - \"FABRIC_E_HEALTH_STALE_REPORT\"\n - \"FABRIC_E_SEQUENCE_NUMBER_CHECK_FAILED\"\n - \"FABRIC_E_NODE_HAS_NOT_STOPPED_YET\"\n - \"FABRIC_E_INSTANCE_ID_MISMATCH\"\n - \"FABRIC_E_BACKUP_IN_PROGRESS\"\n - \"FABRIC_E_RESTORE_IN_PROGRESS\"\n - \"FABRIC_E_BACKUP_POLICY_ALREADY_EXISTING\"\n\n - Possible values of the error code for HTTP status code 413 (Request Entity Too Large)\n - \"FABRIC_E_VALUE_TOO_LARGE\"\n\n - Possible values of the error code for HTTP status code 500 (Internal Server Error)\n - \"FABRIC_E_NODE_IS_UP\"\n - \"E_FAIL\"\n - \"FABRIC_E_SINGLE_INSTANCE_APPLICATION_ALREADY_EXISTS\"\n - \"FABRIC_E_SINGLE_INSTANCE_APPLICATION_NOT_FOUND\"\n - \"FABRIC_E_VOLUME_ALREADY_EXISTS\"\n - \"FABRIC_E_VOLUME_NOT_FOUND\"\n - \"SerializationError\"\n\n - Possible values of the error code for HTTP status code 503 (Service Unavailable)\n - \"FABRIC_E_NO_WRITE_QUORUM\"\n - \"FABRIC_E_NOT_PRIMARY\"\n - \"FABRIC_E_NOT_READY\"\n - \"FABRIC_E_RECONFIGURATION_PENDING\"\n - \"FABRIC_E_SERVICE_OFFLINE\"\n - \"E_ABORT\"\n - \"FABRIC_E_VALUE_TOO_LARGE\"\n\n - Possible values of the error code for HTTP status code 504 (Gateway Timeout)\n - \"FABRIC_E_COMMUNICATION_ERROR\"\n - \"FABRIC_E_OPERATION_NOT_COMPLETE\"\n - \"FABRIC_E_TIMEOUT\""
+ },
+ "Message": {
+ "type": "string",
+ "description": "Error message."
+ }
+ },
+ "required": [
+ "Code"
+ ]
+ },
+ "ContainerLogs": {
+ "description": "Container logs.",
+ "properties": {
+ "Content": {
+ "type": "string",
+ "description": "Container logs."
+ }
+ }
+ },
+ "AadMetadata": {
+ "description": "Azure Active Directory metadata used for secured connection to cluster.",
+ "properties": {
+ "authority": {
+ "type": "string",
+ "description": "The AAD authority url."
+ },
+ "client": {
+ "type": "string",
+ "description": "The AAD client application Id."
+ },
+ "cluster": {
+ "type": "string",
+ "description": "The AAD cluster application Id."
+ },
+ "login": {
+ "type": "string",
+ "description": "The AAD login url."
+ },
+ "redirect": {
+ "type": "string",
+ "description": "The client application redirect address."
+ },
+ "tenant": {
+ "type": "string",
+ "description": "The AAD tenant Id."
+ }
+ }
+ },
+ "AadMetadataObject": {
+ "description": "Azure Active Directory metadata object used for secured connection to cluster.",
+ "properties": {
+ "type": {
+ "type": "string",
+ "description": "The client authentication method."
+ },
+ "metadata": {
+ "$ref": "#/definitions/AadMetadata",
+ "description": "Azure Active Directory metadata used for secured connection to cluster."
+ }
+ }
+ },
+ "AnalysisEventMetadata": {
+ "description": "Metadata about an Analysis Event.",
+ "properties": {
+ "Delay": {
+ "type": "string",
+ "format": "duration",
+ "description": "The analysis delay."
+ },
+ "Duration": {
+ "type": "string",
+ "format": "duration",
+ "description": "The duration of analysis."
+ }
+ }
+ },
+ "ApplicationDefinitionKind": {
+ "type": "string",
+ "description": "The mechanism used to define a Service Fabric application.",
+ "enum": [
+ "Invalid",
+ "ServiceFabricApplicationDescription",
+ "Compose"
+ ],
+ "x-ms-enum": {
+ "name": "ApplicationDefinitionKind",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "Invalid",
+ "description": "Indicates the application definition kind is invalid. All Service Fabric enumerations have the invalid type. The value is 65535."
+ },
+ {
+ "value": "ServiceFabricApplicationDescription",
+ "description": "Indicates the application is defined by a Service Fabric application description. The value is 0."
+ },
+ {
+ "value": "Compose",
+ "description": "Indicates the application is defined by compose file(s). The value is 1."
+ }
+ ]
+ }
+ },
+ "ApplicationEvent": {
+ "description": "Represents the base for all Application Events.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/FabricEvent"
+ }
+ ],
+ "properties": {
+ "ApplicationId": {
+ "$ref": "#/definitions/ApplicationId",
+ "description": "The identity of the application. This is an encoded representation of the application name. This is used in the REST APIs to identify the application resource.\nStarting in version 6.0, hierarchical names are delimited with the \"\\~\" character. For example, if the application name is \"fabric:/myapp/app1\",\nthe application identity would be \"myapp\\~app1\" in 6.0+ and \"myapp/app1\" in previous versions."
+ }
+ },
+ "required": [
+ "ApplicationId"
+ ],
+ "x-ms-discriminator-value": "ApplicationEvent"
+ },
+ "ApplicationEventList": {
+ "description": "A list of ApplicationEvent objects.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ApplicationEvent"
+ }
+ },
+ "ApplicationHealth": {
+ "description": "Represents the health of the application. Contains the application aggregated health state and the service and deployed application health states.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/EntityHealth"
+ }
+ ],
+ "properties": {
+ "Name": {
+ "$ref": "#/definitions/ApplicationName",
+ "description": "The name of the application, including the 'fabric:' URI scheme."
+ },
+ "ServiceHealthStates": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ServiceHealthState"
+ },
+ "description": "Service health states as found in the health store."
+ },
+ "DeployedApplicationHealthStates": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/DeployedApplicationHealthState"
+ },
+ "description": "Deployed application health states as found in the health store."
+ }
+ }
+ },
+ "ApplicationHealthEvaluation": {
+ "x-ms-discriminator-value": "Application",
+ "description": "Represents health evaluation for an application, containing information about the data and the algorithm used by the health store to evaluate health.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/HealthEvaluation"
+ }
+ ],
+ "properties": {
+ "ApplicationName": {
+ "$ref": "#/definitions/ApplicationName",
+ "description": "The name of the application, including the 'fabric:' URI scheme."
+ },
+ "UnhealthyEvaluations": {
+ "$ref": "#/definitions/UnhealthyEvaluations",
+ "description": "List of unhealthy evaluations that led to the current aggregated health state of the application. The types of the unhealthy evaluations can be DeployedApplicationsHealthEvaluation, ServicesHealthEvaluation or EventHealthEvaluation."
+ }
+ }
+ },
+ "ApplicationHealthPolicies": {
+ "description": "Defines the application health policy map used to evaluate the health of an application or one of its children entities.",
+ "properties": {
+ "ApplicationHealthPolicyMap": {
+ "$ref": "#/definitions/ApplicationHealthPolicyMap",
+ "description": "The wrapper that contains the map with application health policies used to evaluate specific applications in the cluster."
+ }
+ }
+ },
+ "ApplicationHealthPolicy": {
+ "description": "Defines a health policy used to evaluate the health of an application or one of its children entities.",
+ "properties": {
+ "ConsiderWarningAsError": {
+ "type": "boolean",
+ "description": "Indicates whether warnings are treated with the same severity as errors.",
+ "default": false
+ },
+ "MaxPercentUnhealthyDeployedApplications": {
+ "type": "integer",
+ "description": "The maximum allowed percentage of unhealthy deployed applications. Allowed values are Byte values from zero to 100.\nThe percentage represents the maximum tolerated percentage of deployed applications that can be unhealthy before the application is considered in error.\nThis is calculated by dividing the number of unhealthy deployed applications over the number of nodes where the application is currently deployed on in the cluster.\nThe computation rounds up to tolerate one failure on small numbers of nodes. Default percentage is zero.",
+ "default": 0
+ },
+ "DefaultServiceTypeHealthPolicy": {
+ "$ref": "#/definitions/ServiceTypeHealthPolicy",
+ "description": "The health policy used by default to evaluate the health of a service type."
+ },
+ "ServiceTypeHealthPolicyMap": {
+ "$ref": "#/definitions/ServiceTypeHealthPolicyMap",
+ "description": "The map with service type health policy per service type name. The map is empty by default."
+ }
+ }
+ },
+ "ApplicationHealthPolicyMap": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ApplicationHealthPolicyMapItem"
+ },
+ "description": "Defines a map that contains specific application health policies for different applications.\nEach entry specifies as key the application name and as value an ApplicationHealthPolicy used to evaluate the application health.\nIf an application is not specified in the map, the application health evaluation uses the ApplicationHealthPolicy found in its application manifest or the default application health policy (if no health policy is defined in the manifest).\nThe map is empty by default."
+ },
+ "ApplicationHealthPolicyMapItem": {
+ "description": "Defines an item in ApplicationHealthPolicyMap.",
+ "required": [
+ "Key",
+ "Value"
+ ],
+ "properties": {
+ "Key": {
+ "$ref": "#/definitions/ApplicationName",
+ "description": "The key of the application health policy map item. This is the name of the application."
+ },
+ "Value": {
+ "$ref": "#/definitions/ApplicationHealthPolicy",
+ "description": "The value of the application health policy map item. This is the ApplicationHealthPolicy for this application."
+ }
+ }
+ },
+ "ApplicationHealthState": {
+ "description": "Represents the health state of an application, which contains the application identifier and the aggregated health state.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/EntityHealthState"
+ }
+ ],
+ "properties": {
+ "Name": {
+ "$ref": "#/definitions/ApplicationName",
+ "description": "The name of the application, including the 'fabric:' URI scheme."
+ }
+ }
+ },
+ "ApplicationHealthStateChunk": {
+ "description": "Represents the health state chunk of a application.\nThe application health state chunk contains the application name, its aggregated health state and any children services and deployed applications that respect the filters in cluster health chunk query description.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/EntityHealthStateChunk"
+ }
+ ],
+ "properties": {
+ "ApplicationName": {
+ "$ref": "#/definitions/ApplicationName",
+ "description": "The name of the application, including the 'fabric:' URI scheme."
+ },
+ "ApplicationTypeName": {
+ "$ref": "#/definitions/ApplicationTypeName",
+ "description": "The application type name as defined in the application manifest."
+ },
+ "ServiceHealthStateChunks": {
+ "$ref": "#/definitions/ServiceHealthStateChunkList",
+ "description": "The list of service health state chunks in the cluster that respect the filters in the cluster health chunk query description."
+ },
+ "DeployedApplicationHealthStateChunks": {
+ "$ref": "#/definitions/DeployedApplicationHealthStateChunkList",
+ "description": "The list of deployed application health state chunks in the cluster that respect the filters in the cluster health chunk query description."
+ }
+ }
+ },
+ "ApplicationHealthStateChunkList": {
+ "description": "The list of application health state chunks in the cluster that respect the input filters in the chunk query. Returned by get cluster health state chunks query.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/EntityHealthStateChunkList"
+ }
+ ],
+ "properties": {
+ "Items": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ApplicationHealthStateChunk"
+ },
+ "description": "The list of application health state chunks that respect the input filters in the chunk query."
+ }
+ }
+ },
+ "ApplicationHealthStateFilter": {
+ "description": "Defines matching criteria to determine whether a application should be included in the cluster health chunk.\nOne filter can match zero, one or multiple applications, depending on its properties.",
+ "properties": {
+ "ApplicationNameFilter": {
+ "type": "string",
+ "description": "The name of the application that matches the filter, as a fabric uri. The filter is applied only to the specified application, if it exists.\nIf the application doesn't exist, no application is returned in the cluster health chunk based on this filter.\nIf the application exists, it is included in the cluster health chunk if it respects the other filter properties.\nIf not specified, all applications are matched against the other filter members, like health state filter."
+ },
+ "ApplicationTypeNameFilter": {
+ "type": "string",
+ "description": "The name of the application type that matches the filter.\nIf specified, the filter is applied only to applications of the selected application type, if any exists.\nIf no applications of the specified application type exists, no application is returned in the cluster health chunk based on this filter.\nEach application of the specified application type is included in the cluster health chunk if it respects the other filter properties.\nIf not specified, all applications are matched against the other filter members, like health state filter."
+ },
+ "HealthStateFilter": {
+ "type": "integer",
+ "default": 0,
+ "description": "The filter for the health state of the applications. It allows selecting applications if they match the desired health states.\nThe possible values are integer value of one of the following health states. Only applications that match the filter are returned. All applications are used to evaluate the cluster aggregated health state.\nIf not specified, default value is None, unless the application name or the application type name are specified. If the filter has default value and application name is specified, the matching application is returned.\nThe state values are flag-based enumeration, so the value could be a combination of these values obtained using bitwise 'OR' operator.\nFor example, if the provided value is 6, it matches applications with HealthState value of OK (2) and Warning (4).\n\n- Default - Default value. Matches any HealthState. The value is zero.\n- None - Filter that doesn't match any HealthState value. Used in order to return no results on a given collection of states. The value is 1.\n- Ok - Filter that matches input with HealthState value Ok. The value is 2.\n- Warning - Filter that matches input with HealthState value Warning. The value is 4.\n- Error - Filter that matches input with HealthState value Error. The value is 8.\n- All - Filter that matches input with any HealthState value. The value is 65535."
+ },
+ "ServiceFilters": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ServiceHealthStateFilter"
+ },
+ "description": "Defines a list of filters that specify which services to be included in the returned cluster health chunk as children of the application. The services are returned only if the parent application matches a filter.\nIf the list is empty, no services are returned. All the services are used to evaluate the parent application aggregated health state, regardless of the input filters.\nThe application filter may specify multiple service filters.\nFor example, it can specify a filter to return all services with health state Error and another filter to always include a service identified by its service name."
+ },
+ "DeployedApplicationFilters": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/DeployedApplicationHealthStateFilter"
+ },
+ "description": "Defines a list of filters that specify which deployed applications to be included in the returned cluster health chunk as children of the application. The deployed applications are returned only if the parent application matches a filter.\nIf the list is empty, no deployed applications are returned. All the deployed applications are used to evaluate the parent application aggregated health state, regardless of the input filters.\nThe application filter may specify multiple deployed application filters.\nFor example, it can specify a filter to return all deployed applications with health state Error and another filter to always include a deployed application on a specified node."
+ }
+ }
+ },
+ "ApplicationId": {
+ "type": "string",
+ "description": "The identity of the application. This is an encoded representation of the application name. This is used in the REST APIs to identify the application resource.\nStarting in version 6.0, hierarchical names are delimited with the \"\\~\" character. For example, if the application name is \"fabric:/myapp/app1\",\nthe application identity would be \"myapp\\~app1\" in 6.0+ and \"myapp/app1\" in previous versions."
+ },
+ "ApplicationInfo": {
+ "description": "Information about a Service Fabric application.",
+ "properties": {
+ "Id": {
+ "$ref": "#/definitions/ApplicationId",
+ "description": "The identity of the application. This is an encoded representation of the application name. This is used in the REST APIs to identify the application resource.\nStarting in version 6.0, hierarchical names are delimited with the \"\\~\" character. For example, if the application name is \"fabric:/myapp/app1\",\nthe application identity would be \"myapp\\~app1\" in 6.0+ and \"myapp/app1\" in previous versions."
+ },
+ "Name": {
+ "$ref": "#/definitions/ApplicationName",
+ "description": "The name of the application, including the 'fabric:' URI scheme."
+ },
+ "TypeName": {
+ "$ref": "#/definitions/ApplicationTypeName",
+ "description": "The application type name as defined in the application manifest."
+ },
+ "TypeVersion": {
+ "$ref": "#/definitions/ApplicationTypeVersion",
+ "description": "The version of the application type as defined in the application manifest."
+ },
+ "Status": {
+ "$ref": "#/definitions/ApplicationStatus",
+ "description": "The status of the application."
+ },
+ "Parameters": {
+ "$ref": "#/definitions/ApplicationParameterList",
+ "description": "List of application parameters with overridden values from their default values specified in the application manifest."
+ },
+ "HealthState": {
+ "$ref": "#/definitions/HealthState",
+ "description": "The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc."
+ },
+ "ApplicationDefinitionKind": {
+ "$ref": "#/definitions/ApplicationDefinitionKind",
+ "description": "The mechanism used to define a Service Fabric application."
+ }
+ }
+ },
+ "ApplicationLoadInfo": {
+ "description": "Load Information about a Service Fabric application.",
+ "properties": {
+ "Id": {
+ "$ref": "#/definitions/ApplicationId",
+ "description": "The identity of the application. This is an encoded representation of the application name. This is used in the REST APIs to identify the application resource.\nStarting in version 6.0, hierarchical names are delimited with the \"\\~\" character. For example, if the application name is \"fabric:/myapp/app1\",\nthe application identity would be \"myapp\\~app1\" in 6.0+ and \"myapp/app1\" in previous versions."
+ },
+ "MinimumNodes": {
+ "type": "integer",
+ "format": "int64",
+ "description": "The minimum number of nodes for this application.\nIt is the number of nodes where Service Fabric will reserve Capacity in the cluster which equals to ReservedLoad * MinimumNodes for this Application instance.\nFor applications that do not have application capacity defined this value will be zero."
+ },
+ "MaximumNodes": {
+ "type": "integer",
+ "format": "int64",
+ "description": "The maximum number of nodes where this application can be instantiated.\nIt is the number of nodes this application is allowed to span.\nFor applications that do not have application capacity defined this value will be zero."
+ },
+ "NodeCount": {
+ "type": "integer",
+ "format": "int64",
+ "description": "The number of nodes on which this application is instantiated.\nFor applications that do not have application capacity defined this value will be zero."
+ },
+ "ApplicationLoadMetricInformation": {
+ "$ref": "#/definitions/ApplicationLoadMetricInformationList",
+ "description": "List of application load metric information."
+ }
+ }
+ },
+ "ApplicationName": {
+ "type": "string",
+ "description": "The name of the application, including the 'fabric:' URI scheme."
+ },
+ "ApplicationNameInfo": {
+ "description": "Information about the application name.",
+ "properties": {
+ "Id": {
+ "$ref": "#/definitions/ApplicationId",
+ "description": "The identity of the application. This is an encoded representation of the application name. This is used in the REST APIs to identify the application resource.\nStarting in version 6.0, hierarchical names are delimited with the \"\\~\" character. For example, if the application name is \"fabric:/myapp/app1\",\nthe application identity would be \"myapp\\~app1\" in 6.0+ and \"myapp/app1\" in previous versions."
+ },
+ "Name": {
+ "$ref": "#/definitions/ApplicationName",
+ "description": "The name of the application, including the 'fabric:' URI scheme."
+ }
+ }
+ },
+ "ApplicationPackageCleanupPolicy": {
+ "type": "string",
+ "description": "The kind of action that needs to be taken for cleaning up the application package after successful provision.",
+ "enum": [
+ "Invalid",
+ "Default",
+ "Automatic",
+ "Manual"
+ ],
+ "x-ms-enum": {
+ "name": "ApplicationPackageCleanupPolicy",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "Invalid",
+ "description": "Indicates that the application package cleanup policy is invalid. This value is default. The value is zero."
+ },
+ {
+ "value": "Default",
+ "description": "Indicates that the cleanup policy of application packages is based on the cluster setting \"CleanupApplicationPackageOnProvisionSuccess.\" The value is 1."
+ },
+ {
+ "value": "Automatic",
+ "description": "Indicates that the service fabric runtime determines when to do the application package cleanup. By default, cleanup is done on successful provision. The value is 2."
+ },
+ {
+ "value": "Manual",
+ "description": "Indicates that the user has to explicitly clean up the application package. The value is 3."
+ }
+ ]
+ }
+ },
+ "ApplicationParameter": {
+ "description": "Describes an application parameter override to be applied when creating or upgrading an application.",
+ "required": [
+ "Key",
+ "Value"
+ ],
+ "properties": {
+ "Key": {
+ "type": "string",
+ "description": "The name of the parameter."
+ },
+ "Value": {
+ "type": "string",
+ "description": "The value of the parameter."
+ }
+ }
+ },
+ "ApplicationParameterList": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ApplicationParameter"
+ },
+ "description": "List of application parameters with overridden values from their default values specified in the application manifest."
+ },
+ "ApplicationsHealthEvaluation": {
+ "x-ms-discriminator-value": "Applications",
+ "description": "Represents health evaluation for applications, containing health evaluations for each unhealthy application that impacted current aggregated health state.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/HealthEvaluation"
+ }
+ ],
+ "properties": {
+ "MaxPercentUnhealthyApplications": {
+ "type": "integer",
+ "description": "Maximum allowed percentage of unhealthy applications from the ClusterHealthPolicy."
+ },
+ "TotalCount": {
+ "type": "integer",
+ "format": "int64",
+ "description": "Total number of applications from the health store."
+ },
+ "UnhealthyEvaluations": {
+ "$ref": "#/definitions/UnhealthyEvaluations",
+ "description": "List of unhealthy evaluations that led to the aggregated health state. Includes all the unhealthy ApplicationHealthEvaluation that impacted the aggregated health."
+ }
+ }
+ },
+ "ApplicationStatus": {
+ "type": "string",
+ "description": "The status of the application.",
+ "enum": [
+ "Invalid",
+ "Ready",
+ "Upgrading",
+ "Creating",
+ "Deleting",
+ "Failed"
+ ],
+ "x-ms-enum": {
+ "name": "ApplicationStatus",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "Invalid",
+ "description": "Indicates the application status is invalid. All Service Fabric enumerations have the invalid type. The value is zero."
+ },
+ {
+ "value": "Ready",
+ "description": "Indicates the application status is ready. The value is 1."
+ },
+ {
+ "value": "Upgrading",
+ "description": "Indicates the application status is upgrading. The value is 2."
+ },
+ {
+ "value": "Creating",
+ "description": "Indicates the application status is creating. The value is 3."
+ },
+ {
+ "value": "Deleting",
+ "description": "Indicates the application status is deleting. The value is 4."
+ },
+ {
+ "value": "Failed",
+ "description": "Indicates the creation or deletion of application was terminated due to persistent failures. Another create/delete request can be accepted to resume a failed application. The value is 5."
+ }
+ ]
+ }
+ },
+ "ApplicationTypeApplicationsHealthEvaluation": {
+ "x-ms-discriminator-value": "ApplicationTypeApplications",
+ "description": "Represents health evaluation for applications of a particular application type. The application type applications evaluation can be returned when cluster health evaluation returns unhealthy aggregated health state, either Error or Warning. It contains health evaluations for each unhealthy application of the included application type that impacted current aggregated health state.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/HealthEvaluation"
+ }
+ ],
+ "properties": {
+ "ApplicationTypeName": {
+ "$ref": "#/definitions/ApplicationTypeName",
+ "description": "The application type name as defined in the application manifest."
+ },
+ "MaxPercentUnhealthyApplications": {
+ "type": "integer",
+ "description": "Maximum allowed percentage of unhealthy applications for the application type, specified as an entry in ApplicationTypeHealthPolicyMap."
+ },
+ "TotalCount": {
+ "type": "integer",
+ "format": "int64",
+ "description": "Total number of applications of the application type found in the health store."
+ },
+ "UnhealthyEvaluations": {
+ "$ref": "#/definitions/UnhealthyEvaluations",
+ "description": "List of unhealthy evaluations that led to the aggregated health state. Includes all the unhealthy ApplicationHealthEvaluation of this application type that impacted the aggregated health."
+ }
+ }
+ },
+ "ApplicationTypeDefinitionKind": {
+ "type": "string",
+ "description": "The mechanism used to define a Service Fabric application type.",
+ "enum": [
+ "Invalid",
+ "ServiceFabricApplicationPackage",
+ "Compose"
+ ],
+ "x-ms-enum": {
+ "name": "ApplicationTypeDefinitionKind",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "Invalid",
+ "description": "Indicates the application type definition kind is invalid. All Service Fabric enumerations have the invalid type. The value is 0."
+ },
+ {
+ "value": "ServiceFabricApplicationPackage",
+ "description": "Indicates the application type is defined and created by a Service Fabric application package provided by the user. The value is 1."
+ },
+ {
+ "value": "Compose",
+ "description": "Indicates the application type is defined and created implicitly as part of a compose deployment. The value is 2."
+ }
+ ]
+ }
+ },
+ "ApplicationTypeHealthPolicyMap": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ApplicationTypeHealthPolicyMapItem"
+ },
+ "description": "Defines a map with max percentage unhealthy applications for specific application types.\nEach entry specifies as key the application type name and as value an integer that represents the MaxPercentUnhealthyApplications percentage used to evaluate the applications of the specified application type.\n\nThe application type health policy map can be used during cluster health evaluation to describe special application types.\nThe application types included in the map are evaluated against the percentage specified in the map, and not with the global MaxPercentUnhealthyApplications defined in the cluster health policy.\nThe applications of application types specified in the map are not counted against the global pool of applications.\nFor example, if some applications of a type are critical, the cluster administrator can add an entry to the map for that application type\nand assign it a value of 0% (that is, do not tolerate any failures).\nAll other applications can be evaluated with MaxPercentUnhealthyApplications set to 20% to tolerate some failures out of the thousands of application instances.\nThe application type health policy map is used only if the cluster manifest enables application type health evaluation using the configuration entry for HealthManager/EnableApplicationTypeHealthEvaluation."
+ },
+ "ApplicationTypeHealthPolicyMapItem": {
+ "description": "Defines an item in ApplicationTypeHealthPolicyMap.",
+ "required": [
+ "Key",
+ "Value"
+ ],
+ "properties": {
+ "Key": {
+ "type": "string",
+ "description": "The key of the application type health policy map item. This is the name of the application type."
+ },
+ "Value": {
+ "type": "integer",
+ "description": "The value of the application type health policy map item.\nThe max percent unhealthy applications allowed for the application type. Must be between zero and 100."
+ }
+ }
+ },
+ "ApplicationTypeInfo": {
+ "description": "Information about an application type.",
+ "properties": {
+ "Name": {
+ "$ref": "#/definitions/ApplicationTypeName",
+ "description": "The application type name as defined in the application manifest."
+ },
+ "Version": {
+ "$ref": "#/definitions/ApplicationTypeVersion",
+ "description": "The version of the application type as defined in the application manifest."
+ },
+ "DefaultParameterList": {
+ "$ref": "#/definitions/ApplicationTypeParameterList",
+ "description": "List of application type parameters that can be overridden when creating or updating the application."
+ },
+ "Status": {
+ "$ref": "#/definitions/ApplicationTypeStatus",
+ "description": "The status of the application type."
+ },
+ "StatusDetails": {
+ "type": "string",
+ "description": "Additional detailed information about the status of the application type."
+ },
+ "ApplicationTypeDefinitionKind": {
+ "$ref": "#/definitions/ApplicationTypeDefinitionKind",
+ "description": "The mechanism used to define a Service Fabric application type."
+ }
+ }
+ },
+ "PagedApplicationTypeInfoList": {
+ "description": "The list of application types that are provisioned or being provisioned in the cluster. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.",
+ "properties": {
+ "ContinuationToken": {
+ "$ref": "#/definitions/ContinuationToken",
+ "description": "The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token is not included in the response."
+ },
+ "Items": {
+ "type": "array",
+ "description": "List of application type information.",
+ "items": {
+ "$ref": "#/definitions/ApplicationTypeInfo"
+ }
+ }
+ }
+ },
+ "ApplicationTypeManifest": {
+ "description": "Contains the manifest describing an application type registered in a Service Fabric cluster.",
+ "properties": {
+ "Manifest": {
+ "type": "string",
+ "description": "The XML manifest as a string."
+ }
+ }
+ },
+ "ApplicationTypeName": {
+ "type": "string",
+ "description": "The application type name as defined in the application manifest."
+ },
+ "ApplicationTypeParameterList": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ApplicationParameter"
+ },
+ "description": "List of application type parameters that can be overridden when creating or updating the application."
+ },
+ "ApplicationTypeStatus": {
+ "type": "string",
+ "description": "The status of the application type.",
+ "enum": [
+ "Invalid",
+ "Provisioning",
+ "Available",
+ "Unprovisioning",
+ "Failed"
+ ],
+ "x-ms-enum": {
+ "name": "ApplicationTypeStatus",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "Invalid",
+ "description": "Indicates the application type status is invalid. All Service Fabric enumerations have the invalid type. The value is zero."
+ },
+ {
+ "value": "Provisioning",
+ "description": "Indicates that the application type is being provisioned in the cluster. The value is 1."
+ },
+ {
+ "value": "Available",
+ "description": "Indicates that the application type is fully provisioned and is available for use. An application of this type and version can be created. The value is 2."
+ },
+ {
+ "value": "Unprovisioning",
+ "description": "Indicates that the application type is in process of being unprovisioned from the cluster. The value is 3."
+ },
+ {
+ "value": "Failed",
+ "description": "Indicates that the application type provisioning failed and it is unavailable for use. The failure details can be obtained from the application type information query. The failed application type information remains in the cluster until it is unprovisioned or reprovisioned successfully. The value is 4."
+ }
+ ]
+ }
+ },
+ "ApplicationUnhealthyEvaluations": {
+ "description": "List of health evaluations that resulted in the current aggregated health state.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/HealthEvaluationWrapper"
+ }
+ },
+ "ApplicationUpgradeDescription": {
+ "description": "Describes the parameters for an application upgrade. Note that upgrade description replaces the existing application description. This means that if the parameters are not specified, the existing parameters on the applications will be overwritten with the empty parameters list. This would result in the application using the default value of the parameters from the application manifest. If you do not want to change any existing parameter values, please get the application parameters first using the GetApplicationInfo query and then supply those values as Parameters in this ApplicationUpgradeDescription.",
+ "properties": {
+ "Name": {
+ "$ref": "#/definitions/TargetApplicationName",
+ "description": "The name of the target application, including the 'fabric:' URI scheme."
+ },
+ "TargetApplicationTypeVersion": {
+ "$ref": "#/definitions/TargetApplicationTypeVersion",
+ "description": "The target application type version (found in the application manifest) for the application upgrade."
+ },
+ "Parameters": {
+ "$ref": "#/definitions/ApplicationParameterList",
+ "description": "List of application parameters with overridden values from their default values specified in the application manifest."
+ },
+ "UpgradeKind": {
+ "$ref": "#/definitions/UpgradeKind",
+ "description": "The kind of upgrade out of the following possible values."
+ },
+ "RollingUpgradeMode": {
+ "$ref": "#/definitions/UpgradeMode",
+ "description": "The mode used to monitor health during a rolling upgrade. The values are UnmonitoredAuto, UnmonitoredManual, and Monitored."
+ },
+ "UpgradeReplicaSetCheckTimeoutInSeconds": {
+ "$ref": "#/definitions/UpgradeReplicaSetCheckTimeout",
+ "description": "The maximum amount of time to block processing of an upgrade domain and prevent loss of availability when there are unexpected issues. When this timeout expires, processing of the upgrade domain will proceed regardless of availability loss issues. The timeout is reset at the start of each upgrade domain. Valid values are between 0 and 42949672925 inclusive. (unsigned 32-bit integer)."
+ },
+ "ForceRestart": {
+ "$ref": "#/definitions/ForceRestart",
+ "description": "If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data)."
+ },
+ "SortOrder": {
+ "$ref": "#/definitions/UpgradeSortOrder",
+ "description": "Defines the order in which an upgrade proceeds through the cluster."
+ },
+ "MonitoringPolicy": {
+ "$ref": "#/definitions/MonitoringPolicyDescription",
+ "description": "Describes the parameters for monitoring an upgrade in Monitored mode."
+ },
+ "ApplicationHealthPolicy": {
+ "$ref": "#/definitions/ApplicationHealthPolicy",
+ "description": "Defines a health policy used to evaluate the health of an application or one of its children entities."
+ },
+ "InstanceCloseDelayDurationInSeconds": {
+ "$ref": "#/definitions/InstanceCloseDelayDurationInSeconds",
+ "description": "Duration in seconds, to wait before a stateless instance is closed, to allow the active requests to drain gracefully. This would be effective when the instance is closing during the application/cluster\nupgrade, only for those instances which have a non-zero delay duration configured in the service description. See InstanceCloseDelayDurationSeconds property in $ref: \"#/definitions/StatelessServiceDescription.yaml\" for details.\nNote, the default value of InstanceCloseDelayDurationInSeconds is 4294967295, which indicates that the behavior will entirely depend on the delay configured in the stateless service description."
+ }
+ },
+ "required": [
+ "Name",
+ "TargetApplicationTypeVersion",
+ "UpgradeKind"
+ ]
+ },
+ "ApplicationUpgradeProgressInfo": {
+ "description": "Describes the parameters for an application upgrade.",
+ "properties": {
+ "Name": {
+ "$ref": "#/definitions/TargetApplicationName",
+ "description": "The name of the target application, including the 'fabric:' URI scheme."
+ },
+ "TypeName": {
+ "$ref": "#/definitions/ApplicationTypeName",
+ "description": "The application type name as defined in the application manifest."
+ },
+ "TargetApplicationTypeVersion": {
+ "$ref": "#/definitions/TargetApplicationTypeVersion",
+ "description": "The target application type version (found in the application manifest) for the application upgrade."
+ },
+ "UpgradeDomains": {
+ "$ref": "#/definitions/UpgradeDomainInfoList",
+ "description": "List of upgrade domains and their statuses."
+ },
+ "UpgradeState": {
+ "$ref": "#/definitions/UpgradeState",
+ "description": "The state of the upgrade domain."
+ },
+ "NextUpgradeDomain": {
+ "$ref": "#/definitions/NextUpgradeDomain",
+ "description": "The name of the next upgrade domain to be processed."
+ },
+ "RollingUpgradeMode": {
+ "$ref": "#/definitions/UpgradeMode",
+ "description": "The mode used to monitor health during a rolling upgrade. The values are UnmonitoredAuto, UnmonitoredManual, and Monitored."
+ },
+ "UpgradeDescription": {
+ "$ref": "#/definitions/ApplicationUpgradeDescription",
+ "description": "Describes the parameters for an application upgrade. Note that upgrade description replaces the existing application description. This means that if the parameters are not specified, the existing parameters on the applications will be overwritten with the empty parameters list. This would result in the application using the default value of the parameters from the application manifest. If you do not want to change any existing parameter values, please get the application parameters first using the GetApplicationInfo query and then supply those values as Parameters in this ApplicationUpgradeDescription."
+ },
+ "UpgradeDurationInMilliseconds": {
+ "type": "string",
+ "description": "The estimated total amount of time spent processing the overall upgrade."
+ },
+ "UpgradeDomainDurationInMilliseconds": {
+ "type": "string",
+ "description": "The estimated total amount of time spent processing the current upgrade domain."
+ },
+ "UnhealthyEvaluations": {
+ "$ref": "#/definitions/UnhealthyEvaluations",
+ "description": "List of health evaluations that resulted in the current aggregated health state."
+ },
+ "CurrentUpgradeDomainProgress": {
+ "$ref": "#/definitions/CurrentUpgradeDomainProgressInfo",
+ "description": "Information about the current in-progress upgrade domain."
+ },
+ "StartTimestampUtc": {
+ "type": "string",
+ "description": "The estimated UTC datetime when the upgrade started."
+ },
+ "FailureTimestampUtc": {
+ "type": "string",
+ "description": "The estimated UTC datetime when the upgrade failed and FailureAction was executed."
+ },
+ "FailureReason": {
+ "$ref": "#/definitions/FailureReason",
+ "description": "The cause of an upgrade failure that resulted in FailureAction being executed."
+ },
+ "UpgradeDomainProgressAtFailure": {
+ "$ref": "#/definitions/FailureUpgradeDomainProgressInfo",
+ "description": "Information about the upgrade domain progress at the time of upgrade failure."
+ },
+ "UpgradeStatusDetails": {
+ "type": "string",
+ "description": "Additional detailed information about the status of the pending upgrade."
+ }
+ }
+ },
+ "ByteArray": {
+ "description": "Array of bytes to be sent as an integer array. Each element of array is a number between 0 and 255.",
+ "type": "array",
+ "items": {
+ "type": "integer"
+ }
+ },
+ "ClusterConfiguration": {
+ "description": "Information about the standalone cluster configuration.",
+ "properties": {
+ "ClusterConfiguration": {
+ "type": "string",
+ "description": "The contents of the cluster configuration file."
+ }
+ }
+ },
+ "ClusterEvent": {
+ "description": "Represents the base for all Cluster Events.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/FabricEvent"
+ }
+ ],
+ "x-ms-discriminator-value": "ClusterEvent"
+ },
+ "ClusterEventList": {
+ "description": "A list of ClusterEvent objects.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ClusterEvent"
+ }
+ },
+ "ClusterHealth": {
+ "description": "Represents the health of the cluster.\nContains the cluster aggregated health state, the cluster application and node health states as well as the health events and the unhealthy evaluations.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/EntityHealth"
+ }
+ ],
+ "properties": {
+ "NodeHealthStates": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/NodeHealthState"
+ },
+ "description": "Cluster node health states as found in the health store."
+ },
+ "ApplicationHealthStates": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ApplicationHealthState"
+ },
+ "description": "Cluster application health states as found in the health store."
+ }
+ }
+ },
+ "ClusterHealthChunk": {
+ "description": "Represents the health chunk of the cluster.\nContains the cluster aggregated health state, and the cluster entities that respect the input filter.",
+ "properties": {
+ "HealthState": {
+ "$ref": "#/definitions/HealthState",
+ "description": "The HealthState representing the aggregated health state of the cluster computed by Health Manager.\nThe health evaluation of the entity reflects all events reported on the entity and its children (if any).\nThe aggregation is done by applying the desired cluster health policy and the application health policies."
+ },
+ "NodeHealthStateChunks": {
+ "$ref": "#/definitions/NodeHealthStateChunkList",
+ "description": "The list of node health state chunks in the cluster that respect the filters in the cluster health chunk query description."
+ },
+ "ApplicationHealthStateChunks": {
+ "$ref": "#/definitions/ApplicationHealthStateChunkList",
+ "description": "The list of application health state chunks in the cluster that respect the filters in the cluster health chunk query description."
+ }
+ }
+ },
+ "ClusterHealthChunkQueryDescription": {
+ "description": "The cluster health chunk query description, which can specify the health policies to evaluate cluster health and very expressive filters to select which cluster entities to include in response.",
+ "properties": {
+ "NodeFilters": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/NodeHealthStateFilter"
+ },
+ "description": "Defines a list of filters that specify which nodes to be included in the returned cluster health chunk.\nIf no filters are specified, no nodes are returned. All the nodes are used to evaluate the cluster's aggregated health state, regardless of the input filters.\nThe cluster health chunk query may specify multiple node filters.\nFor example, it can specify a filter to return all nodes with health state Error and another filter to always include a node identified by its NodeName."
+ },
+ "ApplicationFilters": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ApplicationHealthStateFilter"
+ },
+ "description": "Defines a list of filters that specify which applications to be included in the returned cluster health chunk.\nIf no filters are specified, no applications are returned. All the applications are used to evaluate the cluster's aggregated health state, regardless of the input filters.\nThe cluster health chunk query may specify multiple application filters.\nFor example, it can specify a filter to return all applications with health state Error and another filter to always include applications of a specified application type."
+ },
+ "ClusterHealthPolicy": {
+ "$ref": "#/definitions/ClusterHealthPolicy",
+ "description": "Defines a health policy used to evaluate the health of the cluster or of a cluster node."
+ },
+ "ApplicationHealthPolicies": {
+ "$ref": "#/definitions/ApplicationHealthPolicies",
+ "description": "Defines the application health policy map used to evaluate the health of an application or one of its children entities."
+ }
+ }
+ },
+ "ClusterHealthPolicies": {
+ "description": "Health policies to evaluate cluster health.",
+ "properties": {
+ "ApplicationHealthPolicyMap": {
+ "$ref": "#/definitions/ApplicationHealthPolicyMap",
+ "description": "Defines a map that contains specific application health policies for different applications.\nEach entry specifies as key the application name and as value an ApplicationHealthPolicy used to evaluate the application health.\nIf an application is not specified in the map, the application health evaluation uses the ApplicationHealthPolicy found in its application manifest or the default application health policy (if no health policy is defined in the manifest).\nThe map is empty by default."
+ },
+ "ClusterHealthPolicy": {
+ "$ref": "#/definitions/ClusterHealthPolicy",
+ "description": "Defines a health policy used to evaluate the health of the cluster or of a cluster node."
+ }
+ }
+ },
+ "ClusterHealthPolicy": {
+ "description": "Defines a health policy used to evaluate the health of the cluster or of a cluster node.",
+ "properties": {
+ "ConsiderWarningAsError": {
+ "type": "boolean",
+ "description": "Indicates whether warnings are treated with the same severity as errors.",
+ "default": false
+ },
+ "MaxPercentUnhealthyNodes": {
+ "type": "integer",
+ "description": "The maximum allowed percentage of unhealthy nodes before reporting an error. For example, to allow 10% of nodes to be unhealthy, this value would be 10.\n\nThe percentage represents the maximum tolerated percentage of nodes that can be unhealthy before the cluster is considered in error.\nIf the percentage is respected but there is at least one unhealthy node, the health is evaluated as Warning.\nThe percentage is calculated by dividing the number of unhealthy nodes over the total number of nodes in the cluster.\nThe computation rounds up to tolerate one failure on small numbers of nodes. Default percentage is zero.\n\nIn large clusters, some nodes will always be down or out for repairs, so this percentage should be configured to tolerate that.",
+ "default": 0
+ },
+ "MaxPercentUnhealthyApplications": {
+ "type": "integer",
+ "description": "The maximum allowed percentage of unhealthy applications before reporting an error. For example, to allow 10% of applications to be unhealthy, this value would be 10.\n\nThe percentage represents the maximum tolerated percentage of applications that can be unhealthy before the cluster is considered in error.\nIf the percentage is respected but there is at least one unhealthy application, the health is evaluated as Warning.\nThis is calculated by dividing the number of unhealthy applications over the total number of application instances in the cluster, excluding applications of application types that are included in the ApplicationTypeHealthPolicyMap.\nThe computation rounds up to tolerate one failure on small numbers of applications. Default percentage is zero.",
+ "default": 0
+ },
+ "ApplicationTypeHealthPolicyMap": {
+ "$ref": "#/definitions/ApplicationTypeHealthPolicyMap",
+ "description": "Defines a map with max percentage unhealthy applications for specific application types.\nEach entry specifies as key the application type name and as value an integer that represents the MaxPercentUnhealthyApplications percentage used to evaluate the applications of the specified application type.\n\nThe application type health policy map can be used during cluster health evaluation to describe special application types.\nThe application types included in the map are evaluated against the percentage specified in the map, and not with the global MaxPercentUnhealthyApplications defined in the cluster health policy.\nThe applications of application types specified in the map are not counted against the global pool of applications.\nFor example, if some applications of a type are critical, the cluster administrator can add an entry to the map for that application type\nand assign it a value of 0% (that is, do not tolerate any failures).\nAll other applications can be evaluated with MaxPercentUnhealthyApplications set to 20% to tolerate some failures out of the thousands of application instances.\nThe application type health policy map is used only if the cluster manifest enables application type health evaluation using the configuration entry for HealthManager/EnableApplicationTypeHealthEvaluation."
+ }
+ }
+ },
+ "ClusterManifest": {
+ "description": "Information about the cluster manifest.",
+ "properties": {
+ "Manifest": {
+ "type": "string",
+ "description": "The contents of the cluster manifest file."
+ }
+ }
+ },
+ "ClusterLoadInfo": {
+ "description": "Information about load in a Service Fabric cluster. It holds a summary of all metrics and their load in a cluster.",
+ "properties": {
+ "LastBalancingStartTimeUtc": {
+ "type": "string",
+ "format": "date-time",
+ "description": "The starting time of last resource balancing run."
+ },
+ "LastBalancingEndTimeUtc": {
+ "type": "string",
+ "format": "date-time",
+ "description": "The end time of last resource balancing run."
+ },
+ "LoadMetricInformation": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/LoadMetricInformation"
+ },
+ "description": "List that contains metrics and their load information in this cluster."
+ }
+ }
+ },
+ "LoadMetricInformation": {
+ "description": "Represents data structure that contains load information for a certain metric in a cluster.",
+ "properties": {
+ "Name": {
+ "type": "string",
+ "description": "Name of the metric for which this load information is provided."
+ },
+ "IsBalancedBefore": {
+ "type": "boolean",
+ "description": "Value that indicates whether the metrics is balanced or not before resource balancer run"
+ },
+ "IsBalancedAfter": {
+ "type": "boolean",
+ "description": "Value that indicates whether the metrics is balanced or not after resource balancer run."
+ },
+ "DeviationBefore": {
+ "type": "string",
+ "format": "double",
+ "description": "The standard average deviation of the metrics before resource balancer run."
+ },
+ "DeviationAfter": {
+ "type": "string",
+ "format": "double",
+ "description": "The standard average deviation of the metrics after resource balancer run."
+ },
+ "BalancingThreshold": {
+ "type": "string",
+ "format": "double",
+ "description": "The balancing threshold for a certain metric."
+ },
+ "Action": {
+ "type": "string",
+ "description": "The current action being taken with regard to this metric"
+ },
+ "ActivityThreshold": {
+ "type": "string",
+ "format": "double",
+ "description": "The Activity Threshold specified for this metric in the system Cluster Manifest."
+ },
+ "ClusterCapacity": {
+ "type": "string",
+ "description": "The total cluster capacity for a given metric"
+ },
+ "ClusterLoad": {
+ "type": "string",
+ "description": "The total cluster load. In future releases of Service Fabric this parameter will be deprecated in favor of CurrentClusterLoad."
+ },
+ "CurrentClusterLoad": {
+ "type": "string",
+ "format": "double",
+ "description": "The total cluster load."
+ },
+ "ClusterRemainingCapacity": {
+ "type": "string",
+ "description": "The remaining capacity for the metric in the cluster. In future releases of Service Fabric this parameter will be deprecated in favor of ClusterCapacityRemaining."
+ },
+ "ClusterCapacityRemaining": {
+ "type": "string",
+ "description": "The remaining capacity for the metric in the cluster."
+ },
+ "IsClusterCapacityViolation": {
+ "type": "boolean",
+ "description": "Indicates that the metric is currently over capacity in the cluster."
+ },
+ "NodeBufferPercentage": {
+ "type": "string",
+ "format": "double",
+ "description": "The reserved percentage of total node capacity for this metric."
+ },
+ "ClusterBufferedCapacity": {
+ "type": "string",
+ "description": "Remaining capacity in the cluster excluding the reserved space. In future releases of Service Fabric this parameter will be deprecated in favor of BufferedClusterCapacityRemaining."
+ },
+ "BufferedClusterCapacityRemaining": {
+ "type": "string",
+ "format": "double",
+ "description": "Remaining capacity in the cluster excluding the reserved space."
+ },
+ "ClusterRemainingBufferedCapacity": {
+ "type": "string",
+ "description": "The remaining percentage of cluster total capacity for this metric."
+ },
+ "MinNodeLoadValue": {
+ "type": "string",
+ "description": "The minimum load on any node for this metric. In future releases of Service Fabric this parameter will be deprecated in favor of MinimumNodeLoad."
+ },
+ "MinimumNodeLoad": {
+ "type": "string",
+ "format": "double",
+ "description": "The minimum load on any node for this metric."
+ },
+ "MinNodeLoadNodeId": {
+ "$ref": "#/definitions/NodeId",
+ "description": "The node id of the node with the minimum load for this metric."
+ },
+ "MaxNodeLoadValue": {
+ "type": "string",
+ "description": "The maximum load on any node for this metric. In future releases of Service Fabric this parameter will be deprecated in favor of MaximumNodeLoad."
+ },
+ "MaximumNodeLoad": {
+ "type": "string",
+ "format": "double",
+ "description": "The maximum load on any node for this metric."
+ },
+ "MaxNodeLoadNodeId": {
+ "$ref": "#/definitions/NodeId",
+ "description": "The node id of the node with the maximum load for this metric."
+ },
+ "PlannedLoadRemoval": {
+ "type": "string",
+ "format": "double",
+ "description": "This value represents the load of the replicas that are planned to be removed in the future within the cluster.\nThis kind of load is reported for replicas that are currently being moving to other nodes and for replicas that are currently being dropped but still use the load on the source node."
+ }
+ }
+ },
+ "ClusterVersion": {
+ "description": "The cluster version.",
+ "properties": {
+ "Version": {
+ "type": "string",
+ "description": "The Service Fabric cluster runtime version."
+ }
+ }
+ },
+ "ContainerApiRequestBody": {
+ "description": "parameters for making container API call.",
+ "properties": {
+ "HttpVerb": {
+ "type": "string",
+ "description": "HTTP verb of container REST API, defaults to \"GET\""
+ },
+ "UriPath": {
+ "type": "string",
+ "description": "URI path of container REST API"
+ },
+ "Content-Type": {
+ "type": "string",
+ "description": "Content type of container REST API request, defaults to \"application/json\""
+ },
+ "Body": {
+ "type": "string",
+ "description": "HTTP request body of container REST API"
+ }
+ },
+ "required": [
+ "UriPath"
+ ]
+ },
+ "ContainerApiResponse": {
+ "description": "Response body that wraps container API result.",
+ "properties": {
+ "ContainerApiResult": {
+ "$ref": "#/definitions/ContainerApiResult",
+ "description": "Container API result."
+ }
+ },
+ "required": [
+ "ContainerApiResult"
+ ]
+ },
+ "ContainerApiResult": {
+ "description": "Container API result.",
+ "properties": {
+ "Status": {
+ "type": "integer",
+ "description": "HTTP status code returned by the target container API"
+ },
+ "Content-Type": {
+ "type": "string",
+ "description": "HTTP content type"
+ },
+ "Content-Encoding": {
+ "type": "string",
+ "description": "HTTP content encoding"
+ },
+ "Body": {
+ "type": "string",
+ "description": "container API result body"
+ }
+ },
+ "required": [
+ "Status"
+ ]
+ },
+ "ContainerInstanceEvent": {
+ "description": "Represents the base for all Container Events.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/FabricEvent"
+ }
+ ],
+ "x-ms-discriminator-value": "ContainerInstanceEvent"
+ },
+ "ContainerInstanceEventList": {
+ "description": "A list of ContainerInstanceEvent objects.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ContainerInstanceEvent"
+ }
+ },
+ "ContinuationToken": {
+ "type": "string",
+ "description": "The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token is not included in the response."
+ },
+ "ConfigParameterOverrideList": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ConfigParameterOverride"
+ },
+ "description": "List that contains parameters, sections that they belong and their values."
+ },
+ "ConfigParameterOverride": {
+ "description": "Information about a configuration parameter override.",
+ "properties": {
+ "SectionName": {
+ "type": "string",
+ "description": "Name of the section for the parameter override."
+ },
+ "ParameterName": {
+ "type": "string",
+ "description": "Name of the parameter that has been overridden."
+ },
+ "ParameterValue": {
+ "type": "string",
+ "description": "Value of the overridden parameter."
+ },
+ "Timeout": {
+ "type": "string",
+ "format": "duration",
+ "description": "The duration until config override is considered as valid."
+ },
+ "PersistAcrossUpgrade": {
+ "type": "boolean",
+ "description": "A value that indicates whether config override will be removed on upgrade or will still be considered as valid."
+ }
+ },
+ "required": [
+ "SectionName",
+ "ParameterName",
+ "ParameterValue"
+ ]
+ },
+ "CurrentUpgradeDomainProgressInfo": {
+ "description": "Information about the current in-progress upgrade domain.",
+ "properties": {
+ "DomainName": {
+ "$ref": "#/definitions/UpgradeDomainName",
+ "description": "The name of the upgrade domain"
+ },
+ "NodeUpgradeProgressList": {
+ "$ref": "#/definitions/NodeUpgradeProgressInfoList",
+ "description": "List of upgrading nodes and their statuses"
+ }
+ }
+ },
+ "CurrentUpgradeDomainDuration": {
+ "type": "string",
+ "description": "The estimated amount of time spent processing current Upgrade Domain. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds.",
+ "default": "PT0H2M0S"
+ },
+ "DeactivationIntentDescription": {
+ "description": "Describes the intent or reason for deactivating the node.",
+ "properties": {
+ "DeactivationIntent": {
+ "type": "string",
+ "description": "Describes the intent or reason for deactivating the node. The possible values are following.",
+ "enum": [
+ "Pause",
+ "Restart",
+ "RemoveData"
+ ],
+ "x-ms-enum": {
+ "name": "DeactivationIntent",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "Pause",
+ "description": "Indicates that the node should be paused. The value is 1."
+ },
+ {
+ "value": "Restart",
+ "description": "Indicates that the intent is for the node to be restarted after a short period of time. The value is 2."
+ },
+ {
+ "value": "RemoveData",
+ "description": "Indicates the intent is for the node to remove data. The value is 3."
+ }
+ ]
+ }
+ }
+ }
+ },
+ "DeltaNodesCheckHealthEvaluation": {
+ "x-ms-discriminator-value": "DeltaNodesCheck",
+ "description": "Represents health evaluation for delta nodes, containing health evaluations for each unhealthy node that impacted current aggregated health state.\nCan be returned during cluster upgrade when the aggregated health state of the cluster is Warning or Error.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/HealthEvaluation"
+ }
+ ],
+ "properties": {
+ "BaselineErrorCount": {
+ "type": "integer",
+ "format": "int64",
+ "description": "Number of nodes with aggregated heath state Error in the health store at the beginning of the cluster upgrade."
+ },
+ "BaselineTotalCount": {
+ "type": "integer",
+ "format": "int64",
+ "description": "Total number of nodes in the health store at the beginning of the cluster upgrade."
+ },
+ "MaxPercentDeltaUnhealthyNodes": {
+ "type": "integer",
+ "description": "Maximum allowed percentage of delta unhealthy nodes from the ClusterUpgradeHealthPolicy."
+ },
+ "TotalCount": {
+ "type": "integer",
+ "format": "int64",
+ "description": "Total number of nodes in the health store."
+ },
+ "UnhealthyEvaluations": {
+ "$ref": "#/definitions/UnhealthyEvaluations",
+ "description": "List of unhealthy evaluations that led to the aggregated health state.\nIncludes all the unhealthy NodeHealthEvaluation that impacted the aggregated health."
+ }
+ }
+ },
+ "DeployedApplicationHealth": {
+ "description": "Information about the health of an application deployed on a Service Fabric node.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/EntityHealth"
+ }
+ ],
+ "properties": {
+ "Name": {
+ "$ref": "#/definitions/ApplicationName",
+ "description": "Name of the application deployed on the node whose health information is described by this object."
+ },
+ "NodeName": {
+ "$ref": "#/definitions/NodeName",
+ "description": "Name of the node where this application is deployed."
+ },
+ "DeployedServicePackageHealthStates": {
+ "$ref": "#/definitions/DeployedServicePackageHealthStateList",
+ "description": "Deployed service package health states for the current deployed application as found in the health store."
+ }
+ }
+ },
+ "DeployedApplicationHealthEvaluation": {
+ "x-ms-discriminator-value": "DeployedApplication",
+ "description": "Represents health evaluation for a deployed application, containing information about the data and the algorithm used by the health store to evaluate health.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/HealthEvaluation"
+ }
+ ],
+ "properties": {
+ "NodeName": {
+ "$ref": "#/definitions/NodeName",
+ "description": "Name of the node where the application is deployed to."
+ },
+ "ApplicationName": {
+ "$ref": "#/definitions/ApplicationName",
+ "description": "The name of the application, including the 'fabric:' URI scheme."
+ },
+ "UnhealthyEvaluations": {
+ "$ref": "#/definitions/UnhealthyEvaluations",
+ "description": "List of unhealthy evaluations that led to the current aggregated health state of the deployed application.\nThe types of the unhealthy evaluations can be DeployedServicePackagesHealthEvaluation or EventHealthEvaluation."
+ }
+ }
+ },
+ "DeployedApplicationHealthState": {
+ "description": "Represents the health state of a deployed application, which contains the entity identifier and the aggregated health state.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/EntityHealthState"
+ }
+ ],
+ "properties": {
+ "NodeName": {
+ "$ref": "#/definitions/NodeName",
+ "description": "Name of the node on which the service package is deployed."
+ },
+ "ApplicationName": {
+ "$ref": "#/definitions/ApplicationName",
+ "description": "The name of the application, including the 'fabric:' URI scheme."
+ }
+ }
+ },
+ "DeployedApplicationHealthStateChunk": {
+ "description": "Represents the health state chunk of a deployed application, which contains the node where the application is deployed, the aggregated health state and any deployed service packages that respect the chunk query description filters.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/EntityHealthStateChunk"
+ }
+ ],
+ "properties": {
+ "NodeName": {
+ "type": "string",
+ "description": "The name of node where the application is deployed."
+ },
+ "DeployedServicePackageHealthStateChunks": {
+ "$ref": "#/definitions/DeployedServicePackageHealthStateChunkList",
+ "description": "The list of deployed service package health state chunks belonging to the deployed application that respect the filters in the cluster health chunk query description."
+ }
+ }
+ },
+ "DeployedApplicationHealthStateChunkList": {
+ "description": "The list of deployed application health state chunks that respect the input filters in the chunk query. Returned by get cluster health state chunks query.",
+ "properties": {
+ "Items": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/DeployedApplicationHealthStateChunk"
+ },
+ "description": "The list of deployed application health state chunks that respect the input filters in the chunk query."
+ }
+ }
+ },
+ "DeployedApplicationHealthStateFilter": {
+ "description": "Defines matching criteria to determine whether a deployed application should be included as a child of an application in the cluster health chunk.\nThe deployed applications are only returned if the parent application matches a filter specified in the cluster health chunk query description.\nOne filter can match zero, one or multiple deployed applications, depending on its properties.",
+ "properties": {
+ "NodeNameFilter": {
+ "type": "string",
+ "description": "The name of the node where the application is deployed in order to match the filter.\nIf specified, the filter is applied only to the application deployed on the specified node.\nIf the application is not deployed on the node with the specified name, no deployed application is returned in the cluster health chunk based on this filter.\nOtherwise, the deployed application is included in the cluster health chunk if it respects the other filter properties.\nIf not specified, all deployed applications that match the parent filters (if any) are taken into consideration and matched against the other filter members, like health state filter."
+ },
+ "HealthStateFilter": {
+ "type": "integer",
+ "default": 0,
+ "description": "The filter for the health state of the deployed applications. It allows selecting deployed applications if they match the desired health states.\nThe possible values are integer value of one of the following health states. Only deployed applications that match the filter are returned. All deployed applications are used to evaluate the cluster aggregated health state.\nIf not specified, default value is None, unless the node name is specified. If the filter has default value and node name is specified, the matching deployed application is returned.\nThe state values are flag-based enumeration, so the value could be a combination of these values obtained using bitwise 'OR' operator.\nFor example, if the provided value is 6, it matches deployed applications with HealthState value of OK (2) and Warning (4).\n\n- Default - Default value. Matches any HealthState. The value is zero.\n- None - Filter that doesn't match any HealthState value. Used in order to return no results on a given collection of states. The value is 1.\n- Ok - Filter that matches input with HealthState value Ok. The value is 2.\n- Warning - Filter that matches input with HealthState value Warning. The value is 4.\n- Error - Filter that matches input with HealthState value Error. The value is 8.\n- All - Filter that matches input with any HealthState value. The value is 65535."
+ },
+ "DeployedServicePackageFilters": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/DeployedServicePackageHealthStateFilter"
+ },
+ "description": "Defines a list of filters that specify which deployed service packages to be included in the returned cluster health chunk as children of the parent deployed application. The deployed service packages are returned only if the parent deployed application matches a filter.\nIf the list is empty, no deployed service packages are returned. All the deployed service packages are used to evaluate the parent deployed application aggregated health state, regardless of the input filters.\nThe deployed application filter may specify multiple deployed service package filters.\nFor example, it can specify a filter to return all deployed service packages with health state Error and another filter to always include a deployed service package on a node."
+ }
+ }
+ },
+ "DeployedApplicationInfo": {
+ "description": "Information about application deployed on the node.",
+ "properties": {
+ "Id": {
+ "$ref": "#/definitions/ApplicationId",
+ "description": "The identity of the application. This is an encoded representation of the application name. This is used in the REST APIs to identify the application resource.\nStarting in version 6.0, hierarchical names are delimited with the \"\\~\" character. For example, if the application name is \"fabric:/myapp/app1\",\nthe application identity would be \"myapp\\~app1\" in 6.0+ and \"myapp/app1\" in previous versions."
+ },
+ "Name": {
+ "$ref": "#/definitions/ApplicationName",
+ "description": "The name of the application, including the 'fabric:' URI scheme."
+ },
+ "TypeName": {
+ "$ref": "#/definitions/ApplicationTypeName",
+ "description": "The application type name as defined in the application manifest."
+ },
+ "Status": {
+ "$ref": "#/definitions/DeployedApplicationStatus",
+ "description": "The status of the application deployed on the node. Following are the possible values."
+ },
+ "WorkDirectory": {
+ "type": "string",
+ "description": "The work directory of the application on the node. The work directory can be used to store application data."
+ },
+ "LogDirectory": {
+ "type": "string",
+ "description": "The log directory of the application on the node. The log directory can be used to store application logs."
+ },
+ "TempDirectory": {
+ "type": "string",
+ "description": "The temp directory of the application on the node. The code packages belonging to the application are forked with this directory set as their temporary directory."
+ },
+ "HealthState": {
+ "$ref": "#/definitions/HealthState",
+ "description": "The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc."
+ }
+ }
+ },
+ "DeployedApplicationInfoList": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/DeployedApplicationInfo"
+ },
+ "description": "List of deployed application information."
+ },
+ "DeployedApplicationsHealthEvaluation": {
+ "x-ms-discriminator-value": "DeployedApplications",
+ "description": "Represents health evaluation for deployed applications, containing health evaluations for each unhealthy deployed application that impacted current aggregated health state.\nCan be returned when evaluating application health and the aggregated health state is either Error or Warning.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/HealthEvaluation"
+ }
+ ],
+ "properties": {
+ "MaxPercentUnhealthyDeployedApplications": {
+ "type": "integer",
+ "description": "Maximum allowed percentage of unhealthy deployed applications from the ApplicationHealthPolicy."
+ },
+ "TotalCount": {
+ "type": "integer",
+ "format": "int64",
+ "description": "Total number of deployed applications of the application in the health store."
+ },
+ "UnhealthyEvaluations": {
+ "$ref": "#/definitions/UnhealthyEvaluations",
+ "description": "List of unhealthy evaluations that led to the aggregated health state. Includes all the unhealthy DeployedApplicationHealthEvaluation that impacted the aggregated health."
+ }
+ }
+ },
+ "DeployedApplicationStatus": {
+ "type": "string",
+ "description": "The status of the application deployed on the node. Following are the possible values.",
+ "enum": [
+ "Invalid",
+ "Downloading",
+ "Activating",
+ "Active",
+ "Upgrading",
+ "Deactivating"
+ ],
+ "x-ms-enum": {
+ "name": "DeployedApplicationStatus",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "Invalid",
+ "description": "Indicates that deployment status is not valid. All Service Fabric enumerations have the invalid type. The value is zero."
+ },
+ {
+ "value": "Downloading",
+ "description": "Indicates that the package is downloading from the ImageStore. The value is 1."
+ },
+ {
+ "value": "Activating",
+ "description": "Indicates that the package is activating. The value is 2."
+ },
+ {
+ "value": "Active",
+ "description": "Indicates that the package is active. The value is 3."
+ },
+ {
+ "value": "Upgrading",
+ "description": "Indicates that the package is upgrading. The value is 4."
+ },
+ {
+ "value": "Deactivating",
+ "description": "Indicates that the package is deactivating. The value is 5."
+ }
+ ]
+ }
+ },
+ "DeployedServicePackageHealth": {
+ "description": "Information about the health of a service package for a specific application deployed on a Service Fabric node.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/EntityHealth"
+ }
+ ],
+ "properties": {
+ "ApplicationName": {
+ "$ref": "#/definitions/ApplicationName",
+ "description": "The name of the application, including the 'fabric:' URI scheme."
+ },
+ "ServiceManifestName": {
+ "$ref": "#/definitions/ServiceManifestName",
+ "description": "Name of the service manifest."
+ },
+ "NodeName": {
+ "$ref": "#/definitions/NodeName",
+ "description": "Name of the node where this service package is deployed."
+ }
+ }
+ },
+ "DeployedServicePackageHealthEvaluation": {
+ "x-ms-discriminator-value": "DeployedServicePackage",
+ "description": "Represents health evaluation for a deployed service package, containing information about the data and the algorithm used by health store to evaluate health. The evaluation is returned only when the aggregated health state is either Error or Warning.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/HealthEvaluation"
+ }
+ ],
+ "properties": {
+ "NodeName": {
+ "$ref": "#/definitions/NodeName",
+ "description": "The name of a Service Fabric node."
+ },
+ "ApplicationName": {
+ "$ref": "#/definitions/ApplicationName",
+ "description": "The name of the application, including the 'fabric:' URI scheme."
+ },
+ "ServiceManifestName": {
+ "$ref": "#/definitions/ServiceManifestName",
+ "description": "The name of the service manifest."
+ },
+ "UnhealthyEvaluations": {
+ "$ref": "#/definitions/UnhealthyEvaluations",
+ "description": "List of unhealthy evaluations that led to the current aggregated health state. The type of the unhealthy evaluations can be EventHealthEvaluation."
+ }
+ }
+ },
+ "DeployedServicePackageHealthState": {
+ "description": "Represents the health state of a deployed service package, containing the entity identifier and the aggregated health state.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/EntityHealthState"
+ }
+ ],
+ "properties": {
+ "NodeName": {
+ "$ref": "#/definitions/NodeName",
+ "description": "Name of the node on which the service package is deployed."
+ },
+ "ApplicationName": {
+ "$ref": "#/definitions/ApplicationName",
+ "description": "The name of the application, including the 'fabric:' URI scheme."
+ },
+ "ServiceManifestName": {
+ "$ref": "#/definitions/ServiceManifestName",
+ "description": "Name of the manifest describing the service package."
+ },
+ "ServicePackageActivationId": {
+ "$ref": "#/definitions/ServicePackageActivationId",
+ "description": "The ActivationId of a deployed service package. If ServicePackageActivationMode specified at the time of creating the service\nis 'SharedProcess' (or if it is not specified, in which case it defaults to 'SharedProcess'), then value of ServicePackageActivationId\nis always an empty string."
+ }
+ }
+ },
+ "DeployedServicePackageHealthStateChunk": {
+ "description": "Represents the health state chunk of a deployed service package, which contains the service manifest name and the service package aggregated health state.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/EntityHealthStateChunk"
+ }
+ ],
+ "properties": {
+ "ServiceManifestName": {
+ "$ref": "#/definitions/ServiceManifestName",
+ "description": "The name of the service manifest."
+ },
+ "ServicePackageActivationId": {
+ "$ref": "#/definitions/ServicePackageActivationId",
+ "description": "The ActivationId of a deployed service package. If ServicePackageActivationMode specified at the time of creating the service\nis 'SharedProcess' (or if it is not specified, in which case it defaults to 'SharedProcess'), then value of ServicePackageActivationId\nis always an empty string."
+ }
+ }
+ },
+ "DeployedServicePackageHealthStateChunkList": {
+ "description": "The list of deployed service package health state chunks that respect the input filters in the chunk query. Returned by get cluster health state chunks query.",
+ "properties": {
+ "Items": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/DeployedServicePackageHealthStateChunk"
+ },
+ "description": "The list of deployed service package health state chunks that respect the input filters in the chunk query."
+ }
+ }
+ },
+ "DeployedServicePackageHealthStateFilter": {
+ "description": "Defines matching criteria to determine whether a deployed service package should be included as a child of a deployed application in the cluster health chunk.\nThe deployed service packages are only returned if the parent entities match a filter specified in the cluster health chunk query description. The parent deployed application and its parent application must be included in the cluster health chunk.\nOne filter can match zero, one or multiple deployed service packages, depending on its properties.",
+ "properties": {
+ "ServiceManifestNameFilter": {
+ "type": "string",
+ "description": "The name of the service manifest which identifies the deployed service packages that matches the filter.\nIf specified, the filter is applied only to the specified deployed service packages, if any.\nIf no deployed service packages with specified manifest name exist, nothing is returned in the cluster health chunk based on this filter.\nIf any deployed service package exists, they are included in the cluster health chunk if it respects the other filter properties.\nIf not specified, all deployed service packages that match the parent filters (if any) are taken into consideration and matched against the other filter members, like health state filter."
+ },
+ "ServicePackageActivationIdFilter": {
+ "type": "string",
+ "description": "The activation ID of a deployed service package that matches the filter.\nIf not specified, the filter applies to all deployed service packages that match the other parameters.\nIf specified, the filter matches only the deployed service package with the specified activation ID."
+ },
+ "HealthStateFilter": {
+ "type": "integer",
+ "default": 0,
+ "description": "The filter for the health state of the deployed service packages. It allows selecting deployed service packages if they match the desired health states.\nThe possible values are integer value of one of the following health states. Only deployed service packages that match the filter are returned. All deployed service packages are used to evaluate the parent deployed application aggregated health state.\nIf not specified, default value is None, unless the deployed service package ID is specified. If the filter has default value and deployed service package ID is specified, the matching deployed service package is returned.\nThe state values are flag-based enumeration, so the value could be a combination of these values obtained using bitwise 'OR' operator.\nFor example, if the provided value is 6, it matches deployed service packages with HealthState value of OK (2) and Warning (4).\n\n- Default - Default value. Matches any HealthState. The value is zero.\n- None - Filter that doesn't match any HealthState value. Used in order to return no results on a given collection of states. The value is 1.\n- Ok - Filter that matches input with HealthState value Ok. The value is 2.\n- Warning - Filter that matches input with HealthState value Warning. The value is 4.\n- Error - Filter that matches input with HealthState value Error. The value is 8.\n- All - Filter that matches input with any HealthState value. The value is 65535."
+ }
+ }
+ },
+ "DeployedServicePackageHealthStateList": {
+ "description": "List of health states for a service package deployed on a Service Fabric node.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/DeployedServicePackageHealthState"
+ }
+ },
+ "DeployedServicePackagesHealthEvaluation": {
+ "x-ms-discriminator-value": "DeployedServicePackages",
+ "description": "Represents health evaluation for deployed service packages, containing health evaluations for each unhealthy deployed service package that impacted current aggregated health state. Can be returned when evaluating deployed application health and the aggregated health state is either Error or Warning.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/HealthEvaluation"
+ }
+ ],
+ "properties": {
+ "TotalCount": {
+ "type": "integer",
+ "format": "int64",
+ "description": "Total number of deployed service packages of the deployed application in the health store."
+ },
+ "UnhealthyEvaluations": {
+ "$ref": "#/definitions/UnhealthyEvaluations",
+ "description": "List of unhealthy evaluations that led to the aggregated health state. Includes all the unhealthy DeployedServicePackageHealthEvaluation that impacted the aggregated health."
+ }
+ }
+ },
+ "DeployedServiceReplicaInfo": {
+ "discriminator": "ServiceKind",
+ "description": "Information about a Service Fabric service replica deployed on a node.",
+ "required": [
+ "ServiceKind"
+ ],
+ "properties": {
+ "ServiceKind": {
+ "$ref": "#/definitions/ServiceKind",
+ "description": "The kind of service (Stateless or Stateful)."
+ },
+ "ServiceName": {
+ "$ref": "#/definitions/ServiceName",
+ "description": "The full name of the service with 'fabric:' URI scheme."
+ },
+ "ServiceTypeName": {
+ "$ref": "#/definitions/ServiceTypeName",
+ "description": "Name of the service type as specified in the service manifest."
+ },
+ "ServiceManifestName": {
+ "$ref": "#/definitions/ServiceManifestName",
+ "description": "The name of the service manifest in which this service type is defined."
+ },
+ "CodePackageName": {
+ "$ref": "#/definitions/CodePackageName",
+ "description": "The name of the code package that hosts this replica."
+ },
+ "PartitionId": {
+ "$ref": "#/definitions/PartitionId",
+ "description": "An internal ID used by Service Fabric to uniquely identify a partition. This is a randomly generated GUID when the service was created. The partition ID is unique and does not change for the lifetime of the service. If the same service was deleted and recreated the IDs of its partitions would be different."
+ },
+ "ReplicaStatus": {
+ "$ref": "#/definitions/ReplicaStatus",
+ "description": "The status of a replica of a service."
+ },
+ "Address": {
+ "type": "string",
+ "description": "The last address returned by the replica in Open or ChangeRole."
+ },
+ "ServicePackageActivationId": {
+ "$ref": "#/definitions/ServicePackageActivationId",
+ "description": "The ActivationId of a deployed service package. If ServicePackageActivationMode specified at the time of creating the service\nis 'SharedProcess' (or if it is not specified, in which case it defaults to 'SharedProcess'), then value of ServicePackageActivationId\nis always an empty string."
+ },
+ "HostProcessId": {
+ "type": "string",
+ "description": "Host process ID of the process that is hosting the replica. This will be zero if the replica is down. In hyper-v containers this host process ID will be from different kernel."
+ }
+ }
+ },
+ "DeployedServiceReplicaInfoList": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/DeployedServiceReplicaInfo"
+ },
+ "description": "List of deployed service replica information."
+ },
+ "DeployedStatefulServiceReplicaInfo": {
+ "description": "Information about a stateful service replica deployed on a node.",
+ "x-ms-discriminator-value": "Stateful",
+ "allOf": [
+ {
+ "$ref": "#/definitions/DeployedServiceReplicaInfo"
+ }
+ ],
+ "properties": {
+ "ReplicaId": {
+ "$ref": "#/definitions/ReplicaId",
+ "description": "Id of a stateful service replica. ReplicaId is used by Service Fabric to uniquely identify a replica of a partition. It is unique within a partition and does not change for the lifetime of the replica. If a replica gets dropped and another replica gets created on the same node for the same partition, it will get a different value for the id. Sometimes the id of a stateless service instance is also referred as a replica id."
+ },
+ "ReplicaRole": {
+ "$ref": "#/definitions/ReplicaRole",
+ "description": "The role of a replica of a stateful service."
+ },
+ "ReconfigurationInformation": {
+ "$ref": "#/definitions/ReconfigurationInformation",
+ "description": "Information about current reconfiguration like phase, type, previous configuration role of replica and reconfiguration start date time."
+ }
+ }
+ },
+ "DeployedStatelessServiceInstanceInfo": {
+ "description": "Information about a stateless service instance deployed on a node.",
+ "x-ms-discriminator-value": "Stateless",
+ "allOf": [
+ {
+ "$ref": "#/definitions/DeployedServiceReplicaInfo"
+ }
+ ],
+ "properties": {
+ "InstanceId": {
+ "$ref": "#/definitions/InstanceId",
+ "description": "Id of a stateless service instance. InstanceId is used by Service Fabric to uniquely identify an instance of a partition of a stateless service. It is unique within a partition and does not change for the lifetime of the instance. If the instance has failed over on the same or different node, it will get a different value for the InstanceId."
+ }
+ }
+ },
+ "EntityHealth": {
+ "description": "Health information common to all entities in the cluster. It contains the aggregated health state, health events and unhealthy evaluation.",
+ "properties": {
+ "AggregatedHealthState": {
+ "$ref": "#/definitions/HealthState",
+ "description": "The HealthState representing the aggregated health state of the entity computed by Health Manager.\nThe health evaluation of the entity reflects all events reported on the entity and its children (if any).\nThe aggregation is done by applying the desired health policy."
+ },
+ "HealthEvents": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/HealthEvent"
+ },
+ "description": "The list of health events reported on the entity."
+ },
+ "UnhealthyEvaluations": {
+ "$ref": "#/definitions/UnhealthyEvaluations",
+ "description": "The unhealthy evaluations that show why the current aggregated health state was returned by Health Manager."
+ },
+ "HealthStatistics": {
+ "$ref": "#/definitions/HealthStatistics",
+ "description": "Shows the health statistics for all children types of the queried entity."
+ }
+ }
+ },
+ "EntityHealthState": {
+ "description": "A base type for the health state of various entities in the cluster. It contains the aggregated health state.",
+ "properties": {
+ "AggregatedHealthState": {
+ "$ref": "#/definitions/HealthState",
+ "description": "The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc."
+ }
+ }
+ },
+ "EntityHealthStateChunk": {
+ "description": "A base type for the health state chunk of various entities in the cluster. It contains the aggregated health state.",
+ "properties": {
+ "HealthState": {
+ "$ref": "#/definitions/HealthState",
+ "description": "The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc."
+ }
+ }
+ },
+ "EntityHealthStateChunkList": {
+ "description": "A base type for the list of health state chunks found in the cluster. It contains the total number of health states that match the input filters.",
+ "properties": {
+ "TotalCount": {
+ "type": "integer",
+ "format": "int64",
+ "description": "Total number of entity health state objects that match the specified filters from the cluster health chunk query description."
+ }
+ }
+ },
+ "Epoch": {
+ "description": "An Epoch is a configuration number for the partition as a whole. When the configuration of the replica set changes, for example when the Primary replica changes, the operations that are replicated from the new Primary replica are said to be a new Epoch from the ones which were sent by the old Primary replica.",
+ "properties": {
+ "ConfigurationVersion": {
+ "type": "string",
+ "description": "The current configuration number of this Epoch. The configuration number is an increasing value that is updated whenever the configuration of this replica set changes."
+ },
+ "DataLossVersion": {
+ "type": "string",
+ "description": "The current data loss number of this Epoch. The data loss number property is an increasing value which is updated whenever data loss is suspected, as when loss of a quorum of replicas in the replica set that includes the Primary replica."
+ }
+ }
+ },
+ "EventHealthEvaluation": {
+ "x-ms-discriminator-value": "Event",
+ "description": "Represents health evaluation of a HealthEvent that was reported on the entity.\nThe health evaluation is returned when evaluating health of an entity results in Error or Warning.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/HealthEvaluation"
+ }
+ ],
+ "properties": {
+ "ConsiderWarningAsError": {
+ "type": "boolean",
+ "description": "Indicates whether warnings are treated with the same severity as errors. The field is specified in the health policy used to evaluate the entity."
+ },
+ "UnhealthyEvent": {
+ "$ref": "#/definitions/HealthEvent",
+ "description": "Represents health information reported on a health entity, such as cluster, application or node, with additional metadata added by the Health Manager."
+ }
+ }
+ },
+ "EventList": {
+ "description": "A list of FabricEvent objects.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/FabricEvent"
+ }
+ },
+ "FabricCodeVersionInfo": {
+ "description": "Information about a Service Fabric code version.",
+ "properties": {
+ "CodeVersion": {
+ "description": "The product version of Service Fabric.",
+ "type": "string"
+ }
+ }
+ },
+ "FabricCodeVersionInfoList": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/FabricCodeVersionInfo"
+ },
+ "description": "List of all Service Fabric code versions."
+ },
+ "FabricConfigVersionInfo": {
+ "description": "Information about a Service Fabric config version.",
+ "properties": {
+ "ConfigVersion": {
+ "description": "The config version of Service Fabric.",
+ "type": "string"
+ }
+ }
+ },
+ "FabricConfigVersionInfoList": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/FabricConfigVersionInfo"
+ },
+ "description": "List of all Service Fabric config versions."
+ },
+ "FabricEvent": {
+ "discriminator": "Kind",
+ "description": "Represents the base for all Fabric Events.",
+ "properties": {
+ "Kind": {
+ "$ref": "#/definitions/FabricEventKind",
+ "description": "The kind of FabricEvent."
+ },
+ "EventInstanceId": {
+ "type": "string",
+ "format": "uuid",
+ "description": "The identifier for the FabricEvent instance."
+ },
+ "Category": {
+ "type": "string",
+ "description": "The category of event."
+ },
+ "TimeStamp": {
+ "type": "string",
+ "format": "date-time",
+ "description": "The time event was logged."
+ },
+ "HasCorrelatedEvents": {
+ "type": "boolean",
+ "description": "Shows there is existing related events available."
+ }
+ },
+ "required": [
+ "Kind",
+ "EventInstanceId",
+ "TimeStamp"
+ ]
+ },
+ "FabricEventKind": {
+ "type": "string",
+ "description": "The kind of FabricEvent.",
+ "enum": [
+ "ClusterEvent",
+ "ContainerInstanceEvent",
+ "NodeEvent",
+ "ApplicationEvent",
+ "ServiceEvent",
+ "PartitionEvent",
+ "ReplicaEvent",
+ "PartitionAnalysisEvent",
+ "ApplicationCreated",
+ "ApplicationDeleted",
+ "ApplicationNewHealthReport",
+ "ApplicationHealthReportExpired",
+ "ApplicationUpgradeCompleted",
+ "ApplicationUpgradeDomainCompleted",
+ "ApplicationUpgradeRollbackCompleted",
+ "ApplicationUpgradeRollbackStarted",
+ "ApplicationUpgradeStarted",
+ "DeployedApplicationNewHealthReport",
+ "DeployedApplicationHealthReportExpired",
+ "ApplicationProcessExited",
+ "ApplicationContainerInstanceExited",
+ "NodeAborted",
+ "NodeAddedToCluster",
+ "NodeClosed",
+ "NodeDeactivateCompleted",
+ "NodeDeactivateStarted",
+ "NodeDown",
+ "NodeNewHealthReport",
+ "NodeHealthReportExpired",
+ "NodeOpenSucceeded",
+ "NodeOpenFailed",
+ "NodeRemovedFromCluster",
+ "NodeUp",
+ "PartitionNewHealthReport",
+ "PartitionHealthReportExpired",
+ "PartitionReconfigured",
+ "PartitionPrimaryMoveAnalysis",
+ "ServiceCreated",
+ "ServiceDeleted",
+ "ServiceNewHealthReport",
+ "ServiceHealthReportExpired",
+ "DeployedServicePackageNewHealthReport",
+ "DeployedServicePackageHealthReportExpired",
+ "StatefulReplicaNewHealthReport",
+ "StatefulReplicaHealthReportExpired",
+ "StatelessReplicaNewHealthReport",
+ "StatelessReplicaHealthReportExpired",
+ "ClusterNewHealthReport",
+ "ClusterHealthReportExpired",
+ "ClusterUpgradeCompleted",
+ "ClusterUpgradeDomainCompleted",
+ "ClusterUpgradeRollbackCompleted",
+ "ClusterUpgradeRollbackStarted",
+ "ClusterUpgradeStarted",
+ "ChaosStopped",
+ "ChaosStarted",
+ "ChaosCodePackageRestartScheduled",
+ "ChaosReplicaRemovalScheduled",
+ "ChaosPartitionSecondaryMoveScheduled",
+ "ChaosPartitionPrimaryMoveScheduled",
+ "ChaosReplicaRestartScheduled",
+ "ChaosNodeRestartScheduled"
+ ],
+ "x-ms-enum": {
+ "name": "FabricEventKind",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "ClusterEvent"
+ },
+ {
+ "value": "ContainerInstanceEvent"
+ },
+ {
+ "value": "NodeEvent"
+ },
+ {
+ "value": "ApplicationEvent"
+ },
+ {
+ "value": "ServiceEvent"
+ },
+ {
+ "value": "PartitionEvent"
+ },
+ {
+ "value": "ReplicaEvent"
+ },
+ {
+ "value": "PartitionAnalysisEvent"
+ },
+ {
+ "value": "ApplicationCreated"
+ },
+ {
+ "value": "ApplicationDeleted"
+ },
+ {
+ "value": "ApplicationNewHealthReport"
+ },
+ {
+ "value": "ApplicationHealthReportExpired"
+ },
+ {
+ "value": "ApplicationUpgradeCompleted"
+ },
+ {
+ "value": "ApplicationUpgradeDomainCompleted"
+ },
+ {
+ "value": "ApplicationUpgradeRollbackCompleted"
+ },
+ {
+ "value": "ApplicationUpgradeRollbackStarted"
+ },
+ {
+ "value": "ApplicationUpgradeStarted"
+ },
+ {
+ "value": "DeployedApplicationNewHealthReport"
+ },
+ {
+ "value": "DeployedApplicationHealthReportExpired"
+ },
+ {
+ "value": "ApplicationProcessExited"
+ },
+ {
+ "value": "ApplicationContainerInstanceExited"
+ },
+ {
+ "value": "NodeAborted"
+ },
+ {
+ "value": "NodeAddedToCluster"
+ },
+ {
+ "value": "NodeClosed"
+ },
+ {
+ "value": "NodeDeactivateCompleted"
+ },
+ {
+ "value": "NodeDeactivateStarted"
+ },
+ {
+ "value": "NodeDown"
+ },
+ {
+ "value": "NodeNewHealthReport"
+ },
+ {
+ "value": "NodeHealthReportExpired"
+ },
+ {
+ "value": "NodeOpenSucceeded"
+ },
+ {
+ "value": "NodeOpenFailed"
+ },
+ {
+ "value": "NodeRemovedFromCluster"
+ },
+ {
+ "value": "NodeUp"
+ },
+ {
+ "value": "PartitionNewHealthReport"
+ },
+ {
+ "value": "PartitionHealthReportExpired"
+ },
+ {
+ "value": "PartitionReconfigured"
+ },
+ {
+ "value": "PartitionPrimaryMoveAnalysis"
+ },
+ {
+ "value": "ServiceCreated"
+ },
+ {
+ "value": "ServiceDeleted"
+ },
+ {
+ "value": "ServiceNewHealthReport"
+ },
+ {
+ "value": "ServiceHealthReportExpired"
+ },
+ {
+ "value": "DeployedServicePackageNewHealthReport"
+ },
+ {
+ "value": "DeployedServicePackageHealthReportExpired"
+ },
+ {
+ "value": "StatefulReplicaNewHealthReport"
+ },
+ {
+ "value": "StatefulReplicaHealthReportExpired"
+ },
+ {
+ "value": "StatelessReplicaNewHealthReport"
+ },
+ {
+ "value": "StatelessReplicaHealthReportExpired"
+ },
+ {
+ "value": "ClusterNewHealthReport"
+ },
+ {
+ "value": "ClusterHealthReportExpired"
+ },
+ {
+ "value": "ClusterUpgradeCompleted"
+ },
+ {
+ "value": "ClusterUpgradeDomainCompleted"
+ },
+ {
+ "value": "ClusterUpgradeRollbackCompleted"
+ },
+ {
+ "value": "ClusterUpgradeRollbackStarted"
+ },
+ {
+ "value": "ClusterUpgradeStarted"
+ },
+ {
+ "value": "ChaosStopped"
+ },
+ {
+ "value": "ChaosStarted"
+ },
+ {
+ "value": "ChaosCodePackageRestartScheduled"
+ },
+ {
+ "value": "ChaosReplicaRemovalScheduled"
+ },
+ {
+ "value": "ChaosPartitionSecondaryMoveScheduled"
+ },
+ {
+ "value": "ChaosPartitionPrimaryMoveScheduled"
+ },
+ {
+ "value": "ChaosReplicaRestartScheduled"
+ },
+ {
+ "value": "ChaosNodeRestartScheduled"
+ }
+ ]
+ }
+ },
+ "ClusterConfigurationUpgradeStatusInfo": {
+ "description": "Information about a standalone cluster configuration upgrade status.",
+ "properties": {
+ "UpgradeState": {
+ "$ref": "#/definitions/UpgradeState",
+ "description": "The state of the upgrade domain."
+ },
+ "ProgressStatus": {
+ "type": "integer",
+ "description": "The cluster manifest version."
+ },
+ "ConfigVersion": {
+ "type": "string",
+ "description": "The cluster configuration version."
+ },
+ "Details": {
+ "type": "string",
+ "description": "The cluster upgrade status details."
+ }
+ }
+ },
+ "FailureAction": {
+ "type": "string",
+ "description": "The compensating action to perform when a Monitored upgrade encounters monitoring policy or health policy violations.\nInvalid indicates the failure action is invalid. Rollback specifies that the upgrade will start rolling back automatically.\nManual indicates that the upgrade will switch to UnmonitoredManual upgrade mode.",
+ "enum": [
+ "Invalid",
+ "Rollback",
+ "Manual"
+ ],
+ "x-ms-enum": {
+ "name": "FailureAction",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "Invalid",
+ "description": "Indicates the failure action is invalid. All Service Fabric enumerations have the invalid type. The value is zero."
+ },
+ {
+ "value": "Rollback",
+ "description": "The upgrade will start rolling back automatically. The value is 1"
+ },
+ {
+ "value": "Manual",
+ "description": "The upgrade will switch to UnmonitoredManual upgrade mode. The value is 2"
+ }
+ ]
+ }
+ },
+ "FailureReason": {
+ "type": "string",
+ "description": "The cause of an upgrade failure that resulted in FailureAction being executed.",
+ "enum": [
+ "None",
+ "Interrupted",
+ "HealthCheck",
+ "UpgradeDomainTimeout",
+ "OverallUpgradeTimeout"
+ ],
+ "x-ms-enum": {
+ "name": "FailureReason",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "None",
+ "description": "Indicates the reason is invalid or unknown. All Service Fabric enumerations have the invalid type. The value is zero."
+ },
+ {
+ "value": "Interrupted",
+ "description": "There was an external request to roll back the upgrade. The value is 1"
+ },
+ {
+ "value": "HealthCheck",
+ "description": "The upgrade failed due to health policy violations. The value is 2"
+ },
+ {
+ "value": "UpgradeDomainTimeout",
+ "description": "An upgrade domain took longer than the allowed upgrade domain timeout to process. The value is 3"
+ },
+ {
+ "value": "OverallUpgradeTimeout",
+ "description": "The overall upgrade took longer than the allowed upgrade timeout to process. The value is 4"
+ }
+ ]
+ }
+ },
+ "FailureUpgradeDomainProgressInfo": {
+ "description": "Information about the upgrade domain progress at the time of upgrade failure.",
+ "properties": {
+ "DomainName": {
+ "$ref": "#/definitions/UpgradeDomainName",
+ "description": "The name of the upgrade domain"
+ },
+ "NodeUpgradeProgressList": {
+ "$ref": "#/definitions/NodeUpgradeProgressInfoList",
+ "description": "List of upgrading nodes and their statuses"
+ }
+ }
+ },
+ "ForceRestart": {
+ "type": "boolean",
+ "description": "If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data).",
+ "default": false
+ },
+ "HealthCheckRetryTimeout": {
+ "type": "string",
+ "description": "The amount of time to retry health evaluation when the application or cluster is unhealthy before FailureAction is executed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds.",
+ "default": "PT0H10M0S"
+ },
+ "HealthCheckStableDuration": {
+ "type": "string",
+ "description": "The amount of time that the application or cluster must remain healthy before the upgrade proceeds to the next upgrade domain. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds.",
+ "default": "PT0H2M0S"
+ },
+ "HealthCheckWaitDuration": {
+ "type": "string",
+ "description": "The amount of time to wait after completing an upgrade domain before applying health policies. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds.",
+ "default": "0"
+ },
+ "HealthEvaluation": {
+ "discriminator": "Kind",
+ "description": "Represents a health evaluation which describes the data and the algorithm used by health manager to evaluate the health of an entity.",
+ "properties": {
+ "Kind": {
+ "$ref": "#/definitions/HealthEvaluationKind",
+ "description": "The health manager in the cluster performs health evaluations in determining the aggregated health state of an entity. This enumeration provides information on the kind of evaluation that was performed. Following are the possible values."
+ },
+ "AggregatedHealthState": {
+ "$ref": "#/definitions/HealthState",
+ "description": "The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc."
+ },
+ "Description": {
+ "type": "string",
+ "description": "Description of the health evaluation, which represents a summary of the evaluation process."
+ }
+ },
+ "required": [
+ "Kind"
+ ]
+ },
+ "HealthEvaluationKind": {
+ "type": "string",
+ "description": "The health manager in the cluster performs health evaluations in determining the aggregated health state of an entity. This enumeration provides information on the kind of evaluation that was performed. Following are the possible values.",
+ "enum": [
+ "Invalid",
+ "Event",
+ "Replicas",
+ "Partitions",
+ "DeployedServicePackages",
+ "DeployedApplications",
+ "Services",
+ "Nodes",
+ "Applications",
+ "SystemApplication",
+ "UpgradeDomainDeployedApplications",
+ "UpgradeDomainNodes",
+ "Replica",
+ "Partition",
+ "DeployedServicePackage",
+ "DeployedApplication",
+ "Service",
+ "Node",
+ "Application",
+ "DeltaNodesCheck",
+ "UpgradeDomainDeltaNodesCheck",
+ "ApplicationTypeApplications"
+ ],
+ "x-ms-enum": {
+ "name": "HealthEvaluationKind",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "Invalid",
+ "description": "Indicates that the health evaluation is invalid. The value is zero."
+ },
+ {
+ "value": "Event",
+ "description": "Indicates that the health evaluation is for a health event. The value is 1."
+ },
+ {
+ "value": "Replicas",
+ "description": "Indicates that the health evaluation is for the replicas of a partition. The value is 2."
+ },
+ {
+ "value": "Partitions",
+ "description": "Indicates that the health evaluation is for the partitions of a service. The value is 3."
+ },
+ {
+ "value": "DeployedServicePackages",
+ "description": "Indicates that the health evaluation is for the deployed service packages of a deployed application. The value is 4."
+ },
+ {
+ "value": "DeployedApplications",
+ "description": "Indicates that the health evaluation is for the deployed applications of an application. The value is 5."
+ },
+ {
+ "value": "Services",
+ "description": "Indicates that the health evaluation is for services of an application. The value is 6."
+ },
+ {
+ "value": "Nodes",
+ "description": "Indicates that the health evaluation is for the cluster nodes. The value is 7."
+ },
+ {
+ "value": "Applications",
+ "description": "Indicates that the health evaluation is for the cluster applications. The value is 8."
+ },
+ {
+ "value": "SystemApplication",
+ "description": "Indicates that the health evaluation is for the system application. The value is 9."
+ },
+ {
+ "value": "UpgradeDomainDeployedApplications",
+ "description": "Indicates that the health evaluation is for the deployed applications of an application in an upgrade domain. The value is 10."
+ },
+ {
+ "value": "UpgradeDomainNodes",
+ "description": "Indicates that the health evaluation is for the cluster nodes in an upgrade domain. The value is 11."
+ },
+ {
+ "value": "Replica",
+ "description": "Indicates that the health evaluation is for a replica. The value is 13."
+ },
+ {
+ "value": "Partition",
+ "description": "Indicates that the health evaluation is for a partition. The value is 14."
+ },
+ {
+ "value": "DeployedServicePackage",
+ "description": "Indicates that the health evaluation is for a deployed service package. The value is 16."
+ },
+ {
+ "value": "DeployedApplication",
+ "description": "Indicates that the health evaluation is for a deployed application. The value is 17."
+ },
+ {
+ "value": "Service",
+ "description": "Indicates that the health evaluation is for a service. The value is 15."
+ },
+ {
+ "value": "Node",
+ "description": "Indicates that the health evaluation is for a node. The value is 12."
+ },
+ {
+ "value": "Application",
+ "description": "Indicates that the health evaluation is for an application. The value is 18."
+ },
+ {
+ "value": "DeltaNodesCheck",
+ "description": "Indicates that the health evaluation is for the delta of unhealthy cluster nodes. The value is 19."
+ },
+ {
+ "value": "UpgradeDomainDeltaNodesCheck",
+ "description": "Indicates that the health evaluation is for the delta of unhealthy upgrade domain cluster nodes. The value is 20."
+ },
+ {
+ "value": "ApplicationTypeApplications",
+ "description": "– Indicates that the health evaluation is for applications of an application type. The value is 21."
+ }
+ ]
+ }
+ },
+ "HealthEvaluationWrapper": {
+ "description": "Wrapper object for health evaluation.",
+ "properties": {
+ "HealthEvaluation": {
+ "$ref": "#/definitions/HealthEvaluation",
+ "description": "Represents a health evaluation which describes the data and the algorithm used by health manager to evaluate the health of an entity."
+ }
+ }
+ },
+ "HealthEvent": {
+ "description": "Represents health information reported on a health entity, such as cluster, application or node, with additional metadata added by the Health Manager.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/HealthInformation"
+ }
+ ],
+ "properties": {
+ "IsExpired": {
+ "type": "boolean",
+ "description": "Returns true if the health event is expired, otherwise false."
+ },
+ "SourceUtcTimestamp": {
+ "type": "string",
+ "format": "date-time",
+ "description": "The date and time when the health report was sent by the source."
+ },
+ "LastModifiedUtcTimestamp": {
+ "type": "string",
+ "format": "date-time",
+ "description": "The date and time when the health report was last modified by the health store."
+ },
+ "LastOkTransitionAt": {
+ "type": "string",
+ "format": "date-time",
+ "description": "If the current health state is 'Ok', this property returns the time at which the health report was first reported with 'Ok'.\nFor periodic reporting, many reports with the same state may have been generated.\nThis property returns the date and time when the first 'Ok' health report was received.\n\nIf the current health state is 'Error' or 'Warning', returns the date and time at which the health state was last in 'Ok', before transitioning to a different state.\n\nIf the health state was never 'Ok', the value will be zero date-time."
+ },
+ "LastWarningTransitionAt": {
+ "type": "string",
+ "format": "date-time",
+ "description": "If the current health state is 'Warning', this property returns the time at which the health report was first reported with 'Warning'. For periodic reporting, many reports with the same state may have been generated however, this property returns only the date and time at the first 'Warning' health report was received.\n\nIf the current health state is 'Ok' or 'Error', returns the date and time at which the health state was last in 'Warning', before transitioning to a different state.\n\nIf the health state was never 'Warning', the value will be zero date-time."
+ },
+ "LastErrorTransitionAt": {
+ "type": "string",
+ "format": "date-time",
+ "description": "If the current health state is 'Error', this property returns the time at which the health report was first reported with 'Error'. For periodic reporting, many reports with the same state may have been generated however, this property returns only the date and time at the first 'Error' health report was received.\n\nIf the current health state is 'Ok' or 'Warning', returns the date and time at which the health state was last in 'Error', before transitioning to a different state.\n\nIf the health state was never 'Error', the value will be zero date-time."
+ }
+ }
+ },
+ "HealthInformation": {
+ "description": "Represents common health report information. It is included in all health reports sent to health store and in all health events returned by health queries.",
+ "required": [
+ "SourceId",
+ "Property",
+ "HealthState"
+ ],
+ "properties": {
+ "SourceId": {
+ "type": "string",
+ "description": "The source name that identifies the client/watchdog/system component that generated the health information."
+ },
+ "Property": {
+ "type": "string",
+ "description": "The property of the health information. An entity can have health reports for different properties.\nThe property is a string and not a fixed enumeration to allow the reporter flexibility to categorize the state condition that triggers the report.\nFor example, a reporter with SourceId \"LocalWatchdog\" can monitor the state of the available disk on a node,\nso it can report \"AvailableDisk\" property on that node.\nThe same reporter can monitor the node connectivity, so it can report a property \"Connectivity\" on the same node.\nIn the health store, these reports are treated as separate health events for the specified node.\n\nTogether with the SourceId, the property uniquely identifies the health information."
+ },
+ "HealthState": {
+ "$ref": "#/definitions/HealthState",
+ "description": "The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc."
+ },
+ "TimeToLiveInMilliSeconds": {
+ "type": "string",
+ "format": "duration",
+ "description": "The duration for which this health report is valid. This field uses ISO8601 format for specifying the duration.\nWhen clients report periodically, they should send reports with higher frequency than time to live.\nIf clients report on transition, they can set the time to live to infinite.\nWhen time to live expires, the health event that contains the health information\nis either removed from health store, if RemoveWhenExpired is true, or evaluated at error, if RemoveWhenExpired false.\n\nIf not specified, time to live defaults to infinite value."
+ },
+ "Description": {
+ "type": "string",
+ "description": "The description of the health information. It represents free text used to add human readable information about the report.\nThe maximum string length for the description is 4096 characters.\nIf the provided string is longer, it will be automatically truncated.\nWhen truncated, the last characters of the description contain a marker \"[Truncated]\", and total string size is 4096 characters.\nThe presence of the marker indicates to users that truncation occurred.\nNote that when truncated, the description has less than 4096 characters from the original string."
+ },
+ "SequenceNumber": {
+ "type": "string",
+ "description": "The sequence number for this health report as a numeric string.\nThe report sequence number is used by the health store to detect stale reports.\nIf not specified, a sequence number is auto-generated by the health client when a report is added."
+ },
+ "RemoveWhenExpired": {
+ "type": "boolean",
+ "description": "Value that indicates whether the report is removed from health store when it expires.\nIf set to true, the report is removed from the health store after it expires.\nIf set to false, the report is treated as an error when expired. The value of this property is false by default.\nWhen clients report periodically, they should set RemoveWhenExpired false (default).\nThis way, if the reporter has issues (e.g. deadlock) and can't report, the entity is evaluated at error when the health report expires.\nThis flags the entity as being in Error health state."
+ },
+ "HealthReportId": {
+ "type": "string",
+ "description": "A health report ID which identifies the health report and can be used to find more detailed information about a specific health event at\naka.ms/sfhealthid"
+ }
+ }
+ },
+ "Int64RangePartitionInformation": {
+ "description": "Describes the partition information for the integer range that is based on partition schemes.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/PartitionInformation"
+ }
+ ],
+ "x-ms-discriminator-value": "Int64Range",
+ "properties": {
+ "LowKey": {
+ "type": "string",
+ "description": "Specifies the minimum key value handled by this partition."
+ },
+ "HighKey": {
+ "type": "string",
+ "description": "Specifies the maximum key value handled by this partition."
+ }
+ }
+ },
+ "MinInstanceCount": {
+ "type": "integer",
+ "default": 1,
+ "minimum": 1,
+ "description": "MinInstanceCount is the minimum number of instances that must be up to meet the EnsureAvailability safety check during operations like upgrade or deactivate node.\nThe actual number that is used is max( MinInstanceCount, ceil( MinInstancePercentage/100.0 * InstanceCount) ).\nNote, if InstanceCount is set to -1, during MinInstanceCount computation -1 is first converted into the number of nodes on which the instances are allowed to be placed according to the placement constraints on the service."
+ },
+ "MinInstancePercentage": {
+ "type": "integer",
+ "default": 0,
+ "minimum": 0,
+ "maximum": 100,
+ "description": "MinInstancePercentage is the minimum percentage of InstanceCount that must be up to meet the EnsureAvailability safety check during operations like upgrade or deactivate node.\nThe actual number that is used is max( MinInstanceCount, ceil( MinInstancePercentage/100.0 * InstanceCount) ).\nNote, if InstanceCount is set to -1, during MinInstancePercentage computation, -1 is first converted into the number of nodes on which the instances are allowed to be placed according to the placement constraints on the service."
+ },
+ "MonitoringPolicyDescription": {
+ "description": "Describes the parameters for monitoring an upgrade in Monitored mode.",
+ "properties": {
+ "FailureAction": {
+ "$ref": "#/definitions/FailureAction",
+ "description": "The compensating action to perform when a Monitored upgrade encounters monitoring policy or health policy violations.\nInvalid indicates the failure action is invalid. Rollback specifies that the upgrade will start rolling back automatically.\nManual indicates that the upgrade will switch to UnmonitoredManual upgrade mode."
+ },
+ "HealthCheckWaitDurationInMilliseconds": {
+ "$ref": "#/definitions/HealthCheckWaitDuration",
+ "description": "The amount of time to wait after completing an upgrade domain before applying health policies. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds."
+ },
+ "HealthCheckStableDurationInMilliseconds": {
+ "$ref": "#/definitions/HealthCheckStableDuration",
+ "description": "The amount of time that the application or cluster must remain healthy before the upgrade proceeds to the next upgrade domain. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds."
+ },
+ "HealthCheckRetryTimeoutInMilliseconds": {
+ "$ref": "#/definitions/HealthCheckRetryTimeout",
+ "description": "The amount of time to retry health evaluation when the application or cluster is unhealthy before FailureAction is executed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds."
+ },
+ "UpgradeTimeoutInMilliseconds": {
+ "$ref": "#/definitions/UpgradeTimeout",
+ "description": "The amount of time the overall upgrade has to complete before FailureAction is executed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds."
+ },
+ "UpgradeDomainTimeoutInMilliseconds": {
+ "$ref": "#/definitions/UpgradeDomainTimeout",
+ "description": "The amount of time each upgrade domain has to complete before FailureAction is executed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds."
+ }
+ }
+ },
+ "NamedPartitionInformation": {
+ "description": "Describes the partition information for the name as a string that is based on partition schemes.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/PartitionInformation"
+ }
+ ],
+ "x-ms-discriminator-value": "Named",
+ "properties": {
+ "Name": {
+ "type": "string",
+ "description": "Name of the partition."
+ }
+ }
+ },
+ "NextUpgradeDomain": {
+ "type": "string",
+ "description": "The name of the next upgrade domain to be processed."
+ },
+ "NodeDeactivationInfo": {
+ "description": "Information about the node deactivation. This information is valid for a node that is undergoing deactivation or has already been deactivated.",
+ "properties": {
+ "NodeDeactivationIntent": {
+ "$ref": "#/definitions/NodeDeactivationIntent",
+ "description": "The intent or the reason for deactivating the node. Following are the possible values for it."
+ },
+ "NodeDeactivationStatus": {
+ "$ref": "#/definitions/NodeDeactivationStatus",
+ "description": "The status of node deactivation operation. Following are the possible values."
+ },
+ "NodeDeactivationTask": {
+ "$ref": "#/definitions/NodeDeactivationTaskList",
+ "description": "List of tasks representing the deactivation operation on the node."
+ },
+ "PendingSafetyChecks": {
+ "$ref": "#/definitions/SafetyCheckInfoList",
+ "description": "List of pending safety checks"
+ }
+ }
+ },
+ "NodeDeactivationIntent": {
+ "type": "string",
+ "description": "The intent or the reason for deactivating the node. Following are the possible values for it.",
+ "enum": [
+ "Invalid",
+ "Pause",
+ "Restart",
+ "RemoveData",
+ "RemoveNode"
+ ],
+ "x-ms-enum": {
+ "name": "NodeDeactivationIntent",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "Invalid",
+ "description": "Indicates the node deactivation intent is invalid. All Service Fabric enumerations have the invalid type. The value is zero. This value is not used."
+ },
+ {
+ "value": "Pause",
+ "description": "Indicates that the node should be paused. The value is 1."
+ },
+ {
+ "value": "Restart",
+ "description": "Indicates that the intent is for the node to be restarted after a short period of time. Service Fabric does not restart the node, this action is done outside of Service Fabric. The value is 2."
+ },
+ {
+ "value": "RemoveData",
+ "description": "Indicates that the intent is to reimage the node. Service Fabric does not reimage the node, this action is done outside of Service Fabric. The value is 3."
+ },
+ {
+ "value": "RemoveNode",
+ "description": "Indicates that the node is being decommissioned and is not expected to return. Service Fabric does not decommission the node, this action is done outside of Service Fabric. The value is 4."
+ }
+ ]
+ }
+ },
+ "NodeDeactivationStatus": {
+ "type": "string",
+ "description": "The status of node deactivation operation. Following are the possible values.",
+ "enum": [
+ "None",
+ "SafetyCheckInProgress",
+ "SafetyCheckComplete",
+ "Completed"
+ ],
+ "x-ms-enum": {
+ "name": "NodeDeactivationStatus",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "None",
+ "description": "No status is associated with the task. The value is zero."
+ },
+ {
+ "value": "SafetyCheckInProgress",
+ "description": "When a node is deactivated Service Fabric performs checks to ensure that the operation is safe to proceed to ensure availability of the service and reliability of the state. This value indicates that one or more safety checks are in progress. The value is 1."
+ },
+ {
+ "value": "SafetyCheckComplete",
+ "description": "When a node is deactivated Service Fabric performs checks to ensure that the operation is safe to proceed to ensure availability of the service and reliability of the state. This value indicates that all safety checks have been completed. The value is 2."
+ },
+ {
+ "value": "Completed",
+ "description": "The task is completed. The value is 3."
+ }
+ ]
+ }
+ },
+ "NodeDeactivationTask": {
+ "description": "The task representing the deactivation operation on the node.",
+ "properties": {
+ "NodeDeactivationTaskId": {
+ "$ref": "#/definitions/NodeDeactivationTaskId",
+ "description": "Identity of the task related to deactivation operation on the node."
+ },
+ "NodeDeactivationIntent": {
+ "$ref": "#/definitions/NodeDeactivationIntent",
+ "description": "The intent or the reason for deactivating the node. Following are the possible values for it."
+ }
+ }
+ },
+ "NodeDeactivationTaskId": {
+ "description": "Identity of the task related to deactivation operation on the node.",
+ "properties": {
+ "Id": {
+ "type": "string",
+ "description": "Value of the task id."
+ },
+ "NodeDeactivationTaskType": {
+ "$ref": "#/definitions/NodeDeactivationTaskType",
+ "description": "The type of the task that performed the node deactivation. Following are the possible values."
+ }
+ }
+ },
+ "NodeDeactivationTaskList": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/NodeDeactivationTask"
+ },
+ "description": "List of tasks representing the deactivation operation on the node."
+ },
+ "NodeDeactivationTaskType": {
+ "type": "string",
+ "description": "The type of the task that performed the node deactivation. Following are the possible values.",
+ "enum": [
+ "Invalid",
+ "Infrastructure",
+ "Repair",
+ "Client"
+ ],
+ "x-ms-enum": {
+ "name": "NodeDeactivationTaskType",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "Invalid",
+ "description": "Indicates the node deactivation task type is invalid. All Service Fabric enumerations have the invalid type. The value is zero. This value is not used."
+ },
+ {
+ "value": "Infrastructure",
+ "description": "Specifies the task created by Infrastructure hosting the nodes. The value is 1."
+ },
+ {
+ "value": "Repair",
+ "description": "Specifies the task that was created by the Repair Manager service. The value is 2."
+ },
+ {
+ "value": "Client",
+ "description": "Specifies that the task was created by using the public API. The value is 3."
+ }
+ ]
+ }
+ },
+ "NodeEvent": {
+ "description": "Represents the base for all Node Events.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/FabricEvent"
+ }
+ ],
+ "properties": {
+ "NodeName": {
+ "$ref": "#/definitions/NodeName",
+ "description": "The name of a Service Fabric node."
+ }
+ },
+ "required": [
+ "NodeName"
+ ],
+ "x-ms-discriminator-value": "NodeEvent"
+ },
+ "NodeEventList": {
+ "description": "A list of NodeEvent objects.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/NodeEvent"
+ }
+ },
+ "NodeHealth": {
+ "description": "Information about the health of a Service Fabric node.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/EntityHealth"
+ }
+ ],
+ "properties": {
+ "Name": {
+ "$ref": "#/definitions/NodeName",
+ "description": "Name of the node whose health information is described by this object."
+ }
+ }
+ },
+ "NodeHealthEvaluation": {
+ "x-ms-discriminator-value": "Node",
+ "description": "Represents health evaluation for a node, containing information about the data and the algorithm used by health store to evaluate health. The evaluation is returned only when the aggregated health state is either Error or Warning.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/HealthEvaluation"
+ }
+ ],
+ "properties": {
+ "NodeName": {
+ "$ref": "#/definitions/NodeName",
+ "description": "The name of a Service Fabric node."
+ },
+ "UnhealthyEvaluations": {
+ "$ref": "#/definitions/UnhealthyEvaluations",
+ "description": "List of unhealthy evaluations that led to the current aggregated health state of the node. The types of the unhealthy evaluations can be EventHealthEvaluation."
+ }
+ }
+ },
+ "NodeHealthState": {
+ "description": "Represents the health state of a node, which contains the node identifier and its aggregated health state.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/EntityHealthState"
+ }
+ ],
+ "properties": {
+ "Name": {
+ "$ref": "#/definitions/NodeName",
+ "description": "The name of a Service Fabric node."
+ },
+ "Id": {
+ "$ref": "#/definitions/NodeId",
+ "description": "An internal ID used by Service Fabric to uniquely identify a node. Node Id is deterministically generated from node name."
+ }
+ }
+ },
+ "NodeHealthStateChunk": {
+ "description": "Represents the health state chunk of a node, which contains the node name and its aggregated health state.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/EntityHealthStateChunk"
+ }
+ ],
+ "properties": {
+ "NodeName": {
+ "$ref": "#/definitions/NodeName",
+ "description": "The name of a Service Fabric node."
+ }
+ }
+ },
+ "NodeHealthStateChunkList": {
+ "description": "The list of node health state chunks in the cluster that respect the input filters in the chunk query. Returned by get cluster health state chunks query.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/EntityHealthStateChunkList"
+ }
+ ],
+ "properties": {
+ "Items": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/NodeHealthStateChunk"
+ },
+ "description": "The list of node health state chunks that respect the input filters in the chunk query."
+ }
+ }
+ },
+ "NodeHealthStateFilter": {
+ "description": "Defines matching criteria to determine whether a node should be included in the returned cluster health chunk.\nOne filter can match zero, one or multiple nodes, depending on its properties.\nCan be specified in the cluster health chunk query description.",
+ "properties": {
+ "NodeNameFilter": {
+ "type": "string",
+ "description": "Name of the node that matches the filter. The filter is applied only to the specified node, if it exists.\nIf the node doesn't exist, no node is returned in the cluster health chunk based on this filter.\nIf the node exists, it is included in the cluster health chunk if the health state matches the other filter properties.\nIf not specified, all nodes that match the parent filters (if any) are taken into consideration and matched against the other filter members, like health state filter."
+ },
+ "HealthStateFilter": {
+ "type": "integer",
+ "default": 0,
+ "description": "The filter for the health state of the nodes. It allows selecting nodes if they match the desired health states.\nThe possible values are integer value of one of the following health states. Only nodes that match the filter are returned. All nodes are used to evaluate the cluster aggregated health state.\nIf not specified, default value is None, unless the node name is specified. If the filter has default value and node name is specified, the matching node is returned.\nThe state values are flag-based enumeration, so the value could be a combination of these values obtained using bitwise 'OR' operator.\nFor example, if the provided value is 6, it matches nodes with HealthState value of OK (2) and Warning (4).\n\n- Default - Default value. Matches any HealthState. The value is zero.\n- None - Filter that doesn't match any HealthState value. Used in order to return no results on a given collection of states. The value is 1.\n- Ok - Filter that matches input with HealthState value Ok. The value is 2.\n- Warning - Filter that matches input with HealthState value Warning. The value is 4.\n- Error - Filter that matches input with HealthState value Error. The value is 8.\n- All - Filter that matches input with any HealthState value. The value is 65535."
+ }
+ }
+ },
+ "NodeId": {
+ "description": "An internal ID used by Service Fabric to uniquely identify a node. Node Id is deterministically generated from node name.",
+ "properties": {
+ "Id": {
+ "type": "string",
+ "description": "Value of the node Id. This is a 128 bit integer."
+ }
+ }
+ },
+ "NodeIdList": {
+ "description": "A list of NodeIds.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/NodeId"
+ }
+ },
+ "NodeInfo": {
+ "description": "Information about a node in Service Fabric cluster.",
+ "properties": {
+ "Name": {
+ "$ref": "#/definitions/NodeName",
+ "description": "The name of a Service Fabric node."
+ },
+ "IpAddressOrFQDN": {
+ "type": "string",
+ "description": "The IP address or fully qualified domain name of the node."
+ },
+ "Type": {
+ "type": "string",
+ "description": "The type of the node."
+ },
+ "CodeVersion": {
+ "type": "string",
+ "description": "The version of Service Fabric binaries that the node is running."
+ },
+ "ConfigVersion": {
+ "type": "string",
+ "description": "The version of Service Fabric cluster manifest that the node is using."
+ },
+ "NodeStatus": {
+ "$ref": "#/definitions/NodeStatus",
+ "description": "The status of the node."
+ },
+ "NodeUpTimeInSeconds": {
+ "type": "string",
+ "description": "Time in seconds since the node has been in NodeStatus Up. Value zero indicates that the node is not Up."
+ },
+ "HealthState": {
+ "$ref": "#/definitions/HealthState",
+ "description": "The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc."
+ },
+ "IsSeedNode": {
+ "type": "boolean",
+ "description": "Indicates if the node is a seed node or not. Returns true if the node is a seed node, otherwise false. A quorum of seed nodes are required for proper operation of Service Fabric cluster."
+ },
+ "UpgradeDomain": {
+ "type": "string",
+ "description": "The upgrade domain of the node."
+ },
+ "FaultDomain": {
+ "type": "string",
+ "description": "The fault domain of the node."
+ },
+ "Id": {
+ "$ref": "#/definitions/NodeId",
+ "description": "An internal ID used by Service Fabric to uniquely identify a node. Node Id is deterministically generated from node name."
+ },
+ "InstanceId": {
+ "type": "string",
+ "description": "The ID representing the node instance. While the ID of the node is deterministically generated from the node name and remains same across restarts, the InstanceId changes every time node restarts."
+ },
+ "NodeDeactivationInfo": {
+ "$ref": "#/definitions/NodeDeactivationInfo",
+ "description": "Information about the node deactivation. This information is valid for a node that is undergoing deactivation or has already been deactivated."
+ },
+ "IsStopped": {
+ "type": "boolean",
+ "description": "Indicates if the node is stopped by calling stop node API or not. Returns true if the node is stopped, otherwise false."
+ },
+ "NodeDownTimeInSeconds": {
+ "type": "string",
+ "description": "Time in seconds since the node has been in NodeStatus Down. Value zero indicates node is not NodeStatus Down."
+ },
+ "NodeUpAt": {
+ "type": "string",
+ "format": "date-time",
+ "description": "Date time in UTC when the node came up. If the node has never been up then this value will be zero date time."
+ },
+ "NodeDownAt": {
+ "type": "string",
+ "format": "date-time",
+ "description": "Date time in UTC when the node went down. If node has never been down then this value will be zero date time."
+ }
+ }
+ },
+ "NodeLoadInfo": {
+ "description": "Information about load on a Service Fabric node. It holds a summary of all metrics and their load on a node.",
+ "properties": {
+ "NodeName": {
+ "$ref": "#/definitions/NodeName",
+ "description": "Name of the node for which the load information is provided by this object."
+ },
+ "NodeLoadMetricInformation": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/NodeLoadMetricInformation"
+ },
+ "description": "List that contains metrics and their load information on this node."
+ }
+ }
+ },
+ "NodeLoadMetricInformation": {
+ "description": "Represents data structure that contains load information for a certain metric on a node.",
+ "properties": {
+ "Name": {
+ "type": "string",
+ "description": "Name of the metric for which this load information is provided."
+ },
+ "NodeCapacity": {
+ "type": "string",
+ "description": "Total capacity on the node for this metric."
+ },
+ "NodeLoad": {
+ "type": "string",
+ "description": "Current load on the node for this metric. In future releases of Service Fabric this parameter will be deprecated in favor of CurrentNodeLoad."
+ },
+ "NodeRemainingCapacity": {
+ "type": "string",
+ "description": "The remaining capacity on the node for this metric. In future releases of Service Fabric this parameter will be deprecated in favor of NodeCapacityRemaining."
+ },
+ "IsCapacityViolation": {
+ "type": "boolean",
+ "description": "Indicates if there is a capacity violation for this metric on the node."
+ },
+ "NodeBufferedCapacity": {
+ "type": "string",
+ "description": "The value that indicates the reserved capacity for this metric on the node."
+ },
+ "NodeRemainingBufferedCapacity": {
+ "type": "string",
+ "description": "The remaining reserved capacity for this metric on the node. In future releases of Service Fabric this parameter will be deprecated in favor of BufferedNodeCapacityRemaining."
+ },
+ "CurrentNodeLoad": {
+ "type": "string",
+ "format": "double",
+ "description": "Current load on the node for this metric."
+ },
+ "NodeCapacityRemaining": {
+ "type": "string",
+ "format": "double",
+ "description": "The remaining capacity on the node for the metric."
+ },
+ "BufferedNodeCapacityRemaining": {
+ "type": "string",
+ "format": "double",
+ "description": "The remaining capacity which is not reserved by NodeBufferPercentage for this metric on the node."
+ },
+ "PlannedNodeLoadRemoval": {
+ "type": "string",
+ "format": "double",
+ "description": "This value represents the load of the replicas that are planned to be removed in the future.\nThis kind of load is reported for replicas that are currently being moving to other nodes and for replicas that are currently being dropped but still use the load on the source node."
+ }
+ }
+ },
+ "NodeName": {
+ "type": "string",
+ "description": "The name of a Service Fabric node."
+ },
+ "NodeType": {
+ "type": "string",
+ "description": "The type name of a Service Fabric node.\nRefer to the article [The relationship between Service Fabric node types and Virtual Machine Scale Sets](https://docs.microsoft.com/azure/service-fabric/service-fabric-cluster-nodetypes) for more details."
+ },
+ "NodesHealthEvaluation": {
+ "x-ms-discriminator-value": "Nodes",
+ "description": "Represents health evaluation for nodes, containing health evaluations for each unhealthy node that impacted current aggregated health state. Can be returned when evaluating cluster health and the aggregated health state is either Error or Warning.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/HealthEvaluation"
+ }
+ ],
+ "properties": {
+ "MaxPercentUnhealthyNodes": {
+ "type": "integer",
+ "description": "Maximum allowed percentage of unhealthy nodes from the ClusterHealthPolicy."
+ },
+ "TotalCount": {
+ "type": "integer",
+ "format": "int64",
+ "description": "Total number of nodes found in the health store."
+ },
+ "UnhealthyEvaluations": {
+ "$ref": "#/definitions/UnhealthyEvaluations",
+ "description": "List of unhealthy evaluations that led to the aggregated health state. Includes all the unhealthy NodeHealthEvaluation that impacted the aggregated health."
+ }
+ }
+ },
+ "NodeStatus": {
+ "type": "string",
+ "description": "The status of the node.",
+ "enum": [
+ "Invalid",
+ "Up",
+ "Down",
+ "Enabling",
+ "Disabling",
+ "Disabled",
+ "Unknown",
+ "Removed"
+ ],
+ "x-ms-enum": {
+ "name": "NodeStatus",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "Invalid",
+ "description": "Indicates the node status is invalid. All Service Fabric enumerations have the invalid type. The value is zero."
+ },
+ {
+ "value": "Up",
+ "description": "Indicates the node is up. The value is 1."
+ },
+ {
+ "value": "Down",
+ "description": "Indicates the node is down. The value is 2."
+ },
+ {
+ "value": "Enabling",
+ "description": "Indicates the node is in process of being enabled. The value is 3."
+ },
+ {
+ "value": "Disabling",
+ "description": "Indicates the node is in the process of being disabled. The value is 4."
+ },
+ {
+ "value": "Disabled",
+ "description": "Indicates the node is disabled. The value is 5."
+ },
+ {
+ "value": "Unknown",
+ "description": "Indicates the node is unknown. A node would be in Unknown state if Service Fabric does not have authoritative information about that node. This can happen if the system learns about a node at runtime.The value is 6."
+ },
+ {
+ "value": "Removed",
+ "description": "Indicates the node is removed. A node would be in Removed state if NodeStateRemoved API has been called for this node. In other words, Service Fabric has been informed that the persisted state on the node has been permanently lost. The value is 7."
+ }
+ ]
+ }
+ },
+ "NodeUpgradePhase": {
+ "type": "string",
+ "description": "The state of the upgrading node.",
+ "enum": [
+ "Invalid",
+ "PreUpgradeSafetyCheck",
+ "Upgrading",
+ "PostUpgradeSafetyCheck"
+ ],
+ "x-ms-enum": {
+ "name": "NodeUpgradePhase",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "Invalid",
+ "description": "Indicates the upgrade state is invalid. All Service Fabric enumerations have the invalid type. The value is zero."
+ },
+ {
+ "value": "PreUpgradeSafetyCheck",
+ "description": "The upgrade has not started yet due to pending safety checks. The value is 1"
+ },
+ {
+ "value": "Upgrading",
+ "description": "The upgrade is in progress. The value is 2"
+ },
+ {
+ "value": "PostUpgradeSafetyCheck",
+ "description": "The upgrade has completed and post upgrade safety checks are being performed. The value is 3"
+ }
+ ]
+ }
+ },
+ "NodeUpgradeProgressInfo": {
+ "description": "Information about the upgrading node and its status",
+ "properties": {
+ "NodeName": {
+ "$ref": "#/definitions/NodeName",
+ "description": "The name of a Service Fabric node."
+ },
+ "UpgradePhase": {
+ "$ref": "#/definitions/NodeUpgradePhase",
+ "description": "The state of the upgrading node."
+ },
+ "PendingSafetyChecks": {
+ "$ref": "#/definitions/SafetyCheckInfoList",
+ "description": "List of pending safety checks"
+ }
+ }
+ },
+ "NodeUpgradeProgressInfoList": {
+ "type": "array",
+ "description": "List of upgrading nodes and their statuses",
+ "items": {
+ "$ref": "#/definitions/NodeUpgradeProgressInfo"
+ }
+ },
+ "PagedApplicationInfoList": {
+ "description": "The list of applications in the cluster. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.",
+ "properties": {
+ "ContinuationToken": {
+ "$ref": "#/definitions/ContinuationToken",
+ "description": "The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token is not included in the response."
+ },
+ "Items": {
+ "type": "array",
+ "description": "List of application information.",
+ "items": {
+ "$ref": "#/definitions/ApplicationInfo"
+ }
+ }
+ }
+ },
+ "PagedDeployedApplicationInfoList": {
+ "description": "The list of deployed applications in activating, downloading, or active states on a node.\nThe list is paged when all of the results cannot fit in a single message.\nThe next set of results can be obtained by executing the same query with the continuation token provided in this list.",
+ "properties": {
+ "ContinuationToken": {
+ "$ref": "#/definitions/ContinuationToken",
+ "description": "The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token is not included in the response."
+ },
+ "Items": {
+ "type": "array",
+ "description": "List of deployed application information.",
+ "items": {
+ "$ref": "#/definitions/DeployedApplicationInfo"
+ }
+ }
+ }
+ },
+ "PagedNodeInfoList": {
+ "description": "The list of nodes in the cluster. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.",
+ "properties": {
+ "ContinuationToken": {
+ "$ref": "#/definitions/ContinuationToken",
+ "description": "The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token is not included in the response."
+ },
+ "Items": {
+ "type": "array",
+ "description": "List of node information.",
+ "items": {
+ "$ref": "#/definitions/NodeInfo"
+ }
+ }
+ }
+ },
+ "PagedServicePartitionInfoList": {
+ "description": "The list of partition in the cluster for a service. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.",
+ "properties": {
+ "ContinuationToken": {
+ "$ref": "#/definitions/ContinuationToken",
+ "description": "The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token is not included in the response."
+ },
+ "Items": {
+ "type": "array",
+ "description": "List of service partition information.",
+ "items": {
+ "$ref": "#/definitions/ServicePartitionInfo"
+ }
+ }
+ }
+ },
+ "PagedReplicaInfoList": {
+ "description": "The list of replicas in the cluster for a given partition. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.",
+ "properties": {
+ "ContinuationToken": {
+ "$ref": "#/definitions/ContinuationToken",
+ "description": "The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token is not included in the response."
+ },
+ "Items": {
+ "type": "array",
+ "description": "List of replica information.",
+ "items": {
+ "$ref": "#/definitions/ReplicaInfo"
+ }
+ }
+ }
+ },
+ "PagedServiceInfoList": {
+ "description": "The list of services in the cluster for an application. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.",
+ "properties": {
+ "ContinuationToken": {
+ "$ref": "#/definitions/ContinuationToken",
+ "description": "The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token is not included in the response."
+ },
+ "Items": {
+ "type": "array",
+ "description": "List of service information.",
+ "items": {
+ "$ref": "#/definitions/ServiceInfo"
+ }
+ }
+ }
+ },
+ "PartitionAnalysisEvent": {
+ "description": "Represents the base for all Partition Analysis Events.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/PartitionEvent"
+ }
+ ],
+ "properties": {
+ "Metadata": {
+ "$ref": "#/definitions/AnalysisEventMetadata",
+ "description": "Metadata about an Analysis Event."
+ }
+ },
+ "required": [
+ "Metadata"
+ ],
+ "x-ms-discriminator-value": "PartitionAnalysisEvent"
+ },
+ "PartitionEvent": {
+ "description": "Represents the base for all Partition Events.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/FabricEvent"
+ }
+ ],
+ "properties": {
+ "PartitionId": {
+ "$ref": "#/definitions/PartitionId",
+ "description": "An internal ID used by Service Fabric to uniquely identify a partition. This is a randomly generated GUID when the service was created. The partition ID is unique and does not change for the lifetime of the service. If the same service was deleted and recreated the IDs of its partitions would be different."
+ }
+ },
+ "required": [
+ "PartitionId"
+ ],
+ "x-ms-discriminator-value": "PartitionEvent"
+ },
+ "PartitionEventList": {
+ "description": "A list of PartitionEvent objects.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/PartitionEvent"
+ }
+ },
+ "PartitionHealth": {
+ "description": "Information about the health of a Service Fabric partition.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/EntityHealth"
+ }
+ ],
+ "properties": {
+ "PartitionId": {
+ "$ref": "#/definitions/PartitionId",
+ "description": "ID of the partition whose health information is described by this object."
+ },
+ "ReplicaHealthStates": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ReplicaHealthState"
+ },
+ "description": "The list of replica health states associated with the partition."
+ }
+ }
+ },
+ "PartitionHealthEvaluation": {
+ "x-ms-discriminator-value": "Partition",
+ "description": "Represents health evaluation for a partition, containing information about the data and the algorithm used by health store to evaluate health. The evaluation is returned only when the aggregated health state is either Error or Warning.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/HealthEvaluation"
+ }
+ ],
+ "properties": {
+ "PartitionId": {
+ "$ref": "#/definitions/PartitionId",
+ "description": "Id of the partition whose health evaluation is described by this object."
+ },
+ "UnhealthyEvaluations": {
+ "$ref": "#/definitions/UnhealthyEvaluations",
+ "description": "List of unhealthy evaluations that led to the current aggregated health state of the partition. The types of the unhealthy evaluations can be ReplicasHealthEvaluation or EventHealthEvaluation."
+ }
+ }
+ },
+ "PartitionHealthState": {
+ "description": "Represents the health state of a partition, which contains the partition identifier and its aggregated health state.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/EntityHealthState"
+ }
+ ],
+ "properties": {
+ "PartitionId": {
+ "$ref": "#/definitions/PartitionId",
+ "description": "Id of the partition whose health state is described by this object."
+ }
+ }
+ },
+ "PartitionHealthStateChunk": {
+ "description": "Represents the health state chunk of a partition, which contains the partition ID, its aggregated health state and any replicas that respect the filters in the cluster health chunk query description.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/EntityHealthStateChunk"
+ }
+ ],
+ "properties": {
+ "PartitionId": {
+ "$ref": "#/definitions/PartitionId",
+ "description": "The Id of the partition."
+ },
+ "ReplicaHealthStateChunks": {
+ "$ref": "#/definitions/ReplicaHealthStateChunkList",
+ "description": "The list of replica health state chunks belonging to the partition that respect the filters in the cluster health chunk query description."
+ }
+ }
+ },
+ "PartitionHealthStateChunkList": {
+ "description": "The list of partition health state chunks that respect the input filters in the chunk query description.\nReturned by get cluster health state chunks query as part of the parent application hierarchy.",
+ "properties": {
+ "Items": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/PartitionHealthStateChunk"
+ },
+ "description": "The list of partition health state chunks that respect the input filters in the chunk query."
+ }
+ }
+ },
+ "PartitionHealthStateFilter": {
+ "description": "Defines matching criteria to determine whether a partition should be included as a child of a service in the cluster health chunk.\nThe partitions are only returned if the parent entities match a filter specified in the cluster health chunk query description. The parent service and application must be included in the cluster health chunk.\nOne filter can match zero, one or multiple partitions, depending on its properties.",
+ "properties": {
+ "PartitionIdFilter": {
+ "type": "string",
+ "format": "uuid",
+ "description": "ID of the partition that matches the filter. The filter is applied only to the specified partition, if it exists.\nIf the partition doesn't exist, no partition is returned in the cluster health chunk based on this filter.\nIf the partition exists, it is included in the cluster health chunk if it respects the other filter properties.\nIf not specified, all partitions that match the parent filters (if any) are taken into consideration and matched against the other filter members, like health state filter."
+ },
+ "HealthStateFilter": {
+ "type": "integer",
+ "default": 0,
+ "description": "The filter for the health state of the partitions. It allows selecting partitions if they match the desired health states.\nThe possible values are integer value of one of the following health states. Only partitions that match the filter are returned. All partitions are used to evaluate the cluster aggregated health state.\nIf not specified, default value is None, unless the partition ID is specified. If the filter has default value and partition ID is specified, the matching partition is returned.\nThe state values are flag-based enumeration, so the value could be a combination of these values obtained using bitwise 'OR' operator.\nFor example, if the provided value is 6, it matches partitions with HealthState value of OK (2) and Warning (4).\n\n- Default - Default value. Matches any HealthState. The value is zero.\n- None - Filter that doesn't match any HealthState value. Used in order to return no results on a given collection of states. The value is 1.\n- Ok - Filter that matches input with HealthState value Ok. The value is 2.\n- Warning - Filter that matches input with HealthState value Warning. The value is 4.\n- Error - Filter that matches input with HealthState value Error. The value is 8.\n- All - Filter that matches input with any HealthState value. The value is 65535."
+ },
+ "ReplicaFilters": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ReplicaHealthStateFilter"
+ },
+ "description": "Defines a list of filters that specify which replicas to be included in the returned cluster health chunk as children of the parent partition. The replicas are returned only if the parent partition matches a filter.\nIf the list is empty, no replicas are returned. All the replicas are used to evaluate the parent partition aggregated health state, regardless of the input filters.\nThe partition filter may specify multiple replica filters.\nFor example, it can specify a filter to return all replicas with health state Error and another filter to always include a replica identified by its replica id."
+ }
+ }
+ },
+ "PartitionId": {
+ "type": "string",
+ "format": "uuid",
+ "description": "An internal ID used by Service Fabric to uniquely identify a partition. This is a randomly generated GUID when the service was created. The partition ID is unique and does not change for the lifetime of the service. If the same service was deleted and recreated the IDs of its partitions would be different."
+ },
+ "PartitionInformation": {
+ "discriminator": "ServicePartitionKind",
+ "description": "Information about the partition identity, partitioning scheme and keys supported by it.",
+ "required": [
+ "ServicePartitionKind"
+ ],
+ "properties": {
+ "ServicePartitionKind": {
+ "$ref": "#/definitions/ServicePartitionKind",
+ "description": "The kind of partitioning scheme used to partition the service."
+ },
+ "Id": {
+ "$ref": "#/definitions/PartitionId",
+ "description": "An internal ID used by Service Fabric to uniquely identify a partition. This is a randomly generated GUID when the service was created. The partition ID is unique and does not change for the lifetime of the service. If the same service was deleted and recreated the IDs of its partitions would be different."
+ }
+ }
+ },
+ "ProvisionFabricDescription": {
+ "description": "Describes the parameters for provisioning a cluster.",
+ "properties": {
+ "CodeFilePath": {
+ "type": "string",
+ "description": "The cluster code package file path."
+ },
+ "ClusterManifestFilePath": {
+ "type": "string",
+ "description": "The cluster manifest file path."
+ }
+ }
+ },
+ "ProvisionApplicationTypeKind": {
+ "type": "string",
+ "description": "The kind of application type registration or provision requested. The application package can be registered or provisioned either from the image store or from an external store. Following are the kinds of the application type provision.",
+ "enum": [
+ "Invalid",
+ "ImageStorePath",
+ "ExternalStore"
+ ],
+ "x-ms-enum": {
+ "name": "ProvisionApplicationTypeKind",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "Invalid",
+ "description": "Indicates that the provision kind is invalid. This value is default and should not be used. The value is zero."
+ },
+ {
+ "value": "ImageStorePath",
+ "description": "Indicates that the provision is for a package that was previously uploaded to the image store. The value is 1."
+ },
+ {
+ "value": "ExternalStore",
+ "description": "Indicates that the provision is for an application package that was previously uploaded to an external store. The application package ends with the extension *.sfpkg. The value is 2."
+ }
+ ]
+ }
+ },
+ "ProvisionApplicationTypeDescriptionBase": {
+ "discriminator": "Kind",
+ "description": "Represents the type of registration or provision requested, and if the operation needs to be asynchronous or not. Supported types of provision operations are from either image store or external store.",
+ "properties": {
+ "Kind": {
+ "$ref": "#/definitions/ProvisionApplicationTypeKind",
+ "description": "The kind of application type registration or provision requested. The application package can be registered or provisioned either from the image store or from an external store. Following are the kinds of the application type provision."
+ },
+ "Async": {
+ "type": "boolean",
+ "description": "Indicates whether or not provisioning should occur asynchronously. When set to true, the provision operation returns when the request is accepted by the system, and the provision operation continues without any timeout limit. The default value is false. For large application packages, we recommend setting the value to true."
+ }
+ },
+ "required": [
+ "Kind",
+ "Async"
+ ]
+ },
+ "ProvisionApplicationTypeDescription": {
+ "description": "Describes the operation to register or provision an application type using an application package uploaded to the Service Fabric image store.",
+ "required": [
+ "ApplicationTypeBuildPath"
+ ],
+ "allOf": [
+ {
+ "$ref": "#/definitions/ProvisionApplicationTypeDescriptionBase"
+ }
+ ],
+ "properties": {
+ "ApplicationTypeBuildPath": {
+ "description": "The relative path for the application package in the image store specified during the prior upload operation.",
+ "type": "string"
+ },
+ "ApplicationPackageCleanupPolicy": {
+ "$ref": "#/definitions/ApplicationPackageCleanupPolicy",
+ "description": "The kind of action that needs to be taken for cleaning up the application package after successful provision."
+ }
+ },
+ "x-ms-discriminator-value": "ImageStorePath"
+ },
+ "ExternalStoreProvisionApplicationTypeDescription": {
+ "description": "Describes the operation to register or provision an application type using an application package from an external store instead of a package uploaded to the Service Fabric image store.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ProvisionApplicationTypeDescriptionBase"
+ }
+ ],
+ "properties": {
+ "ApplicationPackageDownloadUri": {
+ "description": "The path to the '.sfpkg' application package from where the application package can be downloaded using HTTP or HTTPS protocols. The application package can be stored in an external store that provides GET operation to download the file. Supported protocols are HTTP and HTTPS, and the path must allow READ access.",
+ "type": "string"
+ },
+ "ApplicationTypeName": {
+ "description": "The application type name represents the name of the application type found in the application manifest.",
+ "type": "string"
+ },
+ "ApplicationTypeVersion": {
+ "description": "The application type version represents the version of the application type found in the application manifest.",
+ "type": "string"
+ }
+ },
+ "x-ms-discriminator-value": "ExternalStore",
+ "required": [
+ "ApplicationPackageDownloadUri",
+ "ApplicationTypeName",
+ "ApplicationTypeVersion"
+ ]
+ },
+ "UnprovisionFabricDescription": {
+ "description": "Describes the parameters for unprovisioning a cluster.",
+ "properties": {
+ "CodeVersion": {
+ "type": "string",
+ "description": "The cluster code package version."
+ },
+ "ConfigVersion": {
+ "type": "string",
+ "description": "The cluster manifest version."
+ }
+ }
+ },
+ "ResumeClusterUpgradeDescription": {
+ "description": "Describes the parameters for resuming a cluster upgrade.",
+ "properties": {
+ "UpgradeDomain": {
+ "type": "string",
+ "description": "The next upgrade domain for this cluster upgrade."
+ }
+ },
+ "required": [
+ "UpgradeDomain"
+ ]
+ },
+ "StartClusterUpgradeDescription": {
+ "description": "Describes the parameters for starting a cluster upgrade.",
+ "properties": {
+ "CodeVersion": {
+ "type": "string",
+ "description": "The cluster code version."
+ },
+ "ConfigVersion": {
+ "type": "string",
+ "description": "The cluster configuration version."
+ },
+ "UpgradeKind": {
+ "$ref": "#/definitions/UpgradeKind",
+ "description": "The kind of upgrade out of the following possible values."
+ },
+ "RollingUpgradeMode": {
+ "$ref": "#/definitions/UpgradeMode",
+ "description": "The mode used to monitor health during a rolling upgrade. The values are UnmonitoredAuto, UnmonitoredManual, and Monitored."
+ },
+ "UpgradeReplicaSetCheckTimeoutInSeconds": {
+ "$ref": "#/definitions/UpgradeReplicaSetCheckTimeout",
+ "description": "The maximum amount of time to block processing of an upgrade domain and prevent loss of availability when there are unexpected issues. When this timeout expires, processing of the upgrade domain will proceed regardless of availability loss issues. The timeout is reset at the start of each upgrade domain. Valid values are between 0 and 42949672925 inclusive. (unsigned 32-bit integer)."
+ },
+ "ForceRestart": {
+ "$ref": "#/definitions/ForceRestart",
+ "description": "If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data)."
+ },
+ "SortOrder": {
+ "$ref": "#/definitions/UpgradeSortOrder",
+ "description": "Defines the order in which an upgrade proceeds through the cluster."
+ },
+ "MonitoringPolicy": {
+ "$ref": "#/definitions/MonitoringPolicyDescription",
+ "description": "Describes the parameters for monitoring an upgrade in Monitored mode."
+ },
+ "ClusterHealthPolicy": {
+ "$ref": "#/definitions/ClusterHealthPolicy",
+ "description": "Defines a health policy used to evaluate the health of the cluster or of a cluster node."
+ },
+ "EnableDeltaHealthEvaluation": {
+ "type": "boolean",
+ "description": "When true, enables delta health evaluation rather than absolute health evaluation after completion of each upgrade domain."
+ },
+ "ClusterUpgradeHealthPolicy": {
+ "$ref": "#/definitions/ClusterUpgradeHealthPolicyObject",
+ "description": "Defines a health policy used to evaluate the health of the cluster during a cluster upgrade."
+ },
+ "ApplicationHealthPolicyMap": {
+ "$ref": "#/definitions/ApplicationHealthPolicies",
+ "description": "Defines the application health policy map used to evaluate the health of an application or one of its children entities."
+ },
+ "InstanceCloseDelayDurationInSeconds": {
+ "$ref": "#/definitions/InstanceCloseDelayDurationInSeconds",
+ "description": "Duration in seconds, to wait before a stateless instance is closed, to allow the active requests to drain gracefully. This would be effective when the instance is closing during the application/cluster\nupgrade, only for those instances which have a non-zero delay duration configured in the service description. See InstanceCloseDelayDurationSeconds property in $ref: \"#/definitions/StatelessServiceDescription.yaml\" for details.\nNote, the default value of InstanceCloseDelayDurationInSeconds is 4294967295, which indicates that the behavior will entirely depend on the delay configured in the stateless service description."
+ }
+ }
+ },
+ "UpdateClusterUpgradeDescription": {
+ "description": "Parameters for updating a cluster upgrade.",
+ "properties": {
+ "UpgradeKind": {
+ "$ref": "#/definitions/UpgradeType",
+ "description": "The type of upgrade out of the following possible values."
+ },
+ "UpdateDescription": {
+ "$ref": "#/definitions/RollingUpgradeUpdateDescription",
+ "description": "Describes the parameters for updating a rolling upgrade of application or cluster."
+ },
+ "ClusterHealthPolicy": {
+ "$ref": "#/definitions/ClusterHealthPolicy",
+ "description": "Defines a health policy used to evaluate the health of the cluster or of a cluster node."
+ },
+ "EnableDeltaHealthEvaluation": {
+ "$ref": "#/definitions/DeltaHealthEvaluationBool",
+ "description": "When true, enables delta health evaluation rather than absolute health evaluation after completion of each upgrade domain."
+ },
+ "ClusterUpgradeHealthPolicy": {
+ "$ref": "#/definitions/ClusterUpgradeHealthPolicyObject",
+ "description": "Defines a health policy used to evaluate the health of the cluster during a cluster upgrade."
+ },
+ "ApplicationHealthPolicyMap": {
+ "$ref": "#/definitions/ApplicationHealthPolicies",
+ "description": "Defines the application health policy map used to evaluate the health of an application or one of its children entities."
+ }
+ }
+ },
+ "SafetyCheckKind": {
+ "type": "string",
+ "description": "The kind of safety check performed by service fabric before continuing with the operations. These checks ensure the availability of the service and the reliability of the state. Following are the kinds of safety checks.",
+ "enum": [
+ "Invalid",
+ "EnsureSeedNodeQuorum",
+ "EnsurePartitionQuorum",
+ "WaitForPrimaryPlacement",
+ "WaitForPrimarySwap",
+ "WaitForReconfiguration",
+ "WaitForInbuildReplica",
+ "EnsureAvailability"
+ ],
+ "x-ms-enum": {
+ "name": "SafetyCheckKind",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "Invalid",
+ "description": "Indicates that the upgrade safety check kind is invalid. All Service Fabric enumerations have the invalid type. The value is zero."
+ },
+ {
+ "value": "EnsureSeedNodeQuorum",
+ "description": "Indicates that if we bring down the node then this will result in global seed node quorum loss. The value is 1."
+ },
+ {
+ "value": "EnsurePartitionQuorum",
+ "description": "Indicates that there is some partition for which if we bring down the replica on the node, it will result in quorum loss for that partition. The value is 2."
+ },
+ {
+ "value": "WaitForPrimaryPlacement",
+ "description": "Indicates that there is some replica on the node that was moved out of this node due to upgrade. Service Fabric is now waiting for the primary to be moved back to this node. The value is 3."
+ },
+ {
+ "value": "WaitForPrimarySwap",
+ "description": "Indicates that Service Fabric is waiting for a primary replica to be moved out of the node before starting upgrade on that node. The value is 4."
+ },
+ {
+ "value": "WaitForReconfiguration",
+ "description": "Indicates that there is some replica on the node that is involved in a reconfiguration. Service Fabric is waiting for the reconfiguration to be complete before staring upgrade on that node. The value is 5."
+ },
+ {
+ "value": "WaitForInbuildReplica",
+ "description": "Indicates that there is either a replica on the node that is going through copy, or there is a primary replica on the node that is copying data to some other replica. In both cases, bringing down the replica on the node due to upgrade will abort the copy. The value is 6."
+ },
+ {
+ "value": "EnsureAvailability",
+ "description": "Indicates that there is either a stateless service partition on the node having exactly one instance, or there is a primary replica on the node for which the partition is quorum loss. In both cases, bringing down the replicas due to upgrade will result in loss of availability. The value is 7."
+ }
+ ]
+ }
+ },
+ "SafetyCheck": {
+ "discriminator": "Kind",
+ "description": "Represents a safety check performed by service fabric before continuing with the operations. These checks ensure the availability of the service and the reliability of the state.",
+ "properties": {
+ "Kind": {
+ "$ref": "#/definitions/SafetyCheckKind",
+ "description": "The kind of safety check performed by service fabric before continuing with the operations. These checks ensure the availability of the service and the reliability of the state. Following are the kinds of safety checks."
+ }
+ },
+ "required": [
+ "Kind"
+ ]
+ },
+ "PartitionSafetyCheck": {
+ "description": "Represents a safety check for the service partition being performed by service fabric before continuing with operations.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/SafetyCheck"
+ }
+ ],
+ "properties": {
+ "PartitionId": {
+ "$ref": "#/definitions/PartitionId",
+ "description": "Id of the partition which is undergoing the safety check."
+ }
+ }
+ },
+ "EnsureAvailabilitySafetyCheck": {
+ "description": "Safety check that waits to ensure the availability of the partition. It waits until there are replicas available such that bringing down this replica will not cause availability loss for the partition.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/PartitionSafetyCheck"
+ }
+ ],
+ "x-ms-discriminator-value": "EnsureAvailability"
+ },
+ "EnsurePartitionQuorumSafetyCheck": {
+ "description": "Safety check that ensures that a quorum of replicas are not lost for a partition.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/PartitionSafetyCheck"
+ }
+ ],
+ "x-ms-discriminator-value": "EnsurePartitionQuorum"
+ },
+ "SeedNodeSafetyCheck": {
+ "description": "Represents a safety check for the seed nodes being performed by service fabric before continuing with node level operations.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/SafetyCheck"
+ }
+ ],
+ "x-ms-discriminator-value": "EnsureSeedNodeQuorum"
+ },
+ "PartitionsHealthEvaluation": {
+ "x-ms-discriminator-value": "Partitions",
+ "description": "Represents health evaluation for the partitions of a service, containing health evaluations for each unhealthy partition that impacts current aggregated health state. Can be returned when evaluating service health and the aggregated health state is either Error or Warning.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/HealthEvaluation"
+ }
+ ],
+ "properties": {
+ "MaxPercentUnhealthyPartitionsPerService": {
+ "type": "integer",
+ "description": "Maximum allowed percentage of unhealthy partitions per service from the ServiceTypeHealthPolicy."
+ },
+ "TotalCount": {
+ "type": "integer",
+ "format": "int64",
+ "description": "Total number of partitions of the service from the health store."
+ },
+ "UnhealthyEvaluations": {
+ "$ref": "#/definitions/UnhealthyEvaluations",
+ "description": "List of unhealthy evaluations that led to the aggregated health state. Includes all the unhealthy PartitionHealthEvaluation that impacted the aggregated health."
+ }
+ }
+ },
+ "ReplicaEvent": {
+ "description": "Represents the base for all Replica Events.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/FabricEvent"
+ }
+ ],
+ "properties": {
+ "PartitionId": {
+ "$ref": "#/definitions/PartitionId",
+ "description": "An internal ID used by Service Fabric to uniquely identify a partition. This is a randomly generated GUID when the service was created. The partition ID is unique and does not change for the lifetime of the service. If the same service was deleted and recreated the IDs of its partitions would be different."
+ },
+ "ReplicaId": {
+ "$ref": "#/definitions/ReplicaId_Integer",
+ "description": "Id of a stateful service replica. ReplicaId is used by Service Fabric to uniquely identify a replica of a partition. It is unique within a partition and does not change for the lifetime of the replica. If a replica gets dropped and another replica gets created on the same node for the same partition, it will get a different value for the id. Sometimes the id of a stateless service instance is also referred as a replica id."
+ }
+ },
+ "required": [
+ "PartitionId",
+ "ReplicaId"
+ ],
+ "x-ms-discriminator-value": "ReplicaEvent"
+ },
+ "ReplicaEventList": {
+ "description": "A list of ReplicaEvent objects.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ReplicaEvent"
+ }
+ },
+ "ReplicaHealth": {
+ "allOf": [
+ {
+ "$ref": "#/definitions/EntityHealth"
+ }
+ ],
+ "discriminator": "ServiceKind",
+ "description": "Represents a base class for stateful service replica or stateless service instance health.\nContains the replica aggregated health state, the health events and the unhealthy evaluations.",
+ "properties": {
+ "ServiceKind": {
+ "$ref": "#/definitions/ServiceKind",
+ "description": "The kind of service (Stateless or Stateful)."
+ },
+ "PartitionId": {
+ "$ref": "#/definitions/PartitionId",
+ "description": "Id of the partition to which this replica belongs."
+ }
+ },
+ "required": [
+ "ServiceKind"
+ ]
+ },
+ "ReplicaHealthEvaluation": {
+ "x-ms-discriminator-value": "Replica",
+ "description": "Represents health evaluation for a replica, containing information about the data and the algorithm used by health store to evaluate health. The evaluation is returned only when the aggregated health state is either Error or Warning.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/HealthEvaluation"
+ }
+ ],
+ "properties": {
+ "PartitionId": {
+ "$ref": "#/definitions/PartitionId",
+ "description": "Id of the partition to which the replica belongs."
+ },
+ "ReplicaOrInstanceId": {
+ "$ref": "#/definitions/ReplicaOrInstanceId",
+ "description": "Id of a stateful service replica or a stateless service instance. This ID is used in the queries that apply to both stateful and stateless services. It is used by Service Fabric to uniquely identify a replica of a partition of a stateful service or an instance of a stateless service partition. It is unique within a partition and does not change for the lifetime of the replica or the instance. If a stateful replica gets dropped and another replica gets created on the same node for the same partition, it will get a different value for the ID. If a stateless instance is failed over on the same or different node it will get a different value for the ID."
+ },
+ "UnhealthyEvaluations": {
+ "$ref": "#/definitions/UnhealthyEvaluations",
+ "description": "List of unhealthy evaluations that led to the current aggregated health state of the replica. The types of the unhealthy evaluations can be EventHealthEvaluation."
+ }
+ }
+ },
+ "ReplicaHealthState": {
+ "discriminator": "ServiceKind",
+ "required": [
+ "ServiceKind"
+ ],
+ "description": "Represents a base class for stateful service replica or stateless service instance health state.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/EntityHealthState"
+ }
+ ],
+ "properties": {
+ "ServiceKind": {
+ "$ref": "#/definitions/ServiceKind",
+ "description": "The kind of service (Stateless or Stateful)."
+ },
+ "PartitionId": {
+ "$ref": "#/definitions/PartitionId",
+ "description": "The ID of the partition to which this replica belongs."
+ }
+ }
+ },
+ "ReplicaHealthStateChunk": {
+ "description": "Represents the health state chunk of a stateful service replica or a stateless service instance.\nThe replica health state contains the replica ID and its aggregated health state.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/EntityHealthStateChunk"
+ }
+ ],
+ "properties": {
+ "ReplicaOrInstanceId": {
+ "$ref": "#/definitions/ReplicaOrInstanceId",
+ "description": "Id of a stateful service replica or a stateless service instance. This ID is used in the queries that apply to both stateful and stateless services. It is used by Service Fabric to uniquely identify a replica of a partition of a stateful service or an instance of a stateless service partition. It is unique within a partition and does not change for the lifetime of the replica or the instance. If a stateful replica gets dropped and another replica gets created on the same node for the same partition, it will get a different value for the ID. If a stateless instance is failed over on the same or different node it will get a different value for the ID."
+ }
+ }
+ },
+ "ReplicaHealthStateChunkList": {
+ "description": "The list of replica health state chunks that respect the input filters in the chunk query. Returned by get cluster health state chunks query.",
+ "properties": {
+ "Items": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ReplicaHealthStateChunk"
+ },
+ "description": "The list of replica health state chunks that respect the input filters in the chunk query."
+ }
+ }
+ },
+ "ReplicaHealthStateFilter": {
+ "description": "Defines matching criteria to determine whether a replica should be included as a child of a partition in the cluster health chunk.\nThe replicas are only returned if the parent entities match a filter specified in the cluster health chunk query description. The parent partition, service and application must be included in the cluster health chunk.\nOne filter can match zero, one or multiple replicas, depending on its properties.",
+ "properties": {
+ "ReplicaOrInstanceIdFilter": {
+ "type": "string",
+ "description": "Id of the stateful service replica or stateless service instance that matches the filter. The filter is applied only to the specified replica, if it exists.\nIf the replica doesn't exist, no replica is returned in the cluster health chunk based on this filter.\nIf the replica exists, it is included in the cluster health chunk if it respects the other filter properties.\nIf not specified, all replicas that match the parent filters (if any) are taken into consideration and matched against the other filter members, like health state filter."
+ },
+ "HealthStateFilter": {
+ "type": "integer",
+ "default": 0,
+ "description": "The filter for the health state of the replicas. It allows selecting replicas if they match the desired health states.\nThe possible values are integer value of one of the following health states. Only replicas that match the filter are returned. All replicas are used to evaluate the parent partition aggregated health state.\nIf not specified, default value is None, unless the replica ID is specified. If the filter has default value and replica ID is specified, the matching replica is returned.\nThe state values are flag-based enumeration, so the value could be a combination of these values obtained using bitwise 'OR' operator.\nFor example, if the provided value is 6, it matches replicas with HealthState value of OK (2) and Warning (4).\n\n- Default - Default value. Matches any HealthState. The value is zero.\n- None - Filter that doesn't match any HealthState value. Used in order to return no results on a given collection of states. The value is 1.\n- Ok - Filter that matches input with HealthState value Ok. The value is 2.\n- Warning - Filter that matches input with HealthState value Warning. The value is 4.\n- Error - Filter that matches input with HealthState value Error. The value is 8.\n- All - Filter that matches input with any HealthState value. The value is 65535."
+ }
+ }
+ },
+ "ReplicaId": {
+ "type": "string",
+ "description": "Id of a stateful service replica. ReplicaId is used by Service Fabric to uniquely identify a replica of a partition. It is unique within a partition and does not change for the lifetime of the replica. If a replica gets dropped and another replica gets created on the same node for the same partition, it will get a different value for the id. Sometimes the id of a stateless service instance is also referred as a replica id."
+ },
+ "ReplicaId_Integer": {
+ "type": "integer",
+ "format": "int64",
+ "description": "Id of a stateful service replica. ReplicaId is used by Service Fabric to uniquely identify a replica of a partition. It is unique within a partition and does not change for the lifetime of the replica. If a replica gets dropped and another replica gets created on the same node for the same partition, it will get a different value for the id. Sometimes the id of a stateless service instance is also referred as a replica id."
+ },
+ "ReplicaOrInstanceId": {
+ "type": "string",
+ "description": "Id of a stateful service replica or a stateless service instance. This ID is used in the queries that apply to both stateful and stateless services. It is used by Service Fabric to uniquely identify a replica of a partition of a stateful service or an instance of a stateless service partition. It is unique within a partition and does not change for the lifetime of the replica or the instance. If a stateful replica gets dropped and another replica gets created on the same node for the same partition, it will get a different value for the ID. If a stateless instance is failed over on the same or different node it will get a different value for the ID."
+ },
+ "ReplicaInfo": {
+ "discriminator": "ServiceKind",
+ "description": "Information about the identity, status, health, node name, uptime, and other details about the replica.",
+ "required": [
+ "ServiceKind"
+ ],
+ "properties": {
+ "ServiceKind": {
+ "$ref": "#/definitions/ServiceKind",
+ "description": "The kind of service (Stateless or Stateful)."
+ },
+ "ReplicaStatus": {
+ "$ref": "#/definitions/ReplicaStatus",
+ "description": "The status of a replica of a service."
+ },
+ "HealthState": {
+ "$ref": "#/definitions/HealthState",
+ "description": "The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc."
+ },
+ "NodeName": {
+ "$ref": "#/definitions/NodeName",
+ "description": "The name of a Service Fabric node."
+ },
+ "Address": {
+ "type": "string",
+ "description": "The address the replica is listening on."
+ },
+ "LastInBuildDurationInSeconds": {
+ "type": "string",
+ "description": "The last in build duration of the replica in seconds."
+ }
+ }
+ },
+ "ReplicaRole": {
+ "type": "string",
+ "description": "The role of a replica of a stateful service.",
+ "enum": [
+ "Unknown",
+ "None",
+ "Primary",
+ "IdleSecondary",
+ "ActiveSecondary"
+ ],
+ "x-ms-enum": {
+ "name": "ReplicaRole",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "Unknown",
+ "description": "Indicates the initial role that a replica is created in. The value is zero."
+ },
+ {
+ "value": "None",
+ "description": "Specifies that the replica has no responsibility in regard to the replica set. The value is 1"
+ },
+ {
+ "value": "Primary",
+ "description": "Refers to the replica in the set on which all read and write operations are complete in order to enforce strong consistency semantics. Read operations are handled directly by the Primary replica, while write operations must be acknowledged by a quorum of the replicas in the replica set. There can only be one Primary replica in a replica set at a time. The value is 2."
+ },
+ {
+ "value": "IdleSecondary",
+ "description": "Refers to a replica in the set that receives a state transfer from the Primary replica to prepare for becoming an active Secondary replica. There can be multiple Idle Secondary replicas in a replica set at a time. Idle Secondary replicas do not count as a part of a write quorum. The value is 3."
+ },
+ {
+ "value": "ActiveSecondary",
+ "description": "Refers to a replica in the set that receives state updates from the Primary replica, applies them, and sends acknowledgements back. Secondary replicas must participate in the write quorum for a replica set. There can be multiple active Secondary replicas in a replica set at a time. The number of active Secondary replicas is configurable that the reliability subsystem should maintain. The value is 4."
+ }
+ ]
+ }
+ },
+ "ReplicasHealthEvaluation": {
+ "x-ms-discriminator-value": "Replicas",
+ "description": "Represents health evaluation for replicas, containing health evaluations for each unhealthy replica that impacted current aggregated health state. Can be returned when evaluating partition health and the aggregated health state is either Error or Warning.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/HealthEvaluation"
+ }
+ ],
+ "properties": {
+ "MaxPercentUnhealthyReplicasPerPartition": {
+ "type": "integer",
+ "description": "Maximum allowed percentage of unhealthy replicas per partition from the ApplicationHealthPolicy."
+ },
+ "TotalCount": {
+ "type": "integer",
+ "format": "int64",
+ "description": "Total number of replicas in the partition from the health store."
+ },
+ "UnhealthyEvaluations": {
+ "$ref": "#/definitions/UnhealthyEvaluations",
+ "description": "List of unhealthy evaluations that led to the aggregated health state. Includes all the unhealthy ReplicaHealthEvaluation that impacted the aggregated health."
+ }
+ }
+ },
+ "ReplicaStatus": {
+ "type": "string",
+ "description": "The status of a replica of a service.",
+ "enum": [
+ "Invalid",
+ "InBuild",
+ "Standby",
+ "Ready",
+ "Down",
+ "Dropped"
+ ],
+ "x-ms-enum": {
+ "name": "ReplicaStatus",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "Invalid",
+ "description": "Indicates the replica status is invalid. All Service Fabric enumerations have the invalid type. The value is zero."
+ },
+ {
+ "value": "InBuild",
+ "description": "The replica is being built. This means that a primary replica is seeding this replica. The value is 1."
+ },
+ {
+ "value": "Standby",
+ "description": "The replica is in standby. The value is 2."
+ },
+ {
+ "value": "Ready",
+ "description": "The replica is ready. The value is 3."
+ },
+ {
+ "value": "Down",
+ "description": "The replica is down. The value is 4."
+ },
+ {
+ "value": "Dropped",
+ "description": "Replica is dropped. This means that the replica has been removed from the replica set. If it is persisted, its state has been deleted. The value is 5."
+ }
+ ]
+ }
+ },
+ "RestartNodeDescription": {
+ "description": "Describes the parameters to restart a Service Fabric node.",
+ "properties": {
+ "NodeInstanceId": {
+ "type": "string",
+ "description": "The instance ID of the target node. If instance ID is specified the node is restarted only if it matches with the current instance of the node. A default value of \"0\" would match any instance ID. The instance ID can be obtained using get node query.",
+ "default": "0"
+ },
+ "CreateFabricDump": {
+ "type": "string",
+ "description": "Specify True to create a dump of the fabric node process. This is case-sensitive.",
+ "enum": [
+ "False",
+ "True"
+ ],
+ "default": "False",
+ "x-ms-enum": {
+ "name": "CreateFabricDump",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "False"
+ },
+ {
+ "value": "True"
+ }
+ ]
+ }
+ }
+ },
+ "required": [
+ "NodeInstanceId"
+ ]
+ },
+ "SafetyCheckInfoList": {
+ "type": "array",
+ "description": "List of pending safety checks",
+ "items": {
+ "$ref": "#/definitions/SafetyCheckWrapper"
+ }
+ },
+ "SafetyCheckWrapper": {
+ "description": "A wrapper for the safety check object. Safety checks are performed by service fabric before continuing with the operations. These checks ensure the availability of the service and the reliability of the state.",
+ "properties": {
+ "SafetyCheck": {
+ "$ref": "#/definitions/SafetyCheck",
+ "description": "Represents a safety check performed by service fabric before continuing with the operations. These checks ensure the availability of the service and the reliability of the state."
+ }
+ }
+ },
+ "ServiceEvent": {
+ "description": "Represents the base for all Service Events.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/FabricEvent"
+ }
+ ],
+ "properties": {
+ "ServiceId": {
+ "$ref": "#/definitions/ServiceId",
+ "description": "The identity of the service. This ID is an encoded representation of the service name. This is used in the REST APIs to identify the service resource.\nStarting in version 6.0, hierarchical names are delimited with the \"\\~\" character. For example, if the service name is \"fabric:/myapp/app1/svc1\",\nthe service identity would be \"myapp~app1\\~svc1\" in 6.0+ and \"myapp/app1/svc1\" in previous versions."
+ }
+ },
+ "required": [
+ "ServiceId"
+ ],
+ "x-ms-discriminator-value": "ServiceEvent"
+ },
+ "ServiceEventList": {
+ "description": "A list of ServiceEvent objects.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ServiceEvent"
+ }
+ },
+ "ServiceFromTemplateDescription": {
+ "description": "Defines description for creating a Service Fabric service from a template defined in the application manifest.",
+ "required": [
+ "ApplicationName",
+ "ServiceName",
+ "ServiceTypeName"
+ ],
+ "properties": {
+ "ApplicationName": {
+ "$ref": "#/definitions/ApplicationName",
+ "description": "The name of the application, including the 'fabric:' URI scheme."
+ },
+ "ServiceName": {
+ "$ref": "#/definitions/ServiceName",
+ "description": "The full name of the service with 'fabric:' URI scheme."
+ },
+ "ServiceTypeName": {
+ "$ref": "#/definitions/ServiceTypeName",
+ "description": "Name of the service type as specified in the service manifest."
+ },
+ "InitializationData": {
+ "$ref": "#/definitions/ByteArray",
+ "description": "The initialization data for the newly created service instance."
+ },
+ "ServicePackageActivationMode": {
+ "$ref": "#/definitions/ServicePackageActivationMode",
+ "description": "The activation mode of service package to be used for a service."
+ },
+ "ServiceDnsName": {
+ "type": "string",
+ "description": "The DNS name of the service. It requires the DNS system service to be enabled in Service Fabric cluster."
+ }
+ }
+ },
+ "ServiceHealthEvaluation": {
+ "x-ms-discriminator-value": "Service",
+ "description": "Represents health evaluation for a service, containing information about the data and the algorithm used by health store to evaluate health. The evaluation is returned only when the aggregated health state is either Error or Warning.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/HealthEvaluation"
+ }
+ ],
+ "properties": {
+ "ServiceName": {
+ "$ref": "#/definitions/ServiceName",
+ "description": "Name of the service whose health evaluation is described by this object."
+ },
+ "UnhealthyEvaluations": {
+ "$ref": "#/definitions/UnhealthyEvaluations",
+ "description": "List of unhealthy evaluations that led to the current aggregated health state of the service. The types of the unhealthy evaluations can be PartitionsHealthEvaluation or EventHealthEvaluation."
+ }
+ }
+ },
+ "ServiceHealthState": {
+ "description": "Represents the health state of a service, which contains the service identifier and its aggregated health state.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/EntityHealthState"
+ }
+ ],
+ "properties": {
+ "ServiceName": {
+ "$ref": "#/definitions/ServiceName",
+ "description": "Name of the service whose health state is represented by this object."
+ }
+ }
+ },
+ "ServiceHealthStateChunk": {
+ "description": "Represents the health state chunk of a service, which contains the service name, its aggregated health state and any partitions that respect the filters in the cluster health chunk query description.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/EntityHealthStateChunk"
+ }
+ ],
+ "properties": {
+ "ServiceName": {
+ "$ref": "#/definitions/ServiceName",
+ "description": "The name of the service whose health state chunk is provided in this object."
+ },
+ "PartitionHealthStateChunks": {
+ "$ref": "#/definitions/PartitionHealthStateChunkList",
+ "description": "The list of partition health state chunks belonging to the service that respect the filters in the cluster health chunk query description."
+ }
+ }
+ },
+ "ServiceHealthStateChunkList": {
+ "description": "The list of service health state chunks that respect the input filters in the chunk query. Returned by get cluster health state chunks query.",
+ "properties": {
+ "Items": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ServiceHealthStateChunk"
+ },
+ "description": "The list of service health state chunks that respect the input filters in the chunk query."
+ }
+ }
+ },
+ "ServiceHealthStateFilter": {
+ "description": "Defines matching criteria to determine whether a service should be included as a child of an application in the cluster health chunk.\nThe services are only returned if the parent application matches a filter specified in the cluster health chunk query description.\nOne filter can match zero, one or multiple services, depending on its properties.",
+ "properties": {
+ "ServiceNameFilter": {
+ "type": "string",
+ "description": "The name of the service that matches the filter. The filter is applied only to the specified service, if it exists.\nIf the service doesn't exist, no service is returned in the cluster health chunk based on this filter.\nIf the service exists, it is included as the application's child if the health state matches the other filter properties.\nIf not specified, all services that match the parent filters (if any) are taken into consideration and matched against the other filter members, like health state filter."
+ },
+ "HealthStateFilter": {
+ "type": "integer",
+ "default": 0,
+ "description": "The filter for the health state of the services. It allows selecting services if they match the desired health states.\nThe possible values are integer value of one of the following health states. Only services that match the filter are returned. All services are used to evaluate the cluster aggregated health state.\nIf not specified, default value is None, unless the service name is specified. If the filter has default value and service name is specified, the matching service is returned.\nThe state values are flag-based enumeration, so the value could be a combination of these values obtained using bitwise 'OR' operator.\nFor example, if the provided value is 6, it matches services with HealthState value of OK (2) and Warning (4).\n\n- Default - Default value. Matches any HealthState. The value is zero.\n- None - Filter that doesn't match any HealthState value. Used in order to return no results on a given collection of states. The value is 1.\n- Ok - Filter that matches input with HealthState value Ok. The value is 2.\n- Warning - Filter that matches input with HealthState value Warning. The value is 4.\n- Error - Filter that matches input with HealthState value Error. The value is 8.\n- All - Filter that matches input with any HealthState value. The value is 65535."
+ },
+ "PartitionFilters": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/PartitionHealthStateFilter"
+ },
+ "description": "Defines a list of filters that specify which partitions to be included in the returned cluster health chunk as children of the service. The partitions are returned only if the parent service matches a filter.\nIf the list is empty, no partitions are returned. All the partitions are used to evaluate the parent service aggregated health state, regardless of the input filters.\nThe service filter may specify multiple partition filters.\nFor example, it can specify a filter to return all partitions with health state Error and another filter to always include a partition identified by its partition ID."
+ }
+ }
+ },
+ "ServiceHealth": {
+ "description": "Information about the health of a Service Fabric service.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/EntityHealth"
+ }
+ ],
+ "properties": {
+ "Name": {
+ "$ref": "#/definitions/ServiceName",
+ "description": "The name of the service whose health information is described by this object."
+ },
+ "PartitionHealthStates": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/PartitionHealthState"
+ },
+ "description": "The list of partition health states associated with the service."
+ }
+ }
+ },
+ "ServiceId": {
+ "type": "string",
+ "description": "The identity of the service. This ID is an encoded representation of the service name. This is used in the REST APIs to identify the service resource.\nStarting in version 6.0, hierarchical names are delimited with the \"\\~\" character. For example, if the service name is \"fabric:/myapp/app1/svc1\",\nthe service identity would be \"myapp~app1\\~svc1\" in 6.0+ and \"myapp/app1/svc1\" in previous versions."
+ },
+ "ServiceName": {
+ "type": "string",
+ "description": "The full name of the service with 'fabric:' URI scheme."
+ },
+ "ServiceManifestName": {
+ "type": "string",
+ "description": "The name of the service manifest."
+ },
+ "ServiceTypeName": {
+ "type": "string",
+ "description": "Name of the service type as specified in the service manifest."
+ },
+ "ServiceInfo": {
+ "discriminator": "ServiceKind",
+ "description": "Information about a Service Fabric service.",
+ "properties": {
+ "Id": {
+ "$ref": "#/definitions/ServiceId",
+ "description": "The identity of the service. This ID is an encoded representation of the service name. This is used in the REST APIs to identify the service resource.\nStarting in version 6.0, hierarchical names are delimited with the \"\\~\" character. For example, if the service name is \"fabric:/myapp/app1/svc1\",\nthe service identity would be \"myapp~app1\\~svc1\" in 6.0+ and \"myapp/app1/svc1\" in previous versions."
+ },
+ "ServiceKind": {
+ "$ref": "#/definitions/ServiceKind",
+ "description": "The kind of service (Stateless or Stateful)."
+ },
+ "Name": {
+ "$ref": "#/definitions/ServiceName",
+ "description": "The full name of the service with 'fabric:' URI scheme."
+ },
+ "TypeName": {
+ "$ref": "#/definitions/ServiceTypeName",
+ "description": "Name of the service type as specified in the service manifest."
+ },
+ "ManifestVersion": {
+ "description": "The version of the service manifest.",
+ "type": "string"
+ },
+ "HealthState": {
+ "$ref": "#/definitions/HealthState",
+ "description": "The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc."
+ },
+ "ServiceStatus": {
+ "$ref": "#/definitions/ServiceStatus",
+ "description": "The status of the application."
+ },
+ "IsServiceGroup": {
+ "description": "Whether the service is in a service group.",
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "ServiceKind"
+ ]
+ },
+ "ServiceKind": {
+ "type": "string",
+ "description": "The kind of service (Stateless or Stateful).",
+ "enum": [
+ "Invalid",
+ "Stateless",
+ "Stateful"
+ ],
+ "x-ms-enum": {
+ "name": "ServiceKind",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "Invalid",
+ "description": "Indicates the service kind is invalid. All Service Fabric enumerations have the invalid type. The value is zero."
+ },
+ {
+ "value": "Stateless",
+ "description": "Does not use Service Fabric to make its state highly available or reliable. The value is 1."
+ },
+ {
+ "value": "Stateful",
+ "description": "Uses Service Fabric to make its state or part of its state highly available and reliable. The value is 2."
+ }
+ ]
+ }
+ },
+ "ServiceNameInfo": {
+ "description": "Information about the service name.",
+ "properties": {
+ "Id": {
+ "$ref": "#/definitions/ServiceId",
+ "description": "The identity of the service. This ID is an encoded representation of the service name. This is used in the REST APIs to identify the service resource.\nStarting in version 6.0, hierarchical names are delimited with the \"\\~\" character. For example, if the service name is \"fabric:/myapp/app1/svc1\",\nthe service identity would be \"myapp~app1\\~svc1\" in 6.0+ and \"myapp/app1/svc1\" in previous versions."
+ },
+ "Name": {
+ "$ref": "#/definitions/ServiceName",
+ "description": "The full name of the service with 'fabric:' URI scheme."
+ }
+ }
+ },
+ "ServicePackageActivationId": {
+ "type": "string",
+ "description": "The ActivationId of a deployed service package. If ServicePackageActivationMode specified at the time of creating the service\nis 'SharedProcess' (or if it is not specified, in which case it defaults to 'SharedProcess'), then value of ServicePackageActivationId\nis always an empty string."
+ },
+ "ServicePartitionInfo": {
+ "discriminator": "ServiceKind",
+ "description": "Information about a partition of a Service Fabric service.",
+ "required": [
+ "ServiceKind"
+ ],
+ "properties": {
+ "ServiceKind": {
+ "$ref": "#/definitions/ServiceKind",
+ "description": "The kind of service (Stateless or Stateful)."
+ },
+ "HealthState": {
+ "$ref": "#/definitions/HealthState",
+ "description": "The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc."
+ },
+ "PartitionStatus": {
+ "$ref": "#/definitions/ServicePartitionStatus",
+ "description": "The status of the service fabric service partition."
+ },
+ "PartitionInformation": {
+ "$ref": "#/definitions/PartitionInformation",
+ "description": "Information about the partition identity, partitioning scheme and keys supported by it."
+ }
+ }
+ },
+ "ServicePartitionKind": {
+ "type": "string",
+ "description": "The kind of partitioning scheme used to partition the service.",
+ "enum": [
+ "Invalid",
+ "Singleton",
+ "Int64Range",
+ "Named"
+ ],
+ "x-ms-enum": {
+ "name": "ServicePartitionKind",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "Invalid",
+ "description": "Indicates the partition kind is invalid. All Service Fabric enumerations have the invalid type. The value is zero."
+ },
+ {
+ "value": "Singleton",
+ "description": "Indicates that there is only one partition, and SingletonPartitionSchemeDescription was specified while creating the service. The value is 1."
+ },
+ {
+ "value": "Int64Range",
+ "description": "Indicates that the partition is based on Int64 key ranges, and UniformInt64RangePartitionSchemeDescription was specified while creating the service. The value is 2."
+ },
+ {
+ "value": "Named",
+ "description": "Indicates that the partition is based on string names, and NamedPartitionInformation was specified while creating the service. The value is 3."
+ }
+ ]
+ }
+ },
+ "ServicePartitionStatus": {
+ "type": "string",
+ "description": "The status of the service fabric service partition.",
+ "enum": [
+ "Invalid",
+ "Ready",
+ "NotReady",
+ "InQuorumLoss",
+ "Reconfiguring",
+ "Deleting"
+ ],
+ "x-ms-enum": {
+ "name": "ServicePartitionStatus",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "Invalid",
+ "description": "Indicates the partition status is invalid. All Service Fabric enumerations have the invalid type. The value is zero."
+ },
+ {
+ "value": "Ready",
+ "description": "Indicates that the partition is ready. This means that for a stateless service partition there is at least one instance that is up and for a stateful service partition the number of ready replicas is greater than or equal to the MinReplicaSetSize. The value is 1."
+ },
+ {
+ "value": "NotReady",
+ "description": "Indicates that the partition is not ready. This status is returned when none of the other states apply. The value is 2."
+ },
+ {
+ "value": "InQuorumLoss",
+ "description": "Indicates that the partition is in quorum loss. This means that number of replicas that are up and participating in a replica set is less than MinReplicaSetSize for this partition. The value is 3."
+ },
+ {
+ "value": "Reconfiguring",
+ "description": "Indicates that the partition is undergoing reconfiguration of its replica sets. This can happen due to failover, upgrade, load balancing or addition or removal of replicas from the replica set. The value is 4."
+ },
+ {
+ "value": "Deleting",
+ "description": "Indicates that the partition is being deleted. The value is 5."
+ }
+ ]
+ }
+ },
+ "ServicePlacementInvalidDomainPolicyDescription": {
+ "x-ms-discriminator-value": "InvalidDomain",
+ "description": "Describes the policy to be used for placement of a Service Fabric service where a particular fault or upgrade domain should not be used for placement of the instances or replicas of that service.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ServicePlacementPolicyDescription"
+ }
+ ],
+ "properties": {
+ "DomainName": {
+ "type": "string",
+ "description": "The name of the domain that should not be used for placement."
+ }
+ }
+ },
+ "ServicePlacementNonPartiallyPlaceServicePolicyDescription": {
+ "x-ms-discriminator-value": "NonPartiallyPlaceService",
+ "description": "Describes the policy to be used for placement of a Service Fabric service where all replicas must be able to be placed in order for any replicas to be created.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ServicePlacementPolicyDescription"
+ }
+ ]
+ },
+ "ServicePlacementPolicyDescription": {
+ "discriminator": "Type",
+ "description": "Describes the policy to be used for placement of a Service Fabric service.",
+ "required": [
+ "Type"
+ ],
+ "properties": {
+ "Type": {
+ "$ref": "#/definitions/ServicePlacementPolicyType",
+ "description": "The type of placement policy for a service fabric service. Following are the possible values."
+ }
+ }
+ },
+ "ServicePlacementPolicyDescriptionList": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ServicePlacementPolicyDescription"
+ },
+ "description": "List of service placement policy descriptions."
+ },
+ "ServicePlacementPolicyType": {
+ "type": "string",
+ "description": "The type of placement policy for a service fabric service. Following are the possible values.",
+ "enum": [
+ "Invalid",
+ "InvalidDomain",
+ "RequireDomain",
+ "PreferPrimaryDomain",
+ "RequireDomainDistribution",
+ "NonPartiallyPlaceService"
+ ],
+ "x-ms-enum": {
+ "name": "ServicePlacementPolicyType",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "Invalid",
+ "description": "Indicates the type of the placement policy is invalid. All Service Fabric enumerations have the invalid type. The value is zero."
+ },
+ {
+ "value": "InvalidDomain",
+ "description": "Indicates that the ServicePlacementPolicyDescription is of type ServicePlacementInvalidDomainPolicyDescription, which indicates that a particular fault or upgrade domain cannot be used for placement of this service. The value is 1."
+ },
+ {
+ "value": "RequireDomain",
+ "description": "Indicates that the ServicePlacementPolicyDescription is of type ServicePlacementRequireDomainDistributionPolicyDescription indicating that the replicas of the service must be placed in a specific domain. The value is 2."
+ },
+ {
+ "value": "PreferPrimaryDomain",
+ "description": "Indicates that the ServicePlacementPolicyDescription is of type ServicePlacementPreferPrimaryDomainPolicyDescription, which indicates that if possible the Primary replica for the partitions of the service should be located in a particular domain as an optimization. The value is 3."
+ },
+ {
+ "value": "RequireDomainDistribution",
+ "description": "Indicates that the ServicePlacementPolicyDescription is of type ServicePlacementRequireDomainDistributionPolicyDescription, indicating that the system will disallow placement of any two replicas from the same partition in the same domain at any time. The value is 4."
+ },
+ {
+ "value": "NonPartiallyPlaceService",
+ "description": "Indicates that the ServicePlacementPolicyDescription is of type ServicePlacementNonPartiallyPlaceServicePolicyDescription, which indicates that if possible all replicas of a particular partition of the service should be placed atomically. The value is 5."
+ }
+ ]
+ }
+ },
+ "ServicePlacementPreferPrimaryDomainPolicyDescription": {
+ "x-ms-discriminator-value": "PreferPrimaryDomain",
+ "description": "Describes the policy to be used for placement of a Service Fabric service where the service's Primary replicas should optimally be placed in a particular domain.\n\nThis placement policy is usually used with fault domains in scenarios where the Service Fabric cluster is geographically distributed in order to indicate that a service's primary replica should be located in a particular fault domain, which in geo-distributed scenarios usually aligns with regional or datacenter boundaries. Note that since this is an optimization it is possible that the Primary replica may not end up located in this domain due to failures, capacity limits, or other constraints.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ServicePlacementPolicyDescription"
+ }
+ ],
+ "properties": {
+ "DomainName": {
+ "type": "string",
+ "description": "The name of the domain that should used for placement as per this policy."
+ }
+ }
+ },
+ "ServicePlacementRequiredDomainPolicyDescription": {
+ "x-ms-discriminator-value": "RequireDomain",
+ "description": "Describes the policy to be used for placement of a Service Fabric service where the instances or replicas of that service must be placed in a particular domain",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ServicePlacementPolicyDescription"
+ }
+ ],
+ "properties": {
+ "DomainName": {
+ "type": "string",
+ "description": "The name of the domain that should used for placement as per this policy."
+ }
+ }
+ },
+ "ServicePlacementRequireDomainDistributionPolicyDescription": {
+ "x-ms-discriminator-value": "RequireDomainDistribution",
+ "description": "Describes the policy to be used for placement of a Service Fabric service where two replicas from the same partition should never be placed in the same fault or upgrade domain.\n\nWhile this is not common it can expose the service to an increased risk of concurrent failures due to unplanned outages or other cases of subsequent/concurrent failures. As an example, consider a case where replicas are deployed across different data center, with one replica per location. In the event that one of the datacenters goes offline, normally the replica that was placed in that datacenter will be packed into one of the remaining datacenters. If this is not desirable then this policy should be set.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ServicePlacementPolicyDescription"
+ }
+ ],
+ "properties": {
+ "DomainName": {
+ "type": "string",
+ "description": "The name of the domain that should used for placement as per this policy."
+ }
+ }
+ },
+ "ServicesHealthEvaluation": {
+ "x-ms-discriminator-value": "Services",
+ "description": "Represents health evaluation for services of a certain service type belonging to an application, containing health evaluations for each unhealthy service that impacted current aggregated health state. Can be returned when evaluating application health and the aggregated health state is either Error or Warning.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/HealthEvaluation"
+ }
+ ],
+ "properties": {
+ "ServiceTypeName": {
+ "type": "string",
+ "description": "Name of the service type of the services."
+ },
+ "MaxPercentUnhealthyServices": {
+ "type": "integer",
+ "description": "Maximum allowed percentage of unhealthy services from the ServiceTypeHealthPolicy."
+ },
+ "TotalCount": {
+ "type": "integer",
+ "format": "int64",
+ "description": "Total number of services of the current service type in the application from the health store."
+ },
+ "UnhealthyEvaluations": {
+ "$ref": "#/definitions/UnhealthyEvaluations",
+ "description": "List of unhealthy evaluations that led to the aggregated health state. Includes all the unhealthy ServiceHealthEvaluation that impacted the aggregated health."
+ }
+ }
+ },
+ "ServiceStatus": {
+ "type": "string",
+ "description": "The status of the application.",
+ "enum": [
+ "Unknown",
+ "Active",
+ "Upgrading",
+ "Deleting",
+ "Creating",
+ "Failed"
+ ],
+ "x-ms-enum": {
+ "name": "ServiceStatus",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "Unknown",
+ "description": "Indicates the service status is unknown. The value is zero."
+ },
+ {
+ "value": "Active",
+ "description": "Indicates the service status is active. The value is 1."
+ },
+ {
+ "value": "Upgrading",
+ "description": "Indicates the service is upgrading. The value is 2."
+ },
+ {
+ "value": "Deleting",
+ "description": "Indicates the service is being deleted. The value is 3."
+ },
+ {
+ "value": "Creating",
+ "description": "Indicates the service is being created. The value is 4."
+ },
+ {
+ "value": "Failed",
+ "description": "Indicates creation or deletion was terminated due to persistent failures. Another create/delete request can be accepted. The value is 5."
+ }
+ ]
+ }
+ },
+ "ServiceTypeDescription": {
+ "discriminator": "Kind",
+ "description": "Describes a service type defined in the service manifest of a provisioned application type. The properties the ones defined in the service manifest.",
+ "required": [
+ "Kind"
+ ],
+ "properties": {
+ "Kind": {
+ "$ref": "#/definitions/ServiceKind",
+ "description": "The kind of service (Stateless or Stateful)."
+ },
+ "IsStateful": {
+ "type": "boolean",
+ "description": "Indicates whether the service type is a stateful service type or a stateless service type. This property is true if the service type is a stateful service type, false otherwise."
+ },
+ "ServiceTypeName": {
+ "$ref": "#/definitions/ServiceTypeName",
+ "description": "Name of the service type as specified in the service manifest."
+ },
+ "PlacementConstraints": {
+ "type": "string",
+ "description": "The placement constraint to be used when instantiating this service in a Service Fabric cluster."
+ },
+ "LoadMetrics": {
+ "$ref": "#/definitions/ServiceLoadMetricsList",
+ "description": "The service load metrics is given as an array of ServiceLoadMetricDescription objects."
+ },
+ "ServicePlacementPolicies": {
+ "$ref": "#/definitions/ServicePlacementPolicyDescriptionList",
+ "description": "List of service placement policy descriptions."
+ },
+ "Extensions": {
+ "$ref": "#/definitions/ServiceTypeExtensionDescriptionList",
+ "description": "List of service type extensions."
+ }
+ }
+ },
+ "ServiceTypeExtensionDescription": {
+ "description": "Describes extension of a service type defined in the service manifest.",
+ "properties": {
+ "Key": {
+ "type": "string",
+ "description": "The name of the extension."
+ },
+ "Value": {
+ "type": "string",
+ "description": "The extension value."
+ }
+ }
+ },
+ "ServiceTypeExtensionDescriptionList": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ServiceTypeExtensionDescription"
+ },
+ "description": "List of service type extensions."
+ },
+ "ServiceTypeHealthPolicy": {
+ "description": "Represents the health policy used to evaluate the health of services belonging to a service type.",
+ "properties": {
+ "MaxPercentUnhealthyPartitionsPerService": {
+ "type": "integer",
+ "description": "The maximum allowed percentage of unhealthy partitions per service. Allowed values are Byte values from zero to 100\n\nThe percentage represents the maximum tolerated percentage of partitions that can be unhealthy before the service is considered in error.\nIf the percentage is respected but there is at least one unhealthy partition, the health is evaluated as Warning.\nThe percentage is calculated by dividing the number of unhealthy partitions over the total number of partitions in the service.\nThe computation rounds up to tolerate one failure on small numbers of partitions. Default percentage is zero.",
+ "default": 0
+ },
+ "MaxPercentUnhealthyReplicasPerPartition": {
+ "type": "integer",
+ "description": "The maximum allowed percentage of unhealthy replicas per partition. Allowed values are Byte values from zero to 100.\n\nThe percentage represents the maximum tolerated percentage of replicas that can be unhealthy before the partition is considered in error.\nIf the percentage is respected but there is at least one unhealthy replica, the health is evaluated as Warning.\nThe percentage is calculated by dividing the number of unhealthy replicas over the total number of replicas in the partition.\nThe computation rounds up to tolerate one failure on small numbers of replicas. Default percentage is zero.",
+ "default": 0
+ },
+ "MaxPercentUnhealthyServices": {
+ "type": "integer",
+ "description": "The maximum allowed percentage of unhealthy services. Allowed values are Byte values from zero to 100.\n\nThe percentage represents the maximum tolerated percentage of services that can be unhealthy before the application is considered in error.\nIf the percentage is respected but there is at least one unhealthy service, the health is evaluated as Warning.\nThis is calculated by dividing the number of unhealthy services of the specific service type over the total number of services of the specific service type.\nThe computation rounds up to tolerate one failure on small numbers of services. Default percentage is zero.",
+ "default": 0
+ }
+ }
+ },
+ "ServiceTypeHealthPolicyMap": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ServiceTypeHealthPolicyMapItem"
+ },
+ "description": "Defines a ServiceTypeHealthPolicy per service type name.\n\nThe entries in the map replace the default service type health policy for each specified service type. For example, in an application that contains both a stateless gateway service type and a stateful engine service type, the health policies for the stateless and stateful services can be configured differently. With policy per service type, there's more granular control of the health of the service.\n\nIf no policy is specified for a service type name, the DefaultServiceTypeHealthPolicy is used for evaluation."
+ },
+ "ServiceTypeHealthPolicyMapItem": {
+ "description": "Defines an item in ServiceTypeHealthPolicyMap.",
+ "required": [
+ "Key",
+ "Value"
+ ],
+ "properties": {
+ "Key": {
+ "type": "string",
+ "description": "The key of the service type health policy map item. This is the name of the service type."
+ },
+ "Value": {
+ "$ref": "#/definitions/ServiceTypeHealthPolicy",
+ "description": "The value of the service type health policy map item. This is the ServiceTypeHealthPolicy for this service type."
+ }
+ }
+ },
+ "ServiceTypeInfo": {
+ "description": "Information about a service type that is defined in a service manifest of a provisioned application type.",
+ "properties": {
+ "ServiceTypeDescription": {
+ "$ref": "#/definitions/ServiceTypeDescription",
+ "description": "Describes a service type defined in the service manifest of a provisioned application type. The properties the ones defined in the service manifest."
+ },
+ "ServiceManifestName": {
+ "$ref": "#/definitions/ServiceManifestName",
+ "description": "The name of the service manifest in which this service type is defined."
+ },
+ "ServiceManifestVersion": {
+ "type": "string",
+ "description": "The version of the service manifest in which this service type is defined."
+ },
+ "IsServiceGroup": {
+ "type": "boolean",
+ "description": "Indicates whether the service is a service group. If it is, the property value is true otherwise false."
+ }
+ }
+ },
+ "ServiceTypeInfoList": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ServiceTypeInfo"
+ },
+ "description": "List of service type information."
+ },
+ "ServiceTypeManifest": {
+ "description": "Contains the manifest describing a service type registered as part of an application in a Service Fabric cluster.",
+ "properties": {
+ "Manifest": {
+ "type": "string",
+ "description": "The XML manifest as a string."
+ }
+ }
+ },
+ "SingletonPartitionInformation": {
+ "description": "Information about a partition that is singleton. The services with singleton partitioning scheme are effectively non-partitioned. They only have one partition.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/PartitionInformation"
+ }
+ ],
+ "x-ms-discriminator-value": "Singleton"
+ },
+ "StatefulServiceInfo": {
+ "description": "Information about a stateful Service Fabric service.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ServiceInfo"
+ }
+ ],
+ "properties": {
+ "HasPersistedState": {
+ "description": "Whether the service has persisted state.",
+ "type": "boolean"
+ }
+ },
+ "x-ms-discriminator-value": "Stateful"
+ },
+ "StatefulServicePartitionInfo": {
+ "description": "Information about a partition of a stateful Service Fabric service..",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ServicePartitionInfo"
+ }
+ ],
+ "x-ms-discriminator-value": "Stateful",
+ "properties": {
+ "TargetReplicaSetSize": {
+ "type": "integer",
+ "format": "int64",
+ "description": "The target replica set size as a number."
+ },
+ "MinReplicaSetSize": {
+ "type": "integer",
+ "format": "int64",
+ "description": "The minimum replica set size as a number."
+ },
+ "LastQuorumLossDuration": {
+ "type": "string",
+ "format": "duration",
+ "description": "The duration for which this partition was in quorum loss. If the partition is currently in quorum loss, it returns the duration since it has been in that state. This field is using ISO8601 format for specifying the duration."
+ },
+ "PrimaryEpoch": {
+ "$ref": "#/definitions/Epoch",
+ "description": "An Epoch is a configuration number for the partition as a whole. When the configuration of the replica set changes, for example when the Primary replica changes, the operations that are replicated from the new Primary replica are said to be a new Epoch from the ones which were sent by the old Primary replica."
+ }
+ }
+ },
+ "StatefulServiceReplicaHealth": {
+ "description": "Represents the health of the stateful service replica.\nContains the replica aggregated health state, the health events and the unhealthy evaluations.",
+ "x-ms-discriminator-value": "Stateful",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ReplicaHealth"
+ }
+ ],
+ "properties": {
+ "ReplicaId": {
+ "$ref": "#/definitions/ReplicaId",
+ "description": "Id of a stateful service replica. ReplicaId is used by Service Fabric to uniquely identify a replica of a partition. It is unique within a partition and does not change for the lifetime of the replica. If a replica gets dropped and another replica gets created on the same node for the same partition, it will get a different value for the id. Sometimes the id of a stateless service instance is also referred as a replica id."
+ }
+ }
+ },
+ "StatefulServiceReplicaHealthState": {
+ "x-ms-discriminator-value": "Stateful",
+ "description": "Represents the health state of the stateful service replica, which contains the replica ID and the aggregated health state.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ReplicaHealthState"
+ }
+ ],
+ "properties": {
+ "ReplicaId": {
+ "$ref": "#/definitions/ReplicaId",
+ "description": "Id of a stateful service replica. ReplicaId is used by Service Fabric to uniquely identify a replica of a partition. It is unique within a partition and does not change for the lifetime of the replica. If a replica gets dropped and another replica gets created on the same node for the same partition, it will get a different value for the id. Sometimes the id of a stateless service instance is also referred as a replica id."
+ }
+ }
+ },
+ "StatefulServiceTypeDescription": {
+ "description": "Describes a stateful service type defined in the service manifest of a provisioned application type.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ServiceTypeDescription"
+ }
+ ],
+ "x-ms-discriminator-value": "Stateful",
+ "properties": {
+ "HasPersistedState": {
+ "type": "boolean",
+ "description": "A flag indicating whether this is a persistent service which stores states on the local disk. If it is then the value of this property is true, if not it is false."
+ }
+ }
+ },
+ "StatelessServiceInfo": {
+ "description": "Information about a stateless Service Fabric service.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ServiceInfo"
+ }
+ ],
+ "x-ms-discriminator-value": "Stateless"
+ },
+ "StatelessServiceInstanceHealth": {
+ "description": "Represents the health of the stateless service instance.\nContains the instance aggregated health state, the health events and the unhealthy evaluations.",
+ "x-ms-discriminator-value": "Stateless",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ReplicaHealth"
+ }
+ ],
+ "properties": {
+ "InstanceId": {
+ "$ref": "#/definitions/InstanceId",
+ "description": "Id of a stateless service instance. InstanceId is used by Service Fabric to uniquely identify an instance of a partition of a stateless service. It is unique within a partition and does not change for the lifetime of the instance. If the instance has failed over on the same or different node, it will get a different value for the InstanceId."
+ }
+ }
+ },
+ "StatelessServiceInstanceHealthState": {
+ "x-ms-discriminator-value": "Stateless",
+ "description": "Represents the health state of the stateless service instance, which contains the instance ID and the aggregated health state.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ReplicaHealthState"
+ }
+ ],
+ "properties": {
+ "ReplicaId": {
+ "$ref": "#/definitions/ReplicaId",
+ "description": "Id of the stateless service instance on the wire this field is called ReplicaId."
+ }
+ }
+ },
+ "StatelessServicePartitionInfo": {
+ "description": "Information about a partition of a stateless Service Fabric service.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ServicePartitionInfo"
+ }
+ ],
+ "x-ms-discriminator-value": "Stateless",
+ "properties": {
+ "InstanceCount": {
+ "type": "integer",
+ "format": "int64",
+ "description": "Number of instances of this partition."
+ },
+ "MinInstanceCount": {
+ "$ref": "#/definitions/MinInstanceCount",
+ "description": "MinInstanceCount is the minimum number of instances that must be up to meet the EnsureAvailability safety check during operations like upgrade or deactivate node.\nThe actual number that is used is max( MinInstanceCount, ceil( MinInstancePercentage/100.0 * InstanceCount) ).\nNote, if InstanceCount is set to -1, during MinInstanceCount computation -1 is first converted into the number of nodes on which the instances are allowed to be placed according to the placement constraints on the service."
+ },
+ "MinInstancePercentage": {
+ "$ref": "#/definitions/MinInstancePercentage",
+ "description": "MinInstancePercentage is the minimum percentage of InstanceCount that must be up to meet the EnsureAvailability safety check during operations like upgrade or deactivate node.\nThe actual number that is used is max( MinInstanceCount, ceil( MinInstancePercentage/100.0 * InstanceCount) ).\nNote, if InstanceCount is set to -1, during MinInstancePercentage computation, -1 is first converted into the number of nodes on which the instances are allowed to be placed according to the placement constraints on the service."
+ }
+ }
+ },
+ "StatelessServiceTypeDescription": {
+ "description": "Describes a stateless service type defined in the service manifest of a provisioned application type.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ServiceTypeDescription"
+ }
+ ],
+ "x-ms-discriminator-value": "Stateless",
+ "properties": {
+ "UseImplicitHost": {
+ "type": "boolean",
+ "description": "A flag indicating if this type is not implemented and hosted by a user service process, but is implicitly hosted by a system created process. This value is true for services using the guest executable services, false otherwise."
+ }
+ }
+ },
+ "SystemApplicationHealthEvaluation": {
+ "x-ms-discriminator-value": "SystemApplication",
+ "description": "Represents health evaluation for the fabric:/System application, containing information about the data and the algorithm used by health store to evaluate health. The evaluation is returned only when the aggregated health state of the cluster is either Error or Warning.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/HealthEvaluation"
+ }
+ ],
+ "properties": {
+ "UnhealthyEvaluations": {
+ "$ref": "#/definitions/UnhealthyEvaluations",
+ "description": "List of unhealthy evaluations that led to the current aggregated health state of the system application. The types of the unhealthy evaluations can be DeployedApplicationsHealthEvaluation, ServicesHealthEvaluation or EventHealthEvaluation."
+ }
+ }
+ },
+ "TargetApplicationName": {
+ "type": "string",
+ "description": "The name of the target application, including the 'fabric:' URI scheme."
+ },
+ "TargetApplicationTypeVersion": {
+ "type": "string",
+ "description": "The target application type version (found in the application manifest) for the application upgrade."
+ },
+ "TargetDeploymentName": {
+ "type": "string",
+ "description": "The name of the target deployment."
+ },
+ "UnhealthyEvaluations": {
+ "description": "List of health evaluations that resulted in the current aggregated health state.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/HealthEvaluationWrapper"
+ }
+ },
+ "UpgradeDomainDeltaNodesCheckHealthEvaluation": {
+ "x-ms-discriminator-value": "UpgradeDomainDeltaNodesCheck",
+ "description": "Represents health evaluation for delta unhealthy cluster nodes in an upgrade domain, containing health evaluations for each unhealthy node that impacted current aggregated health state.\nCan be returned during cluster upgrade when cluster aggregated health state is Warning or Error.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/HealthEvaluation"
+ }
+ ],
+ "properties": {
+ "UpgradeDomainName": {
+ "type": "string",
+ "description": "Name of the upgrade domain where nodes health is currently evaluated."
+ },
+ "BaselineErrorCount": {
+ "type": "integer",
+ "format": "int64",
+ "description": "Number of upgrade domain nodes with aggregated heath state Error in the health store at the beginning of the cluster upgrade."
+ },
+ "BaselineTotalCount": {
+ "type": "integer",
+ "format": "int64",
+ "description": "Total number of upgrade domain nodes in the health store at the beginning of the cluster upgrade."
+ },
+ "MaxPercentDeltaUnhealthyNodes": {
+ "type": "integer",
+ "description": "Maximum allowed percentage of upgrade domain delta unhealthy nodes from the ClusterUpgradeHealthPolicy."
+ },
+ "TotalCount": {
+ "type": "integer",
+ "format": "int64",
+ "description": "Total number of upgrade domain nodes in the health store."
+ },
+ "UnhealthyEvaluations": {
+ "$ref": "#/definitions/UnhealthyEvaluations",
+ "description": "List of unhealthy evaluations that led to the aggregated health state. Includes all the unhealthy NodeHealthEvaluation that impacted the aggregated health."
+ }
+ }
+ },
+ "UpgradeDomainInfo": {
+ "description": "Information about an upgrade domain.",
+ "properties": {
+ "Name": {
+ "$ref": "#/definitions/UpgradeDomainName",
+ "description": "The name of the upgrade domain"
+ },
+ "State": {
+ "$ref": "#/definitions/UpgradeDomainState",
+ "description": "The state of the upgrade domain."
+ }
+ }
+ },
+ "UpgradeDomainInfoList": {
+ "type": "array",
+ "description": "List of upgrade domains and their statuses.",
+ "items": {
+ "$ref": "#/definitions/UpgradeDomainInfo"
+ }
+ },
+ "UpgradeDomainName": {
+ "type": "string",
+ "description": "The name of the upgrade domain"
+ },
+ "UpgradeDomainNodesHealthEvaluation": {
+ "x-ms-discriminator-value": "UpgradeDomainNodes",
+ "description": "Represents health evaluation for cluster nodes in an upgrade domain, containing health evaluations for each unhealthy node that impacted current aggregated health state. Can be returned when evaluating cluster health during cluster upgrade and the aggregated health state is either Error or Warning.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/HealthEvaluation"
+ }
+ ],
+ "properties": {
+ "UpgradeDomainName": {
+ "type": "string",
+ "description": "Name of the upgrade domain where nodes health is currently evaluated."
+ },
+ "MaxPercentUnhealthyNodes": {
+ "type": "integer",
+ "description": "Maximum allowed percentage of unhealthy nodes from the ClusterHealthPolicy."
+ },
+ "TotalCount": {
+ "type": "integer",
+ "format": "int64",
+ "description": "Total number of nodes in the current upgrade domain."
+ },
+ "UnhealthyEvaluations": {
+ "$ref": "#/definitions/UnhealthyEvaluations",
+ "description": "List of unhealthy evaluations that led to the aggregated health state. Includes all the unhealthy NodeHealthEvaluation that impacted the aggregated health."
+ }
+ }
+ },
+ "UpgradeDomainState": {
+ "type": "string",
+ "description": "The state of the upgrade domain.",
+ "enum": [
+ "Invalid",
+ "Pending",
+ "InProgress",
+ "Completed"
+ ],
+ "x-ms-enum": {
+ "name": "UpgradeDomainState",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "Invalid",
+ "description": "Indicates the upgrade domain state is invalid. All Service Fabric enumerations have the invalid type. The value is zero."
+ },
+ {
+ "value": "Pending",
+ "description": "The upgrade domain has not started upgrading yet. The value is 1"
+ },
+ {
+ "value": "InProgress",
+ "description": "The upgrade domain is being upgraded but not complete yet. The value is 2"
+ },
+ {
+ "value": "Completed",
+ "description": "The upgrade domain has completed upgrade. The value is 3"
+ }
+ ]
+ }
+ },
+ "UpgradeDomainTimeout": {
+ "type": "string",
+ "description": "The amount of time each upgrade domain has to complete before FailureAction is executed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds.",
+ "default": "P10675199DT02H48M05.4775807S"
+ },
+ "UpgradeDuration": {
+ "type": "string",
+ "description": "The estimated amount of time that the overall upgrade elapsed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds.",
+ "default": "PT0H2M0S"
+ },
+ "UpgradeKind": {
+ "type": "string",
+ "description": "The kind of upgrade out of the following possible values.",
+ "default": "Rolling",
+ "enum": [
+ "Invalid",
+ "Rolling"
+ ],
+ "x-ms-enum": {
+ "name": "UpgradeKind",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "Invalid",
+ "description": "Indicates the upgrade kind is invalid. All Service Fabric enumerations have the invalid type. The value is zero."
+ },
+ {
+ "value": "Rolling",
+ "description": "The upgrade progresses one upgrade domain at a time. The value is 1"
+ }
+ ]
+ }
+ },
+ "UpgradeMode": {
+ "type": "string",
+ "description": "The mode used to monitor health during a rolling upgrade. The values are UnmonitoredAuto, UnmonitoredManual, and Monitored.",
+ "enum": [
+ "Invalid",
+ "UnmonitoredAuto",
+ "UnmonitoredManual",
+ "Monitored"
+ ],
+ "default": "UnmonitoredAuto",
+ "x-ms-enum": {
+ "name": "UpgradeMode",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "Invalid",
+ "description": "Indicates the upgrade mode is invalid. All Service Fabric enumerations have the invalid type. The value is zero."
+ },
+ {
+ "value": "UnmonitoredAuto",
+ "description": "The upgrade will proceed automatically without performing any health monitoring. The value is 1"
+ },
+ {
+ "value": "UnmonitoredManual",
+ "description": "The upgrade will stop after completing each upgrade domain, giving the opportunity to manually monitor health before proceeding. The value is 2"
+ },
+ {
+ "value": "Monitored",
+ "description": "The upgrade will stop after completing each upgrade domain and automatically monitor health before proceeding. The value is 3"
+ }
+ ]
+ }
+ },
+ "UpgradeSortOrder": {
+ "type": "string",
+ "description": "Defines the order in which an upgrade proceeds through the cluster.",
+ "enum": [
+ "Invalid",
+ "Default",
+ "Numeric",
+ "Lexicographical",
+ "ReverseNumeric",
+ "ReverseLexicographical"
+ ],
+ "default": "Default",
+ "x-ms-enum": {
+ "name": "UpgradeSortOrder",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "Invalid",
+ "description": "Indicates that this sort order is not valid. All Service Fabric enumerations have the invalid type. The value is 0."
+ },
+ {
+ "value": "Default",
+ "description": "Indicates that the default sort order (as specified in cluster manifest) will be used. The value is 1."
+ },
+ {
+ "value": "Numeric",
+ "description": "Indicates that forward numeric sort order (UD names sorted as numbers) will be used. The value is 2."
+ },
+ {
+ "value": "Lexicographical",
+ "description": "Indicates that forward lexicographical sort order (UD names sorted as strings) will be used. The value is 3."
+ },
+ {
+ "value": "ReverseNumeric",
+ "description": "Indicates that reverse numeric sort order (UD names sorted as numbers) will be used. The value is 4."
+ },
+ {
+ "value": "ReverseLexicographical",
+ "description": "Indicates that reverse lexicographical sort order (UD names sorted as strings) will be used. The value is 5."
+ }
+ ]
+ }
+ },
+ "UpgradeType": {
+ "type": "string",
+ "description": "The type of upgrade out of the following possible values.",
+ "default": "Rolling",
+ "enum": [
+ "Invalid",
+ "Rolling",
+ "Rolling_ForceRestart"
+ ],
+ "x-ms-enum": {
+ "name": "UpgradeType",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "Invalid",
+ "description": "Indicates the upgrade kind is invalid. All Service Fabric enumerations have the invalid type. The value is zero."
+ },
+ {
+ "value": "Rolling",
+ "description": "The upgrade progresses one upgrade domain at a time. The value is 1."
+ },
+ {
+ "value": "Rolling_ForceRestart",
+ "description": "The upgrade gets restarted by force. The value is 2."
+ }
+ ]
+ }
+ },
+ "UpgradeReplicaSetCheckTimeout": {
+ "type": "integer",
+ "format": "int64",
+ "description": "The maximum amount of time to block processing of an upgrade domain and prevent loss of availability when there are unexpected issues. When this timeout expires, processing of the upgrade domain will proceed regardless of availability loss issues. The timeout is reset at the start of each upgrade domain. Valid values are between 0 and 42949672925 inclusive. (unsigned 32-bit integer).",
+ "default": 42949672925
+ },
+ "UpgradeState": {
+ "type": "string",
+ "description": "The state of the upgrade domain.",
+ "enum": [
+ "Invalid",
+ "RollingBackInProgress",
+ "RollingBackCompleted",
+ "RollingForwardPending",
+ "RollingForwardInProgress",
+ "RollingForwardCompleted",
+ "Failed"
+ ],
+ "x-ms-enum": {
+ "name": "UpgradeState",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "Invalid",
+ "description": "Indicates the upgrade state is invalid. All Service Fabric enumerations have the invalid type. The value is zero."
+ },
+ {
+ "value": "RollingBackInProgress",
+ "description": "The upgrade is rolling back to the previous version but is not complete yet. The value is 1"
+ },
+ {
+ "value": "RollingBackCompleted",
+ "description": "The upgrade has finished rolling back. The value is 2"
+ },
+ {
+ "value": "RollingForwardPending",
+ "description": "The current upgrade domain has finished upgrading. The overall upgrade is waiting for an explicit move next request in UnmonitoredManual mode or performing health checks in Monitored mode. The value is 3"
+ },
+ {
+ "value": "RollingForwardInProgress",
+ "description": "The upgrade is rolling forward to the target version but is not complete yet. The value is 4"
+ },
+ {
+ "value": "RollingForwardCompleted",
+ "description": "The upgrade has finished rolling forward. The value is 5"
+ },
+ {
+ "value": "Failed",
+ "description": "The upgrade has failed and is unable to execute FailureAction. The value is 6"
+ }
+ ]
+ }
+ },
+ "UpgradeTimeout": {
+ "type": "string",
+ "description": "The amount of time the overall upgrade has to complete before FailureAction is executed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds.",
+ "default": "P10675199DT02H48M05.4775807S"
+ },
+ "WaitForInbuildReplicaSafetyCheck": {
+ "description": "Safety check that waits for the replica build operation to finish. This indicates that there is a replica that is going through the copy or is providing data for building another replica. Bring the node down will abort this copy operation which are typically expensive involving data movements.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/PartitionSafetyCheck"
+ }
+ ],
+ "x-ms-discriminator-value": "WaitForInbuildReplica"
+ },
+ "WaitForPrimaryPlacementSafetyCheck": {
+ "description": "Safety check that waits for the primary replica that was moved out of the node due to upgrade to be placed back again on that node.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/PartitionSafetyCheck"
+ }
+ ],
+ "x-ms-discriminator-value": "WaitForPrimaryPlacement"
+ },
+ "WaitForPrimarySwapSafetyCheck": {
+ "description": "Safety check that waits for the primary replica to be moved out of the node before starting an upgrade to ensure the availability of the primary replica for the partition.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/PartitionSafetyCheck"
+ }
+ ],
+ "x-ms-discriminator-value": "WaitForPrimarySwap"
+ },
+ "WaitForReconfigurationSafetyCheck": {
+ "description": "Safety check that waits for the current reconfiguration of the partition to be completed before starting an upgrade.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/PartitionSafetyCheck"
+ }
+ ],
+ "x-ms-discriminator-value": "WaitForReconfiguration"
+ },
+ "LoadMetricReport": {
+ "description": "Represents the load metric report which contains the time metric was reported, its name and value.",
+ "properties": {
+ "LastReportedUtc": {
+ "type": "string",
+ "format": "date-time",
+ "description": "Gets the UTC time when the load was reported."
+ },
+ "Name": {
+ "type": "string",
+ "description": "The name of the load metric."
+ },
+ "Value": {
+ "type": "string",
+ "format": "int32",
+ "description": "The value of the load metric. In future releases of Service Fabric this parameter will be deprecated in favor of CurrentValue."
+ },
+ "CurrentValue": {
+ "type": "string",
+ "format": "double",
+ "description": "The value of the load metric."
+ }
+ }
+ },
+ "PartitionLoadInformation": {
+ "description": "Represents load information for a partition, which contains the primary and secondary reported load metrics.\nIn case there is no load reported, PartitionLoadInformation will contain the default load for the service of the partition.\nFor default loads, LoadMetricReport's LastReportedUtc is set to 0.",
+ "properties": {
+ "PartitionId": {
+ "$ref": "#/definitions/PartitionId",
+ "description": "Id of the partition."
+ },
+ "PrimaryLoadMetricReports": {
+ "type": "array",
+ "description": "Array of load reports from the primary replica for this partition.",
+ "items": {
+ "$ref": "#/definitions/LoadMetricReport"
+ }
+ },
+ "SecondaryLoadMetricReports": {
+ "type": "array",
+ "description": "Array of aggregated load reports from all secondary replicas for this partition.\nArray only contains the latest reported load for each metric.",
+ "items": {
+ "$ref": "#/definitions/LoadMetricReport"
+ }
+ }
+ }
+ },
+ "StatefulServiceReplicaInfo": {
+ "x-ms-discriminator-value": "Stateful",
+ "description": "Represents a stateful service replica. This includes information about the identity, role, status, health, node name, uptime, and other details about the replica.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ReplicaInfo"
+ }
+ ],
+ "properties": {
+ "ReplicaRole": {
+ "$ref": "#/definitions/ReplicaRole",
+ "description": "The role of a replica of a stateful service."
+ },
+ "ReplicaId": {
+ "$ref": "#/definitions/ReplicaId",
+ "description": "Id of a stateful service replica. ReplicaId is used by Service Fabric to uniquely identify a replica of a partition. It is unique within a partition and does not change for the lifetime of the replica. If a replica gets dropped and another replica gets created on the same node for the same partition, it will get a different value for the id. Sometimes the id of a stateless service instance is also referred as a replica id."
+ }
+ }
+ },
+ "StatelessServiceInstanceInfo": {
+ "x-ms-discriminator-value": "Stateless",
+ "description": "Represents a stateless service instance. This includes information about the identity, status, health, node name, uptime, and other details about the instance.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ReplicaInfo"
+ }
+ ],
+ "properties": {
+ "InstanceId": {
+ "$ref": "#/definitions/InstanceId",
+ "description": "Id of a stateless service instance. InstanceId is used by Service Fabric to uniquely identify an instance of a partition of a stateless service. It is unique within a partition and does not change for the lifetime of the instance. If the instance has failed over on the same or different node, it will get a different value for the InstanceId."
+ }
+ }
+ },
+ "ClusterFabricCodeVersionString": {
+ "type": "string",
+ "description": "The ServiceFabric code version of the cluster."
+ },
+ "ClusterFabricConfigVersionString": {
+ "type": "string",
+ "description": "The cluster configuration version (specified in the cluster manifest)."
+ },
+ "ClusterUpgradeDescriptionObject": {
+ "description": "Represents a ServiceFabric cluster upgrade",
+ "properties": {
+ "ConfigVersion": {
+ "$ref": "#/definitions/ClusterFabricConfigVersionString",
+ "description": "The cluster configuration version (specified in the cluster manifest)."
+ },
+ "CodeVersion": {
+ "$ref": "#/definitions/ClusterFabricCodeVersionString",
+ "description": "The ServiceFabric code version of the cluster."
+ },
+ "UpgradeKind": {
+ "$ref": "#/definitions/UpgradeKind",
+ "description": "The kind of upgrade out of the following possible values."
+ },
+ "RollingUpgradeMode": {
+ "$ref": "#/definitions/UpgradeMode",
+ "description": "The mode used to monitor health during a rolling upgrade. The values are UnmonitoredAuto, UnmonitoredManual, and Monitored."
+ },
+ "UpgradeReplicaSetCheckTimeoutInSeconds": {
+ "$ref": "#/definitions/UpgradeReplicaSetCheckTimeout",
+ "description": "The maximum amount of time to block processing of an upgrade domain and prevent loss of availability when there are unexpected issues. When this timeout expires, processing of the upgrade domain will proceed regardless of availability loss issues. The timeout is reset at the start of each upgrade domain. Valid values are between 0 and 42949672925 inclusive. (unsigned 32-bit integer)."
+ },
+ "ForceRestart": {
+ "$ref": "#/definitions/ForceRestart",
+ "description": "If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data)."
+ },
+ "SortOrder": {
+ "$ref": "#/definitions/UpgradeSortOrder",
+ "description": "Defines the order in which an upgrade proceeds through the cluster."
+ },
+ "EnableDeltaHealthEvaluation": {
+ "$ref": "#/definitions/DeltaHealthEvaluationBool",
+ "description": "When true, enables delta health evaluation rather than absolute health evaluation after completion of each upgrade domain."
+ },
+ "MonitoringPolicy": {
+ "$ref": "#/definitions/MonitoringPolicyDescription",
+ "description": "Describes the parameters for monitoring an upgrade in Monitored mode."
+ },
+ "ClusterHealthPolicy": {
+ "$ref": "#/definitions/ClusterHealthPolicy",
+ "description": "Defines a health policy used to evaluate the health of the cluster or of a cluster node."
+ },
+ "ClusterUpgradeHealthPolicy": {
+ "$ref": "#/definitions/ClusterUpgradeHealthPolicyObject",
+ "description": "Defines a health policy used to evaluate the health of the cluster during a cluster upgrade."
+ },
+ "ApplicationHealthPolicyMap": {
+ "$ref": "#/definitions/ApplicationHealthPolicyMap",
+ "description": "Defines a map that contains specific application health policies for different applications.\nEach entry specifies as key the application name and as value an ApplicationHealthPolicy used to evaluate the application health.\nIf an application is not specified in the map, the application health evaluation uses the ApplicationHealthPolicy found in its application manifest or the default application health policy (if no health policy is defined in the manifest).\nThe map is empty by default."
+ }
+ }
+ },
+ "ClusterUpgradeHealthPolicyObject": {
+ "description": "Defines a health policy used to evaluate the health of the cluster during a cluster upgrade.",
+ "properties": {
+ "MaxPercentDeltaUnhealthyNodes": {
+ "type": "integer",
+ "description": "The maximum allowed percentage of nodes health degradation allowed during cluster upgrades. The delta is measured between the state of the nodes at the beginning of upgrade and the state of the nodes at the time of the health evaluation. The check is performed after every upgrade domain upgrade completion to make sure the global state of the cluster is within tolerated limits. The default value is 10%.",
+ "maximum": 100,
+ "minimum": 0
+ },
+ "MaxPercentUpgradeDomainDeltaUnhealthyNodes": {
+ "type": "integer",
+ "description": "The maximum allowed percentage of upgrade domain nodes health degradation allowed during cluster upgrades. The delta is measured between the state of the upgrade domain nodes at the beginning of upgrade and the state of the upgrade domain nodes at the time of the health evaluation. The check is performed after every upgrade domain upgrade completion for all completed upgrade domains to make sure the state of the upgrade domains is within tolerated limits. The default value is 15%.",
+ "maximum": 100,
+ "minimum": 0
+ }
+ }
+ },
+ "ClusterUpgradeProgressObject": {
+ "description": "Information about a cluster upgrade.",
+ "properties": {
+ "CodeVersion": {
+ "$ref": "#/definitions/ClusterFabricCodeVersionString",
+ "description": "The ServiceFabric code version of the cluster."
+ },
+ "ConfigVersion": {
+ "$ref": "#/definitions/ClusterFabricConfigVersionString",
+ "description": "The cluster configuration version (specified in the cluster manifest)."
+ },
+ "UpgradeDomains": {
+ "$ref": "#/definitions/UpgradeDomainInfoList",
+ "description": "List of upgrade domains and their statuses."
+ },
+ "UpgradeState": {
+ "$ref": "#/definitions/UpgradeState",
+ "description": "The state of the upgrade domain."
+ },
+ "NextUpgradeDomain": {
+ "$ref": "#/definitions/NextUpgradeDomain",
+ "description": "The name of the next upgrade domain to be processed."
+ },
+ "RollingUpgradeMode": {
+ "$ref": "#/definitions/UpgradeMode",
+ "description": "The mode used to monitor health during a rolling upgrade. The values are UnmonitoredAuto, UnmonitoredManual, and Monitored."
+ },
+ "UpgradeDescription": {
+ "$ref": "#/definitions/ClusterUpgradeDescriptionObject",
+ "description": "Represents a ServiceFabric cluster upgrade"
+ },
+ "UpgradeDurationInMilliseconds": {
+ "$ref": "#/definitions/UpgradeDurationString",
+ "description": "The estimated elapsed time spent processing the current overall upgrade."
+ },
+ "UpgradeDomainDurationInMilliseconds": {
+ "$ref": "#/definitions/UpgradeDomainDurationString",
+ "description": "The estimated elapsed time spent processing the current upgrade domain."
+ },
+ "UnhealthyEvaluations": {
+ "$ref": "#/definitions/UnhealthyEvaluations",
+ "description": "List of health evaluations that resulted in the current aggregated health state."
+ },
+ "CurrentUpgradeDomainProgress": {
+ "$ref": "#/definitions/CurrentUpgradeDomainProgressInfo",
+ "description": "Information about the current in-progress upgrade domain."
+ },
+ "StartTimestampUtc": {
+ "$ref": "#/definitions/UpgradeStartTimeUTCString",
+ "description": "The start time of the upgrade in UTC."
+ },
+ "FailureTimestampUtc": {
+ "$ref": "#/definitions/UpgradeFailureTimeUTCString",
+ "description": "The failure time of the upgrade in UTC."
+ },
+ "FailureReason": {
+ "$ref": "#/definitions/FailureReason",
+ "description": "The cause of an upgrade failure that resulted in FailureAction being executed."
+ },
+ "UpgradeDomainProgressAtFailure": {
+ "$ref": "#/definitions/FailedUpgradeDomainProgressObject",
+ "description": "The detailed upgrade progress for nodes in the current upgrade domain at the point of failure."
+ }
+ }
+ },
+ "ClusterConfigurationUpgradeDescription": {
+ "description": "Describes the parameters for a standalone cluster configuration upgrade.",
+ "properties": {
+ "ClusterConfig": {
+ "type": "string",
+ "description": "The cluster configuration as a JSON string. For example, [this file](https://github.com/Azure-Samples/service-fabric-dotnet-standalone-cluster-configuration/blob/master/Samples/ClusterConfig.Unsecure.DevCluster.json) contains JSON describing the [nodes and other properties of the cluster](https://docs.microsoft.com/azure/service-fabric/service-fabric-cluster-manifest)."
+ },
+ "HealthCheckRetryTimeout": {
+ "type": "string",
+ "format": "duration",
+ "description": "The length of time between attempts to perform health checks if the application or cluster is not healthy.",
+ "default": "PT0H0M0S"
+ },
+ "HealthCheckWaitDurationInSeconds": {
+ "type": "string",
+ "format": "duration",
+ "description": "The length of time to wait after completing an upgrade domain before starting the health checks process.",
+ "default": "PT0H0M0S"
+ },
+ "HealthCheckStableDurationInSeconds": {
+ "type": "string",
+ "format": "duration",
+ "description": "The length of time that the application or cluster must remain healthy before the upgrade proceeds to the next upgrade domain.",
+ "default": "PT0H0M0S"
+ },
+ "UpgradeDomainTimeoutInSeconds": {
+ "type": "string",
+ "format": "duration",
+ "description": "The timeout for the upgrade domain.",
+ "default": "PT0H0M0S"
+ },
+ "UpgradeTimeoutInSeconds": {
+ "type": "string",
+ "format": "duration",
+ "description": "The upgrade timeout.",
+ "default": "PT0H0M0S"
+ },
+ "MaxPercentUnhealthyApplications": {
+ "type": "integer",
+ "description": "The maximum allowed percentage of unhealthy applications during the upgrade. Allowed values are integer values from zero to 100.",
+ "default": 0
+ },
+ "MaxPercentUnhealthyNodes": {
+ "type": "integer",
+ "description": "The maximum allowed percentage of unhealthy nodes during the upgrade. Allowed values are integer values from zero to 100.",
+ "default": 0
+ },
+ "MaxPercentDeltaUnhealthyNodes": {
+ "type": "integer",
+ "description": "The maximum allowed percentage of delta health degradation during the upgrade. Allowed values are integer values from zero to 100.",
+ "default": 0
+ },
+ "MaxPercentUpgradeDomainDeltaUnhealthyNodes": {
+ "type": "integer",
+ "description": "The maximum allowed percentage of upgrade domain delta health degradation during the upgrade. Allowed values are integer values from zero to 100.",
+ "default": 0
+ },
+ "ApplicationHealthPolicies": {
+ "$ref": "#/definitions/ApplicationHealthPolicies",
+ "description": "Defines the application health policy map used to evaluate the health of an application or one of its children entities."
+ }
+ },
+ "required": [
+ "ClusterConfig"
+ ]
+ },
+ "DeltaHealthEvaluationBool": {
+ "type": "boolean",
+ "description": "When true, enables delta health evaluation rather than absolute health evaluation after completion of each upgrade domain."
+ },
+ "FailedUpgradeDomainProgressObject": {
+ "description": "The detailed upgrade progress for nodes in the current upgrade domain at the point of failure.",
+ "properties": {
+ "DomainName": {
+ "$ref": "#/definitions/UpgradeDomainName",
+ "description": "The name of the upgrade domain"
+ },
+ "NodeUpgradeProgressList": {
+ "$ref": "#/definitions/NodeUpgradeProgressInfoList",
+ "description": "List of upgrading nodes and their statuses"
+ }
+ }
+ },
+ "UpgradeDomainDurationString": {
+ "type": "string",
+ "description": "The estimated elapsed time spent processing the current upgrade domain."
+ },
+ "UpgradeDurationString": {
+ "type": "string",
+ "description": "The estimated elapsed time spent processing the current overall upgrade."
+ },
+ "UpgradeFailureTimeUTCString": {
+ "type": "string",
+ "description": "The failure time of the upgrade in UTC."
+ },
+ "UpgradeStartTimeUTCString": {
+ "type": "string",
+ "description": "The start time of the upgrade in UTC."
+ },
+ "UpgradeOrchestrationServiceState": {
+ "description": "Service state of Service Fabric Upgrade Orchestration Service.",
+ "properties": {
+ "ServiceState": {
+ "type": "string",
+ "description": "The state of Service Fabric Upgrade Orchestration Service."
+ }
+ }
+ },
+ "UpgradeOrchestrationServiceStateSummary": {
+ "description": "Service state summary of Service Fabric Upgrade Orchestration Service.",
+ "properties": {
+ "CurrentCodeVersion": {
+ "type": "string",
+ "description": "The current code version of the cluster."
+ },
+ "CurrentManifestVersion": {
+ "type": "string",
+ "description": "The current manifest version of the cluster."
+ },
+ "TargetCodeVersion": {
+ "type": "string",
+ "description": "The target code version of the cluster."
+ },
+ "TargetManifestVersion": {
+ "type": "string",
+ "description": "The target manifest version of the cluster."
+ },
+ "PendingUpgradeType": {
+ "type": "string",
+ "description": "The type of the pending upgrade of the cluster."
+ }
+ }
+ },
+ "ApplicationTypeImageStorePath": {
+ "description": "Path description for the application package in the image store specified during the prior copy operation.",
+ "required": [
+ "ApplicationTypeBuildPath"
+ ],
+ "properties": {
+ "ApplicationTypeBuildPath": {
+ "type": "string",
+ "description": "The relative image store path to the application package."
+ }
+ }
+ },
+ "UnprovisionApplicationTypeDescriptionInfo": {
+ "description": "Describes the operation to unregister or unprovision an application type and its version that was registered with the Service Fabric.",
+ "required": [
+ "ApplicationTypeVersion"
+ ],
+ "properties": {
+ "ApplicationTypeVersion": {
+ "$ref": "#/definitions/ApplicationTypeVersion",
+ "description": "The version of the application type as defined in the application manifest."
+ },
+ "Async": {
+ "type": "boolean",
+ "description": "The flag indicating whether or not unprovision should occur asynchronously. When set to true, the unprovision operation returns when the request is accepted by the system, and the unprovision operation continues without any timeout limit. The default value is false. However, we recommend setting it to true for large application packages that were provisioned."
+ }
+ }
+ },
+ "CodePackageName": {
+ "type": "string",
+ "description": "The name of the code package defined in the service manifest."
+ },
+ "CodePackageEntryPointStatistics": {
+ "description": "Statistics about setup or main entry point of a code package deployed on a Service Fabric node.",
+ "properties": {
+ "LastExitCode": {
+ "type": "string",
+ "description": "The last exit code of the entry point."
+ },
+ "LastActivationTime": {
+ "type": "string",
+ "format": "date-time",
+ "description": "The last time (in UTC) when Service Fabric attempted to run the entry point."
+ },
+ "LastExitTime": {
+ "type": "string",
+ "format": "date-time",
+ "description": "The last time (in UTC) when the entry point finished running."
+ },
+ "LastSuccessfulActivationTime": {
+ "type": "string",
+ "format": "date-time",
+ "description": "The last time (in UTC) when the entry point ran successfully."
+ },
+ "LastSuccessfulExitTime": {
+ "type": "string",
+ "format": "date-time",
+ "description": "The last time (in UTC) when the entry point finished running gracefully."
+ },
+ "ActivationCount": {
+ "type": "string",
+ "description": "Number of times the entry point has run."
+ },
+ "ActivationFailureCount": {
+ "type": "string",
+ "description": "Number of times the entry point failed to run."
+ },
+ "ContinuousActivationFailureCount": {
+ "type": "string",
+ "description": "Number of times the entry point continuously failed to run."
+ },
+ "ExitCount": {
+ "type": "string",
+ "description": "Number of times the entry point finished running."
+ },
+ "ExitFailureCount": {
+ "type": "string",
+ "description": "Number of times the entry point failed to exit gracefully."
+ },
+ "ContinuousExitFailureCount": {
+ "type": "string",
+ "description": "Number of times the entry point continuously failed to exit gracefully."
+ }
+ }
+ },
+ "DeployedCodePackageInfoList": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/DeployedCodePackageInfo"
+ },
+ "description": "List of deployed code package information."
+ },
+ "DeployedCodePackageInfo": {
+ "description": "Information about code package deployed on a Service Fabric node.",
+ "properties": {
+ "Name": {
+ "$ref": "#/definitions/CodePackageName",
+ "description": "The name of the code package."
+ },
+ "Version": {
+ "type": "string",
+ "description": "The version of the code package specified in service manifest."
+ },
+ "ServiceManifestName": {
+ "$ref": "#/definitions/ServiceManifestName",
+ "description": "The name of service manifest that specified this code package."
+ },
+ "ServicePackageActivationId": {
+ "$ref": "#/definitions/ServicePackageActivationId",
+ "description": "The ActivationId of a deployed service package. If ServicePackageActivationMode specified at the time of creating the service\nis 'SharedProcess' (or if it is not specified, in which case it defaults to 'SharedProcess'), then value of ServicePackageActivationId\nis always an empty string."
+ },
+ "HostType": {
+ "$ref": "#/definitions/HostType",
+ "description": "Specifies the type of host for main entry point of a code package as specified in service manifest."
+ },
+ "HostIsolationMode": {
+ "$ref": "#/definitions/HostIsolationMode",
+ "description": "Specifies the isolation mode of main entry point of a code package when it's host type is ContainerHost. This is specified as part of container host policies in application manifest while importing service manifest."
+ },
+ "Status": {
+ "$ref": "#/definitions/DeploymentStatus",
+ "description": "Specifies the status of a deployed application or service package on a Service Fabric node."
+ },
+ "RunFrequencyInterval": {
+ "type": "string",
+ "description": "The interval at which code package is run. This is used for periodic code package."
+ },
+ "SetupEntryPoint": {
+ "$ref": "#/definitions/CodePackageEntryPoint",
+ "description": "Information about setup or main entry point of a code package deployed on a Service Fabric node."
+ },
+ "MainEntryPoint": {
+ "$ref": "#/definitions/CodePackageEntryPoint",
+ "description": "Information about setup or main entry point of a code package deployed on a Service Fabric node."
+ }
+ }
+ },
+ "DeploymentStatus": {
+ "type": "string",
+ "description": "Specifies the status of a deployed application or service package on a Service Fabric node.",
+ "enum": [
+ "Invalid",
+ "Downloading",
+ "Activating",
+ "Active",
+ "Upgrading",
+ "Deactivating",
+ "RanToCompletion",
+ "Failed"
+ ],
+ "x-ms-enum": {
+ "name": "DeploymentStatus",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "Invalid",
+ "description": "Indicates status of the application or service package is not known or invalid. The value is 0."
+ },
+ {
+ "value": "Downloading",
+ "description": "Indicates the application or service package is being downloaded to the node from the ImageStore. The value is 1."
+ },
+ {
+ "value": "Activating",
+ "description": "Indicates the application or service package is being activated. The value is 2."
+ },
+ {
+ "value": "Active",
+ "description": "Indicates the application or service package is active the node. The value is 3."
+ },
+ {
+ "value": "Upgrading",
+ "description": "Indicates the application or service package is being upgraded. The value is 4."
+ },
+ {
+ "value": "Deactivating",
+ "description": "Indicates the application or service package is being deactivated. The value is 5."
+ },
+ {
+ "value": "RanToCompletion",
+ "description": "Indicates the application or service package has ran to completion successfully. The value is 6."
+ },
+ {
+ "value": "Failed",
+ "description": "Indicates the application or service package has failed to run to completion. The value is 7."
+ }
+ ]
+ }
+ },
+ "EntryPointStatus": {
+ "type": "string",
+ "description": "Specifies the status of the code package entry point deployed on a Service Fabric node.",
+ "enum": [
+ "Invalid",
+ "Pending",
+ "Starting",
+ "Started",
+ "Stopping",
+ "Stopped"
+ ],
+ "x-ms-enum": {
+ "name": "EntryPointStatus",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "Invalid",
+ "description": "Indicates status of entry point is not known or invalid. The value is 0."
+ },
+ {
+ "value": "Pending",
+ "description": "Indicates the entry point is scheduled to be started. The value is 1."
+ },
+ {
+ "value": "Starting",
+ "description": "Indicates the entry point is being started. The value is 2."
+ },
+ {
+ "value": "Started",
+ "description": "Indicates the entry point was started successfully and is running. The value is 3."
+ },
+ {
+ "value": "Stopping",
+ "description": "Indicates the entry point is being stopped. The value is 4."
+ },
+ {
+ "value": "Stopped",
+ "description": "Indicates the entry point is not running. The value is 5."
+ }
+ ]
+ }
+ },
+ "CodePackageEntryPoint": {
+ "description": "Information about setup or main entry point of a code package deployed on a Service Fabric node.",
+ "properties": {
+ "EntryPointLocation": {
+ "type": "string",
+ "description": "The location of entry point executable on the node."
+ },
+ "ProcessId": {
+ "type": "string",
+ "description": "The process ID of the entry point."
+ },
+ "RunAsUserName": {
+ "type": "string",
+ "description": "The user name under which entry point executable is run on the node."
+ },
+ "CodePackageEntryPointStatistics": {
+ "$ref": "#/definitions/CodePackageEntryPointStatistics",
+ "description": "Statistics about setup or main entry point of a code package deployed on a Service Fabric node."
+ },
+ "Status": {
+ "$ref": "#/definitions/EntryPointStatus",
+ "description": "Specifies the status of the code package entry point deployed on a Service Fabric node."
+ },
+ "NextActivationTime": {
+ "type": "string",
+ "format": "date-time",
+ "description": "The time (in UTC) when the entry point executable will be run next."
+ },
+ "InstanceId": {
+ "$ref": "#/definitions/CodePackageInstanceId",
+ "description": "The instance ID for current running entry point. For a code package setup entry point (if specified) runs first and after it finishes main entry point is started. Each time entry point executable is run, its instance id will change."
+ }
+ }
+ },
+ "Chaos": {
+ "description": "Contains a description of Chaos.",
+ "properties": {
+ "ChaosParameters": {
+ "$ref": "#/definitions/ChaosParameters",
+ "description": "If Chaos is running, these are the parameters Chaos is running with."
+ },
+ "Status": {
+ "$ref": "#/definitions/ChaosStatus",
+ "description": "Current status of the Chaos run."
+ },
+ "ScheduleStatus": {
+ "$ref": "#/definitions/ChaosScheduleStatus",
+ "description": "Current status of the schedule."
+ }
+ }
+ },
+ "ChaosStatus": {
+ "type": "string",
+ "description": "Current status of the Chaos run.",
+ "enum": [
+ "Invalid",
+ "Running",
+ "Stopped"
+ ],
+ "x-ms-enum": {
+ "name": "ChaosStatus",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "Invalid",
+ "description": "Indicates an invalid Chaos status. All Service Fabric enumerations have the invalid type. The value is zero."
+ },
+ {
+ "value": "Running",
+ "description": "Indicates that Chaos is not stopped. The value is one."
+ },
+ {
+ "value": "Stopped",
+ "description": "Indicates that Chaos is not scheduling further faults. The value is two."
+ }
+ ]
+ }
+ },
+ "ChaosScheduleStatus": {
+ "type": "string",
+ "description": "Current status of the schedule.",
+ "enum": [
+ "Invalid",
+ "Stopped",
+ "Active",
+ "Expired",
+ "Pending"
+ ],
+ "x-ms-enum": {
+ "name": "ChaosScheduleStatus",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "Invalid",
+ "description": "Indicates an invalid Chaos Schedule status. All Service Fabric enumerations have the invalid type. The value is zero."
+ },
+ {
+ "value": "Stopped",
+ "description": "Indicates that the schedule is stopped and not being used to schedule runs of chaos. The value is one."
+ },
+ {
+ "value": "Active",
+ "description": "Indicates that the schedule is active and is being used to schedule runs of Chaos. The value is two."
+ },
+ {
+ "value": "Expired",
+ "description": "Indicates that the schedule is expired and will no longer be used to schedule runs of Chaos. The value is three."
+ },
+ {
+ "value": "Pending",
+ "description": "Indicates that the schedule is pending and is not yet being used to schedule runs of Chaos but will be used when the start time is passed. The value is four."
+ }
+ ]
+ }
+ },
+ "ChaosContextMap": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Describes a map that contains a collection of ChaosContextMapItem's."
+ },
+ "ChaosContext": {
+ "description": "Describes a map, which is a collection of (string, string) type key-value pairs. The map can be used to record information about\nthe Chaos run. There cannot be more than 100 such pairs and each string (key or value) can be at most 4095 characters long.\nThis map is set by the starter of the Chaos run to optionally store the context about the specific run.",
+ "properties": {
+ "Map": {
+ "$ref": "#/definitions/ChaosContextMap",
+ "description": "Describes a map that contains a collection of ChaosContextMapItem's."
+ }
+ }
+ },
+ "ChaosParameters": {
+ "description": "Defines all the parameters to configure a Chaos run.",
+ "properties": {
+ "TimeToRunInSeconds": {
+ "type": "string",
+ "description": "Total time (in seconds) for which Chaos will run before automatically stopping. The maximum allowed value is 4,294,967,295 (System.UInt32.MaxValue).",
+ "default": "4294967295"
+ },
+ "MaxClusterStabilizationTimeoutInSeconds": {
+ "type": "integer",
+ "format": "int64",
+ "description": "The maximum amount of time to wait for all cluster entities to become stable and healthy. Chaos executes in iterations and at the start of each iteration it validates the health of cluster entities.\nDuring validation if a cluster entity is not stable and healthy within MaxClusterStabilizationTimeoutInSeconds, Chaos generates a validation failed event.",
+ "default": 60,
+ "minimum": 0,
+ "maximum": 4294967295
+ },
+ "MaxConcurrentFaults": {
+ "type": "integer",
+ "format": "int64",
+ "description": "MaxConcurrentFaults is the maximum number of concurrent faults induced per iteration.\nChaos executes in iterations and two consecutive iterations are separated by a validation phase.\nThe higher the concurrency, the more aggressive the injection of faults, leading to inducing more complex series of states to uncover bugs.\nThe recommendation is to start with a value of 2 or 3 and to exercise caution while moving up.",
+ "default": 1,
+ "minimum": 0,
+ "maximum": 4294967295
+ },
+ "EnableMoveReplicaFaults": {
+ "type": "boolean",
+ "description": "Enables or disables the move primary and move secondary faults.",
+ "default": true
+ },
+ "WaitTimeBetweenFaultsInSeconds": {
+ "type": "integer",
+ "format": "int64",
+ "description": "Wait time (in seconds) between consecutive faults within a single iteration.\nThe larger the value, the lower the overlapping between faults and the simpler the sequence of state transitions that the cluster goes through.\nThe recommendation is to start with a value between 1 and 5 and exercise caution while moving up.",
+ "default": 20,
+ "minimum": 0,
+ "maximum": 4294967295
+ },
+ "WaitTimeBetweenIterationsInSeconds": {
+ "type": "integer",
+ "format": "int64",
+ "description": "Time-separation (in seconds) between two consecutive iterations of Chaos.\nThe larger the value, the lower the fault injection rate.",
+ "default": 30,
+ "minimum": 0,
+ "maximum": 4294967295
+ },
+ "ClusterHealthPolicy": {
+ "$ref": "#/definitions/ClusterHealthPolicy",
+ "description": "Passed-in cluster health policy is used to validate health of the cluster in between Chaos iterations. If the cluster health is in error or if an unexpected exception happens during fault execution--to provide the cluster with some time to recuperate--Chaos will wait for 30 minutes before the next health-check."
+ },
+ "Context": {
+ "$ref": "#/definitions/ChaosContext",
+ "description": "Describes a map, which is a collection of (string, string) type key-value pairs. The map can be used to record information about\nthe Chaos run. There cannot be more than 100 such pairs and each string (key or value) can be at most 4095 characters long.\nThis map is set by the starter of the Chaos run to optionally store the context about the specific run."
+ },
+ "ChaosTargetFilter": {
+ "$ref": "#/definitions/ChaosTargetFilter",
+ "description": "List of cluster entities to target for Chaos faults.\nThis filter can be used to target Chaos faults only to certain node types or only to certain application instances. If ChaosTargetFilter is not used, Chaos faults all cluster entities.\nIf ChaosTargetFilter is used, Chaos faults only the entities that meet the ChaosTargetFilter specification."
+ }
+ }
+ },
+ "ChaosParametersDictionaryItem": {
+ "description": "Defines an item in ChaosParametersDictionary of the Chaos Schedule.",
+ "required": [
+ "Key",
+ "Value"
+ ],
+ "properties": {
+ "Key": {
+ "type": "string",
+ "description": "The key identifying the Chaos Parameter in the dictionary. This key is referenced by Chaos Schedule Jobs."
+ },
+ "Value": {
+ "$ref": "#/definitions/ChaosParameters",
+ "description": "Defines all the parameters to configure a Chaos run."
+ }
+ }
+ },
+ "ChaosEvent": {
+ "discriminator": "Kind",
+ "description": "Represents an event generated during a Chaos run.",
+ "properties": {
+ "Kind": {
+ "$ref": "#/definitions/ChaosEventKind",
+ "description": "The kind of Chaos event."
+ },
+ "TimeStampUtc": {
+ "type": "string",
+ "description": "The UTC timestamp when this Chaos event was generated.",
+ "format": "date-time"
+ }
+ },
+ "required": [
+ "Kind",
+ "TimeStampUtc"
+ ]
+ },
+ "ChaosEventWrapper": {
+ "description": "Wrapper object for Chaos event.",
+ "properties": {
+ "ChaosEvent": {
+ "$ref": "#/definitions/ChaosEvent",
+ "description": "Represents an event generated during a Chaos run."
+ }
+ }
+ },
+ "ChaosEventKind": {
+ "type": "string",
+ "description": "The kind of Chaos event.",
+ "enum": [
+ "Invalid",
+ "Started",
+ "ExecutingFaults",
+ "Waiting",
+ "ValidationFailed",
+ "TestError",
+ "Stopped"
+ ],
+ "x-ms-enum": {
+ "name": "ChaosEventKind",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "Invalid",
+ "description": "Indicates an invalid Chaos event kind. All Service Fabric enumerations have the invalid type."
+ },
+ {
+ "value": "Started",
+ "description": "Indicates a Chaos event that gets generated when Chaos is started."
+ },
+ {
+ "value": "ExecutingFaults",
+ "description": "Indicates a Chaos event that gets generated when Chaos has decided on the faults for an iteration. This Chaos event contains the details of the faults as a list of strings."
+ },
+ {
+ "value": "Waiting",
+ "description": "Indicates a Chaos event that gets generated when Chaos is waiting for the cluster to become ready for faulting, for example, Chaos may be waiting for the on-going upgrade to finish."
+ },
+ {
+ "value": "ValidationFailed",
+ "description": "Indicates a Chaos event that gets generated when the cluster entities do not become stable and healthy within ChaosParameters.MaxClusterStabilizationTimeoutInSeconds."
+ },
+ {
+ "value": "TestError",
+ "description": "Indicates a Chaos event that gets generated when an unexpected event has occurred in the Chaos engine, for example, due to the cluster snapshot being inconsistent, while faulting a faultable entity Chaos found that the entity was already faulted."
+ },
+ {
+ "value": "Stopped",
+ "description": "Indicates a Chaos event that gets generated when Chaos stops because either the user issued a stop or the time to run was up."
+ }
+ ]
+ }
+ },
+ "ChaosEventsSegment": {
+ "description": "Contains the list of Chaos events and the continuation token to get the next segment.",
+ "properties": {
+ "ContinuationToken": {
+ "$ref": "#/definitions/ContinuationToken",
+ "description": "The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token is not included in the response."
+ },
+ "History": {
+ "$ref": "#/definitions/ChaosEventHistory",
+ "description": "List of Chaos events that meet the user-supplied criteria."
+ }
+ }
+ },
+ "ChaosScheduleDescription": {
+ "description": "Defines the Chaos Schedule used by Chaos and the version of the Chaos Schedule. The version value wraps back to 0 after surpassing 2,147,483,647.",
+ "properties": {
+ "Version": {
+ "description": "The version number of the Schedule.",
+ "type": "integer",
+ "format": "int32",
+ "minimum": 0
+ },
+ "Schedule": {
+ "$ref": "#/definitions/ChaosSchedule",
+ "description": "Defines the schedule used by Chaos."
+ }
+ }
+ },
+ "ChaosSchedule": {
+ "description": "Defines the schedule used by Chaos.",
+ "properties": {
+ "StartDate": {
+ "type": "string",
+ "format": "date-time",
+ "description": "The date and time Chaos will start using this schedule.",
+ "default": "1601-01-01T00:00:00Z"
+ },
+ "ExpiryDate": {
+ "type": "string",
+ "format": "date-time",
+ "description": "The date and time Chaos will continue to use this schedule until.",
+ "default": "9999-12-31T23:59:59.999Z"
+ },
+ "ChaosParametersDictionary": {
+ "type": "array",
+ "description": "A mapping of string names to Chaos Parameters to be referenced by Chaos Schedule Jobs.",
+ "items": {
+ "$ref": "#/definitions/ChaosParametersDictionaryItem"
+ }
+ },
+ "Jobs": {
+ "description": "A list of all Chaos Schedule Jobs that will be automated by the schedule.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ChaosScheduleJob"
+ }
+ }
+ }
+ },
+ "ChaosScheduleJob": {
+ "description": "Defines a repetition rule and parameters of Chaos to be used with the Chaos Schedule.",
+ "properties": {
+ "ChaosParameters": {
+ "type": "string",
+ "description": "A reference to which Chaos Parameters of the Chaos Schedule to use."
+ },
+ "Days": {
+ "$ref": "#/definitions/ChaosScheduleJobActiveDaysOfWeek",
+ "description": "Defines the days of the week that a Chaos Schedule Job will run for."
+ },
+ "Times": {
+ "description": "A list of Time Ranges that specify when during active days that this job will run. The times are interpreted as UTC.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/TimeRange"
+ }
+ }
+ }
+ },
+ "ChaosScheduleJobActiveDaysOfWeek": {
+ "description": "Defines the days of the week that a Chaos Schedule Job will run for.",
+ "properties": {
+ "Sunday": {
+ "type": "boolean",
+ "description": "Indicates if the Chaos Schedule Job will run on Sunday",
+ "default": false
+ },
+ "Monday": {
+ "type": "boolean",
+ "description": "Indicates if the Chaos Schedule Job will run on Monday",
+ "default": false
+ },
+ "Tuesday": {
+ "type": "boolean",
+ "description": "Indicates if the Chaos Schedule Job will run on Tuesday",
+ "default": false
+ },
+ "Wednesday": {
+ "type": "boolean",
+ "description": "Indicates if the Chaos Schedule Job will run on Wednesday",
+ "default": false
+ },
+ "Thursday": {
+ "type": "boolean",
+ "description": "Indicates if the Chaos Schedule Job will run on Thursday",
+ "default": false
+ },
+ "Friday": {
+ "type": "boolean",
+ "description": "Indicates if the Chaos Schedule Job will run on Friday",
+ "default": false
+ },
+ "Saturday": {
+ "type": "boolean",
+ "description": "Indicates if the Chaos Schedule Job will run on Saturday",
+ "default": false
+ }
+ }
+ },
+ "TimeRange": {
+ "description": "Defines a time range in a 24 hour day specified by a start and end time.",
+ "properties": {
+ "StartTime": {
+ "$ref": "#/definitions/TimeOfDay",
+ "description": "Defines an hour and minute of the day specified in 24 hour time."
+ },
+ "EndTime": {
+ "$ref": "#/definitions/TimeOfDay",
+ "description": "Defines an hour and minute of the day specified in 24 hour time."
+ }
+ }
+ },
+ "TimeOfDay": {
+ "description": "Defines an hour and minute of the day specified in 24 hour time.",
+ "properties": {
+ "Hour": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Represents the hour of the day. Value must be between 0 and 23 inclusive.",
+ "minimum": 0,
+ "maximum": 23
+ },
+ "Minute": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Represents the minute of the hour. Value must be between 0 to 59 inclusive.",
+ "minimum": 0,
+ "maximum": 59
+ }
+ }
+ },
+ "ExecutingFaultsChaosEvent": {
+ "description": "Describes a Chaos event that gets generated when Chaos has decided on the faults for an iteration. This Chaos event contains the details of the faults as a list of strings.",
+ "x-ms-discriminator-value": "ExecutingFaults",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ChaosEvent"
+ }
+ ],
+ "properties": {
+ "Faults": {
+ "type": "array",
+ "description": "List of string description of the faults that Chaos decided to execute in an iteration.",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "StartedChaosEvent": {
+ "description": "Describes a Chaos event that gets generated when Chaos is started.",
+ "x-ms-discriminator-value": "Started",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ChaosEvent"
+ }
+ ],
+ "properties": {
+ "ChaosParameters": {
+ "$ref": "#/definitions/ChaosParameters",
+ "description": "Defines all the parameters to configure a Chaos run."
+ }
+ }
+ },
+ "StoppedChaosEvent": {
+ "description": "Describes a Chaos event that gets generated when Chaos stops because either the user issued a stop or the time to run was up.",
+ "x-ms-discriminator-value": "Stopped",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ChaosEvent"
+ }
+ ],
+ "properties": {
+ "Reason": {
+ "type": "string",
+ "description": "Describes why Chaos stopped. Chaos can stop because of StopChaos API call or the timeToRun provided in ChaosParameters is over."
+ }
+ }
+ },
+ "TestErrorChaosEvent": {
+ "description": "Describes a Chaos event that gets generated when an unexpected event occurs in the Chaos engine.\nFor example, due to the cluster snapshot being inconsistent, while faulting an entity, Chaos found that the entity was already faulted -- which would be an unexpected event.",
+ "x-ms-discriminator-value": "TestError",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ChaosEvent"
+ }
+ ],
+ "properties": {
+ "Reason": {
+ "type": "string",
+ "description": "Describes why TestErrorChaosEvent was generated. For example, Chaos tries to fault a partition but finds that the partition is no longer fault tolerant, then a TestErrorEvent gets generated with the reason stating that the partition is not fault tolerant."
+ }
+ }
+ },
+ "ValidationFailedChaosEvent": {
+ "description": "Chaos event corresponding to a failure during validation.",
+ "x-ms-discriminator-value": "ValidationFailed",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ChaosEvent"
+ }
+ ],
+ "properties": {
+ "Reason": {
+ "type": "string",
+ "description": "Describes why the ValidationFailedChaosEvent was generated. This may happen because more than MaxPercentUnhealthyNodes are unhealthy for more than MaxClusterStabilizationTimeout. This reason will be in the Reason property of the ValidationFailedChaosEvent as a string."
+ }
+ }
+ },
+ "WaitingChaosEvent": {
+ "description": "Describes a Chaos event that gets generated when Chaos is waiting for the cluster to become ready for faulting, for example, Chaos may be waiting for the on-going upgrade to finish.",
+ "x-ms-discriminator-value": "Waiting",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ChaosEvent"
+ }
+ ],
+ "properties": {
+ "Reason": {
+ "type": "string",
+ "description": "Describes why the WaitingChaosEvent was generated, for example, due to a cluster upgrade."
+ }
+ }
+ },
+ "ChaosEventHistory": {
+ "type": "array",
+ "description": "An list of Chaos events that were generated during the time range passed into the GetChaosReport API call.",
+ "items": {
+ "$ref": "#/definitions/ChaosEventWrapper"
+ }
+ },
+ "ChaosTargetFilter": {
+ "description": "Defines all filters for targeted Chaos faults, for example, faulting only certain node types or faulting only certain applications.\nIf ChaosTargetFilter is not used, Chaos faults all cluster entities. If ChaosTargetFilter is used, Chaos faults only the entities that meet the ChaosTargetFilter\nspecification. NodeTypeInclusionList and ApplicationInclusionList allow a union semantics only. It is not possible to specify an intersection\nof NodeTypeInclusionList and ApplicationInclusionList. For example, it is not possible to specify \"fault this application only when it is on that node type.\"\nOnce an entity is included in either NodeTypeInclusionList or ApplicationInclusionList, that entity cannot be excluded using ChaosTargetFilter. Even if\napplicationX does not appear in ApplicationInclusionList, in some Chaos iteration applicationX can be faulted because it happens to be on a node of nodeTypeY that is included\nin NodeTypeInclusionList. If both NodeTypeInclusionList and ApplicationInclusionList are null or empty, an ArgumentException is thrown.",
+ "properties": {
+ "NodeTypeInclusionList": {
+ "type": "array",
+ "description": "A list of node types to include in Chaos faults.\nAll types of faults (restart node, restart code package, remove replica, restart replica, move primary, and move secondary) are enabled for the nodes of these node types.\nIf a node type (say NodeTypeX) does not appear in the NodeTypeInclusionList, then node level faults (like NodeRestart) will never be enabled for the nodes of\nNodeTypeX, but code package and replica faults can still be enabled for NodeTypeX if an application in the ApplicationInclusionList.\nhappens to reside on a node of NodeTypeX.\nAt most 100 node type names can be included in this list, to increase this number, a config upgrade is required for MaxNumberOfNodeTypesInChaosEntityFilter configuration.",
+ "items": {
+ "$ref": "#/definitions/NodeType"
+ }
+ },
+ "ApplicationInclusionList": {
+ "type": "array",
+ "description": "A list of application URIs to include in Chaos faults.\nAll replicas belonging to services of these applications are amenable to replica faults (restart replica, remove replica, move primary, and move secondary) by Chaos.\nChaos may restart a code package only if the code package hosts replicas of these applications only.\nIf an application does not appear in this list, it can still be faulted in some Chaos iteration if the application ends up on a node of a node type that is included in NodeTypeInclusionList.\nHowever, if applicationX is tied to nodeTypeY through placement constraints and applicationX is absent from ApplicationInclusionList and nodeTypeY is absent from NodeTypeInclusionList, then applicationX will never be faulted.\nAt most 1000 application names can be included in this list, to increase this number, a config upgrade is required for MaxNumberOfApplicationsInChaosEntityFilter configuration.",
+ "items": {
+ "$ref": "#/definitions/ApplicationName"
+ }
+ }
+ }
+ },
+ "ApplicationTypeVersion": {
+ "type": "string",
+ "description": "The version of the application type as defined in the application manifest."
+ },
+ "ApplicationCapacityDescription": {
+ "description": "Describes capacity information for services of this application. This description can be used for describing the following.\n- Reserving the capacity for the services on the nodes\n- Limiting the total number of nodes that services of this application can run on\n- Limiting the custom capacity metrics to limit the total consumption of this metric by the services of this application",
+ "properties": {
+ "MinimumNodes": {
+ "type": "integer",
+ "format": "int64",
+ "description": "The minimum number of nodes where Service Fabric will reserve capacity for this application. Note that this does not mean that the services of this application will be placed on all of those nodes. If this property is set to zero, no capacity will be reserved. The value of this property cannot be more than the value of the MaximumNodes property.",
+ "minimum": 0
+ },
+ "MaximumNodes": {
+ "type": "integer",
+ "format": "int64",
+ "description": "The maximum number of nodes where Service Fabric will reserve capacity for this application. Note that this does not mean that the services of this application will be placed on all of those nodes. By default, the value of this property is zero and it means that the services can be placed on any node.",
+ "minimum": 0,
+ "default": 0
+ },
+ "ApplicationMetrics": {
+ "$ref": "#/definitions/ApplicationMetricDescriptionList",
+ "description": "List of application capacity metric description."
+ }
+ }
+ },
+ "ApplicationDescription": {
+ "description": "Describes a Service Fabric application.",
+ "properties": {
+ "Name": {
+ "$ref": "#/definitions/ApplicationName",
+ "description": "The name of the application, including the 'fabric:' URI scheme."
+ },
+ "TypeName": {
+ "$ref": "#/definitions/ApplicationTypeName",
+ "description": "The application type name as defined in the application manifest."
+ },
+ "TypeVersion": {
+ "$ref": "#/definitions/ApplicationTypeVersion",
+ "description": "The version of the application type as defined in the application manifest."
+ },
+ "ParameterList": {
+ "$ref": "#/definitions/ApplicationParameterList",
+ "description": "List of application parameters with overridden values from their default values specified in the application manifest."
+ },
+ "ApplicationCapacity": {
+ "$ref": "#/definitions/ApplicationCapacityDescription",
+ "description": "Describes capacity information for services of this application. This description can be used for describing the following.\n- Reserving the capacity for the services on the nodes\n- Limiting the total number of nodes that services of this application can run on\n- Limiting the custom capacity metrics to limit the total consumption of this metric by the services of this application"
+ },
+ "ManagedApplicationIdentity": {
+ "$ref": "#/definitions/ManagedApplicationIdentityDescription",
+ "description": "Managed application identity description."
+ }
+ },
+ "required": [
+ "Name",
+ "TypeName",
+ "TypeVersion"
+ ]
+ },
+ "ApplicationMetricDescription": {
+ "description": "Describes capacity information for a custom resource balancing metric. This can be used to limit the total consumption of this metric by the services of this application.",
+ "properties": {
+ "Name": {
+ "type": "string",
+ "description": "The name of the metric."
+ },
+ "MaximumCapacity": {
+ "type": "integer",
+ "format": "int64",
+ "description": "The maximum node capacity for Service Fabric application.\nThis is the maximum Load for an instance of this application on a single node. Even if the capacity of node is greater than this value, Service Fabric will limit the total load of services within the application on each node to this value.\nIf set to zero, capacity for this metric is unlimited on each node.\nWhen creating a new application with application capacity defined, the product of MaximumNodes and this value must always be smaller than or equal to TotalApplicationCapacity.\nWhen updating existing application with application capacity, the product of MaximumNodes and this value must always be smaller than or equal to TotalApplicationCapacity."
+ },
+ "ReservationCapacity": {
+ "type": "integer",
+ "format": "int64",
+ "description": "The node reservation capacity for Service Fabric application.\nThis is the amount of load which is reserved on nodes which have instances of this application.\nIf MinimumNodes is specified, then the product of these values will be the capacity reserved in the cluster for the application.\nIf set to zero, no capacity is reserved for this metric.\nWhen setting application capacity or when updating application capacity; this value must be smaller than or equal to MaximumCapacity for each metric."
+ },
+ "TotalApplicationCapacity": {
+ "description": "The total metric capacity for Service Fabric application.\nThis is the total metric capacity for this application in the cluster. Service Fabric will try to limit the sum of loads of services within the application to this value.\nWhen creating a new application with application capacity defined, the product of MaximumNodes and MaximumCapacity must always be smaller than or equal to this value.",
+ "type": "integer",
+ "format": "int64"
+ }
+ }
+ },
+ "ApplicationMetricDescriptionList": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ApplicationMetricDescription"
+ },
+ "description": "List of application capacity metric description."
+ },
+ "ApplicationLoadMetricInformation": {
+ "description": "Describes load information for a custom resource balancing metric. This can be used to limit the total consumption of this metric by the services of this application.",
+ "properties": {
+ "Name": {
+ "type": "string",
+ "description": "The name of the metric."
+ },
+ "ReservationCapacity": {
+ "type": "integer",
+ "format": "int64",
+ "description": "This is the capacity reserved in the cluster for the application.\nIt's the product of NodeReservationCapacity and MinimumNodes.\nIf set to zero, no capacity is reserved for this metric.\nWhen setting application capacity or when updating application capacity this value must be smaller than or equal to MaximumCapacity for each metric."
+ },
+ "ApplicationCapacity": {
+ "type": "integer",
+ "format": "int64",
+ "description": "Total capacity for this metric in this application instance."
+ },
+ "ApplicationLoad": {
+ "type": "integer",
+ "format": "int64",
+ "description": "Current load for this metric in this application instance."
+ }
+ }
+ },
+ "ApplicationLoadMetricInformationList": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ApplicationLoadMetricInformation"
+ },
+ "description": "List of application load metric information."
+ },
+ "ComposeDeploymentStatus": {
+ "type": "string",
+ "description": "The status of the compose deployment.",
+ "enum": [
+ "Invalid",
+ "Provisioning",
+ "Creating",
+ "Ready",
+ "Unprovisioning",
+ "Deleting",
+ "Failed",
+ "Upgrading"
+ ],
+ "x-ms-enum": {
+ "name": "ComposeDeploymentStatus",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "Invalid",
+ "description": "Indicates that the compose deployment status is invalid. The value is zero."
+ },
+ {
+ "value": "Provisioning",
+ "description": "Indicates that the compose deployment is being provisioned in background. The value is 1."
+ },
+ {
+ "value": "Creating",
+ "description": "Indicates that the compose deployment is being created in background. The value is 2."
+ },
+ {
+ "value": "Ready",
+ "description": "Indicates that the compose deployment has been successfully created or upgraded. The value is 3."
+ },
+ {
+ "value": "Unprovisioning",
+ "description": "Indicates that the compose deployment is being unprovisioned in background. The value is 4."
+ },
+ {
+ "value": "Deleting",
+ "description": "Indicates that the compose deployment is being deleted in background. The value is 5."
+ },
+ {
+ "value": "Failed",
+ "description": "Indicates that the compose deployment was terminated due to persistent failures. The value is 6."
+ },
+ {
+ "value": "Upgrading",
+ "description": "Indicates that the compose deployment is being upgraded in the background. The value is 7."
+ }
+ ]
+ }
+ },
+ "ComposeDeploymentStatusInfo": {
+ "description": "Information about a Service Fabric compose deployment.",
+ "properties": {
+ "Name": {
+ "$ref": "#/definitions/DeploymentName",
+ "description": "The name of the deployment."
+ },
+ "ApplicationName": {
+ "$ref": "#/definitions/ApplicationName",
+ "description": "The name of the application, including the 'fabric:' URI scheme."
+ },
+ "Status": {
+ "$ref": "#/definitions/ComposeDeploymentStatus",
+ "description": "The status of the compose deployment."
+ },
+ "StatusDetails": {
+ "description": "The status details of compose deployment including failure message.",
+ "type": "string"
+ }
+ }
+ },
+ "ComposeDeploymentUpgradeDescription": {
+ "description": "Describes the parameters for a compose deployment upgrade.",
+ "properties": {
+ "DeploymentName": {
+ "$ref": "#/definitions/DeploymentName",
+ "description": "The name of the deployment."
+ },
+ "ComposeFileContent": {
+ "type": "string",
+ "description": "The content of the compose file that describes the deployment to create."
+ },
+ "RegistryCredential": {
+ "$ref": "#/definitions/RegistryCredential",
+ "description": "Credential information to connect to container registry."
+ },
+ "UpgradeKind": {
+ "$ref": "#/definitions/UpgradeKind",
+ "description": "The kind of upgrade out of the following possible values."
+ },
+ "RollingUpgradeMode": {
+ "$ref": "#/definitions/UpgradeMode",
+ "description": "The mode used to monitor health during a rolling upgrade. The values are UnmonitoredAuto, UnmonitoredManual, and Monitored."
+ },
+ "UpgradeReplicaSetCheckTimeoutInSeconds": {
+ "$ref": "#/definitions/UpgradeReplicaSetCheckTimeout",
+ "description": "The maximum amount of time to block processing of an upgrade domain and prevent loss of availability when there are unexpected issues. When this timeout expires, processing of the upgrade domain will proceed regardless of availability loss issues. The timeout is reset at the start of each upgrade domain. Valid values are between 0 and 42949672925 inclusive. (unsigned 32-bit integer)."
+ },
+ "ForceRestart": {
+ "$ref": "#/definitions/ForceRestart",
+ "description": "If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data)."
+ },
+ "MonitoringPolicy": {
+ "$ref": "#/definitions/MonitoringPolicyDescription",
+ "description": "Describes the parameters for monitoring an upgrade in Monitored mode."
+ },
+ "ApplicationHealthPolicy": {
+ "$ref": "#/definitions/ApplicationHealthPolicy",
+ "description": "Defines a health policy used to evaluate the health of an application or one of its children entities."
+ }
+ },
+ "required": [
+ "DeploymentName",
+ "ComposeFileContent",
+ "UpgradeKind"
+ ]
+ },
+ "ComposeDeploymentUpgradeProgressInfo": {
+ "description": "Describes the parameters for a compose deployment upgrade.",
+ "properties": {
+ "DeploymentName": {
+ "$ref": "#/definitions/TargetDeploymentName",
+ "description": "The name of the target deployment."
+ },
+ "ApplicationName": {
+ "$ref": "#/definitions/TargetApplicationName",
+ "description": "The name of the target application, including the 'fabric:' URI scheme."
+ },
+ "UpgradeState": {
+ "$ref": "#/definitions/ComposeDeploymentUpgradeState",
+ "description": "The state of the compose deployment upgrade."
+ },
+ "UpgradeStatusDetails": {
+ "type": "string",
+ "description": "Additional detailed information about the status of the pending upgrade."
+ },
+ "UpgradeKind": {
+ "$ref": "#/definitions/UpgradeKind",
+ "description": "The kind of upgrade out of the following possible values."
+ },
+ "RollingUpgradeMode": {
+ "$ref": "#/definitions/UpgradeMode",
+ "description": "The mode used to monitor health during a rolling upgrade. The values are UnmonitoredAuto, UnmonitoredManual, and Monitored."
+ },
+ "ForceRestart": {
+ "$ref": "#/definitions/ForceRestart",
+ "description": "If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data)."
+ },
+ "UpgradeReplicaSetCheckTimeoutInSeconds": {
+ "$ref": "#/definitions/UpgradeReplicaSetCheckTimeout",
+ "description": "The maximum amount of time to block processing of an upgrade domain and prevent loss of availability when there are unexpected issues. When this timeout expires, processing of the upgrade domain will proceed regardless of availability loss issues. The timeout is reset at the start of each upgrade domain. Valid values are between 0 and 42949672925 inclusive. (unsigned 32-bit integer)."
+ },
+ "MonitoringPolicy": {
+ "$ref": "#/definitions/MonitoringPolicyDescription",
+ "description": "Describes the parameters for monitoring an upgrade in Monitored mode."
+ },
+ "ApplicationHealthPolicy": {
+ "$ref": "#/definitions/ApplicationHealthPolicy",
+ "description": "Defines a health policy used to evaluate the health of an application or one of its children entities."
+ },
+ "TargetApplicationTypeVersion": {
+ "$ref": "#/definitions/TargetApplicationTypeVersion",
+ "description": "The target application type version (found in the application manifest) for the application upgrade."
+ },
+ "UpgradeDuration": {
+ "$ref": "#/definitions/UpgradeDuration",
+ "description": "The estimated amount of time that the overall upgrade elapsed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds."
+ },
+ "CurrentUpgradeDomainDuration": {
+ "$ref": "#/definitions/CurrentUpgradeDomainDuration",
+ "description": "The estimated amount of time spent processing current Upgrade Domain. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds."
+ },
+ "ApplicationUnhealthyEvaluations": {
+ "$ref": "#/definitions/ApplicationUnhealthyEvaluations",
+ "description": "List of health evaluations that resulted in the current aggregated health state."
+ },
+ "CurrentUpgradeDomainProgress": {
+ "$ref": "#/definitions/CurrentUpgradeDomainProgressInfo",
+ "description": "Information about the current in-progress upgrade domain."
+ },
+ "StartTimestampUtc": {
+ "type": "string",
+ "description": "The estimated UTC datetime when the upgrade started."
+ },
+ "FailureTimestampUtc": {
+ "type": "string",
+ "description": "The estimated UTC datetime when the upgrade failed and FailureAction was executed."
+ },
+ "FailureReason": {
+ "$ref": "#/definitions/FailureReason",
+ "description": "The cause of an upgrade failure that resulted in FailureAction being executed."
+ },
+ "UpgradeDomainProgressAtFailure": {
+ "$ref": "#/definitions/FailureUpgradeDomainProgressInfo",
+ "description": "Information about the upgrade domain progress at the time of upgrade failure."
+ },
+ "ApplicationUpgradeStatusDetails": {
+ "type": "string",
+ "description": "Additional details of application upgrade including failure message."
+ }
+ }
+ },
+ "ComposeDeploymentUpgradeState": {
+ "type": "string",
+ "description": "The state of the compose deployment upgrade.",
+ "enum": [
+ "Invalid",
+ "ProvisioningTarget",
+ "RollingForwardInProgress",
+ "RollingForwardPending",
+ "UnprovisioningCurrent",
+ "RollingForwardCompleted",
+ "RollingBackInProgress",
+ "UnprovisioningTarget",
+ "RollingBackCompleted",
+ "Failed"
+ ],
+ "x-ms-enum": {
+ "name": "ComposeDeploymentUpgradeState",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "Invalid",
+ "description": "Indicates the upgrade state is invalid. All Service Fabric enumerations have the invalid type. The value is zero."
+ },
+ {
+ "value": "ProvisioningTarget",
+ "description": "The upgrade is in the progress of provisioning target application type version. The value is 1."
+ },
+ {
+ "value": "RollingForwardInProgress",
+ "description": "The upgrade is rolling forward to the target version but is not complete yet. The value is 2."
+ },
+ {
+ "value": "RollingForwardPending",
+ "description": "The current upgrade domain has finished upgrading. The overall upgrade is waiting for an explicit move next request in UnmonitoredManual mode or performing health checks in Monitored mode. The value is 3"
+ },
+ {
+ "value": "UnprovisioningCurrent",
+ "description": "The upgrade is in the progress of unprovisioning current application type version and rolling forward to the target version is completed. The value is 4."
+ },
+ {
+ "value": "RollingForwardCompleted",
+ "description": "The upgrade has finished rolling forward. The value is 5."
+ },
+ {
+ "value": "RollingBackInProgress",
+ "description": "The upgrade is rolling back to the previous version but is not complete yet. The value is 6."
+ },
+ {
+ "value": "UnprovisioningTarget",
+ "description": "The upgrade is in the progress of unprovisioning target application type version and rolling back to the current version is completed. The value is 7."
+ },
+ {
+ "value": "RollingBackCompleted",
+ "description": "The upgrade has finished rolling back. The value is 8."
+ },
+ {
+ "value": "Failed",
+ "description": "The upgrade has failed and is unable to execute FailureAction. The value is 9."
+ }
+ ]
+ }
+ },
+ "PagedComposeDeploymentStatusInfoList": {
+ "description": "The list of compose deployments in the cluster. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.",
+ "properties": {
+ "ContinuationToken": {
+ "$ref": "#/definitions/ContinuationToken",
+ "description": "The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token is not included in the response."
+ },
+ "Items": {
+ "type": "array",
+ "description": "List of compose deployment status information.",
+ "items": {
+ "$ref": "#/definitions/ComposeDeploymentStatusInfo"
+ }
+ }
+ }
+ },
+ "CreateComposeDeploymentDescription": {
+ "description": "Defines description for creating a Service Fabric compose deployment.",
+ "properties": {
+ "DeploymentName": {
+ "$ref": "#/definitions/DeploymentName",
+ "description": "The name of the deployment."
+ },
+ "ComposeFileContent": {
+ "type": "string",
+ "description": "The content of the compose file that describes the deployment to create."
+ },
+ "RegistryCredential": {
+ "$ref": "#/definitions/RegistryCredential",
+ "description": "Credential information to connect to container registry."
+ }
+ },
+ "required": [
+ "DeploymentName",
+ "ComposeFileContent"
+ ]
+ },
+ "RegistryCredential": {
+ "description": "Credential information to connect to container registry.",
+ "properties": {
+ "RegistryUserName": {
+ "type": "string",
+ "description": "The user name to connect to container registry."
+ },
+ "RegistryPassword": {
+ "type": "string",
+ "description": "The password for supplied username to connect to container registry."
+ },
+ "PasswordEncrypted": {
+ "type": "boolean",
+ "description": "Indicates that supplied container registry password is encrypted."
+ }
+ }
+ },
+ "DeployedServicePackageInfoList": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/DeployedServicePackageInfo"
+ },
+ "description": "List of deployed service package information."
+ },
+ "DeployedServicePackageInfo": {
+ "description": "Information about service package deployed on a Service Fabric node.",
+ "properties": {
+ "Name": {
+ "$ref": "#/definitions/ServiceManifestName",
+ "description": "The name of the service package as specified in the service manifest."
+ },
+ "Version": {
+ "type": "string",
+ "description": "The version of the service package specified in service manifest."
+ },
+ "Status": {
+ "$ref": "#/definitions/DeploymentStatus",
+ "description": "Specifies the status of a deployed application or service package on a Service Fabric node."
+ },
+ "ServicePackageActivationId": {
+ "$ref": "#/definitions/ServicePackageActivationId",
+ "description": "The ActivationId of a deployed service package. If ServicePackageActivationMode specified at the time of creating the service\nis 'SharedProcess' (or if it is not specified, in which case it defaults to 'SharedProcess'), then value of ServicePackageActivationId\nis always an empty string."
+ }
+ }
+ },
+ "DeploymentName": {
+ "type": "string",
+ "description": "The name of the deployment."
+ },
+ "CorrelationSchemeList": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ServiceCorrelationDescription"
+ },
+ "description": "A list that describes the correlation of the service with other services."
+ },
+ "MoveCost": {
+ "type": "string",
+ "description": "Specifies the move cost for the service.",
+ "enum": [
+ "Zero",
+ "Low",
+ "Medium",
+ "High",
+ "VeryHigh"
+ ],
+ "x-ms-enum": {
+ "name": "MoveCost",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "Zero",
+ "description": "Zero move cost. This value is zero."
+ },
+ {
+ "value": "Low",
+ "description": "Specifies the move cost of the service as Low. The value is 1."
+ },
+ {
+ "value": "Medium",
+ "description": "Specifies the move cost of the service as Medium. The value is 2."
+ },
+ {
+ "value": "High",
+ "description": "Specifies the move cost of the service as High. The value is 3."
+ },
+ {
+ "value": "VeryHigh",
+ "description": "Specifies the move cost of the service as VeryHigh. The value is 4."
+ }
+ ]
+ }
+ },
+ "PartitionScheme": {
+ "type": "string",
+ "description": "Enumerates the ways that a service can be partitioned.",
+ "enum": [
+ "Invalid",
+ "Singleton",
+ "UniformInt64Range",
+ "Named"
+ ],
+ "x-ms-enum": {
+ "name": "PartitionScheme",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "Invalid",
+ "description": "Indicates the partition kind is invalid. All Service Fabric enumerations have the invalid type. The value is zero."
+ },
+ {
+ "value": "Singleton",
+ "description": "Indicates that the partition is based on string names, and is a SingletonPartitionSchemeDescription object, The value is 1."
+ },
+ {
+ "value": "UniformInt64Range",
+ "description": "Indicates that the partition is based on Int64 key ranges, and is a UniformInt64RangePartitionSchemeDescription object. The value is 2."
+ },
+ {
+ "value": "Named",
+ "description": "Indicates that the partition is based on string names, and is a NamedPartitionSchemeDescription object. The value is 3"
+ }
+ ]
+ }
+ },
+ "ServiceCorrelationDescription": {
+ "description": "Creates a particular correlation between services.",
+ "required": [
+ "Scheme",
+ "ServiceName"
+ ],
+ "properties": {
+ "Scheme": {
+ "$ref": "#/definitions/ServiceCorrelationScheme",
+ "description": "The ServiceCorrelationScheme which describes the relationship between this service and the service specified via ServiceName."
+ },
+ "ServiceName": {
+ "$ref": "#/definitions/ServiceName",
+ "description": "The name of the service that the correlation relationship is established with."
+ }
+ }
+ },
+ "ServiceCorrelationScheme": {
+ "type": "string",
+ "description": "The service correlation scheme.",
+ "enum": [
+ "Invalid",
+ "Affinity",
+ "AlignedAffinity",
+ "NonAlignedAffinity"
+ ],
+ "x-ms-enum": {
+ "name": "ServiceCorrelationScheme",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "Invalid",
+ "description": "An invalid correlation scheme. Cannot be used. The value is zero."
+ },
+ {
+ "value": "Affinity",
+ "description": "Indicates that this service has an affinity relationship with another service. Provided for backwards compatibility, consider preferring the Aligned or NonAlignedAffinity options. The value is 1."
+ },
+ {
+ "value": "AlignedAffinity",
+ "description": "Aligned affinity ensures that the primaries of the partitions of the affinitized services are collocated on the same nodes. This is the default and is the same as selecting the Affinity scheme. The value is 2."
+ },
+ {
+ "value": "NonAlignedAffinity",
+ "description": "Non-Aligned affinity guarantees that all replicas of each service will be placed on the same nodes. Unlike Aligned Affinity, this does not guarantee that replicas of particular role will be collocated. The value is 3."
+ }
+ ]
+ }
+ },
+ "ServiceLoadMetricsList": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ServiceLoadMetricDescription"
+ },
+ "description": "The service load metrics is given as an array of ServiceLoadMetricDescription objects."
+ },
+ "ServiceLoadMetricDescription": {
+ "description": "Specifies a metric to load balance a service during runtime.",
+ "required": [
+ "Name"
+ ],
+ "properties": {
+ "Name": {
+ "type": "string",
+ "description": "The name of the metric. If the service chooses to report load during runtime, the load metric name should match the name that is specified in Name exactly. Note that metric names are case-sensitive."
+ },
+ "Weight": {
+ "$ref": "#/definitions/ServiceLoadMetricWeight",
+ "description": "The service load metric relative weight, compared to other metrics configured for this service, as a number."
+ },
+ "PrimaryDefaultLoad": {
+ "type": "integer",
+ "description": "Used only for Stateful services. The default amount of load, as a number, that this service creates for this metric when it is a Primary replica."
+ },
+ "SecondaryDefaultLoad": {
+ "type": "integer",
+ "description": "Used only for Stateful services. The default amount of load, as a number, that this service creates for this metric when it is a Secondary replica."
+ },
+ "DefaultLoad": {
+ "type": "integer",
+ "description": "Used only for Stateless services. The default amount of load, as a number, that this service creates for this metric."
+ }
+ }
+ },
+ "ServiceLoadMetricWeight": {
+ "type": "string",
+ "description": "Determines the metric weight relative to the other metrics that are configured for this service. During runtime, if two metrics end up in conflict, the Cluster Resource Manager prefers the metric with the higher weight.",
+ "enum": [
+ "Zero",
+ "Low",
+ "Medium",
+ "High"
+ ],
+ "x-ms-enum": {
+ "name": "ServiceLoadMetricWeight",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "Zero",
+ "description": "Disables resource balancing for this metric. This value is zero."
+ },
+ {
+ "value": "Low",
+ "description": "Specifies the metric weight of the service load as Low. The value is 1."
+ },
+ {
+ "value": "Medium",
+ "description": "Specifies the metric weight of the service load as Medium. The value is 2."
+ },
+ {
+ "value": "High",
+ "description": "Specifies the metric weight of the service load as High. The value is 3."
+ }
+ ]
+ }
+ },
+ "ServicePackageActivationMode": {
+ "type": "string",
+ "description": "The activation mode of service package to be used for a Service Fabric service. This is specified at the time of creating the Service.",
+ "enum": [
+ "SharedProcess",
+ "ExclusiveProcess"
+ ],
+ "x-ms-enum": {
+ "name": "ServicePackageActivationMode",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "SharedProcess",
+ "description": "This is the default activation mode. With this activation mode, replicas or instances from different partition(s) of service, on a given node, will share same activation of service package on a node. The value is zero."
+ },
+ {
+ "value": "ExclusiveProcess",
+ "description": "With this activation mode, each replica or instance of service, on a given node, will have its own dedicated activation of service package on a node. The value is 1."
+ }
+ ]
+ }
+ },
+ "ServicePlacementPoliciesList": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ServicePlacementPolicyDescription"
+ },
+ "description": "A list that describes the correlation of the service with other services."
+ },
+ "PartitionSchemeDescription": {
+ "discriminator": "PartitionScheme",
+ "description": "Describes how the service is partitioned.",
+ "required": [
+ "PartitionScheme"
+ ],
+ "properties": {
+ "PartitionScheme": {
+ "$ref": "#/definitions/PartitionScheme",
+ "description": "Specifies how the service is partitioned."
+ }
+ }
+ },
+ "NamedPartitionSchemeDescription": {
+ "description": "Describes the named partition scheme of the service.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/PartitionSchemeDescription"
+ }
+ ],
+ "x-ms-discriminator-value": "Named",
+ "required": [
+ "Count",
+ "Names"
+ ],
+ "properties": {
+ "Count": {
+ "type": "integer",
+ "description": "The number of partitions."
+ },
+ "Names": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "Array of size specified by the ‘Count’ parameter, for the names of the partitions."
+ }
+ }
+ },
+ "SingletonPartitionSchemeDescription": {
+ "description": "Describes the partition scheme of a singleton-partitioned, or non-partitioned service.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/PartitionSchemeDescription"
+ }
+ ],
+ "x-ms-discriminator-value": "Singleton"
+ },
+ "UniformInt64RangePartitionSchemeDescription": {
+ "description": "Describes a partitioning scheme where an integer range is allocated evenly across a number of partitions.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/PartitionSchemeDescription"
+ }
+ ],
+ "x-ms-discriminator-value": "UniformInt64Range",
+ "required": [
+ "Count",
+ "LowKey",
+ "HighKey"
+ ],
+ "properties": {
+ "Count": {
+ "type": "integer",
+ "description": "The number of partitions."
+ },
+ "LowKey": {
+ "type": "string",
+ "description": "String indicating the lower bound of the partition key range that\nshould be split between the partitions."
+ },
+ "HighKey": {
+ "type": "string",
+ "description": "String indicating the upper bound of the partition key range that\nshould be split between the partitions."
+ }
+ }
+ },
+ "ServiceDescription": {
+ "discriminator": "ServiceKind",
+ "description": "A ServiceDescription contains all of the information necessary to create a service.",
+ "required": [
+ "ServiceKind",
+ "ServiceName",
+ "ServiceTypeName",
+ "PartitionDescription"
+ ],
+ "properties": {
+ "ServiceKind": {
+ "$ref": "#/definitions/ServiceKind",
+ "description": "The service kind."
+ },
+ "ApplicationName": {
+ "$ref": "#/definitions/ApplicationName",
+ "description": "The name of the application, including the 'fabric:' URI scheme."
+ },
+ "ServiceName": {
+ "$ref": "#/definitions/ServiceName",
+ "description": "The full name of the service with 'fabric:' URI scheme."
+ },
+ "ServiceTypeName": {
+ "$ref": "#/definitions/ServiceTypeName",
+ "description": "Name of the service type as specified in the service manifest."
+ },
+ "InitializationData": {
+ "$ref": "#/definitions/ByteArray",
+ "description": "The initialization data as an array of bytes. Initialization data is passed to service instances or replicas when they are created."
+ },
+ "PartitionDescription": {
+ "$ref": "#/definitions/PartitionSchemeDescription",
+ "description": "The partition description as an object."
+ },
+ "PlacementConstraints": {
+ "type": "string",
+ "description": "The placement constraints as a string. Placement constraints are boolean expressions on node properties and allow for restricting a service to particular nodes based on the service requirements. For example, to place a service on nodes where NodeType is blue specify the following: \"NodeColor == blue)\"."
+ },
+ "CorrelationScheme": {
+ "$ref": "#/definitions/CorrelationSchemeList",
+ "description": "The correlation scheme."
+ },
+ "ServiceLoadMetrics": {
+ "$ref": "#/definitions/ServiceLoadMetricsList",
+ "description": "The service load metrics."
+ },
+ "ServicePlacementPolicies": {
+ "$ref": "#/definitions/ServicePlacementPoliciesList",
+ "description": "The service placement policies."
+ },
+ "DefaultMoveCost": {
+ "$ref": "#/definitions/MoveCost",
+ "description": "The move cost for the service."
+ },
+ "IsDefaultMoveCostSpecified": {
+ "type": "boolean",
+ "description": "Indicates if the DefaultMoveCost property is specified."
+ },
+ "ServicePackageActivationMode": {
+ "$ref": "#/definitions/ServicePackageActivationMode",
+ "description": "The activation mode of service package to be used for a service."
+ },
+ "ServiceDnsName": {
+ "type": "string",
+ "description": "The DNS name of the service. It requires the DNS system service to be enabled in Service Fabric cluster."
+ },
+ "ScalingPolicies": {
+ "$ref": "#/definitions/ScalingPolicyDescriptionList",
+ "description": "Scaling policies for this service."
+ }
+ }
+ },
+ "StatefulServiceDescription": {
+ "description": "Describes a stateful service.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ServiceDescription"
+ }
+ ],
+ "x-ms-discriminator-value": "Stateful",
+ "required": [
+ "TargetReplicaSetSize",
+ "MinReplicaSetSize",
+ "HasPersistedState"
+ ],
+ "properties": {
+ "TargetReplicaSetSize": {
+ "type": "integer",
+ "minimum": 1,
+ "description": "The target replica set size as a number."
+ },
+ "MinReplicaSetSize": {
+ "type": "integer",
+ "minimum": 1,
+ "description": "The minimum replica set size as a number."
+ },
+ "HasPersistedState": {
+ "type": "boolean",
+ "description": "A flag indicating whether this is a persistent service which stores states on the local disk. If it is then the value of this property is true, if not it is false."
+ },
+ "Flags": {
+ "type": "integer",
+ "description": "Flags indicating whether other properties are set. Each of the associated properties corresponds to a flag, specified below, which, if set, indicate that the property is specified.\nThis property can be a combination of those flags obtained using bitwise 'OR' operator.\nFor example, if the provided value is 6 then the flags for QuorumLossWaitDuration (2) and StandByReplicaKeepDuration(4) are set.\n\n- None - Does not indicate any other properties are set. The value is zero.\n- ReplicaRestartWaitDuration - Indicates the ReplicaRestartWaitDuration property is set. The value is 1.\n- QuorumLossWaitDuration - Indicates the QuorumLossWaitDuration property is set. The value is 2.\n- StandByReplicaKeepDuration - Indicates the StandByReplicaKeepDuration property is set. The value is 4.\n- ServicePlacementTimeLimit - Indicates the ServicePlacementTimeLimit property is set. The value is 8."
+ },
+ "ReplicaRestartWaitDurationSeconds": {
+ "type": "integer",
+ "format": "int64",
+ "minimum": 0,
+ "maximum": 4294967295,
+ "description": "The duration, in seconds, between when a replica goes down and when a new replica is created."
+ },
+ "QuorumLossWaitDurationSeconds": {
+ "type": "integer",
+ "format": "int64",
+ "minimum": 0,
+ "maximum": 4294967295,
+ "description": "The maximum duration, in seconds, for which a partition is allowed to be in a state of quorum loss."
+ },
+ "StandByReplicaKeepDurationSeconds": {
+ "type": "integer",
+ "format": "int64",
+ "minimum": 0,
+ "maximum": 4294967295,
+ "description": "The definition on how long StandBy replicas should be maintained before being removed."
+ },
+ "ServicePlacementTimeLimitSeconds": {
+ "type": "integer",
+ "format": "int64",
+ "minimum": 0,
+ "maximum": 4294967295,
+ "description": "The duration for which replicas can stay InBuild before reporting that build is stuck."
+ }
+ }
+ },
+ "StatelessServiceDescription": {
+ "description": "Describes a stateless service.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ServiceDescription"
+ }
+ ],
+ "x-ms-discriminator-value": "Stateless",
+ "required": [
+ "InstanceCount"
+ ],
+ "properties": {
+ "InstanceCount": {
+ "type": "integer",
+ "minimum": -1,
+ "description": "The instance count."
+ },
+ "MinInstanceCount": {
+ "$ref": "#/definitions/MinInstanceCount",
+ "description": "MinInstanceCount is the minimum number of instances that must be up to meet the EnsureAvailability safety check during operations like upgrade or deactivate node.\nThe actual number that is used is max( MinInstanceCount, ceil( MinInstancePercentage/100.0 * InstanceCount) ).\nNote, if InstanceCount is set to -1, during MinInstanceCount computation -1 is first converted into the number of nodes on which the instances are allowed to be placed according to the placement constraints on the service."
+ },
+ "MinInstancePercentage": {
+ "$ref": "#/definitions/MinInstancePercentage",
+ "description": "MinInstancePercentage is the minimum percentage of InstanceCount that must be up to meet the EnsureAvailability safety check during operations like upgrade or deactivate node.\nThe actual number that is used is max( MinInstanceCount, ceil( MinInstancePercentage/100.0 * InstanceCount) ).\nNote, if InstanceCount is set to -1, during MinInstancePercentage computation, -1 is first converted into the number of nodes on which the instances are allowed to be placed according to the placement constraints on the service."
+ },
+ "Flags": {
+ "type": "integer",
+ "description": "Flags indicating whether other properties are set. Each of the associated properties corresponds to a flag, specified below, which, if set, indicate that the property is specified.\nThis property can be a combination of those flags obtained using bitwise 'OR' operator.\nFor example, if the provided value is 1 then the flags for InstanceCloseDelayDuration is set.\n\n- None - Does not indicate any other properties are set. The value is zero.\n- InstanceCloseDelayDuration - Indicates the InstanceCloseDelayDuration property is set. The value is 1."
+ },
+ "InstanceCloseDelayDurationSeconds": {
+ "type": "integer",
+ "format": "int64",
+ "minimum": 0,
+ "maximum": 4294967295,
+ "description": "Duration in seconds, to wait before a stateless instance is closed, to allow the active requests to drain gracefully. This would be effective when the instance is closing during the application/cluster upgrade and disabling node.\nThe endpoint exposed on this instance is removed prior to starting the delay, which prevents new connections to this instance.\nIn addition, clients that have subscribed to service endpoint change events(https://docs.microsoft.com/dotnet/api/system.fabric.fabricclient.servicemanagementclient.registerservicenotificationfilterasync), can do\nthe following upon receiving the endpoint removal notification:\n - Stop sending new requests to this instance.\n - Close existing connections after in-flight requests have completed.\n - Connect to a different instance of the service partition for future requests.\nNote, the default value of InstanceCloseDelayDuration is 0, which indicates that there won't be any delay or removal of the endpoint prior to closing the instance."
+ }
+ }
+ },
+ "ReplicatorQueueStatus": {
+ "description": "Provides various statistics of the queue used in the service fabric replicator.\nContains information about the service fabric replicator like the replication/copy queue utilization, last acknowledgement received timestamp, etc.\nDepending on the role of the replicator, the properties in this type imply different meanings.",
+ "properties": {
+ "QueueUtilizationPercentage": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Represents the utilization of the queue. A value of 0 indicates that the queue is empty and a value of 100 indicates the queue is full."
+ },
+ "QueueMemorySize": {
+ "type": "string",
+ "description": "Represents the virtual memory consumed by the queue in bytes."
+ },
+ "FirstSequenceNumber": {
+ "type": "string",
+ "description": "On a primary replicator, this is semantically the sequence number of the operation for which all the secondary replicas have sent an acknowledgement.\nOn a secondary replicator, this is the smallest sequence number of the operation that is present in the queue."
+ },
+ "CompletedSequenceNumber": {
+ "type": "string",
+ "description": "On a primary replicator, this is semantically the highest sequence number of the operation for which all the secondary replicas have sent an acknowledgement.\nOn a secondary replicator, this is semantically the highest sequence number that has been applied to the persistent state."
+ },
+ "CommittedSequenceNumber": {
+ "type": "string",
+ "description": "On a primary replicator, this is semantically the highest sequence number of the operation for which a write quorum of the secondary replicas have sent an acknowledgement.\nOn a secondary replicator, this is semantically the highest sequence number of the in-order operation received from the primary."
+ },
+ "LastSequenceNumber": {
+ "type": "string",
+ "description": "Represents the latest sequence number of the operation that is available in the queue."
+ }
+ }
+ },
+ "ReplicatorStatus": {
+ "discriminator": "Kind",
+ "description": "Represents a base class for primary or secondary replicator status.\nContains information about the service fabric replicator like the replication/copy queue utilization, last acknowledgement received timestamp, etc.",
+ "required": [
+ "Kind"
+ ],
+ "properties": {
+ "Kind": {
+ "$ref": "#/definitions/ReplicaRole",
+ "description": "The role of a replica of a stateful service."
+ }
+ }
+ },
+ "PrimaryReplicatorStatus": {
+ "x-ms-discriminator-value": "Primary",
+ "description": "Provides statistics about the Service Fabric Replicator, when it is functioning in a Primary role.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ReplicatorStatus"
+ }
+ ],
+ "properties": {
+ "ReplicationQueueStatus": {
+ "$ref": "#/definitions/ReplicatorQueueStatus",
+ "description": "Details about the replication queue on the primary replicator."
+ },
+ "RemoteReplicators": {
+ "$ref": "#/definitions/RemoteReplicatorStatusList",
+ "description": "The status of all the active and idle secondary replicators that the primary is aware of."
+ }
+ }
+ },
+ "SecondaryReplicatorStatus": {
+ "description": "Provides statistics about the Service Fabric Replicator, when it is functioning in a ActiveSecondary role.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ReplicatorStatus"
+ }
+ ],
+ "properties": {
+ "ReplicationQueueStatus": {
+ "$ref": "#/definitions/ReplicatorQueueStatus",
+ "description": "Details about the replication queue on the secondary replicator."
+ },
+ "LastReplicationOperationReceivedTimeUtc": {
+ "type": "string",
+ "format": "date-time",
+ "description": "The last time-stamp (UTC) at which a replication operation was received from the primary.\nUTC 0 represents an invalid value, indicating that a replication operation message was never received."
+ },
+ "IsInBuild": {
+ "type": "boolean",
+ "description": "Value that indicates whether the replica is currently being built."
+ },
+ "CopyQueueStatus": {
+ "$ref": "#/definitions/ReplicatorQueueStatus",
+ "description": "Details about the copy queue on the secondary replicator."
+ },
+ "LastCopyOperationReceivedTimeUtc": {
+ "type": "string",
+ "format": "date-time",
+ "description": "The last time-stamp (UTC) at which a copy operation was received from the primary.\nUTC 0 represents an invalid value, indicating that a copy operation message was never received."
+ },
+ "LastAcknowledgementSentTimeUtc": {
+ "type": "string",
+ "format": "date-time",
+ "description": "The last time-stamp (UTC) at which an acknowledgment was sent to the primary replicator.\nUTC 0 represents an invalid value, indicating that an acknowledgment message was never sent."
+ }
+ }
+ },
+ "SecondaryActiveReplicatorStatus": {
+ "x-ms-discriminator-value": "ActiveSecondary",
+ "description": "Status of the secondary replicator when it is in active mode and is part of the replica set.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/SecondaryReplicatorStatus"
+ }
+ ]
+ },
+ "SecondaryIdleReplicatorStatus": {
+ "x-ms-discriminator-value": "IdleSecondary",
+ "description": "Status of the secondary replicator when it is in idle mode and is being built by the primary.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/SecondaryReplicatorStatus"
+ }
+ ]
+ },
+ "RemoteReplicatorStatus": {
+ "description": "Represents the state of the secondary replicator from the primary replicator’s point of view.",
+ "properties": {
+ "ReplicaId": {
+ "$ref": "#/definitions/ReplicaId",
+ "description": "Represents the replica ID of the remote secondary replicator."
+ },
+ "LastAcknowledgementProcessedTimeUtc": {
+ "type": "string",
+ "format": "date-time",
+ "description": "The last timestamp (in UTC) when an acknowledgement from the secondary replicator was processed on the primary.\nUTC 0 represents an invalid value, indicating that no acknowledgement messages were ever processed."
+ },
+ "LastReceivedReplicationSequenceNumber": {
+ "type": "string",
+ "description": "The highest replication operation sequence number that the secondary has received from the primary."
+ },
+ "LastAppliedReplicationSequenceNumber": {
+ "type": "string",
+ "description": "The highest replication operation sequence number that the secondary has applied to its state."
+ },
+ "IsInBuild": {
+ "type": "boolean",
+ "description": "A value that indicates whether the secondary replica is in the process of being built."
+ },
+ "LastReceivedCopySequenceNumber": {
+ "type": "string",
+ "description": "The highest copy operation sequence number that the secondary has received from the primary.\nA value of -1 implies that the secondary has received all copy operations."
+ },
+ "LastAppliedCopySequenceNumber": {
+ "type": "string",
+ "description": "The highest copy operation sequence number that the secondary has applied to its state.\nA value of -1 implies that the secondary has applied all copy operations and the copy process is complete."
+ },
+ "RemoteReplicatorAcknowledgementStatus": {
+ "$ref": "#/definitions/RemoteReplicatorAcknowledgementStatus",
+ "description": "Represents the acknowledgment status for the remote secondary replicator."
+ }
+ }
+ },
+ "RemoteReplicatorStatusList": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/RemoteReplicatorStatus"
+ },
+ "description": "List of remote replicator status"
+ },
+ "RemoteReplicatorAcknowledgementStatus": {
+ "description": "Provides details about the remote replicators from the primary replicator's point of view.",
+ "properties": {
+ "ReplicationStreamAcknowledgementDetail": {
+ "$ref": "#/definitions/RemoteReplicatorAcknowledgementDetail",
+ "description": "Details about the acknowledgements for operations that are part of the replication stream data."
+ },
+ "CopyStreamAcknowledgementDetail": {
+ "$ref": "#/definitions/RemoteReplicatorAcknowledgementDetail",
+ "description": "Details about the acknowledgements for operations that are part of the copy stream data."
+ }
+ }
+ },
+ "RemoteReplicatorAcknowledgementDetail": {
+ "description": "Provides various statistics of the acknowledgements that are being received from the remote replicator.",
+ "properties": {
+ "AverageReceiveDuration": {
+ "type": "string",
+ "description": "Represents the average duration it takes for the remote replicator to receive an operation."
+ },
+ "AverageApplyDuration": {
+ "type": "string",
+ "description": "Represents the average duration it takes for the remote replicator to apply an operation. This usually entails writing the operation to disk."
+ },
+ "NotReceivedCount": {
+ "type": "string",
+ "description": "Represents the number of operations not yet received by a remote replicator."
+ },
+ "ReceivedAndNotAppliedCount": {
+ "type": "string",
+ "description": "Represents the number of operations received and not yet applied by a remote replicator."
+ }
+ }
+ },
+ "DeployedServiceReplicaDetailInfo": {
+ "discriminator": "ServiceKind",
+ "description": "Information about a Service Fabric service replica deployed on a node.",
+ "required": [
+ "ServiceKind"
+ ],
+ "properties": {
+ "ServiceKind": {
+ "$ref": "#/definitions/ServiceKind",
+ "description": "The kind of service (Stateless or Stateful)."
+ },
+ "ServiceName": {
+ "$ref": "#/definitions/ServiceName",
+ "description": "Full hierarchical name of the service in URI format starting with `fabric:`."
+ },
+ "PartitionId": {
+ "$ref": "#/definitions/PartitionId",
+ "description": "An internal ID used by Service Fabric to uniquely identify a partition. This is a randomly generated GUID when the service was created. The partition ID is unique and does not change for the lifetime of the service. If the same service was deleted and recreated the IDs of its partitions would be different."
+ },
+ "CurrentServiceOperation": {
+ "$ref": "#/definitions/ServiceOperationName",
+ "description": "Specifies the current active life-cycle operation on a stateful service replica or stateless service instance."
+ },
+ "CurrentServiceOperationStartTimeUtc": {
+ "type": "string",
+ "format": "date-time",
+ "description": "The start time of the current service operation in UTC format."
+ },
+ "ReportedLoad": {
+ "$ref": "#/definitions/LoadMetricReportInfoList",
+ "description": "List of load reported by replica."
+ }
+ }
+ },
+ "DeployedStatefulServiceReplicaDetailInfo": {
+ "description": "Information about a stateful replica running in a code package. Note DeployedServiceReplicaQueryResult will contain duplicate data like ServiceKind, ServiceName, PartitionId and replicaId.",
+ "x-ms-discriminator-value": "Stateful",
+ "allOf": [
+ {
+ "$ref": "#/definitions/DeployedServiceReplicaDetailInfo"
+ }
+ ],
+ "properties": {
+ "ReplicaId": {
+ "$ref": "#/definitions/ReplicaId",
+ "description": "Id of a stateful service replica. ReplicaId is used by Service Fabric to uniquely identify a replica of a partition. It is unique within a partition and does not change for the lifetime of the replica. If a replica gets dropped and another replica gets created on the same node for the same partition, it will get a different value for the id. Sometimes the id of a stateless service instance is also referred as a replica id."
+ },
+ "CurrentReplicatorOperation": {
+ "$ref": "#/definitions/ReplicatorOperationName",
+ "description": "Specifies the operation currently being executed by the Replicator."
+ },
+ "ReadStatus": {
+ "$ref": "#/definitions/PartitionAccessStatus",
+ "description": "Specifies the access status of the partition."
+ },
+ "WriteStatus": {
+ "$ref": "#/definitions/PartitionAccessStatus",
+ "description": "Specifies the access status of the partition."
+ },
+ "ReplicatorStatus": {
+ "$ref": "#/definitions/ReplicatorStatus",
+ "description": "Represents a base class for primary or secondary replicator status.\nContains information about the service fabric replicator like the replication/copy queue utilization, last acknowledgement received timestamp, etc."
+ },
+ "ReplicaStatus": {
+ "$ref": "#/definitions/KeyValueStoreReplicaStatus",
+ "description": "Key value store related information for the replica."
+ },
+ "DeployedServiceReplicaQueryResult": {
+ "$ref": "#/definitions/DeployedStatefulServiceReplicaInfo",
+ "description": "Information about a stateful service replica deployed on a node."
+ }
+ }
+ },
+ "DeployedStatelessServiceInstanceDetailInfo": {
+ "description": "Information about a stateless instance running in a code package. Note that DeployedServiceReplicaQueryResult will contain duplicate data like ServiceKind, ServiceName, PartitionId and InstanceId.",
+ "x-ms-discriminator-value": "Stateless",
+ "allOf": [
+ {
+ "$ref": "#/definitions/DeployedServiceReplicaDetailInfo"
+ }
+ ],
+ "properties": {
+ "InstanceId": {
+ "$ref": "#/definitions/InstanceId",
+ "description": "Id of a stateless service instance. InstanceId is used by Service Fabric to uniquely identify an instance of a partition of a stateless service. It is unique within a partition and does not change for the lifetime of the instance. If the instance has failed over on the same or different node, it will get a different value for the InstanceId."
+ },
+ "DeployedServiceReplicaQueryResult": {
+ "$ref": "#/definitions/DeployedStatelessServiceInstanceInfo",
+ "description": "Information about a stateless service instance deployed on a node."
+ }
+ }
+ },
+ "FabricReplicaStatus": {
+ "type": "string",
+ "description": "Specifies the status of the replica.",
+ "enum": [
+ "Invalid",
+ "Down",
+ "Up"
+ ],
+ "x-ms-enum": {
+ "name": "FabricReplicaStatus",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "Invalid",
+ "description": "Indicates that the read or write operation access status is not valid. This value is not returned to the caller."
+ },
+ {
+ "value": "Down",
+ "description": "Indicates that the replica is down."
+ },
+ {
+ "value": "Up",
+ "description": "Indicates that the replica is up."
+ }
+ ]
+ }
+ },
+ "LoadMetricReportInfoList": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/LoadMetricReportInfo"
+ },
+ "description": "List of load reported by replica."
+ },
+ "LoadMetricReportInfo": {
+ "description": "Information about load reported by replica.",
+ "properties": {
+ "Name": {
+ "type": "string",
+ "description": "The name of the metric."
+ },
+ "Value": {
+ "type": "integer",
+ "format": "int32",
+ "description": "The value of the load for the metric. In future releases of Service Fabric this parameter will be deprecated in favor of CurrentValue."
+ },
+ "CurrentValue": {
+ "type": "string",
+ "format": "double",
+ "description": "The double value of the load for the metric."
+ },
+ "LastReportedUtc": {
+ "type": "string",
+ "format": "date-time",
+ "description": "The UTC time when the load is reported."
+ }
+ }
+ },
+ "PartitionAccessStatus": {
+ "type": "string",
+ "description": "Specifies the access status of the partition.",
+ "enum": [
+ "Invalid",
+ "Granted",
+ "ReconfigurationPending",
+ "NotPrimary",
+ "NoWriteQuorum"
+ ],
+ "x-ms-enum": {
+ "name": "PartitionAccessStatus",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "Invalid",
+ "description": "Indicates that the read or write operation access status is not valid. This value is not returned to the caller."
+ },
+ {
+ "value": "Granted",
+ "description": "Indicates that the read or write operation access is granted and the operation is allowed."
+ },
+ {
+ "value": "ReconfigurationPending",
+ "description": "Indicates that the client should try again later, because a reconfiguration is in progress."
+ },
+ {
+ "value": "NotPrimary",
+ "description": "Indicates that this client request was received by a replica that is not a Primary replica."
+ },
+ {
+ "value": "NoWriteQuorum",
+ "description": "Indicates that no write quorum is available and, therefore, no write operation can be accepted."
+ }
+ ]
+ }
+ },
+ "ReplicatorOperationName": {
+ "type": "string",
+ "description": "Specifies the operation currently being executed by the Replicator.",
+ "enum": [
+ "Invalid",
+ "None",
+ "Open",
+ "ChangeRole",
+ "UpdateEpoch",
+ "Close",
+ "Abort",
+ "OnDataLoss",
+ "WaitForCatchup",
+ "Build"
+ ],
+ "x-ms-enum": {
+ "name": "ReplicatorOperationName",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "Invalid",
+ "description": "Default value if the replicator is not yet ready."
+ },
+ {
+ "value": "None",
+ "description": "Replicator is not running any operation from Service Fabric perspective."
+ },
+ {
+ "value": "Open",
+ "description": "Replicator is opening."
+ },
+ {
+ "value": "ChangeRole",
+ "description": "Replicator is in the process of changing its role."
+ },
+ {
+ "value": "UpdateEpoch",
+ "description": "Due to a change in the replica set, replicator is being updated with its Epoch."
+ },
+ {
+ "value": "Close",
+ "description": "Replicator is closing."
+ },
+ {
+ "value": "Abort",
+ "description": "Replicator is being aborted."
+ },
+ {
+ "value": "OnDataLoss",
+ "description": "Replicator is handling the data loss condition, where the user service may potentially be recovering state from an external source."
+ },
+ {
+ "value": "WaitForCatchup",
+ "description": "Replicator is waiting for a quorum of replicas to be caught up to the latest state."
+ },
+ {
+ "value": "Build",
+ "description": "Replicator is in the process of building one or more replicas."
+ }
+ ]
+ }
+ },
+ "ServiceOperationName": {
+ "type": "string",
+ "description": "Specifies the current active life-cycle operation on a stateful service replica or stateless service instance.",
+ "enum": [
+ "Unknown",
+ "None",
+ "Open",
+ "ChangeRole",
+ "Close",
+ "Abort"
+ ],
+ "x-ms-enum": {
+ "name": "ServiceOperationName",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "Unknown",
+ "description": "Reserved for future use."
+ },
+ {
+ "value": "None",
+ "description": "The service replica or instance is not going through any life-cycle changes."
+ },
+ {
+ "value": "Open",
+ "description": "The service replica or instance is being opened."
+ },
+ {
+ "value": "ChangeRole",
+ "description": "The service replica is changing roles."
+ },
+ {
+ "value": "Close",
+ "description": "The service replica or instance is being closed."
+ },
+ {
+ "value": "Abort",
+ "description": "The service replica or instance is being aborted."
+ }
+ ]
+ }
+ },
+ "ReplicaKind": {
+ "type": "string",
+ "description": "The role of a replica of a stateful service.",
+ "enum": [
+ "Invalid",
+ "KeyValueStore"
+ ],
+ "x-ms-enum": {
+ "name": "ReplicaKind",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "Invalid",
+ "description": "Represents an invalid replica kind. The value is zero."
+ },
+ {
+ "value": "KeyValueStore",
+ "description": "Represents a key value store replica. The value is 1"
+ }
+ ]
+ }
+ },
+ "ReplicaStatusBase": {
+ "discriminator": "Kind",
+ "description": "Information about the replica.",
+ "required": [
+ "Kind"
+ ],
+ "properties": {
+ "Kind": {
+ "$ref": "#/definitions/ReplicaKind",
+ "description": "The role of a replica of a stateful service."
+ }
+ }
+ },
+ "KeyValueStoreReplicaStatus": {
+ "description": "Key value store related information for the replica.",
+ "x-ms-discriminator-value": "KeyValueStore",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ReplicaStatusBase"
+ }
+ ],
+ "properties": {
+ "DatabaseRowCountEstimate": {
+ "type": "string",
+ "description": "Value indicating the estimated number of rows in the underlying database."
+ },
+ "DatabaseLogicalSizeEstimate": {
+ "type": "string",
+ "description": "Value indicating the estimated size of the underlying database."
+ },
+ "CopyNotificationCurrentKeyFilter": {
+ "type": "string",
+ "description": "Value indicating the latest key-prefix filter applied to enumeration during the callback. Null if there is no pending callback."
+ },
+ "CopyNotificationCurrentProgress": {
+ "type": "string",
+ "description": "Value indicating the latest number of keys enumerated during the callback. 0 if there is no pending callback."
+ },
+ "StatusDetails": {
+ "type": "string",
+ "description": "Value indicating the current status details of the replica."
+ }
+ }
+ },
+ "ServiceUpdateDescription": {
+ "discriminator": "ServiceKind",
+ "description": "A ServiceUpdateDescription contains all of the information necessary to update a service.",
+ "required": [
+ "ServiceKind"
+ ],
+ "properties": {
+ "ServiceKind": {
+ "$ref": "#/definitions/ServiceKind",
+ "description": "The service kind."
+ },
+ "Flags": {
+ "type": "string",
+ "description": "Flags indicating whether other properties are set. Each of the associated properties corresponds to a flag, specified below, which, if set, indicate that the property is specified.\nThis property can be a combination of those flags obtained using bitwise 'OR' operator.\nFor example, if the provided value is 6 then the flags for ReplicaRestartWaitDuration (2) and QuorumLossWaitDuration (4) are set.\n\n- None - Does not indicate any other properties are set. The value is zero.\n- TargetReplicaSetSize/InstanceCount - Indicates whether the TargetReplicaSetSize property (for Stateful services) or the InstanceCount property (for Stateless services) is set. The value is 1.\n- ReplicaRestartWaitDuration - Indicates the ReplicaRestartWaitDuration property is set. The value is 2.\n- QuorumLossWaitDuration - Indicates the QuorumLossWaitDuration property is set. The value is 4.\n- StandByReplicaKeepDuration - Indicates the StandByReplicaKeepDuration property is set. The value is 8.\n- MinReplicaSetSize - Indicates the MinReplicaSetSize property is set. The value is 16.\n- PlacementConstraints - Indicates the PlacementConstraints property is set. The value is 32.\n- PlacementPolicyList - Indicates the ServicePlacementPolicies property is set. The value is 64.\n- Correlation - Indicates the CorrelationScheme property is set. The value is 128.\n- Metrics - Indicates the ServiceLoadMetrics property is set. The value is 256.\n- DefaultMoveCost - Indicates the DefaultMoveCost property is set. The value is 512.\n- ScalingPolicy - Indicates the ScalingPolicies property is set. The value is 1024.\n- ServicePlacementTimeLimit - Indicates the ServicePlacementTimeLimit property is set. The value is 2048.\n- MinInstanceCount - Indicates the MinInstanceCount property is set. The value is 4096.\n- MinInstancePercentage - Indicates the MinInstancePercentage property is set. The value is 8192.\n- InstanceCloseDelayDuration - Indicates the InstanceCloseDelayDuration property is set. The value is 16384."
+ },
+ "PlacementConstraints": {
+ "type": "string",
+ "description": "The placement constraints as a string. Placement constraints are boolean expressions on node properties and allow for restricting a service to particular nodes based on the service requirements. For example, to place a service on nodes where NodeType is blue specify the following: \"NodeColor == blue)\"."
+ },
+ "CorrelationScheme": {
+ "$ref": "#/definitions/CorrelationSchemeList",
+ "description": "The correlation scheme."
+ },
+ "LoadMetrics": {
+ "$ref": "#/definitions/ServiceLoadMetricsList",
+ "description": "The service load metrics."
+ },
+ "ServicePlacementPolicies": {
+ "$ref": "#/definitions/ServicePlacementPoliciesList",
+ "description": "The service placement policies."
+ },
+ "DefaultMoveCost": {
+ "$ref": "#/definitions/MoveCost",
+ "description": "The move cost for the service."
+ },
+ "ScalingPolicies": {
+ "$ref": "#/definitions/ScalingPolicyDescriptionList",
+ "description": "Scaling policies for this service."
+ }
+ }
+ },
+ "StatefulServiceUpdateDescription": {
+ "description": "Describes an update for a stateful service.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ServiceUpdateDescription"
+ }
+ ],
+ "x-ms-discriminator-value": "Stateful",
+ "properties": {
+ "TargetReplicaSetSize": {
+ "type": "integer",
+ "minimum": 1,
+ "description": "The target replica set size as a number."
+ },
+ "MinReplicaSetSize": {
+ "type": "integer",
+ "minimum": 1,
+ "description": "The minimum replica set size as a number."
+ },
+ "ReplicaRestartWaitDurationSeconds": {
+ "type": "string",
+ "description": "The duration, in seconds, between when a replica goes down and when a new replica is created."
+ },
+ "QuorumLossWaitDurationSeconds": {
+ "type": "string",
+ "description": "The maximum duration, in seconds, for which a partition is allowed to be in a state of quorum loss."
+ },
+ "StandByReplicaKeepDurationSeconds": {
+ "type": "string",
+ "description": "The definition on how long StandBy replicas should be maintained before being removed."
+ },
+ "ServicePlacementTimeLimitSeconds": {
+ "type": "string",
+ "description": "The duration for which replicas can stay InBuild before reporting that build is stuck."
+ }
+ }
+ },
+ "StatelessServiceUpdateDescription": {
+ "description": "Describes an update for a stateless service.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ServiceUpdateDescription"
+ }
+ ],
+ "x-ms-discriminator-value": "Stateless",
+ "properties": {
+ "InstanceCount": {
+ "type": "integer",
+ "minimum": -1,
+ "description": "The instance count."
+ },
+ "MinInstanceCount": {
+ "$ref": "#/definitions/MinInstanceCount",
+ "description": "MinInstanceCount is the minimum number of instances that must be up to meet the EnsureAvailability safety check during operations like upgrade or deactivate node.\nThe actual number that is used is max( MinInstanceCount, ceil( MinInstancePercentage/100.0 * InstanceCount) ).\nNote, if InstanceCount is set to -1, during MinInstanceCount computation -1 is first converted into the number of nodes on which the instances are allowed to be placed according to the placement constraints on the service."
+ },
+ "MinInstancePercentage": {
+ "$ref": "#/definitions/MinInstancePercentage",
+ "description": "MinInstancePercentage is the minimum percentage of InstanceCount that must be up to meet the EnsureAvailability safety check during operations like upgrade or deactivate node.\nThe actual number that is used is max( MinInstanceCount, ceil( MinInstancePercentage/100.0 * InstanceCount) ).\nNote, if InstanceCount is set to -1, during MinInstancePercentage computation, -1 is first converted into the number of nodes on which the instances are allowed to be placed according to the placement constraints on the service."
+ },
+ "InstanceCloseDelayDurationSeconds": {
+ "type": "string",
+ "description": "Duration in seconds, to wait before a stateless instance is closed, to allow the active requests to drain gracefully. This would be effective when the instance is closing during the application/cluster upgrade and disabling node.\nThe endpoint exposed on this instance is removed prior to starting the delay, which prevents new connections to this instance.\nIn addition, clients that have subscribed to service endpoint change events(https://docs.microsoft.com/dotnet/api/system.fabric.fabricclient.servicemanagementclient.registerservicenotificationfilterasync), can do\nthe following upon receiving the endpoint removal notification:\n - Stop sending new requests to this instance.\n - Close existing connections after in-flight requests have completed.\n - Connect to a different instance of the service partition for future requests."
+ }
+ }
+ },
+ "ImageStoreRelativePath": {
+ "type": "string",
+ "description": "The remote location within image store. This path is relative to the image store root."
+ },
+ "FileVersion": {
+ "description": "Information about the version of image store file.",
+ "properties": {
+ "VersionNumber": {
+ "type": "string",
+ "description": "The current image store version number for the file is used in image store for checking whether it need to be updated."
+ },
+ "EpochDataLossNumber": {
+ "type": "string",
+ "description": "The epoch data loss number of image store replica when this file entry was updated or created."
+ },
+ "EpochConfigurationNumber": {
+ "type": "string",
+ "description": "The epoch configuration version number of the image store replica when this file entry was created or updated."
+ }
+ }
+ },
+ "DiskInfo": {
+ "description": "Information about the disk",
+ "properties": {
+ "Capacity": {
+ "type": "string",
+ "description": "the disk size in bytes"
+ },
+ "AvailableSpace": {
+ "type": "string",
+ "description": "the available disk space in bytes"
+ }
+ }
+ },
+ "FileInfo": {
+ "description": "Information about a image store file.",
+ "properties": {
+ "FileSize": {
+ "type": "string",
+ "description": "The size of file in bytes."
+ },
+ "FileVersion": {
+ "$ref": "#/definitions/FileVersion",
+ "description": "Information about the version of image store file."
+ },
+ "ModifiedDate": {
+ "type": "string",
+ "format": "date-time",
+ "description": "The date and time when the image store file was last modified."
+ },
+ "StoreRelativePath": {
+ "type": "string",
+ "description": "The file path relative to the image store root path."
+ }
+ }
+ },
+ "FolderInfo": {
+ "description": "Information about a image store folder. It includes how many files this folder contains and its image store relative path.",
+ "properties": {
+ "StoreRelativePath": {
+ "$ref": "#/definitions/ImageStoreRelativePath",
+ "description": "The remote location within image store. This path is relative to the image store root."
+ },
+ "FileCount": {
+ "type": "string",
+ "description": "The number of files from within the image store folder."
+ }
+ }
+ },
+ "FolderSizeInfo": {
+ "description": "Information of a image store folder size",
+ "properties": {
+ "StoreRelativePath": {
+ "$ref": "#/definitions/ImageStoreRelativePath",
+ "description": "The remote location within image store. This path is relative to the image store root."
+ },
+ "FolderSize": {
+ "type": "string",
+ "description": "The size of folder in bytes."
+ }
+ }
+ },
+ "UsageInfo": {
+ "description": "Information about how much space and how many files in the file system the ImageStore is using in this category",
+ "properties": {
+ "UsedSpace": {
+ "type": "string",
+ "description": "the size of all files in this category"
+ },
+ "FileCount": {
+ "type": "string",
+ "description": "the number of all files in this category"
+ }
+ }
+ },
+ "ImageStoreContent": {
+ "description": "Information about the image store content.",
+ "properties": {
+ "StoreFiles": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/FileInfo"
+ },
+ "description": "The list of image store file info objects represents files found under the given image store relative path."
+ },
+ "StoreFolders": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/FolderInfo"
+ },
+ "description": "The list of image store folder info objects represents subfolders found under the given image store relative path."
+ }
+ }
+ },
+ "ImageStoreCopyDescription": {
+ "description": "Information about how to copy image store content from one image store relative path to another image store relative path.",
+ "required": [
+ "RemoteSource",
+ "RemoteDestination"
+ ],
+ "properties": {
+ "RemoteSource": {
+ "type": "string",
+ "description": "The relative path of source image store content to be copied from."
+ },
+ "RemoteDestination": {
+ "type": "string",
+ "description": "The relative path of destination image store content to be copied to."
+ },
+ "SkipFiles": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "The list of the file names to be skipped for copying."
+ },
+ "CheckMarkFile": {
+ "type": "boolean",
+ "description": "Indicates whether to check mark file during copying. The property is true if checking mark file is required, false otherwise. The mark file is used to check whether the folder is well constructed. If the property is true and mark file does not exist, the copy is skipped."
+ }
+ }
+ },
+ "ImageStoreInfo": {
+ "description": "Information about the ImageStore's resource usage",
+ "properties": {
+ "DiskInfo": {
+ "$ref": "#/definitions/DiskInfo",
+ "description": "disk capacity and available disk space on the node where the ImageStore primary is placed."
+ },
+ "UsedByMetadata": {
+ "$ref": "#/definitions/UsageInfo",
+ "description": "the ImageStore's file system usage for metadata."
+ },
+ "UsedByStaging": {
+ "$ref": "#/definitions/UsageInfo",
+ "description": "The ImageStore's file system usage for staging files that are being uploaded."
+ },
+ "UsedByCopy": {
+ "$ref": "#/definitions/UsageInfo",
+ "description": "the ImageStore's file system usage for copied application and cluster packages. [Removing application and cluster packages](https://docs.microsoft.com/rest/api/servicefabric/sfclient-api-deleteimagestorecontent) will free up this space."
+ },
+ "UsedByRegister": {
+ "$ref": "#/definitions/UsageInfo",
+ "description": "the ImageStore's file system usage for registered and cluster packages. [Unregistering application](https://docs.microsoft.com/rest/api/servicefabric/sfclient-api-unprovisionapplicationtype) and [cluster packages](https://docs.microsoft.com/rest/api/servicefabric/sfclient-api-unprovisionapplicationtype) will free up this space."
+ }
+ }
+ },
+ "InstanceId": {
+ "type": "string",
+ "description": "Id of a stateless service instance. InstanceId is used by Service Fabric to uniquely identify an instance of a partition of a stateless service. It is unique within a partition and does not change for the lifetime of the instance. If the instance has failed over on the same or different node, it will get a different value for the InstanceId."
+ },
+ "CodePackageInstanceId": {
+ "type": "string",
+ "description": "The instance ID for current running entry point. For a code package setup entry point (if specified) runs first and after it finishes main entry point is started. Each time entry point executable is run, its instance id will change."
+ },
+ "HostIsolationMode": {
+ "type": "string",
+ "description": "Specifies the isolation mode of main entry point of a code package when it's host type is ContainerHost. This is specified as part of container host policies in application manifest while importing service manifest.",
+ "enum": [
+ "None",
+ "Process",
+ "HyperV"
+ ],
+ "x-ms-enum": {
+ "name": "HostIsolationMode",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "None",
+ "description": "Indicates the isolation mode is not applicable for given HostType. The value is 0."
+ },
+ {
+ "value": "Process",
+ "description": "This is the default isolation mode for a ContainerHost. The value is 1."
+ },
+ {
+ "value": "HyperV",
+ "description": "Indicates the ContainerHost is a Hyper-V container. This applies to only Windows containers. The value is 2."
+ }
+ ]
+ }
+ },
+ "HostType": {
+ "type": "string",
+ "description": "Specifies the type of host for main entry point of a code package as specified in service manifest.",
+ "enum": [
+ "Invalid",
+ "ExeHost",
+ "ContainerHost"
+ ],
+ "x-ms-enum": {
+ "name": "HostType",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "Invalid",
+ "description": "Indicates the type of host is not known or invalid. The value is 0."
+ },
+ {
+ "value": "ExeHost",
+ "description": "Indicates the host is an executable. The value is 1."
+ },
+ {
+ "value": "ContainerHost",
+ "description": "Indicates the host is a container. The value is 2."
+ }
+ ]
+ }
+ },
+ "RestartDeployedCodePackageDescription": {
+ "description": "Defines description for restarting a deployed code package on Service Fabric node.",
+ "required": [
+ "ServiceManifestName",
+ "CodePackageName",
+ "CodePackageInstanceId"
+ ],
+ "properties": {
+ "ServiceManifestName": {
+ "$ref": "#/definitions/ServiceManifestName",
+ "description": "The name of service manifest that specified this code package."
+ },
+ "ServicePackageActivationId": {
+ "$ref": "#/definitions/ServicePackageActivationId",
+ "description": "The ActivationId of a deployed service package. If ServicePackageActivationMode specified at the time of creating the service\nis 'SharedProcess' (or if it is not specified, in which case it defaults to 'SharedProcess'), then value of ServicePackageActivationId\nis always an empty string."
+ },
+ "CodePackageName": {
+ "$ref": "#/definitions/CodePackageName",
+ "description": "The name of the code package defined in the service manifest."
+ },
+ "CodePackageInstanceId": {
+ "$ref": "#/definitions/CodePackageInstanceId",
+ "description": "The instance ID for currently running entry point. For a code package setup entry point (if specified) runs first and after it finishes main entry point is started.\nEach time entry point executable is run, its instance ID will change. If 0 is passed in as the code package instance ID, the API will restart the code package with whatever instance ID it is currently running.\nIf an instance ID other than 0 is passed in, the API will restart the code package only if the current Instance ID matches the passed in instance ID.\nNote, passing in the exact instance ID (not 0) in the API is safer, because if ensures at most one restart of the code package."
+ }
+ }
+ },
+ "DeployedServiceTypeInfo": {
+ "description": "Information about service type deployed on a node, information such as the status of the service type registration on a node.",
+ "properties": {
+ "ServiceTypeName": {
+ "$ref": "#/definitions/ServiceTypeName",
+ "description": "Name of the service type as specified in the service manifest."
+ },
+ "ServiceManifestName": {
+ "$ref": "#/definitions/ServiceManifestName",
+ "description": "The name of the service manifest in which this service type is defined."
+ },
+ "CodePackageName": {
+ "$ref": "#/definitions/CodePackageName",
+ "description": "The name of the code package that registered the service type."
+ },
+ "Status": {
+ "$ref": "#/definitions/ServiceTypeRegistrationStatus",
+ "description": "The status of the service type registration on the node."
+ },
+ "ServicePackageActivationId": {
+ "$ref": "#/definitions/ServicePackageActivationId",
+ "description": "The ActivationId of a deployed service package. If ServicePackageActivationMode specified at the time of creating the service\nis 'SharedProcess' (or if it is not specified, in which case it defaults to 'SharedProcess'), then value of ServicePackageActivationId\nis always an empty string."
+ }
+ }
+ },
+ "DeployedServiceTypeInfoList": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/DeployedServiceTypeInfo"
+ },
+ "description": "List of information about service type deployed on a node."
+ },
+ "ServiceTypeRegistrationStatus": {
+ "type": "string",
+ "description": "The status of the service type registration on the node.",
+ "enum": [
+ "Invalid",
+ "Disabled",
+ "Enabled",
+ "Registered"
+ ],
+ "x-ms-enum": {
+ "name": "ServiceTypeRegistrationStatus",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "Invalid",
+ "description": "Indicates the registration status is invalid. All Service Fabric enumerations have the invalid type. The value is zero."
+ },
+ {
+ "value": "Disabled",
+ "description": "Indicates that the service type is disabled on this node. A type gets disabled when there are too many failures of the code package hosting the service type. If the service type is disabled, new replicas of that service type will not be placed on the node until it is enabled again. The service type is enabled again after the process hosting it comes up and re-registers the type or a preconfigured time interval has passed. The value is 1."
+ },
+ {
+ "value": "Enabled",
+ "description": "Indicates that the service type is enabled on this node. Replicas of this service type can be placed on this node when the code package registers the service type. The value is 2."
+ },
+ {
+ "value": "Registered",
+ "description": "Indicates that the service type is enabled and registered on the node by a code package. Replicas of this service type can now be placed on this node. The value is 3."
+ }
+ ]
+ }
+ },
+ "ServiceEndpointRole": {
+ "type": "string",
+ "description": "The role of the replica where the endpoint is reported.",
+ "enum": [
+ "Invalid",
+ "Stateless",
+ "StatefulPrimary",
+ "StatefulSecondary"
+ ],
+ "x-ms-enum": {
+ "name": "ServiceEndpointRole",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "Invalid",
+ "description": "Indicates the service endpoint role is invalid. All Service Fabric enumerations have the invalid type. The value is zero."
+ },
+ {
+ "value": "Stateless",
+ "description": "Indicates that the service endpoint is of a stateless service. The value is 1."
+ },
+ {
+ "value": "StatefulPrimary",
+ "description": "Indicates that the service endpoint is of a primary replica of a stateful service. The value is 2."
+ },
+ {
+ "value": "StatefulSecondary",
+ "description": "Indicates that the service endpoint is of a secondary replica of a stateful service. The value is 3."
+ }
+ ]
+ }
+ },
+ "ResolvedServiceEndpoint": {
+ "description": "Endpoint of a resolved service partition.",
+ "properties": {
+ "Kind": {
+ "$ref": "#/definitions/ServiceEndpointRole",
+ "description": "The role of the replica where the endpoint is reported."
+ },
+ "Address": {
+ "type": "string",
+ "description": "The address of the endpoint. If the endpoint has multiple listeners the address is a JSON object with one property per listener with the value as the address of that listener."
+ }
+ }
+ },
+ "ResolvedServicePartition": {
+ "description": "Information about a service partition and its associated endpoints.",
+ "required": [
+ "Name",
+ "PartitionInformation",
+ "Endpoints",
+ "Version"
+ ],
+ "properties": {
+ "Name": {
+ "$ref": "#/definitions/ServiceName",
+ "description": "The full name of the service with 'fabric:' URI scheme."
+ },
+ "PartitionInformation": {
+ "$ref": "#/definitions/PartitionInformation",
+ "description": "A representation of the resolved partition."
+ },
+ "Endpoints": {
+ "$ref": "#/definitions/ResolvedServiceEndpointList",
+ "description": "List of resolved service endpoints of a service partition."
+ },
+ "Version": {
+ "type": "string",
+ "description": "The version of this resolved service partition result. This version should be passed in the next time the ResolveService call is made via the PreviousRspVersion query parameter."
+ }
+ }
+ },
+ "ResolvedServiceEndpointList": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ResolvedServiceEndpoint"
+ },
+ "description": "List of resolved service endpoints of a service partition."
+ },
+ "InvokeDataLossResult": {
+ "description": "Represents information about an operation in a terminal state (Completed or Faulted).",
+ "properties": {
+ "ErrorCode": {
+ "type": "integer",
+ "format": "int32",
+ "description": "If OperationState is Completed, this is 0. If OperationState is Faulted, this is an error code indicating the reason."
+ },
+ "SelectedPartition": {
+ "$ref": "#/definitions/SelectedPartition",
+ "description": "This class returns information about the partition that the user-induced operation acted upon."
+ }
+ }
+ },
+ "InvokeQuorumLossResult": {
+ "description": "Represents information about an operation in a terminal state (Completed or Faulted).",
+ "properties": {
+ "ErrorCode": {
+ "type": "integer",
+ "format": "int32",
+ "description": "If OperationState is Completed, this is 0. If OperationState is Faulted, this is an error code indicating the reason."
+ },
+ "SelectedPartition": {
+ "$ref": "#/definitions/SelectedPartition",
+ "description": "This class returns information about the partition that the user-induced operation acted upon."
+ }
+ }
+ },
+ "NodeResult": {
+ "description": "Contains information about a node that was targeted by a user-induced operation.",
+ "properties": {
+ "NodeName": {
+ "$ref": "#/definitions/NodeName",
+ "description": "The name of a Service Fabric node."
+ },
+ "NodeInstanceId": {
+ "type": "string",
+ "description": "The node instance id."
+ }
+ }
+ },
+ "NodeTransitionProgress": {
+ "description": "Information about an NodeTransition operation. This class contains an OperationState and a NodeTransitionResult. The NodeTransitionResult is not valid until OperationState\nis Completed or Faulted.",
+ "properties": {
+ "State": {
+ "$ref": "#/definitions/OperationState",
+ "description": "The state of the operation."
+ },
+ "NodeTransitionResult": {
+ "$ref": "#/definitions/NodeTransitionResult",
+ "description": "Represents information about an operation in a terminal state (Completed or Faulted)."
+ }
+ }
+ },
+ "NodeTransitionResult": {
+ "description": "Represents information about an operation in a terminal state (Completed or Faulted).",
+ "properties": {
+ "ErrorCode": {
+ "type": "integer",
+ "format": "int32",
+ "description": "If OperationState is Completed, this is 0. If OperationState is Faulted, this is an error code indicating the reason."
+ },
+ "NodeResult": {
+ "$ref": "#/definitions/NodeResult",
+ "description": "Contains information about a node that was targeted by a user-induced operation."
+ }
+ }
+ },
+ "OperationId": {
+ "type": "string",
+ "format": "uuid",
+ "description": "A GUID that identifies a call to this API. This is also passed into the corresponding GetProgress API."
+ },
+ "OperationState": {
+ "type": "string",
+ "description": "The state of the operation.",
+ "enum": [
+ "Invalid",
+ "Running",
+ "RollingBack",
+ "Completed",
+ "Faulted",
+ "Cancelled",
+ "ForceCancelled"
+ ],
+ "x-ms-enum": {
+ "name": "OperationState",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "Invalid",
+ "description": "The operation state is invalid."
+ },
+ {
+ "value": "Running",
+ "description": "The operation is in progress."
+ },
+ {
+ "value": "RollingBack",
+ "description": "The operation is rolling back internal system state because it encountered a fatal error or was cancelled by the user. \"RollingBack\" does not refer to user state. For example, if CancelOperation is called on a command of type PartitionDataLoss, state of \"RollingBack\" does not mean service data is being restored (assuming the command has progressed far enough to cause data loss). It means the system is rolling back/cleaning up internal system state associated with the command."
+ },
+ {
+ "value": "Completed",
+ "description": "The operation has completed successfully and is no longer running."
+ },
+ {
+ "value": "Faulted",
+ "description": "The operation has failed and is no longer running."
+ },
+ {
+ "value": "Cancelled",
+ "description": "The operation was cancelled by the user using CancelOperation, and is no longer running."
+ },
+ {
+ "value": "ForceCancelled",
+ "description": "The operation was cancelled by the user using CancelOperation, with the force parameter set to true. It is no longer running. Refer to CancelOperation for more details."
+ }
+ ]
+ }
+ },
+ "OperationStatus": {
+ "description": "Contains the OperationId, OperationState, and OperationType for user-induced operations.",
+ "properties": {
+ "OperationId": {
+ "$ref": "#/definitions/OperationId",
+ "description": "A GUID that identifies a call to this API. This is also passed into the corresponding GetProgress API."
+ },
+ "State": {
+ "$ref": "#/definitions/OperationState",
+ "description": "The state of the operation."
+ },
+ "Type": {
+ "$ref": "#/definitions/OperationType",
+ "description": "The type of the operation."
+ }
+ }
+ },
+ "OperationStatusList": {
+ "type": "array",
+ "description": "A list of OperationStatus objects.",
+ "items": {
+ "$ref": "#/definitions/OperationStatus"
+ }
+ },
+ "OperationType": {
+ "type": "string",
+ "description": "The type of the operation.",
+ "enum": [
+ "Invalid",
+ "PartitionDataLoss",
+ "PartitionQuorumLoss",
+ "PartitionRestart",
+ "NodeTransition"
+ ],
+ "x-ms-enum": {
+ "name": "OperationType",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "Invalid",
+ "description": "The operation state is invalid."
+ },
+ {
+ "value": "PartitionDataLoss",
+ "description": "An operation started using the StartDataLoss API."
+ },
+ {
+ "value": "PartitionQuorumLoss",
+ "description": "An operation started using the StartQuorumLoss API."
+ },
+ {
+ "value": "PartitionRestart",
+ "description": "An operation started using the StartPartitionRestart API."
+ },
+ {
+ "value": "NodeTransition",
+ "description": "An operation started using the StartNodeTransition API."
+ }
+ ]
+ }
+ },
+ "PartitionDataLossProgress": {
+ "description": "Information about a partition data loss user-induced operation.",
+ "properties": {
+ "State": {
+ "$ref": "#/definitions/OperationState",
+ "description": "The state of the operation."
+ },
+ "InvokeDataLossResult": {
+ "$ref": "#/definitions/InvokeDataLossResult",
+ "description": "Represents information about an operation in a terminal state (Completed or Faulted)."
+ }
+ }
+ },
+ "PartitionQuorumLossProgress": {
+ "description": "Information about a partition quorum loss user-induced operation.",
+ "properties": {
+ "State": {
+ "$ref": "#/definitions/OperationState",
+ "description": "The state of the operation."
+ },
+ "InvokeQuorumLossResult": {
+ "$ref": "#/definitions/InvokeQuorumLossResult",
+ "description": "Represents information about an operation in a terminal state (Completed or Faulted)."
+ }
+ }
+ },
+ "PartitionRestartProgress": {
+ "description": "Information about a partition restart user-induced operation.",
+ "properties": {
+ "State": {
+ "$ref": "#/definitions/OperationState",
+ "description": "The state of the operation."
+ },
+ "RestartPartitionResult": {
+ "$ref": "#/definitions/RestartPartitionResult",
+ "description": "Represents information about an operation in a terminal state (Completed or Faulted)."
+ }
+ }
+ },
+ "RestartPartitionResult": {
+ "description": "Represents information about an operation in a terminal state (Completed or Faulted).",
+ "properties": {
+ "ErrorCode": {
+ "type": "integer",
+ "format": "int32",
+ "description": "If OperationState is Completed, this is 0. If OperationState is Faulted, this is an error code indicating the reason."
+ },
+ "SelectedPartition": {
+ "$ref": "#/definitions/SelectedPartition",
+ "description": "This class returns information about the partition that the user-induced operation acted upon."
+ }
+ }
+ },
+ "SelectedPartition": {
+ "description": "This class returns information about the partition that the user-induced operation acted upon.",
+ "properties": {
+ "ServiceName": {
+ "$ref": "#/definitions/ServiceName",
+ "description": "The name of the service the partition belongs to."
+ },
+ "PartitionId": {
+ "$ref": "#/definitions/PartitionId",
+ "description": "An internal ID used by Service Fabric to uniquely identify a partition. This is a randomly generated GUID when the service was created. The partition ID is unique and does not change for the lifetime of the service. If the same service was deleted and recreated the IDs of its partitions would be different."
+ }
+ }
+ },
+ "DeployServicePackageToNodeDescription": {
+ "description": "Defines description for downloading packages associated with a service manifest to image cache on a Service Fabric node.",
+ "properties": {
+ "ServiceManifestName": {
+ "$ref": "#/definitions/ServiceManifestName",
+ "description": "The name of service manifest whose packages need to be downloaded."
+ },
+ "ApplicationTypeName": {
+ "$ref": "#/definitions/ApplicationTypeName",
+ "description": "The application type name as defined in the application manifest."
+ },
+ "ApplicationTypeVersion": {
+ "$ref": "#/definitions/ApplicationTypeVersion",
+ "description": "The version of the application type as defined in the application manifest."
+ },
+ "NodeName": {
+ "$ref": "#/definitions/NodeName",
+ "description": "The name of a Service Fabric node."
+ },
+ "PackageSharingPolicy": {
+ "$ref": "#/definitions/PackageSharingPolicyInfoList",
+ "description": "List of package sharing policy information."
+ }
+ },
+ "required": [
+ "ServiceManifestName",
+ "ApplicationTypeName",
+ "ApplicationTypeVersion",
+ "NodeName"
+ ]
+ },
+ "PackageSharingPolicyInfo": {
+ "description": "Represents a policy for the package sharing.",
+ "properties": {
+ "SharedPackageName": {
+ "type": "string",
+ "description": "The name of code, configuration or data package that should be shared."
+ },
+ "PackageSharingScope": {
+ "$ref": "#/definitions/PackageSharingPolicyScope",
+ "description": "Represents the scope for PackageSharingPolicy. This is specified during DeployServicePackageToNode operation."
+ }
+ }
+ },
+ "PackageSharingPolicyInfoList": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/PackageSharingPolicyInfo"
+ },
+ "description": "List of package sharing policy information."
+ },
+ "PackageSharingPolicyScope": {
+ "type": "string",
+ "description": "Represents the scope for PackageSharingPolicy. This is specified during DeployServicePackageToNode operation.",
+ "enum": [
+ "None",
+ "All",
+ "Code",
+ "Config",
+ "Data"
+ ],
+ "x-ms-enum": {
+ "name": "PackageSharingPolicyScope",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "None",
+ "description": "No package sharing policy scope. The value is 0."
+ },
+ {
+ "value": "All",
+ "description": "Share all code, config and data packages from corresponding service manifest. The value is 1."
+ },
+ {
+ "value": "Code",
+ "description": "Share all code packages from corresponding service manifest. The value is 2."
+ },
+ {
+ "value": "Config",
+ "description": "Share all config packages from corresponding service manifest. The value is 3."
+ },
+ {
+ "value": "Data",
+ "description": "Share all data packages from corresponding service manifest. The value is 4."
+ }
+ ]
+ }
+ },
+ "ResumeApplicationUpgradeDescription": {
+ "description": "Describes the parameters for resuming an unmonitored manual Service Fabric application upgrade",
+ "properties": {
+ "UpgradeDomainName": {
+ "type": "string",
+ "description": "The name of the upgrade domain in which to resume the upgrade."
+ }
+ },
+ "required": [
+ "UpgradeDomainName"
+ ]
+ },
+ "ApplicationUpgradeUpdateDescription": {
+ "description": "Describes the parameters for updating an ongoing application upgrade.",
+ "properties": {
+ "Name": {
+ "$ref": "#/definitions/ApplicationName",
+ "description": "The name of the application, including the 'fabric:' URI scheme."
+ },
+ "UpgradeKind": {
+ "$ref": "#/definitions/UpgradeKind",
+ "description": "The kind of upgrade out of the following possible values."
+ },
+ "ApplicationHealthPolicy": {
+ "$ref": "#/definitions/ApplicationHealthPolicy",
+ "description": "Defines a health policy used to evaluate the health of an application or one of its children entities."
+ },
+ "UpdateDescription": {
+ "$ref": "#/definitions/RollingUpgradeUpdateDescription",
+ "description": "Describes the parameters for updating a rolling upgrade of application or cluster."
+ }
+ },
+ "required": [
+ "Name",
+ "UpgradeKind"
+ ]
+ },
+ "RollingUpgradeUpdateDescription": {
+ "description": "Describes the parameters for updating a rolling upgrade of application or cluster.",
+ "properties": {
+ "RollingUpgradeMode": {
+ "$ref": "#/definitions/UpgradeMode",
+ "description": "The mode used to monitor health during a rolling upgrade. The values are UnmonitoredAuto, UnmonitoredManual, and Monitored."
+ },
+ "ForceRestart": {
+ "$ref": "#/definitions/ForceRestart",
+ "description": "If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data)."
+ },
+ "ReplicaSetCheckTimeoutInMilliseconds": {
+ "$ref": "#/definitions/UpgradeReplicaSetCheckTimeout",
+ "description": "The maximum amount of time to block processing of an upgrade domain and prevent loss of availability when there are unexpected issues. When this timeout expires, processing of the upgrade domain will proceed regardless of availability loss issues. The timeout is reset at the start of each upgrade domain. Valid values are between 0 and 42949672925 inclusive. (unsigned 32-bit integer)."
+ },
+ "FailureAction": {
+ "$ref": "#/definitions/FailureAction",
+ "description": "The compensating action to perform when a Monitored upgrade encounters monitoring policy or health policy violations.\nInvalid indicates the failure action is invalid. Rollback specifies that the upgrade will start rolling back automatically.\nManual indicates that the upgrade will switch to UnmonitoredManual upgrade mode."
+ },
+ "HealthCheckWaitDurationInMilliseconds": {
+ "$ref": "#/definitions/HealthCheckWaitDuration",
+ "description": "The amount of time to wait after completing an upgrade domain before applying health policies. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds."
+ },
+ "HealthCheckStableDurationInMilliseconds": {
+ "$ref": "#/definitions/HealthCheckStableDuration",
+ "description": "The amount of time that the application or cluster must remain healthy before the upgrade proceeds to the next upgrade domain. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds."
+ },
+ "HealthCheckRetryTimeoutInMilliseconds": {
+ "$ref": "#/definitions/HealthCheckRetryTimeout",
+ "description": "The amount of time to retry health evaluation when the application or cluster is unhealthy before FailureAction is executed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds."
+ },
+ "UpgradeTimeoutInMilliseconds": {
+ "$ref": "#/definitions/UpgradeTimeout",
+ "description": "The amount of time the overall upgrade has to complete before FailureAction is executed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds."
+ },
+ "UpgradeDomainTimeoutInMilliseconds": {
+ "$ref": "#/definitions/UpgradeDomainTimeout",
+ "description": "The amount of time each upgrade domain has to complete before FailureAction is executed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds."
+ },
+ "InstanceCloseDelayDurationInSeconds": {
+ "$ref": "#/definitions/InstanceCloseDelayDurationInSeconds",
+ "description": "Duration in seconds, to wait before a stateless instance is closed, to allow the active requests to drain gracefully. This would be effective when the instance is closing during the application/cluster\nupgrade, only for those instances which have a non-zero delay duration configured in the service description. See InstanceCloseDelayDurationSeconds property in $ref: \"#/definitions/StatelessServiceDescription.yaml\" for details.\nNote, the default value of InstanceCloseDelayDurationInSeconds is 4294967295, which indicates that the behavior will entirely depend on the delay configured in the stateless service description."
+ }
+ },
+ "required": [
+ "RollingUpgradeMode"
+ ]
+ },
+ "NameDescription": {
+ "description": "Describes a Service Fabric name.",
+ "properties": {
+ "Name": {
+ "$ref": "#/definitions/FabricName",
+ "description": "The Service Fabric name, including the 'fabric:' URI scheme."
+ }
+ },
+ "required": [
+ "Name"
+ ]
+ },
+ "FabricName": {
+ "type": "string",
+ "description": "The Service Fabric name, including the 'fabric:' URI scheme."
+ },
+ "PagedSubNameInfoList": {
+ "description": "A paged list of Service Fabric names. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.",
+ "properties": {
+ "ContinuationToken": {
+ "$ref": "#/definitions/ContinuationToken",
+ "description": "The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token is not included in the response."
+ },
+ "IsConsistent": {
+ "type": "boolean",
+ "description": "Indicates whether any name under the given name has been modified during the enumeration. If there was a modification, this property value is false."
+ },
+ "SubNames": {
+ "type": "array",
+ "description": "List of the child names.",
+ "items": {
+ "$ref": "#/definitions/FabricName"
+ }
+ }
+ }
+ },
+ "PropertyValueKind": {
+ "type": "string",
+ "description": "The kind of property, determined by the type of data. Following are the possible values.",
+ "enum": [
+ "Invalid",
+ "Binary",
+ "Int64",
+ "Double",
+ "String",
+ "Guid"
+ ],
+ "x-ms-enum": {
+ "name": "PropertyValueKind",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "Invalid",
+ "description": "Indicates the property is invalid. All Service Fabric enumerations have the invalid type. The value is zero."
+ },
+ {
+ "value": "Binary",
+ "description": "The data inside the property is a binary blob. The value is 1."
+ },
+ {
+ "value": "Int64",
+ "description": "The data inside the property is an int64. The value is 2."
+ },
+ {
+ "value": "Double",
+ "description": "The data inside the property is a double. The value is 3."
+ },
+ {
+ "value": "String",
+ "description": "The data inside the property is a string. The value is 4."
+ },
+ {
+ "value": "Guid",
+ "description": "The data inside the property is a guid. The value is 5."
+ }
+ ]
+ }
+ },
+ "PropertyValue": {
+ "discriminator": "Kind",
+ "description": "Describes a Service Fabric property value.",
+ "properties": {
+ "Kind": {
+ "$ref": "#/definitions/PropertyValueKind",
+ "description": "The kind of property, determined by the type of data. Following are the possible values."
+ }
+ },
+ "required": [
+ "Kind"
+ ]
+ },
+ "BinaryPropertyValue": {
+ "description": "Describes a Service Fabric property value of type Binary.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/PropertyValue"
+ }
+ ],
+ "x-ms-discriminator-value": "Binary",
+ "required": [
+ "Data"
+ ],
+ "properties": {
+ "Data": {
+ "$ref": "#/definitions/ByteArray",
+ "description": "Array of bytes to be sent as an integer array. Each element of array is a number between 0 and 255."
+ }
+ }
+ },
+ "Int64PropertyValue": {
+ "description": "Describes a Service Fabric property value of type Int64.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/PropertyValue"
+ }
+ ],
+ "x-ms-discriminator-value": "Int64",
+ "required": [
+ "Data"
+ ],
+ "properties": {
+ "Data": {
+ "type": "string",
+ "description": "The data of the property value."
+ }
+ }
+ },
+ "DoublePropertyValue": {
+ "description": "Describes a Service Fabric property value of type Double.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/PropertyValue"
+ }
+ ],
+ "x-ms-discriminator-value": "Double",
+ "required": [
+ "Data"
+ ],
+ "properties": {
+ "Data": {
+ "type": "number",
+ "format": "double",
+ "description": "The data of the property value."
+ }
+ }
+ },
+ "StringPropertyValue": {
+ "description": "Describes a Service Fabric property value of type String.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/PropertyValue"
+ }
+ ],
+ "x-ms-discriminator-value": "String",
+ "required": [
+ "Data"
+ ],
+ "properties": {
+ "Data": {
+ "type": "string",
+ "description": "The data of the property value."
+ }
+ }
+ },
+ "GuidPropertyValue": {
+ "description": "Describes a Service Fabric property value of type Guid.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/PropertyValue"
+ }
+ ],
+ "x-ms-discriminator-value": "Guid",
+ "required": [
+ "Data"
+ ],
+ "properties": {
+ "Data": {
+ "type": "string",
+ "format": "uuid",
+ "description": "The data of the property value."
+ }
+ }
+ },
+ "PropertyInfo": {
+ "description": "Information about a Service Fabric property.",
+ "properties": {
+ "Name": {
+ "$ref": "#/definitions/PropertyName",
+ "description": "The name of the Service Fabric property."
+ },
+ "Value": {
+ "$ref": "#/definitions/PropertyValue",
+ "description": "Describes a Service Fabric property value."
+ },
+ "Metadata": {
+ "$ref": "#/definitions/PropertyMetadata",
+ "description": "The metadata associated with a property, including the property's name."
+ }
+ },
+ "required": [
+ "Name",
+ "Metadata"
+ ]
+ },
+ "PagedPropertyInfoList": {
+ "description": "The paged list of Service Fabric properties under a given name. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.",
+ "properties": {
+ "ContinuationToken": {
+ "$ref": "#/definitions/ContinuationToken",
+ "description": "The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token is not included in the response."
+ },
+ "IsConsistent": {
+ "type": "boolean",
+ "description": "Indicates whether any property under the given name has been modified during the enumeration. If there was a modification, this property value is false."
+ },
+ "Properties": {
+ "type": "array",
+ "description": "List of property information.",
+ "items": {
+ "$ref": "#/definitions/PropertyInfo"
+ }
+ }
+ }
+ },
+ "PropertyDescription": {
+ "description": "Description of a Service Fabric property.",
+ "properties": {
+ "PropertyName": {
+ "$ref": "#/definitions/PropertyName",
+ "description": "The name of the Service Fabric property."
+ },
+ "CustomTypeId": {
+ "$ref": "#/definitions/PropertyCustomTypeId",
+ "description": "The property's custom type ID. Using this property, the user is able to tag the type of the value of the property."
+ },
+ "Value": {
+ "$ref": "#/definitions/PropertyValue",
+ "description": "Describes a Service Fabric property value."
+ }
+ },
+ "required": [
+ "PropertyName",
+ "Value"
+ ]
+ },
+ "PropertyName": {
+ "type": "string",
+ "description": "The name of the Service Fabric property."
+ },
+ "PropertyMetadata": {
+ "description": "The metadata associated with a property, including the property's name.",
+ "properties": {
+ "TypeId": {
+ "$ref": "#/definitions/PropertyValueKind",
+ "description": "The kind of property, determined by the type of data. Following are the possible values."
+ },
+ "CustomTypeId": {
+ "$ref": "#/definitions/PropertyCustomTypeId",
+ "description": "The property's custom type ID."
+ },
+ "Parent": {
+ "$ref": "#/definitions/FabricName",
+ "description": "The name of the parent Service Fabric Name for the property. It could be thought of as the name-space/table under which the property exists."
+ },
+ "SizeInBytes": {
+ "type": "integer",
+ "description": "The length of the serialized property value."
+ },
+ "LastModifiedUtcTimestamp": {
+ "type": "string",
+ "format": "date-time",
+ "description": "Represents when the Property was last modified. Only write operations will cause this field to be updated."
+ },
+ "SequenceNumber": {
+ "type": "string",
+ "description": "The version of the property. Every time a property is modified, its sequence number is increased."
+ }
+ }
+ },
+ "PropertyCustomTypeId": {
+ "type": "string",
+ "description": "The property's custom type ID. Using this property, the user is able to tag the type of the value of the property."
+ },
+ "PropertyBatchDescriptionList": {
+ "description": "Describes a list of property batch operations to be executed. Either all or none of the operations will be committed.",
+ "properties": {
+ "Operations": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/PropertyBatchOperation"
+ },
+ "description": "A list of the property batch operations to be executed."
+ }
+ }
+ },
+ "PropertyBatchOperationKind": {
+ "type": "string",
+ "description": "The kind of property batch operation, determined by the operation to be performed. The following are the possible values.",
+ "enum": [
+ "Invalid",
+ "Put",
+ "Get",
+ "CheckExists",
+ "CheckSequence",
+ "Delete",
+ "CheckValue"
+ ],
+ "x-ms-enum": {
+ "name": "PropertyBatchOperationKind",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "Invalid",
+ "description": "Indicates the property operation is invalid. All Service Fabric enumerations have the invalid type. The value is zero."
+ },
+ {
+ "value": "Put",
+ "description": "The operation will create or edit a property. The value is 1."
+ },
+ {
+ "value": "Get",
+ "description": "The operation will get a property. The value is 2."
+ },
+ {
+ "value": "CheckExists",
+ "description": "The operation will check that a property exists or doesn't exists, depending on the provided value. The value is 3."
+ },
+ {
+ "value": "CheckSequence",
+ "description": "The operation will ensure that the sequence number is equal to the provided value. The value is 4."
+ },
+ {
+ "value": "Delete",
+ "description": "The operation will delete a property. The value is 5."
+ },
+ {
+ "value": "CheckValue",
+ "description": "The operation will ensure that the value of a property is equal to the provided value. The value is 7."
+ }
+ ]
+ }
+ },
+ "PropertyBatchOperation": {
+ "discriminator": "Kind",
+ "description": "Represents the base type for property operations that can be put into a batch and submitted.",
+ "properties": {
+ "Kind": {
+ "$ref": "#/definitions/PropertyBatchOperationKind",
+ "description": "The kind of property batch operation, determined by the operation to be performed. The following are the possible values."
+ },
+ "PropertyName": {
+ "$ref": "#/definitions/PropertyName",
+ "description": "The name of the Service Fabric property."
+ }
+ },
+ "required": [
+ "Kind",
+ "PropertyName"
+ ]
+ },
+ "CheckExistsPropertyBatchOperation": {
+ "description": "Represents a PropertyBatchOperation that compares the Boolean existence of a property with the Exists argument.\nThe PropertyBatchOperation operation fails if the property's existence is not equal to the Exists argument.\nThe CheckExistsPropertyBatchOperation is generally used as a precondition for the write operations in the batch.\nNote that if one PropertyBatchOperation in a PropertyBatch fails,\nthe entire batch fails and cannot be committed in a transactional manner.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/PropertyBatchOperation"
+ }
+ ],
+ "x-ms-discriminator-value": "CheckExists",
+ "properties": {
+ "Exists": {
+ "type": "boolean",
+ "description": "Whether or not the property should exist for the operation to pass."
+ }
+ },
+ "required": [
+ "Exists"
+ ]
+ },
+ "CheckSequencePropertyBatchOperation": {
+ "description": "Compares the Sequence Number of a property with the SequenceNumber argument.\nA property's sequence number can be thought of as that property's version.\nEvery time the property is modified, its sequence number is increased.\nThe sequence number can be found in a property's metadata.\nThe comparison fails if the sequence numbers are not equal.\nCheckSequencePropertyBatchOperation is generally used as a precondition for the write operations in the batch.\nNote that if one PropertyBatchOperation in a PropertyBatch fails,\nthe entire batch fails and cannot be committed in a transactional manner.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/PropertyBatchOperation"
+ }
+ ],
+ "x-ms-discriminator-value": "CheckSequence",
+ "properties": {
+ "SequenceNumber": {
+ "type": "string",
+ "description": "The expected sequence number."
+ }
+ },
+ "required": [
+ "SequenceNumber"
+ ]
+ },
+ "CheckValuePropertyBatchOperation": {
+ "description": "Represents a PropertyBatchOperation that compares the value of the property with the expected value.\nThe CheckValuePropertyBatchOperation is generally used as a precondition for the write operations in the batch.\nNote that if one PropertyBatchOperation in a PropertyBatch fails,\nthe entire batch fails and cannot be committed in a transactional manner.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/PropertyBatchOperation"
+ }
+ ],
+ "x-ms-discriminator-value": "CheckValue",
+ "properties": {
+ "Value": {
+ "$ref": "#/definitions/PropertyValue",
+ "description": "The expected property value."
+ }
+ },
+ "required": [
+ "Value"
+ ]
+ },
+ "DeletePropertyBatchOperation": {
+ "description": "Represents a PropertyBatchOperation that deletes a specified property if it exists.\nNote that if one PropertyBatchOperation in a PropertyBatch fails,\nthe entire batch fails and cannot be committed in a transactional manner.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/PropertyBatchOperation"
+ }
+ ],
+ "x-ms-discriminator-value": "Delete"
+ },
+ "GetPropertyBatchOperation": {
+ "description": "Represents a PropertyBatchOperation that gets the specified property if it exists.\nNote that if one PropertyBatchOperation in a PropertyBatch fails,\nthe entire batch fails and cannot be committed in a transactional manner.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/PropertyBatchOperation"
+ }
+ ],
+ "x-ms-discriminator-value": "Get",
+ "properties": {
+ "IncludeValue": {
+ "type": "boolean",
+ "default": false,
+ "description": "Whether or not to return the property value with the metadata.\nTrue if values should be returned with the metadata; False to return only property metadata."
+ }
+ }
+ },
+ "PutPropertyBatchOperation": {
+ "description": "Puts the specified property under the specified name.\nNote that if one PropertyBatchOperation in a PropertyBatch fails,\nthe entire batch fails and cannot be committed in a transactional manner.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/PropertyBatchOperation"
+ }
+ ],
+ "x-ms-discriminator-value": "Put",
+ "properties": {
+ "Value": {
+ "$ref": "#/definitions/PropertyValue",
+ "description": "Describes a Service Fabric property value."
+ },
+ "CustomTypeId": {
+ "$ref": "#/definitions/PropertyCustomTypeId",
+ "description": "The property's custom type ID. Using this property, the user is able to tag the type of the value of the property."
+ }
+ },
+ "required": [
+ "Value"
+ ]
+ },
+ "PropertyBatchInfoKind": {
+ "type": "string",
+ "description": "The kind of property batch info, determined by the results of a property batch. The following are the possible values.",
+ "enum": [
+ "Invalid",
+ "Successful",
+ "Failed"
+ ],
+ "x-ms-enum": {
+ "name": "PropertyBatchInfoKind",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "Invalid",
+ "description": "Indicates the property batch info is invalid. All Service Fabric enumerations have the invalid type."
+ },
+ {
+ "value": "Successful",
+ "description": "The property batch succeeded."
+ },
+ {
+ "value": "Failed",
+ "description": "The property batch failed."
+ }
+ ]
+ }
+ },
+ "PropertyBatchInfo": {
+ "discriminator": "Kind",
+ "description": "Information about the results of a property batch.",
+ "properties": {
+ "Kind": {
+ "$ref": "#/definitions/PropertyBatchInfoKind",
+ "description": "The kind of property batch info, determined by the results of a property batch. The following are the possible values."
+ }
+ },
+ "required": [
+ "Kind"
+ ]
+ },
+ "SuccessfulPropertyBatchInfo": {
+ "description": "Derived from PropertyBatchInfo. Represents the property batch succeeding. Contains the results of any \"Get\" operations in the batch.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/PropertyBatchInfo"
+ }
+ ],
+ "x-ms-discriminator-value": "Successful",
+ "properties": {
+ "Properties": {
+ "additionalProperties": {
+ "$ref": "#/definitions/PropertyInfo"
+ },
+ "description": "A map containing the properties that were requested through any \"Get\" property batch operations. The key represents the index of the \"Get\" operation in the original request, in string form. The value is the property. If a property is not found, it will not be in the map."
+ }
+ }
+ },
+ "FailedPropertyBatchInfo": {
+ "description": "Derived from PropertyBatchInfo. Represents the property batch failing. Contains information about the specific batch failure.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/PropertyBatchInfo"
+ }
+ ],
+ "x-ms-discriminator-value": "Failed",
+ "properties": {
+ "ErrorMessage": {
+ "type": "string",
+ "description": "The error message of the failed operation. Describes the exception thrown due to the first unsuccessful operation in the property batch."
+ },
+ "OperationIndex": {
+ "type": "integer",
+ "description": "The index of the unsuccessful operation in the property batch."
+ }
+ }
+ },
+ "EntityKind": {
+ "type": "string",
+ "description": "The entity type of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc.",
+ "enum": [
+ "Invalid",
+ "Node",
+ "Partition",
+ "Service",
+ "Application",
+ "Replica",
+ "DeployedApplication",
+ "DeployedServicePackage",
+ "Cluster"
+ ],
+ "x-ms-enum": {
+ "name": "EntityKind",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "Invalid",
+ "description": "Indicates an invalid entity kind. All Service Fabric enumerations have the invalid type. The value is zero."
+ },
+ {
+ "value": "Node",
+ "description": "Indicates the entity is a Service Fabric node. The value is 1."
+ },
+ {
+ "value": "Partition",
+ "description": "Indicates the entity is a Service Fabric partition. The value is 2."
+ },
+ {
+ "value": "Service",
+ "description": "Indicates the entity is a Service Fabric service. The value is 3."
+ },
+ {
+ "value": "Application",
+ "description": "Indicates the entity is a Service Fabric application. The value is 4."
+ },
+ {
+ "value": "Replica",
+ "description": "Indicates the entity is a Service Fabric replica. The value is 5."
+ },
+ {
+ "value": "DeployedApplication",
+ "description": "Indicates the entity is a Service Fabric deployed application. The value is 6."
+ },
+ {
+ "value": "DeployedServicePackage",
+ "description": "Indicates the entity is a Service Fabric deployed service package. The value is 7."
+ },
+ {
+ "value": "Cluster",
+ "description": "Indicates the entity is a Service Fabric cluster. The value is 8."
+ }
+ ]
+ }
+ },
+ "HealthStateCount": {
+ "description": "Represents information about how many health entities are in Ok, Warning and Error health state.",
+ "properties": {
+ "OkCount": {
+ "type": "integer",
+ "format": "int64",
+ "description": "The number of health entities with aggregated health state Ok.",
+ "minimum": 0
+ },
+ "WarningCount": {
+ "type": "integer",
+ "format": "int64",
+ "description": "The number of health entities with aggregated health state Warning.",
+ "minimum": 0
+ },
+ "ErrorCount": {
+ "type": "integer",
+ "format": "int64",
+ "description": "The number of health entities with aggregated health state Error.",
+ "minimum": 0
+ }
+ }
+ },
+ "EntityKindHealthStateCount": {
+ "description": "Represents health state count for entities of the specified entity kind.",
+ "properties": {
+ "EntityKind": {
+ "$ref": "#/definitions/EntityKind",
+ "description": "The entity kind for which health states are evaluated."
+ },
+ "HealthStateCount": {
+ "$ref": "#/definitions/HealthStateCount",
+ "description": "The health state count for the entities of the specified kind."
+ }
+ }
+ },
+ "HealthStatistics": {
+ "description": "The health statistics of an entity, returned as part of the health query result when the query description is configured to include statistics.\nThe statistics include health state counts for all children types of the current entity.\nFor example, for cluster, the health statistics include health state counts for nodes, applications, services, partitions, replicas, deployed applications and deployed service packages.\nFor partition, the health statistics include health counts for replicas.",
+ "properties": {
+ "HealthStateCountList": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/EntityKindHealthStateCount"
+ },
+ "description": "List of health state counts per entity kind, which keeps track of how many children of the queried entity are in Ok, Warning and Error state."
+ }
+ }
+ },
+ "BackupPolicyDescription": {
+ "description": "Describes a backup policy for configuring periodic backup.",
+ "required": [
+ "Name",
+ "AutoRestoreOnDataLoss",
+ "Schedule",
+ "MaxIncrementalBackups",
+ "Storage"
+ ],
+ "properties": {
+ "Name": {
+ "type": "string",
+ "description": "The unique name identifying this backup policy."
+ },
+ "AutoRestoreOnDataLoss": {
+ "type": "boolean",
+ "description": "Specifies whether to trigger restore automatically using the latest available backup in case the partition experiences a data loss event."
+ },
+ "MaxIncrementalBackups": {
+ "type": "integer",
+ "minimum": 0,
+ "maximum": 255,
+ "description": "Defines the maximum number of incremental backups to be taken between two full backups. This is just the upper limit. A full backup may be taken before specified number of incremental backups are completed in one of the following conditions\n- The replica has never taken a full backup since it has become primary,\n- Some of the log records since the last backup has been truncated, or\n- Replica passed the MaxAccumulatedBackupLogSizeInMB limit."
+ },
+ "Schedule": {
+ "$ref": "#/definitions/BackupScheduleDescription",
+ "description": "Describes the backup schedule parameters."
+ },
+ "Storage": {
+ "$ref": "#/definitions/BackupStorageDescription",
+ "description": "Describes the details of backup storage where to store the periodic backups."
+ },
+ "RetentionPolicy": {
+ "$ref": "#/definitions/RetentionPolicyDescription",
+ "description": "Describes the policy to retain backups in storage."
+ }
+ }
+ },
+ "PagedBackupPolicyDescriptionList": {
+ "description": "The list of backup policies configured in the cluster. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.",
+ "properties": {
+ "ContinuationToken": {
+ "$ref": "#/definitions/ContinuationToken",
+ "description": "The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token is not included in the response."
+ },
+ "Items": {
+ "type": "array",
+ "description": "The list of backup policies information.",
+ "items": {
+ "$ref": "#/definitions/BackupPolicyDescription"
+ }
+ }
+ }
+ },
+ "BasicRetentionPolicyDescription": {
+ "description": "Describes basic retention policy.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/RetentionPolicyDescription"
+ }
+ ],
+ "x-ms-discriminator-value": "Basic",
+ "required": [
+ "RetentionDuration"
+ ],
+ "properties": {
+ "RetentionDuration": {
+ "type": "string",
+ "format": "duration",
+ "description": "It is the minimum duration for which a backup created, will remain stored in the storage and might get deleted after that span of time. It should be specified in ISO8601 format."
+ },
+ "MinimumNumberOfBackups": {
+ "type": "integer",
+ "minimum": 0,
+ "description": "It is the minimum number of backups to be retained at any point of time. If specified with a non zero value, backups will not be deleted even if the backups have gone past retention duration and have number of backups less than or equal to it."
+ }
+ }
+ },
+ "RetentionPolicyType": {
+ "type": "string",
+ "description": "The type of retention policy. Currently only \"Basic\" retention policy is supported.",
+ "enum": [
+ "Basic",
+ "Invalid"
+ ],
+ "x-ms-enum": {
+ "name": "RetentionPolicyType",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "Basic",
+ "description": "Indicates a basic retention policy type."
+ },
+ {
+ "value": "Invalid",
+ "description": "Indicates an invalid retention policy type."
+ }
+ ]
+ }
+ },
+ "DisableBackupDescription": {
+ "description": "It describes the body parameters while disabling backup of a backup entity(Application/Service/Partition).",
+ "required": [
+ "CleanBackup"
+ ],
+ "properties": {
+ "CleanBackup": {
+ "type": "boolean",
+ "description": "Boolean flag to delete backups. It can be set to true for deleting all the backups which were created for the backup entity that is getting disabled for backup."
+ }
+ }
+ },
+ "RetentionPolicyDescription": {
+ "description": "Describes the retention policy configured.",
+ "required": [
+ "RetentionPolicyType"
+ ],
+ "discriminator": "RetentionPolicyType",
+ "properties": {
+ "RetentionPolicyType": {
+ "$ref": "#/definitions/RetentionPolicyType",
+ "description": "The type of retention policy. Currently only \"Basic\" retention policy is supported."
+ }
+ }
+ },
+ "BackupStorageDescription": {
+ "required": [
+ "StorageKind"
+ ],
+ "discriminator": "StorageKind",
+ "properties": {
+ "StorageKind": {
+ "$ref": "#/definitions/BackupStorageKind",
+ "description": "The kind of backup storage, where backups are saved."
+ },
+ "FriendlyName": {
+ "type": "string",
+ "description": "Friendly name for this backup storage."
+ }
+ },
+ "description": "Describes the parameters for the backup storage."
+ },
+ "BackupStorageKind": {
+ "type": "string",
+ "description": "The kind of backup storage, where backups are saved.",
+ "enum": [
+ "Invalid",
+ "FileShare",
+ "AzureBlobStore"
+ ],
+ "x-ms-enum": {
+ "name": "BackupStorageKind",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "Invalid",
+ "description": "Indicates an invalid backup storage kind. All Service Fabric enumerations have the invalid type."
+ },
+ {
+ "value": "FileShare",
+ "description": "Indicates file/ SMB share to be used as backup storage."
+ },
+ {
+ "value": "AzureBlobStore",
+ "description": "Indicates Azure blob store to be used as backup storage."
+ }
+ ]
+ }
+ },
+ "BackupScheduleDescription": {
+ "description": "Describes the backup schedule parameters.",
+ "required": [
+ "ScheduleKind"
+ ],
+ "discriminator": "ScheduleKind",
+ "properties": {
+ "ScheduleKind": {
+ "$ref": "#/definitions/BackupScheduleKind",
+ "description": "The kind of backup schedule, time based or frequency based."
+ }
+ }
+ },
+ "BackupScheduleKind": {
+ "type": "string",
+ "description": "The kind of backup schedule, time based or frequency based.",
+ "enum": [
+ "Invalid",
+ "TimeBased",
+ "FrequencyBased"
+ ],
+ "x-ms-enum": {
+ "name": "BackupScheduleKind",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "Invalid",
+ "description": "Indicates an invalid backup schedule kind. All Service Fabric enumerations have the invalid type."
+ },
+ {
+ "value": "TimeBased",
+ "description": "Indicates a time-based backup schedule."
+ },
+ {
+ "value": "FrequencyBased",
+ "description": "Indicates a frequency-based backup schedule."
+ }
+ ]
+ }
+ },
+ "ApplicationBackupConfigurationInfo": {
+ "description": "Backup configuration information for a specific Service Fabric application specifying what backup policy is being applied and suspend description, if any.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/BackupConfigurationInfo"
+ }
+ ],
+ "properties": {
+ "ApplicationName": {
+ "$ref": "#/definitions/ApplicationName",
+ "description": "The name of the application, including the 'fabric:' URI scheme."
+ }
+ },
+ "x-ms-discriminator-value": "Application"
+ },
+ "ServiceBackupConfigurationInfo": {
+ "description": "Backup configuration information for a specific Service Fabric service specifying what backup policy is being applied and suspend description, if any.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/BackupConfigurationInfo"
+ }
+ ],
+ "properties": {
+ "ServiceName": {
+ "$ref": "#/definitions/ServiceName",
+ "description": "The full name of the service with 'fabric:' URI scheme."
+ }
+ },
+ "x-ms-discriminator-value": "Service"
+ },
+ "PagedBackupConfigurationInfoList": {
+ "description": "The list of backup configuration information. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.",
+ "properties": {
+ "ContinuationToken": {
+ "$ref": "#/definitions/ContinuationToken",
+ "description": "The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token is not included in the response."
+ },
+ "Items": {
+ "type": "array",
+ "description": "List of backup configuration information.",
+ "items": {
+ "$ref": "#/definitions/BackupConfigurationInfo"
+ }
+ }
+ }
+ },
+ "BackupPolicyScope": {
+ "type": "string",
+ "description": "Specifies the scope at which the backup policy is applied.",
+ "enum": [
+ "Invalid",
+ "Partition",
+ "Service",
+ "Application"
+ ],
+ "x-ms-enum": {
+ "name": "BackupPolicyScope",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "Invalid",
+ "description": "Indicates an invalid backup policy scope type. All Service Fabric enumerations have the invalid type."
+ },
+ {
+ "value": "Partition",
+ "description": "Indicates the backup policy is applied at partition level. Hence overriding any policy which may have applied at partition's service or application level."
+ },
+ {
+ "value": "Service",
+ "description": "Indicates the backup policy is applied at service level. All partitions of the service inherit this policy unless explicitly overridden at partition level."
+ },
+ {
+ "value": "Application",
+ "description": "Indicates the backup policy is applied at application level. All services and partitions of the application inherit this policy unless explicitly overridden at service or partition level."
+ }
+ ]
+ }
+ },
+ "BackupSuspensionScope": {
+ "type": "string",
+ "description": "Specifies the scope at which the backup suspension was applied.",
+ "enum": [
+ "Invalid",
+ "Partition",
+ "Service",
+ "Application"
+ ],
+ "x-ms-enum": {
+ "name": "BackupSuspensionScope",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "Invalid",
+ "description": "Indicates an invalid backup suspension scope type also indicating entity is not suspended. All Service Fabric enumerations have the invalid type."
+ },
+ {
+ "value": "Partition",
+ "description": "Indicates the backup suspension is applied at partition level."
+ },
+ {
+ "value": "Service",
+ "description": "Indicates the backup suspension is applied at service level. All partitions of the service are hence suspended for backup."
+ },
+ {
+ "value": "Application",
+ "description": "Indicates the backup suspension is applied at application level. All services and partitions of the application are hence suspended for backup."
+ }
+ ]
+ }
+ },
+ "RestorePartitionDescription": {
+ "description": "Specifies the parameters needed to trigger a restore of a specific partition.",
+ "required": [
+ "BackupId",
+ "BackupLocation"
+ ],
+ "properties": {
+ "BackupId": {
+ "type": "string",
+ "format": "uuid",
+ "description": "Unique backup ID."
+ },
+ "BackupLocation": {
+ "type": "string",
+ "description": "Location of the backup relative to the backup storage specified/ configured."
+ },
+ "BackupStorage": {
+ "$ref": "#/definitions/BackupStorageDescription",
+ "description": "Location of the backup from where the partition will be restored."
+ }
+ }
+ },
+ "RestoreProgressInfo": {
+ "description": "Describes the progress of a restore operation on a partition.",
+ "properties": {
+ "RestoreState": {
+ "$ref": "#/definitions/RestoreState",
+ "description": "Represents the current state of the partition restore operation."
+ },
+ "TimeStampUtc": {
+ "type": "string",
+ "format": "date-time",
+ "description": "Timestamp when operation succeeded or failed."
+ },
+ "RestoredEpoch": {
+ "$ref": "#/definitions/Epoch",
+ "description": "Describes the epoch at which the partition is restored."
+ },
+ "RestoredLsn": {
+ "type": "string",
+ "description": "Restored LSN."
+ },
+ "FailureError": {
+ "$ref": "#/definitions/FabricErrorError",
+ "description": "Denotes the failure encountered in performing restore operation."
+ }
+ }
+ },
+ "RestoreState": {
+ "type": "string",
+ "description": "Represents the current state of the partition restore operation.",
+ "enum": [
+ "Invalid",
+ "Accepted",
+ "RestoreInProgress",
+ "Success",
+ "Failure",
+ "Timeout"
+ ],
+ "x-ms-enum": {
+ "name": "RestoreState",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "Invalid",
+ "description": "Indicates an invalid restore state. All Service Fabric enumerations have the invalid type."
+ },
+ {
+ "value": "Accepted",
+ "description": "Operation has been validated and accepted. Restore is yet to be triggered."
+ },
+ {
+ "value": "RestoreInProgress",
+ "description": "Restore operation has been triggered and is under process."
+ },
+ {
+ "value": "Success",
+ "description": "Operation completed with success."
+ },
+ {
+ "value": "Failure",
+ "description": "Operation completed with failure."
+ },
+ {
+ "value": "Timeout",
+ "description": "Operation timed out."
+ }
+ ]
+ }
+ },
+ "BackupPartitionDescription": {
+ "description": "Describes the parameters for triggering partition's backup.",
+ "properties": {
+ "BackupStorage": {
+ "$ref": "#/definitions/BackupStorageDescription",
+ "description": "Specifies the details of the backup storage where to save the backup."
+ }
+ }
+ },
+ "BackupInfo": {
+ "description": "Represents a backup point which can be used to trigger a restore.",
+ "properties": {
+ "BackupId": {
+ "type": "string",
+ "format": "uuid",
+ "description": "Unique backup ID ."
+ },
+ "BackupChainId": {
+ "type": "string",
+ "format": "uuid",
+ "description": "Unique backup chain ID. All backups part of the same chain has the same backup chain id. A backup chain is comprised of 1 full backup and multiple incremental backups."
+ },
+ "ApplicationName": {
+ "type": "string",
+ "description": "Name of the Service Fabric application this partition backup belongs to."
+ },
+ "ServiceName": {
+ "type": "string",
+ "description": "Name of the Service Fabric service this partition backup belongs to."
+ },
+ "PartitionInformation": {
+ "$ref": "#/definitions/PartitionInformation",
+ "description": "Information about the partition to which this backup belongs to"
+ },
+ "BackupLocation": {
+ "type": "string",
+ "description": "Location of the backup, relative to the backup store."
+ },
+ "BackupType": {
+ "$ref": "#/definitions/BackupType",
+ "description": "Describes the type of backup, whether its full or incremental."
+ },
+ "EpochOfLastBackupRecord": {
+ "$ref": "#/definitions/Epoch",
+ "description": "Epoch of the last record in this backup."
+ },
+ "LsnOfLastBackupRecord": {
+ "type": "string",
+ "description": "LSN of the last record in this backup."
+ },
+ "CreationTimeUtc": {
+ "type": "string",
+ "format": "date-time",
+ "description": "The date time when this backup was taken."
+ },
+ "ServiceManifestVersion": {
+ "type": "string",
+ "description": "Manifest Version of the service this partition backup belongs to."
+ },
+ "FailureError": {
+ "$ref": "#/definitions/FabricErrorError",
+ "description": "Denotes the failure encountered in getting backup point information."
+ }
+ }
+ },
+ "PagedBackupInfoList": {
+ "description": "The list of backups. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.",
+ "properties": {
+ "ContinuationToken": {
+ "$ref": "#/definitions/ContinuationToken",
+ "description": "The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token is not included in the response."
+ },
+ "Items": {
+ "type": "array",
+ "description": "List of backup information.",
+ "items": {
+ "$ref": "#/definitions/BackupInfo"
+ }
+ }
+ }
+ },
+ "BackupType": {
+ "type": "string",
+ "description": "Describes the type of backup, whether its full or incremental.",
+ "enum": [
+ "Invalid",
+ "Full",
+ "Incremental"
+ ],
+ "x-ms-enum": {
+ "name": "BackupType",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "Invalid",
+ "description": "Indicates an invalid backup type. All Service Fabric enumerations have the invalid type."
+ },
+ {
+ "value": "Full",
+ "description": "Indicates a full backup."
+ },
+ {
+ "value": "Incremental",
+ "description": "Indicates an incremental backup. A backup chain is comprised of a full backup followed by 0 or more incremental backups."
+ }
+ ]
+ }
+ },
+ "AzureBlobBackupStorageDescription": {
+ "allOf": [
+ {
+ "$ref": "#/definitions/BackupStorageDescription"
+ }
+ ],
+ "x-ms-discriminator-value": "AzureBlobStore",
+ "required": [
+ "ConnectionString",
+ "ContainerName"
+ ],
+ "properties": {
+ "ConnectionString": {
+ "type": "string",
+ "description": "The connection string to connect to the Azure blob store."
+ },
+ "ContainerName": {
+ "type": "string",
+ "description": "The name of the container in the blob store to store and enumerate backups from."
+ }
+ },
+ "description": "Describes the parameters for Azure blob store used for storing and enumerating backups."
+ },
+ "FileShareBackupStorageDescription": {
+ "allOf": [
+ {
+ "$ref": "#/definitions/BackupStorageDescription"
+ }
+ ],
+ "x-ms-discriminator-value": "FileShare",
+ "required": [
+ "Path"
+ ],
+ "description": "Describes the parameters for file share storage used for storing or enumerating backups.",
+ "properties": {
+ "Path": {
+ "type": "string",
+ "description": "UNC path of the file share where to store or enumerate backups from."
+ },
+ "PrimaryUserName": {
+ "type": "string",
+ "description": "Primary user name to access the file share."
+ },
+ "PrimaryPassword": {
+ "type": "string",
+ "description": "Primary password to access the share location."
+ },
+ "SecondaryUserName": {
+ "type": "string",
+ "description": "Secondary user name to access the file share."
+ },
+ "SecondaryPassword": {
+ "type": "string",
+ "description": "Secondary password to access the share location"
+ }
+ }
+ },
+ "FrequencyBasedBackupScheduleDescription": {
+ "description": "Describes the frequency based backup schedule.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/BackupScheduleDescription"
+ }
+ ],
+ "x-ms-discriminator-value": "FrequencyBased",
+ "required": [
+ "Interval"
+ ],
+ "properties": {
+ "Interval": {
+ "type": "string",
+ "format": "duration",
+ "description": "Defines the interval with which backups are periodically taken. It should be specified in ISO8601 format. Timespan in seconds is not supported and will be ignored while creating the policy."
+ }
+ }
+ },
+ "TimeBasedBackupScheduleDescription": {
+ "description": "Describes the time based backup schedule.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/BackupScheduleDescription"
+ }
+ ],
+ "x-ms-discriminator-value": "TimeBased",
+ "required": [
+ "ScheduleFrequencyType",
+ "RunTimes"
+ ],
+ "properties": {
+ "ScheduleFrequencyType": {
+ "$ref": "#/definitions/BackupScheduleFrequencyType",
+ "description": "Describes the frequency with which to run the time based backup schedule."
+ },
+ "RunDays": {
+ "$ref": "#/definitions/DayOfWeekList",
+ "description": "List of days of a week when to trigger the periodic backup. This is valid only when the backup schedule frequency type is weekly."
+ },
+ "RunTimes": {
+ "$ref": "#/definitions/TimeList",
+ "description": "Represents the list of exact time during the day in ISO8601 format. Like '19:00:00' will represent '7PM' during the day. Date specified along with time will be ignored."
+ }
+ }
+ },
+ "BackupScheduleFrequencyType": {
+ "type": "string",
+ "description": "Describes the frequency with which to run the time based backup schedule.",
+ "enum": [
+ "Invalid",
+ "Daily",
+ "Weekly"
+ ],
+ "x-ms-enum": {
+ "name": "BackupScheduleFrequencyType",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "Invalid",
+ "description": "Indicates an invalid backup schedule frequency type. All Service Fabric enumerations have the invalid type."
+ },
+ {
+ "value": "Daily",
+ "description": "Indicates that the time based backup schedule is repeated at a daily frequency."
+ },
+ {
+ "value": "Weekly",
+ "description": "Indicates that the time based backup schedule is repeated at a weekly frequency."
+ }
+ ]
+ }
+ },
+ "TimeList": {
+ "type": "array",
+ "items": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "description": "Represents the list of exact time during the day in ISO8601 format. Like '19:00:00' will represent '7PM' during the day. Date specified along with time will be ignored."
+ },
+ "DayOfWeekList": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/DayOfWeek"
+ },
+ "description": "List of days of a week when to trigger the periodic backup. This is valid only when the backup schedule frequency type is weekly."
+ },
+ "DayOfWeek": {
+ "type": "string",
+ "description": "Describes the days in a week.",
+ "enum": [
+ "Sunday",
+ "Monday",
+ "Tuesday",
+ "Wednesday",
+ "Thursday",
+ "Friday",
+ "Saturday"
+ ],
+ "x-ms-enum": {
+ "name": "DayOfWeek",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "Sunday",
+ "description": "Indicates the Day referred is Sunday."
+ },
+ {
+ "value": "Monday",
+ "description": "Indicates the Day referred is Monday."
+ },
+ {
+ "value": "Tuesday",
+ "description": "Indicates the Day referred is Tuesday."
+ },
+ {
+ "value": "Wednesday",
+ "description": "Indicates the Day referred is Wednesday."
+ },
+ {
+ "value": "Thursday",
+ "description": "Indicates the Day referred is Thursday."
+ },
+ {
+ "value": "Friday",
+ "description": "Indicates the Day referred is Friday."
+ },
+ {
+ "value": "Saturday",
+ "description": "Indicates the Day referred is Saturday."
+ }
+ ]
+ }
+ },
+ "BackupProgressInfo": {
+ "description": "Describes the progress of a partition's backup.",
+ "properties": {
+ "BackupState": {
+ "$ref": "#/definitions/BackupState",
+ "description": "Represents the current state of the partition backup operation."
+ },
+ "TimeStampUtc": {
+ "type": "string",
+ "format": "date-time",
+ "description": "TimeStamp in UTC when operation succeeded or failed."
+ },
+ "BackupId": {
+ "type": "string",
+ "format": "uuid",
+ "description": "Unique ID of the newly created backup."
+ },
+ "BackupLocation": {
+ "type": "string",
+ "description": "Location, relative to the backup store, of the newly created backup."
+ },
+ "EpochOfLastBackupRecord": {
+ "$ref": "#/definitions/Epoch",
+ "description": "Specifies the epoch of the last record included in backup."
+ },
+ "LsnOfLastBackupRecord": {
+ "type": "string",
+ "description": "The LSN of last record included in backup."
+ },
+ "FailureError": {
+ "$ref": "#/definitions/FabricErrorError",
+ "description": "Denotes the failure encountered in performing backup operation."
+ }
+ }
+ },
+ "BackupConfigurationInfo": {
+ "discriminator": "Kind",
+ "description": "Describes the backup configuration information.",
+ "properties": {
+ "Kind": {
+ "$ref": "#/definitions/BackupEntityKind",
+ "description": "The entity type of a Service Fabric entity such as Application, Service or a Partition where periodic backups can be enabled."
+ },
+ "PolicyName": {
+ "description": "The name of the backup policy which is applicable to this Service Fabric application or service or partition.",
+ "type": "string"
+ },
+ "PolicyInheritedFrom": {
+ "$ref": "#/definitions/BackupPolicyScope",
+ "description": "Specifies the scope at which the backup policy is applied."
+ },
+ "SuspensionInfo": {
+ "$ref": "#/definitions/BackupSuspensionInfo",
+ "description": "Describes the backup suspension details."
+ }
+ },
+ "required": [
+ "Kind"
+ ]
+ },
+ "PartitionBackupConfigurationInfo": {
+ "description": "Backup configuration information, for a specific partition, specifying what backup policy is being applied and suspend description, if any.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/BackupConfigurationInfo"
+ }
+ ],
+ "properties": {
+ "ServiceName": {
+ "$ref": "#/definitions/ServiceName",
+ "description": "The full name of the service with 'fabric:' URI scheme."
+ },
+ "PartitionId": {
+ "$ref": "#/definitions/PartitionId",
+ "description": "The partition ID identifying the partition."
+ }
+ },
+ "x-ms-discriminator-value": "Partition"
+ },
+ "BackupState": {
+ "type": "string",
+ "description": "Represents the current state of the partition backup operation.",
+ "enum": [
+ "Invalid",
+ "Accepted",
+ "BackupInProgress",
+ "Success",
+ "Failure",
+ "Timeout"
+ ],
+ "x-ms-enum": {
+ "name": "BackupState",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "Invalid",
+ "description": "Indicates an invalid backup state. All Service Fabric enumerations have the invalid type."
+ },
+ {
+ "value": "Accepted",
+ "description": "Operation has been validated and accepted. Backup is yet to be triggered."
+ },
+ {
+ "value": "BackupInProgress",
+ "description": "Backup operation has been triggered and is under process."
+ },
+ {
+ "value": "Success",
+ "description": "Operation completed with success."
+ },
+ {
+ "value": "Failure",
+ "description": "Operation completed with failure."
+ },
+ {
+ "value": "Timeout",
+ "description": "Operation timed out."
+ }
+ ]
+ }
+ },
+ "BackupEntity": {
+ "discriminator": "EntityKind",
+ "description": "Describes the Service Fabric entity that is configured for backup.",
+ "properties": {
+ "EntityKind": {
+ "$ref": "#/definitions/BackupEntityKind",
+ "description": "The entity type of a Service Fabric entity such as Application, Service or a Partition where periodic backups can be enabled."
+ }
+ },
+ "required": [
+ "EntityKind"
+ ]
+ },
+ "ApplicationBackupEntity": {
+ "description": "Identifies the Service Fabric application which is being backed up.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/BackupEntity"
+ }
+ ],
+ "properties": {
+ "ApplicationName": {
+ "$ref": "#/definitions/ApplicationName",
+ "description": "The name of the application, including the 'fabric:' URI scheme."
+ }
+ },
+ "x-ms-discriminator-value": "Application"
+ },
+ "ServiceBackupEntity": {
+ "description": "Identifies the Service Fabric stateful service which is being backed up.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/BackupEntity"
+ }
+ ],
+ "properties": {
+ "ServiceName": {
+ "$ref": "#/definitions/ServiceName",
+ "description": "The full name of the service with 'fabric:' URI scheme."
+ }
+ },
+ "x-ms-discriminator-value": "Service"
+ },
+ "PartitionBackupEntity": {
+ "description": "Identifies the Service Fabric stateful partition which is being backed up.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/BackupEntity"
+ }
+ ],
+ "properties": {
+ "ServiceName": {
+ "$ref": "#/definitions/ServiceName",
+ "description": "The full name of the service with 'fabric:' URI scheme."
+ },
+ "PartitionId": {
+ "$ref": "#/definitions/PartitionId",
+ "description": "The partition ID identifying the partition."
+ }
+ },
+ "x-ms-discriminator-value": "Partition"
+ },
+ "EnableBackupDescription": {
+ "description": "Specifies the parameters needed to enable periodic backup.",
+ "required": [
+ "BackupPolicyName"
+ ],
+ "properties": {
+ "BackupPolicyName": {
+ "type": "string",
+ "description": "Name of the backup policy to be used for enabling periodic backups."
+ }
+ }
+ },
+ "PagedBackupEntityList": {
+ "description": "The list of backup entities that are being periodically backed. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.",
+ "properties": {
+ "ContinuationToken": {
+ "$ref": "#/definitions/ContinuationToken",
+ "description": "The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token is not included in the response."
+ },
+ "Items": {
+ "type": "array",
+ "description": "List of backup entity information.",
+ "items": {
+ "$ref": "#/definitions/BackupEntity"
+ }
+ }
+ }
+ },
+ "BackupSuspensionInfo": {
+ "description": "Describes the backup suspension details.",
+ "properties": {
+ "IsSuspended": {
+ "type": "boolean",
+ "description": "Indicates whether periodic backup is suspended at this level or not."
+ },
+ "SuspensionInheritedFrom": {
+ "$ref": "#/definitions/BackupSuspensionScope",
+ "description": "Specifies the scope at which the backup suspension was applied."
+ }
+ }
+ },
+ "BackupEntityKind": {
+ "type": "string",
+ "description": "The entity type of a Service Fabric entity such as Application, Service or a Partition where periodic backups can be enabled.",
+ "enum": [
+ "Invalid",
+ "Partition",
+ "Service",
+ "Application"
+ ],
+ "x-ms-enum": {
+ "name": "BackupEntityKind",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "Invalid",
+ "description": "Indicates an invalid entity kind. All Service Fabric enumerations have the invalid type."
+ },
+ {
+ "value": "Partition",
+ "description": "Indicates the entity is a Service Fabric partition."
+ },
+ {
+ "value": "Service",
+ "description": "Indicates the entity is a Service Fabric service."
+ },
+ {
+ "value": "Application",
+ "description": "Indicates the entity is a Service Fabric application."
+ }
+ ]
+ }
+ },
+ "GetBackupByStorageQueryDescription": {
+ "description": "Describes additional filters to be applied, while listing backups, and backup storage details from where to fetch the backups.",
+ "required": [
+ "Storage",
+ "BackupEntity"
+ ],
+ "properties": {
+ "StartDateTimeFilter": {
+ "type": "string",
+ "format": "date-time",
+ "description": "Specifies the start date time in ISO8601 from which to enumerate backups. If not specified, backups are enumerated from the beginning."
+ },
+ "EndDateTimeFilter": {
+ "type": "string",
+ "format": "date-time",
+ "description": "Specifies the end date time in ISO8601 till which to enumerate backups. If not specified, backups are enumerated till the end."
+ },
+ "Latest": {
+ "type": "boolean",
+ "default": false,
+ "description": "If specified as true, gets the most recent backup (within the specified time range) for every partition under the specified backup entity."
+ },
+ "Storage": {
+ "$ref": "#/definitions/BackupStorageDescription",
+ "description": "Describes the parameters for the backup storage from where to enumerate backups. This is optional and by default backups are enumerated from the backup storage where this backup entity is currently being backed up (as specified in backup policy). This parameter is useful to be able to enumerate backups from another cluster where you may intend to restore."
+ },
+ "BackupEntity": {
+ "$ref": "#/definitions/BackupEntity",
+ "description": "Indicates the entity for which to enumerate backups."
+ }
+ }
+ },
+ "NodeImpact": {
+ "description": "Describes the expected impact of a repair to a particular node.\n\nThis type supports the Service Fabric platform; it is not meant to be used directly from your code.",
+ "properties": {
+ "NodeName": {
+ "type": "string",
+ "description": "The name of the impacted node."
+ },
+ "ImpactLevel": {
+ "type": "string",
+ "enum": [
+ "Invalid",
+ "None",
+ "Restart",
+ "RemoveData",
+ "RemoveNode"
+ ],
+ "description": "The level of impact expected.",
+ "x-ms-enum": {
+ "name": "ImpactLevel",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "Invalid"
+ },
+ {
+ "value": "None"
+ },
+ {
+ "value": "Restart"
+ },
+ {
+ "value": "RemoveData"
+ },
+ {
+ "value": "RemoveNode"
+ }
+ ]
+ }
+ }
+ },
+ "required": [
+ "NodeName"
+ ]
+ },
+ "NodeRepairImpactDescription": {
+ "description": "Describes the expected impact of a repair on a set of nodes.\n\nThis type supports the Service Fabric platform; it is not meant to be used directly from your code.",
+ "x-ms-discriminator-value": "Node",
+ "allOf": [
+ {
+ "$ref": "#/definitions/RepairImpactDescriptionBase"
+ }
+ ],
+ "properties": {
+ "NodeImpactList": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/NodeImpact"
+ },
+ "description": "The list of nodes impacted by a repair action and their respective expected impact."
+ }
+ }
+ },
+ "NodeRepairTargetDescription": {
+ "description": "Describes the list of nodes targeted by a repair action.\n\nThis type supports the Service Fabric platform; it is not meant to be used directly from your code.",
+ "x-ms-discriminator-value": "Node",
+ "allOf": [
+ {
+ "$ref": "#/definitions/RepairTargetDescriptionBase"
+ }
+ ],
+ "properties": {
+ "NodeNames": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "The list of nodes targeted by a repair action."
+ }
+ }
+ },
+ "RepairImpactDescriptionBase": {
+ "discriminator": "Kind",
+ "description": "Describes the expected impact of executing a repair task.\n\nThis type supports the Service Fabric platform; it is not meant to be used directly from your code.",
+ "properties": {
+ "Kind": {
+ "$ref": "#/definitions/RepairImpactKind",
+ "description": "The kind of repair impact represented by the current object."
+ }
+ },
+ "required": [
+ "Kind"
+ ]
+ },
+ "RepairImpactKind": {
+ "description": "Specifies the kind of the impact. This type supports the Service Fabric platform; it is not meant to be used directly from your code.'",
+ "type": "string",
+ "enum": [
+ "Invalid",
+ "Node"
+ ],
+ "x-ms-enum": {
+ "name": "RepairImpactKind",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "Invalid",
+ "description": "The repair impact is not valid or is of an unknown type."
+ },
+ {
+ "value": "Node",
+ "description": "The repair impact affects a set of Service Fabric nodes."
+ }
+ ]
+ }
+ },
+ "RepairTargetDescriptionBase": {
+ "discriminator": "Kind",
+ "description": "Describes the entities targeted by a repair action.\n\nThis type supports the Service Fabric platform; it is not meant to be used directly from your code.",
+ "properties": {
+ "Kind": {
+ "$ref": "#/definitions/RepairTargetKind",
+ "description": "The kind of repair target described by the current object."
+ }
+ },
+ "required": [
+ "Kind"
+ ]
+ },
+ "RepairTargetKind": {
+ "description": "Specifies the kind of the repair target. This type supports the Service Fabric platform; it is not meant to be used directly from your code.'",
+ "type": "string",
+ "enum": [
+ "Invalid",
+ "Node"
+ ],
+ "x-ms-enum": {
+ "name": "RepairTargetKind",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "Invalid",
+ "description": "The repair target is not valid or is of an unknown type."
+ },
+ {
+ "value": "Node",
+ "description": "The repair target is a set of Service Fabric nodes."
+ }
+ ]
+ }
+ },
+ "RepairTask": {
+ "description": "Represents a repair task, which includes information about what kind of repair was requested, what its progress is, and what its final result was.\n\nThis type supports the Service Fabric platform; it is not meant to be used directly from your code.",
+ "properties": {
+ "TaskId": {
+ "type": "string",
+ "description": "The ID of the repair task."
+ },
+ "Version": {
+ "type": "string",
+ "description": "The version of the repair task.\nWhen creating a new repair task, the version must be set to zero. When updating a repair task,\nthe version is used for optimistic concurrency checks. If the version is\nset to zero, the update will not check for write conflicts. If the version is set to a non-zero value, then the\nupdate will only succeed if the actual current version of the repair task matches this value."
+ },
+ "Description": {
+ "type": "string",
+ "description": "A description of the purpose of the repair task, or other informational details.\nMay be set when the repair task is created, and is immutable once set."
+ },
+ "State": {
+ "type": "string",
+ "enum": [
+ "Invalid",
+ "Created",
+ "Claimed",
+ "Preparing",
+ "Approved",
+ "Executing",
+ "Restoring",
+ "Completed"
+ ],
+ "description": "The workflow state of the repair task. Valid initial states are Created, Claimed, and Preparing.",
+ "x-ms-enum": {
+ "name": "State",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "Invalid",
+ "description": "Indicates that the repair task state is invalid. All Service Fabric enumerations have the invalid value."
+ },
+ {
+ "value": "Created",
+ "description": "Indicates that the repair task has been created."
+ },
+ {
+ "value": "Claimed",
+ "description": "Indicates that the repair task has been claimed by a repair executor."
+ },
+ {
+ "value": "Preparing",
+ "description": "Indicates that the Repair Manager is preparing the system to handle the impact of the repair task, usually by taking resources offline gracefully."
+ },
+ {
+ "value": "Approved",
+ "description": "Indicates that the repair task has been approved by the Repair Manager and is safe to execute."
+ },
+ {
+ "value": "Executing",
+ "description": "Indicates that execution of the repair task is in progress."
+ },
+ {
+ "value": "Restoring",
+ "description": "Indicates that the Repair Manager is restoring the system to its pre-repair state, usually by bringing resources back online."
+ },
+ {
+ "value": "Completed",
+ "description": "Indicates that the repair task has completed, and no further state changes will occur."
+ }
+ ]
+ }
+ },
+ "Flags": {
+ "type": "integer",
+ "description": "A bitwise-OR of the following values, which gives additional details about the status of the repair task.\n- 1 - Cancellation of the repair has been requested\n- 2 - Abort of the repair has been requested\n- 4 - Approval of the repair was forced via client request"
+ },
+ "Action": {
+ "type": "string",
+ "description": "The requested repair action. Must be specified when the repair task is created, and is immutable once set."
+ },
+ "Target": {
+ "$ref": "#/definitions/RepairTargetDescriptionBase",
+ "description": "The target object determines what actions the system will take to prepare for the impact of the repair, prior to approving execution of the repair.\nMay be set when the repair task is created, and is immutable once set."
+ },
+ "Executor": {
+ "type": "string",
+ "description": "The name of the repair executor. Must be specified in Claimed and later states, and is immutable once set."
+ },
+ "ExecutorData": {
+ "type": "string",
+ "description": "A data string that the repair executor can use to store its internal state."
+ },
+ "Impact": {
+ "$ref": "#/definitions/RepairImpactDescriptionBase",
+ "description": "The impact object determines what actions the system will take to prepare for the impact of the repair, prior to approving execution of the repair.\nImpact must be specified by the repair executor when transitioning to the Preparing state, and is immutable once set."
+ },
+ "ResultStatus": {
+ "type": "string",
+ "enum": [
+ "Invalid",
+ "Succeeded",
+ "Cancelled",
+ "Interrupted",
+ "Failed",
+ "Pending"
+ ],
+ "description": "A value describing the overall result of the repair task execution. Must be specified in the Restoring and later states, and is immutable once set.",
+ "x-ms-enum": {
+ "name": "ResultStatus",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "Invalid",
+ "description": "Indicates that the repair task result is invalid. All Service Fabric enumerations have the invalid value."
+ },
+ {
+ "value": "Succeeded",
+ "description": "Indicates that the repair task completed execution successfully."
+ },
+ {
+ "value": "Cancelled",
+ "description": "Indicates that the repair task was cancelled prior to execution."
+ },
+ {
+ "value": "Interrupted",
+ "description": "Indicates that execution of the repair task was interrupted by a cancellation request after some work had already been performed."
+ },
+ {
+ "value": "Failed",
+ "description": "Indicates that there was a failure during execution of the repair task. Some work may have been performed."
+ },
+ {
+ "value": "Pending",
+ "description": "Indicates that the repair task result is not yet available, because the repair task has not finished executing."
+ }
+ ]
+ }
+ },
+ "ResultCode": {
+ "type": "integer",
+ "description": "A numeric value providing additional details about the result of the repair task execution.\nMay be specified in the Restoring and later states, and is immutable once set."
+ },
+ "ResultDetails": {
+ "type": "string",
+ "description": "A string providing additional details about the result of the repair task execution.\nMay be specified in the Restoring and later states, and is immutable once set."
+ },
+ "History": {
+ "$ref": "#/definitions/RepairTaskHistory",
+ "description": "An object that contains timestamps of the repair task's state transitions.\nThese timestamps are updated by the system, and cannot be directly modified."
+ },
+ "PreparingHealthCheckState": {
+ "$ref": "#/definitions/RepairTaskHealthCheckState",
+ "description": "The workflow state of the health check when the repair task is in the Preparing state."
+ },
+ "RestoringHealthCheckState": {
+ "$ref": "#/definitions/RepairTaskHealthCheckState",
+ "description": "The workflow state of the health check when the repair task is in the Restoring state."
+ },
+ "PerformPreparingHealthCheck": {
+ "type": "boolean",
+ "description": "A value to determine if health checks will be performed when the repair task enters the Preparing state."
+ },
+ "PerformRestoringHealthCheck": {
+ "type": "boolean",
+ "description": "A value to determine if health checks will be performed when the repair task enters the Restoring state."
+ }
+ },
+ "required": [
+ "TaskId",
+ "Action",
+ "State"
+ ]
+ },
+ "RepairTaskApproveDescription": {
+ "description": "Describes a request for forced approval of a repair task.\n\nThis type supports the Service Fabric platform; it is not meant to be used directly from your code.",
+ "properties": {
+ "TaskId": {
+ "type": "string",
+ "description": "The ID of the repair task."
+ },
+ "Version": {
+ "type": "string",
+ "description": "The current version number of the repair task. If non-zero, then the request will only succeed if this value matches the actual current version of the repair task. If zero, then no version check is performed."
+ }
+ },
+ "required": [
+ "TaskId"
+ ]
+ },
+ "RepairTaskCancelDescription": {
+ "description": "Describes a request to cancel a repair task.\n\nThis type supports the Service Fabric platform; it is not meant to be used directly from your code.",
+ "properties": {
+ "TaskId": {
+ "type": "string",
+ "description": "The ID of the repair task."
+ },
+ "Version": {
+ "type": "string",
+ "description": "The current version number of the repair task. If non-zero, then the request will only succeed if this value matches the actual current version of the repair task. If zero, then no version check is performed."
+ },
+ "RequestAbort": {
+ "type": "boolean",
+ "description": "_True_ if the repair should be stopped as soon as possible even if it has already started executing. _False_ if the repair should be cancelled only if execution has not yet started."
+ }
+ },
+ "required": [
+ "TaskId"
+ ]
+ },
+ "RepairTaskDeleteDescription": {
+ "description": "Describes a request to delete a completed repair task.\n\nThis type supports the Service Fabric platform; it is not meant to be used directly from your code.",
+ "properties": {
+ "TaskId": {
+ "type": "string",
+ "description": "The ID of the completed repair task to be deleted."
+ },
+ "Version": {
+ "type": "string",
+ "description": "The current version number of the repair task. If non-zero, then the request will only succeed if this value matches the actual current version of the repair task. If zero, then no version check is performed."
+ }
+ },
+ "required": [
+ "TaskId"
+ ]
+ },
+ "RepairTaskHealthCheckState": {
+ "description": "Specifies the workflow state of a repair task's health check. This type supports the Service Fabric platform; it is not meant to be used directly from your code.",
+ "type": "string",
+ "enum": [
+ "NotStarted",
+ "InProgress",
+ "Succeeded",
+ "Skipped",
+ "TimedOut"
+ ],
+ "x-ms-enum": {
+ "name": "RepairTaskHealthCheckState",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "NotStarted",
+ "description": "Indicates that the health check has not started."
+ },
+ {
+ "value": "InProgress",
+ "description": "Indicates that the health check is in progress."
+ },
+ {
+ "value": "Succeeded",
+ "description": "Indicates that the health check succeeded."
+ },
+ {
+ "value": "Skipped",
+ "description": "Indicates that the health check was skipped."
+ },
+ {
+ "value": "TimedOut",
+ "description": "Indicates that the health check timed out."
+ }
+ ]
+ }
+ },
+ "RepairTaskHistory": {
+ "description": "A record of the times when the repair task entered each state.\n\nThis type supports the Service Fabric platform; it is not meant to be used directly from your code.",
+ "properties": {
+ "CreatedUtcTimestamp": {
+ "type": "string",
+ "format": "date-time",
+ "description": "The time when the repair task entered the Created state."
+ },
+ "ClaimedUtcTimestamp": {
+ "type": "string",
+ "format": "date-time",
+ "description": "The time when the repair task entered the Claimed state."
+ },
+ "PreparingUtcTimestamp": {
+ "type": "string",
+ "format": "date-time",
+ "description": "The time when the repair task entered the Preparing state."
+ },
+ "ApprovedUtcTimestamp": {
+ "type": "string",
+ "format": "date-time",
+ "description": "The time when the repair task entered the Approved state"
+ },
+ "ExecutingUtcTimestamp": {
+ "type": "string",
+ "format": "date-time",
+ "description": "The time when the repair task entered the Executing state"
+ },
+ "RestoringUtcTimestamp": {
+ "type": "string",
+ "format": "date-time",
+ "description": "The time when the repair task entered the Restoring state"
+ },
+ "CompletedUtcTimestamp": {
+ "type": "string",
+ "format": "date-time",
+ "description": "The time when the repair task entered the Completed state"
+ },
+ "PreparingHealthCheckStartUtcTimestamp": {
+ "type": "string",
+ "format": "date-time",
+ "description": "The time when the repair task started the health check in the Preparing state."
+ },
+ "PreparingHealthCheckEndUtcTimestamp": {
+ "type": "string",
+ "format": "date-time",
+ "description": "The time when the repair task completed the health check in the Preparing state."
+ },
+ "RestoringHealthCheckStartUtcTimestamp": {
+ "type": "string",
+ "format": "date-time",
+ "description": "The time when the repair task started the health check in the Restoring state."
+ },
+ "RestoringHealthCheckEndUtcTimestamp": {
+ "type": "string",
+ "format": "date-time",
+ "description": "The time when the repair task completed the health check in the Restoring state."
+ }
+ }
+ },
+ "RepairTaskList": {
+ "type": "array",
+ "description": "A list of repair tasks.",
+ "items": {
+ "$ref": "#/definitions/RepairTask"
+ }
+ },
+ "RepairTaskUpdateHealthPolicyDescription": {
+ "description": "Describes a request to update the health policy of a repair task.\n\nThis type supports the Service Fabric platform; it is not meant to be used directly from your code.",
+ "properties": {
+ "TaskId": {
+ "type": "string",
+ "description": "The ID of the repair task to be updated."
+ },
+ "Version": {
+ "type": "string",
+ "description": "The current version number of the repair task. If non-zero, then the request will only succeed if this value matches the actual current value of the repair task. If zero, then no version check is performed."
+ },
+ "PerformPreparingHealthCheck": {
+ "type": "boolean",
+ "description": "A boolean indicating if health check is to be performed in the Preparing stage of the repair task. If not specified the existing value should not be altered. Otherwise, specify the desired new value."
+ },
+ "PerformRestoringHealthCheck": {
+ "type": "boolean",
+ "description": "A boolean indicating if health check is to be performed in the Restoring stage of the repair task. If not specified the existing value should not be altered. Otherwise, specify the desired new value."
+ }
+ },
+ "required": [
+ "TaskId"
+ ]
+ },
+ "RepairTaskUpdateInfo": {
+ "description": "Describes the result of an operation that created or updated a repair task.\n\nThis type supports the Service Fabric platform; it is not meant to be used directly from your code.",
+ "properties": {
+ "Version": {
+ "type": "string",
+ "description": "The new version of the repair task."
+ }
+ },
+ "required": [
+ "Version"
+ ]
+ },
+ "ReconfigurationInformation": {
+ "description": "Information about current reconfiguration like phase, type, previous configuration role of replica and reconfiguration start date time.",
+ "properties": {
+ "PreviousConfigurationRole": {
+ "$ref": "#/definitions/ReplicaRole",
+ "description": "Replica role before reconfiguration started."
+ },
+ "ReconfigurationPhase": {
+ "$ref": "#/definitions/ReconfigurationPhase",
+ "description": "Current phase of ongoing reconfiguration. If no reconfiguration is taking place then this value will be \"None\"."
+ },
+ "ReconfigurationType": {
+ "$ref": "#/definitions/ReconfigurationType",
+ "description": "Type of current ongoing reconfiguration. If no reconfiguration is taking place then this value will be \"None\"."
+ },
+ "ReconfigurationStartTimeUtc": {
+ "type": "string",
+ "format": "date-time",
+ "description": "Start time (in UTC) of the ongoing reconfiguration. If no reconfiguration is taking place then this value will be zero date-time."
+ }
+ }
+ },
+ "ReconfigurationPhase": {
+ "type": "string",
+ "description": "The reconfiguration phase of a replica of a stateful service.",
+ "enum": [
+ "Unknown",
+ "None",
+ "Phase0",
+ "Phase1",
+ "Phase2",
+ "Phase3",
+ "Phase4",
+ "AbortPhaseZero"
+ ],
+ "x-ms-enum": {
+ "name": "ReconfigurationPhase",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "Unknown",
+ "description": "Indicates the invalid reconfiguration phase."
+ },
+ {
+ "value": "None",
+ "description": "Specifies that there is no reconfiguration in progress."
+ },
+ {
+ "value": "Phase0",
+ "description": "Refers to the phase where the reconfiguration is transferring data from the previous primary to the new primary."
+ },
+ {
+ "value": "Phase1",
+ "description": "Refers to the phase where the reconfiguration is querying the replica set for the progress."
+ },
+ {
+ "value": "Phase2",
+ "description": "Refers to the phase where the reconfiguration is ensuring that data from the current primary is present in a majority of the replica set."
+ },
+ {
+ "value": "Phase3",
+ "description": "This phase is for internal use only."
+ },
+ {
+ "value": "Phase4",
+ "description": "This phase is for internal use only."
+ },
+ {
+ "value": "AbortPhaseZero",
+ "description": "This phase is for internal use only."
+ }
+ ]
+ }
+ },
+ "ReconfigurationType": {
+ "type": "string",
+ "description": "The type of reconfiguration for replica of a stateful service.",
+ "enum": [
+ "Unknown",
+ "SwapPrimary",
+ "Failover",
+ "Other"
+ ],
+ "x-ms-enum": {
+ "name": "ReconfigurationType",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "Unknown",
+ "description": "Indicates the invalid reconfiguration type."
+ },
+ {
+ "value": "SwapPrimary",
+ "description": "Specifies that the primary replica is being swapped with a different replica."
+ },
+ {
+ "value": "Failover",
+ "description": "Reconfiguration triggered in response to a primary going down. This could be due to many reasons such as primary replica crashing etc."
+ },
+ {
+ "value": "Other",
+ "description": "Reconfigurations where the primary replica is not changing."
+ }
+ ]
+ }
+ },
+ "InfrastructureServiceResponse": {
+ "type": "string",
+ "format": "binary",
+ "description": "This is a weakly-typed response stream to the client. It contains the JSON response from the infrastructure service without deserialization.\nThe content of the response depends on which command was issued to the infrastructure service."
+ },
+ "UploadChunkRange": {
+ "description": "Information about which portion of the file to upload.",
+ "properties": {
+ "StartPosition": {
+ "type": "string",
+ "description": "The start position of the portion of the file. It's represented by the number of bytes."
+ },
+ "EndPosition": {
+ "type": "string",
+ "description": "The end position of the portion of the file. It's represented by the number of bytes."
+ }
+ }
+ },
+ "UploadSessionInfo": {
+ "description": "Information about an image store upload session. A session is associated with a relative path in the image store.",
+ "properties": {
+ "StoreRelativePath": {
+ "type": "string",
+ "description": "The remote location within image store. This path is relative to the image store root."
+ },
+ "SessionId": {
+ "type": "string",
+ "format": "uuid",
+ "description": "A unique ID of the upload session. A session ID can be reused only if the session was committed or removed."
+ },
+ "ModifiedDate": {
+ "type": "string",
+ "format": "date-time",
+ "description": "The date and time when the upload session was last modified."
+ },
+ "FileSize": {
+ "type": "string",
+ "description": "The size in bytes of the uploading file."
+ },
+ "ExpectedRanges": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/UploadChunkRange"
+ },
+ "description": "List of chunk ranges that image store has not received yet."
+ }
+ }
+ },
+ "UploadSession": {
+ "description": "Information about a image store upload session",
+ "properties": {
+ "UploadSessions": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/UploadSessionInfo"
+ },
+ "description": "When querying upload session by upload session ID, the result contains only one upload session. When querying upload session by image store relative path, the result might contain multiple upload sessions."
+ }
+ }
+ },
+ "ScalingPolicyDescription": {
+ "description": "Describes how the scaling should be performed",
+ "required": [
+ "ScalingTrigger",
+ "ScalingMechanism"
+ ],
+ "properties": {
+ "ScalingTrigger": {
+ "$ref": "#/definitions/ScalingTriggerDescription",
+ "description": "Specifies the trigger associated with this scaling policy"
+ },
+ "ScalingMechanism": {
+ "$ref": "#/definitions/ScalingMechanismDescription",
+ "description": "Specifies the mechanism associated with this scaling policy"
+ }
+ }
+ },
+ "ScalingPolicyDescriptionList": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ScalingPolicyDescription"
+ },
+ "description": "A list that describes the scaling policies."
+ },
+ "ScalingTriggerDescription": {
+ "discriminator": "Kind",
+ "description": "Describes the trigger for performing a scaling operation.",
+ "required": [
+ "Kind"
+ ],
+ "properties": {
+ "Kind": {
+ "$ref": "#/definitions/ScalingTriggerKind",
+ "description": "Specifies the kind of scaling trigger"
+ }
+ }
+ },
+ "ScalingMechanismDescription": {
+ "discriminator": "Kind",
+ "description": "Describes the mechanism for performing a scaling operation.",
+ "required": [
+ "Kind"
+ ],
+ "properties": {
+ "Kind": {
+ "$ref": "#/definitions/ScalingMechanismKind",
+ "description": "Specifies the kind of scaling mechanism"
+ }
+ }
+ },
+ "ScalingTriggerKind": {
+ "type": "string",
+ "description": "Enumerates the ways that a service can be scaled.",
+ "enum": [
+ "Invalid",
+ "AveragePartitionLoad",
+ "AverageServiceLoad"
+ ],
+ "x-ms-enum": {
+ "name": "ScalingTriggerKind",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "Invalid",
+ "description": "Indicates the scaling trigger is invalid. All Service Fabric enumerations have the invalid type. The value is zero."
+ },
+ {
+ "value": "AveragePartitionLoad",
+ "description": "Indicates a trigger where scaling decisions are made based on average load of a partition. The value is 1."
+ },
+ {
+ "value": "AverageServiceLoad",
+ "description": "Indicates a trigger where scaling decisions are made based on average load of a service. The value is 2."
+ }
+ ]
+ }
+ },
+ "ScalingMechanismKind": {
+ "type": "string",
+ "description": "Enumerates the ways that a service can be scaled.",
+ "enum": [
+ "Invalid",
+ "PartitionInstanceCount",
+ "AddRemoveIncrementalNamedPartition"
+ ],
+ "x-ms-enum": {
+ "name": "ScalingMechanismKind",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "Invalid",
+ "description": "Indicates the scaling mechanism is invalid. All Service Fabric enumerations have the invalid type. The value is zero."
+ },
+ {
+ "value": "PartitionInstanceCount",
+ "description": "Indicates a mechanism for scaling where new instances are added or removed from a partition. The value is 1."
+ },
+ {
+ "value": "AddRemoveIncrementalNamedPartition",
+ "description": "Indicates a mechanism for scaling where new named partitions are added or removed from a service. The value is 2."
+ }
+ ]
+ }
+ },
+ "AveragePartitionLoadScalingTrigger": {
+ "description": "Represents a scaling trigger related to an average load of a metric/resource of a partition.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ScalingTriggerDescription"
+ }
+ ],
+ "x-ms-discriminator-value": "AveragePartitionLoad",
+ "required": [
+ "MetricName",
+ "LowerLoadThreshold",
+ "UpperLoadThreshold",
+ "ScaleIntervalInSeconds"
+ ],
+ "properties": {
+ "MetricName": {
+ "type": "string",
+ "description": "The name of the metric for which usage should be tracked."
+ },
+ "LowerLoadThreshold": {
+ "type": "string",
+ "format": "double",
+ "description": "The lower limit of the load below which a scale in operation should be performed."
+ },
+ "UpperLoadThreshold": {
+ "type": "string",
+ "format": "double",
+ "description": "The upper limit of the load beyond which a scale out operation should be performed."
+ },
+ "ScaleIntervalInSeconds": {
+ "type": "integer",
+ "format": "int64",
+ "minimum": 0,
+ "maximum": 4294967295,
+ "description": "The period in seconds on which a decision is made whether to scale or not."
+ }
+ }
+ },
+ "AverageServiceLoadScalingTrigger": {
+ "description": "Represents a scaling policy related to an average load of a metric/resource of a service.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ScalingTriggerDescription"
+ }
+ ],
+ "x-ms-discriminator-value": "AverageServiceLoad",
+ "required": [
+ "MetricName",
+ "LowerLoadThreshold",
+ "UpperLoadThreshold",
+ "ScaleIntervalInSeconds"
+ ],
+ "properties": {
+ "MetricName": {
+ "type": "string",
+ "description": "The name of the metric for which usage should be tracked."
+ },
+ "LowerLoadThreshold": {
+ "type": "string",
+ "format": "double",
+ "description": "The lower limit of the load below which a scale in operation should be performed."
+ },
+ "UpperLoadThreshold": {
+ "type": "string",
+ "format": "double",
+ "description": "The upper limit of the load beyond which a scale out operation should be performed."
+ },
+ "ScaleIntervalInSeconds": {
+ "type": "integer",
+ "format": "int64",
+ "minimum": 0,
+ "maximum": 4294967295,
+ "description": "The period in seconds on which a decision is made whether to scale or not."
+ }
+ }
+ },
+ "PartitionInstanceCountScaleMechanism": {
+ "description": "Represents a scaling mechanism for adding or removing instances of stateless service partition.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ScalingMechanismDescription"
+ }
+ ],
+ "x-ms-discriminator-value": "PartitionInstanceCount",
+ "required": [
+ "MinInstanceCount",
+ "MaxInstanceCount",
+ "ScaleIncrement"
+ ],
+ "properties": {
+ "MinInstanceCount": {
+ "type": "integer",
+ "description": "Minimum number of instances of the partition."
+ },
+ "MaxInstanceCount": {
+ "type": "integer",
+ "description": "Maximum number of instances of the partition."
+ },
+ "ScaleIncrement": {
+ "type": "integer",
+ "description": "The number of instances to add or remove during a scaling operation."
+ }
+ }
+ },
+ "AddRemoveIncrementalNamedPartitionScalingMechanism": {
+ "description": "Represents a scaling mechanism for adding or removing named partitions of a stateless service. Partition names are in the format '0','1''N-1'",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ScalingMechanismDescription"
+ }
+ ],
+ "x-ms-discriminator-value": "AddRemoveIncrementalNamedPartition",
+ "required": [
+ "MinPartitionCount",
+ "MaxPartitionCount",
+ "ScaleIncrement"
+ ],
+ "properties": {
+ "MinPartitionCount": {
+ "type": "integer",
+ "description": "Minimum number of named partitions of the service."
+ },
+ "MaxPartitionCount": {
+ "type": "integer",
+ "description": "Maximum number of named partitions of the service."
+ },
+ "ScaleIncrement": {
+ "type": "integer",
+ "description": "The number of instances to add or remove during a scaling operation."
+ }
+ }
+ },
+ "UnplacedReplicaInformation": {
+ "description": "Contains information for an unplaced replica.",
+ "properties": {
+ "ServiceName": {
+ "$ref": "#/definitions/ServiceName",
+ "description": "The name of the service."
+ },
+ "PartitionId": {
+ "$ref": "#/definitions/PartitionId",
+ "description": "The ID of the partition."
+ },
+ "UnplacedReplicaDetails": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "List of reasons due to which a replica cannot be placed."
+ }
+ }
+ },
+ "ApplicationCreatedEvent": {
+ "description": "Application Created event.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ApplicationEvent"
+ }
+ ],
+ "properties": {
+ "ApplicationTypeName": {
+ "type": "string",
+ "description": "Application type name."
+ },
+ "ApplicationTypeVersion": {
+ "type": "string",
+ "description": "Application type version."
+ },
+ "ApplicationDefinitionKind": {
+ "type": "string",
+ "description": "Application definition kind."
+ }
+ },
+ "required": [
+ "ApplicationTypeName",
+ "ApplicationTypeVersion",
+ "ApplicationDefinitionKind"
+ ],
+ "x-ms-discriminator-value": "ApplicationCreated"
+ },
+ "ApplicationDeletedEvent": {
+ "description": "Application Deleted event.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ApplicationEvent"
+ }
+ ],
+ "properties": {
+ "ApplicationTypeName": {
+ "type": "string",
+ "description": "Application type name."
+ },
+ "ApplicationTypeVersion": {
+ "type": "string",
+ "description": "Application type version."
+ }
+ },
+ "required": [
+ "ApplicationTypeName",
+ "ApplicationTypeVersion"
+ ],
+ "x-ms-discriminator-value": "ApplicationDeleted"
+ },
+ "ApplicationNewHealthReportEvent": {
+ "description": "Application Health Report Created event.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ApplicationEvent"
+ }
+ ],
+ "properties": {
+ "ApplicationInstanceId": {
+ "type": "integer",
+ "format": "int64",
+ "description": "Id of Application instance."
+ },
+ "SourceId": {
+ "type": "string",
+ "description": "Id of report source."
+ },
+ "Property": {
+ "type": "string",
+ "description": "Describes the property."
+ },
+ "HealthState": {
+ "type": "string",
+ "description": "Describes the property health state."
+ },
+ "TimeToLiveMs": {
+ "type": "integer",
+ "format": "int64",
+ "description": "Time to live in milli-seconds."
+ },
+ "SequenceNumber": {
+ "type": "integer",
+ "format": "int64",
+ "description": "Sequence number of report."
+ },
+ "Description": {
+ "type": "string",
+ "description": "Description of report."
+ },
+ "RemoveWhenExpired": {
+ "type": "boolean",
+ "description": "Indicates the removal when it expires."
+ },
+ "SourceUtcTimestamp": {
+ "type": "string",
+ "format": "date-time",
+ "description": "Source time."
+ }
+ },
+ "required": [
+ "ApplicationInstanceId",
+ "SourceId",
+ "Property",
+ "HealthState",
+ "TimeToLiveMs",
+ "SequenceNumber",
+ "Description",
+ "RemoveWhenExpired",
+ "SourceUtcTimestamp"
+ ],
+ "x-ms-discriminator-value": "ApplicationNewHealthReport"
+ },
+ "ApplicationHealthReportExpiredEvent": {
+ "description": "Application Health Report Expired event.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ApplicationEvent"
+ }
+ ],
+ "properties": {
+ "ApplicationInstanceId": {
+ "type": "integer",
+ "format": "int64",
+ "description": "Id of Application instance."
+ },
+ "SourceId": {
+ "type": "string",
+ "description": "Id of report source."
+ },
+ "Property": {
+ "type": "string",
+ "description": "Describes the property."
+ },
+ "HealthState": {
+ "type": "string",
+ "description": "Describes the property health state."
+ },
+ "TimeToLiveMs": {
+ "type": "integer",
+ "format": "int64",
+ "description": "Time to live in milli-seconds."
+ },
+ "SequenceNumber": {
+ "type": "integer",
+ "format": "int64",
+ "description": "Sequence number of report."
+ },
+ "Description": {
+ "type": "string",
+ "description": "Description of report."
+ },
+ "RemoveWhenExpired": {
+ "type": "boolean",
+ "description": "Indicates the removal when it expires."
+ },
+ "SourceUtcTimestamp": {
+ "type": "string",
+ "format": "date-time",
+ "description": "Source time."
+ }
+ },
+ "required": [
+ "ApplicationInstanceId",
+ "SourceId",
+ "Property",
+ "HealthState",
+ "TimeToLiveMs",
+ "SequenceNumber",
+ "Description",
+ "RemoveWhenExpired",
+ "SourceUtcTimestamp"
+ ],
+ "x-ms-discriminator-value": "ApplicationHealthReportExpired"
+ },
+ "ApplicationUpgradeCompletedEvent": {
+ "description": "Application Upgrade Completed event.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ApplicationEvent"
+ }
+ ],
+ "properties": {
+ "ApplicationTypeName": {
+ "type": "string",
+ "description": "Application type name."
+ },
+ "ApplicationTypeVersion": {
+ "type": "string",
+ "description": "Application type version."
+ },
+ "OverallUpgradeElapsedTimeInMs": {
+ "type": "number",
+ "format": "double",
+ "description": "Overall upgrade time in milli-seconds."
+ }
+ },
+ "required": [
+ "ApplicationTypeName",
+ "ApplicationTypeVersion",
+ "OverallUpgradeElapsedTimeInMs"
+ ],
+ "x-ms-discriminator-value": "ApplicationUpgradeCompleted"
+ },
+ "ApplicationUpgradeDomainCompletedEvent": {
+ "description": "Application Upgrade Domain Completed event.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ApplicationEvent"
+ }
+ ],
+ "properties": {
+ "ApplicationTypeName": {
+ "type": "string",
+ "description": "Application type name."
+ },
+ "CurrentApplicationTypeVersion": {
+ "type": "string",
+ "description": "Current Application type version."
+ },
+ "ApplicationTypeVersion": {
+ "type": "string",
+ "description": "Target Application type version."
+ },
+ "UpgradeState": {
+ "type": "string",
+ "description": "State of upgrade."
+ },
+ "UpgradeDomains": {
+ "type": "string",
+ "description": "Upgrade domains."
+ },
+ "UpgradeDomainElapsedTimeInMs": {
+ "type": "number",
+ "format": "double",
+ "description": "Upgrade time of domain in milli-seconds."
+ }
+ },
+ "required": [
+ "ApplicationTypeName",
+ "CurrentApplicationTypeVersion",
+ "ApplicationTypeVersion",
+ "UpgradeState",
+ "UpgradeDomains",
+ "UpgradeDomainElapsedTimeInMs"
+ ],
+ "x-ms-discriminator-value": "ApplicationUpgradeDomainCompleted"
+ },
+ "ApplicationUpgradeRollbackCompletedEvent": {
+ "description": "Application Upgrade Rollback Completed event.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ApplicationEvent"
+ }
+ ],
+ "properties": {
+ "ApplicationTypeName": {
+ "type": "string",
+ "description": "Application type name."
+ },
+ "ApplicationTypeVersion": {
+ "type": "string",
+ "description": "Application type version."
+ },
+ "FailureReason": {
+ "type": "string",
+ "description": "Describes reason of failure."
+ },
+ "OverallUpgradeElapsedTimeInMs": {
+ "type": "number",
+ "format": "double",
+ "description": "Overall upgrade time in milli-seconds."
+ }
+ },
+ "required": [
+ "ApplicationTypeName",
+ "ApplicationTypeVersion",
+ "FailureReason",
+ "OverallUpgradeElapsedTimeInMs"
+ ],
+ "x-ms-discriminator-value": "ApplicationUpgradeRollbackCompleted"
+ },
+ "ApplicationUpgradeRollbackStartedEvent": {
+ "description": "Application Upgrade Rollback Started event.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ApplicationEvent"
+ }
+ ],
+ "properties": {
+ "ApplicationTypeName": {
+ "type": "string",
+ "description": "Application type name."
+ },
+ "CurrentApplicationTypeVersion": {
+ "type": "string",
+ "description": "Current Application type version."
+ },
+ "ApplicationTypeVersion": {
+ "type": "string",
+ "description": "Target Application type version."
+ },
+ "FailureReason": {
+ "type": "string",
+ "description": "Describes reason of failure."
+ },
+ "OverallUpgradeElapsedTimeInMs": {
+ "type": "number",
+ "format": "double",
+ "description": "Overall upgrade time in milli-seconds."
+ }
+ },
+ "required": [
+ "ApplicationTypeName",
+ "CurrentApplicationTypeVersion",
+ "ApplicationTypeVersion",
+ "FailureReason",
+ "OverallUpgradeElapsedTimeInMs"
+ ],
+ "x-ms-discriminator-value": "ApplicationUpgradeRollbackStarted"
+ },
+ "ApplicationUpgradeStartedEvent": {
+ "description": "Application Upgrade Started event.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ApplicationEvent"
+ }
+ ],
+ "properties": {
+ "ApplicationTypeName": {
+ "type": "string",
+ "description": "Application type name."
+ },
+ "CurrentApplicationTypeVersion": {
+ "type": "string",
+ "description": "Current Application type version."
+ },
+ "ApplicationTypeVersion": {
+ "type": "string",
+ "description": "Target Application type version."
+ },
+ "UpgradeType": {
+ "type": "string",
+ "description": "Type of upgrade."
+ },
+ "RollingUpgradeMode": {
+ "type": "string",
+ "description": "Mode of upgrade."
+ },
+ "FailureAction": {
+ "type": "string",
+ "description": "Action if failed."
+ }
+ },
+ "required": [
+ "ApplicationTypeName",
+ "CurrentApplicationTypeVersion",
+ "ApplicationTypeVersion",
+ "UpgradeType",
+ "RollingUpgradeMode",
+ "FailureAction"
+ ],
+ "x-ms-discriminator-value": "ApplicationUpgradeStarted"
+ },
+ "DeployedApplicationNewHealthReportEvent": {
+ "description": "Deployed Application Health Report Created event.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ApplicationEvent"
+ }
+ ],
+ "properties": {
+ "ApplicationInstanceId": {
+ "type": "integer",
+ "format": "int64",
+ "description": "Id of Application instance."
+ },
+ "NodeName": {
+ "$ref": "#/definitions/NodeName",
+ "description": "The name of a Service Fabric node."
+ },
+ "SourceId": {
+ "type": "string",
+ "description": "Id of report source."
+ },
+ "Property": {
+ "type": "string",
+ "description": "Describes the property."
+ },
+ "HealthState": {
+ "type": "string",
+ "description": "Describes the property health state."
+ },
+ "TimeToLiveMs": {
+ "type": "integer",
+ "format": "int64",
+ "description": "Time to live in milli-seconds."
+ },
+ "SequenceNumber": {
+ "type": "integer",
+ "format": "int64",
+ "description": "Sequence number of report."
+ },
+ "Description": {
+ "type": "string",
+ "description": "Description of report."
+ },
+ "RemoveWhenExpired": {
+ "type": "boolean",
+ "description": "Indicates the removal when it expires."
+ },
+ "SourceUtcTimestamp": {
+ "type": "string",
+ "format": "date-time",
+ "description": "Source time."
+ }
+ },
+ "required": [
+ "ApplicationInstanceId",
+ "NodeName",
+ "SourceId",
+ "Property",
+ "HealthState",
+ "TimeToLiveMs",
+ "SequenceNumber",
+ "Description",
+ "RemoveWhenExpired",
+ "SourceUtcTimestamp"
+ ],
+ "x-ms-discriminator-value": "DeployedApplicationNewHealthReport"
+ },
+ "DeployedApplicationHealthReportExpiredEvent": {
+ "description": "Deployed Application Health Report Expired event.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ApplicationEvent"
+ }
+ ],
+ "properties": {
+ "ApplicationInstanceId": {
+ "type": "integer",
+ "format": "int64",
+ "description": "Id of Application instance."
+ },
+ "NodeName": {
+ "$ref": "#/definitions/NodeName",
+ "description": "The name of a Service Fabric node."
+ },
+ "SourceId": {
+ "type": "string",
+ "description": "Id of report source."
+ },
+ "Property": {
+ "type": "string",
+ "description": "Describes the property."
+ },
+ "HealthState": {
+ "type": "string",
+ "description": "Describes the property health state."
+ },
+ "TimeToLiveMs": {
+ "type": "integer",
+ "format": "int64",
+ "description": "Time to live in milli-seconds."
+ },
+ "SequenceNumber": {
+ "type": "integer",
+ "format": "int64",
+ "description": "Sequence number of report."
+ },
+ "Description": {
+ "type": "string",
+ "description": "Description of report."
+ },
+ "RemoveWhenExpired": {
+ "type": "boolean",
+ "description": "Indicates the removal when it expires."
+ },
+ "SourceUtcTimestamp": {
+ "type": "string",
+ "format": "date-time",
+ "description": "Source time."
+ }
+ },
+ "required": [
+ "ApplicationInstanceId",
+ "NodeName",
+ "SourceId",
+ "Property",
+ "HealthState",
+ "TimeToLiveMs",
+ "SequenceNumber",
+ "Description",
+ "RemoveWhenExpired",
+ "SourceUtcTimestamp"
+ ],
+ "x-ms-discriminator-value": "DeployedApplicationHealthReportExpired"
+ },
+ "ApplicationProcessExitedEvent": {
+ "description": "Process Exited event.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ApplicationEvent"
+ }
+ ],
+ "properties": {
+ "ServiceName": {
+ "type": "string",
+ "description": "Name of Service."
+ },
+ "ServicePackageName": {
+ "type": "string",
+ "description": "Name of Service package."
+ },
+ "ServicePackageActivationId": {
+ "type": "string",
+ "description": "Activation Id of Service package."
+ },
+ "IsExclusive": {
+ "type": "boolean",
+ "description": "Indicates IsExclusive flag."
+ },
+ "CodePackageName": {
+ "type": "string",
+ "description": "Name of Code package."
+ },
+ "EntryPointType": {
+ "type": "string",
+ "description": "Type of EntryPoint."
+ },
+ "ExeName": {
+ "type": "string",
+ "description": "Name of executable."
+ },
+ "ProcessId": {
+ "type": "integer",
+ "format": "int64",
+ "description": "Process Id."
+ },
+ "HostId": {
+ "type": "string",
+ "description": "Host Id."
+ },
+ "ExitCode": {
+ "type": "integer",
+ "format": "int64",
+ "description": "Exit code of process."
+ },
+ "UnexpectedTermination": {
+ "type": "boolean",
+ "description": "Indicates if termination is unexpected."
+ },
+ "StartTime": {
+ "type": "string",
+ "format": "date-time",
+ "description": "Start time of process."
+ }
+ },
+ "required": [
+ "ServiceName",
+ "ServicePackageName",
+ "ServicePackageActivationId",
+ "IsExclusive",
+ "CodePackageName",
+ "EntryPointType",
+ "ExeName",
+ "ProcessId",
+ "HostId",
+ "ExitCode",
+ "UnexpectedTermination",
+ "StartTime"
+ ],
+ "x-ms-discriminator-value": "ApplicationProcessExited"
+ },
+ "ApplicationContainerInstanceExitedEvent": {
+ "description": "Container Exited event.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ApplicationEvent"
+ }
+ ],
+ "properties": {
+ "ServiceName": {
+ "type": "string",
+ "description": "Name of Service."
+ },
+ "ServicePackageName": {
+ "type": "string",
+ "description": "Name of Service package."
+ },
+ "ServicePackageActivationId": {
+ "type": "string",
+ "description": "Activation Id of Service package."
+ },
+ "IsExclusive": {
+ "type": "boolean",
+ "description": "Indicates IsExclusive flag."
+ },
+ "CodePackageName": {
+ "type": "string",
+ "description": "Name of Code package."
+ },
+ "EntryPointType": {
+ "type": "string",
+ "description": "Type of EntryPoint."
+ },
+ "ImageName": {
+ "type": "string",
+ "description": "Name of Container image."
+ },
+ "ContainerName": {
+ "type": "string",
+ "description": "Name of Container."
+ },
+ "HostId": {
+ "type": "string",
+ "description": "Host Id."
+ },
+ "ExitCode": {
+ "type": "integer",
+ "format": "int64",
+ "description": "Exit code of process."
+ },
+ "UnexpectedTermination": {
+ "type": "boolean",
+ "description": "Indicates if termination is unexpected."
+ },
+ "StartTime": {
+ "type": "string",
+ "format": "date-time",
+ "description": "Start time of process."
+ }
+ },
+ "required": [
+ "ServiceName",
+ "ServicePackageName",
+ "ServicePackageActivationId",
+ "IsExclusive",
+ "CodePackageName",
+ "EntryPointType",
+ "ImageName",
+ "ContainerName",
+ "HostId",
+ "ExitCode",
+ "UnexpectedTermination",
+ "StartTime"
+ ],
+ "x-ms-discriminator-value": "ApplicationContainerInstanceExited"
+ },
+ "NodeAbortedEvent": {
+ "description": "Node Aborted event.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/NodeEvent"
+ }
+ ],
+ "properties": {
+ "NodeInstance": {
+ "type": "integer",
+ "format": "int64",
+ "description": "Id of Node instance."
+ },
+ "NodeId": {
+ "type": "string",
+ "description": "Id of Node."
+ },
+ "UpgradeDomain": {
+ "type": "string",
+ "description": "Upgrade domain of Node."
+ },
+ "FaultDomain": {
+ "type": "string",
+ "description": "Fault domain of Node."
+ },
+ "IpAddressOrFQDN": {
+ "type": "string",
+ "description": "IP address or FQDN."
+ },
+ "Hostname": {
+ "type": "string",
+ "description": "Name of Host."
+ },
+ "IsSeedNode": {
+ "type": "boolean",
+ "description": "Indicates if it is seed node."
+ },
+ "NodeVersion": {
+ "type": "string",
+ "description": "Version of Node."
+ }
+ },
+ "required": [
+ "NodeInstance",
+ "NodeId",
+ "UpgradeDomain",
+ "FaultDomain",
+ "IpAddressOrFQDN",
+ "Hostname",
+ "IsSeedNode",
+ "NodeVersion"
+ ],
+ "x-ms-discriminator-value": "NodeAborted"
+ },
+ "NodeAddedToClusterEvent": {
+ "description": "Node Added event.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/NodeEvent"
+ }
+ ],
+ "properties": {
+ "NodeId": {
+ "type": "string",
+ "description": "Id of Node."
+ },
+ "NodeInstance": {
+ "type": "integer",
+ "format": "int64",
+ "description": "Id of Node instance."
+ },
+ "NodeType": {
+ "type": "string",
+ "description": "Type of Node."
+ },
+ "FabricVersion": {
+ "type": "string",
+ "description": "Fabric version."
+ },
+ "IpAddressOrFQDN": {
+ "type": "string",
+ "description": "IP address or FQDN."
+ },
+ "NodeCapacities": {
+ "type": "string",
+ "description": "Capacities."
+ }
+ },
+ "required": [
+ "NodeId",
+ "NodeInstance",
+ "NodeType",
+ "FabricVersion",
+ "IpAddressOrFQDN",
+ "NodeCapacities"
+ ],
+ "x-ms-discriminator-value": "NodeAddedToCluster"
+ },
+ "NodeClosedEvent": {
+ "description": "Node Closed event.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/NodeEvent"
+ }
+ ],
+ "properties": {
+ "NodeId": {
+ "type": "string",
+ "description": "Id of Node."
+ },
+ "NodeInstance": {
+ "type": "integer",
+ "format": "int64",
+ "description": "Id of Node instance."
+ },
+ "Error": {
+ "type": "string",
+ "description": "Describes error."
+ }
+ },
+ "required": [
+ "NodeId",
+ "NodeInstance",
+ "Error"
+ ],
+ "x-ms-discriminator-value": "NodeClosed"
+ },
+ "NodeDeactivateCompletedEvent": {
+ "description": "Node Deactivate Completed event.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/NodeEvent"
+ }
+ ],
+ "properties": {
+ "NodeInstance": {
+ "type": "integer",
+ "format": "int64",
+ "description": "Id of Node instance."
+ },
+ "EffectiveDeactivateIntent": {
+ "type": "string",
+ "description": "Describes deactivate intent."
+ },
+ "BatchIdsWithDeactivateIntent": {
+ "type": "string",
+ "description": "Batch Ids."
+ },
+ "StartTime": {
+ "type": "string",
+ "format": "date-time",
+ "description": "Start time."
+ }
+ },
+ "required": [
+ "NodeInstance",
+ "EffectiveDeactivateIntent",
+ "BatchIdsWithDeactivateIntent",
+ "StartTime"
+ ],
+ "x-ms-discriminator-value": "NodeDeactivateCompleted"
+ },
+ "NodeDeactivateStartedEvent": {
+ "description": "Node Deactivate Started event.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/NodeEvent"
+ }
+ ],
+ "properties": {
+ "NodeInstance": {
+ "type": "integer",
+ "format": "int64",
+ "description": "Id of Node instance."
+ },
+ "BatchId": {
+ "type": "string",
+ "description": "Batch Id."
+ },
+ "DeactivateIntent": {
+ "type": "string",
+ "description": "Describes deactivate intent."
+ }
+ },
+ "required": [
+ "NodeInstance",
+ "BatchId",
+ "DeactivateIntent"
+ ],
+ "x-ms-discriminator-value": "NodeDeactivateStarted"
+ },
+ "NodeDownEvent": {
+ "description": "Node Down event.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/NodeEvent"
+ }
+ ],
+ "properties": {
+ "NodeInstance": {
+ "type": "integer",
+ "format": "int64",
+ "description": "Id of Node instance."
+ },
+ "LastNodeUpAt": {
+ "type": "string",
+ "format": "date-time",
+ "description": "Time when Node was last up."
+ }
+ },
+ "required": [
+ "NodeInstance",
+ "LastNodeUpAt"
+ ],
+ "x-ms-discriminator-value": "NodeDown"
+ },
+ "NodeNewHealthReportEvent": {
+ "description": "Node Health Report Created event.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/NodeEvent"
+ }
+ ],
+ "properties": {
+ "NodeInstanceId": {
+ "type": "integer",
+ "format": "int64",
+ "description": "Id of Node instance."
+ },
+ "SourceId": {
+ "type": "string",
+ "description": "Id of report source."
+ },
+ "Property": {
+ "type": "string",
+ "description": "Describes the property."
+ },
+ "HealthState": {
+ "type": "string",
+ "description": "Describes the property health state."
+ },
+ "TimeToLiveMs": {
+ "type": "integer",
+ "format": "int64",
+ "description": "Time to live in milli-seconds."
+ },
+ "SequenceNumber": {
+ "type": "integer",
+ "format": "int64",
+ "description": "Sequence number of report."
+ },
+ "Description": {
+ "type": "string",
+ "description": "Description of report."
+ },
+ "RemoveWhenExpired": {
+ "type": "boolean",
+ "description": "Indicates the removal when it expires."
+ },
+ "SourceUtcTimestamp": {
+ "type": "string",
+ "format": "date-time",
+ "description": "Source time."
+ }
+ },
+ "required": [
+ "NodeInstanceId",
+ "SourceId",
+ "Property",
+ "HealthState",
+ "TimeToLiveMs",
+ "SequenceNumber",
+ "Description",
+ "RemoveWhenExpired",
+ "SourceUtcTimestamp"
+ ],
+ "x-ms-discriminator-value": "NodeNewHealthReport"
+ },
+ "NodeHealthReportExpiredEvent": {
+ "description": "Node Health Report Expired event.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/NodeEvent"
+ }
+ ],
+ "properties": {
+ "NodeInstanceId": {
+ "type": "integer",
+ "format": "int64",
+ "description": "Id of Node instance."
+ },
+ "SourceId": {
+ "type": "string",
+ "description": "Id of report source."
+ },
+ "Property": {
+ "type": "string",
+ "description": "Describes the property."
+ },
+ "HealthState": {
+ "type": "string",
+ "description": "Describes the property health state."
+ },
+ "TimeToLiveMs": {
+ "type": "integer",
+ "format": "int64",
+ "description": "Time to live in milli-seconds."
+ },
+ "SequenceNumber": {
+ "type": "integer",
+ "format": "int64",
+ "description": "Sequence number of report."
+ },
+ "Description": {
+ "type": "string",
+ "description": "Description of report."
+ },
+ "RemoveWhenExpired": {
+ "type": "boolean",
+ "description": "Indicates the removal when it expires."
+ },
+ "SourceUtcTimestamp": {
+ "type": "string",
+ "format": "date-time",
+ "description": "Source time."
+ }
+ },
+ "required": [
+ "NodeInstanceId",
+ "SourceId",
+ "Property",
+ "HealthState",
+ "TimeToLiveMs",
+ "SequenceNumber",
+ "Description",
+ "RemoveWhenExpired",
+ "SourceUtcTimestamp"
+ ],
+ "x-ms-discriminator-value": "NodeHealthReportExpired"
+ },
+ "NodeOpenSucceededEvent": {
+ "description": "Node Opened Succeeded event.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/NodeEvent"
+ }
+ ],
+ "properties": {
+ "NodeInstance": {
+ "type": "integer",
+ "format": "int64",
+ "description": "Id of Node instance."
+ },
+ "NodeId": {
+ "type": "string",
+ "description": "Id of Node."
+ },
+ "UpgradeDomain": {
+ "type": "string",
+ "description": "Upgrade domain of Node."
+ },
+ "FaultDomain": {
+ "type": "string",
+ "description": "Fault domain of Node."
+ },
+ "IpAddressOrFQDN": {
+ "type": "string",
+ "description": "IP address or FQDN."
+ },
+ "Hostname": {
+ "type": "string",
+ "description": "Name of Host."
+ },
+ "IsSeedNode": {
+ "type": "boolean",
+ "description": "Indicates if it is seed node."
+ },
+ "NodeVersion": {
+ "type": "string",
+ "description": "Version of Node."
+ }
+ },
+ "required": [
+ "NodeInstance",
+ "NodeId",
+ "UpgradeDomain",
+ "FaultDomain",
+ "IpAddressOrFQDN",
+ "Hostname",
+ "IsSeedNode",
+ "NodeVersion"
+ ],
+ "x-ms-discriminator-value": "NodeOpenSucceeded"
+ },
+ "NodeOpenFailedEvent": {
+ "description": "Node Open Failed event.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/NodeEvent"
+ }
+ ],
+ "properties": {
+ "NodeInstance": {
+ "type": "integer",
+ "format": "int64",
+ "description": "Id of Node instance."
+ },
+ "NodeId": {
+ "type": "string",
+ "description": "Id of Node."
+ },
+ "UpgradeDomain": {
+ "type": "string",
+ "description": "Upgrade domain of Node."
+ },
+ "FaultDomain": {
+ "type": "string",
+ "description": "Fault domain of Node."
+ },
+ "IpAddressOrFQDN": {
+ "type": "string",
+ "description": "IP address or FQDN."
+ },
+ "Hostname": {
+ "type": "string",
+ "description": "Name of Host."
+ },
+ "IsSeedNode": {
+ "type": "boolean",
+ "description": "Indicates if it is seed node."
+ },
+ "NodeVersion": {
+ "type": "string",
+ "description": "Version of Node."
+ },
+ "Error": {
+ "type": "string",
+ "description": "Describes the error."
+ }
+ },
+ "required": [
+ "NodeInstance",
+ "NodeId",
+ "UpgradeDomain",
+ "FaultDomain",
+ "IpAddressOrFQDN",
+ "Hostname",
+ "IsSeedNode",
+ "NodeVersion",
+ "Error"
+ ],
+ "x-ms-discriminator-value": "NodeOpenFailed"
+ },
+ "NodeRemovedFromClusterEvent": {
+ "description": "Node Removed event.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/NodeEvent"
+ }
+ ],
+ "properties": {
+ "NodeId": {
+ "type": "string",
+ "description": "Id of Node."
+ },
+ "NodeInstance": {
+ "type": "integer",
+ "format": "int64",
+ "description": "Id of Node instance."
+ },
+ "NodeType": {
+ "type": "string",
+ "description": "Type of Node."
+ },
+ "FabricVersion": {
+ "type": "string",
+ "description": "Fabric version."
+ },
+ "IpAddressOrFQDN": {
+ "type": "string",
+ "description": "IP address or FQDN."
+ },
+ "NodeCapacities": {
+ "type": "string",
+ "description": "Capacities."
+ }
+ },
+ "required": [
+ "NodeId",
+ "NodeInstance",
+ "NodeType",
+ "FabricVersion",
+ "IpAddressOrFQDN",
+ "NodeCapacities"
+ ],
+ "x-ms-discriminator-value": "NodeRemovedFromCluster"
+ },
+ "NodeUpEvent": {
+ "description": "Node Up event.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/NodeEvent"
+ }
+ ],
+ "properties": {
+ "NodeInstance": {
+ "type": "integer",
+ "format": "int64",
+ "description": "Id of Node instance."
+ },
+ "LastNodeDownAt": {
+ "type": "string",
+ "format": "date-time",
+ "description": "Time when Node was last down."
+ }
+ },
+ "required": [
+ "NodeInstance",
+ "LastNodeDownAt"
+ ],
+ "x-ms-discriminator-value": "NodeUp"
+ },
+ "PartitionNewHealthReportEvent": {
+ "description": "Partition Health Report Created event.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/PartitionEvent"
+ }
+ ],
+ "properties": {
+ "SourceId": {
+ "type": "string",
+ "description": "Id of report source."
+ },
+ "Property": {
+ "type": "string",
+ "description": "Describes the property."
+ },
+ "HealthState": {
+ "type": "string",
+ "description": "Describes the property health state."
+ },
+ "TimeToLiveMs": {
+ "type": "integer",
+ "format": "int64",
+ "description": "Time to live in milli-seconds."
+ },
+ "SequenceNumber": {
+ "type": "integer",
+ "format": "int64",
+ "description": "Sequence number of report."
+ },
+ "Description": {
+ "type": "string",
+ "description": "Description of report."
+ },
+ "RemoveWhenExpired": {
+ "type": "boolean",
+ "description": "Indicates the removal when it expires."
+ },
+ "SourceUtcTimestamp": {
+ "type": "string",
+ "format": "date-time",
+ "description": "Source time."
+ }
+ },
+ "required": [
+ "SourceId",
+ "Property",
+ "HealthState",
+ "TimeToLiveMs",
+ "SequenceNumber",
+ "Description",
+ "RemoveWhenExpired",
+ "SourceUtcTimestamp"
+ ],
+ "x-ms-discriminator-value": "PartitionNewHealthReport"
+ },
+ "PartitionHealthReportExpiredEvent": {
+ "description": "Partition Health Report Expired event.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/PartitionEvent"
+ }
+ ],
+ "properties": {
+ "SourceId": {
+ "type": "string",
+ "description": "Id of report source."
+ },
+ "Property": {
+ "type": "string",
+ "description": "Describes the property."
+ },
+ "HealthState": {
+ "type": "string",
+ "description": "Describes the property health state."
+ },
+ "TimeToLiveMs": {
+ "type": "integer",
+ "format": "int64",
+ "description": "Time to live in milli-seconds."
+ },
+ "SequenceNumber": {
+ "type": "integer",
+ "format": "int64",
+ "description": "Sequence number of report."
+ },
+ "Description": {
+ "type": "string",
+ "description": "Description of report."
+ },
+ "RemoveWhenExpired": {
+ "type": "boolean",
+ "description": "Indicates the removal when it expires."
+ },
+ "SourceUtcTimestamp": {
+ "type": "string",
+ "format": "date-time",
+ "description": "Source time."
+ }
+ },
+ "required": [
+ "SourceId",
+ "Property",
+ "HealthState",
+ "TimeToLiveMs",
+ "SequenceNumber",
+ "Description",
+ "RemoveWhenExpired",
+ "SourceUtcTimestamp"
+ ],
+ "x-ms-discriminator-value": "PartitionHealthReportExpired"
+ },
+ "PartitionReconfiguredEvent": {
+ "description": "Partition Reconfiguration event.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/PartitionEvent"
+ }
+ ],
+ "properties": {
+ "NodeName": {
+ "$ref": "#/definitions/NodeName",
+ "description": "The name of a Service Fabric node."
+ },
+ "NodeInstanceId": {
+ "type": "string",
+ "description": "Id of Node instance."
+ },
+ "ServiceType": {
+ "type": "string",
+ "description": "Type of Service."
+ },
+ "CcEpochDataLossVersion": {
+ "type": "integer",
+ "format": "int64",
+ "description": "CcEpochDataLoss version."
+ },
+ "CcEpochConfigVersion": {
+ "type": "integer",
+ "format": "int64",
+ "description": "CcEpochConfig version."
+ },
+ "ReconfigType": {
+ "type": "string",
+ "description": "Type of reconfiguration."
+ },
+ "Result": {
+ "type": "string",
+ "description": "Describes reconfiguration result."
+ },
+ "Phase0DurationMs": {
+ "type": "number",
+ "format": "double",
+ "description": "Duration of Phase0 in milli-seconds."
+ },
+ "Phase1DurationMs": {
+ "type": "number",
+ "format": "double",
+ "description": "Duration of Phase1 in milli-seconds."
+ },
+ "Phase2DurationMs": {
+ "type": "number",
+ "format": "double",
+ "description": "Duration of Phase2 in milli-seconds."
+ },
+ "Phase3DurationMs": {
+ "type": "number",
+ "format": "double",
+ "description": "Duration of Phase3 in milli-seconds."
+ },
+ "Phase4DurationMs": {
+ "type": "number",
+ "format": "double",
+ "description": "Duration of Phase4 in milli-seconds."
+ },
+ "TotalDurationMs": {
+ "type": "number",
+ "format": "double",
+ "description": "Total duration in milli-seconds."
+ }
+ },
+ "required": [
+ "NodeName",
+ "NodeInstanceId",
+ "ServiceType",
+ "CcEpochDataLossVersion",
+ "CcEpochConfigVersion",
+ "ReconfigType",
+ "Result",
+ "Phase0DurationMs",
+ "Phase1DurationMs",
+ "Phase2DurationMs",
+ "Phase3DurationMs",
+ "Phase4DurationMs",
+ "TotalDurationMs"
+ ],
+ "x-ms-discriminator-value": "PartitionReconfigured"
+ },
+ "PartitionPrimaryMoveAnalysisEvent": {
+ "description": "Partition Primary Move Analysis event.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/PartitionAnalysisEvent"
+ }
+ ],
+ "properties": {
+ "WhenMoveCompleted": {
+ "type": "string",
+ "format": "date-time",
+ "description": "Time when the move was completed."
+ },
+ "PreviousNode": {
+ "$ref": "#/definitions/NodeName",
+ "description": "The name of a Service Fabric node."
+ },
+ "CurrentNode": {
+ "$ref": "#/definitions/NodeName",
+ "description": "The name of a Service Fabric node."
+ },
+ "MoveReason": {
+ "type": "string",
+ "description": "Move reason."
+ },
+ "RelevantTraces": {
+ "type": "string",
+ "description": "Relevant traces."
+ }
+ },
+ "required": [
+ "WhenMoveCompleted",
+ "PreviousNode",
+ "CurrentNode",
+ "MoveReason",
+ "RelevantTraces"
+ ],
+ "x-ms-discriminator-value": "PartitionPrimaryMoveAnalysis"
+ },
+ "ServiceCreatedEvent": {
+ "description": "Service Created event.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ServiceEvent"
+ }
+ ],
+ "properties": {
+ "ServiceTypeName": {
+ "type": "string",
+ "description": "Service type name."
+ },
+ "ApplicationName": {
+ "type": "string",
+ "description": "Application name."
+ },
+ "ApplicationTypeName": {
+ "type": "string",
+ "description": "Application type name."
+ },
+ "ServiceInstance": {
+ "type": "integer",
+ "format": "int64",
+ "description": "Id of Service instance."
+ },
+ "IsStateful": {
+ "type": "boolean",
+ "description": "Indicates if Service is stateful."
+ },
+ "PartitionCount": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Number of partitions."
+ },
+ "TargetReplicaSetSize": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Size of target replicas set."
+ },
+ "MinReplicaSetSize": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Minimum size of replicas set."
+ },
+ "ServicePackageVersion": {
+ "type": "string",
+ "description": "Version of Service package."
+ },
+ "PartitionId": {
+ "$ref": "#/definitions/PartitionId",
+ "description": "An internal ID used by Service Fabric to uniquely identify a partition. This is a randomly generated GUID when the service was created. The partition ID is unique and does not change for the lifetime of the service. If the same service was deleted and recreated the IDs of its partitions would be different."
+ }
+ },
+ "required": [
+ "ServiceTypeName",
+ "ApplicationName",
+ "ApplicationTypeName",
+ "ServiceInstance",
+ "IsStateful",
+ "PartitionCount",
+ "TargetReplicaSetSize",
+ "MinReplicaSetSize",
+ "ServicePackageVersion",
+ "PartitionId"
+ ],
+ "x-ms-discriminator-value": "ServiceCreated"
+ },
+ "ServiceDeletedEvent": {
+ "description": "Service Deleted event.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ServiceEvent"
+ }
+ ],
+ "properties": {
+ "ServiceTypeName": {
+ "type": "string",
+ "description": "Service type name."
+ },
+ "ApplicationName": {
+ "type": "string",
+ "description": "Application name."
+ },
+ "ApplicationTypeName": {
+ "type": "string",
+ "description": "Application type name."
+ },
+ "ServiceInstance": {
+ "type": "integer",
+ "format": "int64",
+ "description": "Id of Service instance."
+ },
+ "IsStateful": {
+ "type": "boolean",
+ "description": "Indicates if Service is stateful."
+ },
+ "PartitionCount": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Number of partitions."
+ },
+ "TargetReplicaSetSize": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Size of target replicas set."
+ },
+ "MinReplicaSetSize": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Minimum size of replicas set."
+ },
+ "ServicePackageVersion": {
+ "type": "string",
+ "description": "Version of Service package."
+ }
+ },
+ "required": [
+ "ServiceTypeName",
+ "ApplicationName",
+ "ApplicationTypeName",
+ "ServiceInstance",
+ "IsStateful",
+ "PartitionCount",
+ "TargetReplicaSetSize",
+ "MinReplicaSetSize",
+ "ServicePackageVersion"
+ ],
+ "x-ms-discriminator-value": "ServiceDeleted"
+ },
+ "ServiceNewHealthReportEvent": {
+ "description": "Service Health Report Created event.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ServiceEvent"
+ }
+ ],
+ "properties": {
+ "InstanceId": {
+ "type": "integer",
+ "format": "int64",
+ "description": "Id of Service instance."
+ },
+ "SourceId": {
+ "type": "string",
+ "description": "Id of report source."
+ },
+ "Property": {
+ "type": "string",
+ "description": "Describes the property."
+ },
+ "HealthState": {
+ "type": "string",
+ "description": "Describes the property health state."
+ },
+ "TimeToLiveMs": {
+ "type": "integer",
+ "format": "int64",
+ "description": "Time to live in milli-seconds."
+ },
+ "SequenceNumber": {
+ "type": "integer",
+ "format": "int64",
+ "description": "Sequence number of report."
+ },
+ "Description": {
+ "type": "string",
+ "description": "Description of report."
+ },
+ "RemoveWhenExpired": {
+ "type": "boolean",
+ "description": "Indicates the removal when it expires."
+ },
+ "SourceUtcTimestamp": {
+ "type": "string",
+ "format": "date-time",
+ "description": "Source time."
+ }
+ },
+ "required": [
+ "InstanceId",
+ "SourceId",
+ "Property",
+ "HealthState",
+ "TimeToLiveMs",
+ "SequenceNumber",
+ "Description",
+ "RemoveWhenExpired",
+ "SourceUtcTimestamp"
+ ],
+ "x-ms-discriminator-value": "ServiceNewHealthReport"
+ },
+ "ServiceHealthReportExpiredEvent": {
+ "description": "Service Health Report Expired event.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ServiceEvent"
+ }
+ ],
+ "properties": {
+ "InstanceId": {
+ "type": "integer",
+ "format": "int64",
+ "description": "Id of Service instance."
+ },
+ "SourceId": {
+ "type": "string",
+ "description": "Id of report source."
+ },
+ "Property": {
+ "type": "string",
+ "description": "Describes the property."
+ },
+ "HealthState": {
+ "type": "string",
+ "description": "Describes the property health state."
+ },
+ "TimeToLiveMs": {
+ "type": "integer",
+ "format": "int64",
+ "description": "Time to live in milli-seconds."
+ },
+ "SequenceNumber": {
+ "type": "integer",
+ "format": "int64",
+ "description": "Sequence number of report."
+ },
+ "Description": {
+ "type": "string",
+ "description": "Description of report."
+ },
+ "RemoveWhenExpired": {
+ "type": "boolean",
+ "description": "Indicates the removal when it expires."
+ },
+ "SourceUtcTimestamp": {
+ "type": "string",
+ "format": "date-time",
+ "description": "Source time."
+ }
+ },
+ "required": [
+ "InstanceId",
+ "SourceId",
+ "Property",
+ "HealthState",
+ "TimeToLiveMs",
+ "SequenceNumber",
+ "Description",
+ "RemoveWhenExpired",
+ "SourceUtcTimestamp"
+ ],
+ "x-ms-discriminator-value": "ServiceHealthReportExpired"
+ },
+ "DeployedServicePackageNewHealthReportEvent": {
+ "description": "Deployed Service Health Report Created event.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ApplicationEvent"
+ }
+ ],
+ "properties": {
+ "ServiceManifestName": {
+ "type": "string",
+ "description": "Service manifest name."
+ },
+ "ServicePackageInstanceId": {
+ "type": "integer",
+ "format": "int64",
+ "description": "Id of Service package instance."
+ },
+ "ServicePackageActivationId": {
+ "type": "string",
+ "description": "Id of Service package activation."
+ },
+ "NodeName": {
+ "$ref": "#/definitions/NodeName",
+ "description": "The name of a Service Fabric node."
+ },
+ "SourceId": {
+ "type": "string",
+ "description": "Id of report source."
+ },
+ "Property": {
+ "type": "string",
+ "description": "Describes the property."
+ },
+ "HealthState": {
+ "type": "string",
+ "description": "Describes the property health state."
+ },
+ "TimeToLiveMs": {
+ "type": "integer",
+ "format": "int64",
+ "description": "Time to live in milli-seconds."
+ },
+ "SequenceNumber": {
+ "type": "integer",
+ "format": "int64",
+ "description": "Sequence number of report."
+ },
+ "Description": {
+ "type": "string",
+ "description": "Description of report."
+ },
+ "RemoveWhenExpired": {
+ "type": "boolean",
+ "description": "Indicates the removal when it expires."
+ },
+ "SourceUtcTimestamp": {
+ "type": "string",
+ "format": "date-time",
+ "description": "Source time."
+ }
+ },
+ "required": [
+ "ServiceManifestName",
+ "ServicePackageInstanceId",
+ "ServicePackageActivationId",
+ "NodeName",
+ "SourceId",
+ "Property",
+ "HealthState",
+ "TimeToLiveMs",
+ "SequenceNumber",
+ "Description",
+ "RemoveWhenExpired",
+ "SourceUtcTimestamp"
+ ],
+ "x-ms-discriminator-value": "DeployedServicePackageNewHealthReport"
+ },
+ "DeployedServicePackageHealthReportExpiredEvent": {
+ "description": "Deployed Service Health Report Expired event.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ApplicationEvent"
+ }
+ ],
+ "properties": {
+ "ServiceManifest": {
+ "type": "string",
+ "description": "Service manifest name."
+ },
+ "ServicePackageInstanceId": {
+ "type": "integer",
+ "format": "int64",
+ "description": "Id of Service package instance."
+ },
+ "ServicePackageActivationId": {
+ "type": "string",
+ "description": "Id of Service package activation."
+ },
+ "NodeName": {
+ "$ref": "#/definitions/NodeName",
+ "description": "The name of a Service Fabric node."
+ },
+ "SourceId": {
+ "type": "string",
+ "description": "Id of report source."
+ },
+ "Property": {
+ "type": "string",
+ "description": "Describes the property."
+ },
+ "HealthState": {
+ "type": "string",
+ "description": "Describes the property health state."
+ },
+ "TimeToLiveMs": {
+ "type": "integer",
+ "format": "int64",
+ "description": "Time to live in milli-seconds."
+ },
+ "SequenceNumber": {
+ "type": "integer",
+ "format": "int64",
+ "description": "Sequence number of report."
+ },
+ "Description": {
+ "type": "string",
+ "description": "Description of report."
+ },
+ "RemoveWhenExpired": {
+ "type": "boolean",
+ "description": "Indicates the removal when it expires."
+ },
+ "SourceUtcTimestamp": {
+ "type": "string",
+ "format": "date-time",
+ "description": "Source time."
+ }
+ },
+ "required": [
+ "ServiceManifest",
+ "ServicePackageInstanceId",
+ "ServicePackageActivationId",
+ "NodeName",
+ "SourceId",
+ "Property",
+ "HealthState",
+ "TimeToLiveMs",
+ "SequenceNumber",
+ "Description",
+ "RemoveWhenExpired",
+ "SourceUtcTimestamp"
+ ],
+ "x-ms-discriminator-value": "DeployedServicePackageHealthReportExpired"
+ },
+ "StatefulReplicaNewHealthReportEvent": {
+ "description": "Stateful Replica Health Report Created event.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ReplicaEvent"
+ }
+ ],
+ "properties": {
+ "ReplicaInstanceId": {
+ "type": "integer",
+ "format": "int64",
+ "description": "Id of Replica instance."
+ },
+ "SourceId": {
+ "type": "string",
+ "description": "Id of report source."
+ },
+ "Property": {
+ "type": "string",
+ "description": "Describes the property."
+ },
+ "HealthState": {
+ "type": "string",
+ "description": "Describes the property health state."
+ },
+ "TimeToLiveMs": {
+ "type": "integer",
+ "format": "int64",
+ "description": "Time to live in milli-seconds."
+ },
+ "SequenceNumber": {
+ "type": "integer",
+ "format": "int64",
+ "description": "Sequence number of report."
+ },
+ "Description": {
+ "type": "string",
+ "description": "Description of report."
+ },
+ "RemoveWhenExpired": {
+ "type": "boolean",
+ "description": "Indicates the removal when it expires."
+ },
+ "SourceUtcTimestamp": {
+ "type": "string",
+ "format": "date-time",
+ "description": "Source time."
+ }
+ },
+ "required": [
+ "ReplicaInstanceId",
+ "SourceId",
+ "Property",
+ "HealthState",
+ "TimeToLiveMs",
+ "SequenceNumber",
+ "Description",
+ "RemoveWhenExpired",
+ "SourceUtcTimestamp"
+ ],
+ "x-ms-discriminator-value": "StatefulReplicaNewHealthReport"
+ },
+ "StatefulReplicaHealthReportExpiredEvent": {
+ "description": "Stateful Replica Health Report Expired event.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ReplicaEvent"
+ }
+ ],
+ "properties": {
+ "ReplicaInstanceId": {
+ "type": "integer",
+ "format": "int64",
+ "description": "Id of Replica instance."
+ },
+ "SourceId": {
+ "type": "string",
+ "description": "Id of report source."
+ },
+ "Property": {
+ "type": "string",
+ "description": "Describes the property."
+ },
+ "HealthState": {
+ "type": "string",
+ "description": "Describes the property health state."
+ },
+ "TimeToLiveMs": {
+ "type": "integer",
+ "format": "int64",
+ "description": "Time to live in milli-seconds."
+ },
+ "SequenceNumber": {
+ "type": "integer",
+ "format": "int64",
+ "description": "Sequence number of report."
+ },
+ "Description": {
+ "type": "string",
+ "description": "Description of report."
+ },
+ "RemoveWhenExpired": {
+ "type": "boolean",
+ "description": "Indicates the removal when it expires."
+ },
+ "SourceUtcTimestamp": {
+ "type": "string",
+ "format": "date-time",
+ "description": "Source time."
+ }
+ },
+ "required": [
+ "ReplicaInstanceId",
+ "SourceId",
+ "Property",
+ "HealthState",
+ "TimeToLiveMs",
+ "SequenceNumber",
+ "Description",
+ "RemoveWhenExpired",
+ "SourceUtcTimestamp"
+ ],
+ "x-ms-discriminator-value": "StatefulReplicaHealthReportExpired"
+ },
+ "StatelessReplicaNewHealthReportEvent": {
+ "description": "Stateless Replica Health Report Created event.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ReplicaEvent"
+ }
+ ],
+ "properties": {
+ "SourceId": {
+ "type": "string",
+ "description": "Id of report source."
+ },
+ "Property": {
+ "type": "string",
+ "description": "Describes the property."
+ },
+ "HealthState": {
+ "type": "string",
+ "description": "Describes the property health state."
+ },
+ "TimeToLiveMs": {
+ "type": "integer",
+ "format": "int64",
+ "description": "Time to live in milli-seconds."
+ },
+ "SequenceNumber": {
+ "type": "integer",
+ "format": "int64",
+ "description": "Sequence number of report."
+ },
+ "Description": {
+ "type": "string",
+ "description": "Description of report."
+ },
+ "RemoveWhenExpired": {
+ "type": "boolean",
+ "description": "Indicates the removal when it expires."
+ },
+ "SourceUtcTimestamp": {
+ "type": "string",
+ "format": "date-time",
+ "description": "Source time."
+ }
+ },
+ "required": [
+ "SourceId",
+ "Property",
+ "HealthState",
+ "TimeToLiveMs",
+ "SequenceNumber",
+ "Description",
+ "RemoveWhenExpired",
+ "SourceUtcTimestamp"
+ ],
+ "x-ms-discriminator-value": "StatelessReplicaNewHealthReport"
+ },
+ "StatelessReplicaHealthReportExpiredEvent": {
+ "description": "Stateless Replica Health Report Expired event.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ReplicaEvent"
+ }
+ ],
+ "properties": {
+ "SourceId": {
+ "type": "string",
+ "description": "Id of report source."
+ },
+ "Property": {
+ "type": "string",
+ "description": "Describes the property."
+ },
+ "HealthState": {
+ "type": "string",
+ "description": "Describes the property health state."
+ },
+ "TimeToLiveMs": {
+ "type": "integer",
+ "format": "int64",
+ "description": "Time to live in milli-seconds."
+ },
+ "SequenceNumber": {
+ "type": "integer",
+ "format": "int64",
+ "description": "Sequence number of report."
+ },
+ "Description": {
+ "type": "string",
+ "description": "Description of report."
+ },
+ "RemoveWhenExpired": {
+ "type": "boolean",
+ "description": "Indicates the removal when it expires."
+ },
+ "SourceUtcTimestamp": {
+ "type": "string",
+ "format": "date-time",
+ "description": "Source time."
+ }
+ },
+ "required": [
+ "SourceId",
+ "Property",
+ "HealthState",
+ "TimeToLiveMs",
+ "SequenceNumber",
+ "Description",
+ "RemoveWhenExpired",
+ "SourceUtcTimestamp"
+ ],
+ "x-ms-discriminator-value": "StatelessReplicaHealthReportExpired"
+ },
+ "ClusterNewHealthReportEvent": {
+ "description": "Cluster Health Report Created event.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ClusterEvent"
+ }
+ ],
+ "properties": {
+ "SourceId": {
+ "type": "string",
+ "description": "Id of report source."
+ },
+ "Property": {
+ "type": "string",
+ "description": "Describes the property."
+ },
+ "HealthState": {
+ "type": "string",
+ "description": "Describes the property health state."
+ },
+ "TimeToLiveMs": {
+ "type": "integer",
+ "format": "int64",
+ "description": "Time to live in milli-seconds."
+ },
+ "SequenceNumber": {
+ "type": "integer",
+ "format": "int64",
+ "description": "Sequence number of report."
+ },
+ "Description": {
+ "type": "string",
+ "description": "Description of report."
+ },
+ "RemoveWhenExpired": {
+ "type": "boolean",
+ "description": "Indicates the removal when it expires."
+ },
+ "SourceUtcTimestamp": {
+ "type": "string",
+ "format": "date-time",
+ "description": "Source time."
+ }
+ },
+ "required": [
+ "SourceId",
+ "Property",
+ "HealthState",
+ "TimeToLiveMs",
+ "SequenceNumber",
+ "Description",
+ "RemoveWhenExpired",
+ "SourceUtcTimestamp"
+ ],
+ "x-ms-discriminator-value": "ClusterNewHealthReport"
+ },
+ "ClusterHealthReportExpiredEvent": {
+ "description": "Cluster Health Report Expired event.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ClusterEvent"
+ }
+ ],
+ "properties": {
+ "SourceId": {
+ "type": "string",
+ "description": "Id of report source."
+ },
+ "Property": {
+ "type": "string",
+ "description": "Describes the property."
+ },
+ "HealthState": {
+ "type": "string",
+ "description": "Describes the property health state."
+ },
+ "TimeToLiveMs": {
+ "type": "integer",
+ "format": "int64",
+ "description": "Time to live in milli-seconds."
+ },
+ "SequenceNumber": {
+ "type": "integer",
+ "format": "int64",
+ "description": "Sequence number of report."
+ },
+ "Description": {
+ "type": "string",
+ "description": "Description of report."
+ },
+ "RemoveWhenExpired": {
+ "type": "boolean",
+ "description": "Indicates the removal when it expires."
+ },
+ "SourceUtcTimestamp": {
+ "type": "string",
+ "format": "date-time",
+ "description": "Source time."
+ }
+ },
+ "required": [
+ "SourceId",
+ "Property",
+ "HealthState",
+ "TimeToLiveMs",
+ "SequenceNumber",
+ "Description",
+ "RemoveWhenExpired",
+ "SourceUtcTimestamp"
+ ],
+ "x-ms-discriminator-value": "ClusterHealthReportExpired"
+ },
+ "ClusterUpgradeCompletedEvent": {
+ "description": "Cluster Upgrade Completed event.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ClusterEvent"
+ }
+ ],
+ "properties": {
+ "TargetClusterVersion": {
+ "type": "string",
+ "description": "Target Cluster version."
+ },
+ "OverallUpgradeElapsedTimeInMs": {
+ "type": "number",
+ "format": "double",
+ "description": "Overall duration of upgrade in milli-seconds."
+ }
+ },
+ "required": [
+ "TargetClusterVersion",
+ "OverallUpgradeElapsedTimeInMs"
+ ],
+ "x-ms-discriminator-value": "ClusterUpgradeCompleted"
+ },
+ "ClusterUpgradeDomainCompletedEvent": {
+ "description": "Cluster Upgrade Domain Completed event.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ClusterEvent"
+ }
+ ],
+ "properties": {
+ "TargetClusterVersion": {
+ "type": "string",
+ "description": "Target Cluster version."
+ },
+ "UpgradeState": {
+ "type": "string",
+ "description": "State of upgrade."
+ },
+ "UpgradeDomains": {
+ "type": "string",
+ "description": "Upgrade domains."
+ },
+ "UpgradeDomainElapsedTimeInMs": {
+ "type": "number",
+ "format": "double",
+ "description": "Duration of domain upgrade in milli-seconds."
+ }
+ },
+ "required": [
+ "TargetClusterVersion",
+ "UpgradeState",
+ "UpgradeDomains",
+ "UpgradeDomainElapsedTimeInMs"
+ ],
+ "x-ms-discriminator-value": "ClusterUpgradeDomainCompleted"
+ },
+ "ClusterUpgradeRollbackCompletedEvent": {
+ "description": "Cluster Upgrade Rollback Completed event.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ClusterEvent"
+ }
+ ],
+ "properties": {
+ "TargetClusterVersion": {
+ "type": "string",
+ "description": "Target Cluster version."
+ },
+ "FailureReason": {
+ "type": "string",
+ "description": "Describes failure."
+ },
+ "OverallUpgradeElapsedTimeInMs": {
+ "type": "number",
+ "format": "double",
+ "description": "Overall duration of upgrade in milli-seconds."
+ }
+ },
+ "required": [
+ "TargetClusterVersion",
+ "FailureReason",
+ "OverallUpgradeElapsedTimeInMs"
+ ],
+ "x-ms-discriminator-value": "ClusterUpgradeRollbackCompleted"
+ },
+ "ClusterUpgradeRollbackStartedEvent": {
+ "description": "Cluster Upgrade Rollback Started event.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ClusterEvent"
+ }
+ ],
+ "properties": {
+ "TargetClusterVersion": {
+ "type": "string",
+ "description": "Target Cluster version."
+ },
+ "FailureReason": {
+ "type": "string",
+ "description": "Describes failure."
+ },
+ "OverallUpgradeElapsedTimeInMs": {
+ "type": "number",
+ "format": "double",
+ "description": "Overall duration of upgrade in milli-seconds."
+ }
+ },
+ "required": [
+ "TargetClusterVersion",
+ "FailureReason",
+ "OverallUpgradeElapsedTimeInMs"
+ ],
+ "x-ms-discriminator-value": "ClusterUpgradeRollbackStarted"
+ },
+ "ClusterUpgradeStartedEvent": {
+ "description": "Cluster Upgrade Started event.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ClusterEvent"
+ }
+ ],
+ "properties": {
+ "CurrentClusterVersion": {
+ "type": "string",
+ "description": "Current Cluster version."
+ },
+ "TargetClusterVersion": {
+ "type": "string",
+ "description": "Target Cluster version."
+ },
+ "UpgradeType": {
+ "type": "string",
+ "description": "Type of upgrade."
+ },
+ "RollingUpgradeMode": {
+ "type": "string",
+ "description": "Mode of upgrade."
+ },
+ "FailureAction": {
+ "type": "string",
+ "description": "Action if failed."
+ }
+ },
+ "required": [
+ "CurrentClusterVersion",
+ "TargetClusterVersion",
+ "UpgradeType",
+ "RollingUpgradeMode",
+ "FailureAction"
+ ],
+ "x-ms-discriminator-value": "ClusterUpgradeStarted"
+ },
+ "ChaosStoppedEvent": {
+ "description": "Chaos Stopped event.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ClusterEvent"
+ }
+ ],
+ "properties": {
+ "Reason": {
+ "type": "string",
+ "description": "Describes reason."
+ }
+ },
+ "required": [
+ "Reason"
+ ],
+ "x-ms-discriminator-value": "ChaosStopped"
+ },
+ "ChaosStartedEvent": {
+ "description": "Chaos Started event.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ClusterEvent"
+ }
+ ],
+ "properties": {
+ "MaxConcurrentFaults": {
+ "type": "integer",
+ "format": "int64",
+ "description": "Maximum number of concurrent faults."
+ },
+ "TimeToRunInSeconds": {
+ "type": "number",
+ "format": "double",
+ "description": "Time to run in seconds."
+ },
+ "MaxClusterStabilizationTimeoutInSeconds": {
+ "type": "number",
+ "format": "double",
+ "description": "Maximum timeout for cluster stabilization in seconds."
+ },
+ "WaitTimeBetweenIterationsInSeconds": {
+ "type": "number",
+ "format": "double",
+ "description": "Wait time between iterations in seconds."
+ },
+ "WaitTimeBetweenFaultsInSeconds": {
+ "type": "number",
+ "format": "double",
+ "description": "Wait time between faults in seconds."
+ },
+ "MoveReplicaFaultEnabled": {
+ "type": "boolean",
+ "description": "Indicates MoveReplica fault is enabled."
+ },
+ "IncludedNodeTypeList": {
+ "type": "string",
+ "description": "List of included Node types."
+ },
+ "IncludedApplicationList": {
+ "type": "string",
+ "description": "List of included Applications."
+ },
+ "ClusterHealthPolicy": {
+ "type": "string",
+ "description": "Health policy."
+ },
+ "ChaosContext": {
+ "type": "string",
+ "description": "Chaos Context."
+ }
+ },
+ "required": [
+ "MaxConcurrentFaults",
+ "TimeToRunInSeconds",
+ "MaxClusterStabilizationTimeoutInSeconds",
+ "WaitTimeBetweenIterationsInSeconds",
+ "WaitTimeBetweenFaultsInSeconds",
+ "MoveReplicaFaultEnabled",
+ "IncludedNodeTypeList",
+ "IncludedApplicationList",
+ "ClusterHealthPolicy",
+ "ChaosContext"
+ ],
+ "x-ms-discriminator-value": "ChaosStarted"
+ },
+ "ChaosCodePackageRestartScheduledEvent": {
+ "description": "Chaos Restart Code Package Fault Scheduled event.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ApplicationEvent"
+ }
+ ],
+ "properties": {
+ "FaultGroupId": {
+ "type": "string",
+ "format": "uuid",
+ "description": "Id of fault group."
+ },
+ "FaultId": {
+ "type": "string",
+ "format": "uuid",
+ "description": "Id of fault."
+ },
+ "NodeName": {
+ "$ref": "#/definitions/NodeName",
+ "description": "The name of a Service Fabric node."
+ },
+ "ServiceManifestName": {
+ "type": "string",
+ "description": "Service manifest name."
+ },
+ "CodePackageName": {
+ "type": "string",
+ "description": "Code package name."
+ },
+ "ServicePackageActivationId": {
+ "type": "string",
+ "description": "Id of Service package activation."
+ }
+ },
+ "required": [
+ "FaultGroupId",
+ "FaultId",
+ "NodeName",
+ "ServiceManifestName",
+ "CodePackageName",
+ "ServicePackageActivationId"
+ ],
+ "x-ms-discriminator-value": "ChaosCodePackageRestartScheduled"
+ },
+ "ChaosReplicaRemovalScheduledEvent": {
+ "description": "Chaos Remove Replica Fault Scheduled event.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ReplicaEvent"
+ }
+ ],
+ "properties": {
+ "FaultGroupId": {
+ "type": "string",
+ "format": "uuid",
+ "description": "Id of fault group."
+ },
+ "FaultId": {
+ "type": "string",
+ "format": "uuid",
+ "description": "Id of fault."
+ },
+ "ServiceUri": {
+ "type": "string",
+ "description": "Service name."
+ }
+ },
+ "required": [
+ "FaultGroupId",
+ "FaultId",
+ "ServiceUri"
+ ],
+ "x-ms-discriminator-value": "ChaosReplicaRemovalScheduled"
+ },
+ "ChaosPartitionSecondaryMoveScheduledEvent": {
+ "description": "Chaos Move Secondary Fault Scheduled event.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/PartitionEvent"
+ }
+ ],
+ "properties": {
+ "FaultGroupId": {
+ "type": "string",
+ "format": "uuid",
+ "description": "Id of fault group."
+ },
+ "FaultId": {
+ "type": "string",
+ "format": "uuid",
+ "description": "Id of fault."
+ },
+ "ServiceName": {
+ "type": "string",
+ "description": "Service name."
+ },
+ "SourceNode": {
+ "$ref": "#/definitions/NodeName",
+ "description": "The name of a Service Fabric node."
+ },
+ "DestinationNode": {
+ "$ref": "#/definitions/NodeName",
+ "description": "The name of a Service Fabric node."
+ },
+ "ForcedMove": {
+ "type": "boolean",
+ "description": "Indicates a forced move."
+ }
+ },
+ "required": [
+ "FaultGroupId",
+ "FaultId",
+ "ServiceName",
+ "SourceNode",
+ "DestinationNode",
+ "ForcedMove"
+ ],
+ "x-ms-discriminator-value": "ChaosPartitionSecondaryMoveScheduled"
+ },
+ "ChaosPartitionPrimaryMoveScheduledEvent": {
+ "description": "Chaos Move Primary Fault Scheduled event.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/PartitionEvent"
+ }
+ ],
+ "properties": {
+ "FaultGroupId": {
+ "type": "string",
+ "format": "uuid",
+ "description": "Id of fault group."
+ },
+ "FaultId": {
+ "type": "string",
+ "format": "uuid",
+ "description": "Id of fault."
+ },
+ "ServiceName": {
+ "type": "string",
+ "description": "Service name."
+ },
+ "NodeTo": {
+ "$ref": "#/definitions/NodeName",
+ "description": "The name of a Service Fabric node."
+ },
+ "ForcedMove": {
+ "type": "boolean",
+ "description": "Indicates a forced move."
+ }
+ },
+ "required": [
+ "FaultGroupId",
+ "FaultId",
+ "ServiceName",
+ "NodeTo",
+ "ForcedMove"
+ ],
+ "x-ms-discriminator-value": "ChaosPartitionPrimaryMoveScheduled"
+ },
+ "ChaosReplicaRestartScheduledEvent": {
+ "description": "Chaos Restart Replica Fault Scheduled event.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ReplicaEvent"
+ }
+ ],
+ "properties": {
+ "FaultGroupId": {
+ "type": "string",
+ "format": "uuid",
+ "description": "Id of fault group."
+ },
+ "FaultId": {
+ "type": "string",
+ "format": "uuid",
+ "description": "Id of fault."
+ },
+ "ServiceUri": {
+ "type": "string",
+ "description": "Service name."
+ }
+ },
+ "required": [
+ "FaultGroupId",
+ "FaultId",
+ "ServiceUri"
+ ],
+ "x-ms-discriminator-value": "ChaosReplicaRestartScheduled"
+ },
+ "ChaosNodeRestartScheduledEvent": {
+ "description": "Chaos Restart Node Fault Scheduled event.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/NodeEvent"
+ }
+ ],
+ "properties": {
+ "NodeInstanceId": {
+ "type": "integer",
+ "format": "int64",
+ "description": "Id of Node instance."
+ },
+ "FaultGroupId": {
+ "type": "string",
+ "format": "uuid",
+ "description": "Id of fault group."
+ },
+ "FaultId": {
+ "type": "string",
+ "format": "uuid",
+ "description": "Id of fault."
+ }
+ },
+ "required": [
+ "NodeInstanceId",
+ "FaultGroupId",
+ "FaultId"
+ ],
+ "x-ms-discriminator-value": "ChaosNodeRestartScheduled"
+ },
+ "ManagedApplicationIdentityDescription": {
+ "description": "Managed application identity description.",
+ "properties": {
+ "TokenServiceEndpoint": {
+ "type": "string",
+ "description": "Token service endpoint."
+ },
+ "ManagedIdentities": {
+ "$ref": "#/definitions/ManagedApplicationIdentityList",
+ "description": "A list of managed application identity objects."
+ }
+ }
+ },
+ "ManagedApplicationIdentityList": {
+ "description": "A list of managed application identity objects.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ManagedApplicationIdentity"
+ }
+ },
+ "ManagedApplicationIdentity": {
+ "description": "Describes a managed application identity.",
+ "required": [
+ "Name"
+ ],
+ "properties": {
+ "Name": {
+ "type": "string",
+ "description": "The name of the identity."
+ },
+ "PrincipalId": {
+ "type": "string",
+ "description": "The identity's PrincipalId."
+ }
+ }
+ },
+ "InstanceCloseDelayDurationInSeconds": {
+ "type": "integer",
+ "format": "int64",
+ "description": "Duration in seconds, to wait before a stateless instance is closed, to allow the active requests to drain gracefully. This would be effective when the instance is closing during the application/cluster\nupgrade, only for those instances which have a non-zero delay duration configured in the service description. See InstanceCloseDelayDurationSeconds property in $ref: \"#/definitions/StatelessServiceDescription.yaml\" for details.\nNote, the default value of InstanceCloseDelayDurationInSeconds is 4294967295, which indicates that the behavior will entirely depend on the delay configured in the stateless service description.",
+ "default": 4294967295
+ },
+ "ResourceStatus": {
+ "description": "Status of the resource.",
+ "type": "string",
+ "enum": [
+ "Unknown",
+ "Ready",
+ "Upgrading",
+ "Creating",
+ "Deleting",
+ "Failed"
+ ],
+ "x-ms-enum": {
+ "name": "ResourceStatus",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "Unknown",
+ "description": "Indicates the resource status is unknown. The value is zero."
+ },
+ {
+ "value": "Ready",
+ "description": "Indicates the resource is ready. The value is 1."
+ },
+ {
+ "value": "Upgrading",
+ "description": "Indicates the resource is upgrading. The value is 2."
+ },
+ {
+ "value": "Creating",
+ "description": "Indicates the resource is being created. The value is 3."
+ },
+ {
+ "value": "Deleting",
+ "description": "Indicates the resource is being deleted. The value is 4."
+ },
+ {
+ "value": "Failed",
+ "description": "Indicates the resource is not functional due to persistent failures. See statusDetails property for more details. The value is 5."
+ }
+ ]
+ }
+ },
+ "SecretKind": {
+ "type": "string",
+ "description": "Describes the kind of secret.",
+ "enum": [
+ "inlinedValue",
+ "keyVaultVersionedReference"
+ ],
+ "x-ms-enum": {
+ "name": "SecretKind",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "inlinedValue",
+ "description": "A simple secret resource whose plaintext value is provided by the user."
+ },
+ {
+ "value": "keyVaultVersionedReference",
+ "description": "A secret resource that references a specific version of a secret stored in Azure Key Vault; the expected value is a versioned KeyVault URI corresponding to the version of the secret being referenced."
+ }
+ ]
+ }
+ },
+ "SecretResourceProperties": {
+ "description": "Describes the properties of a secret resource.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/SecretResourcePropertiesBase"
+ }
+ ],
+ "properties": {
+ "description": {
+ "description": "User readable description of the secret.",
+ "type": "string"
+ },
+ "status": {
+ "readOnly": true,
+ "$ref": "#/definitions/ResourceStatus",
+ "description": "Status of the resource."
+ },
+ "statusDetails": {
+ "readOnly": true,
+ "type": "string",
+ "description": "Gives additional information about the current status of the secret."
+ },
+ "contentType": {
+ "type": "string",
+ "description": "The type of the content stored in the secret value. The value of this property is opaque to Service Fabric. Once set, the value of this property cannot be changed."
+ }
+ }
+ },
+ "InlinedValueSecretResourceProperties": {
+ "description": "Describes the properties of a secret resource whose value is provided explicitly as plaintext. The secret resource may have multiple values, each being uniquely versioned. The secret value of each version is stored encrypted, and delivered as plaintext into the context of applications referencing it.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/SecretResourceProperties"
+ }
+ ],
+ "x-ms-discriminator-value": "inlinedValue"
+ },
+ "SecretResourceName": {
+ "type": "string",
+ "description": "Name of the Secret resource."
+ },
+ "SecretResourceDescription": {
+ "description": "This type describes a secret resource.",
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/SecretResourceProperties",
+ "description": "Describes the properties of a secret resource."
+ },
+ "name": {
+ "$ref": "#/definitions/SecretResourceName",
+ "description": "Name of the Secret resource."
+ }
+ },
+ "required": [
+ "name",
+ "properties"
+ ]
+ },
+ "PagedSecretResourceDescriptionList": {
+ "type": "object",
+ "description": "The list of secret resources. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.",
+ "properties": {
+ "ContinuationToken": {
+ "$ref": "#/definitions/ContinuationToken",
+ "description": "The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token is not included in the response."
+ },
+ "Items": {
+ "type": "array",
+ "description": "One page of the list.",
+ "items": {
+ "$ref": "#/definitions/SecretResourceDescription"
+ }
+ }
+ }
+ },
+ "SecretResourcePropertiesBase": {
+ "discriminator": "kind",
+ "description": "This type describes the properties of a secret resource, including its kind.",
+ "type": "object",
+ "properties": {
+ "kind": {
+ "$ref": "#/definitions/SecretKind",
+ "description": "Describes the kind of secret."
+ }
+ },
+ "required": [
+ "kind"
+ ]
+ },
+ "SecretValue": {
+ "type": "object",
+ "description": "This type represents the unencrypted value of the secret.",
+ "properties": {
+ "value": {
+ "type": "string",
+ "description": "The actual value of the secret."
+ }
+ }
+ },
+ "SecretValueProperties": {
+ "type": "object",
+ "description": "This type describes properties of secret value resource.",
+ "properties": {
+ "value": {
+ "type": "string",
+ "description": "The actual value of the secret."
+ }
+ }
+ },
+ "SecretValueResourceDescription": {
+ "description": "This type describes a value of a secret resource. The name of this resource is the version identifier corresponding to this secret value.",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "Version identifier of the secret value."
+ },
+ "properties": {
+ "x-ms-client-flatten": true,
+ "$ref": "#/definitions/SecretValueResourceProperties",
+ "description": "This type describes properties of a secret value resource."
+ }
+ },
+ "required": [
+ "name",
+ "properties"
+ ]
+ },
+ "PagedSecretValueResourceDescriptionList": {
+ "type": "object",
+ "description": "The list of values of a secret resource, paged if the number of results exceeds the limits of a single message. The next set of results can be obtained by executing the same query with the continuation token provided in the previous page.",
+ "properties": {
+ "ContinuationToken": {
+ "$ref": "#/definitions/ContinuationToken",
+ "description": "The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token is not included in the response."
+ },
+ "Items": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/SecretValueResourceDescription"
+ },
+ "description": "One page of the list."
+ }
+ }
+ },
+ "SecretValueResourceProperties": {
+ "description": "This type describes properties of a secret value resource.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/SecretValueProperties"
+ }
+ ]
+ },
+ "VolumeProperties": {
+ "description": "Describes properties of a volume resource.",
+ "properties": {
+ "description": {
+ "type": "string",
+ "description": "User readable description of the volume."
+ },
+ "status": {
+ "readOnly": true,
+ "$ref": "#/definitions/ResourceStatus",
+ "description": "Status of the volume."
+ },
+ "statusDetails": {
+ "readOnly": true,
+ "type": "string",
+ "description": "Gives additional information about the current status of the volume."
+ },
+ "provider": {
+ "$ref": "#/definitions/VolumeProvider",
+ "description": "Provider of the volume."
+ },
+ "azureFileParameters": {
+ "$ref": "#/definitions/VolumeProviderParametersAzureFile",
+ "description": "This type describes a volume provided by an Azure Files file share."
+ }
+ },
+ "required": [
+ "provider"
+ ]
+ },
+ "VolumeProvider": {
+ "type": "string",
+ "description": "Describes the provider of the volume resource.",
+ "enum": [
+ "SFAzureFile"
+ ],
+ "x-ms-enum": {
+ "name": "VolumeProvider",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "SFAzureFile",
+ "description": "Provides volumes that are backed by Azure Files."
+ }
+ ]
+ }
+ },
+ "VolumeProviderParametersAzureFile": {
+ "description": "This type describes a volume provided by an Azure Files file share.",
+ "properties": {
+ "accountName": {
+ "description": "Name of the Azure storage account for the File Share.",
+ "type": "string"
+ },
+ "accountKey": {
+ "description": "Access key of the Azure storage account for the File Share.",
+ "type": "string"
+ },
+ "shareName": {
+ "description": "Name of the Azure Files file share that provides storage for the volume.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "accountName",
+ "shareName"
+ ]
+ },
+ "VolumeReference": {
+ "description": "Describes a reference to a volume resource.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "Name of the volume being referenced."
+ },
+ "readOnly": {
+ "type": "boolean",
+ "description": "The flag indicating whether the volume is read only. Default is 'false'."
+ },
+ "destinationPath": {
+ "type": "string",
+ "description": "The path within the container at which the volume should be mounted. Only valid path characters are allowed."
+ }
+ },
+ "required": [
+ "name",
+ "destinationPath"
+ ]
+ },
+ "ApplicationScopedVolume": {
+ "description": "Describes a volume whose lifetime is scoped to the application's lifetime.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/VolumeReference"
+ }
+ ],
+ "properties": {
+ "creationParameters": {
+ "$ref": "#/definitions/ApplicationScopedVolumeCreationParameters",
+ "description": "Describes parameters for creating application-scoped volumes."
+ }
+ },
+ "required": [
+ "creationParameters"
+ ]
+ },
+ "ApplicationScopedVolumeCreationParameters": {
+ "description": "Describes parameters for creating application-scoped volumes.",
+ "type": "object",
+ "discriminator": "kind",
+ "properties": {
+ "kind": {
+ "$ref": "#/definitions/ApplicationScopedVolumeKind",
+ "description": "Specifies the application-scoped volume kind."
+ },
+ "description": {
+ "description": "User readable description of the volume.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "kind"
+ ]
+ },
+ "ApplicationScopedVolumeCreationParametersServiceFabricVolumeDisk": {
+ "description": "Describes parameters for creating application-scoped volumes provided by Service Fabric Volume Disks",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ApplicationScopedVolumeCreationParameters"
+ }
+ ],
+ "properties": {
+ "sizeDisk": {
+ "description": "Volume size",
+ "type": "string",
+ "enum": [
+ "Small",
+ "Medium",
+ "Large"
+ ],
+ "x-ms-enum": {
+ "name": "SizeTypes",
+ "modelAsString": true
+ }
+ }
+ },
+ "required": [
+ "sizeDisk"
+ ],
+ "x-ms-discriminator-value": "ServiceFabricVolumeDisk"
+ },
+ "ApplicationScopedVolumeKind": {
+ "description": "Specifies the application-scoped volume kind.",
+ "type": "string",
+ "enum": [
+ "ServiceFabricVolumeDisk"
+ ],
+ "x-ms-enum": {
+ "name": "ApplicationScopedVolumeKind",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "ServiceFabricVolumeDisk",
+ "description": "Provides Service Fabric High Availability Volume Disk"
+ }
+ ]
+ }
+ },
+ "VolumeResourceName": {
+ "type": "string",
+ "description": "Name of the Volume resource."
+ },
+ "VolumeResourceDescription": {
+ "description": "This type describes a volume resource.",
+ "properties": {
+ "name": {
+ "$ref": "#/definitions/VolumeResourceName",
+ "description": "Name of the Volume resource."
+ },
+ "properties": {
+ "x-ms-client-flatten": true,
+ "$ref": "#/definitions/VolumeProperties",
+ "description": "Describes properties of a volume resource."
+ }
+ },
+ "required": [
+ "name",
+ "properties"
+ ]
+ },
+ "PagedVolumeResourceDescriptionList": {
+ "type": "object",
+ "description": "The list of volume resources. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.",
+ "properties": {
+ "ContinuationToken": {
+ "$ref": "#/definitions/ContinuationToken",
+ "description": "The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token is not included in the response."
+ },
+ "Items": {
+ "type": "array",
+ "description": "One page of the list.",
+ "items": {
+ "$ref": "#/definitions/VolumeResourceDescription"
+ }
+ }
+ }
+ },
+ "NetworkAddressPrefix": {
+ "type": "string",
+ "description": "Address space for a container network. This is expressed in CIDR notation."
+ },
+ "NetworkRef": {
+ "description": "Describes a network reference in a service.",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "Name of the network"
+ },
+ "endpointRefs": {
+ "description": "A list of endpoints that are exposed on this network.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/EndpointRef"
+ }
+ }
+ }
+ },
+ "EndpointRef": {
+ "description": "Describes a reference to a service endpoint.",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "Name of the endpoint."
+ }
+ }
+ },
+ "NetworkKind": {
+ "type": "string",
+ "description": "The type of a Service Fabric container network.",
+ "enum": [
+ "Local"
+ ],
+ "x-ms-enum": {
+ "name": "NetworkKind",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "Local",
+ "description": "Indicates a container network local to a single Service Fabric cluster. The value is 1."
+ }
+ ]
+ }
+ },
+ "NetworkResourceProperties": {
+ "description": "Describes properties of a network resource.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/NetworkResourcePropertiesBase"
+ }
+ ],
+ "properties": {
+ "description": {
+ "type": "string",
+ "description": "User readable description of the network."
+ },
+ "status": {
+ "readOnly": true,
+ "$ref": "#/definitions/ResourceStatus",
+ "description": "Status of the network."
+ },
+ "statusDetails": {
+ "readOnly": true,
+ "type": "string",
+ "description": "Gives additional information about the current status of the network."
+ }
+ }
+ },
+ "LocalNetworkResourceProperties": {
+ "description": "Information about a Service Fabric container network local to a single Service Fabric cluster.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/NetworkResourceProperties"
+ }
+ ],
+ "x-ms-discriminator-value": "Local",
+ "properties": {
+ "networkAddressPrefix": {
+ "$ref": "#/definitions/NetworkAddressPrefix",
+ "description": "Address space for the local container network."
+ }
+ }
+ },
+ "NetworkResourceName": {
+ "type": "string",
+ "description": "Name of the Network resource."
+ },
+ "NetworkResourceDescription": {
+ "description": "This type describes a network resource.",
+ "properties": {
+ "name": {
+ "$ref": "#/definitions/NetworkResourceName",
+ "description": "Name of the Network resource."
+ },
+ "properties": {
+ "$ref": "#/definitions/NetworkResourceProperties",
+ "description": "Describes properties of a network resource."
+ }
+ },
+ "required": [
+ "name",
+ "properties"
+ ]
+ },
+ "NetworkResourcePropertiesBase": {
+ "discriminator": "kind",
+ "description": "This type describes the properties of a network resource, including its kind.",
+ "type": "object",
+ "properties": {
+ "kind": {
+ "$ref": "#/definitions/NetworkKind",
+ "description": "The type of a Service Fabric container network."
+ }
+ },
+ "required": [
+ "kind"
+ ]
+ },
+ "PagedNetworkResourceDescriptionList": {
+ "type": "object",
+ "description": "The list of network resources. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.",
+ "properties": {
+ "ContinuationToken": {
+ "$ref": "#/definitions/ContinuationToken",
+ "description": "The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token is not included in the response."
+ },
+ "Items": {
+ "type": "array",
+ "description": "One page of the list.",
+ "items": {
+ "$ref": "#/definitions/NetworkResourceDescription"
+ }
+ }
+ }
+ },
+ "GatewayDestination": {
+ "description": "Describes destination endpoint for routing traffic.",
+ "type": "object",
+ "properties": {
+ "applicationName": {
+ "type": "string",
+ "description": "Name of the service fabric Mesh application."
+ },
+ "serviceName": {
+ "type": "string",
+ "description": "service that contains the endpoint."
+ },
+ "endpointName": {
+ "type": "string",
+ "description": "name of the endpoint in the service."
+ }
+ },
+ "required": [
+ "applicationName",
+ "endpointName",
+ "serviceName"
+ ]
+ },
+ "GatewayProperties": {
+ "description": "Describes properties of a gateway resource.",
+ "properties": {
+ "description": {
+ "description": "User readable description of the gateway.",
+ "type": "string"
+ },
+ "sourceNetwork": {
+ "$ref": "#/definitions/NetworkRef",
+ "description": "Network the gateway should listen on for requests."
+ },
+ "destinationNetwork": {
+ "$ref": "#/definitions/NetworkRef",
+ "description": "Network that the Application is using."
+ },
+ "tcp": {
+ "description": "Configuration for tcp connectivity for this gateway.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/TcpConfig"
+ }
+ },
+ "http": {
+ "description": "Configuration for http connectivity for this gateway.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/HttpConfig"
+ }
+ },
+ "status": {
+ "readOnly": true,
+ "$ref": "#/definitions/ResourceStatus",
+ "description": "Status of the resource."
+ },
+ "statusDetails": {
+ "readOnly": true,
+ "type": "string",
+ "description": "Gives additional information about the current status of the gateway."
+ },
+ "ipAddress": {
+ "readOnly": true,
+ "type": "string",
+ "description": "IP address of the gateway. This is populated in the response and is ignored for incoming requests."
+ }
+ },
+ "required": [
+ "destinationNetwork",
+ "sourceNetwork"
+ ]
+ },
+ "HttpConfig": {
+ "description": "Describes the http configuration for external connectivity for this network.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "http gateway config name."
+ },
+ "port": {
+ "type": "integer",
+ "description": "Specifies the port at which the service endpoint below needs to be exposed."
+ },
+ "hosts": {
+ "type": "array",
+ "description": "description for routing.",
+ "items": {
+ "$ref": "#/definitions/HttpHostConfig"
+ }
+ }
+ },
+ "required": [
+ "hosts",
+ "name",
+ "port"
+ ]
+ },
+ "HttpHostConfig": {
+ "description": "Describes the hostname properties for http routing.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "http hostname config name."
+ },
+ "routes": {
+ "type": "array",
+ "description": "Route information to use for routing. Routes are processed in the order they are specified. Specify routes that are more specific before routes that can handle general cases.",
+ "items": {
+ "$ref": "#/definitions/HttpRouteConfig"
+ }
+ }
+ },
+ "required": [
+ "name",
+ "routes"
+ ]
+ },
+ "HttpRouteConfig": {
+ "description": "Describes the hostname properties for http routing.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "http route name."
+ },
+ "match": {
+ "$ref": "#/definitions/HttpRouteMatchRule",
+ "description": "Describes a rule for http route matching."
+ },
+ "destination": {
+ "$ref": "#/definitions/GatewayDestination",
+ "description": "Describes destination endpoint for routing traffic."
+ }
+ },
+ "required": [
+ "destination",
+ "match",
+ "name"
+ ]
+ },
+ "HttpRouteMatchHeader": {
+ "description": "Describes header information for http route matching.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "Name of header to match in request."
+ },
+ "value": {
+ "type": "string",
+ "description": "Value of header to match in request."
+ },
+ "type": {
+ "type": "string",
+ "description": "how to match header value",
+ "enum": [
+ "exact"
+ ],
+ "x-ms-enum": {
+ "name": "HeaderMatchType",
+ "modelAsString": true
+ }
+ }
+ },
+ "required": [
+ "name"
+ ]
+ },
+ "HttpRouteMatchPath": {
+ "description": "Path to match for routing.",
+ "type": "object",
+ "properties": {
+ "value": {
+ "type": "string",
+ "description": "Uri path to match for request."
+ },
+ "rewrite": {
+ "type": "string",
+ "description": "replacement string for matched part of the Uri."
+ },
+ "type": {
+ "type": "string",
+ "description": "how to match value in the Uri",
+ "enum": [
+ "prefix"
+ ],
+ "x-ms-enum": {
+ "name": "PathMatchType",
+ "modelAsString": true
+ }
+ }
+ },
+ "required": [
+ "type",
+ "value"
+ ]
+ },
+ "HttpRouteMatchRule": {
+ "description": "Describes a rule for http route matching.",
+ "type": "object",
+ "properties": {
+ "path": {
+ "$ref": "#/definitions/HttpRouteMatchPath",
+ "description": "Path to match for routing."
+ },
+ "headers": {
+ "type": "array",
+ "description": "headers and their values to match in request.",
+ "items": {
+ "$ref": "#/definitions/HttpRouteMatchHeader"
+ }
+ }
+ },
+ "required": [
+ "path"
+ ]
+ },
+ "TcpConfig": {
+ "description": "Describes the tcp configuration for external connectivity for this network.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "tcp gateway config name."
+ },
+ "port": {
+ "type": "integer",
+ "description": "Specifies the port at which the service endpoint below needs to be exposed."
+ },
+ "destination": {
+ "$ref": "#/definitions/GatewayDestination",
+ "description": "Describes destination endpoint for routing traffic."
+ }
+ },
+ "required": [
+ "destination",
+ "name",
+ "port"
+ ]
+ },
+ "GatewayResourceName": {
+ "type": "string",
+ "description": "Name of the Gateway resource."
+ },
+ "GatewayResourceDescription": {
+ "description": "This type describes a gateway resource.",
+ "properties": {
+ "name": {
+ "$ref": "#/definitions/GatewayResourceName",
+ "description": "Name of the Gateway resource."
+ },
+ "properties": {
+ "x-ms-client-flatten": true,
+ "$ref": "#/definitions/GatewayProperties",
+ "description": "Describes properties of a gateway resource."
+ }
+ },
+ "required": [
+ "name",
+ "properties"
+ ]
+ },
+ "PagedGatewayResourceDescriptionList": {
+ "type": "object",
+ "description": "The list of gateway resources. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.",
+ "properties": {
+ "ContinuationToken": {
+ "$ref": "#/definitions/ContinuationToken",
+ "description": "The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token is not included in the response."
+ },
+ "Items": {
+ "type": "array",
+ "description": "One page of the list.",
+ "items": {
+ "$ref": "#/definitions/GatewayResourceDescription"
+ }
+ }
+ }
+ },
+ "ApplicationProperties": {
+ "description": "Describes properties of a application resource.",
+ "properties": {
+ "description": {
+ "type": "string",
+ "description": "User readable description of the application."
+ },
+ "services": {
+ "type": "array",
+ "description": "Describes the services in the application. This property is used to create or modify services of the application. On get only the name of the service is returned. The service description can be obtained by querying for the service resource.",
+ "items": {
+ "$ref": "#/definitions/ServiceResourceDescription"
+ }
+ },
+ "diagnostics": {
+ "$ref": "#/definitions/DiagnosticsDescription",
+ "description": "Describes the diagnostics definition and usage for an application resource."
+ },
+ "debugParams": {
+ "description": "Internal - used by Visual Studio to setup the debugging session on the local development environment.",
+ "type": "string"
+ },
+ "serviceNames": {
+ "readOnly": true,
+ "description": "Names of the services in the application.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "status": {
+ "readOnly": true,
+ "$ref": "#/definitions/ResourceStatus",
+ "description": "Status of the application."
+ },
+ "statusDetails": {
+ "readOnly": true,
+ "type": "string",
+ "description": "Gives additional information about the current status of the application."
+ },
+ "healthState": {
+ "readOnly": true,
+ "$ref": "#/definitions/HealthState",
+ "description": "Describes the health state of an application resource."
+ },
+ "unhealthyEvaluation": {
+ "readOnly": true,
+ "type": "string",
+ "description": "When the application's health state is not 'Ok', this additional details from service fabric Health Manager for the user to know why the application is marked unhealthy."
+ }
+ }
+ },
+ "ApplicationResourceUpgradeProgressInfo": {
+ "description": "This type describes an application resource upgrade.",
+ "properties": {
+ "Name": {
+ "type": "string",
+ "description": "Name of the Application resource."
+ },
+ "TargetApplicationTypeVersion": {
+ "type": "string",
+ "description": "The target application version for the application upgrade."
+ },
+ "StartTimestampUtc": {
+ "type": "string",
+ "description": "The estimated UTC datetime when the upgrade started."
+ },
+ "UpgradeState": {
+ "$ref": "#/definitions/ApplicationResourceUpgradeState",
+ "description": "The state of the application resource upgrade."
+ },
+ "PercentCompleted": {
+ "type": "string",
+ "description": "The estimated percent of replicas are completed in the upgrade."
+ },
+ "ServiceUpgradeProgress": {
+ "$ref": "#/definitions/ServiceUpgradeProgressList",
+ "description": "List of service upgrade progresses."
+ },
+ "RollingUpgradeMode": {
+ "$ref": "#/definitions/RollingUpgradeMode",
+ "description": "The mode used to monitor health during a rolling upgrade. The values are UnmonitoredAuto, UnmonitoredManual, and Monitored."
+ },
+ "UpgradeDuration": {
+ "type": "string",
+ "description": "The estimated amount of time that the overall upgrade elapsed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds.",
+ "default": "PT0H2M0S"
+ },
+ "ApplicationUpgradeStatusDetails": {
+ "type": "string",
+ "description": "Additional detailed information about the status of the pending upgrade."
+ },
+ "UpgradeReplicaSetCheckTimeoutInSeconds": {
+ "type": "integer",
+ "format": "int64",
+ "description": "The maximum amount of time to block processing of an upgrade domain and prevent loss of availability when there are unexpected issues. When this timeout expires, processing of the upgrade domain will proceed regardless of availability loss issues. The timeout is reset at the start of each upgrade domain. Valid values are between 0 and 42949672925 inclusive. (unsigned 32-bit integer).",
+ "default": 42949672925
+ },
+ "FailureTimestampUtc": {
+ "type": "string",
+ "description": "The estimated UTC datetime when the upgrade failed and FailureAction was executed."
+ }
+ }
+ },
+ "ApplicationResourceUpgradeState": {
+ "type": "string",
+ "description": "The state of the application resource upgrade.",
+ "enum": [
+ "Invalid",
+ "ProvisioningTarget",
+ "RollingForward",
+ "UnprovisioningCurrent",
+ "CompletedRollforward",
+ "RollingBack",
+ "UnprovisioningTarget",
+ "CompletedRollback",
+ "Failed"
+ ],
+ "x-ms-enum": {
+ "name": "ApplicationResourceUpgradeState",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "Invalid",
+ "description": "Indicates the upgrade state is invalid. All Service Fabric enumerations have the invalid type. The value is 0."
+ },
+ {
+ "value": "ProvisioningTarget",
+ "description": "The upgrade is in the progress of provisioning target application type version. The value is 1."
+ },
+ {
+ "value": "RollingForward",
+ "description": "The upgrade is rolling forward to the target version but is not complete yet. The value is 2."
+ },
+ {
+ "value": "UnprovisioningCurrent",
+ "description": "The upgrade is in the progress of unprovisioning current application type version and rolling forward to the target version is completed. The value is 3."
+ },
+ {
+ "value": "CompletedRollforward",
+ "description": "The upgrade has finished rolling forward. The value is 4."
+ },
+ {
+ "value": "RollingBack",
+ "description": "The upgrade is rolling back to the previous version but is not complete yet. The value is 5."
+ },
+ {
+ "value": "UnprovisioningTarget",
+ "description": "The upgrade is in the progress of unprovisioning target application type version and rolling back to the current version is completed. The value is 6."
+ },
+ {
+ "value": "CompletedRollback",
+ "description": "The upgrade has finished rolling back. The value is 7."
+ },
+ {
+ "value": "Failed",
+ "description": "The upgrade has failed and is unable to execute FailureAction. The value is 8."
+ }
+ ]
+ }
+ },
+ "AzureInternalMonitoringPipelineSinkDescription": {
+ "allOf": [
+ {
+ "$ref": "#/definitions/DiagnosticsSinkProperties"
+ }
+ ],
+ "x-ms-discriminator-value": "AzureInternalMonitoringPipeline",
+ "description": "Diagnostics settings for Geneva.",
+ "properties": {
+ "accountName": {
+ "description": "Azure Internal monitoring pipeline account.",
+ "type": "string"
+ },
+ "namespace": {
+ "description": "Azure Internal monitoring pipeline account namespace.",
+ "type": "string"
+ },
+ "maConfigUrl": {
+ "description": "Azure Internal monitoring agent configuration.",
+ "type": "string"
+ },
+ "fluentdConfigUrl": {
+ "description": "Azure Internal monitoring agent fluentd configuration.",
+ "type": "string"
+ },
+ "autoKeyConfigUrl": {
+ "description": "Azure Internal monitoring pipeline autokey associated with the certificate.",
+ "type": "string"
+ }
+ }
+ },
+ "DiagnosticsDescription": {
+ "description": "Describes the diagnostics options available",
+ "properties": {
+ "sinks": {
+ "description": "List of supported sinks that can be referenced.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/DiagnosticsSinkProperties"
+ }
+ },
+ "enabled": {
+ "description": "Status of whether or not sinks are enabled.",
+ "type": "boolean"
+ },
+ "defaultSinkRefs": {
+ "description": "The sinks to be used if diagnostics is enabled. Sink choices can be overridden at the service and code package level.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "DiagnosticsRef": {
+ "description": "Reference to sinks in DiagnosticsDescription.",
+ "properties": {
+ "enabled": {
+ "description": "Status of whether or not sinks are enabled.",
+ "type": "boolean"
+ },
+ "sinkRefs": {
+ "description": "List of sinks to be used if enabled. References the list of sinks in DiagnosticsDescription.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "DiagnosticsSinkKind": {
+ "type": "string",
+ "description": "The kind of DiagnosticsSink.",
+ "enum": [
+ "Invalid",
+ "AzureInternalMonitoringPipeline"
+ ],
+ "x-ms-enum": {
+ "name": "DiagnosticsSinkKind",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "Invalid",
+ "description": "Indicates an invalid sink kind. All Service Fabric enumerations have the invalid type."
+ },
+ {
+ "value": "AzureInternalMonitoringPipeline",
+ "description": "Diagnostics settings for Geneva."
+ }
+ ]
+ }
+ },
+ "DiagnosticsSinkProperties": {
+ "description": "Properties of a DiagnosticsSink.",
+ "discriminator": "kind",
+ "properties": {
+ "kind": {
+ "$ref": "#/definitions/DiagnosticsSinkKind",
+ "description": "The kind of DiagnosticsSink."
+ },
+ "name": {
+ "description": "Name of the sink. This value is referenced by DiagnosticsReferenceDescription",
+ "type": "string"
+ },
+ "description": {
+ "description": "A description of the sink.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "kind"
+ ]
+ },
+ "IdentityDescription": {
+ "description": "Information describing the identities associated with this application.",
+ "properties": {
+ "tokenServiceEndpoint": {
+ "type": "string",
+ "description": "the endpoint for the token service managing this identity"
+ },
+ "type": {
+ "type": "string",
+ "description": "the types of identities associated with this resource; currently restricted to 'SystemAssigned and UserAssigned'"
+ },
+ "tenantId": {
+ "type": "string",
+ "description": "the identifier of the tenant containing the application's identity."
+ },
+ "principalId": {
+ "type": "string",
+ "description": "the object identifier of the Service Principal of the identity associated with this resource."
+ },
+ "userAssignedIdentities": {
+ "$ref": "#/definitions/UserAssignedIdentityMap",
+ "description": "represents user assigned identities map."
+ }
+ },
+ "required": [
+ "type"
+ ]
+ },
+ "IdentityItemDescription": {
+ "description": "Describes a single user-assigned identity associated with the application.",
+ "type": "object",
+ "properties": {
+ "principalId": {
+ "type": "string",
+ "description": "the object identifier of the Service Principal which this identity represents."
+ },
+ "clientId": {
+ "type": "string",
+ "description": "the client identifier of the Service Principal which this identity represents."
+ }
+ }
+ },
+ "RollingUpgradeMode": {
+ "type": "string",
+ "description": "The mode used to monitor health during a rolling upgrade. The values are UnmonitoredAuto, UnmonitoredManual, and Monitored.",
+ "enum": [
+ "Invalid",
+ "UnmonitoredAuto",
+ "UnmonitoredManual",
+ "Monitored"
+ ],
+ "default": "Monitored",
+ "x-ms-enum": {
+ "name": "RollingUpgradeMode",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "Invalid",
+ "description": "Indicates the upgrade mode is invalid. All Service Fabric enumerations have the invalid type. The value is zero."
+ },
+ {
+ "value": "UnmonitoredAuto",
+ "description": "The upgrade will proceed automatically without performing any health monitoring. The value is 1"
+ },
+ {
+ "value": "UnmonitoredManual",
+ "description": "The upgrade will stop after completing each upgrade domain, giving the opportunity to manually monitor health before proceeding. The value is 2"
+ },
+ {
+ "value": "Monitored",
+ "description": "The upgrade will stop after completing each upgrade domain and automatically monitor health before proceeding. The value is 3"
+ }
+ ]
+ }
+ },
+ "ServiceUpgradeProgressList": {
+ "type": "array",
+ "description": "List of service upgrade progresses.",
+ "items": {
+ "$ref": "#/definitions/ServiceUpgradeProgress"
+ }
+ },
+ "ServiceUpgradeProgress": {
+ "description": "Information about how many replicas are completed or pending for a specific service during upgrade.",
+ "properties": {
+ "ServiceName": {
+ "type": "string",
+ "description": "Name of the Service resource."
+ },
+ "CompletedReplicaCount": {
+ "type": "string",
+ "description": "The number of replicas that completes the upgrade in the service."
+ },
+ "PendingReplicaCount": {
+ "type": "string",
+ "description": "The number of replicas that are waiting to be upgraded in the service."
+ }
+ }
+ },
+ "UserAssignedIdentityMap": {
+ "type": "object",
+ "description": "Defines a map that contains user assigned identities.",
+ "additionalProperties": {
+ "$ref": "#/definitions/IdentityItemDescription"
+ }
+ },
+ "AddRemoveReplicaScalingMechanism": {
+ "description": "Describes the horizontal auto scaling mechanism that adds or removes replicas (containers or container groups).",
+ "allOf": [
+ {
+ "$ref": "#/definitions/AutoScalingMechanism"
+ },
+ {
+ "type": "object"
+ }
+ ],
+ "x-ms-discriminator-value": "AddRemoveReplica",
+ "properties": {
+ "minCount": {
+ "type": "integer",
+ "description": "Minimum number of containers (scale down won't be performed below this number)."
+ },
+ "maxCount": {
+ "type": "integer",
+ "description": "Maximum number of containers (scale up won't be performed above this number)."
+ },
+ "scaleIncrement": {
+ "type": "integer",
+ "description": "Each time auto scaling is performed, this number of containers will be added or removed."
+ }
+ },
+ "required": [
+ "minCount",
+ "maxCount",
+ "scaleIncrement"
+ ]
+ },
+ "AutoScalingMechanism": {
+ "type": "object",
+ "discriminator": "kind",
+ "description": "Describes the mechanism for performing auto scaling operation. Derived classes will describe the actual mechanism.",
+ "properties": {
+ "kind": {
+ "$ref": "#/definitions/AutoScalingMechanismKind",
+ "description": "The type of auto scaling mechanism."
+ }
+ },
+ "required": [
+ "kind"
+ ]
+ },
+ "AutoScalingMechanismKind": {
+ "type": "string",
+ "description": "Enumerates the mechanisms for auto scaling.",
+ "enum": [
+ "AddRemoveReplica"
+ ],
+ "x-ms-enum": {
+ "name": "AutoScalingMechanismKind",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "AddRemoveReplica",
+ "description": "Indicates that scaling should be performed by adding or removing replicas."
+ }
+ ]
+ }
+ },
+ "AutoScalingMetric": {
+ "type": "object",
+ "discriminator": "kind",
+ "description": "Describes the metric that is used for triggering auto scaling operation. Derived classes will describe resources or metrics.",
+ "properties": {
+ "kind": {
+ "$ref": "#/definitions/AutoScalingMetricKind",
+ "description": "The type of auto scaling metric"
+ }
+ },
+ "required": [
+ "kind"
+ ]
+ },
+ "AutoScalingMetricKind": {
+ "type": "string",
+ "description": "Enumerates the metrics that are used for triggering auto scaling.",
+ "enum": [
+ "Resource"
+ ],
+ "x-ms-enum": {
+ "name": "AutoScalingMetricKind",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "Resource",
+ "description": "Indicates that the metric is one of resources, like cpu or memory."
+ }
+ ]
+ }
+ },
+ "AutoScalingPolicy": {
+ "description": "Describes the auto scaling policy",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "The name of the auto scaling policy.",
+ "type": "string"
+ },
+ "trigger": {
+ "$ref": "#/definitions/AutoScalingTrigger",
+ "description": "Determines when auto scaling operation will be invoked."
+ },
+ "mechanism": {
+ "$ref": "#/definitions/AutoScalingMechanism",
+ "description": "The mechanism that is used to scale when auto scaling operation is invoked."
+ }
+ },
+ "required": [
+ "name",
+ "trigger",
+ "mechanism"
+ ]
+ },
+ "AutoScalingResourceMetric": {
+ "description": "Describes the resource that is used for triggering auto scaling.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/AutoScalingMetric"
+ },
+ {
+ "type": "object"
+ }
+ ],
+ "x-ms-discriminator-value": "Resource",
+ "properties": {
+ "name": {
+ "$ref": "#/definitions/AutoScalingResourceMetricName",
+ "description": "Name of the resource."
+ }
+ },
+ "required": [
+ "name"
+ ]
+ },
+ "AutoScalingResourceMetricName": {
+ "type": "string",
+ "description": "Enumerates the resources that are used for triggering auto scaling.",
+ "enum": [
+ "cpu",
+ "memoryInGB"
+ ],
+ "x-ms-enum": {
+ "name": "AutoScalingResourceMetricName",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "cpu",
+ "description": "Indicates that the resource is CPU cores."
+ },
+ {
+ "value": "memoryInGB",
+ "description": "Indicates that the resource is memory in GB."
+ }
+ ]
+ }
+ },
+ "AutoScalingTrigger": {
+ "type": "object",
+ "discriminator": "kind",
+ "description": "Describes the trigger for performing auto scaling operation.",
+ "properties": {
+ "kind": {
+ "$ref": "#/definitions/AutoScalingTriggerKind",
+ "description": "The type of auto scaling trigger"
+ }
+ },
+ "required": [
+ "kind"
+ ]
+ },
+ "AutoScalingTriggerKind": {
+ "type": "string",
+ "description": "Enumerates the triggers for auto scaling.",
+ "enum": [
+ "AverageLoad"
+ ],
+ "x-ms-enum": {
+ "name": "AutoScalingTriggerKind",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "AverageLoad",
+ "description": "Indicates that scaling should be performed based on average load of all replicas in the service."
+ }
+ ]
+ }
+ },
+ "ContainerCodePackageProperties": {
+ "description": "Describes a container and its runtime properties.",
+ "properties": {
+ "name": {
+ "description": "The name of the code package.",
+ "type": "string"
+ },
+ "image": {
+ "description": "The Container image to use.",
+ "type": "string"
+ },
+ "imageRegistryCredential": {
+ "$ref": "#/definitions/ImageRegistryCredential",
+ "description": "Image registry credential."
+ },
+ "entryPoint": {
+ "description": "Override for the default entry point in the container.",
+ "type": "string"
+ },
+ "commands": {
+ "description": "Command array to execute within the container in exec form.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "environmentVariables": {
+ "description": "The environment variables to set in this container",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/EnvironmentVariable"
+ }
+ },
+ "settings": {
+ "description": "The settings to set in this container. The setting file path can be fetched from environment variable \"Fabric_SettingPath\". The path for Windows container is \"C:\\\\secrets\". The path for Linux container is \"/var/secrets\".",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/Setting"
+ }
+ },
+ "labels": {
+ "description": "The labels to set in this container.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ContainerLabel"
+ }
+ },
+ "endpoints": {
+ "description": "The endpoints exposed by this container.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/EndpointProperties"
+ }
+ },
+ "resources": {
+ "description": "The resources required by this container.",
+ "$ref": "#/definitions/ResourceRequirements"
+ },
+ "volumeRefs": {
+ "description": "Volumes to be attached to the container. The lifetime of these volumes is independent of the application's lifetime.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/VolumeReference"
+ }
+ },
+ "volumes": {
+ "description": "Volumes to be attached to the container. The lifetime of these volumes is scoped to the application's lifetime.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ApplicationScopedVolume"
+ }
+ },
+ "diagnostics": {
+ "$ref": "#/definitions/DiagnosticsRef",
+ "description": "Reference to sinks in DiagnosticsDescription."
+ },
+ "reliableCollectionsRefs": {
+ "description": "A list of ReliableCollection resources used by this particular code package. Please refer to ReliableCollectionsRef for more details.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ReliableCollectionsRef"
+ }
+ },
+ "instanceView": {
+ "readOnly": true,
+ "$ref": "#/definitions/ContainerInstanceView",
+ "description": "Runtime information of a container instance."
+ },
+ "livenessProbe": {
+ "description": "An array of liveness probes for a code package. It determines when to restart a code package.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/Probe"
+ }
+ },
+ "readinessProbe": {
+ "description": "An array of readiness probes for a code package. It determines when to unpublish an endpoint.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/Probe"
+ }
+ }
+ },
+ "required": [
+ "name",
+ "image",
+ "resources"
+ ]
+ },
+ "ContainerEvent": {
+ "description": "A container event.",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "The name of the container event."
+ },
+ "count": {
+ "type": "integer",
+ "description": "The count of the event."
+ },
+ "firstTimestamp": {
+ "type": "string",
+ "description": "Date/time of the first event."
+ },
+ "lastTimestamp": {
+ "type": "string",
+ "description": "Date/time of the last event."
+ },
+ "message": {
+ "type": "string",
+ "description": "The event message"
+ },
+ "type": {
+ "type": "string",
+ "description": "The event type."
+ }
+ }
+ },
+ "ContainerInstanceView": {
+ "description": "Runtime information of a container instance.",
+ "properties": {
+ "restartCount": {
+ "type": "integer",
+ "description": "The number of times the container has been restarted."
+ },
+ "currentState": {
+ "$ref": "#/definitions/ContainerState",
+ "description": "Current container instance state."
+ },
+ "previousState": {
+ "$ref": "#/definitions/ContainerState",
+ "description": "Previous container instance state."
+ },
+ "events": {
+ "description": "The events of this container instance.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ContainerEvent"
+ }
+ }
+ }
+ },
+ "ContainerLabel": {
+ "description": "Describes a container label.",
+ "properties": {
+ "name": {
+ "description": "The name of the container label.",
+ "type": "string"
+ },
+ "value": {
+ "description": "The value of the container label.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "name",
+ "value"
+ ]
+ },
+ "ContainerState": {
+ "description": "The container state.",
+ "properties": {
+ "state": {
+ "type": "string",
+ "description": "The state of this container"
+ },
+ "startTime": {
+ "type": "string",
+ "format": "date-time",
+ "description": "Date/time when the container state started."
+ },
+ "exitCode": {
+ "type": "string",
+ "description": "The container exit code."
+ },
+ "finishTime": {
+ "type": "string",
+ "format": "date-time",
+ "description": "Date/time when the container state finished."
+ },
+ "detailStatus": {
+ "description": "Human-readable status of this state.",
+ "type": "string"
+ }
+ }
+ },
+ "DefaultExecutionPolicy": {
+ "description": "The default execution policy. Always restart the service if an exit occurs.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ExecutionPolicy"
+ },
+ {
+ "type": "object"
+ }
+ ],
+ "x-ms-discriminator-value": "Default"
+ },
+ "EndpointProperties": {
+ "description": "Describes a container endpoint.",
+ "properties": {
+ "name": {
+ "description": "The name of the endpoint.",
+ "type": "string"
+ },
+ "port": {
+ "description": "Port used by the container.",
+ "type": "integer"
+ }
+ },
+ "required": [
+ "name"
+ ]
+ },
+ "EnvironmentVariable": {
+ "description": "Describes an environment variable for the container.",
+ "properties": {
+ "type": {
+ "$ref": "#/definitions/EnvironmentVariableType",
+ "description": "The type of the environment variable being given in value"
+ },
+ "name": {
+ "description": "The name of the environment variable.",
+ "type": "string"
+ },
+ "value": {
+ "description": "The value of the environment variable, will be processed based on the type provided.",
+ "type": "string"
+ }
+ }
+ },
+ "EnvironmentVariableType": {
+ "type": "string",
+ "description": "The type of the environment variable being given in value",
+ "default": "ClearText",
+ "enum": [
+ "ClearText",
+ "KeyVaultReference",
+ "SecretValueReference"
+ ],
+ "x-ms-enum": {
+ "name": "EnvironmentVariableType",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "ClearText",
+ "description": "The environment variable in clear text, will not be processed in any way and passed in as is"
+ },
+ {
+ "value": "KeyVaultReference",
+ "description": "The URI to a KeyVault secret version, will be resolved using the application's managed identity (this type is only valid if the app was assigned a managed identity) before getting passed in"
+ },
+ {
+ "value": "SecretValueReference",
+ "description": "The reference to a SecretValue resource, will be resolved before getting passed in"
+ }
+ ]
+ }
+ },
+ "ExecutionPolicy": {
+ "type": "object",
+ "discriminator": "type",
+ "description": "The execution policy of the service",
+ "properties": {
+ "type": {
+ "$ref": "#/definitions/ExecutionPolicyType",
+ "description": "Enumerates the execution policy types for services."
+ }
+ },
+ "required": [
+ "type"
+ ]
+ },
+ "ExecutionPolicyType": {
+ "type": "string",
+ "description": "Enumerates the execution policy types for services.",
+ "enum": [
+ "Default",
+ "RunToCompletion"
+ ],
+ "x-ms-enum": {
+ "name": "ExecutionPolicyType",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "Default",
+ "description": "Indicates the default execution policy, always restart the service if an exit occurs."
+ },
+ {
+ "value": "RunToCompletion",
+ "description": "Indicates that the service will perform its desired operation and complete successfully. If the service encounters failure, it will restarted based on restart policy specified. If the service completes its operation successfully, it will not be restarted again."
+ }
+ ]
+ }
+ },
+ "ImageRegistryCredential": {
+ "description": "Image registry credential.",
+ "properties": {
+ "server": {
+ "type": "string",
+ "description": "Docker image registry server, without protocol such as `http` and `https`."
+ },
+ "username": {
+ "type": "string",
+ "description": "The username for the private registry."
+ },
+ "passwordType": {
+ "$ref": "#/definitions/ImageRegistryPasswordType",
+ "description": "The type of the image registry password being given in password"
+ },
+ "password": {
+ "type": "string",
+ "description": "The password for the private registry. The password is required for create or update operations, however it is not returned in the get or list operations. Will be processed based on the type provided."
+ }
+ },
+ "required": [
+ "server",
+ "username"
+ ]
+ },
+ "ImageRegistryPasswordType": {
+ "type": "string",
+ "description": "The type of the image registry password being given in password",
+ "default": "ClearText",
+ "enum": [
+ "ClearText",
+ "KeyVaultReference",
+ "SecretValueReference"
+ ],
+ "x-ms-enum": {
+ "name": "ImageRegistryPasswordType",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "ClearText",
+ "description": "The image registry password in clear text, will not be processed in any way and used directly"
+ },
+ {
+ "value": "KeyVaultReference",
+ "description": "The URI to a KeyVault secret version, will be resolved using the application's managed identity (this type is only valid if the app was assigned a managed identity) before getting used"
+ },
+ {
+ "value": "SecretValueReference",
+ "description": "The reference to a SecretValue resource, will be resolved before getting used"
+ }
+ ]
+ }
+ },
+ "OperatingSystemType": {
+ "type": "string",
+ "description": "The operation system required by the code in service.",
+ "enum": [
+ "Linux",
+ "Windows"
+ ],
+ "x-ms-enum": {
+ "name": "OperatingSystemType",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "Linux",
+ "description": "The required operating system is Linux."
+ },
+ {
+ "value": "Windows",
+ "description": "The required operating system is Windows."
+ }
+ ]
+ }
+ },
+ "Probe": {
+ "description": "Probes have a number of fields that you can use to control their behavior.",
+ "properties": {
+ "initialDelaySeconds": {
+ "type": "integer",
+ "description": "The initial delay in seconds to start executing probe once codepackage has started.",
+ "default": 0
+ },
+ "periodSeconds": {
+ "type": "integer",
+ "description": "Periodic seconds to execute probe.",
+ "default": 10
+ },
+ "timeoutSeconds": {
+ "type": "integer",
+ "description": "Period after which probe is considered as failed if it hasn't completed successfully.",
+ "default": 1
+ },
+ "successThreshold": {
+ "type": "integer",
+ "description": "The count of successful probe executions after which probe is considered success.",
+ "default": 1
+ },
+ "failureThreshold": {
+ "type": "integer",
+ "description": "The count of failures after which probe is considered failed.",
+ "default": 3
+ },
+ "exec": {
+ "$ref": "#/definitions/ProbeExec",
+ "description": "Exec command to run inside the container."
+ },
+ "httpGet": {
+ "$ref": "#/definitions/ProbeHttpGet",
+ "description": "Http probe for the container."
+ },
+ "tcpSocket": {
+ "$ref": "#/definitions/ProbeTcpSocket",
+ "description": "Tcp port to probe inside the container."
+ }
+ }
+ },
+ "ProbeExec": {
+ "description": "Exec command to run inside the container.",
+ "properties": {
+ "command": {
+ "description": "Comma separated command to run inside the container for example \"sh, -c, echo hello world\".",
+ "type": "string"
+ }
+ },
+ "required": [
+ "command"
+ ]
+ },
+ "ProbeHttpGet": {
+ "description": "Http probe for the container.",
+ "properties": {
+ "port": {
+ "description": "Port to access for probe.",
+ "type": "integer"
+ },
+ "path": {
+ "description": "Path to access on the HTTP request.",
+ "type": "string"
+ },
+ "host": {
+ "description": "Host IP to connect to.",
+ "type": "string"
+ },
+ "httpHeaders": {
+ "description": "Headers to set in the request.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ProbeHttpGetHeaders"
+ }
+ },
+ "scheme": {
+ "type": "string",
+ "description": "Scheme for the http probe. Can be Http or Https.",
+ "enum": [
+ "http",
+ "https"
+ ],
+ "x-ms-enum": {
+ "name": "scheme",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "http",
+ "description": "Indicates that the probe is http."
+ },
+ {
+ "value": "https",
+ "description": "Indicates that the probe is https. No cert validation."
+ }
+ ]
+ }
+ }
+ },
+ "required": [
+ "port"
+ ]
+ },
+ "ProbeHttpGetHeaders": {
+ "description": "Http headers.",
+ "properties": {
+ "name": {
+ "description": "The name of the header.",
+ "type": "string"
+ },
+ "value": {
+ "description": "The value of the header.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "name",
+ "value"
+ ]
+ },
+ "ProbeTcpSocket": {
+ "description": "Tcp port to probe inside the container.",
+ "properties": {
+ "port": {
+ "description": "Port to access for probe.",
+ "type": "integer"
+ }
+ },
+ "required": [
+ "port"
+ ]
+ },
+ "ReliableCollectionsRef": {
+ "description": "Specifying this parameter adds support for reliable collections",
+ "properties": {
+ "name": {
+ "description": "Name of ReliableCollection resource. Right now it's not used and you can use any string.",
+ "type": "string"
+ },
+ "doNotPersistState": {
+ "description": "False (the default) if ReliableCollections state is persisted to disk as usual. True if you do not want to persist state, in which case replication is still enabled and you can use ReliableCollections as distributed cache.",
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "name"
+ ]
+ },
+ "ResourceLimits": {
+ "description": "This type describes the resource limits for a given container. It describes the most amount of resources a container is allowed to use before being restarted.",
+ "properties": {
+ "memoryInGB": {
+ "description": "The memory limit in GB.",
+ "type": "number",
+ "format": "double"
+ },
+ "cpu": {
+ "description": "CPU limits in cores. At present, only full cores are supported.",
+ "type": "number",
+ "format": "double"
+ }
+ }
+ },
+ "ResourceRequests": {
+ "description": "This type describes the requested resources for a given container. It describes the least amount of resources required for the container. A container can consume more than requested resources up to the specified limits before being restarted. Currently, the requested resources are treated as limits.",
+ "properties": {
+ "memoryInGB": {
+ "description": "The memory request in GB for this container.",
+ "type": "number",
+ "format": "double"
+ },
+ "cpu": {
+ "description": "Requested number of CPU cores. At present, only full cores are supported.",
+ "type": "number",
+ "format": "double"
+ }
+ },
+ "required": [
+ "memoryInGB",
+ "cpu"
+ ]
+ },
+ "ResourceRequirements": {
+ "description": "This type describes the resource requirements for a container or a service.",
+ "properties": {
+ "requests": {
+ "$ref": "#/definitions/ResourceRequests",
+ "description": "Describes the requested resources for a given container."
+ },
+ "limits": {
+ "$ref": "#/definitions/ResourceLimits",
+ "description": "Describes the maximum limits on the resources for a given container."
+ }
+ },
+ "required": [
+ "requests"
+ ]
+ },
+ "RestartPolicy": {
+ "type": "string",
+ "description": "Enumerates the restart policy for RunToCompletionExecutionPolicy",
+ "enum": [
+ "OnFailure",
+ "Never"
+ ],
+ "x-ms-enum": {
+ "name": "RestartPolicy",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "OnFailure",
+ "description": "Service will be restarted when it encounters a failure."
+ },
+ {
+ "value": "Never",
+ "description": "Service will never be restarted. If the service encounters a failure, it will move to Failed state."
+ }
+ ]
+ }
+ },
+ "RunToCompletionExecutionPolicy": {
+ "description": "The run to completion execution policy, the service will perform its desired operation and complete successfully. If the service encounters failure, it will restarted based on restart policy specified. If the service completes its operation successfully, it will not be restarted again.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ExecutionPolicy"
+ },
+ {
+ "type": "object"
+ }
+ ],
+ "x-ms-discriminator-value": "RunToCompletion",
+ "properties": {
+ "restart": {
+ "$ref": "#/definitions/RestartPolicy",
+ "description": "Enumerates the restart policy for RunToCompletionExecutionPolicy"
+ }
+ },
+ "required": [
+ "restart"
+ ]
+ },
+ "ServiceProperties": {
+ "description": "Describes properties of a service resource.",
+ "properties": {
+ "description": {
+ "type": "string",
+ "description": "User readable description of the service."
+ },
+ "replicaCount": {
+ "type": "integer",
+ "description": "The number of replicas of the service to create. Defaults to 1 if not specified."
+ },
+ "executionPolicy": {
+ "$ref": "#/definitions/ExecutionPolicy",
+ "description": "The execution policy of the service"
+ },
+ "autoScalingPolicies": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/AutoScalingPolicy"
+ },
+ "description": "Auto scaling policies"
+ },
+ "status": {
+ "readOnly": true,
+ "$ref": "#/definitions/ResourceStatus",
+ "description": "Status of the service."
+ },
+ "statusDetails": {
+ "readOnly": true,
+ "type": "string",
+ "description": "Gives additional information about the current status of the service."
+ },
+ "healthState": {
+ "readOnly": true,
+ "$ref": "#/definitions/HealthState",
+ "description": "Describes the health state of an application resource."
+ },
+ "unhealthyEvaluation": {
+ "readOnly": true,
+ "type": "string",
+ "description": "When the service's health state is not 'Ok', this additional details from service fabric Health Manager for the user to know why the service is marked unhealthy."
+ },
+ "identityRefs": {
+ "description": "The service identity list.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ServiceIdentity"
+ }
+ },
+ "dnsName": {
+ "type": "string",
+ "description": "Dns name of the service."
+ }
+ }
+ },
+ "ServiceReplicaProperties": {
+ "description": "Describes the properties of a service replica.",
+ "properties": {
+ "osType": {
+ "$ref": "#/definitions/OperatingSystemType",
+ "description": "The operation system required by the code in service."
+ },
+ "codePackages": {
+ "description": "Describes the set of code packages that forms the service. A code package describes the container and the properties for running it. All the code packages are started together on the same host and share the same context (network, process etc.).",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ContainerCodePackageProperties"
+ }
+ },
+ "networkRefs": {
+ "type": "array",
+ "description": "The names of the private networks that this service needs to be part of.",
+ "items": {
+ "$ref": "#/definitions/NetworkRef"
+ }
+ },
+ "diagnostics": {
+ "$ref": "#/definitions/DiagnosticsRef",
+ "description": "Reference to sinks in DiagnosticsDescription."
+ }
+ },
+ "required": [
+ "osType",
+ "codePackages"
+ ]
+ },
+ "Setting": {
+ "description": "Describes a setting for the container. The setting file path can be fetched from environment variable \"Fabric_SettingPath\". The path for Windows container is \"C:\\\\secrets\". The path for Linux container is \"/var/secrets\".",
+ "properties": {
+ "type": {
+ "$ref": "#/definitions/SettingType",
+ "description": "The type of the setting being given in value"
+ },
+ "name": {
+ "description": "The name of the setting.",
+ "type": "string"
+ },
+ "value": {
+ "description": "The value of the setting, will be processed based on the type provided.",
+ "type": "string"
+ }
+ }
+ },
+ "SettingType": {
+ "type": "string",
+ "description": "The type of the setting being given in value",
+ "default": "ClearText",
+ "enum": [
+ "ClearText",
+ "KeyVaultReference",
+ "SecretValueReference"
+ ],
+ "x-ms-enum": {
+ "name": "SettingType",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "ClearText",
+ "description": "The setting in clear text, will not be processed in any way and passed in as is"
+ },
+ {
+ "value": "KeyVaultReference",
+ "description": "The URI to a KeyVault secret version, will be resolved using the application's managed identity (this type is only valid if the app was assigned a managed identity) before getting passed in"
+ },
+ {
+ "value": "SecretValueReference",
+ "description": "The reference to a SecretValue resource, will be resolved before getting passed in"
+ }
+ ]
+ }
+ },
+ "ServiceReplicaDescription": {
+ "description": "Describes a replica of a service resource.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ServiceReplicaProperties"
+ }
+ ],
+ "properties": {
+ "replicaName": {
+ "type": "string",
+ "description": "Name of the replica."
+ }
+ },
+ "required": [
+ "replicaName"
+ ]
+ },
+ "AverageLoadScalingTrigger": {
+ "description": "Describes the average load trigger used for auto scaling.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/AutoScalingTrigger"
+ },
+ {
+ "type": "object"
+ }
+ ],
+ "x-ms-discriminator-value": "AverageLoad",
+ "properties": {
+ "metric": {
+ "$ref": "#/definitions/AutoScalingMetric",
+ "description": "Description of the metric that is used for scaling."
+ },
+ "lowerLoadThreshold": {
+ "type": "number",
+ "format": "double",
+ "description": "Lower load threshold (if average load is below this threshold, service will scale down)."
+ },
+ "upperLoadThreshold": {
+ "type": "number",
+ "format": "double",
+ "description": "Upper load threshold (if average load is above this threshold, service will scale up)."
+ },
+ "scaleIntervalInSeconds": {
+ "type": "integer",
+ "description": "Scale interval that indicates how often will this trigger be checked.",
+ "minimum": 60
+ }
+ },
+ "required": [
+ "metric",
+ "lowerLoadThreshold",
+ "upperLoadThreshold",
+ "scaleIntervalInSeconds"
+ ]
+ },
+ "ServiceIdentity": {
+ "description": "Map service identity friendly name to an application identity.",
+ "properties": {
+ "name": {
+ "description": "The identity friendly name.",
+ "type": "string"
+ },
+ "identityRef": {
+ "description": "The application identity name.",
+ "type": "string"
+ }
+ }
+ },
+ "ServiceResourceName": {
+ "type": "string",
+ "description": "Name of the Service resource."
+ },
+ "ServiceResourceDescription": {
+ "description": "This type describes a service resource.",
+ "properties": {
+ "name": {
+ "$ref": "#/definitions/ServiceResourceName",
+ "description": "Name of the Service resource."
+ },
+ "properties": {
+ "x-ms-client-flatten": true,
+ "$ref": "#/definitions/ServiceResourceProperties",
+ "description": "This type describes properties of a service resource."
+ }
+ },
+ "required": [
+ "name",
+ "properties"
+ ]
+ },
+ "ServiceResourceProperties": {
+ "description": "This type describes properties of a service resource.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ServiceReplicaProperties"
+ },
+ {
+ "$ref": "#/definitions/ServiceProperties"
+ }
+ ]
+ },
+ "PagedServiceResourceDescriptionList": {
+ "type": "object",
+ "description": "The list of service resources. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.",
+ "properties": {
+ "ContinuationToken": {
+ "$ref": "#/definitions/ContinuationToken",
+ "description": "The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token is not included in the response."
+ },
+ "Items": {
+ "type": "array",
+ "description": "One page of the list.",
+ "items": {
+ "$ref": "#/definitions/ServiceResourceDescription"
+ }
+ }
+ }
+ },
+ "PagedServiceReplicaDescriptionList": {
+ "description": "The list of service resource replicas in the cluster. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.",
+ "properties": {
+ "ContinuationToken": {
+ "$ref": "#/definitions/ContinuationToken",
+ "description": "The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token is not included in the response."
+ },
+ "Items": {
+ "type": "array",
+ "description": "List of service resource replica description.",
+ "items": {
+ "$ref": "#/definitions/ServiceReplicaDescription"
+ }
+ }
+ }
+ },
+ "ApplicationResourceName": {
+ "type": "string",
+ "description": "Name of the Application resource."
+ },
+ "ApplicationResourceDescription": {
+ "description": "This type describes a application resource.",
+ "properties": {
+ "name": {
+ "$ref": "#/definitions/ApplicationResourceName",
+ "description": "Name of the Application resource."
+ },
+ "properties": {
+ "x-ms-client-flatten": true,
+ "$ref": "#/definitions/ApplicationProperties",
+ "description": "Describes properties of a application resource."
+ },
+ "identity": {
+ "$ref": "#/definitions/IdentityDescription",
+ "description": "Describes the identity of the application."
+ }
+ },
+ "required": [
+ "name",
+ "properties"
+ ]
+ },
+ "PagedApplicationResourceDescriptionList": {
+ "type": "object",
+ "description": "The list of application resources. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.",
+ "properties": {
+ "ContinuationToken": {
+ "$ref": "#/definitions/ContinuationToken",
+ "description": "The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token is not included in the response."
+ },
+ "Items": {
+ "type": "array",
+ "description": "One page of the list.",
+ "items": {
+ "$ref": "#/definitions/ApplicationResourceDescription"
+ }
+ }
+ }
+ }
+ },
+ "parameters": {
+ "CodePackageNameRequiredPathParam": {
+ "name": "codePackageName",
+ "in": "path",
+ "x-ms-parameter-location": "method",
+ "type": "string",
+ "required": true,
+ "description": "The name of code package of the service."
+ },
+ "ApiVersion_6-4-Preview_RequiredQueryParam": {
+ "name": "api-version",
+ "in": "query",
+ "x-ms-parameter-location": "method",
+ "type": "string",
+ "enum": [
+ "6.4-preview"
+ ],
+ "required": true,
+ "default": "6.4-preview",
+ "description": "The version of the API. This parameter is required and its value must be '6.4-preview'.",
+ "x-ms-enum": {
+ "name": "ApiVersion_6-4-Preview_RequiredQueryParam",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "6.4-preview",
+ "description": "The version number for the preview functionality of 6.4 runtime"
+ }
+ ]
+ }
+ },
+ "TailOptionalQueryParam": {
+ "name": "Tail",
+ "in": "query",
+ "x-ms-parameter-location": "method",
+ "type": "string",
+ "required": false,
+ "description": "Number of lines to show from the end of the logs. Default is 100. 'all' to show the complete logs."
+ },
+ "ApiVersion_6-0-Preview_RequiredQueryParam": {
+ "name": "api-version",
+ "in": "query",
+ "x-ms-parameter-location": "method",
+ "type": "string",
+ "enum": [
+ "6.0-preview"
+ ],
+ "required": true,
+ "default": "6.0-preview",
+ "description": "The version of the API. This parameter is required and its value must be '\"6.0-preview'.",
+ "x-ms-enum": {
+ "name": "ApiVersion_6-0-Preview_RequiredQueryParam",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "6.0-preview",
+ "description": "The version number for the preview functionality of 6.0 runtime."
+ }
+ ]
+ }
+ },
+ "ApiVersion_6-0_RequiredQueryParam": {
+ "name": "api-version",
+ "in": "query",
+ "x-ms-parameter-location": "method",
+ "type": "string",
+ "enum": [
+ "6.0"
+ ],
+ "required": true,
+ "default": "6.0",
+ "description": "The version of the API. This parameter is required and its value must be '6.0'.\n\nService Fabric REST API version is based on the runtime version in which the API was introduced or was changed. Service Fabric runtime supports more than one version of the API. This is the latest supported version of the API. If a lower API version is passed, the returned response may be different from the one documented in this specification.\n\nAdditionally the runtime accept any version that is higher than the latest supported version up to the current version of the runtime. So if the latest API version is 6.0, but if the runtime is 6.1, in order to make it easier to write the clients, the runtime will accept version 6.1 for that API. However the behavior of the API will be as per the documented 6.0 version.",
+ "x-ms-enum": {
+ "name": "ApiVersion_6-0_RequiredQueryParam",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "6.0",
+ "description": "The 6.0 version of the API."
+ }
+ ]
+ }
+ },
+ "ApiVersion_6-1_RequiredQueryParam": {
+ "name": "api-version",
+ "in": "query",
+ "x-ms-parameter-location": "method",
+ "type": "string",
+ "enum": [
+ "6.1"
+ ],
+ "required": true,
+ "default": "6.1",
+ "description": "The version of the API. This parameter is required and its value must be '6.1'.\n\nService Fabric REST API version is based on the runtime version in which the API was introduced or was changed. Service Fabric runtime supports more than one version of the API. This is the latest supported version of the API. If a lower API version is passed, the returned response may be different from the one documented in this specification.\n\nAdditionally the runtime accept any version that is higher than the latest supported version up to the current version of the runtime. So if the latest API version is 6.0, but if the runtime is 6.1, in order to make it easier to write the clients, the runtime will accept version 6.1 for that API. However the behavior of the API will be as per the documented 6.0 version.",
+ "x-ms-enum": {
+ "name": "ApiVersion_6-1_RequiredQueryParam",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "6.1",
+ "description": "The 6.1 version of the API."
+ }
+ ]
+ }
+ },
+ "ApiVersion_6-2_RequiredQueryParam": {
+ "name": "api-version",
+ "in": "query",
+ "x-ms-parameter-location": "method",
+ "type": "string",
+ "enum": [
+ "6.2"
+ ],
+ "required": true,
+ "default": "6.2",
+ "description": "The version of the API. This parameter is required and its value must be '6.2'.\n\nService Fabric REST API version is based on the runtime version in which the API was introduced or was changed. Service Fabric runtime supports more than one version of the API. This version is the latest supported version of the API. If a lower API version is passed, the returned response may be different from the one documented in this specification.\n\nAdditionally the runtime accepts any version that is higher than the latest supported version up to the current version of the runtime. So if the latest API version is 6.0 and the runtime is 6.1, the runtime will accept version 6.1 for that API. However the behavior of the API will be as per the documented 6.0 version.",
+ "x-ms-enum": {
+ "name": "ApiVersion_6-2_RequiredQueryParam",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "6.2",
+ "description": "The 6.2 version of the API."
+ }
+ ]
+ }
+ },
+ "ApiVersion_6-2-Preview_RequiredQueryParam": {
+ "name": "api-version",
+ "in": "query",
+ "x-ms-parameter-location": "method",
+ "type": "string",
+ "enum": [
+ "6.2-preview"
+ ],
+ "required": true,
+ "default": "6.2-preview",
+ "description": "The version of the API. This parameter is required and its value must be '6.2-preview'.",
+ "x-ms-enum": {
+ "name": "ApiVersion_6-2-Preview_RequiredQueryParam",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "6.2-preview",
+ "description": "The version number for the preview functionality of 6.2 runtime"
+ }
+ ]
+ }
+ },
+ "ApiVersion_6-3_RequiredQueryParam": {
+ "name": "api-version",
+ "in": "query",
+ "x-ms-parameter-location": "method",
+ "type": "string",
+ "enum": [
+ "6.3"
+ ],
+ "required": true,
+ "default": "6.3",
+ "description": "The version of the API. This parameter is required and its value must be '6.3'.\n\nService Fabric REST API version is based on the runtime version in which the API was introduced or was changed. Service Fabric runtime supports more than one version of the API. This version is the latest supported version of the API. If a lower API version is passed, the returned response may be different from the one documented in this specification.\n\nAdditionally the runtime accepts any version that is higher than the latest supported version up to the current version of the runtime. So if the latest API version is 6.0 and the runtime is 6.1, the runtime will accept version 6.1 for that API. However the behavior of the API will be as per the documented 6.0 version.",
+ "x-ms-enum": {
+ "name": "ApiVersion_6-3_RequiredQueryParam",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "6.3",
+ "description": "The 6.3 version of the API."
+ }
+ ]
+ }
+ },
+ "ApiVersion_6-3-Preview_RequiredQueryParam": {
+ "name": "api-version",
+ "in": "query",
+ "x-ms-parameter-location": "method",
+ "type": "string",
+ "enum": [
+ "6.3-preview"
+ ],
+ "required": true,
+ "default": "6.3-preview",
+ "description": "The version of the API. This parameter is required and its value must be '6.3-preview'.",
+ "x-ms-enum": {
+ "name": "ApiVersion_6-3-Preview_RequiredQueryParam",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "6.3-preview",
+ "description": "The version number for the preview functionality of 6.3 runtime"
+ }
+ ]
+ }
+ },
+ "ApiVersion_6-4_RequiredQueryParam": {
+ "name": "api-version",
+ "in": "query",
+ "x-ms-parameter-location": "method",
+ "type": "string",
+ "enum": [
+ "6.4"
+ ],
+ "required": true,
+ "default": "6.4",
+ "description": "The version of the API. This parameter is required and its value must be '6.4'.\n\nService Fabric REST API version is based on the runtime version in which the API was introduced or was changed. Service Fabric runtime supports more than one version of the API. This version is the latest supported version of the API. If a lower API version is passed, the returned response may be different from the one documented in this specification.\n\nAdditionally the runtime accepts any version that is higher than the latest supported version up to the current version of the runtime. So if the latest API version is 6.0 and the runtime is 6.1, the runtime will accept version 6.1 for that API. However the behavior of the API will be as per the documented 6.0 version.",
+ "x-ms-enum": {
+ "name": "ApiVersion_6-4_RequiredQueryParam",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "6.4",
+ "description": "The 6.4 version of the API."
+ }
+ ]
+ }
+ },
+ "ApiVersion_6-5_RequiredQueryParam": {
+ "name": "api-version",
+ "in": "query",
+ "x-ms-parameter-location": "method",
+ "type": "string",
+ "enum": [
+ "6.5"
+ ],
+ "required": true,
+ "default": "6.5",
+ "description": "The version of the API. This parameter is required and its value must be '6.5'.\n\nService Fabric REST API version is based on the runtime version in which the API was introduced or was changed. Service Fabric runtime supports more than one version of the API. This version is the latest supported version of the API. If a lower API version is passed, the returned response may be different from the one documented in this specification.\n\nAdditionally the runtime accepts any version that is higher than the latest supported version up to the current version of the runtime. So if the latest API version is 6.0 and the runtime is 6.1, the runtime will accept version 6.1 for that API. However the behavior of the API will be as per the documented 6.0 version.",
+ "x-ms-enum": {
+ "name": "ApiVersion_6-5_RequiredQueryParam",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "6.5",
+ "description": "The 6.5 version of the API."
+ }
+ ]
+ }
+ },
+ "ApiVersion_7-0_RequiredQueryParam": {
+ "name": "api-version",
+ "in": "query",
+ "x-ms-parameter-location": "method",
+ "type": "string",
+ "enum": [
+ "7.0"
+ ],
+ "required": true,
+ "default": "7.0",
+ "description": "The version of the API. This parameter is required and its value must be '7.0'.\n\nService Fabric REST API version is based on the runtime version in which the API was introduced or was changed. Service Fabric runtime supports more than one version of the API. This version is the latest supported version of the API. If a lower API version is passed, the returned response may be different from the one documented in this specification.\n\nAdditionally the runtime accepts any version that is higher than the latest supported version up to the current version of the runtime. So if the latest API version is 6.0 and the runtime is 6.1, the runtime will accept version 6.1 for that API. However the behavior of the API will be as per the documented 6.0 version.",
+ "x-ms-enum": {
+ "name": "ApiVersion_7-0_RequiredQueryParam",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "7.0",
+ "description": "The 7.0 version of the API."
+ }
+ ]
+ }
+ },
+ "ApplicationDefinitionKindFilterOptionalQueryParam": {
+ "name": "ApplicationDefinitionKindFilter",
+ "description": "Used to filter on ApplicationDefinitionKind, which is the mechanism used to define a Service Fabric application.\n- Default - Default value, which performs the same function as selecting \"All\". The value is 0.\n- All - Filter that matches input with any ApplicationDefinitionKind value. The value is 65535.\n- ServiceFabricApplicationDescription - Filter that matches input with ApplicationDefinitionKind value ServiceFabricApplicationDescription. The value is 1.\n- Compose - Filter that matches input with ApplicationDefinitionKind value Compose. The value is 2.",
+ "in": "query",
+ "x-ms-parameter-location": "method",
+ "type": "integer",
+ "required": false,
+ "default": 0
+ },
+ "ApplicationHealthPolicyOptionalBodyParam": {
+ "name": "ApplicationHealthPolicy",
+ "in": "body",
+ "description": "Describes the health policies used to evaluate the health of an application or one of its children.\nIf not present, the health evaluation uses the health policy from application manifest or the default health policy.",
+ "required": false,
+ "x-ms-parameter-location": "method",
+ "schema": {
+ "$ref": "#/definitions/ApplicationHealthPolicy"
+ }
+ },
+ "ApplicationIdRequiredPathParam": {
+ "name": "applicationId",
+ "in": "path",
+ "x-ms-parameter-location": "method",
+ "x-ms-skip-url-encoding": true,
+ "type": "string",
+ "required": true,
+ "description": "The identity of the application. This is typically the full name of the application without the 'fabric:' URI scheme.\nStarting from version 6.0, hierarchical names are delimited with the \"~\" character.\nFor example, if the application name is \"fabric:/myapp/app1\", the application identity would be \"myapp~app1\" in 6.0+ and \"myapp/app1\" in previous versions."
+ },
+ "ApplicationsHealthStateFilterOptionalQueryParam": {
+ "name": "ApplicationsHealthStateFilter",
+ "description": "Allows filtering of the application health state objects returned in the result of cluster health\nquery based on their health state.\nThe possible values for this parameter include integer value obtained from members or bitwise operations\non members of HealthStateFilter enumeration. Only applications that match the filter are returned.\nAll applications are used to evaluate the aggregated health state. If not specified, all entries are returned.\nThe state values are flag-based enumeration, so the value could be a combination of these values obtained using bitwise 'OR' operator.\nFor example, if the provided value is 6 then health state of applications with HealthState value of OK (2) and Warning (4) are returned.\n\n- Default - Default value. Matches any HealthState. The value is zero.\n- None - Filter that doesn't match any HealthState value. Used in order to return no results on a given collection of states. The value is 1.\n- Ok - Filter that matches input with HealthState value Ok. The value is 2.\n- Warning - Filter that matches input with HealthState value Warning. The value is 4.\n- Error - Filter that matches input with HealthState value Error. The value is 8.\n- All - Filter that matches input with any HealthState value. The value is 65535.",
+ "in": "query",
+ "x-ms-parameter-location": "method",
+ "type": "integer",
+ "required": false,
+ "default": 0
+ },
+ "ApplicationTypeDefinitionKindFilterOptionalQueryParam": {
+ "name": "ApplicationTypeDefinitionKindFilter",
+ "description": "Used to filter on ApplicationTypeDefinitionKind which is the mechanism used to define a Service Fabric application type.\n- Default - Default value, which performs the same function as selecting \"All\". The value is 0.\n- All - Filter that matches input with any ApplicationTypeDefinitionKind value. The value is 65535.\n- ServiceFabricApplicationPackage - Filter that matches input with ApplicationTypeDefinitionKind value ServiceFabricApplicationPackage. The value is 1.\n- Compose - Filter that matches input with ApplicationTypeDefinitionKind value Compose. The value is 2.",
+ "in": "query",
+ "x-ms-parameter-location": "method",
+ "type": "integer",
+ "required": false,
+ "default": 0
+ },
+ "ApplicationTypeNameOptionalQueryParam": {
+ "name": "ApplicationTypeName",
+ "in": "query",
+ "x-ms-parameter-location": "method",
+ "type": "string",
+ "required": false,
+ "description": "The application type name used to filter the applications to query for. This value should not contain the application type version."
+ },
+ "ApplicationTypeNameRequiredPathParam": {
+ "name": "applicationTypeName",
+ "in": "path",
+ "x-ms-parameter-location": "method",
+ "type": "string",
+ "required": true,
+ "description": "The name of the application type."
+ },
+ "ApplicationTypeVersionOptionalQueryParam": {
+ "name": "ApplicationTypeVersion",
+ "in": "query",
+ "x-ms-parameter-location": "method",
+ "type": "string",
+ "required": false,
+ "description": "The version of the application type."
+ },
+ "ApplicationTypeVersionRequiredQueryParam": {
+ "name": "ApplicationTypeVersion",
+ "in": "query",
+ "x-ms-parameter-location": "method",
+ "type": "string",
+ "required": true,
+ "description": "The version of the application type."
+ },
+ "ProvisionApplicationTypeDescriptionBaseRequiredBodyParam": {
+ "name": "ProvisionApplicationTypeDescriptionBaseRequiredBodyParam",
+ "in": "body",
+ "description": "The base type of provision application type description which supports either image store-based provision or external store-based provision.",
+ "required": true,
+ "x-ms-parameter-location": "method",
+ "schema": {
+ "$ref": "#/definitions/ProvisionApplicationTypeDescriptionBase"
+ }
+ },
+ "ClusterConfigurationUpgradeDescriptionRequiredBodyParam": {
+ "name": "ClusterConfigurationUpgradeDescription",
+ "in": "body",
+ "description": "Parameters for a standalone cluster configuration upgrade.",
+ "required": true,
+ "x-ms-parameter-location": "method",
+ "schema": {
+ "$ref": "#/definitions/ClusterConfigurationUpgradeDescription"
+ }
+ },
+ "ClusterHealthPoliciesOptionalBodyParam": {
+ "name": "ClusterHealthPolicies",
+ "in": "body",
+ "description": "Describes the health policies used to evaluate the cluster health.\nIf not present, the health evaluation uses the cluster health policy defined in the cluster manifest or the default cluster health policy.\nBy default, each application is evaluated using its specific application health policy, defined in the application manifest, or the default health policy, if no policy is defined in manifest.\nIf the application health policy map is specified, and it has an entry for an application, the specified application health policy\nis used to evaluate the application health.",
+ "required": false,
+ "x-ms-parameter-location": "method",
+ "schema": {
+ "$ref": "#/definitions/ClusterHealthPolicies"
+ }
+ },
+ "ClusterHealthPolicyOptionalBodyParam": {
+ "name": "ClusterHealthPolicy",
+ "in": "body",
+ "description": "Describes the health policies used to evaluate the health of a cluster or node. If not present, the health evaluation uses the health policy from cluster manifest or the default health policy.",
+ "required": false,
+ "x-ms-parameter-location": "method",
+ "schema": {
+ "$ref": "#/definitions/ClusterHealthPolicy"
+ }
+ },
+ "ClusterHealthChunkQueryDescriptionOptionalBodyParam": {
+ "name": "ClusterHealthChunkQueryDescription",
+ "in": "body",
+ "description": "Describes the cluster and application health policies used to evaluate the cluster health and the filters to select which cluster entities to be returned.\nIf the cluster health policy is present, it is used to evaluate the cluster events and the cluster nodes. If not present, the health evaluation uses the cluster health policy defined in the cluster manifest or the default cluster health policy.\nBy default, each application is evaluated using its specific application health policy, defined in the application manifest, or the default health policy, if no policy is defined in manifest.\nIf the application health policy map is specified, and it has an entry for an application, the specified application health policy\nis used to evaluate the application health.\nUsers can specify very flexible filters to select which cluster entities to include in response. The selection can be done based on the entities health state and based on the hierarchy.\nThe query can return multi-level children of the entities based on the specified filters. For example, it can return one application with a specified name, and for this application, return\nonly services that are in Error or Warning, and all partitions and replicas for one of these services.",
+ "required": false,
+ "x-ms-parameter-location": "method",
+ "schema": {
+ "$ref": "#/definitions/ClusterHealthChunkQueryDescription"
+ }
+ },
+ "CodePackageInstanceIdRequiredQueryParam": {
+ "name": "CodePackageInstanceId",
+ "description": "ID that uniquely identifies a code package instance deployed on a service fabric node.",
+ "in": "query",
+ "x-ms-parameter-location": "method",
+ "type": "string",
+ "required": true
+ },
+ "CodePackageNameRequiredQueryParam": {
+ "name": "CodePackageName",
+ "in": "query",
+ "x-ms-parameter-location": "method",
+ "type": "string",
+ "required": true,
+ "description": "The name of code package specified in service manifest registered as part of an application type in a Service Fabric cluster."
+ },
+ "CodeVersionOptionalQueryParam": {
+ "name": "CodeVersion",
+ "in": "query",
+ "x-ms-parameter-location": "method",
+ "type": "string",
+ "required": false,
+ "description": "The product version of Service Fabric."
+ },
+ "ConfigVersionOptionalQueryParam": {
+ "name": "ConfigVersion",
+ "in": "query",
+ "x-ms-parameter-location": "method",
+ "type": "string",
+ "required": false,
+ "description": "The config version of Service Fabric."
+ },
+ "ConfigurationApiVersionRequiredQueryParam": {
+ "name": "ConfigurationApiVersion",
+ "in": "query",
+ "x-ms-parameter-location": "method",
+ "type": "string",
+ "required": true,
+ "description": "The API version of the Standalone cluster json configuration."
+ },
+ "ContainerApiRequiredBodyParam": {
+ "name": "ContainerApiRequestBody",
+ "in": "body",
+ "description": "Parameters for making container API call",
+ "required": true,
+ "x-ms-parameter-location": "method",
+ "schema": {
+ "$ref": "#/definitions/ContainerApiRequestBody"
+ }
+ },
+ "ContinuationTokenOptionalQueryParam": {
+ "name": "ContinuationToken",
+ "in": "query",
+ "x-ms-parameter-location": "method",
+ "x-ms-skip-url-encoding": true,
+ "type": "string",
+ "required": false,
+ "description": "The continuation token parameter is used to obtain next set of results. A continuation token with a non-empty value is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token does not contain a value. The value of this parameter should not be URL encoded."
+ },
+ "DeployedApplicationsHealthStateFilterOptionalQueryParam": {
+ "name": "DeployedApplicationsHealthStateFilter",
+ "description": "Allows filtering of the deployed applications health state objects returned in the result of application health query based on their health state.\nThe possible values for this parameter include integer value of one of the following health states. Only deployed applications that match the filter will be returned.\nAll deployed applications are used to evaluate the aggregated health state. If not specified, all entries are returned.\nThe state values are flag-based enumeration, so the value could be a combination of these values, obtained using bitwise 'OR' operator.\nFor example, if the provided value is 6 then health state of deployed applications with HealthState value of OK (2) and Warning (4) are returned.\n\n- Default - Default value. Matches any HealthState. The value is zero.\n- None - Filter that doesn't match any HealthState value. Used in order to return no results on a given collection of states. The value is 1.\n- Ok - Filter that matches input with HealthState value Ok. The value is 2.\n- Warning - Filter that matches input with HealthState value Warning. The value is 4.\n- Error - Filter that matches input with HealthState value Error. The value is 8.\n- All - Filter that matches input with any HealthState value. The value is 65535.",
+ "in": "query",
+ "x-ms-parameter-location": "method",
+ "type": "integer",
+ "required": false,
+ "default": 0
+ },
+ "DeployedServicePackagesHealthStateFilterOptionalQueryParam": {
+ "name": "DeployedServicePackagesHealthStateFilter",
+ "description": "Allows filtering of the deployed service package health state objects returned in the result of deployed application health query based on their health state.\nThe possible values for this parameter include integer value of one of the following health states.\nOnly deployed service packages that match the filter are returned. All deployed service packages are used to evaluate the aggregated health state of the deployed application.\nIf not specified, all entries are returned.\nThe state values are flag-based enumeration, so the value can be a combination of these values, obtained using the bitwise 'OR' operator.\nFor example, if the provided value is 6 then health state of service packages with HealthState value of OK (2) and Warning (4) are returned.\n\n- Default - Default value. Matches any HealthState. The value is zero.\n- None - Filter that doesn't match any HealthState value. Used in order to return no results on a given collection of states. The value is 1.\n- Ok - Filter that matches input with HealthState value Ok. The value is 2.\n- Warning - Filter that matches input with HealthState value Warning. The value is 4.\n- Error - Filter that matches input with HealthState value Error. The value is 8.\n- All - Filter that matches input with any HealthState value. The value is 65535.",
+ "in": "query",
+ "x-ms-parameter-location": "method",
+ "type": "integer",
+ "required": false,
+ "default": 0
+ },
+ "DeploymentNameRequiredPathParam": {
+ "name": "deploymentName",
+ "in": "path",
+ "x-ms-parameter-location": "method",
+ "x-ms-skip-url-encoding": true,
+ "type": "string",
+ "required": true,
+ "description": "The identity of the deployment."
+ },
+ "EventsHealthStateFilterOptionalQueryParam": {
+ "name": "EventsHealthStateFilter",
+ "description": "Allows filtering the collection of HealthEvent objects returned based on health state.\nThe possible values for this parameter include integer value of one of the following health states.\nOnly events that match the filter are returned. All events are used to evaluate the aggregated health state.\nIf not specified, all entries are returned. The state values are flag-based enumeration, so the value could be a combination of these values, obtained using the bitwise 'OR' operator. For example, If the provided value is 6 then all of the events with HealthState value of OK (2) and Warning (4) are returned.\n\n- Default - Default value. Matches any HealthState. The value is zero.\n- None - Filter that doesn't match any HealthState value. Used in order to return no results on a given collection of states. The value is 1.\n- Ok - Filter that matches input with HealthState value Ok. The value is 2.\n- Warning - Filter that matches input with HealthState value Warning. The value is 4.\n- Error - Filter that matches input with HealthState value Error. The value is 8.\n- All - Filter that matches input with any HealthState value. The value is 65535.",
+ "in": "query",
+ "x-ms-parameter-location": "method",
+ "type": "integer",
+ "required": false,
+ "default": 0
+ },
+ "ExcludeApplicationParametersOptionalQueryParam": {
+ "name": "ExcludeApplicationParameters",
+ "in": "query",
+ "x-ms-parameter-location": "method",
+ "type": "boolean",
+ "required": false,
+ "default": false,
+ "description": "The flag that specifies whether application parameters will be excluded from the result."
+ },
+ "HealthInformationRequiredBodyParam": {
+ "name": "HealthInformation",
+ "in": "body",
+ "description": "Describes the health information for the health report. This information needs to be present in all of the health reports sent to the health manager.",
+ "required": true,
+ "x-ms-parameter-location": "method",
+ "schema": {
+ "$ref": "#/definitions/HealthInformation"
+ }
+ },
+ "NodeNameRequiredPathParam": {
+ "name": "nodeName",
+ "in": "path",
+ "x-ms-parameter-location": "method",
+ "type": "string",
+ "required": true,
+ "description": "The name of the node."
+ },
+ "NodesHealthStateFilterOptionalQueryParam": {
+ "name": "NodesHealthStateFilter",
+ "description": "Allows filtering of the node health state objects returned in the result of cluster health query\nbased on their health state. The possible values for this parameter include integer value of one of the\nfollowing health states. Only nodes that match the filter are returned. All nodes are used to evaluate the aggregated health state.\nIf not specified, all entries are returned.\nThe state values are flag-based enumeration, so the value could be a combination of these values obtained using bitwise 'OR' operator.\nFor example, if the provided value is 6 then health state of nodes with HealthState value of OK (2) and Warning (4) are returned.\n\n- Default - Default value. Matches any HealthState. The value is zero.\n- None - Filter that doesn't match any HealthState value. Used in order to return no results on a given collection of states. The value is 1.\n- Ok - Filter that matches input with HealthState value Ok. The value is 2.\n- Warning - Filter that matches input with HealthState value Warning. The value is 4.\n- Error - Filter that matches input with HealthState value Error. The value is 8.\n- All - Filter that matches input with any HealthState value. The value is 65535.",
+ "in": "query",
+ "x-ms-parameter-location": "method",
+ "type": "integer",
+ "required": false,
+ "default": 0
+ },
+ "NodeStatusFilterOptionalQueryParam": {
+ "name": "NodeStatusFilter",
+ "description": "Allows filtering the nodes based on the NodeStatus. Only the nodes that are matching the specified filter value will be returned. The filter value can be one of the following.",
+ "in": "query",
+ "x-ms-parameter-location": "method",
+ "type": "string",
+ "enum": [
+ "default",
+ "all",
+ "up",
+ "down",
+ "enabling",
+ "disabling",
+ "disabled",
+ "unknown",
+ "removed"
+ ],
+ "required": false,
+ "default": "default",
+ "x-ms-enum": {
+ "name": "NodeStatusFilter",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "default",
+ "description": "This filter value will match all of the nodes excepts the ones with status as Unknown or Removed."
+ },
+ {
+ "value": "all",
+ "description": "This filter value will match all of the nodes."
+ },
+ {
+ "value": "up",
+ "description": "This filter value will match nodes that are Up."
+ },
+ {
+ "value": "down",
+ "description": "This filter value will match nodes that are Down."
+ },
+ {
+ "value": "enabling",
+ "description": "This filter value will match nodes that are in the process of being enabled with status as Enabling."
+ },
+ {
+ "value": "disabling",
+ "description": "This filter value will match nodes that are in the process of being disabled with status as Disabling."
+ },
+ {
+ "value": "disabled",
+ "description": "This filter value will match nodes that are Disabled."
+ },
+ {
+ "value": "unknown",
+ "description": "This filter value will match nodes whose status is Unknown. A node would be in Unknown state if Service Fabric does not have authoritative information about that node. This can happen if the system learns about a node at runtime."
+ },
+ {
+ "value": "removed",
+ "description": "This filter value will match nodes whose status is Removed. These are the nodes that are removed from the cluster using the RemoveNodeState API."
+ }
+ ]
+ }
+ },
+ "PartitionIdOptionalQueryParam": {
+ "name": "PartitionId",
+ "in": "query",
+ "x-ms-parameter-location": "method",
+ "type": "string",
+ "format": "uuid",
+ "required": false,
+ "description": "The identity of the partition."
+ },
+ "PartitionIdRequiredPathParam": {
+ "name": "partitionId",
+ "in": "path",
+ "x-ms-parameter-location": "method",
+ "x-ms-skip-url-encoding": true,
+ "type": "string",
+ "format": "uuid",
+ "required": true,
+ "description": "The identity of the partition."
+ },
+ "ProvisionFabricDescriptionRequiredBodyParam": {
+ "name": "ProvisionFabricDescription",
+ "in": "body",
+ "description": "Describes the parameters for provisioning a cluster.",
+ "required": true,
+ "x-ms-parameter-location": "method",
+ "schema": {
+ "$ref": "#/definitions/ProvisionFabricDescription"
+ }
+ },
+ "UnprovisionFabricDescriptionRequiredBodyParam": {
+ "name": "UnprovisionFabricDescription",
+ "in": "body",
+ "description": "Describes the parameters for unprovisioning a cluster.",
+ "required": true,
+ "x-ms-parameter-location": "method",
+ "schema": {
+ "$ref": "#/definitions/UnprovisionFabricDescription"
+ }
+ },
+ "ResumeClusterUpgradeDescriptionRequiredBodyParam": {
+ "name": "ResumeClusterUpgradeDescription",
+ "in": "body",
+ "description": "Describes the parameters for resuming a cluster upgrade.",
+ "required": true,
+ "x-ms-parameter-location": "method",
+ "schema": {
+ "$ref": "#/definitions/ResumeClusterUpgradeDescription"
+ }
+ },
+ "UpdateClusterUpgradeDescriptionRequiredBodyParam": {
+ "name": "UpdateClusterUpgradeDescription",
+ "in": "body",
+ "description": "Parameters for updating a cluster upgrade.",
+ "required": true,
+ "x-ms-parameter-location": "method",
+ "schema": {
+ "$ref": "#/definitions/UpdateClusterUpgradeDescription"
+ }
+ },
+ "StartClusterUpgradeDescriptionRequiredBodyParam": {
+ "name": "StartClusterUpgradeDescription",
+ "in": "body",
+ "description": "Describes the parameters for starting a cluster upgrade.",
+ "required": true,
+ "x-ms-parameter-location": "method",
+ "schema": {
+ "$ref": "#/definitions/StartClusterUpgradeDescription"
+ }
+ },
+ "ReplicaHealthReportServiceKindRequiredQueryParam": {
+ "name": "ServiceKind",
+ "in": "query",
+ "required": true,
+ "x-ms-parameter-location": "method",
+ "description": "The kind of service replica (Stateless or Stateful) for which the health is being reported. Following are the possible values.",
+ "type": "string",
+ "enum": [
+ "Stateless",
+ "Stateful"
+ ],
+ "default": "Stateful",
+ "x-ms-enum": {
+ "name": "ReplicaHealthReportServiceKind",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "Stateless",
+ "description": "Does not use Service Fabric to make its state highly available or reliable. The value is 1"
+ },
+ {
+ "value": "Stateful",
+ "description": "Uses Service Fabric to make its state or part of its state highly available and reliable. The value is 2."
+ }
+ ]
+ }
+ },
+ "ReplicaIdRequiredPathParam": {
+ "name": "replicaId",
+ "in": "path",
+ "x-ms-parameter-location": "method",
+ "x-ms-skip-url-encoding": true,
+ "type": "string",
+ "required": true,
+ "description": "The identifier of the replica."
+ },
+ "ReplicasHealthStateFilerOptionalQueryParam": {
+ "name": "ReplicasHealthStateFilter",
+ "description": "Allows filtering the collection of ReplicaHealthState objects on the partition. The value can be obtained from members or bitwise operations on members of HealthStateFilter. Only replicas that match the filter will be returned. All replicas will be used to evaluate the aggregated health state. If not specified, all entries will be returned.The state values are flag-based enumeration, so the value could be a combination of these values obtained using bitwise 'OR' operator. For example, If the provided value is 6 then all of the events with HealthState value of OK (2) and Warning (4) will be returned. The possible values for this parameter include integer value of one of the following health states.\n\n- Default - Default value. Matches any HealthState. The value is zero.\n- None - Filter that doesn't match any HealthState value. Used in order to return no results on a given collection of states. The value is 1.\n- Ok - Filter that matches input with HealthState value Ok. The value is 2.\n- Warning - Filter that matches input with HealthState value Warning. The value is 4.\n- Error - Filter that matches input with HealthState value Error. The value is 8.\n- All - Filter that matches input with any HealthState value. The value is 65535.",
+ "in": "query",
+ "x-ms-parameter-location": "method",
+ "type": "integer",
+ "required": false,
+ "default": 0
+ },
+ "ServiceIdRequiredPathParam": {
+ "name": "serviceId",
+ "in": "path",
+ "x-ms-parameter-location": "method",
+ "x-ms-skip-url-encoding": true,
+ "type": "string",
+ "required": true,
+ "description": "The identity of the service. This ID is typically the full name of the service without the 'fabric:' URI scheme.\nStarting from version 6.0, hierarchical names are delimited with the \"~\" character.\nFor example, if the service name is \"fabric:/myapp/app1/svc1\", the service identity would be \"myapp~app1~svc1\" in 6.0+ and \"myapp/app1/svc1\" in previous versions."
+ },
+ "ServiceManifestNameOptionalQueryParam": {
+ "name": "ServiceManifestName",
+ "in": "query",
+ "x-ms-parameter-location": "method",
+ "type": "string",
+ "required": false,
+ "description": "The name of a service manifest registered as part of an application type in a Service Fabric cluster."
+ },
+ "ServiceManifestNameRequiredQueryParam": {
+ "name": "ServiceManifestName",
+ "in": "query",
+ "x-ms-parameter-location": "method",
+ "type": "string",
+ "required": true,
+ "description": "The name of a service manifest registered as part of an application type in a Service Fabric cluster."
+ },
+ "ServicePackageNameRequiredPathParam": {
+ "name": "servicePackageName",
+ "in": "path",
+ "x-ms-parameter-location": "method",
+ "x-ms-skip-url-encoding": true,
+ "type": "string",
+ "required": true,
+ "description": "The name of the service package."
+ },
+ "ServicesHealthStateFilterOptionalQueryParam": {
+ "name": "ServicesHealthStateFilter",
+ "description": "Allows filtering of the services health state objects returned in the result of services health query based on their health state.\nThe possible values for this parameter include integer value of one of the following health states.\nOnly services that match the filter are returned. All services are used to evaluate the aggregated health state.\nIf not specified, all entries are returned. The state values are flag-based enumeration, so the value could be a combination of these values,\nobtained using bitwise 'OR' operator. For example, if the provided value is 6 then health state of services with HealthState value of OK (2) and Warning (4) will be returned.\n\n- Default - Default value. Matches any HealthState. The value is zero.\n- None - Filter that doesn't match any HealthState value. Used in order to return no results on a given collection of states. The value is 1.\n- Ok - Filter that matches input with HealthState value Ok. The value is 2.\n- Warning - Filter that matches input with HealthState value Warning. The value is 4.\n- Error - Filter that matches input with HealthState value Error. The value is 8.\n- All - Filter that matches input with any HealthState value. The value is 65535.",
+ "in": "query",
+ "x-ms-parameter-location": "method",
+ "type": "integer",
+ "required": false,
+ "default": 0
+ },
+ "CreateServiceFromTemplateRequiredBodyParam": {
+ "name": "ServiceFromTemplateDescription",
+ "in": "body",
+ "description": "Describes the service that needs to be created from the template defined in the application manifest.",
+ "required": true,
+ "x-ms-parameter-location": "method",
+ "schema": {
+ "$ref": "#/definitions/ServiceFromTemplateDescription"
+ }
+ },
+ "ServiceTypeNameOptionalQueryParam": {
+ "name": "ServiceTypeName",
+ "in": "query",
+ "x-ms-parameter-location": "method",
+ "type": "string",
+ "required": false,
+ "description": "The service type name used to filter the services to query for."
+ },
+ "InfrastructureCommandRequiredQueryParam": {
+ "name": "Command",
+ "description": "The text of the command to be invoked. The content of the command is infrastructure-specific.",
+ "in": "query",
+ "x-ms-parameter-location": "method",
+ "type": "string",
+ "required": true
+ },
+ "InfrastructureServiceIdOptionalQueryParam": {
+ "name": "ServiceId",
+ "in": "query",
+ "x-ms-parameter-location": "method",
+ "type": "string",
+ "description": "The identity of the infrastructure service. This is the full name of the infrastructure service without the 'fabric:' URI scheme. This parameter required only for the cluster that has more than one instance of infrastructure service running.",
+ "required": false
+ },
+ "ForceRemoveOptionalQueryParam": {
+ "name": "ForceRemove",
+ "in": "query",
+ "x-ms-parameter-location": "method",
+ "type": "boolean",
+ "required": false,
+ "description": "Remove a Service Fabric application or service forcefully without going through the graceful shutdown sequence. This parameter can be used to forcefully delete an application or service for which delete is timing out due to issues in the service code that prevents graceful close of replicas."
+ },
+ "ForceRemoveReplicaOptionalQueryParam": {
+ "name": "ForceRemove",
+ "in": "query",
+ "x-ms-parameter-location": "method",
+ "type": "boolean",
+ "required": false,
+ "description": "Remove a Service Fabric application or service forcefully without going through the graceful shutdown sequence. This parameter can be used to forcefully delete an application or service for which delete is timing out due to issues in the service code that prevents graceful close of replicas."
+ },
+ "DeactivationIntentDescriptionRequiredBodyParam": {
+ "name": "DeactivationIntentDescription",
+ "in": "body",
+ "description": "Describes the intent or reason for deactivating the node.",
+ "required": true,
+ "x-ms-parameter-location": "method",
+ "schema": {
+ "$ref": "#/definitions/DeactivationIntentDescription"
+ }
+ },
+ "RestartNodeDescriptionRequiredBodyParam": {
+ "name": "RestartNodeDescription",
+ "in": "body",
+ "description": "The instance of the node to be restarted and a flag indicating the need to take dump of the fabric process.",
+ "required": true,
+ "x-ms-parameter-location": "method",
+ "schema": {
+ "$ref": "#/definitions/RestartNodeDescription"
+ }
+ },
+ "ApplicationUpgradeDescriptionRequiredBodyParam": {
+ "name": "ApplicationUpgradeDescription",
+ "in": "body",
+ "description": "Parameters for an application upgrade.",
+ "required": true,
+ "x-ms-parameter-location": "method",
+ "schema": {
+ "$ref": "#/definitions/ApplicationUpgradeDescription"
+ }
+ },
+ "ComposeDeploymentUpgradeDescriptionRequiredBodyParam": {
+ "name": "ComposeDeploymentUpgradeDescription",
+ "in": "body",
+ "description": "Parameters for upgrading compose deployment.",
+ "required": true,
+ "x-ms-parameter-location": "method",
+ "schema": {
+ "$ref": "#/definitions/ComposeDeploymentUpgradeDescription"
+ }
+ },
+ "ApplicationTypeImageStorePathRequiredBodyParam": {
+ "name": "ApplicationTypeImageStorePath",
+ "in": "body",
+ "description": "The relative path for the application package in the image store specified during the prior copy operation.",
+ "required": true,
+ "x-ms-parameter-location": "method",
+ "schema": {
+ "$ref": "#/definitions/ApplicationTypeImageStorePath"
+ }
+ },
+ "UnprovisionApplicationTypeRequiredBodyParam": {
+ "name": "UnprovisionApplicationTypeDescriptionInfo",
+ "in": "body",
+ "description": "The relative path for the application package in the image store specified during the prior copy operation.",
+ "required": true,
+ "x-ms-parameter-location": "method",
+ "schema": {
+ "$ref": "#/definitions/UnprovisionApplicationTypeDescriptionInfo"
+ }
+ },
+ "UpgradeOrchestrationServiceStateRequiredBodyParam": {
+ "name": "UpgradeOrchestrationServiceState",
+ "in": "body",
+ "x-ms-parameter-location": "method",
+ "required": true,
+ "description": "Service state of Service Fabric Upgrade Orchestration Service.",
+ "schema": {
+ "$ref": "#/definitions/UpgradeOrchestrationServiceState"
+ }
+ },
+ "ChaosParametersRequiredBodyParam": {
+ "name": "ChaosParameters",
+ "in": "body",
+ "description": "Describes all the parameters to configure a Chaos run.",
+ "required": true,
+ "x-ms-parameter-location": "method",
+ "schema": {
+ "$ref": "#/definitions/ChaosParameters"
+ }
+ },
+ "StartTimeUtcOptionalQueryParam": {
+ "name": "StartTimeUtc",
+ "in": "query",
+ "x-ms-parameter-location": "method",
+ "type": "string",
+ "required": false,
+ "description": "The Windows file time representing the start time of the time range for which a Chaos report is to be generated. Consult [DateTime.ToFileTimeUtc Method](https://msdn.microsoft.com/library/system.datetime.tofiletimeutc(v=vs.110).aspx) for details."
+ },
+ "EndTimeUtcOptionalQueryParam": {
+ "name": "EndTimeUtc",
+ "in": "query",
+ "x-ms-parameter-location": "method",
+ "type": "string",
+ "required": false,
+ "description": "The Windows file time representing the end time of the time range for which a Chaos report is to be generated. Consult [DateTime.ToFileTimeUtc Method](https://msdn.microsoft.com/library/system.datetime.tofiletimeutc(v=vs.110).aspx) for details."
+ },
+ "ApplicationNameRequiredQueryParam": {
+ "name": "ApplicationName",
+ "in": "query",
+ "x-ms-parameter-location": "method",
+ "type": "string",
+ "required": true,
+ "description": "The name of application to create from compose file. This is typically the full name of the application including 'fabric:' URI scheme."
+ },
+ "CreateComposeDeploymentRequiredBodyParam": {
+ "name": "CreateComposeDeploymentDescription",
+ "in": "body",
+ "description": "Describes the compose deployment that needs to be created.",
+ "required": true,
+ "x-ms-parameter-location": "method",
+ "schema": {
+ "$ref": "#/definitions/CreateComposeDeploymentDescription"
+ }
+ },
+ "PasswordEncryptedOptionalQueryParam": {
+ "name": "PasswordEncrypted",
+ "in": "query",
+ "x-ms-parameter-location": "method",
+ "type": "boolean",
+ "required": false,
+ "description": "Indicates that supplied container repository password is encrypted."
+ },
+ "RepositoryPasswordOptionalQueryParam": {
+ "name": "RepositoryPassword",
+ "in": "query",
+ "x-ms-parameter-location": "method",
+ "type": "string",
+ "required": false,
+ "description": "The password for supplied username to connect to container repository."
+ },
+ "RepositoryUserNameOptionalQueryParam": {
+ "name": "RepositoryUserName",
+ "in": "query",
+ "x-ms-parameter-location": "method",
+ "type": "string",
+ "required": false,
+ "description": "The user name to connect to container repository."
+ },
+ "MaxResultsOptionalQueryParam": {
+ "name": "MaxResults",
+ "in": "query",
+ "x-ms-parameter-location": "method",
+ "type": "integer",
+ "format": "int64",
+ "minimum": 0,
+ "default": 0,
+ "required": false,
+ "description": "The maximum number of results to be returned as part of the paged queries. This parameter defines the upper bound on the number of results returned. The results returned can be less than the specified maximum results if they do not fit in the message as per the max message size restrictions defined in the configuration. If this parameter is zero or not specified, the paged query includes as many results as possible that fit in the return message."
+ },
+ "ApplicationDescriptionRequiredBodyParam": {
+ "name": "ApplicationDescription",
+ "in": "body",
+ "description": "Description for creating an application.",
+ "required": true,
+ "x-ms-parameter-location": "method",
+ "schema": {
+ "$ref": "#/definitions/ApplicationDescription"
+ }
+ },
+ "ServiceDescriptionRequiredBodyParam": {
+ "name": "ServiceDescription",
+ "in": "body",
+ "description": "The information necessary to create a service.",
+ "required": true,
+ "x-ms-parameter-location": "method",
+ "schema": {
+ "$ref": "#/definitions/ServiceDescription"
+ }
+ },
+ "ServiceUpdateDescriptionRequiredBodyParam": {
+ "name": "ServiceUpdateDescription",
+ "in": "body",
+ "description": "The information necessary to update a service.",
+ "required": true,
+ "x-ms-parameter-location": "method",
+ "schema": {
+ "$ref": "#/definitions/ServiceUpdateDescription"
+ }
+ },
+ "ImageStoreCopyDescriptionRequiredBodyParam": {
+ "name": "ImageStoreCopyDescription",
+ "in": "body",
+ "description": "Describes the copy description for the image store.",
+ "required": true,
+ "x-ms-parameter-location": "method",
+ "schema": {
+ "$ref": "#/definitions/ImageStoreCopyDescription"
+ }
+ },
+ "CodePackageNameOptionalQueryParam": {
+ "name": "CodePackageName",
+ "in": "query",
+ "x-ms-parameter-location": "method",
+ "type": "string",
+ "required": false,
+ "description": "The name of code package specified in service manifest registered as part of an application type in a Service Fabric cluster."
+ },
+ "RestartDeployedCodePackageRequiredBodyParam": {
+ "name": "RestartDeployedCodePackageDescription",
+ "in": "body",
+ "description": "Describes the deployed code package on Service Fabric node to restart.",
+ "required": true,
+ "x-ms-parameter-location": "method",
+ "schema": {
+ "$ref": "#/definitions/RestartDeployedCodePackageDescription"
+ }
+ },
+ "PartitionsHealthStateFilterOptionalQueryParam": {
+ "name": "PartitionsHealthStateFilter",
+ "description": "Allows filtering of the partitions health state objects returned in the result of service health query based on their health state.\nThe possible values for this parameter include integer value of one of the following health states.\nOnly partitions that match the filter are returned. All partitions are used to evaluate the aggregated health state.\nIf not specified, all entries are returned. The state values are flag-based enumeration, so the value could be a combination of these value\nobtained using bitwise 'OR' operator. For example, if the provided value is 6 then health state of partitions with HealthState value of OK (2) and Warning (4) will be returned.\n\n- Default - Default value. Matches any HealthState. The value is zero.\n- None - Filter that doesn't match any HealthState value. Used in order to return no results on a given collection of states. The value is 1.\n- Ok - Filter that matches input with HealthState value Ok. The value is 2.\n- Warning - Filter that matches input with HealthState value Warning. The value is 4.\n- Error - Filter that matches input with HealthState value Error. The value is 8.\n- All - Filter that matches input with any HealthState value. The value is 65535.",
+ "in": "query",
+ "x-ms-parameter-location": "method",
+ "type": "integer",
+ "required": false,
+ "default": 0
+ },
+ "DeployedServiceType_ServiceManifestNameOptionalQueryParam": {
+ "name": "ServiceManifestName",
+ "in": "query",
+ "x-ms-parameter-location": "method",
+ "type": "string",
+ "required": false,
+ "description": "The name of the service manifest to filter the list of deployed service type information. If specified, the response will only contain the information about service types that are defined in this service manifest."
+ },
+ "ServiceTypeNameRequiredPathParam": {
+ "name": "serviceTypeName",
+ "in": "path",
+ "x-ms-parameter-location": "method",
+ "x-ms-skip-url-encoding": true,
+ "type": "string",
+ "required": true,
+ "description": "Specifies the name of a Service Fabric service type."
+ },
+ "ImageStoreContentPathRequiredPathParam": {
+ "name": "contentPath",
+ "in": "path",
+ "x-ms-parameter-location": "method",
+ "type": "string",
+ "required": true,
+ "description": "Relative path to file or folder in the image store from its root."
+ },
+ "PartitionKeyTypeOptionalQueryParam": {
+ "name": "PartitionKeyType",
+ "description": "Key type for the partition. This parameter is required if the partition scheme for the service is Int64Range or Named. The possible values are following.\n- None (1) - Indicates that the PartitionKeyValue parameter is not specified. This is valid for the partitions with partitioning scheme as Singleton. This is the default value. The value is 1.\n- Int64Range (2) - Indicates that the PartitionKeyValue parameter is an int64 partition key. This is valid for the partitions with partitioning scheme as Int64Range. The value is 2.\n- Named (3) - Indicates that the PartitionKeyValue parameter is a name of the partition. This is valid for the partitions with partitioning scheme as Named. The value is 3.",
+ "in": "query",
+ "x-ms-parameter-location": "method",
+ "type": "integer",
+ "required": false
+ },
+ "PartitionKeyValueOptionalQueryParam": {
+ "name": "PartitionKeyValue",
+ "in": "query",
+ "x-ms-parameter-location": "method",
+ "x-ms-skip-url-encoding": true,
+ "type": "string",
+ "required": false,
+ "description": "Partition key. This is required if the partition scheme for the service is Int64Range or Named. \nThis is not the partition ID, but rather, either the integer key value, or the name of the partition ID.\nFor example, if your service is using ranged partitions from 0 to 10, then they PartitionKeyValue would be an\ninteger in that range. Query service description to see the range or name."
+ },
+ "PreviousRspVersionOptionalQueryParam": {
+ "name": "PreviousRspVersion",
+ "in": "query",
+ "x-ms-parameter-location": "method",
+ "x-ms-skip-url-encoding": true,
+ "type": "string",
+ "required": false,
+ "description": "The value in the Version field of the response that was received previously. This is required if the user knows that the result that was gotten previously is stale."
+ },
+ "DataLossModeRequiredQueryParam": {
+ "name": "DataLossMode",
+ "description": "This enum is passed to the StartDataLoss API to indicate what type of data loss to induce.",
+ "in": "query",
+ "x-ms-parameter-location": "method",
+ "type": "string",
+ "enum": [
+ "Invalid",
+ "PartialDataLoss",
+ "FullDataLoss"
+ ],
+ "required": true,
+ "x-ms-enum": {
+ "name": "DataLossMode",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "Invalid",
+ "description": "Reserved. Do not pass into API."
+ },
+ {
+ "value": "PartialDataLoss",
+ "description": "PartialDataLoss option will cause a quorum of replicas to go down, triggering an OnDataLoss event in the system for the given partition."
+ },
+ {
+ "value": "FullDataLoss",
+ "description": "FullDataLoss option will drop all the replicas which means that all the data will be lost."
+ }
+ ]
+ }
+ },
+ "FaultOperationIdRequiredQueryParam": {
+ "name": "OperationId",
+ "description": "A GUID that identifies a call of this API. This is passed into the corresponding GetProgress API",
+ "in": "query",
+ "x-ms-parameter-location": "method",
+ "type": "string",
+ "format": "uuid",
+ "required": true
+ },
+ "ForceRequiredQueryParam": {
+ "name": "Force",
+ "description": "Indicates whether to gracefully roll back and clean up internal system state modified by executing the user-induced operation.",
+ "in": "query",
+ "x-ms-parameter-location": "method",
+ "type": "boolean",
+ "required": true,
+ "default": false
+ },
+ "NodeInstanceIdRequiredQueryParam": {
+ "name": "NodeInstanceId",
+ "in": "query",
+ "x-ms-parameter-location": "method",
+ "type": "string",
+ "required": true,
+ "description": "The node instance ID of the target node. This can be determined through GetNodeInfo API."
+ },
+ "NodeTransitionTypeRequiredQueryParam": {
+ "name": "NodeTransitionType",
+ "description": "Indicates the type of transition to perform. NodeTransitionType.Start will start a stopped node. NodeTransitionType.Stop will stop a node that is up.",
+ "in": "query",
+ "x-ms-parameter-location": "method",
+ "type": "string",
+ "enum": [
+ "Invalid",
+ "Start",
+ "Stop"
+ ],
+ "required": true,
+ "x-ms-enum": {
+ "name": "NodeTransitionType",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "Invalid",
+ "description": "Reserved. Do not pass into API."
+ },
+ {
+ "value": "Start",
+ "description": "Transition a stopped node to up."
+ },
+ {
+ "value": "Stop",
+ "description": "Transition an up node to stopped."
+ }
+ ]
+ }
+ },
+ "QuorumLossDurationRequiredQueryParam": {
+ "name": "QuorumLossDuration",
+ "description": "The amount of time for which the partition will be kept in quorum loss. This must be specified in seconds.",
+ "in": "query",
+ "x-ms-parameter-location": "method",
+ "type": "integer",
+ "required": true
+ },
+ "QuorumLossModeRequiredQueryParam": {
+ "name": "QuorumLossMode",
+ "description": "This enum is passed to the StartQuorumLoss API to indicate what type of quorum loss to induce.",
+ "in": "query",
+ "x-ms-parameter-location": "method",
+ "type": "string",
+ "enum": [
+ "Invalid",
+ "QuorumReplicas",
+ "AllReplicas"
+ ],
+ "required": true,
+ "x-ms-enum": {
+ "name": "QuorumLossMode",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "Invalid",
+ "description": "Reserved. Do not pass into API."
+ },
+ {
+ "value": "QuorumReplicas",
+ "description": "Partial Quorum loss mode : Minimum number of replicas for a partition will be down that will cause a quorum loss."
+ },
+ {
+ "value": "AllReplicas"
+ }
+ ]
+ }
+ },
+ "RestartPartitionModeRequiredQueryParam": {
+ "name": "RestartPartitionMode",
+ "description": "Describe which partitions to restart.",
+ "in": "query",
+ "x-ms-parameter-location": "method",
+ "type": "string",
+ "enum": [
+ "Invalid",
+ "AllReplicasOrInstances",
+ "OnlyActiveSecondaries"
+ ],
+ "required": true,
+ "x-ms-enum": {
+ "name": "RestartPartitionMode",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "Invalid",
+ "description": "Reserved. Do not pass into API."
+ },
+ {
+ "value": "AllReplicasOrInstances",
+ "description": "All replicas or instances in the partition are restarted at once."
+ },
+ {
+ "value": "OnlyActiveSecondaries",
+ "description": "Only the secondary replicas are restarted."
+ }
+ ]
+ }
+ },
+ "StateFilterRequiredQueryParam": {
+ "name": "StateFilter",
+ "description": "Used to filter on OperationState's for user-induced operations.\n\n- 65535 - select All\n- 1 - select Running\n- 2 - select RollingBack\n- 8 - select Completed\n- 16 - select Faulted\n- 32 - select Cancelled\n- 64 - select ForceCancelled",
+ "in": "query",
+ "x-ms-parameter-location": "method",
+ "type": "integer",
+ "required": true,
+ "default": 65535
+ },
+ "StopDurationInSecondsRequiredQueryParam": {
+ "name": "StopDurationInSeconds",
+ "in": "query",
+ "x-ms-parameter-location": "method",
+ "type": "integer",
+ "format": "int32",
+ "minimum": 0,
+ "required": true,
+ "description": "The duration, in seconds, to keep the node stopped. The minimum value is 600, the maximum is 14400. After this time expires, the node will automatically come back up."
+ },
+ "TypeFilterRequiredQueryParam": {
+ "name": "TypeFilter",
+ "description": "Used to filter on OperationType for user-induced operations.\n\n- 65535 - select all\n- 1 - select PartitionDataLoss.\n- 2 - select PartitionQuorumLoss.\n- 4 - select PartitionRestart.\n- 8 - select NodeTransition.",
+ "in": "query",
+ "x-ms-parameter-location": "method",
+ "type": "integer",
+ "required": true,
+ "default": 65535
+ },
+ "DeployServicePackageToNodeRequiredBodyParam": {
+ "name": "DeployServicePackageToNodeDescription",
+ "in": "body",
+ "description": "Describes information for deploying a service package to a Service Fabric node.",
+ "required": true,
+ "x-ms-parameter-location": "method",
+ "schema": {
+ "$ref": "#/definitions/DeployServicePackageToNodeDescription"
+ }
+ },
+ "ResumeApplicationUpgradeDescriptionRequiredBodyParam": {
+ "name": "ResumeApplicationUpgradeDescription",
+ "in": "body",
+ "description": "Describes the parameters for resuming an application upgrade.",
+ "required": true,
+ "x-ms-parameter-location": "method",
+ "schema": {
+ "$ref": "#/definitions/ResumeApplicationUpgradeDescription"
+ }
+ },
+ "ApplicationUpgradeUpdateDescriptionRequiredBodyParam": {
+ "name": "ApplicationUpgradeUpdateDescription",
+ "in": "body",
+ "description": "Parameters for updating an existing application upgrade.",
+ "required": true,
+ "x-ms-parameter-location": "method",
+ "schema": {
+ "$ref": "#/definitions/ApplicationUpgradeUpdateDescription"
+ }
+ },
+ "TimeoutOptionalQueryParam": {
+ "name": "timeout",
+ "in": "query",
+ "x-ms-parameter-location": "method",
+ "type": "integer",
+ "format": "int64",
+ "required": false,
+ "minimum": 1,
+ "maximum": 4294967295,
+ "default": 60,
+ "description": "The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds."
+ },
+ "NameDescriptionRequiredBodyParam": {
+ "name": "NameDescription",
+ "in": "body",
+ "description": "Describes the Service Fabric name to be created.",
+ "required": true,
+ "x-ms-parameter-location": "method",
+ "schema": {
+ "$ref": "#/definitions/NameDescription"
+ }
+ },
+ "NameIdRequiredPathParam": {
+ "name": "nameId",
+ "in": "path",
+ "x-ms-parameter-location": "method",
+ "x-ms-skip-url-encoding": true,
+ "type": "string",
+ "required": true,
+ "description": "The Service Fabric name, without the 'fabric:' URI scheme."
+ },
+ "RecursiveOptionalQueryParam": {
+ "name": "Recursive",
+ "description": "Allows specifying that the search performed should be recursive.",
+ "in": "query",
+ "x-ms-parameter-location": "method",
+ "type": "boolean",
+ "required": false,
+ "default": false
+ },
+ "IncludeValuesOptionalQueryParam": {
+ "name": "IncludeValues",
+ "description": "Allows specifying whether to include the values of the properties returned. True if values should be returned with the metadata; False to return only property metadata.",
+ "in": "query",
+ "x-ms-parameter-location": "method",
+ "type": "boolean",
+ "required": false,
+ "default": false
+ },
+ "PropertyDescriptionRequiredBodyParam": {
+ "name": "PropertyDescription",
+ "in": "body",
+ "description": "Describes the Service Fabric property to be created.",
+ "required": true,
+ "x-ms-parameter-location": "method",
+ "schema": {
+ "$ref": "#/definitions/PropertyDescription"
+ }
+ },
+ "PropertyNameRequiredQueryParam": {
+ "name": "PropertyName",
+ "description": "Specifies the name of the property to get.",
+ "in": "query",
+ "x-ms-parameter-location": "method",
+ "type": "string",
+ "required": true
+ },
+ "PropertyBatchDescriptionListRequiredBodyParam": {
+ "name": "PropertyBatchDescriptionList",
+ "in": "body",
+ "description": "Describes the property batch operations to be submitted.",
+ "required": true,
+ "x-ms-parameter-location": "method",
+ "schema": {
+ "$ref": "#/definitions/PropertyBatchDescriptionList"
+ }
+ },
+ "ImmediateOptionalQueryParam": {
+ "name": "Immediate",
+ "in": "query",
+ "x-ms-parameter-location": "method",
+ "type": "boolean",
+ "required": false,
+ "default": false,
+ "description": "A flag that indicates whether the report should be sent immediately.\nA health report is sent to a Service Fabric gateway Application, which forwards to the health store.\nIf Immediate is set to true, the report is sent immediately from HTTP Gateway to the health store, regardless of the fabric client settings that the HTTP Gateway Application is using.\nThis is useful for critical reports that should be sent as soon as possible.\nDepending on timing and other conditions, sending the report may still fail, for example if the HTTP Gateway is closed or the message doesn't reach the Gateway.\nIf Immediate is set to false, the report is sent based on the health client settings from the HTTP Gateway. Therefore, it will be batched according to the HealthReportSendInterval configuration.\nThis is the recommended setting because it allows the health client to optimize health reporting messages to health store as well as health report processing.\nBy default, reports are not sent immediately."
+ },
+ "ExcludeHealthStatisticsOptionalQueryParam": {
+ "name": "ExcludeHealthStatistics",
+ "description": "Indicates whether the health statistics should be returned as part of the query result. False by default.\nThe statistics show the number of children entities in health state Ok, Warning, and Error.",
+ "in": "query",
+ "x-ms-parameter-location": "method",
+ "type": "boolean",
+ "required": false,
+ "default": false
+ },
+ "IncludeSystemApplicationHealthStatisticsOptionalQueryParam": {
+ "name": "IncludeSystemApplicationHealthStatistics",
+ "description": "Indicates whether the health statistics should include the fabric:/System application health statistics. False by default.\nIf IncludeSystemApplicationHealthStatistics is set to true, the health statistics include the entities that belong to the fabric:/System application.\nOtherwise, the query result includes health statistics only for user applications.\nThe health statistics must be included in the query result for this parameter to be applied.",
+ "in": "query",
+ "x-ms-parameter-location": "method",
+ "type": "boolean",
+ "required": false,
+ "default": false
+ },
+ "IncludeHealthStateOptionalQueryParam": {
+ "name": "IncludeHealthState",
+ "in": "query",
+ "x-ms-parameter-location": "method",
+ "type": "boolean",
+ "required": false,
+ "default": false,
+ "description": "Include the health state of an entity.\nIf this parameter is false or not specified, then the health state returned is \"Unknown\".\nWhen set to true, the query goes in parallel to the node and the health system service before the results are merged.\nAs a result, the query is more expensive and may take a longer time."
+ },
+ "BackupPolicyDescriptionRequiredBodyParam": {
+ "name": "BackupPolicyDescription",
+ "in": "body",
+ "required": true,
+ "x-ms-parameter-location": "method",
+ "description": "Describes the backup policy.",
+ "schema": {
+ "$ref": "#/definitions/BackupPolicyDescription"
+ }
+ },
+ "DisableBackupDescriptionOptionalBodyParam": {
+ "name": "DisableBackupDescription",
+ "in": "body",
+ "description": "Specifies the parameters to disable backup for any backup entity.",
+ "required": false,
+ "x-ms-parameter-location": "method",
+ "schema": {
+ "$ref": "#/definitions/DisableBackupDescription"
+ }
+ },
+ "BackupPolicyNameRequiredPathParam": {
+ "name": "backupPolicyName",
+ "in": "path",
+ "description": "The name of the backup policy.",
+ "required": true,
+ "x-ms-parameter-location": "method",
+ "type": "string"
+ },
+ "EnableBackupDescriptionRequiredBodyParam": {
+ "name": "EnableBackupDescription",
+ "in": "body",
+ "description": "Specifies the parameters for enabling backup.",
+ "required": true,
+ "x-ms-parameter-location": "method",
+ "schema": {
+ "$ref": "#/definitions/EnableBackupDescription"
+ }
+ },
+ "RestorePartitionDescriptionRequiredBodyParam": {
+ "name": "RestorePartitionDescription",
+ "in": "body",
+ "description": "Describes the parameters to restore the partition.",
+ "required": true,
+ "x-ms-parameter-location": "method",
+ "schema": {
+ "$ref": "#/definitions/RestorePartitionDescription"
+ }
+ },
+ "RestoreTimeoutOptionalQueryParam": {
+ "name": "RestoreTimeout",
+ "description": "Specifies the maximum amount of time to wait, in minutes, for the restore operation to complete. Post that, the operation returns back with timeout error. However, in certain corner cases it could be that the restore operation goes through even though it completes with timeout. In case of timeout error, its recommended to invoke this operation again with a greater timeout value. the default value for the same is 10 minutes.",
+ "in": "query",
+ "x-ms-parameter-location": "method",
+ "type": "integer",
+ "required": false,
+ "default": 10
+ },
+ "BackupPartitionDescriptionOptionalBodyParam": {
+ "name": "BackupPartitionDescription",
+ "in": "body",
+ "required": false,
+ "x-ms-parameter-location": "method",
+ "description": "Describes the parameters to backup the partition now. If not present, backup operation uses default parameters from the backup policy current associated with this partition.",
+ "schema": {
+ "$ref": "#/definitions/BackupPartitionDescription"
+ }
+ },
+ "BackupTimeoutOptionalQueryParam": {
+ "name": "BackupTimeout",
+ "in": "query",
+ "x-ms-parameter-location": "method",
+ "type": "integer",
+ "required": false,
+ "description": "Specifies the maximum amount of time, in minutes, to wait for the backup operation to complete. Post that, the operation completes with timeout error. However, in certain corner cases it could be that though the operation returns back timeout, the backup actually goes through. In case of timeout error, its recommended to invoke this operation again with a greater timeout value. The default value for the same is 10 minutes.",
+ "default": 10
+ },
+ "LatestOptionalQueryParam": {
+ "name": "Latest",
+ "in": "query",
+ "x-ms-parameter-location": "method",
+ "type": "boolean",
+ "description": "Specifies whether to get only the most recent backup available for a partition for the specified time range.",
+ "required": false,
+ "default": false
+ },
+ "StartDateTimeFilterOptionalQueryParam": {
+ "name": "StartDateTimeFilter",
+ "in": "query",
+ "x-ms-parameter-location": "method",
+ "type": "string",
+ "format": "date-time",
+ "required": false,
+ "description": "Specify the start date time from which to enumerate backups, in datetime format. The date time must be specified in ISO8601 format. This is an optional parameter. If not specified, all backups from the beginning are enumerated."
+ },
+ "EndDateTimeFilterOptionalQueryParam": {
+ "name": "EndDateTimeFilter",
+ "in": "query",
+ "x-ms-parameter-location": "method",
+ "type": "string",
+ "format": "date-time",
+ "required": false,
+ "description": "Specify the end date time till which to enumerate backups, in datetime format. The date time must be specified in ISO8601 format. This is an optional parameter. If not specified, enumeration is done till the most recent backup."
+ },
+ "GetBackupByStorageQueryDescriptionRequiredBodyParam": {
+ "name": "GetBackupByStorageQueryDescription",
+ "in": "body",
+ "required": true,
+ "x-ms-parameter-location": "method",
+ "description": "Describes the filters and backup storage details to be used for enumerating backups.",
+ "schema": {
+ "$ref": "#/definitions/GetBackupByStorageQueryDescription"
+ }
+ },
+ "RepairTaskApproveDescriptionRequiredBodyParam": {
+ "name": "RepairTaskApproveDescription",
+ "in": "body",
+ "description": "Describes the repair task to be approved.",
+ "required": true,
+ "x-ms-parameter-location": "method",
+ "schema": {
+ "$ref": "#/definitions/RepairTaskApproveDescription"
+ }
+ },
+ "RepairTaskCancelDescriptionRequiredBodyParam": {
+ "name": "RepairTaskCancelDescription",
+ "in": "body",
+ "description": "Describes the repair task to be cancelled.",
+ "required": true,
+ "x-ms-parameter-location": "method",
+ "schema": {
+ "$ref": "#/definitions/RepairTaskCancelDescription"
+ }
+ },
+ "RepairTaskDeleteDescriptionRequiredBodyParam": {
+ "name": "RepairTaskDeleteDescription",
+ "in": "body",
+ "description": "Describes the repair task to be deleted.",
+ "required": true,
+ "x-ms-parameter-location": "method",
+ "schema": {
+ "$ref": "#/definitions/RepairTaskDeleteDescription"
+ }
+ },
+ "RepairTaskExecutorFilterOptionalQueryParam": {
+ "name": "ExecutorFilter",
+ "description": "The name of the repair executor whose claimed tasks should be included in the list.",
+ "in": "query",
+ "x-ms-parameter-location": "method",
+ "type": "string",
+ "required": false
+ },
+ "RepairTaskIdFilterOptionalQueryParam": {
+ "name": "TaskIdFilter",
+ "description": "The repair task ID prefix to be matched.",
+ "in": "query",
+ "x-ms-parameter-location": "method",
+ "type": "string",
+ "required": false
+ },
+ "RepairTaskRequiredBodyParam": {
+ "name": "RepairTask",
+ "in": "body",
+ "description": "Describes the repair task to be created or updated.",
+ "required": true,
+ "x-ms-parameter-location": "method",
+ "schema": {
+ "$ref": "#/definitions/RepairTask"
+ }
+ },
+ "RepairTaskStateFilterOptionalQueryParam": {
+ "name": "StateFilter",
+ "description": "A bitwise-OR of the following values, specifying which task states should be included in the result list.\n\n- 1 - Created\n- 2 - Claimed\n- 4 - Preparing\n- 8 - Approved\n- 16 - Executing\n- 32 - Restoring\n- 64 - Completed",
+ "in": "query",
+ "x-ms-parameter-location": "method",
+ "type": "integer",
+ "required": false
+ },
+ "RepairTaskUpdateHealthPolicyDescriptionRequiredBodyParam": {
+ "name": "RepairTaskUpdateHealthPolicyDescription",
+ "in": "body",
+ "description": "Describes the repair task healthy policy to be updated.",
+ "x-ms-parameter-location": "method",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/RepairTaskUpdateHealthPolicyDescription"
+ }
+ },
+ "UploadSessionIdRequiredQueryParam": {
+ "name": "session-id",
+ "in": "query",
+ "x-ms-parameter-location": "method",
+ "type": "string",
+ "format": "uuid",
+ "required": true,
+ "description": "A GUID generated by the user for a file uploading. It identifies an image store upload session which keeps track of all file chunks until it is committed."
+ },
+ "UploadFileChunkContentRangeHeaderParam": {
+ "name": "Content-Range",
+ "in": "header",
+ "x-ms-parameter-location": "method",
+ "type": "string",
+ "required": true,
+ "description": "When uploading file chunks to the image store, the Content-Range header field need to be configured and sent with a request. The format should looks like \"bytes {First-Byte-Position}-{Last-Byte-Position}/{File-Length}\". For example, Content-Range:bytes 300-5000/20000 indicates that user is sending bytes 300 through 5,000 and the total file length is 20,000 bytes."
+ },
+ "ChaosScheduleRequiredBodyParam": {
+ "name": "ChaosSchedule",
+ "in": "body",
+ "description": "Describes the schedule used by Chaos.",
+ "required": true,
+ "x-ms-parameter-location": "method",
+ "schema": {
+ "$ref": "#/definitions/ChaosScheduleDescription"
+ }
+ },
+ "StartTimeUtcRequiredQueryParam": {
+ "name": "StartTimeUtc",
+ "in": "query",
+ "x-ms-parameter-location": "method",
+ "type": "string",
+ "required": true,
+ "description": "The start time of a lookup query in ISO UTC yyyy-MM-ddTHH:mm:ssZ."
+ },
+ "EndTimeUtcRequiredQueryParam": {
+ "name": "EndTimeUtc",
+ "in": "query",
+ "x-ms-parameter-location": "method",
+ "type": "string",
+ "required": true,
+ "description": "The end time of a lookup query in ISO UTC yyyy-MM-ddTHH:mm:ssZ."
+ },
+ "EventsTypesFilterOptionalQueryParam": {
+ "name": "EventsTypesFilter",
+ "in": "query",
+ "x-ms-parameter-location": "method",
+ "type": "string",
+ "required": false,
+ "description": "This is a comma separated string specifying the types of FabricEvents that should only be included in the response."
+ },
+ "ExcludeAnalysisEventsOptionalQueryParam": {
+ "name": "ExcludeAnalysisEvents",
+ "in": "query",
+ "x-ms-parameter-location": "method",
+ "type": "boolean",
+ "required": false,
+ "description": "This param disables the retrieval of AnalysisEvents if true is passed."
+ },
+ "SkipCorrelationLookupOptionalQueryParam": {
+ "name": "SkipCorrelationLookup",
+ "in": "query",
+ "x-ms-parameter-location": "method",
+ "type": "boolean",
+ "required": false,
+ "description": "This param disables the search of CorrelatedEvents information if true is passed. otherwise the CorrelationEvents get processed and HasCorrelatedEvents field in every FabricEvent gets populated."
+ },
+ "EventInstanceIdRequiredPathParam": {
+ "name": "eventInstanceId",
+ "in": "path",
+ "x-ms-parameter-location": "method",
+ "type": "string",
+ "required": true,
+ "description": "The EventInstanceId."
+ },
+ "PreviousOptionalQueryParam": {
+ "name": "Previous",
+ "in": "query",
+ "x-ms-parameter-location": "method",
+ "type": "boolean",
+ "description": "Specifies whether to get container logs from exited/dead containers of the code package instance.",
+ "required": false,
+ "default": false
+ },
+ "IgnoreConstraintsOptionalParam": {
+ "name": "IgnoreConstraints",
+ "in": "query",
+ "x-ms-parameter-location": "method",
+ "type": "boolean",
+ "required": false,
+ "default": false,
+ "description": "Ignore constraints when moving a replica. If this parameter is not specified, all constraints are honored."
+ },
+ "NodeNameOptionalParam": {
+ "name": "NodeName",
+ "in": "query",
+ "x-ms-parameter-location": "method",
+ "type": "string",
+ "required": false,
+ "description": "The name of the node."
+ },
+ "VerboseServicePlacementHealthReportingParam": {
+ "name": "Enabled",
+ "in": "query",
+ "x-ms-parameter-location": "method",
+ "type": "boolean",
+ "required": true,
+ "description": "The verbosity of service placement health reporting."
+ },
+ "NewNodeNameOptionalParam": {
+ "name": "NewNodeName",
+ "in": "query",
+ "x-ms-parameter-location": "method",
+ "type": "string",
+ "required": false,
+ "description": "The name of the target node for secondary replica move. If not specified, replica is moved to a random node."
+ },
+ "CurrentNodeNameRequiredParam": {
+ "name": "CurrentNodeName",
+ "in": "query",
+ "x-ms-parameter-location": "method",
+ "type": "string",
+ "required": true,
+ "description": "The name of the source node for secondary replica move."
+ },
+ "OnlyQueryPrimariesOptionalQueryParam": {
+ "name": "OnlyQueryPrimaries",
+ "description": "Indicates that unplaced replica information will be queries only for primary replicas.",
+ "in": "query",
+ "x-ms-parameter-location": "method",
+ "type": "boolean",
+ "required": false,
+ "default": false
+ },
+ "ForceConfigurationOverrideOptionalParam": {
+ "name": "Force",
+ "in": "query",
+ "x-ms-parameter-location": "method",
+ "type": "boolean",
+ "required": false,
+ "description": "Force adding configuration overrides on specified nodes."
+ },
+ "ConfigurationOverrideListRequiredParam": {
+ "name": "ConfigParameterOverrideList",
+ "in": "body",
+ "description": "Description for adding list of configuration overrides.",
+ "required": true,
+ "x-ms-parameter-location": "method",
+ "schema": {
+ "$ref": "#/definitions/ConfigParameterOverrideList"
+ }
+ },
+ "SecretResourceDescriptionRequiredBodyParam": {
+ "name": "secretResourceDescription",
+ "in": "body",
+ "description": "Description for creating a secret resource.",
+ "required": true,
+ "x-ms-parameter-location": "method",
+ "schema": {
+ "$ref": "#/definitions/SecretResourceDescription"
+ }
+ },
+ "SecretResourceNameRequiredPathParam": {
+ "name": "secretResourceName",
+ "in": "path",
+ "x-ms-parameter-location": "method",
+ "x-ms-skip-url-encoding": true,
+ "type": "string",
+ "required": true,
+ "description": "The name of the secret resource."
+ },
+ "SecretValueResourceDescriptionRequiredBodyParam": {
+ "name": "secretValueResourceDescription",
+ "in": "body",
+ "description": "Description for creating a value of a secret resource.",
+ "required": true,
+ "x-ms-parameter-location": "method",
+ "schema": {
+ "$ref": "#/definitions/SecretValueResourceDescription"
+ }
+ },
+ "SecretValueResourceNameRequiredPathParam": {
+ "name": "secretValueResourceName",
+ "in": "path",
+ "x-ms-parameter-location": "method",
+ "x-ms-skip-url-encoding": true,
+ "type": "string",
+ "required": true,
+ "description": "The name of the secret resource value which is typically the version identifier for the value."
+ },
+ "VolumeResourceDescriptionRequiredBodyParam": {
+ "name": "volumeResourceDescription",
+ "in": "body",
+ "description": "Description for creating a Volume resource.",
+ "required": true,
+ "x-ms-parameter-location": "method",
+ "schema": {
+ "$ref": "#/definitions/VolumeResourceDescription"
+ }
+ },
+ "VolumeResourceNameRequiredPathParam": {
+ "name": "volumeResourceName",
+ "in": "path",
+ "x-ms-parameter-location": "method",
+ "x-ms-skip-url-encoding": true,
+ "type": "string",
+ "required": true,
+ "description": "The identity of the volume."
+ },
+ "NetworkResourceDescriptionRequiredBodyParam": {
+ "name": "networkResourceDescription",
+ "in": "body",
+ "description": "Description for creating a Network resource.",
+ "required": true,
+ "x-ms-parameter-location": "method",
+ "schema": {
+ "$ref": "#/definitions/NetworkResourceDescription"
+ }
+ },
+ "NetworkResourceNameRequiredPathParam": {
+ "name": "networkResourceName",
+ "in": "path",
+ "x-ms-parameter-location": "method",
+ "x-ms-skip-url-encoding": true,
+ "type": "string",
+ "required": true,
+ "description": "The identity of the network."
+ },
+ "ApplicationResourceDescriptionRequiredBodyParam": {
+ "name": "applicationResourceDescription",
+ "in": "body",
+ "description": "Description for creating a Application resource.",
+ "required": true,
+ "x-ms-parameter-location": "method",
+ "schema": {
+ "$ref": "#/definitions/ApplicationResourceDescription"
+ }
+ },
+ "ApplicationResourceNameRequiredPathParam": {
+ "name": "applicationResourceName",
+ "in": "path",
+ "x-ms-parameter-location": "method",
+ "x-ms-skip-url-encoding": true,
+ "type": "string",
+ "required": true,
+ "description": "The identity of the application."
+ },
+ "ServiceResourceNameRequiredPathParam": {
+ "name": "serviceResourceName",
+ "in": "path",
+ "x-ms-parameter-location": "method",
+ "x-ms-skip-url-encoding": true,
+ "type": "string",
+ "required": true,
+ "description": "The identity of the service."
+ },
+ "ReplicaNameRequiredPathParam": {
+ "name": "replicaName",
+ "in": "path",
+ "x-ms-parameter-location": "method",
+ "x-ms-skip-url-encoding": true,
+ "type": "string",
+ "required": true,
+ "description": "Service Fabric replica name."
+ },
+ "GatewayResourceDescriptionRequiredBodyParam": {
+ "name": "gatewayResourceDescription",
+ "in": "body",
+ "description": "Description for creating a Gateway resource.",
+ "required": true,
+ "x-ms-parameter-location": "method",
+ "schema": {
+ "$ref": "#/definitions/GatewayResourceDescription"
+ }
+ },
+ "GatewayResourceNameRequiredPathParam": {
+ "name": "gatewayResourceName",
+ "in": "path",
+ "x-ms-parameter-location": "method",
+ "x-ms-skip-url-encoding": true,
+ "type": "string",
+ "required": true,
+ "description": "The identity of the gateway."
+ }
+ }
+}
diff --git a/specification/servicefabric/data-plane/readme.md b/specification/servicefabric/data-plane/readme.md
index 36eb6843dd17..719a8b671916 100644
--- a/specification/servicefabric/data-plane/readme.md
+++ b/specification/servicefabric/data-plane/readme.md
@@ -25,7 +25,7 @@ These are the global settings for the ServiceFabricClient API.
``` yaml
openapi-type: data-plane
-tag: '7.0'
+tag: '7.1'
```
### Suppression
@@ -115,6 +115,16 @@ input-file:
```
+### Tag: 7.1
+
+These settings apply only when `--tag=7.1` is specified on the command line.
+
+``` yaml $(tag) == '7.1'
+input-file:
+- Microsoft.ServiceFabric/stable/7.1/servicefabric.json
+
+```
+
---
# Code Generation
@@ -168,6 +178,7 @@ input-file:
- $(this-folder)/Microsoft.ServiceFabric/stable/6.4/servicefabric.json
- $(this-folder)/Microsoft.ServiceFabric/stable/6.5/servicefabric.json
- $(this-folder)/Microsoft.ServiceFabric/stable/7.0/servicefabric.json
+ - $(this-folder)/Microsoft.ServiceFabric/stable/7.1/servicefabric.json
```
diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2018-03-01-preview/examples/CreateOrUpdate.json b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2018-03-01-preview/examples/CreateOrUpdate.json
index 2446709ef47b..3a92226cd0a1 100644
--- a/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2018-03-01-preview/examples/CreateOrUpdate.json
+++ b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2018-03-01-preview/examples/CreateOrUpdate.json
@@ -20,6 +20,32 @@
"resourceName": "mySignalRService"
},
"responses": {
+ "200": {
+ "body": {
+ "sku": {
+ "name": "Standard_S1",
+ "tier": "Standard",
+ "size": "S1",
+ "capacity": 1
+ },
+ "properties": {
+ "provisioningState": "Succeeded",
+ "externalIP": "10.0.0.1",
+ "hostName": "myservice.service.signalr.net",
+ "publicPort": 443,
+ "serverPort": 443,
+ "version": "1.0-preview",
+ "hostNamePrefix": null
+ },
+ "location": "eastus",
+ "tags": {
+ "key1": "value1"
+ },
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService",
+ "name": "mySignalRService",
+ "type": "Microsoft.SignalRService/SignalR"
+ }
+ },
"201": {
"body": {
"sku": {
diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2018-03-01-preview/signalr.json b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2018-03-01-preview/signalr.json
index 0a661c94b9f3..d8c5408c9640 100644
--- a/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2018-03-01-preview/signalr.json
+++ b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2018-03-01-preview/signalr.json
@@ -308,6 +308,12 @@
}
],
"responses": {
+ "200": {
+ "description": "Success. The response describes a SignalR service.",
+ "schema": {
+ "$ref": "#/definitions/SignalRResource"
+ }
+ },
"201": {
"description": "Created. The response describes the new service and contains a Location header to query the operation result.",
"schema": {
diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/stable/2020-05-01/examples/Operations_List.json b/specification/signalr/resource-manager/Microsoft.SignalRService/stable/2020-05-01/examples/Operations_List.json
new file mode 100644
index 000000000000..d43346e00368
--- /dev/null
+++ b/specification/signalr/resource-manager/Microsoft.SignalRService/stable/2020-05-01/examples/Operations_List.json
@@ -0,0 +1,25 @@
+{
+ "parameters": {
+ "api-version": "2020-05-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "name": "Microsoft.SignalRService/SignalR/read",
+ "isDataAction": false,
+ "display": {
+ "provider": "Microsoft.SignalRService",
+ "resource": "SignalR",
+ "operation": "Manage SignalR (read-only)",
+ "description": "View the SignalR's settings and configurations in the management portal or through API"
+ },
+ "properties": {}
+ }
+ ],
+ "nextLink": "providers/Microsoft.SignalRService?$skipToken={opaqueString}"
+ }
+ }
+ }
+}
diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/stable/2020-05-01/examples/SignalRPrivateEndpointConnections_Delete.json b/specification/signalr/resource-manager/Microsoft.SignalRService/stable/2020-05-01/examples/SignalRPrivateEndpointConnections_Delete.json
new file mode 100644
index 000000000000..f9c6b18ec351
--- /dev/null
+++ b/specification/signalr/resource-manager/Microsoft.SignalRService/stable/2020-05-01/examples/SignalRPrivateEndpointConnections_Delete.json
@@ -0,0 +1,18 @@
+{
+ "parameters": {
+ "api-version": "2020-05-01",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "myResourceGroup",
+ "resourceName": "mySignalRService",
+ "privateEndpointConnectionName": "mySignalRService.1fa229cd-bf3f-47f0-8c49-afb36723997e"
+ },
+ "responses": {
+ "202": {
+ "headers": {
+ "Location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationResult...",
+ "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationStatus..."
+ }
+ },
+ "204": {}
+ }
+}
diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/stable/2020-05-01/examples/SignalRPrivateEndpointConnections_Get.json b/specification/signalr/resource-manager/Microsoft.SignalRService/stable/2020-05-01/examples/SignalRPrivateEndpointConnections_Get.json
new file mode 100644
index 000000000000..afdb580d1bba
--- /dev/null
+++ b/specification/signalr/resource-manager/Microsoft.SignalRService/stable/2020-05-01/examples/SignalRPrivateEndpointConnections_Get.json
@@ -0,0 +1,29 @@
+{
+ "parameters": {
+ "api-version": "2020-05-01",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "myResourceGroup",
+ "resourceName": "mySignalRService",
+ "privateEndpointConnectionName": "mySignalRService.1fa229cd-bf3f-47f0-8c49-afb36723997e"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "properties": {
+ "provisioningState": "Succeeded",
+ "privateEndpoint": {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint"
+ },
+ "privateLinkServiceConnectionState": {
+ "status": "Approved",
+ "description": null,
+ "actionsRequired": "None"
+ }
+ },
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService/privateEndpointConnections/mySignalRService.1fa229cd-bf3f-47f0-8c49-afb36723997e",
+ "name": "mySignalRService.1fa229cd-bf3f-47f0-8c49-afb36723997e",
+ "type": "Microsoft.SignalRService/SignalR/privateEndpointConnections"
+ }
+ }
+ }
+}
diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/stable/2020-05-01/examples/SignalRPrivateEndpointConnections_Update.json b/specification/signalr/resource-manager/Microsoft.SignalRService/stable/2020-05-01/examples/SignalRPrivateEndpointConnections_Update.json
new file mode 100644
index 000000000000..1fa8b532aac5
--- /dev/null
+++ b/specification/signalr/resource-manager/Microsoft.SignalRService/stable/2020-05-01/examples/SignalRPrivateEndpointConnections_Update.json
@@ -0,0 +1,45 @@
+{
+ "parameters": {
+ "parameters": {
+ "properties": {
+ "privateEndpoint": {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint"
+ },
+ "privateLinkServiceConnectionState": {
+ "status": "Approved",
+ "description": null,
+ "actionsRequired": "None"
+ }
+ }
+ },
+ "api-version": "2020-05-01",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "myResourceGroup",
+ "resourceName": "mySignalRService",
+ "privateEndpointConnectionName": "mySignalRService.1fa229cd-bf3f-47f0-8c49-afb36723997e"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "properties": {
+ "provisioningState": "Succeeded",
+ "privateEndpoint": {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint"
+ },
+ "privateLinkServiceConnectionState": {
+ "status": "Approved",
+ "description": null,
+ "actionsRequired": "None"
+ }
+ },
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService/privateEndpointConnections/mySignalRService.1fa229cd-bf3f-47f0-8c49-afb36723997e",
+ "name": "mySignalRService.1fa229cd-bf3f-47f0-8c49-afb36723997e",
+ "type": "Microsoft.SignalRService/SignalR/privateEndpointConnections"
+ },
+ "headers": {
+ "Location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationResult...",
+ "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationStatus..."
+ }
+ }
+ }
+}
diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/stable/2020-05-01/examples/SignalRPrivateLinkResources_List.json b/specification/signalr/resource-manager/Microsoft.SignalRService/stable/2020-05-01/examples/SignalRPrivateLinkResources_List.json
new file mode 100644
index 000000000000..90120de37bab
--- /dev/null
+++ b/specification/signalr/resource-manager/Microsoft.SignalRService/stable/2020-05-01/examples/SignalRPrivateLinkResources_List.json
@@ -0,0 +1,31 @@
+{
+ "parameters": {
+ "api-version": "2020-05-01",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "myResourceGroup",
+ "resourceName": "mySignalRService"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "properties": {
+ "groupId": "signalr",
+ "requiredMembers": [
+ "signalr"
+ ],
+ "requiredZoneNames": [
+ "privatelink.service.signalr.net"
+ ]
+ },
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/privateLinkResources",
+ "name": "signalr",
+ "type": "privateLinkResources"
+ }
+ ],
+ "nextLink": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToMoreResults..."
+ }
+ }
+ }
+}
diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/stable/2020-05-01/examples/SignalR_CheckNameAvailability.json b/specification/signalr/resource-manager/Microsoft.SignalRService/stable/2020-05-01/examples/SignalR_CheckNameAvailability.json
new file mode 100644
index 000000000000..a330b6b9ca3f
--- /dev/null
+++ b/specification/signalr/resource-manager/Microsoft.SignalRService/stable/2020-05-01/examples/SignalR_CheckNameAvailability.json
@@ -0,0 +1,20 @@
+{
+ "parameters": {
+ "location": "eastus",
+ "parameters": {
+ "type": "Microsoft.SignalRService/SignalR",
+ "name": "my-signalr-service"
+ },
+ "api-version": "2020-05-01",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "nameAvailable": false,
+ "reason": "AlreadyExists",
+ "message": "The leaf is already used by other people"
+ }
+ }
+ }
+}
diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/stable/2020-05-01/examples/SignalR_CreateOrUpdate.json b/specification/signalr/resource-manager/Microsoft.SignalRService/stable/2020-05-01/examples/SignalR_CreateOrUpdate.json
new file mode 100644
index 000000000000..3eb1a78ba38b
--- /dev/null
+++ b/specification/signalr/resource-manager/Microsoft.SignalRService/stable/2020-05-01/examples/SignalR_CreateOrUpdate.json
@@ -0,0 +1,278 @@
+{
+ "parameters": {
+ "parameters": {
+ "sku": {
+ "name": "Standard_S1",
+ "tier": "Standard",
+ "capacity": 1
+ },
+ "properties": {
+ "hostNamePrefix": null,
+ "features": [
+ {
+ "flag": "ServiceMode",
+ "value": "Serverless",
+ "properties": {}
+ },
+ {
+ "flag": "EnableConnectivityLogs",
+ "value": "True",
+ "properties": {}
+ },
+ {
+ "flag": "EnableMessagingLogs",
+ "value": "False",
+ "properties": {}
+ }
+ ],
+ "cors": {
+ "allowedOrigins": [
+ "https://foo.com",
+ "https://bar.com"
+ ]
+ },
+ "upstream": {
+ "templates": [
+ {
+ "hubPattern": "*",
+ "eventPattern": "connect,disconnect",
+ "categoryPattern": "*",
+ "urlTemplate": "https://example.com/chat/api/connect"
+ }
+ ]
+ },
+ "networkACLs": {
+ "defaultAction": "Deny",
+ "publicNetwork": {
+ "allow": [
+ "ClientConnection"
+ ],
+ "deny": null
+ },
+ "privateEndpoints": [
+ {
+ "name": "mySignalRService.1fa229cd-bf3f-47f0-8c49-afb36723997e",
+ "allow": [
+ "ServerConnection"
+ ],
+ "deny": null
+ }
+ ]
+ }
+ },
+ "kind": "SignalR",
+ "location": "eastus",
+ "tags": {
+ "key1": "value1"
+ }
+ },
+ "api-version": "2020-05-01",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "myResourceGroup",
+ "resourceName": "mySignalRService"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "sku": {
+ "name": "Standard_S1",
+ "tier": "Standard",
+ "size": "S1",
+ "capacity": 1
+ },
+ "properties": {
+ "provisioningState": "Succeeded",
+ "externalIP": "10.0.0.1",
+ "hostName": "mysignalrservice.service.signalr.net",
+ "publicPort": 443,
+ "serverPort": 443,
+ "version": "1.0",
+ "privateEndpointConnections": [
+ {
+ "properties": {
+ "provisioningState": "Succeeded",
+ "privateEndpoint": {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint"
+ },
+ "privateLinkServiceConnectionState": {
+ "status": "Approved",
+ "description": null,
+ "actionsRequired": "None"
+ }
+ },
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService/privateEndpointConnections/mySignalRService.1fa229cd-bf3f-47f0-8c49-afb36723997e",
+ "name": "mySignalRService.1fa229cd-bf3f-47f0-8c49-afb36723997e",
+ "type": "Microsoft.SignalRService/SignalR/privateEndpointConnections"
+ }
+ ],
+ "hostNamePrefix": "mysignalrservice",
+ "features": [
+ {
+ "flag": "ServiceMode",
+ "value": "Serverless",
+ "properties": {}
+ },
+ {
+ "flag": "EnableConnectivityLogs",
+ "value": "True",
+ "properties": {}
+ },
+ {
+ "flag": "EnableMessagingLogs",
+ "value": "False",
+ "properties": {}
+ }
+ ],
+ "cors": {
+ "allowedOrigins": [
+ "https://foo.com",
+ "https://bar.com"
+ ]
+ },
+ "upstream": {
+ "templates": [
+ {
+ "hubPattern": null,
+ "eventPattern": null,
+ "categoryPattern": null,
+ "urlTemplate": "http://foo.com"
+ }
+ ]
+ },
+ "networkACLs": {
+ "defaultAction": "Deny",
+ "publicNetwork": {
+ "allow": [
+ "ClientConnection"
+ ],
+ "deny": null
+ },
+ "privateEndpoints": [
+ {
+ "name": "mySignalRService.1fa229cd-bf3f-47f0-8c49-afb36723997e",
+ "allow": [
+ "ServerConnection"
+ ],
+ "deny": null
+ }
+ ]
+ }
+ },
+ "kind": "SignalR",
+ "location": "eastus",
+ "tags": {
+ "key1": "value1"
+ },
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService",
+ "name": "mySignalRService",
+ "type": "Microsoft.SignalRService/SignalR"
+ }
+ },
+ "201": {
+ "body": {
+ "sku": {
+ "name": "Standard_S1",
+ "tier": "Standard",
+ "size": "S1",
+ "capacity": 1
+ },
+ "properties": {
+ "provisioningState": "Succeeded",
+ "externalIP": "10.0.0.1",
+ "hostName": "mysignalrservice.service.signalr.net",
+ "publicPort": 443,
+ "serverPort": 443,
+ "version": "1.0",
+ "privateEndpointConnections": [
+ {
+ "properties": {
+ "provisioningState": "Succeeded",
+ "privateEndpoint": {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint"
+ },
+ "privateLinkServiceConnectionState": {
+ "status": "Approved",
+ "description": null,
+ "actionsRequired": "None"
+ }
+ },
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService/privateEndpointConnections/mySignalRService.1fa229cd-bf3f-47f0-8c49-afb36723997e",
+ "name": "mySignalRService.1fa229cd-bf3f-47f0-8c49-afb36723997e",
+ "type": "Microsoft.SignalRService/SignalR/privateEndpointConnections"
+ }
+ ],
+ "hostNamePrefix": "mysignalrservice",
+ "features": [
+ {
+ "flag": "ServiceMode",
+ "value": "Serverless",
+ "properties": {}
+ },
+ {
+ "flag": "EnableConnectivityLogs",
+ "value": "True",
+ "properties": {}
+ },
+ {
+ "flag": "EnableMessagingLogs",
+ "value": "False",
+ "properties": {}
+ }
+ ],
+ "cors": {
+ "allowedOrigins": [
+ "https://foo.com",
+ "https://bar.com"
+ ]
+ },
+ "upstream": {
+ "templates": [
+ {
+ "hubPattern": null,
+ "eventPattern": null,
+ "categoryPattern": null,
+ "urlTemplate": "http://foo.com"
+ }
+ ]
+ },
+ "networkACLs": {
+ "defaultAction": "Deny",
+ "publicNetwork": {
+ "allow": [
+ "ClientConnection"
+ ],
+ "deny": null
+ },
+ "privateEndpoints": [
+ {
+ "name": "mySignalRService.1fa229cd-bf3f-47f0-8c49-afb36723997e",
+ "allow": [
+ "ServerConnection"
+ ],
+ "deny": null
+ }
+ ]
+ }
+ },
+ "kind": "SignalR",
+ "location": "eastus",
+ "tags": {
+ "key1": "value1"
+ },
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService",
+ "name": "mySignalRService",
+ "type": "Microsoft.SignalRService/SignalR"
+ },
+ "headers": {
+ "Location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationResult...",
+ "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationStatus..."
+ }
+ },
+ "202": {
+ "headers": {
+ "Location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationResult...",
+ "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationStatus..."
+ }
+ }
+ }
+}
diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/stable/2020-05-01/examples/SignalR_Delete.json b/specification/signalr/resource-manager/Microsoft.SignalRService/stable/2020-05-01/examples/SignalR_Delete.json
new file mode 100644
index 000000000000..d9e03852aebb
--- /dev/null
+++ b/specification/signalr/resource-manager/Microsoft.SignalRService/stable/2020-05-01/examples/SignalR_Delete.json
@@ -0,0 +1,17 @@
+{
+ "parameters": {
+ "api-version": "2020-05-01",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "myResourceGroup",
+ "resourceName": "mySignalRService"
+ },
+ "responses": {
+ "202": {
+ "headers": {
+ "Location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationResult...",
+ "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationStatus..."
+ }
+ },
+ "204": {}
+ }
+}
diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/stable/2020-05-01/examples/SignalR_Get.json b/specification/signalr/resource-manager/Microsoft.SignalRService/stable/2020-05-01/examples/SignalR_Get.json
new file mode 100644
index 000000000000..2c7bdf651621
--- /dev/null
+++ b/specification/signalr/resource-manager/Microsoft.SignalRService/stable/2020-05-01/examples/SignalR_Get.json
@@ -0,0 +1,106 @@
+{
+ "parameters": {
+ "api-version": "2020-05-01",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "myResourceGroup",
+ "resourceName": "mySignalRService"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "sku": {
+ "name": "Standard_S1",
+ "tier": "Standard",
+ "size": "S1",
+ "capacity": 1
+ },
+ "properties": {
+ "provisioningState": "Succeeded",
+ "externalIP": "10.0.0.1",
+ "hostName": "mysignalrservice.service.signalr.net",
+ "publicPort": 443,
+ "serverPort": 443,
+ "version": "1.0",
+ "privateEndpointConnections": [
+ {
+ "properties": {
+ "provisioningState": "Succeeded",
+ "privateEndpoint": {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint"
+ },
+ "privateLinkServiceConnectionState": {
+ "status": "Approved",
+ "description": null,
+ "actionsRequired": "None"
+ }
+ },
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService/privateEndpointConnections/mySignalRService.1fa229cd-bf3f-47f0-8c49-afb36723997e",
+ "name": "mySignalRService.1fa229cd-bf3f-47f0-8c49-afb36723997e",
+ "type": "Microsoft.SignalRService/SignalR/privateEndpointConnections"
+ }
+ ],
+ "hostNamePrefix": "mysignalrservice",
+ "features": [
+ {
+ "flag": "ServiceMode",
+ "value": "Serverless",
+ "properties": {}
+ },
+ {
+ "flag": "EnableConnectivityLogs",
+ "value": "True",
+ "properties": {}
+ },
+ {
+ "flag": "EnableMessagingLogs",
+ "value": "False",
+ "properties": {}
+ }
+ ],
+ "cors": {
+ "allowedOrigins": [
+ "https://foo.com",
+ "https://bar.com"
+ ]
+ },
+ "upstream": {
+ "templates": [
+ {
+ "hubPattern": null,
+ "eventPattern": null,
+ "categoryPattern": null,
+ "urlTemplate": "http://foo.com"
+ }
+ ]
+ },
+ "networkACLs": {
+ "defaultAction": "Deny",
+ "publicNetwork": {
+ "allow": [
+ "ClientConnection"
+ ],
+ "deny": null
+ },
+ "privateEndpoints": [
+ {
+ "name": "mySignalRService.1fa229cd-bf3f-47f0-8c49-afb36723997e",
+ "allow": [
+ "ServerConnection"
+ ],
+ "deny": null
+ }
+ ]
+ }
+ },
+ "kind": "SignalR",
+ "location": "eastus",
+ "tags": {
+ "key1": "value1"
+ },
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService",
+ "name": "mySignalRService",
+ "type": "Microsoft.SignalRService/SignalR"
+ }
+ }
+ }
+}
diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/stable/2020-05-01/examples/SignalR_ListByResourceGroup.json b/specification/signalr/resource-manager/Microsoft.SignalRService/stable/2020-05-01/examples/SignalR_ListByResourceGroup.json
new file mode 100644
index 000000000000..f862bb2cfa40
--- /dev/null
+++ b/specification/signalr/resource-manager/Microsoft.SignalRService/stable/2020-05-01/examples/SignalR_ListByResourceGroup.json
@@ -0,0 +1,109 @@
+{
+ "parameters": {
+ "api-version": "2020-05-01",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "myResourceGroup"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "sku": {
+ "name": "Standard_S1",
+ "tier": "Standard",
+ "size": "S1",
+ "capacity": 1
+ },
+ "properties": {
+ "provisioningState": "Succeeded",
+ "externalIP": "10.0.0.1",
+ "hostName": "mysignalrservice.service.signalr.net",
+ "publicPort": 443,
+ "serverPort": 443,
+ "version": "1.0",
+ "privateEndpointConnections": [
+ {
+ "properties": {
+ "provisioningState": "Succeeded",
+ "privateEndpoint": {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint"
+ },
+ "privateLinkServiceConnectionState": {
+ "status": "Approved",
+ "description": null,
+ "actionsRequired": "None"
+ }
+ },
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService/privateEndpointConnections/mySignalRService.1fa229cd-bf3f-47f0-8c49-afb36723997e",
+ "name": "mySignalRService.1fa229cd-bf3f-47f0-8c49-afb36723997e",
+ "type": "Microsoft.SignalRService/SignalR/privateEndpointConnections"
+ }
+ ],
+ "hostNamePrefix": "mysignalrservice",
+ "features": [
+ {
+ "flag": "ServiceMode",
+ "value": "Serverless",
+ "properties": {}
+ },
+ {
+ "flag": "EnableConnectivityLogs",
+ "value": "True",
+ "properties": {}
+ },
+ {
+ "flag": "EnableMessagingLogs",
+ "value": "False",
+ "properties": {}
+ }
+ ],
+ "cors": {
+ "allowedOrigins": [
+ "https://foo.com",
+ "https://bar.com"
+ ]
+ },
+ "upstream": {
+ "templates": [
+ {
+ "hubPattern": null,
+ "eventPattern": null,
+ "categoryPattern": null,
+ "urlTemplate": "http://foo.com"
+ }
+ ]
+ },
+ "networkACLs": {
+ "defaultAction": "Deny",
+ "publicNetwork": {
+ "allow": [
+ "ClientConnection"
+ ],
+ "deny": null
+ },
+ "privateEndpoints": [
+ {
+ "name": "mySignalRService.1fa229cd-bf3f-47f0-8c49-afb36723997e",
+ "allow": [
+ "ServerConnection"
+ ],
+ "deny": null
+ }
+ ]
+ }
+ },
+ "kind": "SignalR",
+ "location": "eastus",
+ "tags": {
+ "key1": "value1"
+ },
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService",
+ "name": "mySignalRService",
+ "type": "Microsoft.SignalRService/SignalR"
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/stable/2020-05-01/examples/SignalR_ListBySubscription.json b/specification/signalr/resource-manager/Microsoft.SignalRService/stable/2020-05-01/examples/SignalR_ListBySubscription.json
new file mode 100644
index 000000000000..1ed24a8269e7
--- /dev/null
+++ b/specification/signalr/resource-manager/Microsoft.SignalRService/stable/2020-05-01/examples/SignalR_ListBySubscription.json
@@ -0,0 +1,108 @@
+{
+ "parameters": {
+ "api-version": "2020-05-01",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "sku": {
+ "name": "Standard_S1",
+ "tier": "Standard",
+ "size": "S1",
+ "capacity": 1
+ },
+ "properties": {
+ "provisioningState": "Succeeded",
+ "externalIP": "10.0.0.1",
+ "hostName": "mysignalrservice.service.signalr.net",
+ "publicPort": 443,
+ "serverPort": 443,
+ "version": "1.0",
+ "privateEndpointConnections": [
+ {
+ "properties": {
+ "provisioningState": "Succeeded",
+ "privateEndpoint": {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint"
+ },
+ "privateLinkServiceConnectionState": {
+ "status": "Approved",
+ "description": null,
+ "actionsRequired": "None"
+ }
+ },
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService/privateEndpointConnections/mySignalRService.1fa229cd-bf3f-47f0-8c49-afb36723997e",
+ "name": "mySignalRService.1fa229cd-bf3f-47f0-8c49-afb36723997e",
+ "type": "Microsoft.SignalRService/SignalR/privateEndpointConnections"
+ }
+ ],
+ "hostNamePrefix": "mysignalrservice",
+ "features": [
+ {
+ "flag": "ServiceMode",
+ "value": "Serverless",
+ "properties": {}
+ },
+ {
+ "flag": "EnableConnectivityLogs",
+ "value": "True",
+ "properties": {}
+ },
+ {
+ "flag": "EnableMessagingLogs",
+ "value": "False",
+ "properties": {}
+ }
+ ],
+ "cors": {
+ "allowedOrigins": [
+ "https://foo.com",
+ "https://bar.com"
+ ]
+ },
+ "upstream": {
+ "templates": [
+ {
+ "hubPattern": null,
+ "eventPattern": null,
+ "categoryPattern": null,
+ "urlTemplate": "http://foo.com"
+ }
+ ]
+ },
+ "networkACLs": {
+ "defaultAction": "Deny",
+ "publicNetwork": {
+ "allow": [
+ "ClientConnection"
+ ],
+ "deny": null
+ },
+ "privateEndpoints": [
+ {
+ "name": "mySignalRService.1fa229cd-bf3f-47f0-8c49-afb36723997e",
+ "allow": [
+ "ServerConnection"
+ ],
+ "deny": null
+ }
+ ]
+ }
+ },
+ "kind": "SignalR",
+ "location": "eastus",
+ "tags": {
+ "key1": "value1"
+ },
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService",
+ "name": "mySignalRService",
+ "type": "Microsoft.SignalRService/SignalR"
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/stable/2020-05-01/examples/SignalR_ListKeys.json b/specification/signalr/resource-manager/Microsoft.SignalRService/stable/2020-05-01/examples/SignalR_ListKeys.json
new file mode 100644
index 000000000000..8932231e33c4
--- /dev/null
+++ b/specification/signalr/resource-manager/Microsoft.SignalRService/stable/2020-05-01/examples/SignalR_ListKeys.json
@@ -0,0 +1,18 @@
+{
+ "parameters": {
+ "api-version": "2020-05-01",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "myResourceGroup",
+ "resourceName": "mySignalRService"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "primaryKey": "primaryAccessKey",
+ "secondaryKey": "secondaryAccessKey",
+ "primaryConnectionString": "Endpoint=https://yourServiceName.service.signalr.net;AccessKey=primaryAccessKey;Version=1.0",
+ "secondaryConnectionString": "Endpoint=https://yourServiceName.service.signalr.net;AccessKey=secondaryAccessKey;Version=1.0"
+ }
+ }
+ }
+}
diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/stable/2020-05-01/examples/SignalR_RegenerateKey.json b/specification/signalr/resource-manager/Microsoft.SignalRService/stable/2020-05-01/examples/SignalR_RegenerateKey.json
new file mode 100644
index 000000000000..0fb7ffb871bb
--- /dev/null
+++ b/specification/signalr/resource-manager/Microsoft.SignalRService/stable/2020-05-01/examples/SignalR_RegenerateKey.json
@@ -0,0 +1,25 @@
+{
+ "parameters": {
+ "parameters": {
+ "keyType": "Primary"
+ },
+ "api-version": "2020-05-01",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "myResourceGroup",
+ "resourceName": "mySignalRService"
+ },
+ "responses": {
+ "201": {
+ "body": {
+ "primaryKey": "primaryAccessKey",
+ "secondaryKey": "secondaryAccessKey",
+ "primaryConnectionString": "Endpoint=https://yourServiceName.service.signalr.net;AccessKey=primaryAccessKey;Version=1.0;",
+ "secondaryConnectionString": "Endpoint=https://yourServiceName.service.signalr.net;AccessKey=secondaryAccessKey;Version=1.0;"
+ },
+ "headers": {
+ "Location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationResult...",
+ "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationStatus..."
+ }
+ }
+ }
+}
diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/stable/2020-05-01/examples/SignalR_Restart.json b/specification/signalr/resource-manager/Microsoft.SignalRService/stable/2020-05-01/examples/SignalR_Restart.json
new file mode 100644
index 000000000000..d9e03852aebb
--- /dev/null
+++ b/specification/signalr/resource-manager/Microsoft.SignalRService/stable/2020-05-01/examples/SignalR_Restart.json
@@ -0,0 +1,17 @@
+{
+ "parameters": {
+ "api-version": "2020-05-01",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "myResourceGroup",
+ "resourceName": "mySignalRService"
+ },
+ "responses": {
+ "202": {
+ "headers": {
+ "Location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationResult...",
+ "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationStatus..."
+ }
+ },
+ "204": {}
+ }
+}
diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/stable/2020-05-01/examples/SignalR_Update.json b/specification/signalr/resource-manager/Microsoft.SignalRService/stable/2020-05-01/examples/SignalR_Update.json
new file mode 100644
index 000000000000..29a1ef2fd73f
--- /dev/null
+++ b/specification/signalr/resource-manager/Microsoft.SignalRService/stable/2020-05-01/examples/SignalR_Update.json
@@ -0,0 +1,178 @@
+{
+ "parameters": {
+ "parameters": {
+ "sku": {
+ "name": "Standard_S1",
+ "tier": "Standard",
+ "capacity": 1
+ },
+ "properties": {
+ "hostNamePrefix": null,
+ "features": [
+ {
+ "flag": "ServiceMode",
+ "value": "Serverless",
+ "properties": {}
+ },
+ {
+ "flag": "EnableConnectivityLogs",
+ "value": "True",
+ "properties": {}
+ },
+ {
+ "flag": "EnableMessagingLogs",
+ "value": "False",
+ "properties": {}
+ }
+ ],
+ "cors": {
+ "allowedOrigins": [
+ "https://foo.com",
+ "https://bar.com"
+ ]
+ },
+ "upstream": {
+ "templates": [
+ {
+ "hubPattern": "*",
+ "eventPattern": "connect,disconnect",
+ "categoryPattern": "*",
+ "urlTemplate": "https://example.com/chat/api/connect"
+ }
+ ]
+ },
+ "networkACLs": {
+ "defaultAction": "Deny",
+ "publicNetwork": {
+ "allow": [
+ "ClientConnection"
+ ],
+ "deny": null
+ },
+ "privateEndpoints": [
+ {
+ "name": "mySignalRService.1fa229cd-bf3f-47f0-8c49-afb36723997e",
+ "allow": [
+ "ServerConnection"
+ ],
+ "deny": null
+ }
+ ]
+ }
+ },
+ "kind": "SignalR",
+ "location": "eastus",
+ "tags": {
+ "key1": "value1"
+ }
+ },
+ "api-version": "2020-05-01",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "myResourceGroup",
+ "resourceName": "mySignalRService"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "sku": {
+ "name": "Standard_S1",
+ "tier": "Standard",
+ "size": "S1",
+ "capacity": 1
+ },
+ "properties": {
+ "provisioningState": "Succeeded",
+ "externalIP": "10.0.0.1",
+ "hostName": "mysignalrservice.service.signalr.net",
+ "publicPort": 443,
+ "serverPort": 443,
+ "version": "1.0",
+ "privateEndpointConnections": [
+ {
+ "properties": {
+ "provisioningState": "Succeeded",
+ "privateEndpoint": {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint"
+ },
+ "privateLinkServiceConnectionState": {
+ "status": "Approved",
+ "description": null,
+ "actionsRequired": "None"
+ }
+ },
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService/privateEndpointConnections/mySignalRService.1fa229cd-bf3f-47f0-8c49-afb36723997e",
+ "name": "mySignalRService.1fa229cd-bf3f-47f0-8c49-afb36723997e",
+ "type": "Microsoft.SignalRService/SignalR/privateEndpointConnections"
+ }
+ ],
+ "hostNamePrefix": "mysignalrservice",
+ "features": [
+ {
+ "flag": "ServiceMode",
+ "value": "Serverless",
+ "properties": {}
+ },
+ {
+ "flag": "EnableConnectivityLogs",
+ "value": "True",
+ "properties": {}
+ },
+ {
+ "flag": "EnableMessagingLogs",
+ "value": "False",
+ "properties": {}
+ }
+ ],
+ "cors": {
+ "allowedOrigins": [
+ "https://foo.com",
+ "https://bar.com"
+ ]
+ },
+ "upstream": {
+ "templates": [
+ {
+ "hubPattern": null,
+ "eventPattern": null,
+ "categoryPattern": null,
+ "urlTemplate": "http://foo.com"
+ }
+ ]
+ },
+ "networkACLs": {
+ "defaultAction": "Deny",
+ "publicNetwork": {
+ "allow": [
+ "ClientConnection"
+ ],
+ "deny": null
+ },
+ "privateEndpoints": [
+ {
+ "name": "mySignalRService.1fa229cd-bf3f-47f0-8c49-afb36723997e",
+ "allow": [
+ "ServerConnection"
+ ],
+ "deny": null
+ }
+ ]
+ }
+ },
+ "kind": "SignalR",
+ "location": "eastus",
+ "tags": {
+ "key1": "value1"
+ },
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService",
+ "name": "mySignalRService",
+ "type": "Microsoft.SignalRService/SignalR"
+ }
+ },
+ "202": {
+ "headers": {
+ "Location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationResult...",
+ "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationStatus..."
+ }
+ }
+ }
+}
diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/stable/2020-05-01/examples/Usages_List.json b/specification/signalr/resource-manager/Microsoft.SignalRService/stable/2020-05-01/examples/Usages_List.json
new file mode 100644
index 000000000000..ae2279860df6
--- /dev/null
+++ b/specification/signalr/resource-manager/Microsoft.SignalRService/stable/2020-05-01/examples/Usages_List.json
@@ -0,0 +1,36 @@
+{
+ "parameters": {
+ "location": "eastus",
+ "api-version": "2020-05-01",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.SignalRService/locations/eastus/usages/Usage1",
+ "currentValue": 0,
+ "limit": 100,
+ "name": {
+ "value": "Usage1",
+ "localizedValue": "Usage1"
+ },
+ "unit": "Count"
+ },
+ {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.SignalRService/locations/eastus/usages/Usage2",
+ "currentValue": 0,
+ "limit": 100,
+ "name": {
+ "value": "Usage2",
+ "localizedValue": "Usage2"
+ },
+ "unit": "Count"
+ }
+ ],
+ "nextLink": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToMoreResults..."
+ }
+ }
+ }
+}
diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/stable/2020-05-01/signalr.json b/specification/signalr/resource-manager/Microsoft.SignalRService/stable/2020-05-01/signalr.json
new file mode 100644
index 000000000000..844d2f52801c
--- /dev/null
+++ b/specification/signalr/resource-manager/Microsoft.SignalRService/stable/2020-05-01/signalr.json
@@ -0,0 +1,1741 @@
+{
+ "swagger": "2.0",
+ "info": {
+ "version": "2020-05-01",
+ "title": "SignalRManagementClient",
+ "description": "REST API for Azure SignalR Service"
+ },
+ "host": "management.azure.com",
+ "schemes": [
+ "https"
+ ],
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "paths": {
+ "/providers/Microsoft.SignalRService/operations": {
+ "get": {
+ "tags": [
+ "SignalR"
+ ],
+ "description": "Lists all of the available REST API operations of the Microsoft.SignalRService provider.",
+ "operationId": "Operations_List",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success. The response describes the list of operations.",
+ "schema": {
+ "$ref": "#/definitions/OperationList"
+ }
+ },
+ "default": {
+ "description": "An unexpected error occurred during the operation.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-examples": {
+ "Operations_List": {
+ "$ref": "./examples/Operations_List.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/providers/Microsoft.SignalRService/locations/{location}/checkNameAvailability": {
+ "post": {
+ "tags": [
+ "SignalR"
+ ],
+ "description": "Checks that the SignalR name is valid and is not already in use.",
+ "operationId": "SignalR_CheckNameAvailability",
+ "parameters": [
+ {
+ "name": "location",
+ "in": "path",
+ "description": "the region",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "description": "Parameters supplied to the operation.",
+ "required": false,
+ "schema": {
+ "$ref": "#/definitions/NameAvailabilityParameters"
+ }
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success. The response describes the name availability.",
+ "schema": {
+ "$ref": "#/definitions/NameAvailability"
+ }
+ },
+ "default": {
+ "description": "An unexpected error occurred during the operation.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "SignalR_CheckNameAvailability": {
+ "$ref": "./examples/SignalR_CheckNameAvailability.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/providers/Microsoft.SignalRService/signalR": {
+ "get": {
+ "tags": [
+ "SignalR"
+ ],
+ "description": "Handles requests to list all resources in a subscription.",
+ "operationId": "SignalR_ListBySubscription",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success. The response describes the list of SignalR services in the subscription.",
+ "schema": {
+ "$ref": "#/definitions/SignalRResourceList"
+ }
+ },
+ "default": {
+ "description": "An unexpected error occurred during the operation.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-examples": {
+ "SignalR_ListBySubscription": {
+ "$ref": "./examples/SignalR_ListBySubscription.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR": {
+ "get": {
+ "tags": [
+ "SignalR"
+ ],
+ "description": "Handles requests to list all resources in a resource group.",
+ "operationId": "SignalR_ListByResourceGroup",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/ResourceGroupParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success. The response describes the list of SignalR services in a resourceGroup.",
+ "schema": {
+ "$ref": "#/definitions/SignalRResourceList"
+ }
+ },
+ "default": {
+ "description": "An unexpected error occurred during the operation.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-examples": {
+ "SignalR_ListByResourceGroup": {
+ "$ref": "./examples/SignalR_ListByResourceGroup.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/privateEndpointConnections/{privateEndpointConnectionName}": {
+ "get": {
+ "tags": [
+ "SignalR"
+ ],
+ "description": "Get the specified private endpoint connection associated with a SignalR resource.",
+ "operationId": "SignalRPrivateEndpointConnections_Get",
+ "parameters": [
+ {
+ "name": "privateEndpointConnectionName",
+ "in": "path",
+ "description": "The name of the private endpoint connection associated with the SignalR resource.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/ResourceGroupParameter"
+ },
+ {
+ "$ref": "#/parameters/SignalRServiceName"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success. The response describes a list of private link resources.",
+ "schema": {
+ "$ref": "#/definitions/PrivateEndpointConnection"
+ }
+ },
+ "default": {
+ "description": "An unexpected error occurred during the operation.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "SignalRPrivateEndpointConnections_Get": {
+ "$ref": "./examples/SignalRPrivateEndpointConnections_Get.json"
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "SignalR"
+ ],
+ "description": "Update the state of specified private endpoint connection associated with a SignalR resource.",
+ "operationId": "SignalRPrivateEndpointConnections_Update",
+ "parameters": [
+ {
+ "name": "privateEndpointConnectionName",
+ "in": "path",
+ "description": "The name of the private endpoint connection associated with the SignalR resource.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "description": "The resource of private endpoint and its properties.",
+ "required": false,
+ "schema": {
+ "$ref": "#/definitions/PrivateEndpointConnection"
+ }
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/ResourceGroupParameter"
+ },
+ {
+ "$ref": "#/parameters/SignalRServiceName"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK. The response indicates the private endpoint connection is updated successfully.",
+ "schema": {
+ "$ref": "#/definitions/PrivateEndpointConnection"
+ }
+ },
+ "default": {
+ "description": "An unexpected error occurred during the operation.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "SignalRPrivateEndpointConnections_Update": {
+ "$ref": "./examples/SignalRPrivateEndpointConnections_Update.json"
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "SignalR"
+ ],
+ "description": "Delete the specified private endpoint connection associated with a SignalR resource.",
+ "operationId": "SignalRPrivateEndpointConnections_Delete",
+ "parameters": [
+ {
+ "name": "privateEndpointConnectionName",
+ "in": "path",
+ "description": "The name of the private endpoint connection associated with the SignalR resource.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/ResourceGroupParameter"
+ },
+ {
+ "$ref": "#/parameters/SignalRServiceName"
+ }
+ ],
+ "responses": {
+ "202": {
+ "description": "Success"
+ },
+ "204": {
+ "description": "Success. The response indicates the private endpoint connection is already deleted."
+ },
+ "default": {
+ "description": "An unexpected error occurred during the operation.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "SignalRPrivateEndpointConnections_Delete": {
+ "$ref": "./examples/SignalRPrivateEndpointConnections_Delete.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/privateLinkResources": {
+ "get": {
+ "tags": [
+ "SignalR"
+ ],
+ "description": "Get the private link resources that need to be created for a SignalR resource.",
+ "operationId": "SignalRPrivateLinkResources_List",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/ResourceGroupParameter"
+ },
+ {
+ "$ref": "#/parameters/SignalRServiceName"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success. The response describes a list of private link resources.",
+ "schema": {
+ "$ref": "#/definitions/PrivateLinkResourceList"
+ }
+ },
+ "default": {
+ "description": "An unexpected error occurred during the operation.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-examples": {
+ "SignalRPrivateLinkResources_List": {
+ "$ref": "./examples/SignalRPrivateLinkResources_List.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/listKeys": {
+ "post": {
+ "tags": [
+ "SignalR"
+ ],
+ "description": "Get the access keys of the SignalR resource.",
+ "operationId": "SignalR_ListKeys",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/ResourceGroupParameter"
+ },
+ {
+ "$ref": "#/parameters/SignalRServiceName"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success. The response describes SignalR service access keys.",
+ "schema": {
+ "$ref": "#/definitions/SignalRKeys"
+ }
+ },
+ "default": {
+ "description": "An unexpected error occurred during the operation.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "SignalR_ListKeys": {
+ "$ref": "./examples/SignalR_ListKeys.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/regenerateKey": {
+ "post": {
+ "tags": [
+ "SignalR"
+ ],
+ "description": "Regenerate SignalR service access key. PrimaryKey and SecondaryKey cannot be regenerated at the same time.",
+ "operationId": "SignalR_RegenerateKey",
+ "parameters": [
+ {
+ "name": "parameters",
+ "in": "body",
+ "description": "Parameter that describes the Regenerate Key Operation.",
+ "required": false,
+ "schema": {
+ "$ref": "#/definitions/RegenerateKeyParameters"
+ }
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/ResourceGroupParameter"
+ },
+ {
+ "$ref": "#/parameters/SignalRServiceName"
+ }
+ ],
+ "responses": {
+ "201": {
+ "description": "Created and an async operation is executing in background to make the new key to take effect. The response contains new keys and a Location header to query the async operation result.",
+ "schema": {
+ "$ref": "#/definitions/SignalRKeys"
+ }
+ },
+ "default": {
+ "description": "An unexpected error occurred during the operation.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-long-running-operation-options": {
+ "final-state-via": "azure-async-operation"
+ },
+ "x-ms-examples": {
+ "SignalR_RegenerateKey": {
+ "$ref": "./examples/SignalR_RegenerateKey.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}": {
+ "get": {
+ "tags": [
+ "SignalR"
+ ],
+ "description": "Get the SignalR service and its properties.",
+ "operationId": "SignalR_Get",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/ResourceGroupParameter"
+ },
+ {
+ "$ref": "#/parameters/SignalRServiceName"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success. The response describes the corresponding SignalR service.",
+ "schema": {
+ "$ref": "#/definitions/SignalRResource"
+ }
+ },
+ "default": {
+ "description": "An unexpected error occurred during the operation.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "SignalR_Get": {
+ "$ref": "./examples/SignalR_Get.json"
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "SignalR"
+ ],
+ "description": "Create a new SignalR service and update an exiting SignalR service.",
+ "operationId": "SignalR_CreateOrUpdate",
+ "parameters": [
+ {
+ "name": "parameters",
+ "in": "body",
+ "description": "Parameters for the create or update operation",
+ "required": false,
+ "schema": {
+ "$ref": "#/definitions/SignalRResource"
+ }
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/ResourceGroupParameter"
+ },
+ {
+ "$ref": "#/parameters/SignalRServiceName"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success. The response describes a SignalR service.",
+ "schema": {
+ "$ref": "#/definitions/SignalRResource"
+ }
+ },
+ "201": {
+ "description": "Created. The response describes the new service and contains a Location header to query the operation result.",
+ "schema": {
+ "$ref": "#/definitions/SignalRResource"
+ }
+ },
+ "202": {
+ "description": "Accepted. The response indicates the exiting SignalR service is now updating and contains a Location header to query the operation result.."
+ },
+ "default": {
+ "description": "An unexpected error occurred during the operation.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "SignalR_CreateOrUpdate": {
+ "$ref": "./examples/SignalR_CreateOrUpdate.json"
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "SignalR"
+ ],
+ "description": "Operation to delete a SignalR service.",
+ "operationId": "SignalR_Delete",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/ResourceGroupParameter"
+ },
+ {
+ "$ref": "#/parameters/SignalRServiceName"
+ }
+ ],
+ "responses": {
+ "202": {
+ "description": "Accepted. The response indicates the delete operation is performed in the background."
+ },
+ "204": {
+ "description": "Success. The response indicates the resource is already deleted."
+ },
+ "default": {
+ "description": "An unexpected error occurred during the operation.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "SignalR_Delete": {
+ "$ref": "./examples/SignalR_Delete.json"
+ }
+ }
+ },
+ "patch": {
+ "tags": [
+ "SignalR"
+ ],
+ "description": "Operation to update an exiting SignalR service.",
+ "operationId": "SignalR_Update",
+ "parameters": [
+ {
+ "name": "parameters",
+ "in": "body",
+ "description": "Parameters for the update operation",
+ "required": false,
+ "schema": {
+ "$ref": "#/definitions/SignalRResource"
+ }
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/ResourceGroupParameter"
+ },
+ {
+ "$ref": "#/parameters/SignalRServiceName"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success. The response describes a SignalR service.",
+ "schema": {
+ "$ref": "#/definitions/SignalRResource"
+ }
+ },
+ "202": {
+ "description": "Accepted. The response indicates the exiting SignalR service is now updating and contains a Location header to query the operation result.."
+ },
+ "default": {
+ "description": "An unexpected error occurred during the operation.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "SignalR_Update": {
+ "$ref": "./examples/SignalR_Update.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/restart": {
+ "post": {
+ "tags": [
+ "SignalR"
+ ],
+ "description": "Operation to restart a SignalR service.",
+ "operationId": "SignalR_Restart",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/ResourceGroupParameter"
+ },
+ {
+ "$ref": "#/parameters/SignalRServiceName"
+ }
+ ],
+ "responses": {
+ "202": {
+ "description": "Accepted. The response indicates the restart operation is performed in the background."
+ },
+ "204": {
+ "description": "Success. The response indicates the operation is successful and no content will be returned."
+ },
+ "default": {
+ "description": "An unexpected error occurred during the operation.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-long-running-operation-options": {
+ "final-state-via": "azure-async-operation"
+ },
+ "x-ms-examples": {
+ "SignalR_Restart": {
+ "$ref": "./examples/SignalR_Restart.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/providers/Microsoft.SignalRService/locations/{location}/usages": {
+ "get": {
+ "tags": [
+ "SignalR"
+ ],
+ "description": "List usage quotas for Azure SignalR service by location.",
+ "operationId": "Usages_List",
+ "parameters": [
+ {
+ "name": "location",
+ "in": "path",
+ "description": "the location like \"eastus\"",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success. The response describe the usage quotas of a subscription in specified region.",
+ "schema": {
+ "$ref": "#/definitions/SignalRUsageList"
+ }
+ },
+ "default": {
+ "description": "An unexpected error occurred during the operation.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-examples": {
+ "Usages_List": {
+ "$ref": "./examples/Usages_List.json"
+ }
+ }
+ }
+ }
+ },
+ "definitions": {
+ "OperationList": {
+ "description": "Result of the request to list REST API operations. It contains a list of operations.",
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "List of operations supported by the resource provider.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/Operation"
+ }
+ },
+ "nextLink": {
+ "description": "The URL the client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use.",
+ "type": "string"
+ }
+ }
+ },
+ "Operation": {
+ "description": "REST API operation supported by SignalR resource provider.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "Name of the operation with format: {provider}/{resource}/{operation}",
+ "type": "string"
+ },
+ "isDataAction": {
+ "description": "If the operation is a data action. (for data plane rbac)",
+ "type": "boolean"
+ },
+ "display": {
+ "$ref": "#/definitions/OperationDisplay",
+ "description": "The object that describes the operation."
+ },
+ "origin": {
+ "description": "Optional. The intended executor of the operation; governs the display of the operation in the RBAC UX and the audit logs UX.",
+ "type": "string"
+ },
+ "properties": {
+ "$ref": "#/definitions/OperationProperties",
+ "description": "Extra properties for the operation.",
+ "x-ms-client-flatten": false
+ }
+ }
+ },
+ "OperationDisplay": {
+ "description": "The object that describes a operation.",
+ "type": "object",
+ "properties": {
+ "provider": {
+ "description": "Friendly name of the resource provider",
+ "type": "string"
+ },
+ "resource": {
+ "description": "Resource type on which the operation is performed.",
+ "type": "string"
+ },
+ "operation": {
+ "description": "The localized friendly name for the operation.",
+ "type": "string"
+ },
+ "description": {
+ "description": "The localized friendly description for the operation",
+ "type": "string"
+ }
+ }
+ },
+ "OperationProperties": {
+ "description": "Extra Operation properties.",
+ "type": "object",
+ "properties": {
+ "serviceSpecification": {
+ "$ref": "#/definitions/ServiceSpecification",
+ "description": "The service specifications."
+ }
+ }
+ },
+ "ServiceSpecification": {
+ "description": "An object that describes a specification.",
+ "type": "object",
+ "properties": {
+ "metricSpecifications": {
+ "description": "Specifications of the Metrics for Azure Monitoring.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/MetricSpecification"
+ }
+ },
+ "logSpecifications": {
+ "description": "Specifications of the Logs for Azure Monitoring.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/LogSpecification"
+ }
+ }
+ }
+ },
+ "MetricSpecification": {
+ "description": "Specifications of the Metrics for Azure Monitoring.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "Name of the metric.",
+ "type": "string"
+ },
+ "displayName": {
+ "description": "Localized friendly display name of the metric.",
+ "type": "string"
+ },
+ "displayDescription": {
+ "description": "Localized friendly description of the metric.",
+ "type": "string"
+ },
+ "unit": {
+ "description": "The unit that makes sense for the metric.",
+ "type": "string"
+ },
+ "aggregationType": {
+ "description": "Only provide one value for this field. Valid values: Average, Minimum, Maximum, Total, Count.",
+ "type": "string"
+ },
+ "fillGapWithZero": {
+ "description": "Optional. If set to true, then zero will be returned for time duration where no metric is emitted/published. \r\nEx. a metric that returns the number of times a particular error code was emitted. The error code may not appear \r\noften, instead of the RP publishing 0, Shoebox can auto fill in 0s for time periods where nothing was emitted.",
+ "type": "string"
+ },
+ "category": {
+ "description": "The name of the metric category that the metric belongs to. A metric can only belong to a single category.",
+ "type": "string"
+ },
+ "dimensions": {
+ "description": "The dimensions of the metrics.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/Dimension"
+ }
+ }
+ }
+ },
+ "LogSpecification": {
+ "description": "Specifications of the Logs for Azure Monitoring.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "Name of the log.",
+ "type": "string"
+ },
+ "displayName": {
+ "description": "Localized friendly display name of the log.",
+ "type": "string"
+ }
+ }
+ },
+ "Dimension": {
+ "description": "Specifications of the Dimension of metrics.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "The public facing name of the dimension.",
+ "type": "string"
+ },
+ "displayName": {
+ "description": "Localized friendly display name of the dimension.",
+ "type": "string"
+ },
+ "internalName": {
+ "description": "Name of the dimension as it appears in MDM.",
+ "type": "string"
+ },
+ "toBeExportedForShoebox": {
+ "description": "A Boolean flag indicating whether this dimension should be included for the shoebox export scenario.",
+ "type": "boolean"
+ }
+ }
+ },
+ "ErrorResponse": {
+ "description": "Contains information about an API error.",
+ "type": "object",
+ "properties": {
+ "error": {
+ "$ref": "#/definitions/ErrorResponseBody",
+ "description": "Describes a particular API error with an error code and a message."
+ }
+ }
+ },
+ "ErrorResponseBody": {
+ "description": "Describes a particular API error with an error code and a message.",
+ "required": [
+ "code",
+ "message"
+ ],
+ "type": "object",
+ "properties": {
+ "code": {
+ "description": "An error code that describes the error condition more precisely than an HTTP status code. \r\nCan be used to programmatically handle specific error cases.",
+ "type": "string"
+ },
+ "message": {
+ "description": "A message that describes the error in detail and provides debugging information.",
+ "type": "string"
+ },
+ "target": {
+ "description": "The target of the particular error (for example, the name of the property in error).",
+ "type": "string"
+ },
+ "details": {
+ "description": "Contains nested errors that are related to this error.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ErrorResponseBody"
+ }
+ }
+ }
+ },
+ "NameAvailabilityParameters": {
+ "description": "Data POST-ed to the nameAvailability action",
+ "required": [
+ "type",
+ "name"
+ ],
+ "type": "object",
+ "properties": {
+ "type": {
+ "description": "The resource type. Should be always \"Microsoft.SignalRService/SignalR\".",
+ "type": "string"
+ },
+ "name": {
+ "description": "The SignalR service name to validate. e.g.\"my-signalR-name-here\"",
+ "type": "string"
+ }
+ }
+ },
+ "NameAvailability": {
+ "description": "Result of the request to check name availability. It contains a flag and possible reason of failure.",
+ "type": "object",
+ "properties": {
+ "nameAvailable": {
+ "description": "Indicates whether the name is available or not.",
+ "type": "boolean"
+ },
+ "reason": {
+ "description": "The reason of the availability. Required if name is not available.",
+ "type": "string"
+ },
+ "message": {
+ "description": "The message of the operation.",
+ "type": "string"
+ }
+ }
+ },
+ "SignalRResourceList": {
+ "description": "Object that includes an array of SignalR services and a possible link for next set.",
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "List of SignalR services",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/SignalRResource"
+ }
+ },
+ "nextLink": {
+ "description": "The URL the client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use.",
+ "type": "string"
+ }
+ }
+ },
+ "SignalRResource": {
+ "description": "A class represent a SignalR service resource.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/TrackedResource"
+ }
+ ],
+ "properties": {
+ "sku": {
+ "$ref": "#/definitions/ResourceSku",
+ "description": "The billing information of the resource.(e.g. Free, Standard)"
+ },
+ "properties": {
+ "$ref": "#/definitions/SignalRProperties",
+ "description": "Settings used to provision or configure the resource",
+ "x-ms-client-flatten": true
+ },
+ "kind": {
+ "$ref": "#/definitions/ServiceKind",
+ "description": "The kind of the service - e.g. \"SignalR\", or \"RawWebSockets\" for \"Microsoft.SignalRService/SignalR\"",
+ "x-ms-mutability": [
+ "read",
+ "create"
+ ]
+ }
+ }
+ },
+ "ServiceKind": {
+ "description": "The kind of the service - e.g. \"SignalR\", or \"RawWebSockets\" for \"Microsoft.SignalRService/SignalR\"",
+ "enum": [
+ "SignalR",
+ "RawWebSockets"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "ServiceKind",
+ "modelAsString": true
+ }
+ },
+ "TrackedResource": {
+ "description": "The resource model definition for a ARM tracked top level resource.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/Resource"
+ }
+ ],
+ "properties": {
+ "location": {
+ "description": "The GEO location of the SignalR service. e.g. West US | East US | North Central US | South Central US.",
+ "type": "string",
+ "x-ms-mutability": [
+ "read",
+ "create"
+ ]
+ },
+ "tags": {
+ "description": "Tags of the service which is a list of key value pairs that describe the resource.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "Resource": {
+ "description": "The core properties of ARM resources.",
+ "type": "object",
+ "properties": {
+ "id": {
+ "description": "Fully qualified resource Id for the resource.",
+ "type": "string",
+ "readOnly": true
+ },
+ "name": {
+ "description": "The name of the resource.",
+ "type": "string",
+ "readOnly": true
+ },
+ "type": {
+ "description": "The type of the resource - e.g. \"Microsoft.SignalRService/SignalR\"",
+ "type": "string",
+ "readOnly": true
+ }
+ },
+ "x-ms-azure-resource": true
+ },
+ "ResourceSku": {
+ "description": "The billing information of the SignalR resource.",
+ "required": [
+ "name"
+ ],
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "The name of the SKU. Required.\r\n\r\nAllowed values: Standard_S1, Free_F1",
+ "type": "string"
+ },
+ "tier": {
+ "$ref": "#/definitions/SignalRSkuTier",
+ "description": "Optional tier of this particular SKU. 'Standard' or 'Free'. \r\n\r\n`Basic` is deprecated, use `Standard` instead."
+ },
+ "size": {
+ "description": "Optional string. For future use.",
+ "type": "string"
+ },
+ "family": {
+ "description": "Optional string. For future use.",
+ "type": "string"
+ },
+ "capacity": {
+ "format": "int32",
+ "description": "Optional, integer. The unit count of SignalR resource. 1 by default.\r\n\r\nIf present, following values are allowed:\r\n Free: 1\r\n Standard: 1,2,5,10,20,50,100",
+ "type": "integer"
+ }
+ }
+ },
+ "SignalRSkuTier": {
+ "description": "Optional tier of this particular SKU. 'Standard' or 'Free'. \r\n\r\n`Basic` is deprecated, use `Standard` instead.",
+ "enum": [
+ "Free",
+ "Basic",
+ "Standard",
+ "Premium"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "SignalRSkuTier",
+ "modelAsString": true
+ }
+ },
+ "SignalRProperties": {
+ "description": "A class that describes the properties of the SignalR service that should contain more read-only properties than AzSignalR.Models.SignalRCreateOrUpdateProperties",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/SignalRCreateOrUpdateProperties"
+ }
+ ],
+ "properties": {
+ "provisioningState": {
+ "$ref": "#/definitions/ProvisioningState",
+ "description": "Provisioning state of the resource.",
+ "readOnly": true
+ },
+ "externalIP": {
+ "description": "The publicly accessible IP of the SignalR service.",
+ "type": "string",
+ "readOnly": true
+ },
+ "hostName": {
+ "description": "FQDN of the SignalR service instance. Format: xxx.service.signalr.net",
+ "type": "string",
+ "readOnly": true
+ },
+ "publicPort": {
+ "format": "int32",
+ "description": "The publicly accessible port of the SignalR service which is designed for browser/client side usage.",
+ "type": "integer",
+ "readOnly": true
+ },
+ "serverPort": {
+ "format": "int32",
+ "description": "The publicly accessible port of the SignalR service which is designed for customer server side usage.",
+ "type": "integer",
+ "readOnly": true
+ },
+ "version": {
+ "description": "Version of the SignalR resource. Probably you need the same or higher version of client SDKs.",
+ "type": "string",
+ "readOnly": true
+ },
+ "privateEndpointConnections": {
+ "description": "Private endpoint connections to the SignalR resource.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/PrivateEndpointConnection"
+ },
+ "readOnly": true
+ }
+ }
+ },
+ "ProvisioningState": {
+ "description": "Provisioning state of the resource.",
+ "enum": [
+ "Unknown",
+ "Succeeded",
+ "Failed",
+ "Canceled",
+ "Running",
+ "Creating",
+ "Updating",
+ "Deleting",
+ "Moving"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "ProvisioningState",
+ "modelAsString": true
+ }
+ },
+ "SignalRCreateOrUpdateProperties": {
+ "description": "Settings used to provision or configure the resource.",
+ "type": "object",
+ "properties": {
+ "hostNamePrefix": {
+ "description": "Prefix for the hostName of the SignalR service. Retained for future use.\r\nThe hostname will be of format: <hostNamePrefix>.service.signalr.net.",
+ "type": "string"
+ },
+ "features": {
+ "description": "List of SignalR featureFlags. e.g. ServiceMode.\r\n\r\nFeatureFlags that are not included in the parameters for the update operation will not be modified.\r\nAnd the response will only include featureFlags that are explicitly set. \r\nWhen a featureFlag is not explicitly set, SignalR service will use its globally default value. \r\nBut keep in mind, the default value doesn't mean \"false\". It varies in terms of different FeatureFlags.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/SignalRFeature"
+ }
+ },
+ "cors": {
+ "$ref": "#/definitions/SignalRCorsSettings",
+ "description": "Cross-Origin Resource Sharing (CORS) settings."
+ },
+ "upstream": {
+ "$ref": "#/definitions/ServerlessUpstreamSettings",
+ "description": "Upstream settings when the Azure SignalR is in server-less mode."
+ },
+ "networkACLs": {
+ "$ref": "#/definitions/SignalRNetworkACLs",
+ "description": "Network ACLs"
+ }
+ }
+ },
+ "SignalRFeature": {
+ "description": "Feature of a SignalR resource, which controls the SignalR runtime behavior.",
+ "required": [
+ "flag",
+ "value"
+ ],
+ "type": "object",
+ "properties": {
+ "flag": {
+ "$ref": "#/definitions/FeatureFlags",
+ "description": "FeatureFlags is the supported features of Azure SignalR service.\r\n- ServiceMode: Flag for backend server for SignalR service. Values allowed: \"Default\": have your own backend server; \"Serverless\": your application doesn't have a backend server; \"Classic\": for backward compatibility. Support both Default and Serverless mode but not recommended; \"PredefinedOnly\": for future use.\r\n- EnableConnectivityLogs: \"true\"/\"false\", to enable/disable the connectivity log category respectively."
+ },
+ "value": {
+ "description": "Value of the feature flag. See Azure SignalR service document https://docs.microsoft.com/azure/azure-signalr/ for allowed values.",
+ "maxLength": 128,
+ "minLength": 1,
+ "type": "string"
+ },
+ "properties": {
+ "description": "Optional properties related to this feature.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "FeatureFlags": {
+ "description": "FeatureFlags is the supported features of Azure SignalR service.\r\n- ServiceMode: Flag for backend server for SignalR service. Values allowed: \"Default\": have your own backend server; \"Serverless\": your application doesn't have a backend server; \"Classic\": for backward compatibility. Support both Default and Serverless mode but not recommended; \"PredefinedOnly\": for future use.\r\n- EnableConnectivityLogs: \"true\"/\"false\", to enable/disable the connectivity log category respectively.",
+ "enum": [
+ "ServiceMode",
+ "EnableConnectivityLogs",
+ "EnableMessagingLogs"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "FeatureFlags",
+ "modelAsString": true
+ }
+ },
+ "SignalRCorsSettings": {
+ "description": "Cross-Origin Resource Sharing (CORS) settings.",
+ "type": "object",
+ "properties": {
+ "allowedOrigins": {
+ "description": "Gets or sets the list of origins that should be allowed to make cross-origin calls (for example: http://example.com:12345). Use \"*\" to allow all. If omitted, allow all by default.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "ServerlessUpstreamSettings": {
+ "description": "The settings for the Upstream when the Azure SignalR is in server-less mode.",
+ "type": "object",
+ "properties": {
+ "templates": {
+ "description": "Gets or sets the list of Upstream URL templates. Order matters, and the first matching template takes effects.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/UpstreamTemplate"
+ }
+ }
+ }
+ },
+ "SignalRNetworkACLs": {
+ "description": "Network ACLs for SignalR",
+ "type": "object",
+ "properties": {
+ "defaultAction": {
+ "$ref": "#/definitions/ACLAction",
+ "description": "Default action when no other rule matches"
+ },
+ "publicNetwork": {
+ "$ref": "#/definitions/NetworkACL",
+ "description": "ACL for requests from public network"
+ },
+ "privateEndpoints": {
+ "description": "ACLs for requests from private endpoints",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/PrivateEndpointACL"
+ }
+ }
+ }
+ },
+ "ACLAction": {
+ "description": "Default action when no other rule matches",
+ "enum": [
+ "Allow",
+ "Deny"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "ACLAction",
+ "modelAsString": true
+ }
+ },
+ "UpstreamTemplate": {
+ "description": "Upstream template item settings. It defines the Upstream URL of the incoming requests.\r\nThe template defines the pattern of the event, the hub or the category of the incoming request that matches current URL template.",
+ "required": [
+ "urlTemplate"
+ ],
+ "type": "object",
+ "properties": {
+ "hubPattern": {
+ "description": "Gets or sets the matching pattern for hub names. If not set, it matches any hub.\r\nThere are 3 kind of patterns supported:\r\n 1. \"*\", it to matches any hub name\r\n 2. Combine multiple hubs with \",\", for example \"hub1,hub2\", it matches \"hub1\" and \"hub2\"\r\n 3. The single hub name, for example, \"hub1\", it matches \"hub1\"",
+ "type": "string"
+ },
+ "eventPattern": {
+ "description": "Gets or sets the matching pattern for event names. If not set, it matches any event.\r\nThere are 3 kind of patterns supported:\r\n 1. \"*\", it to matches any event name\r\n 2. Combine multiple events with \",\", for example \"connect,disconnect\", it matches event \"connect\" and \"disconnect\"\r\n 3. The single event name, for example, \"connect\", it matches \"connect\"",
+ "type": "string"
+ },
+ "categoryPattern": {
+ "description": "Gets or sets the matching pattern for category names. If not set, it matches any category.\r\nThere are 3 kind of patterns supported:\r\n 1. \"*\", it to matches any category name\r\n 2. Combine multiple categories with \",\", for example \"connections,messages\", it matches category \"connections\" and \"messages\"\r\n 3. The single category name, for example, \"connections\", it matches the category \"connections\"",
+ "type": "string"
+ },
+ "urlTemplate": {
+ "description": "Gets or sets the Upstream URL template. You can use 3 predefined parameters {hub}, {category} {event} inside the template, the value of the Upstream URL is dynamically calculated when the client request comes in.\r\nFor example, if the urlTemplate is `http://example.com/{hub}/api/{event}`, with a client request from hub `chat` connects, it will first POST to this URL: `http://example.com/chat/api/connect`.",
+ "type": "string"
+ }
+ }
+ },
+ "NetworkACL": {
+ "description": "Network ACL",
+ "type": "object",
+ "properties": {
+ "allow": {
+ "description": "Allowed request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/SignalRRequestType"
+ }
+ },
+ "deny": {
+ "description": "Denied request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/SignalRRequestType"
+ }
+ }
+ }
+ },
+ "SignalRRequestType": {
+ "description": "Allowed request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI.",
+ "enum": [
+ "ClientConnection",
+ "ServerConnection",
+ "RESTAPI"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "SignalRRequestType",
+ "modelAsString": true
+ }
+ },
+ "PrivateEndpointACL": {
+ "description": "ACL for a private endpoint",
+ "required": [
+ "name"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/NetworkACL"
+ }
+ ],
+ "properties": {
+ "name": {
+ "description": "Name of the private endpoint connection",
+ "type": "string"
+ }
+ }
+ },
+ "PrivateEndpointConnection": {
+ "description": "A private endpoint connection to SignalR resource",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ProxyResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/PrivateEndpointConnectionProperties",
+ "description": "Properties of the private endpoint connection",
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "ProxyResource": {
+ "description": "The resource model definition for a ARM proxy resource. It will have everything other than required location and tags",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/Resource"
+ }
+ ],
+ "properties": {}
+ },
+ "PrivateEndpointConnectionProperties": {
+ "description": "Private endpoint connection properties",
+ "type": "object",
+ "properties": {
+ "provisioningState": {
+ "$ref": "#/definitions/ProvisioningState",
+ "description": "Provisioning state of the private endpoint connection",
+ "readOnly": true
+ },
+ "privateEndpoint": {
+ "$ref": "#/definitions/PrivateEndpoint",
+ "description": "Private endpoint associated with the private endpoint connection"
+ },
+ "privateLinkServiceConnectionState": {
+ "$ref": "#/definitions/PrivateLinkServiceConnectionState",
+ "description": "Connection state"
+ }
+ }
+ },
+ "PrivateEndpoint": {
+ "description": "Private endpoint",
+ "type": "object",
+ "properties": {
+ "id": {
+ "description": "Full qualified Id of the private endpoint",
+ "type": "string"
+ }
+ }
+ },
+ "PrivateLinkServiceConnectionState": {
+ "description": "Connection state of the private endpoint connection",
+ "type": "object",
+ "properties": {
+ "status": {
+ "$ref": "#/definitions/PrivateLinkServiceConnectionStatus",
+ "description": "Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service."
+ },
+ "description": {
+ "description": "The reason for approval/rejection of the connection.",
+ "type": "string"
+ },
+ "actionsRequired": {
+ "description": "A message indicating if changes on the service provider require any updates on the consumer.",
+ "type": "string"
+ }
+ }
+ },
+ "PrivateLinkServiceConnectionStatus": {
+ "description": "Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.",
+ "enum": [
+ "Pending",
+ "Approved",
+ "Rejected",
+ "Disconnected"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "PrivateLinkServiceConnectionStatus",
+ "modelAsString": true
+ }
+ },
+ "PrivateLinkResourceList": {
+ "description": "Contains a list of AzSignalR.Models.Response.PrivateLink.PrivateLinkResource and a possible link to query more results",
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "List of PrivateLinkResource",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/PrivateLinkResource"
+ }
+ },
+ "nextLink": {
+ "description": "The URL the client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use.",
+ "type": "string"
+ }
+ }
+ },
+ "PrivateLinkResource": {
+ "description": "Private link resource",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ProxyResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/PrivateLinkResourceProperties",
+ "description": "Properties of a private link resource",
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "PrivateLinkResourceProperties": {
+ "description": "Private link resource properties",
+ "type": "object",
+ "properties": {
+ "groupId": {
+ "description": "Group Id of the private link resource",
+ "type": "string"
+ },
+ "requiredMembers": {
+ "description": "Required members of the private link resource",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "requiredZoneNames": {
+ "description": "Required private DNS zone names",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "SignalRKeys": {
+ "description": "A class represents the access keys of SignalR service.",
+ "type": "object",
+ "properties": {
+ "primaryKey": {
+ "description": "The primary access key.",
+ "type": "string"
+ },
+ "secondaryKey": {
+ "description": "The secondary access key.",
+ "type": "string"
+ },
+ "primaryConnectionString": {
+ "description": "SignalR connection string constructed via the primaryKey",
+ "type": "string"
+ },
+ "secondaryConnectionString": {
+ "description": "SignalR connection string constructed via the secondaryKey",
+ "type": "string"
+ }
+ }
+ },
+ "RegenerateKeyParameters": {
+ "description": "Parameters describes the request to regenerate access keys",
+ "type": "object",
+ "properties": {
+ "keyType": {
+ "$ref": "#/definitions/KeyType",
+ "description": "The keyType to regenerate. Must be either 'primary' or 'secondary'(case-insensitive)."
+ }
+ }
+ },
+ "KeyType": {
+ "description": "The keyType to regenerate. Must be either 'primary' or 'secondary'(case-insensitive).",
+ "enum": [
+ "Primary",
+ "Secondary"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "KeyType",
+ "modelAsString": true
+ }
+ },
+ "SignalRUsageList": {
+ "description": "Object that includes an array of SignalR resource usages and a possible link for next set.",
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "List of SignalR usages",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/SignalRUsage"
+ }
+ },
+ "nextLink": {
+ "description": "The URL the client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use.",
+ "type": "string"
+ }
+ }
+ },
+ "SignalRUsage": {
+ "description": "Object that describes a specific usage of SignalR resources.",
+ "type": "object",
+ "properties": {
+ "id": {
+ "description": "Fully qualified ARM resource id",
+ "type": "string"
+ },
+ "currentValue": {
+ "format": "int64",
+ "description": "Current value for the usage quota.",
+ "type": "integer"
+ },
+ "limit": {
+ "format": "int64",
+ "description": "The maximum permitted value for the usage quota. If there is no limit, this value will be -1.",
+ "type": "integer"
+ },
+ "name": {
+ "$ref": "#/definitions/SignalRUsageName",
+ "description": "Localizable String object containing the name and a localized value."
+ },
+ "unit": {
+ "description": "Representing the units of the usage quota. Possible values are: Count, Bytes, Seconds, Percent, CountPerSecond, BytesPerSecond.",
+ "type": "string"
+ }
+ }
+ },
+ "SignalRUsageName": {
+ "description": "Localizable String object containing the name and a localized value.",
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "The identifier of the usage.",
+ "type": "string"
+ },
+ "localizedValue": {
+ "description": "Localized name of the usage.",
+ "type": "string"
+ }
+ }
+ }
+ },
+ "parameters": {
+ "ApiVersionParameter": {
+ "name": "api-version",
+ "in": "query",
+ "description": "Client Api Version.",
+ "required": true,
+ "type": "string"
+ },
+ "SubscriptionIdParameter": {
+ "name": "subscriptionId",
+ "in": "path",
+ "description": "Gets subscription Id which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.",
+ "required": true,
+ "type": "string"
+ },
+ "ResourceGroupParameter": {
+ "name": "resourceGroupName",
+ "in": "path",
+ "description": "The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.",
+ "required": true,
+ "type": "string",
+ "x-ms-parameter-location": "method"
+ },
+ "SignalRServiceName": {
+ "name": "resourceName",
+ "in": "path",
+ "description": "The name of the SignalR resource.",
+ "required": true,
+ "type": "string",
+ "x-ms-parameter-location": "method"
+ }
+ },
+ "securityDefinitions": {
+ "azure_auth": {
+ "flow": "implicit",
+ "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize",
+ "scopes": {
+ "user_impersonation": "impersonate your user account"
+ },
+ "type": "oauth2",
+ "description": "Azure Active Directory OAuth2 Flow"
+ }
+ },
+ "security": [
+ {
+ "azure_auth": [
+ "user_impersonation"
+ ]
+ }
+ ]
+}
diff --git a/specification/signalr/resource-manager/readme.go.md b/specification/signalr/resource-manager/readme.go.md
index f84c87f6866a..c7fed8130266 100644
--- a/specification/signalr/resource-manager/readme.go.md
+++ b/specification/signalr/resource-manager/readme.go.md
@@ -15,6 +15,7 @@ go:
batch:
- tag: package-2018-03-01-preview
- tag: package-2018-10-01
+ - tag: package-2020-05-01
```
### Tag: package-2018-03-01-preview and go
@@ -34,3 +35,12 @@ Please also specify `--go-sdk-folder=`.
+
+``` yaml $(tag) == 'package-2020-05-01' && $(go)
+output-folder: $(go-sdk-folder)/services/$(namespace)/mgmt/2020-05-01/$(namespace)
+```
diff --git a/specification/signalr/resource-manager/readme.java.md b/specification/signalr/resource-manager/readme.java.md
index b6b8cbf12242..332c4a397833 100644
--- a/specification/signalr/resource-manager/readme.java.md
+++ b/specification/signalr/resource-manager/readme.java.md
@@ -18,6 +18,20 @@ output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-signalr
batch:
- tag: package-2018-03-01-preview
- tag: package-2018-10-01
+ - tag: package-2020-05-01
+```
+
+### Tag: package-2020-05-01 and java
+
+These settings apply only when `--tag=package-2020-05-01 --java` is specified on the command line.
+Please also specify `--azure-libraries-for-java-folder=`.
+
+``` yaml $(tag) == 'package-2020-05-01' && $(java) && $(multiapi)
+java:
+ namespace: com.microsoft.azure.management.signalr.v2020_05_01
+ output-folder: $(azure-libraries-for-java-folder)/sdk/signalr/mgmt-v2020_05_01
+regenerate-manager: true
+generate-interface: true
```
### Tag: package-2018-10-01 and java
@@ -44,4 +58,4 @@ java:
output-folder: $(azure-libraries-for-java-folder)/sdk/signalr/mgmt-v2018_03_01_preview
regenerate-manager: true
generate-interface: true
-```
\ No newline at end of file
+```
diff --git a/specification/signalr/resource-manager/readme.md b/specification/signalr/resource-manager/readme.md
index 356ff90245d8..807ff01765c9 100644
--- a/specification/signalr/resource-manager/readme.md
+++ b/specification/signalr/resource-manager/readme.md
@@ -26,7 +26,7 @@ These are the global settings for the SignalR API.
``` yaml
openapi-type: arm
-tag: package-2018-10-01
+tag: package-2020-05-01
```
### Suppression
@@ -40,11 +40,28 @@ directive:
- suppress: EnumInsteadOfBoolean
from: signalr.json
where: $.definitions.Dimension.properties.toBeExportedForShoebox
- reason: The boolean properties 'toBeExportedForShoebox' is defined by Geneva metrics
- - suppress: PutRequestResponseScheme
+ reason: The boolean properties 'toBeExportedForShoebox' is defined by Geneva metrics.
+ - suppress: EnumInsteadOfBoolean
+ from: signalr.json
+ where: $.definitions.Operation.properties.isDataAction
+ reason: The boolean properties 'isDataAction' is a standard property for Azuer Operatoins.
+ - suppress: TrackedResourceListByImmediateParent
+ reason: Another list APIs naming approach is used over the specs
+ - suppress: AvoidNestedProperties
from: signalr.json
- where: $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}"].put
- reason: The schema of the PUT request body is a superset of the GET response body, we have a PATCH operation to make the resource updatable
+ where:
+ - $.definitions.SignalRFeature.properties.properties
+ - $.definitions.PrivateEndpointConnection.properties.properties
+ reason: The 'properties' is a user-defined dictionary, cannot be flattened.
+```
+
+### Tag: package-2020-05-01
+
+These settings apply only when `--tag=package-2020-05-01` is specified on the command line.
+
+``` yaml $(tag) == 'package-2020-05-01'
+input-file:
+- Microsoft.SignalRService/stable/2020-05-01/signalr.json
```
### Tag: package-2018-10-01
@@ -123,6 +140,7 @@ require: $(this-folder)/../../../profiles/readme.md
# all the input files across all versions
input-file:
+ - $(this-folder)/Microsoft.SignalRService/stable/2020-05-01/signalr.json
- $(this-folder)/Microsoft.SignalRService/stable/2018-10-01/signalr.json
- $(this-folder)/Microsoft.SignalRService/preview/2018-03-01-preview/signalr.json
diff --git a/specification/signalr/resource-manager/readme.ruby.md b/specification/signalr/resource-manager/readme.ruby.md
index 39b11888ae39..b10560ba58b6 100644
--- a/specification/signalr/resource-manager/readme.ruby.md
+++ b/specification/signalr/resource-manager/readme.ruby.md
@@ -14,6 +14,17 @@ azure-arm: true
batch:
- tag: package-2018-03-01-preview
- tag: package-2018-10-01
+ - tag: package-2020-05-01
+```
+
+### Tag: package-2020-05-01 and ruby
+
+These settings apply only when `--tag=package-2020-05-01 --ruby` is specified on the command line.
+Please also specify `--ruby-sdks-folder=`.
+
+``` yaml $(tag) == 'package-2020-05-01' && $(ruby)
+namespace: "Azure::Signalr::Mgmt::V2020_05_01"
+output-folder: $(ruby-sdks-folder)/management/azure_mgmt_signalr/lib
```
### Tag: package-2018-10-01 and ruby
diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2015-05-01-preview/blobAuditing.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2015-05-01-preview/blobAuditing.json
index a54e76e1c57c..74a2e385bb4b 100644
--- a/specification/sql/resource-manager/Microsoft.Sql/preview/2015-05-01-preview/blobAuditing.json
+++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2015-05-01-preview/blobAuditing.json
@@ -103,7 +103,7 @@
}
},
"default": {
- "description": "*** Error Responses: ***\n\n * 400 BlobAuditingIsNotSupportedOnResourceType - Blob Auditing is currently not supported for this resource type.\n\n * 400 InvalidDatabaseBlobAuditingPolicyCreateRequest - The create database blob auditing policy request does not exist or has no properties object.\n\n * 400 InvalidBlobAuditActionsAndGroups - Invalid audit actions or action groups.\n\n * 400 DataSecurityInvalidUserSuppliedParameter - An invalid parameter value was provided by the client.\n\n * 400 BlobAuditingInvalidStorageAccountName - The provided storage account is not valid or does not exist.\n\n * 400 UpdateNotAllowedOnPausedDatabase - User attempted to perform an update on a paused database.\n\n * 400 BlobAuditingInvalidStorageAccountCredentials - The provided storage account or access key is not valid.\n\n * 400 BlobAuditingIsNotSupportedOnGeoDr - Blob auditing can be configured on primary databases only.\n\n * 400 InvalidBlobAuditActionsAndGroupsForDW - Unsupported audit actions or action groups for DW.\n\n * 400 BlobAuditingInsufficientStorageAccountPermissions - Insufficient read or write permissions on the provided storage account.\n\n * 400 BlobAuditingStorageAccountIsDisabled - The provided storage account is disabled.\n\n * 400 InvalidBlobAuditActions - Invalid audit action\n\n * 404 SourceDatabaseNotFound - The source database does not exist.\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 500 DatabaseIsUnavailable - Loading failed. Please try again later."
+ "description": "*** Error Responses: ***\n\n * 400 BlobAuditingIsNotSupportedOnResourceType - Blob Auditing is currently not supported for this resource type.\n\n * 400 InvalidDatabaseBlobAuditingPolicyCreateRequest - The create database blob auditing policy request does not exist or has no properties object.\n\n * 400 InvalidBlobAuditActionsAndGroups - Invalid audit actions or action groups.\n\n * 400 DataSecurityInvalidUserSuppliedParameter - An invalid parameter value was provided by the client.\n\n * 400 BlobAuditingInvalidStorageAccountName - The provided storage account is not valid or does not exist.\n\n * 400 UpdateNotAllowedOnPausedDatabase - User attempted to perform an update on a paused database.\n\n * 400 BlobAuditingInvalidStorageAccountCredentials - The provided storage account or access key is not valid.\n\n * 400 BlobAuditingIsNotSupportedOnGeoDr - Blob auditing can be configured on primary databases only.\n\n * 400 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."
},
"201": {
"description": "Successfully created the database blob auditing policy.",
@@ -196,7 +196,7 @@
"type": "string"
},
"storageAccountAccessKey": {
- "description": "Specifies the identifier key of the auditing storage account. If state is Enabled and storageEndpoint is specified, storageAccountAccessKey is required.",
+ "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",
diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2015-05-01-preview/examples/ManagedInstanceCreateMax.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2015-05-01-preview/examples/ManagedInstanceCreateMax.json
index 1552d4b274c1..6e307cb7fdb7 100644
--- a/specification/sql/resource-manager/Microsoft.Sql/preview/2015-05-01-preview/examples/ManagedInstanceCreateMax.json
+++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2015-05-01-preview/examples/ManagedInstanceCreateMax.json
@@ -25,7 +25,8 @@
"publicDataEndpointEnabled": false,
"proxyOverride": "Redirect",
"timezoneId": "UTC",
- "instancePoolId": "/subscriptions/20D7082A-0FC7-4468-82BD-542694D5042B/resourceGroups/testrg/providers/Microsoft.Sql/instancePools/pool1"
+ "instancePoolId": "/subscriptions/20D7082A-0FC7-4468-82BD-542694D5042B/resourceGroups/testrg/providers/Microsoft.Sql/instancePools/pool1",
+ "maintenanceConfigurationId": "/subscriptions/ab0e51c0-83c0-4380-8ae9-025516df392f/providers/Microsoft.Maintenance/publicMaintenanceConfigurations/SQL_WestEurope_MI_Mon_Fri_10PM_6AM"
}
}
},
@@ -51,7 +52,8 @@
"proxyOverride": "Redirect",
"dnsZone": "1b4e2caff2530",
"timezoneId": "UTC",
- "instancePoolId": "/subscriptions/20D7082A-0FC7-4468-82BD-542694D5042B/resourceGroups/testrg/providers/Microsoft.Sql/instancePools/pool1"
+ "instancePoolId": "/subscriptions/20D7082A-0FC7-4468-82BD-542694D5042B/resourceGroups/testrg/providers/Microsoft.Sql/instancePools/pool1",
+ "maintenanceConfigurationId": "/subscriptions/ab0e51c0-83c0-4380-8ae9-025516df392f/providers/Microsoft.Maintenance/publicMaintenanceConfigurations/SQL_WestEurope_MI_Mon_Fri_10PM_6AM"
},
"location": "japaneast",
"tags": {
@@ -83,7 +85,8 @@
"proxyOverride": "Redirect",
"dnsZone": "1b4e2caff2530",
"timezoneId": "UTC",
- "instancePoolId": "/subscriptions/20d7082a-0fc7-4468-82bd-542694d5042b/resourceGroups/testrg/providers/Microsoft.Sql/instancePools/pool1"
+ "instancePoolId": "/subscriptions/20d7082a-0fc7-4468-82bd-542694d5042b/resourceGroups/testrg/providers/Microsoft.Sql/instancePools/pool1",
+ "maintenanceConfigurationId": "/subscriptions/ab0e51c0-83c0-4380-8ae9-025516df392f/providers/Microsoft.Maintenance/publicMaintenanceConfigurations/SQL_westeurope_MI_Mon_Fri_10PM_6AM"
},
"location": "japaneast",
"tags": {
diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2015-05-01-preview/examples/ManagedInstanceGet.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2015-05-01-preview/examples/ManagedInstanceGet.json
index d81c083a4af4..4ad01f466643 100644
--- a/specification/sql/resource-manager/Microsoft.Sql/preview/2015-05-01-preview/examples/ManagedInstanceGet.json
+++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2015-05-01-preview/examples/ManagedInstanceGet.json
@@ -26,7 +26,8 @@
"publicDataEndpointEnabled": false,
"proxyOverride": "Default",
"dnsZone": "1b4e2caff2530",
- "instancePoolId": "/subscriptions/20d7082a-0fc7-4468-82bd-542694d5042b/resourceGroups/testrg/providers/Microsoft.Sql/instancePools/instancePool1"
+ "instancePoolId": "/subscriptions/20d7082a-0fc7-4468-82bd-542694d5042b/resourceGroups/testrg/providers/Microsoft.Sql/instancePools/instancePool1",
+ "maintenanceConfigurationId": "/subscriptions/ab0e51c0-83c0-4380-8ae9-025516df392f/providers/Microsoft.Maintenance/publicMaintenanceConfigurations/SQL_WestEurope_MI_Mon_Fri_10PM_6AM"
},
"location": "japaneast",
"tags": {
diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2015-05-01-preview/examples/ManagedInstanceList.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2015-05-01-preview/examples/ManagedInstanceList.json
index 640b037c3ba0..19bc87170b8d 100644
--- a/specification/sql/resource-manager/Microsoft.Sql/preview/2015-05-01-preview/examples/ManagedInstanceList.json
+++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2015-05-01-preview/examples/ManagedInstanceList.json
@@ -29,7 +29,8 @@
"collation": "SQL_Latin1_General_CP1_CI_AS",
"publicDataEndpointEnabled": false,
"proxyOverride": "Default",
- "dnsZone": "1b4e2caff2530"
+ "dnsZone": "1b4e2caff2530",
+ "maintenanceConfigurationId": "/subscriptions/ab0e51c0-83c0-4380-8ae9-025516df392f/providers/Microsoft.Maintenance/publicMaintenanceConfigurations/SQL_WestEurope_MI_Mon_Fri_10PM_6AM"
}
},
{
diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2015-05-01-preview/examples/ManagedInstanceListByResourceGroup.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2015-05-01-preview/examples/ManagedInstanceListByResourceGroup.json
index a08933264aac..2123619ea897 100644
--- a/specification/sql/resource-manager/Microsoft.Sql/preview/2015-05-01-preview/examples/ManagedInstanceListByResourceGroup.json
+++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2015-05-01-preview/examples/ManagedInstanceListByResourceGroup.json
@@ -30,7 +30,8 @@
"collation": "SQL_Latin1_General_CP1_CI_AS",
"publicDataEndpointEnabled": false,
"proxyOverride": "Default",
- "dnsZone": "1b4e2caff2530"
+ "dnsZone": "1b4e2caff2530",
+ "maintenanceConfigurationId": "/subscriptions/ab0e51c0-83c0-4380-8ae9-025516df392f/providers/Microsoft.Maintenance/publicMaintenanceConfigurations/SQL_WestEurope_MI_Mon_Fri_10PM_6AM"
}
},
{
@@ -55,7 +56,8 @@
"collation": "SQL_Latin1_General_CP1_CI_AS",
"publicDataEndpointEnabled": false,
"proxyOverride": "Default",
- "dnsZone": "2c3d1bdae3412"
+ "dnsZone": "2c3d1bdae3412",
+ "maintenanceConfigurationId": "/subscriptions/ab0e51c0-83c0-4380-8ae9-025516df392f/providers/Microsoft.Maintenance/publicMaintenanceConfigurations/SQL_WestEurope_MI_Mon_Fri_10PM_6AM"
}
}
]
diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2015-05-01-preview/examples/ManagedInstanceUpdateMax.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2015-05-01-preview/examples/ManagedInstanceUpdateMax.json
index f60ec5b9c93e..51268336c84e 100644
--- a/specification/sql/resource-manager/Microsoft.Sql/preview/2015-05-01-preview/examples/ManagedInstanceUpdateMax.json
+++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2015-05-01-preview/examples/ManagedInstanceUpdateMax.json
@@ -21,7 +21,8 @@
"licenseType": "BasePrice",
"vCores": 8,
"storageSizeInGB": 448,
- "collation": "SQL_Latin1_General_CP1_CI_AS"
+ "collation": "SQL_Latin1_General_CP1_CI_AS",
+ "maintenanceConfigurationId": "/subscriptions/ab0e51c0-83c0-4380-8ae9-025516df392f/providers/Microsoft.Maintenance/publicMaintenanceConfigurations/SQL_WestEurope_MI_Mon_Fri_10PM_6AM"
}
}
},
@@ -53,7 +54,8 @@
"publicDataEndpointEnabled": false,
"proxyOverride": "Redirect",
"dnsZone": "1b4e2caff2530",
- "instancePoolId": "/subscriptions/20d7082a-0fc7-4468-82bd-542694d5042b/resourceGroups/testrg/providers/Microsoft.Sql/instancePools/instancePool1"
+ "instancePoolId": "/subscriptions/20d7082a-0fc7-4468-82bd-542694d5042b/resourceGroups/testrg/providers/Microsoft.Sql/instancePools/instancePool1",
+ "maintenanceConfigurationId": "/subscriptions/ab0e51c0-83c0-4380-8ae9-025516df392f/providers/Microsoft.Maintenance/publicMaintenanceConfigurations/SQL_WestEurope_MI_Mon_Fri_10PM_6AM"
}
}
},
diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2015-05-01-preview/examples/ManagedInstanceUpdateMin.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2015-05-01-preview/examples/ManagedInstanceUpdateMin.json
index b67afb7b384f..aa87197d2540 100644
--- a/specification/sql/resource-manager/Microsoft.Sql/preview/2015-05-01-preview/examples/ManagedInstanceUpdateMin.json
+++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2015-05-01-preview/examples/ManagedInstanceUpdateMin.json
@@ -31,7 +31,8 @@
"publicDataEndpointEnabled": false,
"proxyOverride": "Default",
"dnsZone": "1b4e2caff2530",
- "instancePoolId": "/subscriptions/20D7082A-0FC7-4468-82BD-542694D5042B/resourceGroups/testrg/providers/Microsoft.Sql/instancePools/instancePool1"
+ "instancePoolId": "/subscriptions/20D7082A-0FC7-4468-82BD-542694D5042B/resourceGroups/testrg/providers/Microsoft.Sql/instancePools/instancePool1",
+ "maintenanceConfigurationId": "/subscriptions/ab0e51c0-83c0-4380-8ae9-025516df392f/providers/Microsoft.Maintenance/publicMaintenanceConfigurations/SQL_WestEurope_MI_Mon_Fri_10PM_6AM"
},
"location": "japaneast",
"tags": {
diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2015-05-01-preview/managedInstances.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2015-05-01-preview/managedInstances.json
index 0e817f870ea3..f73579be3d37 100644
--- a/specification/sql/resource-manager/Microsoft.Sql/preview/2015-05-01-preview/managedInstances.json
+++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2015-05-01-preview/managedInstances.json
@@ -439,6 +439,10 @@
"description": "The Id of the instance pool this managed server belongs to.",
"type": "string"
},
+ "maintenanceConfigurationId": {
+ "description": "Specifies maintenance configuration id to apply to this managed instance.",
+ "type": "string"
+ },
"minimalTlsVersion": {
"description": "Minimal TLS version. Allowed values: 'None', '1.0', '1.1', '1.2'",
"type": "string"
diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/blobAuditing.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/blobAuditing.json
index 78954c1818e2..90430bf3fd96 100644
--- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/blobAuditing.json
+++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/blobAuditing.json
@@ -103,7 +103,7 @@
}
},
"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 InvalidBlobAuditActionsAndGroupsForDW - Unsupported audit actions or action groups for DW.\n\n * 400 BlobAuditingInsufficientStorageAccountPermissions - Insufficient read or write permissions on the provided storage account.\n\n * 400 BlobAuditingStorageAccountIsDisabled - The provided storage account is disabled.\n\n * 400 InvalidBlobAuditActions - Invalid audit action\n\n * 404 SourceDatabaseNotFound - The source database does not exist.\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 500 DatabaseIsUnavailable - Loading failed. Please try again later."
+ "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."
},
"201": {
"description": "Successfully created the extended database blob auditing policy.",
@@ -125,6 +125,51 @@
}
}
},
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/extendedAuditingSettings": {
+ "get": {
+ "tags": [
+ "BlobAuditing"
+ ],
+ "description": "Lists extended auditing settings of a database.",
+ "operationId": "ExtendedDatabaseBlobAuditingPolicies_ListByDatabase",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ResourceGroupParameter"
+ },
+ {
+ "$ref": "#/parameters/ServerNameParameter"
+ },
+ {
+ "$ref": "#/parameters/DatabaseNameParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successfully retrieved the database extended auditing settings.",
+ "schema": {
+ "$ref": "#/definitions/ExtendedDatabaseBlobAuditingPolicyListResult"
+ }
+ },
+ "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 extended auditing settings of a database": {
+ "$ref": "./examples/DatabaseExtendedAuditingSettingsList.json"
+ }
+ }
+ }
+ },
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/extendedAuditingSettings/{blobAuditingPolicyName}": {
"get": {
"tags": [
@@ -206,7 +251,7 @@
}
},
"default": {
- "description": "*** Error Responses: ***\n\n * 400 InvalidServerBlobAuditingPolicyCreateRequest - The create server blob auditing policy request does not exist or has no properties object.\n\n * 400 InvalidBlobAuditActionsAndGroups - Invalid audit actions or action groups.\n\n * 400 DataSecurityInvalidUserSuppliedParameter - An invalid parameter value was provided by the client.\n\n * 400 BlobAuditingPredicateExpressionEmpty - Invalid parameter 'predicateExpression', value can not be empty.\n\n * 400 InvalidBlobAuditActionsAndGroups - Invalid audit actions or action groups.\n\n * 400 InvalidBlobAuditActions - Invalid audit action\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 409 ServerBlobAuditingPolicyInProgress - Set server blob auditing is already in progress."
+ "description": "*** Error Responses: ***\n\n * 400 InvalidServerBlobAuditingPolicyCreateRequest - The create server blob auditing policy request does not exist or has no properties object.\n\n * 400 InvalidBlobAuditActionsAndGroups - Invalid audit actions or action groups.\n\n * 400 DataSecurityInvalidUserSuppliedParameter - An invalid parameter value was provided by the client.\n\n * 400 BlobAuditingPredicateExpressionEmpty - Invalid parameter 'predicateExpression', value can not be empty.\n\n * 400 BlobAuditingInvalidStorageAccountCredentials - The provided storage account or access key is not valid.\n\n * 400 InvalidBlobAuditActionsAndGroups - Invalid audit actions or action groups.\n\n * 400 InsufficientDiskSpaceForAuditing - Insufficient disk space to save auditing metadata in the database\n\n * 400 InvalidBlobAuditActions - Invalid audit action\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 409 ServerBlobAuditingPolicyInProgress - Set server blob auditing is already in progress."
},
"202": {
"description": "Updating the extended auditing settings is in progress."
@@ -223,6 +268,48 @@
}
}
},
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/extendedAuditingSettings": {
+ "get": {
+ "tags": [
+ "BlobAuditing"
+ ],
+ "description": "Lists extended auditing settings of a server.",
+ "operationId": "ExtendedServerBlobAuditingPolicies_ListByServer",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ResourceGroupParameter"
+ },
+ {
+ "$ref": "#/parameters/ServerNameParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successfully retrieved extended server auditing settings.",
+ "schema": {
+ "$ref": "#/definitions/ExtendedServerBlobAuditingPolicyListResult"
+ }
+ },
+ "default": {
+ "description": "*** Error Responses: ***\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription."
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-examples": {
+ "List extended auditing settings of a server": {
+ "$ref": "./examples/ServerExtendedAuditingSettingsList.json"
+ }
+ }
+ }
+ },
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/auditingSettings/{blobAuditingPolicyName}": {
"get": {
"tags": [
@@ -304,7 +391,7 @@
}
},
"default": {
- "description": "*** Error Responses: ***\n\n * 400 InvalidServerBlobAuditingPolicyCreateRequest - The create server blob auditing policy request does not exist or has no properties object.\n\n * 400 InvalidBlobAuditActionsAndGroups - Invalid audit actions or action groups.\n\n * 400 DataSecurityInvalidUserSuppliedParameter - An invalid parameter value was provided by the client.\n\n * 400 InvalidBlobAuditActionsAndGroups - Invalid audit actions or action groups.\n\n * 400 InvalidBlobAuditActions - Invalid audit action\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 409 ServerBlobAuditingPolicyInProgress - Set server blob auditing is already in progress."
+ "description": "*** Error Responses: ***\n\n * 400 InvalidServerBlobAuditingPolicyCreateRequest - The create server blob auditing policy request does not exist or has no properties object.\n\n * 400 InvalidBlobAuditActionsAndGroups - Invalid audit actions or action groups.\n\n * 400 DataSecurityInvalidUserSuppliedParameter - An invalid parameter value was provided by the client.\n\n * 400 BlobAuditingInvalidStorageAccountCredentials - The provided storage account or access key is not valid.\n\n * 400 InvalidBlobAuditActionsAndGroups - Invalid audit actions or action groups.\n\n * 400 InsufficientDiskSpaceForAuditing - Insufficient disk space to save auditing metadata in the database\n\n * 400 InvalidBlobAuditActions - Invalid audit action\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 409 ServerBlobAuditingPolicyInProgress - Set server blob auditing is already in progress."
},
"202": {
"description": "Updating the auditing settings is in progress."
@@ -450,7 +537,7 @@
}
},
"default": {
- "description": "*** Error Responses: ***\n\n * 400 BlobAuditingIsNotSupportedOnResourceType - Blob Auditing is currently not supported for this resource type.\n\n * 400 InvalidDatabaseBlobAuditingPolicyCreateRequest - The create database blob auditing policy request does not exist or has no properties object.\n\n * 400 InvalidBlobAuditActionsAndGroups - Invalid audit actions or action groups.\n\n * 400 DataSecurityInvalidUserSuppliedParameter - An invalid parameter value was provided by the client.\n\n * 400 BlobAuditingInvalidStorageAccountName - The provided storage account is not valid or does not exist.\n\n * 400 UpdateNotAllowedOnPausedDatabase - User attempted to perform an update on a paused database.\n\n * 400 BlobAuditingInvalidStorageAccountCredentials - The provided storage account or access key is not valid.\n\n * 400 BlobAuditingIsNotSupportedOnGeoDr - Blob auditing can be configured on primary databases only.\n\n * 400 InvalidBlobAuditActionsAndGroupsForDW - Unsupported audit actions or action groups for DW.\n\n * 400 BlobAuditingInsufficientStorageAccountPermissions - Insufficient read or write permissions on the provided storage account.\n\n * 400 BlobAuditingStorageAccountIsDisabled - The provided storage account is disabled.\n\n * 400 InvalidBlobAuditActions - Invalid audit action\n\n * 404 SourceDatabaseNotFound - The source database does not exist.\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 500 DatabaseIsUnavailable - Loading failed. Please try again later."
+ "description": "*** Error Responses: ***\n\n * 400 BlobAuditingIsNotSupportedOnResourceType - Blob Auditing is currently not supported for this resource type.\n\n * 400 InvalidDatabaseBlobAuditingPolicyCreateRequest - The create database blob auditing policy request does not exist or has no properties object.\n\n * 400 InvalidBlobAuditActionsAndGroups - Invalid audit actions or action groups.\n\n * 400 DataSecurityInvalidUserSuppliedParameter - An invalid parameter value was provided by the client.\n\n * 400 BlobAuditingInvalidStorageAccountName - The provided storage account is not valid or does not exist.\n\n * 400 UpdateNotAllowedOnPausedDatabase - User attempted to perform an update on a paused database.\n\n * 400 BlobAuditingInvalidStorageAccountCredentials - The provided storage account or access key is not valid.\n\n * 400 BlobAuditingIsNotSupportedOnGeoDr - Blob auditing can be configured on primary databases only.\n\n * 400 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."
},
"201": {
"description": "Successfully created the database blob auditing policy.",
@@ -547,7 +634,7 @@
"type": "string"
},
"storageAccountAccessKey": {
- "description": "Specifies the identifier key of the auditing storage account. If state is Enabled and storageEndpoint is specified, storageAccountAccessKey is required.",
+ "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",
@@ -602,6 +689,25 @@
}
}
},
+ "ExtendedDatabaseBlobAuditingPolicyListResult": {
+ "description": "A list of database extended auditing settings.",
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "Array of results.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ExtendedDatabaseBlobAuditingPolicy"
+ },
+ "readOnly": true
+ },
+ "nextLink": {
+ "description": "Link to retrieve next page of results.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
"ExtendedServerBlobAuditingPolicyProperties": {
"description": "Properties of an extended server blob auditing policy.",
"required": [
@@ -630,7 +736,7 @@
"type": "string"
},
"storageAccountAccessKey": {
- "description": "Specifies the identifier key of the auditing storage account. If state is Enabled and storageEndpoint is specified, storageAccountAccessKey is required.",
+ "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",
@@ -685,6 +791,25 @@
}
}
},
+ "ExtendedServerBlobAuditingPolicyListResult": {
+ "description": "A list of server extended auditing settings.",
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "Array of results.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ExtendedServerBlobAuditingPolicy"
+ },
+ "readOnly": true
+ },
+ "nextLink": {
+ "description": "Link to retrieve next page of results.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
"ServerBlobAuditingPolicyProperties": {
"description": "Properties of a server blob auditing policy.",
"required": [
@@ -709,7 +834,7 @@
"type": "string"
},
"storageAccountAccessKey": {
- "description": "Specifies the identifier key of the auditing storage account. If state is Enabled and storageEndpoint is specified, storageAccountAccessKey is required.",
+ "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",
@@ -807,7 +932,7 @@
"type": "string"
},
"storageAccountAccessKey": {
- "description": "Specifies the identifier key of the auditing storage account. If state is Enabled and storageEndpoint is specified, storageAccountAccessKey is required.",
+ "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",
diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/DatabaseExtendedAuditingSettingsList.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/DatabaseExtendedAuditingSettingsList.json
new file mode 100644
index 000000000000..d4b99bed098a
--- /dev/null
+++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/DatabaseExtendedAuditingSettingsList.json
@@ -0,0 +1,32 @@
+{
+ "parameters": {
+ "subscriptionId": "00000000-1111-2222-3333-444444444444",
+ "resourceGroupName": "blobauditingtest-6852",
+ "serverName": "blobauditingtest-2080",
+ "databaseName": "testdb",
+ "api-version": "2017-03-01-preview"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/blobauditingtest-6852/providers/Microsoft.Sql/servers/blobauditingtest-2080/databases/testdb/extendedAuditingSettings/default",
+ "name": "default",
+ "type": "Microsoft.Sql/servers/databases/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/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ServerExtendedAuditingSettingsList.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ServerExtendedAuditingSettingsList.json
new file mode 100644
index 000000000000..e5570eb1c9d5
--- /dev/null
+++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ServerExtendedAuditingSettingsList.json
@@ -0,0 +1,31 @@
+{
+ "parameters": {
+ "subscriptionId": "00000000-1111-2222-3333-444444444444",
+ "resourceGroupName": "blobauditingtest-4799",
+ "serverName": "blobauditingtest-6440",
+ "api-version": "2017-03-01-preview"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/blobauditingtest-6852/providers/Microsoft.Sql/servers/blobauditingtest-2080/extendedAuditingSettings/default",
+ "name": "default",
+ "type": "Microsoft.Sql/servers/extendedAuditingSettings",
+ "properties": {
+ "state": "Disabled",
+ "storageEndpoint": "",
+ "retentionDays": 0,
+ "auditActionsAndGroups": [],
+ "storageAccountSubscriptionId": "00000000-0000-0000-0000-000000000000",
+ "isStorageSecondaryKeyInUse": false,
+ "predicateExpression": "object_name = 'SensitiveData'",
+ "isAzureMonitorTargetEnabled": false
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/databases.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/databases.json
index 08a4b9ae7774..d93a3000d8e5 100644
--- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/databases.json
+++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/databases.json
@@ -787,7 +787,7 @@
"type": "boolean"
},
"licenseType": {
- "description": "The license type to apply for this database.",
+ "description": "The license type to apply for this database. `LicenseIncluded` if you need a license, or `BasePrice` if you have a license and are eligible for the Azure Hybrid Benefit.",
"enum": [
"LicenseIncluded",
"BasePrice"
diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2018-06-01-preview/examples/ManagedInstanceCreateMax.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2018-06-01-preview/examples/ManagedInstanceCreateMax.json
index cd3e090e3398..ed423629d53a 100644
--- a/specification/sql/resource-manager/Microsoft.Sql/preview/2018-06-01-preview/examples/ManagedInstanceCreateMax.json
+++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2018-06-01-preview/examples/ManagedInstanceCreateMax.json
@@ -25,7 +25,8 @@
"publicDataEndpointEnabled": false,
"proxyOverride": "Redirect",
"timezoneId": "UTC",
- "instancePoolId": "/subscriptions/20D7082A-0FC7-4468-82BD-542694D5042B/resourceGroups/testrg/providers/Microsoft.Sql/instancePools/pool1"
+ "instancePoolId": "/subscriptions/20D7082A-0FC7-4468-82BD-542694D5042B/resourceGroups/testrg/providers/Microsoft.Sql/instancePools/pool1",
+ "maintenanceConfigurationId": "/subscriptions/ab0e51c0-83c0-4380-8ae9-025516df392f/providers/Microsoft.Maintenance/publicMaintenanceConfigurations/SQL_WestEurope_MI_Mon_Fri_10PM_6AM"
}
}
},
@@ -51,7 +52,8 @@
"proxyOverride": "Redirect",
"dnsZone": "1b4e2caff2530",
"timezoneId": "UTC",
- "instancePoolId": "/subscriptions/20D7082A-0FC7-4468-82BD-542694D5042B/resourceGroups/testrg/providers/Microsoft.Sql/instancePools/pool1"
+ "instancePoolId": "/subscriptions/20D7082A-0FC7-4468-82BD-542694D5042B/resourceGroups/testrg/providers/Microsoft.Sql/instancePools/pool1",
+ "maintenanceConfigurationId": "/subscriptions/ab0e51c0-83c0-4380-8ae9-025516df392f/providers/Microsoft.Maintenance/publicMaintenanceConfigurations/SQL_WestEurope_MI_Mon_Fri_10PM_6AM"
},
"location": "japaneast",
"tags": {
@@ -83,7 +85,8 @@
"proxyOverride": "Redirect",
"dnsZone": "1b4e2caff2530",
"timezoneId": "UTC",
- "instancePoolId": "/subscriptions/20d7082a-0fc7-4468-82bd-542694d5042b/resourceGroups/testrg/providers/Microsoft.Sql/instancePools/pool1"
+ "instancePoolId": "/subscriptions/20d7082a-0fc7-4468-82bd-542694d5042b/resourceGroups/testrg/providers/Microsoft.Sql/instancePools/pool1",
+ "maintenanceConfigurationId": "/subscriptions/ab0e51c0-83c0-4380-8ae9-025516df392f/providers/Microsoft.Maintenance/publicMaintenanceConfigurations/SQL_WestEurope_MI_Mon_Fri_10PM_6AM"
},
"location": "japaneast",
"tags": {
diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2018-06-01-preview/examples/ManagedInstanceGet.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2018-06-01-preview/examples/ManagedInstanceGet.json
index 9da73f2a4849..b78074a7820a 100644
--- a/specification/sql/resource-manager/Microsoft.Sql/preview/2018-06-01-preview/examples/ManagedInstanceGet.json
+++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2018-06-01-preview/examples/ManagedInstanceGet.json
@@ -26,7 +26,8 @@
"publicDataEndpointEnabled": false,
"proxyOverride": "Default",
"dnsZone": "1b4e2caff2530",
- "instancePoolId": "/subscriptions/20d7082a-0fc7-4468-82bd-542694d5042b/resourceGroups/testrg/providers/Microsoft.Sql/instancePools/instancePool1"
+ "instancePoolId": "/subscriptions/20d7082a-0fc7-4468-82bd-542694d5042b/resourceGroups/testrg/providers/Microsoft.Sql/instancePools/instancePool1",
+ "maintenanceConfigurationId": "/subscriptions/ab0e51c0-83c0-4380-8ae9-025516df392f/providers/Microsoft.Maintenance/publicMaintenanceConfigurations/SQL_WestEurope_MI_Mon_Fri_10PM_6AM"
},
"location": "japaneast",
"tags": {
diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2018-06-01-preview/examples/ManagedInstanceList.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2018-06-01-preview/examples/ManagedInstanceList.json
index 4ff1240668ef..faf180b0c9a1 100644
--- a/specification/sql/resource-manager/Microsoft.Sql/preview/2018-06-01-preview/examples/ManagedInstanceList.json
+++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2018-06-01-preview/examples/ManagedInstanceList.json
@@ -29,7 +29,8 @@
"collation": "SQL_Latin1_General_CP1_CI_AS",
"publicDataEndpointEnabled": false,
"proxyOverride": "Default",
- "dnsZone": "1b4e2caff2530"
+ "dnsZone": "1b4e2caff2530",
+ "maintenanceConfigurationId": "/subscriptions/ab0e51c0-83c0-4380-8ae9-025516df392f/providers/Microsoft.Maintenance/publicMaintenanceConfigurations/SQL_WestEurope_MI_Mon_Fri_10PM_6AM"
}
},
{
@@ -54,7 +55,8 @@
"collation": "SQL_Latin1_General_CP1_CI_AS",
"publicDataEndpointEnabled": false,
"proxyOverride": "Default",
- "dnsZone": "2c3d1bdae3412"
+ "dnsZone": "2c3d1bdae3412",
+ "maintenanceConfigurationId": "/subscriptions/ab0e51c0-83c0-4380-8ae9-025516df392f/providers/Microsoft.Maintenance/publicMaintenanceConfigurations/SQL_WestEurope_MI_Mon_Fri_10PM_6AM"
}
}
]
diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2018-06-01-preview/examples/ManagedInstanceListByInstancePool.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2018-06-01-preview/examples/ManagedInstanceListByInstancePool.json
index 313ef50fc116..0eeffd79dfdd 100644
--- a/specification/sql/resource-manager/Microsoft.Sql/preview/2018-06-01-preview/examples/ManagedInstanceListByInstancePool.json
+++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2018-06-01-preview/examples/ManagedInstanceListByInstancePool.json
@@ -32,7 +32,8 @@
"publicDataEndpointEnabled": false,
"dnsZone": "1b4e2caff2530",
"proxyOverride": "Redirect",
- "instancePoolId": "/subscriptions/20D7082A-0FC7-4468-82BD-542694D5042B/resourceGroups/Test1/providers/Microsoft.Sql/instancePools/pool1"
+ "instancePoolId": "/subscriptions/20D7082A-0FC7-4468-82BD-542694D5042B/resourceGroups/Test1/providers/Microsoft.Sql/instancePools/pool1",
+ "maintenanceConfigurationId": "/subscriptions/ab0e51c0-83c0-4380-8ae9-025516df392f/providers/Microsoft.Maintenance/publicMaintenanceConfigurations/SQL_WestEurope_MI_Mon_Fri_10PM_6AM"
}
},
{
@@ -58,7 +59,8 @@
"publicDataEndpointEnabled": false,
"dnsZone": "2c3d1bdae3412",
"proxyOverride": "Redirect",
- "instancePoolId": "/subscriptions/20D7082A-0FC7-4468-82BD-542694D5042B/resourceGroups/Test1/providers/Microsoft.Sql/instancePools/pool1"
+ "instancePoolId": "/subscriptions/20D7082A-0FC7-4468-82BD-542694D5042B/resourceGroups/Test1/providers/Microsoft.Sql/instancePools/pool1",
+ "maintenanceConfigurationId": "/subscriptions/ab0e51c0-83c0-4380-8ae9-025516df392f/providers/Microsoft.Maintenance/publicMaintenanceConfigurations/SQL_WestEurope_MI_Mon_Fri_10PM_6AM"
}
}
]
diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2018-06-01-preview/examples/ManagedInstanceListByResourceGroup.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2018-06-01-preview/examples/ManagedInstanceListByResourceGroup.json
index 7ef8a934da16..812771b07788 100644
--- a/specification/sql/resource-manager/Microsoft.Sql/preview/2018-06-01-preview/examples/ManagedInstanceListByResourceGroup.json
+++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2018-06-01-preview/examples/ManagedInstanceListByResourceGroup.json
@@ -30,7 +30,8 @@
"collation": "SQL_Latin1_General_CP1_CI_AS",
"publicDataEndpointEnabled": false,
"proxyOverride": "Default",
- "dnsZone": "1b4e2caff2530"
+ "dnsZone": "1b4e2caff2530",
+ "maintenanceConfigurationId": "/subscriptions/ab0e51c0-83c0-4380-8ae9-025516df392f/providers/Microsoft.Maintenance/publicMaintenanceConfigurations/SQL_WestEurope_MI_Mon_Fri_10PM_6AM"
}
},
{
@@ -55,7 +56,8 @@
"collation": "SQL_Latin1_General_CP1_CI_AS",
"publicDataEndpointEnabled": false,
"proxyOverride": "Default",
- "dnsZone": "2c3d1bdae3412"
+ "dnsZone": "2c3d1bdae3412",
+ "maintenanceConfigurationId": "/subscriptions/ab0e51c0-83c0-4380-8ae9-025516df392f/providers/Microsoft.Maintenance/publicMaintenanceConfigurations/SQL_WestEurope_MI_Mon_Fri_10PM_6AM"
}
}
]
diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2018-06-01-preview/examples/ManagedInstanceUpdateMax.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2018-06-01-preview/examples/ManagedInstanceUpdateMax.json
index 79d81c6aa48b..4f07238c0e25 100644
--- a/specification/sql/resource-manager/Microsoft.Sql/preview/2018-06-01-preview/examples/ManagedInstanceUpdateMax.json
+++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2018-06-01-preview/examples/ManagedInstanceUpdateMax.json
@@ -21,7 +21,8 @@
"licenseType": "BasePrice",
"vCores": 8,
"storageSizeInGB": 448,
- "collation": "SQL_Latin1_General_CP1_CI_AS"
+ "collation": "SQL_Latin1_General_CP1_CI_AS",
+ "maintenanceConfigurationId": "/subscriptions/ab0e51c0-83c0-4380-8ae9-025516df392f/providers/Microsoft.Maintenance/publicMaintenanceConfigurations/SQL_WestEurope_MI_Mon_Fri_10PM_6AM"
}
}
},
@@ -53,7 +54,8 @@
"publicDataEndpointEnabled": false,
"proxyOverride": "Redirect",
"dnsZone": "1b4e2caff2530",
- "instancePoolId": "/subscriptions/20d7082a-0fc7-4468-82bd-542694d5042b/resourceGroups/testrg/providers/Microsoft.Sql/instancePools/instancePool1"
+ "instancePoolId": "/subscriptions/20d7082a-0fc7-4468-82bd-542694d5042b/resourceGroups/testrg/providers/Microsoft.Sql/instancePools/instancePool1",
+ "maintenanceConfigurationId": "/subscriptions/ab0e51c0-83c0-4380-8ae9-025516df392f/providers/Microsoft.Maintenance/publicMaintenanceConfigurations/SQL_WestEurope_MI_Mon_Fri_10PM_6AM"
}
}
},
diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2018-06-01-preview/examples/ManagedInstanceUpdateMin.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2018-06-01-preview/examples/ManagedInstanceUpdateMin.json
index 7fa48928dee9..e2247037c5c6 100644
--- a/specification/sql/resource-manager/Microsoft.Sql/preview/2018-06-01-preview/examples/ManagedInstanceUpdateMin.json
+++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2018-06-01-preview/examples/ManagedInstanceUpdateMin.json
@@ -31,7 +31,8 @@
"publicDataEndpointEnabled": false,
"proxyOverride": "Default",
"dnsZone": "1b4e2caff2530",
- "instancePoolId": "/subscriptions/20d7082a-0fc7-4468-82bd-542694d5042b/resourceGroups/testrg/providers/Microsoft.Sql/instancePools/instancePool1"
+ "instancePoolId": "/subscriptions/20d7082a-0fc7-4468-82bd-542694d5042b/resourceGroups/testrg/providers/Microsoft.Sql/instancePools/instancePool1",
+ "maintenanceConfigurationId": "/subscriptions/ab0e51c0-83c0-4380-8ae9-025516df392f/providers/Microsoft.Maintenance/publicMaintenanceConfigurations/SQL_WestEurope_MI_Mon_Fri_10PM_6AM"
},
"location": "japaneast",
"tags": {
diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2018-06-01-preview/managedInstances.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2018-06-01-preview/managedInstances.json
index 14afdcdb4e85..5006cad54c5f 100644
--- a/specification/sql/resource-manager/Microsoft.Sql/preview/2018-06-01-preview/managedInstances.json
+++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2018-06-01-preview/managedInstances.json
@@ -485,6 +485,10 @@
"description": "The Id of the instance pool this managed server belongs to.",
"type": "string"
},
+ "maintenanceConfigurationId": {
+ "description": "Specifies maintenance configuration id to apply to this managed instance.",
+ "type": "string"
+ },
"minimalTlsVersion": {
"description": "Minimal TLS version. Allowed values: 'None', '1.0', '1.1', '1.2'",
"type": "string"
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 045b85a77c88..2e2db731b65d 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
@@ -885,7 +885,7 @@
"type": "boolean"
},
"licenseType": {
- "description": "The license type to apply for this database.",
+ "description": "The license type to apply for this database. `LicenseIncluded` if you need a license, or `BasePrice` if you have a license and are eligible for the Azure Hybrid Benefit.",
"enum": [
"LicenseIncluded",
"BasePrice"
diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2019-06-01-preview/examples/SyncGroupCancelSync.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2019-06-01-preview/examples/SyncGroupCancelSync.json
new file mode 100644
index 000000000000..48b0b1dad5ee
--- /dev/null
+++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2019-06-01-preview/examples/SyncGroupCancelSync.json
@@ -0,0 +1,13 @@
+{
+ "parameters": {
+ "subscriptionId": "00000000-1111-2222-3333-444444444444",
+ "resourceGroupName": "syncgroupcrud-65440",
+ "serverName": "syncgroupcrud-8475",
+ "databaseName": "syncgroupcrud-4328",
+ "syncGroupName": "syncgroupcrud-3187",
+ "api-version": "2019-06-01-preview"
+ },
+ "responses": {
+ "200": {}
+ }
+}
diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2019-06-01-preview/examples/SyncGroupCreate.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2019-06-01-preview/examples/SyncGroupCreate.json
new file mode 100644
index 000000000000..8a6f8994ec21
--- /dev/null
+++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2019-06-01-preview/examples/SyncGroupCreate.json
@@ -0,0 +1,54 @@
+{
+ "parameters": {
+ "subscriptionId": "00000000-1111-2222-3333-444444444444",
+ "resourceGroupName": "syncgroupcrud-65440",
+ "serverName": "syncgroupcrud-8475",
+ "databaseName": "syncgroupcrud-4328",
+ "syncGroupName": "syncgroupcrud-3187",
+ "api-version": "2019-06-01-preview",
+ "parameters": {
+ "properties": {
+ "interval": -1,
+ "conflictResolutionPolicy": "HubWin",
+ "syncDatabaseId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-3521/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328",
+ "hubDatabaseUserName": "hubUser",
+ "usePrivateLinkConnection": false
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "properties": {
+ "interval": -1,
+ "lastSyncTime": "0001-01-01T08:00:00Z",
+ "conflictResolutionPolicy": "HubWin",
+ "syncDatabaseId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-3521/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328",
+ "hubDatabaseUserName": "hubUser",
+ "syncState": "NotReady",
+ "usePrivateLinkConnection": false
+ },
+ "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-3521/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328/syncGroups/syncgroupcrud-3187",
+ "name": "syncgroupcrud-3187",
+ "type": "Microsoft.Sql/servers/databases/syncGroups"
+ }
+ },
+ "201": {
+ "body": {
+ "properties": {
+ "interval": -1,
+ "lastSyncTime": "0001-01-01T08:00:00Z",
+ "conflictResolutionPolicy": "HubWin",
+ "syncDatabaseId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-3521/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328",
+ "hubDatabaseUserName": "hubUser",
+ "syncState": "NotReady",
+ "usePrivateLinkConnection": false
+ },
+ "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-3521/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328/syncGroups/syncgroupcrud-3187",
+ "name": "syncgroupcrud-3187",
+ "type": "Microsoft.Sql/servers/databases/syncGroups"
+ }
+ },
+ "202": {}
+ }
+}
diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2019-06-01-preview/examples/SyncGroupDelete.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2019-06-01-preview/examples/SyncGroupDelete.json
new file mode 100644
index 000000000000..a9691bbae29d
--- /dev/null
+++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2019-06-01-preview/examples/SyncGroupDelete.json
@@ -0,0 +1,15 @@
+{
+ "parameters": {
+ "subscriptionId": "00000000-1111-2222-3333-444444444444",
+ "resourceGroupName": "syncgroupcrud-65440",
+ "serverName": "syncgroupcrud-8475",
+ "databaseName": "syncgroupcrud-4328",
+ "syncGroupName": "syncgroupcrud-3187",
+ "api-version": "2019-06-01-preview"
+ },
+ "responses": {
+ "200": {},
+ "202": {},
+ "204": {}
+ }
+}
diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2019-06-01-preview/examples/SyncGroupGet.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2019-06-01-preview/examples/SyncGroupGet.json
new file mode 100644
index 000000000000..8a88e81a9966
--- /dev/null
+++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2019-06-01-preview/examples/SyncGroupGet.json
@@ -0,0 +1,28 @@
+{
+ "parameters": {
+ "subscriptionId": "00000000-1111-2222-3333-444444444444",
+ "resourceGroupName": "syncgroupcrud-65440",
+ "serverName": "syncgroupcrud-8475",
+ "databaseName": "syncgroupcrud-4328",
+ "syncGroupName": "syncgroupcrud-3187",
+ "api-version": "2019-06-01-preview"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "properties": {
+ "interval": -1,
+ "lastSyncTime": "0001-01-01T08:00:00Z",
+ "conflictResolutionPolicy": "HubWin",
+ "syncDatabaseId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-3521/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328",
+ "hubDatabaseUserName": "hubUser",
+ "syncState": "NotReady",
+ "usePrivateLinkConnection": false
+ },
+ "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-3521/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328/syncGroups/syncgroupcrud-3187",
+ "name": "syncgroupcrud-3187",
+ "type": "Microsoft.Sql/servers/databases/syncGroups"
+ }
+ }
+ }
+}
diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2019-06-01-preview/examples/SyncGroupGetHubSchema.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2019-06-01-preview/examples/SyncGroupGetHubSchema.json
new file mode 100644
index 000000000000..06aa277287aa
--- /dev/null
+++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2019-06-01-preview/examples/SyncGroupGetHubSchema.json
@@ -0,0 +1,47 @@
+{
+ "parameters": {
+ "subscriptionId": "00000000-1111-2222-3333-444444444444",
+ "resourceGroupName": "syncgroupcrud-65440",
+ "serverName": "syncgroupcrud-8475",
+ "databaseName": "syncgroupcrud-4328",
+ "syncGroupName": "syncgroupcrud-3187",
+ "api-version": "2019-06-01-preview"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "tables": [
+ {
+ "columns": [
+ {
+ "dataSize": "4",
+ "dataType": "int",
+ "hasError": false,
+ "isPrimaryKey": false,
+ "name": "intField",
+ "quotedName": "[intField]"
+ },
+ {
+ "dataSize": "100",
+ "dataType": "nvarchar",
+ "hasError": false,
+ "isPrimaryKey": false,
+ "name": "charField",
+ "quotedName": "[charField]"
+ }
+ ],
+ "errorId": "Schema_TableHasNoPrimaryKey",
+ "hasError": true,
+ "name": "dbo.myTable",
+ "quotedName": "[dbo].[myTable]"
+ }
+ ],
+ "lastUpdateTime": "2017-05-30T07:16:08.21Z"
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2019-06-01-preview/examples/SyncGroupGetLog.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2019-06-01-preview/examples/SyncGroupGetLog.json
new file mode 100644
index 000000000000..8c3db95f2725
--- /dev/null
+++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2019-06-01-preview/examples/SyncGroupGetLog.json
@@ -0,0 +1,37 @@
+{
+ "parameters": {
+ "subscriptionId": "00000000-1111-2222-3333-444444444444",
+ "resourceGroupName": "syncgroupcrud-65440",
+ "serverName": "syncgroupcrud-8475",
+ "databaseName": "syncgroupcrud-4328",
+ "syncGroupName": "syncgroupcrud-3187",
+ "startTime": "2017-01-01T00:00:00",
+ "endTime": "2017-12-31T00:00:00",
+ "type": "All",
+ "api-version": "2019-06-01-preview"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "timestamp": "2017-05-30T07:16:08.25Z",
+ "type": "Success",
+ "source": "syncgroupcrud-8475.database.windows.net/hub",
+ "details": "Schema information obtained successfully.",
+ "tracingId": "c0480c8e-6269-424e-9404-b00efce0ebae",
+ "operationStatus": "SchemaRefreshSuccess"
+ },
+ {
+ "timestamp": "2017-05-30T07:03:37.5733333Z",
+ "type": "Error",
+ "source": "syncgroupcrud-8475.database.windows.net/member",
+ "details": "Getting schema information for the database failed with the exception \"Failed to connect to server .\nInner exception: SqlException Error Code: -2146232060 - SqlError Number:53, Message: A network-related or instance-specific error occurred while establishing a connection to SQL Server. The server was not found or was not accessible. Verify that the instance name is correct and that SQL Server is configured to allow remote connections. (provider: Named Pipes Provider, error: 40 - Could not open a connection to SQL Server) \nInner exception: The network path was not found\n For more information, provide tracing ID ‘cd3aa28c-0c31-471f-8a77-f1b21c908cbd’ to customer support.\"",
+ "tracingId": "cd3aa28c-0c31-471f-8a77-f1b21c908cbd",
+ "operationStatus": "SchemaRefreshFailure"
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2019-06-01-preview/examples/SyncGroupGetSyncDatabaseId.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2019-06-01-preview/examples/SyncGroupGetSyncDatabaseId.json
new file mode 100644
index 000000000000..73987d320296
--- /dev/null
+++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2019-06-01-preview/examples/SyncGroupGetSyncDatabaseId.json
@@ -0,0 +1,18 @@
+{
+ "parameters": {
+ "subscriptionId": "00000000-1111-2222-3333-444444444444",
+ "locationName": "westus",
+ "api-version": "2019-06-01-preview"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-3521/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328"
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2019-06-01-preview/examples/SyncGroupListByDatabase.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2019-06-01-preview/examples/SyncGroupListByDatabase.json
new file mode 100644
index 000000000000..4b6924abcdd7
--- /dev/null
+++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2019-06-01-preview/examples/SyncGroupListByDatabase.json
@@ -0,0 +1,45 @@
+{
+ "parameters": {
+ "subscriptionId": "00000000-1111-2222-3333-444444444444",
+ "resourceGroupName": "syncgroupcrud-65440",
+ "serverName": "syncgroupcrud-8475",
+ "databaseName": "syncgroupcrud-4328",
+ "api-version": "2019-06-01-preview"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "properties": {
+ "interval": -1,
+ "lastSyncTime": "0001-01-01T08:00:00Z",
+ "conflictResolutionPolicy": "HubWin",
+ "syncDatabaseId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-3521/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328",
+ "hubDatabaseUserName": "hubUser",
+ "syncState": "NotReady",
+ "usePrivateLinkConnection": false
+ },
+ "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-3521/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328/syncGroups/syncgroupcrud-3187",
+ "name": "syncgroupcrud-3187",
+ "type": "Microsoft.Sql/servers/databases/syncGroups"
+ },
+ {
+ "properties": {
+ "interval": -1,
+ "lastSyncTime": "0001-01-01T08:00:00Z",
+ "conflictResolutionPolicy": "HubWin",
+ "syncDatabaseId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-3521/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328",
+ "hubDatabaseUserName": "hubUser",
+ "syncState": "NotReady",
+ "usePrivateLinkConnection": false
+ },
+ "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-3521/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328/syncGroups/syncgroupcrud-5374",
+ "name": "syncgroupcrud-5374",
+ "type": "Microsoft.Sql/servers/databases/syncGroups"
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2019-06-01-preview/examples/SyncGroupPatch.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2019-06-01-preview/examples/SyncGroupPatch.json
new file mode 100644
index 000000000000..9ac1bb8b2539
--- /dev/null
+++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2019-06-01-preview/examples/SyncGroupPatch.json
@@ -0,0 +1,39 @@
+{
+ "parameters": {
+ "subscriptionId": "00000000-1111-2222-3333-444444444444",
+ "resourceGroupName": "syncgroupcrud-65440",
+ "serverName": "syncgroupcrud-8475",
+ "databaseName": "syncgroupcrud-4328",
+ "syncGroupName": "syncgroupcrud-3187",
+ "api-version": "2019-06-01-preview",
+ "parameters": {
+ "properties": {
+ "interval": -1,
+ "conflictResolutionPolicy": "HubWin",
+ "syncDatabaseId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-3521/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328",
+ "hubDatabaseUserName": "hubUser",
+ "hubDatabasePassword": "hubPassword",
+ "usePrivateLinkConnection": false
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "properties": {
+ "interval": -1,
+ "lastSyncTime": "0001-01-01T08:00:00Z",
+ "conflictResolutionPolicy": "HubWin",
+ "syncDatabaseId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-3521/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328",
+ "hubDatabaseUserName": "hubUser",
+ "syncState": "NotReady",
+ "usePrivateLinkConnection": false
+ },
+ "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-3521/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328/syncGroups/syncgroupcrud-3187",
+ "name": "syncgroup",
+ "type": "Microsoft.Sql/servers/databases/syncGroups"
+ }
+ },
+ "202": {}
+ }
+}
diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2019-06-01-preview/examples/SyncGroupRefreshHubSchema.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2019-06-01-preview/examples/SyncGroupRefreshHubSchema.json
new file mode 100644
index 000000000000..a81b4f0950db
--- /dev/null
+++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2019-06-01-preview/examples/SyncGroupRefreshHubSchema.json
@@ -0,0 +1,14 @@
+{
+ "parameters": {
+ "subscriptionId": "00000000-1111-2222-3333-444444444444",
+ "resourceGroupName": "syncgroupcrud-65440",
+ "serverName": "syncgroupcrud-8475",
+ "databaseName": "syncgroupcrud-4328",
+ "syncGroupName": "syncgroupcrud-3187",
+ "api-version": "2019-06-01-preview"
+ },
+ "responses": {
+ "200": {},
+ "202": {}
+ }
+}
diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2019-06-01-preview/examples/SyncGroupTriggerSync.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2019-06-01-preview/examples/SyncGroupTriggerSync.json
new file mode 100644
index 000000000000..48b0b1dad5ee
--- /dev/null
+++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2019-06-01-preview/examples/SyncGroupTriggerSync.json
@@ -0,0 +1,13 @@
+{
+ "parameters": {
+ "subscriptionId": "00000000-1111-2222-3333-444444444444",
+ "resourceGroupName": "syncgroupcrud-65440",
+ "serverName": "syncgroupcrud-8475",
+ "databaseName": "syncgroupcrud-4328",
+ "syncGroupName": "syncgroupcrud-3187",
+ "api-version": "2019-06-01-preview"
+ },
+ "responses": {
+ "200": {}
+ }
+}
diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2019-06-01-preview/examples/SyncGroupUpdate.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2019-06-01-preview/examples/SyncGroupUpdate.json
new file mode 100644
index 000000000000..8a6f8994ec21
--- /dev/null
+++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2019-06-01-preview/examples/SyncGroupUpdate.json
@@ -0,0 +1,54 @@
+{
+ "parameters": {
+ "subscriptionId": "00000000-1111-2222-3333-444444444444",
+ "resourceGroupName": "syncgroupcrud-65440",
+ "serverName": "syncgroupcrud-8475",
+ "databaseName": "syncgroupcrud-4328",
+ "syncGroupName": "syncgroupcrud-3187",
+ "api-version": "2019-06-01-preview",
+ "parameters": {
+ "properties": {
+ "interval": -1,
+ "conflictResolutionPolicy": "HubWin",
+ "syncDatabaseId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-3521/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328",
+ "hubDatabaseUserName": "hubUser",
+ "usePrivateLinkConnection": false
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "properties": {
+ "interval": -1,
+ "lastSyncTime": "0001-01-01T08:00:00Z",
+ "conflictResolutionPolicy": "HubWin",
+ "syncDatabaseId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-3521/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328",
+ "hubDatabaseUserName": "hubUser",
+ "syncState": "NotReady",
+ "usePrivateLinkConnection": false
+ },
+ "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-3521/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328/syncGroups/syncgroupcrud-3187",
+ "name": "syncgroupcrud-3187",
+ "type": "Microsoft.Sql/servers/databases/syncGroups"
+ }
+ },
+ "201": {
+ "body": {
+ "properties": {
+ "interval": -1,
+ "lastSyncTime": "0001-01-01T08:00:00Z",
+ "conflictResolutionPolicy": "HubWin",
+ "syncDatabaseId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-3521/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328",
+ "hubDatabaseUserName": "hubUser",
+ "syncState": "NotReady",
+ "usePrivateLinkConnection": false
+ },
+ "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-3521/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328/syncGroups/syncgroupcrud-3187",
+ "name": "syncgroupcrud-3187",
+ "type": "Microsoft.Sql/servers/databases/syncGroups"
+ }
+ },
+ "202": {}
+ }
+}
diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2019-06-01-preview/examples/SyncMemberCreate.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2019-06-01-preview/examples/SyncMemberCreate.json
new file mode 100644
index 000000000000..1ccc734d27a2
--- /dev/null
+++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2019-06-01-preview/examples/SyncMemberCreate.json
@@ -0,0 +1,59 @@
+{
+ "parameters": {
+ "subscriptionId": "00000000-1111-2222-3333-444444444444",
+ "resourceGroupName": "syncgroupcrud-65440",
+ "serverName": "syncgroupcrud-8475",
+ "databaseName": "syncgroupcrud-4328",
+ "syncGroupName": "syncgroupcrud-3187",
+ "syncMemberName": "syncgroupcrud-4879",
+ "api-version": "2019-06-01-preview",
+ "parameters": {
+ "properties": {
+ "databaseType": "AzureSqlDatabase",
+ "serverName": "syncgroupcrud-3379.database.windows.net",
+ "databaseName": "syncgroupcrud-7421",
+ "userName": "myUser",
+ "syncDirection": "Bidirectional",
+ "usePrivateLinkConnection": true,
+ "syncMemberAzureDatabaseResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-65440/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328"
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "properties": {
+ "databaseType": "AzureSqlDatabase",
+ "serverName": "syncgroupcrud-3379.database.windows.net",
+ "databaseName": "syncgroupcrud-7421",
+ "userName": "myUser",
+ "syncDirection": "Bidirectional",
+ "syncState": "UnProvisioned",
+ "usePrivateLinkConnection": true,
+ "syncMemberAzureDatabaseResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-65440/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328"
+ },
+ "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-65440/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328/syncGroups/syncgroupcrud-3187/syncMembers/syncgroupcrud-4879",
+ "name": "syncgroupcrud-4879",
+ "type": "Microsoft.Sql/servers/databases/syncGroups/syncMembers"
+ }
+ },
+ "201": {
+ "body": {
+ "properties": {
+ "databaseType": "AzureSqlDatabase",
+ "serverName": "syncgroupcrud-3379.database.windows.net",
+ "databaseName": "syncgroupcrud-7421",
+ "userName": "myUser",
+ "syncDirection": "Bidirectional",
+ "syncState": "UnProvisioned",
+ "usePrivateLinkConnection": true,
+ "syncMemberAzureDatabaseResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-65440/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328"
+ },
+ "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-65440/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328/syncGroups/syncgroupcrud-3187/syncMembers/syncgroupcrud-4879",
+ "name": "syncgroupcrud-4879",
+ "type": "Microsoft.Sql/servers/databases/syncGroups/syncMembers"
+ }
+ },
+ "202": {}
+ }
+}
diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2019-06-01-preview/examples/SyncMemberDelete.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2019-06-01-preview/examples/SyncMemberDelete.json
new file mode 100644
index 000000000000..f6f8db22c960
--- /dev/null
+++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2019-06-01-preview/examples/SyncMemberDelete.json
@@ -0,0 +1,16 @@
+{
+ "parameters": {
+ "subscriptionId": "00000000-1111-2222-3333-444444444444",
+ "resourceGroupName": "syncgroupcrud-65440",
+ "serverName": "syncgroupcrud-8475",
+ "databaseName": "syncgroupcrud-4328",
+ "syncGroupName": "syncgroupcrud-3187",
+ "syncMemberName": "syncgroupcrud-4879",
+ "api-version": "2019-06-01-preview"
+ },
+ "responses": {
+ "200": {},
+ "202": {},
+ "204": {}
+ }
+}
diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2019-06-01-preview/examples/SyncMemberGet.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2019-06-01-preview/examples/SyncMemberGet.json
new file mode 100644
index 000000000000..8a1e356bfa96
--- /dev/null
+++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2019-06-01-preview/examples/SyncMemberGet.json
@@ -0,0 +1,30 @@
+{
+ "parameters": {
+ "subscriptionId": "00000000-1111-2222-3333-444444444444",
+ "resourceGroupName": "syncgroupcrud-65440",
+ "serverName": "syncgroupcrud-8475",
+ "databaseName": "syncgroupcrud-4328",
+ "syncGroupName": "syncgroupcrud-3187",
+ "syncMemberName": "syncgroupcrud-4879",
+ "api-version": "2019-06-01-preview"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "properties": {
+ "databaseType": "AzureSqlDatabase",
+ "serverName": "syncgroupcrud-3379.database.windows.net",
+ "databaseName": "syncgroupcrud-7421",
+ "userName": "myUser",
+ "syncDirection": "Bidirectional",
+ "syncState": "UnProvisioned",
+ "usePrivateLinkConnection": true,
+ "syncMemberAzureDatabaseResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-65440/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328"
+ },
+ "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-65440/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328/syncGroups/syncgroupcrud-3187/syncMembers/syncgroupcrud-4879",
+ "name": "syncgroupcrud-4879",
+ "type": "Microsoft.Sql/servers/databases/syncGroups/syncMembers"
+ }
+ }
+ }
+}
diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2019-06-01-preview/examples/SyncMemberGetSchema.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2019-06-01-preview/examples/SyncMemberGetSchema.json
new file mode 100644
index 000000000000..3cf3816fd255
--- /dev/null
+++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2019-06-01-preview/examples/SyncMemberGetSchema.json
@@ -0,0 +1,48 @@
+{
+ "parameters": {
+ "subscriptionId": "00000000-1111-2222-3333-444444444444",
+ "resourceGroupName": "syncgroupcrud-65440",
+ "serverName": "syncgroupcrud-8475",
+ "databaseName": "syncgroupcrud-4328",
+ "syncGroupName": "syncgroupcrud-3187",
+ "syncMemberName": "syncgroupcrud-4879",
+ "api-version": "2019-06-01-preview"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "tables": [
+ {
+ "columns": [
+ {
+ "dataSize": "4",
+ "dataType": "int",
+ "hasError": false,
+ "isPrimaryKey": false,
+ "name": "intField",
+ "quotedName": "[intField]"
+ },
+ {
+ "dataSize": "100",
+ "dataType": "nvarchar",
+ "hasError": false,
+ "isPrimaryKey": false,
+ "name": "charField",
+ "quotedName": "[charField]"
+ }
+ ],
+ "errorId": "Schema_TableHasNoPrimaryKey",
+ "hasError": true,
+ "name": "dbo.myTable",
+ "quotedName": "[dbo].[myTable]"
+ }
+ ],
+ "lastUpdateTime": "2017-05-30T07:16:08.21Z"
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2019-06-01-preview/examples/SyncMemberListBySyncGroup.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2019-06-01-preview/examples/SyncMemberListBySyncGroup.json
new file mode 100644
index 000000000000..11497c9e4d7d
--- /dev/null
+++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2019-06-01-preview/examples/SyncMemberListBySyncGroup.json
@@ -0,0 +1,33 @@
+{
+ "parameters": {
+ "subscriptionId": "00000000-1111-2222-3333-444444444444",
+ "resourceGroupName": "syncgroupcrud-65440",
+ "serverName": "syncgroupcrud-8475",
+ "databaseName": "syncgroupcrud-4328",
+ "syncGroupName": "syncgroupcrud-3187",
+ "api-version": "2019-06-01-preview"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "properties": {
+ "databaseType": "AzureSqlDatabase",
+ "serverName": "syncgroupcrud-3379.database.windows.net",
+ "databaseName": "syncgroupcrud-7421",
+ "userName": "myUser",
+ "syncDirection": "Bidirectional",
+ "syncState": "UnProvisioned",
+ "usePrivateLinkConnection": true,
+ "syncMemberAzureDatabaseResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-65440/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328"
+ },
+ "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-65440/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328/syncGroups/syncgroupcrud-3187/syncMembers/syncgroupcrud-4879",
+ "name": "syncgroupcrud-4879",
+ "type": "Microsoft.Sql/servers/databases/syncGroups/syncMembers"
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2019-06-01-preview/examples/SyncMemberPatch.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2019-06-01-preview/examples/SyncMemberPatch.json
new file mode 100644
index 000000000000..1746bb5774c7
--- /dev/null
+++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2019-06-01-preview/examples/SyncMemberPatch.json
@@ -0,0 +1,42 @@
+{
+ "parameters": {
+ "subscriptionId": "00000000-1111-2222-3333-444444444444",
+ "resourceGroupName": "syncgroupcrud-65440",
+ "serverName": "syncgroupcrud-8475",
+ "databaseName": "syncgroupcrud-4328",
+ "syncGroupName": "syncgroupcrud-3187",
+ "syncMemberName": "syncgroupcrud-4879",
+ "api-version": "2019-06-01-preview",
+ "parameters": {
+ "properties": {
+ "databaseType": "AzureSqlDatabase",
+ "serverName": "syncgroupcrud-3379.database.windows.net",
+ "databaseName": "syncgroupcrud-7421",
+ "userName": "myUser",
+ "syncDirection": "Bidirectional",
+ "usePrivateLinkConnection": true,
+ "syncMemberAzureDatabaseResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-65440/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328"
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "properties": {
+ "databaseType": "AzureSqlDatabase",
+ "serverName": "syncgroupcrud-3379.database.windows.net",
+ "databaseName": "syncgroupcrud-7421",
+ "userName": "myUser",
+ "syncDirection": "Bidirectional",
+ "syncState": "UnProvisioned",
+ "usePrivateLinkConnection": true,
+ "syncMemberAzureDatabaseResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-65440/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328"
+ },
+ "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-65440/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328/syncGroups/syncgroupcrud-3187/syncMembers/syncgroupcrud-4879",
+ "name": "syncgroupcrud-4879",
+ "type": "Microsoft.Sql/servers/databases/syncGroups/syncMembers"
+ }
+ },
+ "202": {}
+ }
+}
diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2019-06-01-preview/examples/SyncMemberRefreshSchema.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2019-06-01-preview/examples/SyncMemberRefreshSchema.json
new file mode 100644
index 000000000000..e1624a144833
--- /dev/null
+++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2019-06-01-preview/examples/SyncMemberRefreshSchema.json
@@ -0,0 +1,15 @@
+{
+ "parameters": {
+ "subscriptionId": "00000000-1111-2222-3333-444444444444",
+ "resourceGroupName": "syncgroupcrud-65440",
+ "serverName": "syncgroupcrud-8475",
+ "databaseName": "syncgroupcrud-4328",
+ "syncGroupName": "syncgroupcrud-3187",
+ "syncMemberName": "syncgroupcrud-4879",
+ "api-version": "2019-06-01-preview"
+ },
+ "responses": {
+ "200": {},
+ "202": {}
+ }
+}
diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2019-06-01-preview/examples/SyncMemberUpdate.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2019-06-01-preview/examples/SyncMemberUpdate.json
new file mode 100644
index 000000000000..1ccc734d27a2
--- /dev/null
+++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2019-06-01-preview/examples/SyncMemberUpdate.json
@@ -0,0 +1,59 @@
+{
+ "parameters": {
+ "subscriptionId": "00000000-1111-2222-3333-444444444444",
+ "resourceGroupName": "syncgroupcrud-65440",
+ "serverName": "syncgroupcrud-8475",
+ "databaseName": "syncgroupcrud-4328",
+ "syncGroupName": "syncgroupcrud-3187",
+ "syncMemberName": "syncgroupcrud-4879",
+ "api-version": "2019-06-01-preview",
+ "parameters": {
+ "properties": {
+ "databaseType": "AzureSqlDatabase",
+ "serverName": "syncgroupcrud-3379.database.windows.net",
+ "databaseName": "syncgroupcrud-7421",
+ "userName": "myUser",
+ "syncDirection": "Bidirectional",
+ "usePrivateLinkConnection": true,
+ "syncMemberAzureDatabaseResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-65440/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328"
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "properties": {
+ "databaseType": "AzureSqlDatabase",
+ "serverName": "syncgroupcrud-3379.database.windows.net",
+ "databaseName": "syncgroupcrud-7421",
+ "userName": "myUser",
+ "syncDirection": "Bidirectional",
+ "syncState": "UnProvisioned",
+ "usePrivateLinkConnection": true,
+ "syncMemberAzureDatabaseResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-65440/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328"
+ },
+ "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-65440/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328/syncGroups/syncgroupcrud-3187/syncMembers/syncgroupcrud-4879",
+ "name": "syncgroupcrud-4879",
+ "type": "Microsoft.Sql/servers/databases/syncGroups/syncMembers"
+ }
+ },
+ "201": {
+ "body": {
+ "properties": {
+ "databaseType": "AzureSqlDatabase",
+ "serverName": "syncgroupcrud-3379.database.windows.net",
+ "databaseName": "syncgroupcrud-7421",
+ "userName": "myUser",
+ "syncDirection": "Bidirectional",
+ "syncState": "UnProvisioned",
+ "usePrivateLinkConnection": true,
+ "syncMemberAzureDatabaseResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-65440/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328"
+ },
+ "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-65440/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328/syncGroups/syncgroupcrud-3187/syncMembers/syncgroupcrud-4879",
+ "name": "syncgroupcrud-4879",
+ "type": "Microsoft.Sql/servers/databases/syncGroups/syncMembers"
+ }
+ },
+ "202": {}
+ }
+}
diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2019-06-01-preview/managedDatabases.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2019-06-01-preview/managedDatabases.json
index 195dd2b4ce58..37b1e4031a56 100644
--- a/specification/sql/resource-manager/Microsoft.Sql/preview/2019-06-01-preview/managedDatabases.json
+++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2019-06-01-preview/managedDatabases.json
@@ -101,7 +101,7 @@
}
},
"default": {
- "description": "*** Error Responses: ***\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription."
+ "description": "*** Error Responses: ***\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found"
}
},
"x-ms-pageable": {
@@ -146,7 +146,7 @@
}
},
"default": {
- "description": "*** Error Responses: ***\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 ResourceNotFound - The requested resource was not found."
+ "description": "*** Error Responses: ***\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ResourceNotFound - The requested resource was not found."
}
},
"x-ms-examples": {
@@ -257,7 +257,7 @@
"description": "Successfully deleted the managed database."
},
"default": {
- "description": "*** Error Responses: ***\n\n * 400 CannotUseReservedDatabaseName - Cannot use reserved database name in this operation.\n\n * 400 CannotMoveOrDropJobAccountDatabase - Cannot drop database associated with job account.\n\n * 400 CannotMoveOrDropSyncMetadataDatabase - Cannot drop database used as sync metadata database.\n\n * 400 GeoReplicationDatabaseNotPrimary - The operation cannot be performed since the database '{0}' is a replication target.\n\n * 400 GeoReplicationDatabaseNotSecondary - The operation expects the database to be a replication target.\n\n * 400 ManagedInstanceUpdateSloInProgress - \"The operation could not be completed because a service tier change is in progress for managed instance '{0}.' Please wait for the operation in progress to complete and try again.\"\n\n * 400 DropDisallowedDuringFailover - Can not drop database because a failover operation is in progress on the failover group.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 ServerNotInSubscription - Specified server does not exist on the specified subscription.\n\n * 409 OperationCancelled - The operation has been cancelled by user.\n\n * 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource.\n\n * 409 ServerDisabled - Server is disabled.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout."
+ "description": "*** Error Responses: ***\n\n * 400 CannotMoveOrDropJobAccountDatabase - Cannot drop database associated with job account.\n\n * 400 CannotUseReservedDatabaseName - Cannot use reserved database name in this operation.\n\n * 400 CannotMoveOrDropSyncMetadataDatabase - Cannot drop database used as sync metadata database.\n\n * 400 GeoReplicationDatabaseNotPrimary - The operation cannot be performed since the database '{0}' is a replication target.\n\n * 400 GeoReplicationDatabaseNotSecondary - The operation expects the database to be a replication target.\n\n * 400 DropDisallowedDuringFailover - Can not drop database because a failover operation is in progress on the failover group.\n\n * 400 ManagedInstanceUpdateSloInProgress - \"The operation could not be completed because a service tier change is in progress for managed instance '{0}.' Please wait for the operation in progress to complete and try again.\"\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 ServerNotInSubscription - Specified server does not exist on the specified subscription.\n\n * 409 OperationCancelled - The operation has been cancelled by user.\n\n * 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource.\n\n * 409 ServerDisabled - Server is disabled.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout."
},
"202": {
"description": "Deleting the managed database is in progress."
@@ -313,7 +313,7 @@
}
},
"default": {
- "description": "*** Error Responses: ***\n\n * 400 PitrPointInTimeInvalid - The point in time {0} is not valid. Valid point in time range from {1} days early to now and not before source server creation time.\n\n * 400 CannotUseTrailingWhitespacesInDatabaseName - The database name validation failed.\n\n * 400 InvalidBackupRetentionPeriod - The retention days of {0} is not a valid configuration. Valid backup retention in days must be between {1} and {2}\n\n * 400 ManagedDatabaseNameInUse - Database '{0}' already exists. Choose a different database name.\n\n * 400 NoMoreSpaceInManagedInstance - The managed instance has reached its storage limit. The storage usage for the managed instance cannot exceed (%d) MBs.\n\n * 400 ManagedInstanceUpdateSloInProgress - \"The operation could not be completed because a service tier change is in progress for managed instance '{0}.' Please wait for the operation in progress to complete and try again.\"\n\n * 400 SourceDatabaseNotFound - The source database does not exist.\n\n * 400 RegionDoesNotSupportVersion - A user attempted to create a server of a specified version in a location where that server version isn't supported.\n\n * 400 PasswordNotComplex - The provided password is not complex enough.\n\n * 400 CannotUseReservedDatabaseName - Cannot use reserved database name in this operation.\n\n * 400 SubscriptionNotFound - The requested subscription was not found.\n\n * 400 InvalidServerName - Invalid server name specified.\n\n * 400 SourceServerNotFound - The server part of a source database id provided in a CreateDatabaseAsCopy API call doesn't map to an existing server.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 CurrentDatabaseSizeExceedsMaxSize - User attempted to reduce the max size for a database to a size smaller than the current usage.\n\n * 400 InvalidCollation - Collation is not recognized by the server.\n\n * 400 ServerNotFound - The requested server was not found.\n\n * 400 UnsupportedServiceName - The specified name is an invalid name because it contains one or more unsupported unicode characters.\n\n * 400 CurrentDatabaseLogSizeExceedsMaxSize - User attempted to change the database to a sku with lower max log size than the current usage.\n\n * 400 DatabaseNumberLimitReached - Maximum number of databases for SQL Database Managed Instance reached.\n\n * 400 InvalidDatabaseCreateOrUpdateRequest - The request body for the create or update database operation is invalid.\n\n * 400 InvalidResourceId - Invalid resource identifier.\n\n * 400 InvalidSourceDatabaseId - Invalid source database identifier.\n\n * 400 InvalidRestorableDroppedDatabaseId - Invalid restorable dropped database identifier\n\n * 400 MismatchingResourceGroupNameWithUrl - The provided resource group name did not match the name in the Url.\n\n * 400 MismatchingServerNameWithUrl - The provided server name did not match the name in the Url.\n\n * 400 MismatchingSubscriptionWithUrl - The provided subscription did not match the subscription in the Url.\n\n * 400 MissingCollation - Collation is required.\n\n * 400 MissingSourceDatabaseId - Missing source database identifier.\n\n * 400 MissingRestorePointInTime - Missing restore point in time\n\n * 400 MissingStorageContainerSasToken - Missing storage container SAS token\n\n * 400 MissingStorageContainerUri - Missing storage container URI\n\n * 400 RestorableDroppedDatabaseIdGivenForRestoreWithSourceDatabaseId - Cannot specify restorableDroppedDatabaseId when sourceDatabaseId is already given in restore create mode\n\n * 400 CannotUseReservedDatabaseName - Cannot use reserved database name in this operation.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 CannotFindServerCertificateWithThumbprint - Cannot find server certificate with thumbprint '{0}'. Please use PowerShell Cmdlet 'Add-AzureRmSqlManagedInstanceTransparentDataEncryptionCertificate' to create the certificate.\n\n * 404 CannotFindObject - Cannot find the object because it does not exist or you do not have permissions\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 404 ServerNotInSubscription - Specified server does not exist on the specified subscription.\n\n * 404 RestoreSourceDatabaseNotFound - Could not find database '{0}' at time '{1}' that can be restored.\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 409 RemoteDatabaseExists - The destination database name already exists on the destination server.\n\n * 409 ConflictingDatabaseOperation - There is already some operation on the database and the current operation should wait till it is done.\n\n * 409 SubscriptionDisabled - Subscription is disabled.\n\n * 409 ManagementServiceDatabaseBusy - Database '{0}' is busy with another operation. Please try your operation later.\n\n * 409 ConflictingSystemOperationInProgress - A system maintenance operation is in progress on the database and further operations need to wait until it is completed.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 500 ActivateOrDeactivateWorkflowThrottling - Activation or deactivation workflow failed because there are too many concurrent workflows\n\n * 503 DatabaseUnavailable - The operation failed because the database is unavailable.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout."
+ "description": "*** Error Responses: ***\n\n * 400 InvalidServerName - Invalid server name specified.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 ManagedInstanceUpdateSloInProgress - \"The operation could not be completed because a service tier change is in progress for managed instance '{0}.' Please wait for the operation in progress to complete and try again.\"\n\n * 400 DatabaseNumberLimitReached - Maximum number of databases for SQL Database Managed Instance reached.\n\n * 400 CurrentDatabaseSizeExceedsMaxSize - User attempted to reduce the max size for a database to a size smaller than the current usage.\n\n * 400 InvalidCollation - Collation is not recognized by the server.\n\n * 400 SourceDatabaseNotFound - The source database does not exist.\n\n * 400 PitrPointInTimeInvalid - The point in time {0} is not valid. Valid point in time range from {1} days early to now and not before source server creation time.\n\n * 400 PasswordNotComplex - The provided password is not complex enough.\n\n * 400 ManagedDatabaseNameInUse - Database '{0}' already exists. Choose a different database name.\n\n * 400 CannotUseTrailingWhitespacesInDatabaseName - The database name validation failed.\n\n * 400 NoMoreSpaceInManagedInstance - The managed instance has reached its storage limit. The storage usage for the managed instance cannot exceed (%d) MBs.\n\n * 400 InvalidBackupRetentionPeriod - The retention days of {0} is not a valid configuration. Valid backup retention in days must be between {1} and {2}\n\n * 400 RegionDoesNotSupportVersion - A user attempted to create a server of a specified version in a location where that server version isn't supported.\n\n * 400 SourceServerNotFound - The server part of a source database id provided in a CreateDatabaseAsCopy API call doesn't map to an existing server.\n\n * 400 ServerNotFound - The requested server was not found.\n\n * 400 UnsupportedServiceName - The specified name is an invalid name because it contains one or more unsupported unicode characters.\n\n * 400 CannotUseReservedDatabaseName - Cannot use reserved database name in this operation.\n\n * 400 SubscriptionNotFound - The requested subscription was not found.\n\n * 400 CurrentDatabaseLogSizeExceedsMaxSize - User attempted to change the database to a sku with lower max log size than the current usage.\n\n * 400 InvalidDatabaseCreateOrUpdateRequest - The request body for the create or update database operation is invalid.\n\n * 400 InvalidResourceId - Invalid resource identifier.\n\n * 400 InvalidSourceDatabaseId - Invalid source database identifier.\n\n * 400 InvalidRestorableDroppedDatabaseId - Invalid restorable dropped database identifier\n\n * 400 MismatchingResourceGroupNameWithUrl - The provided resource group name did not match the name in the Url.\n\n * 400 MismatchingServerNameWithUrl - The provided server name did not match the name in the Url.\n\n * 400 MismatchingSubscriptionWithUrl - The provided subscription did not match the subscription in the Url.\n\n * 400 MissingCollation - Collation is required.\n\n * 400 MissingSourceDatabaseId - Missing source database identifier.\n\n * 400 MissingRestorePointInTime - Missing restore point in time\n\n * 400 MissingStorageContainerSasToken - Missing storage container SAS token\n\n * 400 MissingStorageContainerUri - Missing storage container URI\n\n * 400 RestorableDroppedDatabaseIdGivenForRestoreWithSourceDatabaseId - Cannot specify restorableDroppedDatabaseId when sourceDatabaseId is already given in restore create mode\n\n * 400 CannotUseReservedDatabaseName - Cannot use reserved database name in this operation.\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 ServerNotInSubscription - Specified server does not exist on the specified subscription.\n\n * 404 RestoreSourceDatabaseNotFound - Could not find database '{0}' at time '{1}' that can be restored.\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 CannotFindServerCertificateWithThumbprint - Cannot find server certificate with thumbprint '{0}'. Please use PowerShell Cmdlet 'Add-AzureRmSqlManagedInstanceTransparentDataEncryptionCertificate' to create the certificate.\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 404 CannotFindObject - Cannot find the object because it does not exist or you do not have permissions\n\n * 409 RemoteDatabaseExists - The destination database name already exists on the destination server.\n\n * 409 SubscriptionDisabled - Subscription is disabled.\n\n * 409 ManagementServiceDatabaseBusy - Database '{0}' is busy with another operation. Please try your operation later.\n\n * 409 ConflictingDatabaseOperation - There is already some operation on the database and the current operation should wait till it is done.\n\n * 409 ConflictingSystemOperationInProgress - A system maintenance operation is in progress on the database and further operations need to wait until it is completed.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 500 ActivateOrDeactivateWorkflowThrottling - Activation or deactivation workflow failed because there are too many concurrent workflows\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 DatabaseUnavailable - The operation failed because the database is unavailable.\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout."
},
"202": {
"description": "Updating the managed database is in progress."
@@ -359,7 +359,7 @@
}
},
"default": {
- "description": "*** Error Responses: ***\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription."
+ "description": "*** Error Responses: ***\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found"
}
},
"x-ms-pageable": {
@@ -410,7 +410,7 @@
"description": "Successfully completed restore request."
},
"default": {
- "description": "*** Error Responses: ***\n\n * 400 InvalidDatabaseCompleteRestoreRequest - The complete database restore request is invalid\n\n * 400 InvalidDatabaseCompleteRestoreRequestLastBackupName - The last backup name is invalid\n\n * 400 InvalidIdentifier - The identifier contains NULL or an invalid unicode character.\n\n * 400 SourceDatabaseNotFound - The source database does not exist.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 UnsupportedServiceName - The specified name is an invalid name because it contains one or more unsupported unicode characters.\n\n * 400 MissingThumbprint - Can not find server certificate.\n\n * 400 PartiallyContainedDatabaseUnsupported - \"Backup for a partially contained database is not supported.\"\n\n * 400 RequiredBackupIsNotLastRestored - Migration cannot be completed because provided backup file name is not the name of the last backup file that is restored.\n\n * 400 IncompatiblePhysicalLayoutTooFewDataFiles - Database backup contains incompatible physical layout. No data files are found in the backup.\n\n * 400 IncompatiblePhysicalLayoutNonOnlineDataFilesExist - Database backup contains incompatible physical layout. Non-online data files exist.\n\n * 400 IncompatiblePhysicalLayoutWrongNumberOfLogFiles - Database backup contains incompatible physical layout. Multiple log files are not supported.\n\n * 400 IncompatiblePhysicalLayoutNonOnlineLogFilesExist - Database backup contains incompatible physical layout. Non-online log files exist.\n\n * 400 IncompatiblePhysicalLayoutTooManyNonDataLogFiles - Database backup contains incompatible physical layout. Too many non-data/log files.\n\n * 400 BackupSetNotFound - \"No backups were found to restore the database. Please contact support to restore the database.\n\n * 400 ExternalBackupAlreadySignaledToComplete - The restore request has already been signaled to complete.\n\n * 400 FullBackupNotFound - Full backup can not be found.\n\n * 400 ExternalBackupRestoreHasNotBeenStarted - The restore request can only be completed once the restore has started.\n\n * 400 ExternalBackupUpgradeInProgress - The restore request cannot be completed, since upgrade is in progress.\n\n * 400 RestoreFromStripedBackupsNotEnabled - Restoring from striped backups is not supported.\n\n * 400 BrokenRestorePlanNoFullBackup - The restore plan is broken because there is no full backup.\n\n * 400 IncompatiblePhysicalLayoutTooManyXTPFiles - Database backup contains incompatible physical layout. Multiple files found in the filegroup that contains MEMORY_OPTIMIZED_DATA.\n\n * 400 BrokenRestorePlanWrongLogBackupLSN - The restore plan is broken because firstLsn of current log backup is not <= lastLsn of next log backup.\n\n * 400 BrokenRestorePlanWrongDiffBackupLSN - The restore plan is broken because firstLsn of diff backup is not >= firstLsn of full backup.\n\n * 400 BrokenRestorePlanGapInLogBackups - The restore plan is broken because firstLsn of current log backup is not equal to lastLsn of prev log backup.\n\n * 400 XtpInitializedDuringRestore - Memory-optimized filegroup must be empty in order to be restored on General Purpose tier of SQL Database Managed Instance.\n\n * 400 FullBackupMissingChecksum - Provided full backup is missing checksum.\n\n * 400 FullBackupDamaged - Provided full backup is damaged.\n\n * 400 ManagedInstanceStorageLimitHit - The managed instance has reached its storage limit.\n\n * 404 ResourceDoesNotExist - Resource with the name '{0}' does not exist. To continue, specify a valid resource name.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources."
+ "description": "*** Error Responses: ***\n\n * 400 InvalidDatabaseCompleteRestoreRequest - The complete database restore request is invalid\n\n * 400 InvalidDatabaseCompleteRestoreRequestLastBackupName - The last backup name is invalid\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 UnsupportedServiceName - The specified name is an invalid name because it contains one or more unsupported unicode characters.\n\n * 400 SourceDatabaseNotFound - The source database does not exist.\n\n * 400 InvalidIdentifier - The identifier contains NULL or an invalid unicode character.\n\n * 400 ManagedInstanceStorageLimitHit - The managed instance has reached its storage limit.\n\n * 400 BackupSetNotFound - \"No backups were found to restore the database. Please contact support to restore the database.\n\n * 400 FullBackupNotFound - Full backup can not be found.\n\n * 400 RestoreFromStripedBackupsNotEnabled - Restoring from striped backups is not supported.\n\n * 400 BrokenRestorePlanNoFullBackup - The restore plan is broken because there is no full backup.\n\n * 400 BrokenRestorePlanWrongLogBackupLSN - The restore plan is broken because firstLsn of current log backup is not <= lastLsn of next log backup.\n\n * 400 BrokenRestorePlanWrongDiffBackupLSN - The restore plan is broken because firstLsn of diff backup is not >= firstLsn of full backup.\n\n * 400 BrokenRestorePlanGapInLogBackups - The restore plan is broken because firstLsn of current log backup is not equal to lastLsn of prev log backup.\n\n * 400 XtpInitializedDuringRestore - Memory-optimized filegroup must be empty in order to be restored on General Purpose tier of SQL Database Managed Instance.\n\n * 400 FullBackupMissingChecksum - Provided full backup is missing checksum.\n\n * 400 FullBackupDamaged - Provided full backup is damaged.\n\n * 400 PartiallyContainedDatabaseUnsupported - \"Backup for a partially contained database is not supported.\"\n\n * 400 RequiredBackupIsNotLastRestored - Migration cannot be completed because provided backup file name is not the name of the last backup file that is restored.\n\n * 400 IncompatiblePhysicalLayoutTooFewDataFiles - Database backup contains incompatible physical layout. No data files are found in the backup.\n\n * 400 IncompatiblePhysicalLayoutNonOnlineDataFilesExist - Database backup contains incompatible physical layout. Non-online data files exist.\n\n * 400 IncompatiblePhysicalLayoutWrongNumberOfLogFiles - Database backup contains incompatible physical layout. Multiple log files are not supported.\n\n * 400 IncompatiblePhysicalLayoutNonOnlineLogFilesExist - Database backup contains incompatible physical layout. Non-online log files exist.\n\n * 400 IncompatiblePhysicalLayoutTooManyNonDataLogFiles - Database backup contains incompatible physical layout. Too many non-data/log files.\n\n * 400 ExternalBackupAlreadySignaledToComplete - The restore request has already been signaled to complete.\n\n * 400 ExternalBackupRestoreHasNotBeenStarted - The restore request can only be completed once the restore has started.\n\n * 400 ExternalBackupUpgradeInProgress - The restore request cannot be completed, since upgrade is in progress.\n\n * 400 IncompatiblePhysicalLayoutTooManyXTPFiles - Database backup contains incompatible physical layout. Multiple files found in the filegroup that contains MEMORY_OPTIMIZED_DATA.\n\n * 400 BlobStorageFailure - Blob storage failure has occurred.\n\n * 400 MissingThumbprint - Can not find server certificate.\n\n * 404 ResourceDoesNotExist - Resource with the name '{0}' does not exist. To continue, specify a valid resource name.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources."
},
"202": {
"description": "Completing restore request is in progress."
@@ -606,7 +606,7 @@
]
},
"createMode": {
- "description": "Managed database create mode. PointInTimeRestore: Create a database by restoring a point in time backup of an existing database. SourceDatabaseName, SourceManagedInstanceName and PointInTime must be specified. RestoreExternalBackup: Create a database by restoring from external backup files. Collation, StorageContainerUri and StorageContainerSasToken must be specified. Recovery: Creates a database by restoring a geo-replicated backup. RecoverableDatabaseId must be specified as the recoverable database resource ID to restore.",
+ "description": "Managed database create mode. PointInTimeRestore: Create a database by restoring a point in time backup of an existing database. SourceDatabaseName, SourceManagedInstanceName and PointInTime must be specified. RestoreExternalBackup: Create a database by restoring from external backup files. Collation, StorageContainerUri and StorageContainerSasToken must be specified. Recovery: Creates a database by restoring a geo-replicated backup. RecoverableDatabaseId must be specified as the recoverable database resource ID to restore. RestoreLongTermRetentionBackup: Create a database by restoring from a long term retention backup (longTermRetentionBackupResourceId required).",
"enum": [
"Default",
"RestoreExternalBackup",
diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2019-06-01-preview/syncGroups.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2019-06-01-preview/syncGroups.json
new file mode 100644
index 000000000000..ab80ff901950
--- /dev/null
+++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2019-06-01-preview/syncGroups.json
@@ -0,0 +1,1079 @@
+{
+ "swagger": "2.0",
+ "info": {
+ "version": "2019-06-01-preview",
+ "title": "SqlManagementClient",
+ "description": "The Azure SQL Database management API provides a RESTful set of web APIs that interact with Azure SQL Database services to manage your databases. The API enables users to create, retrieve, update, and delete databases, servers, and other entities."
+ },
+ "host": "management.azure.com",
+ "schemes": [
+ "https"
+ ],
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "paths": {
+ "/subscriptions/{subscriptionId}/providers/Microsoft.Sql/locations/{locationName}/syncDatabaseIds": {
+ "get": {
+ "tags": [
+ "SyncGroups"
+ ],
+ "description": "Gets a collection of sync database ids.",
+ "operationId": "SyncGroups_ListSyncDatabaseIds",
+ "parameters": [
+ {
+ "name": "locationName",
+ "in": "path",
+ "description": "The name of the region where the resource is located.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successfully retrieved collection of sync database ids.",
+ "schema": {
+ "$ref": "#/definitions/SyncDatabaseIdListResult"
+ }
+ },
+ "default": {
+ "description": "*** Error Responses: ***\n\n * 400 InvalidSyncGroupCreateOrUpdateRequest - The create or update sync group request body is empty.\n\n * 400 InvalidSyncMemberCreateOrUpdateRequest - The create or update sync member request body is empty.\n\n * 400 InvalidSyncAgentCreateOrUpdateRequest - The create or update sync agent request body is empty.\n\n * 400 InvalidDatabaseResourceId - Invalid database resource identifier.\n\n * 400 MismatchingSubscriptionWithUrl - The provided subscription did not match the subscription in the Url.\n\n * 400 InvalidSyncAgentResourceId - Invalid sync agent resource identifier.\n\n * 400 MismatchingResourceGroupNameWithUrl - The provided resource group name did not match the name in the Url.\n\n * 400 MismatchingServerNameWithUrl - The provided server name did not match the name in the Url.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance."
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-examples": {
+ "Get a sync database ID": {
+ "$ref": "./examples/SyncGroupGetSyncDatabaseId.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/syncGroups/{syncGroupName}/refreshHubSchema": {
+ "post": {
+ "tags": [
+ "SyncGroups"
+ ],
+ "description": "Refreshes a hub database schema.",
+ "operationId": "SyncGroups_RefreshHubSchema",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ResourceGroupParameter"
+ },
+ {
+ "$ref": "#/parameters/ServerNameParameter"
+ },
+ {
+ "name": "databaseName",
+ "in": "path",
+ "description": "The name of the database on which the sync group is hosted.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "syncGroupName",
+ "in": "path",
+ "description": "The name of the sync group.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successfully refreshed a sync hub schema."
+ },
+ "default": {
+ "description": "*** Error Responses: ***\n\n * 400 InvalidSyncGroupCreateOrUpdateRequest - The create or update sync group request body is empty.\n\n * 400 InvalidSyncMemberCreateOrUpdateRequest - The create or update sync member request body is empty.\n\n * 400 InvalidSyncAgentCreateOrUpdateRequest - The create or update sync agent request body is empty.\n\n * 400 InvalidDatabaseResourceId - Invalid database resource identifier.\n\n * 400 MismatchingSubscriptionWithUrl - The provided subscription did not match the subscription in the Url.\n\n * 400 InvalidSyncAgentResourceId - Invalid sync agent resource identifier.\n\n * 400 MismatchingResourceGroupNameWithUrl - The provided resource group name did not match the name in the Url.\n\n * 400 MismatchingServerNameWithUrl - The provided server name did not match the name in the Url.\n\n * 400 InvalidSyncGroup - Sync group is invalid.\n\n * 400 InvalidSyncMetadataDatabase - Sync metadata database is invalid.\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 * 409 CannotCreateSyncGroupDueToQuotaExceeded - Cannot create sync group due to quota exceeded."
+ },
+ "202": {
+ "description": "The sync hub schema refresh operation is on going."
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "Refresh a hub database schema.": {
+ "$ref": "./examples/SyncGroupRefreshHubSchema.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/syncGroups/{syncGroupName}/hubSchemas": {
+ "get": {
+ "tags": [
+ "SyncGroups"
+ ],
+ "description": "Gets a collection of hub database schemas.",
+ "operationId": "SyncGroups_ListHubSchemas",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ResourceGroupParameter"
+ },
+ {
+ "$ref": "#/parameters/ServerNameParameter"
+ },
+ {
+ "name": "databaseName",
+ "in": "path",
+ "description": "The name of the database on which the sync group is hosted.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "syncGroupName",
+ "in": "path",
+ "description": "The name of the sync group.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successfully get a sync group hub database schema.",
+ "schema": {
+ "$ref": "#/definitions/SyncFullSchemaPropertiesListResult"
+ }
+ },
+ "default": {
+ "description": "*** Error Responses: ***\n\n * 400 InvalidSyncGroupCreateOrUpdateRequest - The create or update sync group request body is empty.\n\n * 400 InvalidSyncMemberCreateOrUpdateRequest - The create or update sync member request body is empty.\n\n * 400 InvalidSyncAgentCreateOrUpdateRequest - The create or update sync agent request body is empty.\n\n * 400 InvalidDatabaseResourceId - Invalid database resource identifier.\n\n * 400 MismatchingSubscriptionWithUrl - The provided subscription did not match the subscription in the Url.\n\n * 400 InvalidSyncAgentResourceId - Invalid sync agent resource identifier.\n\n * 400 MismatchingResourceGroupNameWithUrl - The provided resource group name did not match the name in the Url.\n\n * 400 MismatchingServerNameWithUrl - The provided server name did not match the name in the Url.\n\n * 400 InvalidSyncGroup - Sync group is invalid.\n\n * 400 InvalidSyncMetadataDatabase - Sync metadata database is invalid.\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 * 409 CannotCreateSyncGroupDueToQuotaExceeded - Cannot create sync group due to quota exceeded."
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-examples": {
+ "Get a hub database schema.": {
+ "$ref": "./examples/SyncGroupGetHubSchema.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/syncGroups/{syncGroupName}/logs": {
+ "get": {
+ "tags": [
+ "SyncGroups"
+ ],
+ "description": "Gets a collection of sync group logs.",
+ "operationId": "SyncGroups_ListLogs",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ResourceGroupParameter"
+ },
+ {
+ "$ref": "#/parameters/ServerNameParameter"
+ },
+ {
+ "name": "databaseName",
+ "in": "path",
+ "description": "The name of the database on which the sync group is hosted.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "syncGroupName",
+ "in": "path",
+ "description": "The name of the sync group.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "startTime",
+ "in": "query",
+ "description": "Get logs generated after this time.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "endTime",
+ "in": "query",
+ "description": "Get logs generated before this time.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "type",
+ "in": "query",
+ "description": "The types of logs to retrieve.",
+ "required": true,
+ "type": "string",
+ "enum": [
+ "All",
+ "Error",
+ "Warning",
+ "Success"
+ ]
+ },
+ {
+ "name": "continuationToken",
+ "in": "query",
+ "description": "The continuation token for this operation.",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successfully retrieved sync group logs.",
+ "schema": {
+ "$ref": "#/definitions/SyncGroupLogListResult"
+ }
+ },
+ "default": {
+ "description": "*** Error Responses: ***\n\n * 400 InvalidSyncGroupCreateOrUpdateRequest - The create or update sync group request body is empty.\n\n * 400 InvalidSyncMemberCreateOrUpdateRequest - The create or update sync member request body is empty.\n\n * 400 InvalidSyncAgentCreateOrUpdateRequest - The create or update sync agent request body is empty.\n\n * 400 InvalidDatabaseResourceId - Invalid database resource identifier.\n\n * 400 MismatchingSubscriptionWithUrl - The provided subscription did not match the subscription in the Url.\n\n * 400 InvalidSyncAgentResourceId - Invalid sync agent resource identifier.\n\n * 400 MismatchingResourceGroupNameWithUrl - The provided resource group name did not match the name in the Url.\n\n * 400 MismatchingServerNameWithUrl - The provided server name did not match the name in the Url.\n\n * 400 InvalidSyncGroup - Sync group is invalid.\n\n * 400 InvalidSyncMetadataDatabase - Sync metadata database is invalid.\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 * 409 CannotCreateSyncGroupDueToQuotaExceeded - Cannot create sync group due to quota exceeded."
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-examples": {
+ "Get sync group logs": {
+ "$ref": "./examples/SyncGroupGetLog.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/syncGroups/{syncGroupName}/cancelSync": {
+ "post": {
+ "tags": [
+ "SyncGroups"
+ ],
+ "description": "Cancels a sync group synchronization.",
+ "operationId": "SyncGroups_CancelSync",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ResourceGroupParameter"
+ },
+ {
+ "$ref": "#/parameters/ServerNameParameter"
+ },
+ {
+ "name": "databaseName",
+ "in": "path",
+ "description": "The name of the database on which the sync group is hosted.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "syncGroupName",
+ "in": "path",
+ "description": "The name of the sync group.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successfully cancel a sync group synchronization."
+ },
+ "default": {
+ "description": "*** Error Responses: ***\n\n * 400 InvalidSyncGroupCreateOrUpdateRequest - The create or update sync group request body is empty.\n\n * 400 InvalidSyncMemberCreateOrUpdateRequest - The create or update sync member request body is empty.\n\n * 400 InvalidSyncAgentCreateOrUpdateRequest - The create or update sync agent request body is empty.\n\n * 400 InvalidDatabaseResourceId - Invalid database resource identifier.\n\n * 400 MismatchingSubscriptionWithUrl - The provided subscription did not match the subscription in the Url.\n\n * 400 InvalidSyncAgentResourceId - Invalid sync agent resource identifier.\n\n * 400 MismatchingResourceGroupNameWithUrl - The provided resource group name did not match the name in the Url.\n\n * 400 MismatchingServerNameWithUrl - The provided server name did not match the name in the Url.\n\n * 400 InvalidSyncGroup - Sync group is invalid.\n\n * 400 InvalidSyncMetadataDatabase - Sync metadata database is invalid.\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 * 409 CannotCreateSyncGroupDueToQuotaExceeded - Cannot create sync group due to quota exceeded."
+ }
+ },
+ "x-ms-examples": {
+ "Cancel a sync group synchronization": {
+ "$ref": "./examples/SyncGroupCancelSync.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/syncGroups/{syncGroupName}/triggerSync": {
+ "post": {
+ "tags": [
+ "SyncGroups"
+ ],
+ "description": "Triggers a sync group synchronization.",
+ "operationId": "SyncGroups_TriggerSync",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ResourceGroupParameter"
+ },
+ {
+ "$ref": "#/parameters/ServerNameParameter"
+ },
+ {
+ "name": "databaseName",
+ "in": "path",
+ "description": "The name of the database on which the sync group is hosted.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "syncGroupName",
+ "in": "path",
+ "description": "The name of the sync group.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successfully triggered a sync group synchronization."
+ },
+ "default": {
+ "description": "*** Error Responses: ***\n\n * 400 InvalidSyncGroupCreateOrUpdateRequest - The create or update sync group request body is empty.\n\n * 400 InvalidSyncMemberCreateOrUpdateRequest - The create or update sync member request body is empty.\n\n * 400 InvalidSyncAgentCreateOrUpdateRequest - The create or update sync agent request body is empty.\n\n * 400 InvalidDatabaseResourceId - Invalid database resource identifier.\n\n * 400 MismatchingSubscriptionWithUrl - The provided subscription did not match the subscription in the Url.\n\n * 400 InvalidSyncAgentResourceId - Invalid sync agent resource identifier.\n\n * 400 MismatchingResourceGroupNameWithUrl - The provided resource group name did not match the name in the Url.\n\n * 400 MismatchingServerNameWithUrl - The provided server name did not match the name in the Url.\n\n * 400 InvalidSyncGroup - Sync group is invalid.\n\n * 400 InvalidSyncMetadataDatabase - Sync metadata database is invalid.\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 * 409 CannotCreateSyncGroupDueToQuotaExceeded - Cannot create sync group due to quota exceeded."
+ }
+ },
+ "x-ms-examples": {
+ "Trigger a sync group synchronization.": {
+ "$ref": "./examples/SyncGroupTriggerSync.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/syncGroups/{syncGroupName}": {
+ "get": {
+ "tags": [
+ "SyncGroups"
+ ],
+ "description": "Gets a sync group.",
+ "operationId": "SyncGroups_Get",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ResourceGroupParameter"
+ },
+ {
+ "$ref": "#/parameters/ServerNameParameter"
+ },
+ {
+ "name": "databaseName",
+ "in": "path",
+ "description": "The name of the database on which the sync group is hosted.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "syncGroupName",
+ "in": "path",
+ "description": "The name of the sync group.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successfully retrieved the specified sync group.",
+ "schema": {
+ "$ref": "#/definitions/SyncGroup"
+ }
+ },
+ "default": {
+ "description": "*** Error Responses: ***\n\n * 400 InvalidSyncGroupCreateOrUpdateRequest - The create or update sync group request body is empty.\n\n * 400 InvalidSyncMemberCreateOrUpdateRequest - The create or update sync member request body is empty.\n\n * 400 InvalidSyncAgentCreateOrUpdateRequest - The create or update sync agent request body is empty.\n\n * 400 InvalidDatabaseResourceId - Invalid database resource identifier.\n\n * 400 MismatchingSubscriptionWithUrl - The provided subscription did not match the subscription in the Url.\n\n * 400 InvalidSyncAgentResourceId - Invalid sync agent resource identifier.\n\n * 400 MismatchingResourceGroupNameWithUrl - The provided resource group name did not match the name in the Url.\n\n * 400 MismatchingServerNameWithUrl - The provided server name did not match the name in the Url.\n\n * 400 InvalidSyncGroup - Sync group is invalid.\n\n * 400 InvalidSyncMetadataDatabase - Sync metadata database is invalid.\n\n * 404 ResourceNotFound - The requested resource was not 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 * 409 CannotCreateSyncGroupDueToQuotaExceeded - Cannot create sync group due to quota exceeded."
+ }
+ },
+ "x-ms-examples": {
+ "Get a sync group": {
+ "$ref": "./examples/SyncGroupGet.json"
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "SyncGroups"
+ ],
+ "description": "Creates or updates a sync group.",
+ "operationId": "SyncGroups_CreateOrUpdate",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ResourceGroupParameter"
+ },
+ {
+ "$ref": "#/parameters/ServerNameParameter"
+ },
+ {
+ "name": "databaseName",
+ "in": "path",
+ "description": "The name of the database on which the sync group is hosted.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "syncGroupName",
+ "in": "path",
+ "description": "The name of the sync group.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "description": "The requested sync group resource state.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/SyncGroup"
+ }
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successfully updated the sync group.",
+ "schema": {
+ "$ref": "#/definitions/SyncGroup"
+ }
+ },
+ "default": {
+ "description": "*** Error Responses: ***\n\n * 400 InvalidSyncGroupCreateOrUpdateRequest - The create or update sync group request body is empty.\n\n * 400 InvalidSyncMemberCreateOrUpdateRequest - The create or update sync member request body is empty.\n\n * 400 InvalidSyncAgentCreateOrUpdateRequest - The create or update sync agent request body is empty.\n\n * 400 InvalidDatabaseResourceId - Invalid database resource identifier.\n\n * 400 MismatchingSubscriptionWithUrl - The provided subscription did not match the subscription in the Url.\n\n * 400 InvalidSyncAgentResourceId - Invalid sync agent resource identifier.\n\n * 400 MismatchingResourceGroupNameWithUrl - The provided resource group name did not match the name in the Url.\n\n * 400 MismatchingServerNameWithUrl - The provided server name did not match the name in the Url.\n\n * 400 InvalidSyncGroup - Sync group is invalid.\n\n * 400 InvalidSyncMetadataDatabase - Sync metadata database is invalid.\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 * 409 CannotCreateSyncGroupDueToQuotaExceeded - Cannot create sync group due to quota exceeded."
+ },
+ "202": {
+ "description": "Creating or updating the sync group is in progress."
+ },
+ "201": {
+ "description": "Successfully created the sync group.",
+ "schema": {
+ "$ref": "#/definitions/SyncGroup"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "Create a sync group": {
+ "$ref": "./examples/SyncGroupCreate.json"
+ },
+ "Update a sync group": {
+ "$ref": "./examples/SyncGroupUpdate.json"
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "SyncGroups"
+ ],
+ "description": "Deletes a sync group.",
+ "operationId": "SyncGroups_Delete",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ResourceGroupParameter"
+ },
+ {
+ "$ref": "#/parameters/ServerNameParameter"
+ },
+ {
+ "name": "databaseName",
+ "in": "path",
+ "description": "The name of the database on which the sync group is hosted.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "syncGroupName",
+ "in": "path",
+ "description": "The name of the sync group.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successfully deleted the sync group."
+ },
+ "default": {
+ "description": "*** Error Responses: ***\n\n * 400 InvalidSyncGroupCreateOrUpdateRequest - The create or update sync group request body is empty.\n\n * 400 InvalidSyncMemberCreateOrUpdateRequest - The create or update sync member request body is empty.\n\n * 400 InvalidSyncAgentCreateOrUpdateRequest - The create or update sync agent request body is empty.\n\n * 400 InvalidDatabaseResourceId - Invalid database resource identifier.\n\n * 400 MismatchingSubscriptionWithUrl - The provided subscription did not match the subscription in the Url.\n\n * 400 InvalidSyncAgentResourceId - Invalid sync agent resource identifier.\n\n * 400 MismatchingResourceGroupNameWithUrl - The provided resource group name did not match the name in the Url.\n\n * 400 MismatchingServerNameWithUrl - The provided server name did not match the name in the Url.\n\n * 400 InvalidSyncGroup - Sync group is invalid.\n\n * 400 InvalidSyncMetadataDatabase - Sync metadata database is invalid.\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 * 409 CannotCreateSyncGroupDueToQuotaExceeded - Cannot create sync group due to quota exceeded."
+ },
+ "202": {
+ "description": "Deleting the sync group is in progress."
+ },
+ "204": {
+ "description": "The specified sync group does not exist."
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "Delete a sync group": {
+ "$ref": "./examples/SyncGroupDelete.json"
+ }
+ }
+ },
+ "patch": {
+ "tags": [
+ "SyncGroups"
+ ],
+ "description": "Updates a sync group.",
+ "operationId": "SyncGroups_Update",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ResourceGroupParameter"
+ },
+ {
+ "$ref": "#/parameters/ServerNameParameter"
+ },
+ {
+ "name": "databaseName",
+ "in": "path",
+ "description": "The name of the database on which the sync group is hosted.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "syncGroupName",
+ "in": "path",
+ "description": "The name of the sync group.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "description": "The requested sync group resource state.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/SyncGroup"
+ }
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successfully updated the sync group.",
+ "schema": {
+ "$ref": "#/definitions/SyncGroup"
+ }
+ },
+ "default": {
+ "description": "*** Error Responses: ***\n\n * 400 InvalidSyncGroupCreateOrUpdateRequest - The create or update sync group request body is empty.\n\n * 400 InvalidSyncMemberCreateOrUpdateRequest - The create or update sync member request body is empty.\n\n * 400 InvalidSyncAgentCreateOrUpdateRequest - The create or update sync agent request body is empty.\n\n * 400 InvalidDatabaseResourceId - Invalid database resource identifier.\n\n * 400 MismatchingSubscriptionWithUrl - The provided subscription did not match the subscription in the Url.\n\n * 400 InvalidSyncAgentResourceId - Invalid sync agent resource identifier.\n\n * 400 MismatchingResourceGroupNameWithUrl - The provided resource group name did not match the name in the Url.\n\n * 400 MismatchingServerNameWithUrl - The provided server name did not match the name in the Url.\n\n * 400 InvalidSyncGroup - Sync group is invalid.\n\n * 400 InvalidSyncMetadataDatabase - Sync metadata database is invalid.\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 * 409 CannotCreateSyncGroupDueToQuotaExceeded - Cannot create sync group due to quota exceeded."
+ },
+ "202": {
+ "description": "Updating the sync group is in progress."
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "Update a sync group": {
+ "$ref": "./examples/SyncGroupPatch.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/syncGroups": {
+ "get": {
+ "tags": [
+ "SyncGroups"
+ ],
+ "description": "Lists sync groups under a hub database.",
+ "operationId": "SyncGroups_ListByDatabase",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ResourceGroupParameter"
+ },
+ {
+ "$ref": "#/parameters/ServerNameParameter"
+ },
+ {
+ "name": "databaseName",
+ "in": "path",
+ "description": "The name of the database on which the sync group is hosted.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successfully retrieved the list of sync groups.",
+ "schema": {
+ "$ref": "#/definitions/SyncGroupListResult"
+ }
+ },
+ "default": {
+ "description": "*** Error Responses: ***\n\n * 400 InvalidSyncGroupCreateOrUpdateRequest - The create or update sync group request body is empty.\n\n * 400 InvalidSyncMemberCreateOrUpdateRequest - The create or update sync member request body is empty.\n\n * 400 InvalidSyncAgentCreateOrUpdateRequest - The create or update sync agent request body is empty.\n\n * 400 InvalidDatabaseResourceId - Invalid database resource identifier.\n\n * 400 MismatchingSubscriptionWithUrl - The provided subscription did not match the subscription in the Url.\n\n * 400 InvalidSyncAgentResourceId - Invalid sync agent resource identifier.\n\n * 400 MismatchingResourceGroupNameWithUrl - The provided resource group name did not match the name in the Url.\n\n * 400 MismatchingServerNameWithUrl - The provided server name did not match the name in the Url.\n\n * 400 InvalidSyncGroup - Sync group is invalid.\n\n * 400 InvalidSyncMetadataDatabase - Sync metadata database is invalid.\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 * 409 CannotCreateSyncGroupDueToQuotaExceeded - Cannot create sync group due to quota exceeded."
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-examples": {
+ "List sync groups under a given database": {
+ "$ref": "./examples/SyncGroupListByDatabase.json"
+ }
+ }
+ }
+ }
+ },
+ "definitions": {
+ "SyncDatabaseIdListResult": {
+ "description": "A list of sync database ID properties.",
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "Array of results.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/SyncDatabaseIdProperties"
+ },
+ "readOnly": true
+ },
+ "nextLink": {
+ "description": "Link to retrieve next page of results.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "SyncDatabaseIdProperties": {
+ "description": "Properties of the sync database id.",
+ "type": "object",
+ "properties": {
+ "id": {
+ "description": "ARM resource id of sync database.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "SyncFullSchemaPropertiesListResult": {
+ "description": "A list of sync schema properties.",
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "Array of results.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/SyncFullSchemaProperties"
+ },
+ "readOnly": true
+ },
+ "nextLink": {
+ "description": "Link to retrieve next page of results.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "SyncFullSchemaProperties": {
+ "description": "Properties of the database full schema.",
+ "type": "object",
+ "properties": {
+ "tables": {
+ "description": "List of tables in the database full schema.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/SyncFullSchemaTable"
+ },
+ "readOnly": true
+ },
+ "lastUpdateTime": {
+ "format": "date-time",
+ "description": "Last update time of the database schema.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "SyncFullSchemaTable": {
+ "description": "Properties of the table in the database full schema.",
+ "type": "object",
+ "properties": {
+ "columns": {
+ "description": "List of columns in the table of database full schema.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/SyncFullSchemaTableColumn"
+ },
+ "readOnly": true
+ },
+ "errorId": {
+ "description": "Error id of the table.",
+ "type": "string",
+ "readOnly": true
+ },
+ "hasError": {
+ "description": "If there is error in the table.",
+ "type": "boolean",
+ "readOnly": true
+ },
+ "name": {
+ "description": "Name of the table.",
+ "type": "string",
+ "readOnly": true
+ },
+ "quotedName": {
+ "description": "Quoted name of the table.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "SyncFullSchemaTableColumn": {
+ "description": "Properties of the column in the table of database full schema.",
+ "type": "object",
+ "properties": {
+ "dataSize": {
+ "description": "Data size of the column.",
+ "type": "string",
+ "readOnly": true
+ },
+ "dataType": {
+ "description": "Data type of the column.",
+ "type": "string",
+ "readOnly": true
+ },
+ "errorId": {
+ "description": "Error id of the column.",
+ "type": "string",
+ "readOnly": true
+ },
+ "hasError": {
+ "description": "If there is error in the table.",
+ "type": "boolean",
+ "readOnly": true
+ },
+ "isPrimaryKey": {
+ "description": "If it is the primary key of the table.",
+ "type": "boolean",
+ "readOnly": true
+ },
+ "name": {
+ "description": "Name of the column.",
+ "type": "string",
+ "readOnly": true
+ },
+ "quotedName": {
+ "description": "Quoted name of the column.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "SyncGroupLogListResult": {
+ "description": "A list of sync group log properties.",
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "Array of results.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/SyncGroupLogProperties"
+ },
+ "readOnly": true
+ },
+ "nextLink": {
+ "description": "Link to retrieve next page of results.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "SyncGroupLogProperties": {
+ "description": "Properties of an Azure SQL Database sync group log.",
+ "type": "object",
+ "properties": {
+ "timestamp": {
+ "format": "date-time",
+ "description": "Timestamp of the sync group log.",
+ "type": "string",
+ "readOnly": true
+ },
+ "type": {
+ "description": "Type of the sync group log.",
+ "enum": [
+ "All",
+ "Error",
+ "Warning",
+ "Success"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "SyncGroupLogType",
+ "modelAsString": true
+ }
+ },
+ "source": {
+ "description": "Source of the sync group log.",
+ "type": "string",
+ "readOnly": true
+ },
+ "details": {
+ "description": "Details of the sync group log.",
+ "type": "string",
+ "readOnly": true
+ },
+ "tracingId": {
+ "format": "uuid",
+ "description": "TracingId of the sync group log.",
+ "type": "string",
+ "readOnly": true
+ },
+ "operationStatus": {
+ "description": "OperationStatus of the sync group log.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "SyncGroupProperties": {
+ "description": "Properties of a sync group.",
+ "type": "object",
+ "properties": {
+ "interval": {
+ "format": "int32",
+ "description": "Sync interval of the sync group.",
+ "type": "integer"
+ },
+ "lastSyncTime": {
+ "format": "date-time",
+ "description": "Last sync time of the sync group.",
+ "type": "string",
+ "readOnly": true
+ },
+ "conflictResolutionPolicy": {
+ "description": "Conflict resolution policy of the sync group.",
+ "enum": [
+ "HubWin",
+ "MemberWin"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "SyncConflictResolutionPolicy",
+ "modelAsString": true
+ }
+ },
+ "syncDatabaseId": {
+ "description": "ARM resource id of the sync database in the sync group.",
+ "type": "string"
+ },
+ "hubDatabaseUserName": {
+ "description": "User name for the sync group hub database credential.",
+ "type": "string"
+ },
+ "hubDatabasePassword": {
+ "description": "Password for the sync group hub database credential.",
+ "type": "string",
+ "x-ms-mutability": [
+ "create",
+ "update"
+ ]
+ },
+ "syncState": {
+ "description": "Sync state of the sync group.",
+ "enum": [
+ "NotReady",
+ "Error",
+ "Warning",
+ "Progressing",
+ "Good"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "SyncGroupState",
+ "modelAsString": true
+ }
+ },
+ "schema": {
+ "$ref": "#/definitions/SyncGroupSchema",
+ "description": "Sync schema of the sync group."
+ },
+ "usePrivateLinkConnection": {
+ "description": "If use private link connection is enabled.",
+ "type": "boolean"
+ }
+ }
+ },
+ "SyncGroupSchema": {
+ "description": "Properties of sync group schema.",
+ "type": "object",
+ "properties": {
+ "tables": {
+ "description": "List of tables in sync group schema.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/SyncGroupSchemaTable"
+ }
+ },
+ "masterSyncMemberName": {
+ "description": "Name of master sync member where the schema is from.",
+ "type": "string"
+ }
+ }
+ },
+ "SyncGroupSchemaTable": {
+ "description": "Properties of table in sync group schema.",
+ "type": "object",
+ "properties": {
+ "columns": {
+ "description": "List of columns in sync group schema.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/SyncGroupSchemaTableColumn"
+ }
+ },
+ "quotedName": {
+ "description": "Quoted name of sync group schema table.",
+ "type": "string"
+ }
+ }
+ },
+ "SyncGroupSchemaTableColumn": {
+ "description": "Properties of column in sync group table.",
+ "type": "object",
+ "properties": {
+ "quotedName": {
+ "description": "Quoted name of sync group table column.",
+ "type": "string"
+ },
+ "dataSize": {
+ "description": "Data size of the column.",
+ "type": "string"
+ },
+ "dataType": {
+ "description": "Data type of the column.",
+ "type": "string"
+ }
+ }
+ },
+ "SyncGroup": {
+ "description": "An Azure SQL Database sync group.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "../../../common/v1/types.json#/definitions/ProxyResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/SyncGroupProperties",
+ "description": "Resource properties.",
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "SyncGroupListResult": {
+ "description": "A list of sync groups.",
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "Array of results.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/SyncGroup"
+ },
+ "readOnly": true
+ },
+ "nextLink": {
+ "description": "Link to retrieve next page of results.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ }
+ },
+ "parameters": {
+ "SubscriptionIdParameter": {
+ "name": "subscriptionId",
+ "in": "path",
+ "description": "The subscription ID that identifies an Azure subscription.",
+ "required": true,
+ "type": "string",
+ "x-ms-parameter-location": "client"
+ },
+ "ApiVersionParameter": {
+ "name": "api-version",
+ "in": "query",
+ "description": "The API version to use for the request.",
+ "required": true,
+ "type": "string",
+ "x-ms-parameter-location": "client"
+ },
+ "ResourceGroupParameter": {
+ "name": "resourceGroupName",
+ "in": "path",
+ "description": "The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.",
+ "required": true,
+ "type": "string",
+ "x-ms-parameter-location": "method"
+ },
+ "ServerNameParameter": {
+ "name": "serverName",
+ "in": "path",
+ "description": "The name of the server.",
+ "required": true,
+ "type": "string",
+ "x-ms-parameter-location": "method"
+ },
+ "DatabaseNameParameter": {
+ "name": "databaseName",
+ "in": "path",
+ "description": "The name of the database.",
+ "required": true,
+ "type": "string",
+ "x-ms-parameter-location": "method"
+ }
+ },
+ "securityDefinitions": {
+ "azure_auth": {
+ "type": "oauth2",
+ "description": "Azure Active Directory OAuth2 Flow",
+ "flow": "implicit",
+ "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize",
+ "scopes": {
+ "user_impersonation": "impersonate your user account"
+ }
+ }
+ }
+}
diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2019-06-01-preview/syncMembers.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2019-06-01-preview/syncMembers.json
new file mode 100644
index 000000000000..ba60112d1b74
--- /dev/null
+++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2019-06-01-preview/syncMembers.json
@@ -0,0 +1,774 @@
+{
+ "swagger": "2.0",
+ "info": {
+ "version": "2019-06-01-preview",
+ "title": "SqlManagementClient",
+ "description": "The Azure SQL Database management API provides a RESTful set of web APIs that interact with Azure SQL Database services to manage your databases. The API enables users to create, retrieve, update, and delete databases, servers, and other entities."
+ },
+ "host": "management.azure.com",
+ "schemes": [
+ "https"
+ ],
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "paths": {
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/syncGroups/{syncGroupName}/syncMembers/{syncMemberName}": {
+ "get": {
+ "tags": [
+ "SyncMembers"
+ ],
+ "description": "Gets a sync member.",
+ "operationId": "SyncMembers_Get",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ResourceGroupParameter"
+ },
+ {
+ "$ref": "#/parameters/ServerNameParameter"
+ },
+ {
+ "name": "databaseName",
+ "in": "path",
+ "description": "The name of the database on which the sync group is hosted.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "syncGroupName",
+ "in": "path",
+ "description": "The name of the sync group on which the sync member is hosted.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "syncMemberName",
+ "in": "path",
+ "description": "The name of the sync member.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successfully retrieved the specified sync member.",
+ "schema": {
+ "$ref": "#/definitions/SyncMember"
+ }
+ },
+ "default": {
+ "description": "*** Error Responses: ***\n\n * 400 InvalidSyncGroupCreateOrUpdateRequest - The create or update sync group request body is empty.\n\n * 400 InvalidSyncMemberCreateOrUpdateRequest - The create or update sync member request body is empty.\n\n * 400 InvalidSyncAgentCreateOrUpdateRequest - The create or update sync agent request body is empty.\n\n * 400 InvalidDatabaseResourceId - Invalid database resource identifier.\n\n * 400 MismatchingSubscriptionWithUrl - The provided subscription did not match the subscription in the Url.\n\n * 400 InvalidSyncAgentResourceId - Invalid sync agent resource identifier.\n\n * 400 MismatchingResourceGroupNameWithUrl - The provided resource group name did not match the name in the Url.\n\n * 400 MismatchingServerNameWithUrl - The provided server name did not match the name in the Url.\n\n * 400 InvalidSyncGroup - Sync group is invalid.\n\n * 400 InvalidSyncMember - Sync member is invalid.\n\n * 400 InvalidSyncAgent - Sync agent is invalid.\n\n * 400 InvalidSyncMetadataDatabase - Sync metadata database is invalid.\n\n * 404 ResourceNotFound - The requested resource was not 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 * 409 CannotCreateSyncMemberDueToQuotaExceeded - Cannot create sync member due to quota exceeded."
+ }
+ },
+ "x-ms-examples": {
+ "Get a sync member": {
+ "$ref": "./examples/SyncMemberGet.json"
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "SyncMembers"
+ ],
+ "description": "Creates or updates a sync member.",
+ "operationId": "SyncMembers_CreateOrUpdate",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ResourceGroupParameter"
+ },
+ {
+ "$ref": "#/parameters/ServerNameParameter"
+ },
+ {
+ "name": "databaseName",
+ "in": "path",
+ "description": "The name of the database on which the sync group is hosted.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "syncGroupName",
+ "in": "path",
+ "description": "The name of the sync group on which the sync member is hosted.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "syncMemberName",
+ "in": "path",
+ "description": "The name of the sync member.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "description": "The requested sync member resource state.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/SyncMember"
+ }
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successfully updated the sync member.",
+ "schema": {
+ "$ref": "#/definitions/SyncMember"
+ }
+ },
+ "default": {
+ "description": "*** Error Responses: ***\n\n * 400 InvalidSyncGroupCreateOrUpdateRequest - The create or update sync group request body is empty.\n\n * 400 InvalidSyncMemberCreateOrUpdateRequest - The create or update sync member request body is empty.\n\n * 400 InvalidSyncAgentCreateOrUpdateRequest - The create or update sync agent request body is empty.\n\n * 400 InvalidDatabaseResourceId - Invalid database resource identifier.\n\n * 400 MismatchingSubscriptionWithUrl - The provided subscription did not match the subscription in the Url.\n\n * 400 InvalidSyncAgentResourceId - Invalid sync agent resource identifier.\n\n * 400 MismatchingResourceGroupNameWithUrl - The provided resource group name did not match the name in the Url.\n\n * 400 MismatchingServerNameWithUrl - The provided server name did not match the name in the Url.\n\n * 400 InvalidSyncGroup - Sync group is invalid.\n\n * 400 InvalidSyncMember - Sync member is invalid.\n\n * 400 InvalidSyncAgent - Sync agent is invalid.\n\n * 400 InvalidSyncMetadataDatabase - Sync metadata database is invalid.\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 * 409 CannotCreateSyncMemberDueToQuotaExceeded - Cannot create sync member due to quota exceeded."
+ },
+ "202": {
+ "description": "Creating or updating the sync member is in progress."
+ },
+ "201": {
+ "description": "Successfully created the sync member.",
+ "schema": {
+ "$ref": "#/definitions/SyncMember"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "Create a new sync member": {
+ "$ref": "./examples/SyncMemberCreate.json"
+ },
+ "Update a sync member": {
+ "$ref": "./examples/SyncMemberUpdate.json"
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "SyncMembers"
+ ],
+ "description": "Deletes a sync member.",
+ "operationId": "SyncMembers_Delete",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ResourceGroupParameter"
+ },
+ {
+ "$ref": "#/parameters/ServerNameParameter"
+ },
+ {
+ "name": "databaseName",
+ "in": "path",
+ "description": "The name of the database on which the sync group is hosted.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "syncGroupName",
+ "in": "path",
+ "description": "The name of the sync group on which the sync member is hosted.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "syncMemberName",
+ "in": "path",
+ "description": "The name of the sync member.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successfully deleted the sync member."
+ },
+ "default": {
+ "description": "*** Error Responses: ***\n\n * 400 InvalidSyncGroupCreateOrUpdateRequest - The create or update sync group request body is empty.\n\n * 400 InvalidSyncMemberCreateOrUpdateRequest - The create or update sync member request body is empty.\n\n * 400 InvalidSyncAgentCreateOrUpdateRequest - The create or update sync agent request body is empty.\n\n * 400 InvalidDatabaseResourceId - Invalid database resource identifier.\n\n * 400 MismatchingSubscriptionWithUrl - The provided subscription did not match the subscription in the Url.\n\n * 400 InvalidSyncAgentResourceId - Invalid sync agent resource identifier.\n\n * 400 MismatchingResourceGroupNameWithUrl - The provided resource group name did not match the name in the Url.\n\n * 400 MismatchingServerNameWithUrl - The provided server name did not match the name in the Url.\n\n * 400 InvalidSyncGroup - Sync group is invalid.\n\n * 400 InvalidSyncMember - Sync member is invalid.\n\n * 400 InvalidSyncAgent - Sync agent is invalid.\n\n * 400 InvalidSyncMetadataDatabase - Sync metadata database is invalid.\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 * 409 CannotCreateSyncMemberDueToQuotaExceeded - Cannot create sync member due to quota exceeded."
+ },
+ "202": {
+ "description": "Deleting the sync member is in progress."
+ },
+ "204": {
+ "description": "The specified sync member does not exist."
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "Delete a sync member": {
+ "$ref": "./examples/SyncMemberDelete.json"
+ }
+ }
+ },
+ "patch": {
+ "tags": [
+ "SyncMembers"
+ ],
+ "description": "Updates an existing sync member.",
+ "operationId": "SyncMembers_Update",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ResourceGroupParameter"
+ },
+ {
+ "$ref": "#/parameters/ServerNameParameter"
+ },
+ {
+ "name": "databaseName",
+ "in": "path",
+ "description": "The name of the database on which the sync group is hosted.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "syncGroupName",
+ "in": "path",
+ "description": "The name of the sync group on which the sync member is hosted.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "syncMemberName",
+ "in": "path",
+ "description": "The name of the sync member.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "description": "The requested sync member resource state.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/SyncMember"
+ }
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successfully updated the sync member.",
+ "schema": {
+ "$ref": "#/definitions/SyncMember"
+ }
+ },
+ "default": {
+ "description": "*** Error Responses: ***\n\n * 400 InvalidSyncGroupCreateOrUpdateRequest - The create or update sync group request body is empty.\n\n * 400 InvalidSyncMemberCreateOrUpdateRequest - The create or update sync member request body is empty.\n\n * 400 InvalidSyncAgentCreateOrUpdateRequest - The create or update sync agent request body is empty.\n\n * 400 InvalidDatabaseResourceId - Invalid database resource identifier.\n\n * 400 MismatchingSubscriptionWithUrl - The provided subscription did not match the subscription in the Url.\n\n * 400 InvalidSyncAgentResourceId - Invalid sync agent resource identifier.\n\n * 400 MismatchingResourceGroupNameWithUrl - The provided resource group name did not match the name in the Url.\n\n * 400 MismatchingServerNameWithUrl - The provided server name did not match the name in the Url.\n\n * 400 InvalidSyncGroup - Sync group is invalid.\n\n * 400 InvalidSyncMember - Sync member is invalid.\n\n * 400 InvalidSyncAgent - Sync agent is invalid.\n\n * 400 InvalidSyncMetadataDatabase - Sync metadata database is invalid.\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 * 409 CannotCreateSyncMemberDueToQuotaExceeded - Cannot create sync member due to quota exceeded."
+ },
+ "202": {
+ "description": "Updating the sync member is in progress."
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "Update an existing sync member": {
+ "$ref": "./examples/SyncMemberPatch.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/syncGroups/{syncGroupName}/syncMembers": {
+ "get": {
+ "tags": [
+ "SyncMembers"
+ ],
+ "description": "Lists sync members in the given sync group.",
+ "operationId": "SyncMembers_ListBySyncGroup",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ResourceGroupParameter"
+ },
+ {
+ "$ref": "#/parameters/ServerNameParameter"
+ },
+ {
+ "name": "databaseName",
+ "in": "path",
+ "description": "The name of the database on which the sync group is hosted.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "syncGroupName",
+ "in": "path",
+ "description": "The name of the sync group.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successfully retrieved the list of sync members.",
+ "schema": {
+ "$ref": "#/definitions/SyncMemberListResult"
+ }
+ },
+ "default": {
+ "description": "*** Error Responses: ***\n\n * 400 InvalidSyncGroupCreateOrUpdateRequest - The create or update sync group request body is empty.\n\n * 400 InvalidSyncMemberCreateOrUpdateRequest - The create or update sync member request body is empty.\n\n * 400 InvalidSyncAgentCreateOrUpdateRequest - The create or update sync agent request body is empty.\n\n * 400 InvalidDatabaseResourceId - Invalid database resource identifier.\n\n * 400 MismatchingSubscriptionWithUrl - The provided subscription did not match the subscription in the Url.\n\n * 400 InvalidSyncAgentResourceId - Invalid sync agent resource identifier.\n\n * 400 MismatchingResourceGroupNameWithUrl - The provided resource group name did not match the name in the Url.\n\n * 400 MismatchingServerNameWithUrl - The provided server name did not match the name in the Url.\n\n * 400 InvalidSyncGroup - Sync group is invalid.\n\n * 400 InvalidSyncMember - Sync member is invalid.\n\n * 400 InvalidSyncAgent - Sync agent is invalid.\n\n * 400 InvalidSyncMetadataDatabase - Sync metadata database is invalid.\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 * 409 CannotCreateSyncMemberDueToQuotaExceeded - Cannot create sync member due to quota exceeded."
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-examples": {
+ "List sync members under a sync group": {
+ "$ref": "./examples/SyncMemberListBySyncGroup.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/syncGroups/{syncGroupName}/syncMembers/{syncMemberName}/schemas": {
+ "get": {
+ "tags": [
+ "SyncMembers"
+ ],
+ "description": "Gets a sync member database schema.",
+ "operationId": "SyncMembers_ListMemberSchemas",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ResourceGroupParameter"
+ },
+ {
+ "$ref": "#/parameters/ServerNameParameter"
+ },
+ {
+ "name": "databaseName",
+ "in": "path",
+ "description": "The name of the database on which the sync group is hosted.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "syncGroupName",
+ "in": "path",
+ "description": "The name of the sync group on which the sync member is hosted.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "syncMemberName",
+ "in": "path",
+ "description": "The name of the sync member.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successfully get a sync member schema.",
+ "schema": {
+ "$ref": "#/definitions/SyncFullSchemaPropertiesListResult"
+ }
+ },
+ "default": {
+ "description": "*** Error Responses: ***\n\n * 400 InvalidSyncGroupCreateOrUpdateRequest - The create or update sync group request body is empty.\n\n * 400 InvalidSyncMemberCreateOrUpdateRequest - The create or update sync member request body is empty.\n\n * 400 InvalidSyncAgentCreateOrUpdateRequest - The create or update sync agent request body is empty.\n\n * 400 InvalidDatabaseResourceId - Invalid database resource identifier.\n\n * 400 MismatchingSubscriptionWithUrl - The provided subscription did not match the subscription in the Url.\n\n * 400 InvalidSyncAgentResourceId - Invalid sync agent resource identifier.\n\n * 400 MismatchingResourceGroupNameWithUrl - The provided resource group name did not match the name in the Url.\n\n * 400 MismatchingServerNameWithUrl - The provided server name did not match the name in the Url.\n\n * 400 InvalidSyncGroup - Sync group is invalid.\n\n * 400 InvalidSyncMember - Sync member is invalid.\n\n * 400 InvalidSyncAgent - Sync agent is invalid.\n\n * 400 InvalidSyncMetadataDatabase - Sync metadata database is invalid.\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 * 409 CannotCreateSyncMemberDueToQuotaExceeded - Cannot create sync member due to quota exceeded."
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-examples": {
+ "Get a sync member schema": {
+ "$ref": "./examples/SyncMemberGetSchema.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/syncGroups/{syncGroupName}/syncMembers/{syncMemberName}/refreshSchema": {
+ "post": {
+ "tags": [
+ "SyncMembers"
+ ],
+ "description": "Refreshes a sync member database schema.",
+ "operationId": "SyncMembers_RefreshMemberSchema",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ResourceGroupParameter"
+ },
+ {
+ "$ref": "#/parameters/ServerNameParameter"
+ },
+ {
+ "name": "databaseName",
+ "in": "path",
+ "description": "The name of the database on which the sync group is hosted.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "syncGroupName",
+ "in": "path",
+ "description": "The name of the sync group on which the sync member is hosted.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "syncMemberName",
+ "in": "path",
+ "description": "The name of the sync member.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successfully refreshed a sync member schema."
+ },
+ "default": {
+ "description": "*** Error Responses: ***\n\n * 400 InvalidSyncGroupCreateOrUpdateRequest - The create or update sync group request body is empty.\n\n * 400 InvalidSyncMemberCreateOrUpdateRequest - The create or update sync member request body is empty.\n\n * 400 InvalidSyncAgentCreateOrUpdateRequest - The create or update sync agent request body is empty.\n\n * 400 InvalidDatabaseResourceId - Invalid database resource identifier.\n\n * 400 MismatchingSubscriptionWithUrl - The provided subscription did not match the subscription in the Url.\n\n * 400 InvalidSyncAgentResourceId - Invalid sync agent resource identifier.\n\n * 400 MismatchingResourceGroupNameWithUrl - The provided resource group name did not match the name in the Url.\n\n * 400 MismatchingServerNameWithUrl - The provided server name did not match the name in the Url.\n\n * 400 InvalidSyncGroup - Sync group is invalid.\n\n * 400 InvalidSyncMember - Sync member is invalid.\n\n * 400 InvalidSyncAgent - Sync agent is invalid.\n\n * 400 InvalidSyncMetadataDatabase - Sync metadata database is invalid.\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 * 409 CannotCreateSyncMemberDueToQuotaExceeded - Cannot create sync member due to quota exceeded."
+ },
+ "202": {
+ "description": "The sync member schema refresh operation is on going."
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "Refresh a sync member database schema": {
+ "$ref": "./examples/SyncMemberRefreshSchema.json"
+ }
+ }
+ }
+ }
+ },
+ "definitions": {
+ "SyncMemberProperties": {
+ "description": "Properties of a sync member.",
+ "type": "object",
+ "properties": {
+ "databaseType": {
+ "description": "Database type of the sync member.",
+ "enum": [
+ "AzureSqlDatabase",
+ "SqlServerDatabase"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "SyncMemberDbType",
+ "modelAsString": true
+ }
+ },
+ "syncAgentId": {
+ "description": "ARM resource id of the sync agent in the sync member.",
+ "type": "string"
+ },
+ "sqlServerDatabaseId": {
+ "format": "uuid",
+ "description": "SQL Server database id of the sync member.",
+ "type": "string"
+ },
+ "syncMemberAzureDatabaseResourceId": {
+ "description": "ARM resource id of the sync member logical database, for sync members in Azure.",
+ "type": "string"
+ },
+ "usePrivateLinkConnection": {
+ "description": "Whether to use private link connection.",
+ "type": "boolean"
+ },
+ "serverName": {
+ "description": "Server name of the member database in the sync member",
+ "type": "string"
+ },
+ "databaseName": {
+ "description": "Database name of the member database in the sync member.",
+ "type": "string"
+ },
+ "userName": {
+ "description": "User name of the member database in the sync member.",
+ "type": "string"
+ },
+ "password": {
+ "description": "Password of the member database in the sync member.",
+ "type": "string",
+ "x-ms-mutability": [
+ "create",
+ "update"
+ ]
+ },
+ "syncDirection": {
+ "description": "Sync direction of the sync member.",
+ "enum": [
+ "Bidirectional",
+ "OneWayMemberToHub",
+ "OneWayHubToMember"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "SyncDirection",
+ "modelAsString": true
+ }
+ },
+ "syncState": {
+ "description": "Sync state of the sync member.",
+ "enum": [
+ "SyncInProgress",
+ "SyncSucceeded",
+ "SyncFailed",
+ "DisabledTombstoneCleanup",
+ "DisabledBackupRestore",
+ "SyncSucceededWithWarnings",
+ "SyncCancelling",
+ "SyncCancelled",
+ "UnProvisioned",
+ "Provisioning",
+ "Provisioned",
+ "ProvisionFailed",
+ "DeProvisioning",
+ "DeProvisioned",
+ "DeProvisionFailed",
+ "Reprovisioning",
+ "ReprovisionFailed",
+ "UnReprovisioned"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "SyncMemberState",
+ "modelAsString": true
+ }
+ }
+ }
+ },
+ "SyncMember": {
+ "description": "An Azure SQL Database sync member.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "../../../common/v1/types.json#/definitions/ProxyResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/SyncMemberProperties",
+ "description": "Resource properties.",
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "SyncMemberListResult": {
+ "description": "A list of Azure SQL Database sync members.",
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "Array of results.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/SyncMember"
+ },
+ "readOnly": true
+ },
+ "nextLink": {
+ "description": "Link to retrieve next page of results.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "SyncFullSchemaPropertiesListResult": {
+ "description": "A list of sync schema properties.",
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "Array of results.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/SyncFullSchemaProperties"
+ },
+ "readOnly": true
+ },
+ "nextLink": {
+ "description": "Link to retrieve next page of results.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "SyncFullSchemaProperties": {
+ "description": "Properties of the database full schema.",
+ "type": "object",
+ "properties": {
+ "tables": {
+ "description": "List of tables in the database full schema.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/SyncFullSchemaTable"
+ },
+ "readOnly": true
+ },
+ "lastUpdateTime": {
+ "format": "date-time",
+ "description": "Last update time of the database schema.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "SyncFullSchemaTable": {
+ "description": "Properties of the table in the database full schema.",
+ "type": "object",
+ "properties": {
+ "columns": {
+ "description": "List of columns in the table of database full schema.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/SyncFullSchemaTableColumn"
+ },
+ "readOnly": true
+ },
+ "errorId": {
+ "description": "Error id of the table.",
+ "type": "string",
+ "readOnly": true
+ },
+ "hasError": {
+ "description": "If there is error in the table.",
+ "type": "boolean",
+ "readOnly": true
+ },
+ "name": {
+ "description": "Name of the table.",
+ "type": "string",
+ "readOnly": true
+ },
+ "quotedName": {
+ "description": "Quoted name of the table.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "SyncFullSchemaTableColumn": {
+ "description": "Properties of the column in the table of database full schema.",
+ "type": "object",
+ "properties": {
+ "dataSize": {
+ "description": "Data size of the column.",
+ "type": "string",
+ "readOnly": true
+ },
+ "dataType": {
+ "description": "Data type of the column.",
+ "type": "string",
+ "readOnly": true
+ },
+ "errorId": {
+ "description": "Error id of the column.",
+ "type": "string",
+ "readOnly": true
+ },
+ "hasError": {
+ "description": "If there is error in the table.",
+ "type": "boolean",
+ "readOnly": true
+ },
+ "isPrimaryKey": {
+ "description": "If it is the primary key of the table.",
+ "type": "boolean",
+ "readOnly": true
+ },
+ "name": {
+ "description": "Name of the column.",
+ "type": "string",
+ "readOnly": true
+ },
+ "quotedName": {
+ "description": "Quoted name of the column.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ }
+ },
+ "parameters": {
+ "SubscriptionIdParameter": {
+ "name": "subscriptionId",
+ "in": "path",
+ "description": "The subscription ID that identifies an Azure subscription.",
+ "required": true,
+ "type": "string",
+ "x-ms-parameter-location": "client"
+ },
+ "ApiVersionParameter": {
+ "name": "api-version",
+ "in": "query",
+ "description": "The API version to use for the request.",
+ "required": true,
+ "type": "string",
+ "x-ms-parameter-location": "client"
+ },
+ "ResourceGroupParameter": {
+ "name": "resourceGroupName",
+ "in": "path",
+ "description": "The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.",
+ "required": true,
+ "type": "string",
+ "x-ms-parameter-location": "method"
+ },
+ "ServerNameParameter": {
+ "name": "serverName",
+ "in": "path",
+ "description": "The name of the server.",
+ "required": true,
+ "type": "string",
+ "x-ms-parameter-location": "method"
+ },
+ "DatabaseNameParameter": {
+ "name": "databaseName",
+ "in": "path",
+ "description": "The name of the database.",
+ "required": true,
+ "type": "string",
+ "x-ms-parameter-location": "method"
+ }
+ },
+ "securityDefinitions": {
+ "azure_auth": {
+ "type": "oauth2",
+ "description": "Azure Active Directory OAuth2 Flow",
+ "flow": "implicit",
+ "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize",
+ "scopes": {
+ "user_impersonation": "impersonate your user account"
+ }
+ }
+ }
+}
diff --git a/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/backupLongTermRetentionPolicies.json b/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/backupLongTermRetentionPolicies.json
deleted file mode 100644
index 63699e0d02b9..000000000000
--- a/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/backupLongTermRetentionPolicies.json
+++ /dev/null
@@ -1,279 +0,0 @@
-{
- "swagger": "2.0",
- "info": {
- "title": "Azure SQL Database Backup Long Term Retention Policy",
- "description": "Provides read and update functionality for Azure SQL Database backup long term retention policy",
- "version": "2014-04-01"
- },
- "host": "management.azure.com",
- "schemes": [
- "https"
- ],
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "paths": {
- "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/backupLongTermRetentionPolicies/{backupLongTermRetentionPolicyName}": {
- "get": {
- "tags": [
- "BackupLongTermRetentionPolicies"
- ],
- "operationId": "BackupLongTermRetentionPolicies_Get",
- "description": "Returns a database backup long term retention policy",
- "x-ms-examples": {
- "Get backup long term retention policy": {
- "$ref": "./examples/BackupLongTermRetentionPolicyGet.json"
- }
- },
- "parameters": [
- {
- "$ref": "../../../common/v1/types.json#/parameters/ApiVersionParameter"
- },
- {
- "$ref": "../../../common/v1/types.json#/parameters/SubscriptionIdParameter"
- },
- {
- "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupParameter"
- },
- {
- "$ref": "#/parameters/ServerNameParameter"
- },
- {
- "name": "databaseName",
- "in": "path",
- "required": true,
- "type": "string",
- "description": "The name of the database."
- },
- {
- "name": "backupLongTermRetentionPolicyName",
- "in": "path",
- "description": "The name of the backup long term retention policy",
- "required": true,
- "type": "string",
- "enum": [
- "Default"
- ],
- "x-ms-enum": {
- "name": "BackupLongTermRetentionPolicyName",
- "modelAsString": true
- }
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "schema": {
- "$ref": "#/definitions/BackupLongTermRetentionPolicy"
- }
- }
- }
- },
- "put": {
- "tags": [
- "BackupLongTermRetentionPolicies"
- ],
- "operationId": "BackupLongTermRetentionPolicies_CreateOrUpdate",
- "description": "Creates or updates a database backup long term retention policy",
- "x-ms-examples": {
- "Update backup long term retention policy": {
- "$ref": "./examples/BackupLongTermRetentionPolicyUpdate.json"
- }
- },
- "parameters": [
- {
- "$ref": "../../../common/v1/types.json#/parameters/ApiVersionParameter"
- },
- {
- "$ref": "../../../common/v1/types.json#/parameters/SubscriptionIdParameter"
- },
- {
- "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupParameter"
- },
- {
- "$ref": "#/parameters/ServerNameParameter"
- },
- {
- "name": "databaseName",
- "in": "path",
- "required": true,
- "type": "string",
- "description": "The name of the database"
- },
- {
- "name": "backupLongTermRetentionPolicyName",
- "in": "path",
- "description": "The name of the backup long term retention policy",
- "required": true,
- "type": "string",
- "enum": [
- "Default"
- ],
- "x-ms-enum": {
- "name": "BackupLongTermRetentionPolicyName",
- "modelAsString": true
- }
- },
- {
- "name": "parameters",
- "in": "body",
- "required": true,
- "schema": {
- "$ref": "#/definitions/BackupLongTermRetentionPolicy"
- },
- "description": "The required parameters to update a backup long term retention policy"
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "schema": {
- "$ref": "#/definitions/BackupLongTermRetentionPolicy"
- }
- },
- "201": {
- "description": "Created",
- "schema": {
- "$ref": "#/definitions/BackupLongTermRetentionPolicy"
- }
- },
- "202": {
- "description": "Accepted"
- }
- },
- "x-ms-long-running-operation": true
- }
- },
- "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/backupLongTermRetentionPolicies": {
- "get": {
- "tags": [
- "BackupLongTermRetentionPolicies"
- ],
- "operationId": "BackupLongTermRetentionPolicies_ListByDatabase",
- "description": "Returns a database backup long term retention policy",
- "x-ms-examples": {
- "Get backup long term retention policy": {
- "$ref": "./examples/BackupLongTermRetentionPolicyList.json"
- }
- },
- "parameters": [
- {
- "$ref": "../../../common/v1/types.json#/parameters/ApiVersionParameter"
- },
- {
- "$ref": "../../../common/v1/types.json#/parameters/SubscriptionIdParameter"
- },
- {
- "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupParameter"
- },
- {
- "$ref": "#/parameters/ServerNameParameter"
- },
- {
- "name": "databaseName",
- "in": "path",
- "required": true,
- "type": "string",
- "description": "The name of the database."
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "schema": {
- "$ref": "#/definitions/BackupLongTermRetentionPolicyListResult"
- }
- }
- },
- "x-ms-pageable": {
- "nextLinkName": null
- }
- }
- }
- },
- "definitions": {
- "BackupLongTermRetentionPolicyProperties": {
- "properties": {
- "state": {
- "type": "string",
- "description": "The status of the backup long term retention policy",
- "enum": [
- "Disabled",
- "Enabled"
- ],
- "x-ms-enum": {
- "name": "BackupLongTermRetentionPolicyState"
- }
- },
- "recoveryServicesBackupPolicyResourceId": {
- "type": "string",
- "description": "The azure recovery services backup protection policy resource id"
- }
- },
- "required": [
- "state",
- "recoveryServicesBackupPolicyResourceId"
- ],
- "description": "The properties of a backup long term retention policy"
- },
- "BackupLongTermRetentionPolicy": {
- "properties": {
- "location": {
- "type": "string",
- "readOnly": true,
- "description": "The geo-location where the resource lives"
- },
- "properties": {
- "$ref": "#/definitions/BackupLongTermRetentionPolicyProperties",
- "description": "The properties of the backup long term retention policy",
- "x-ms-client-flatten": true
- }
- },
- "allOf": [
- {
- "$ref": "../../../common/v1/types.json#/definitions/ProxyResource"
- }
- ],
- "description": "A backup long term retention policy"
- },
- "BackupLongTermRetentionPolicyListResult": {
- "properties": {
- "value": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/BackupLongTermRetentionPolicy"
- },
- "description": "The list of long-term retention policies in the database."
- }
- },
- "required": [
- "value"
- ],
- "description": "Represents the response to a list long-term retention policies request."
- }
- },
- "parameters": {
- "ServerNameParameter": {
- "name": "serverName",
- "in": "path",
- "required": true,
- "type": "string",
- "description": "The name of the server.",
- "x-ms-parameter-location": "method"
- }
- },
- "securityDefinitions": {
- "azure_auth": {
- "type": "oauth2",
- "description": "Azure Active Directory OAuth2 Flow",
- "flow": "implicit",
- "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize",
- "scopes": {
- "user_impersonation": "impersonate your user account"
- }
- }
- }
-}
diff --git a/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/backupLongTermRetentionVaults.json b/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/backupLongTermRetentionVaults.json
deleted file mode 100644
index f99b9020d32c..000000000000
--- a/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/backupLongTermRetentionVaults.json
+++ /dev/null
@@ -1,246 +0,0 @@
-{
- "swagger": "2.0",
- "info": {
- "title": "Azure SQL Server Backup Long Term Retention Vault",
- "description": "Provides read and update functionality for Azure SQL Server backup long term retention vault",
- "version": "2014-04-01"
- },
- "host": "management.azure.com",
- "schemes": [
- "https"
- ],
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "paths": {
- "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/backupLongTermRetentionVaults/{backupLongTermRetentionVaultName}": {
- "get": {
- "tags": [
- "BackupLongTermRetentionVaults"
- ],
- "operationId": "BackupLongTermRetentionVaults_Get",
- "description": "Gets a server backup long term retention vault",
- "x-ms-examples": {
- "Get backup long term retention vault": {
- "$ref": "./examples/BackupLongTermRetentionVaultGet.json"
- }
- },
- "parameters": [
- {
- "$ref": "../../../common/v1/types.json#/parameters/ApiVersionParameter"
- },
- {
- "$ref": "../../../common/v1/types.json#/parameters/SubscriptionIdParameter"
- },
- {
- "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupParameter"
- },
- {
- "$ref": "#/parameters/ServerNameParameter"
- },
- {
- "name": "backupLongTermRetentionVaultName",
- "in": "path",
- "description": "The name of the Azure SQL Server backup LongTermRetention vault",
- "required": true,
- "type": "string",
- "enum": [
- "RegisteredVault"
- ],
- "x-ms-enum": {
- "name": "BackupLongTermRetentionVaultName",
- "modelAsString": true
- }
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "schema": {
- "$ref": "#/definitions/BackupLongTermRetentionVault"
- }
- }
- }
- },
- "put": {
- "tags": [
- "BackupLongTermRetentionVaults"
- ],
- "operationId": "BackupLongTermRetentionVaults_CreateOrUpdate",
- "description": "Updates a server backup long term retention vault",
- "x-ms-examples": {
- "Update backup long term retention vault": {
- "$ref": "./examples/BackupLongTermRetentionVaultUpdate.json"
- }
- },
- "parameters": [
- {
- "$ref": "../../../common/v1/types.json#/parameters/ApiVersionParameter"
- },
- {
- "$ref": "../../../common/v1/types.json#/parameters/SubscriptionIdParameter"
- },
- {
- "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupParameter"
- },
- {
- "$ref": "#/parameters/ServerNameParameter"
- },
- {
- "name": "backupLongTermRetentionVaultName",
- "in": "path",
- "description": "The name of the backup long term retention vault",
- "required": true,
- "type": "string",
- "enum": [
- "RegisteredVault"
- ],
- "x-ms-enum": {
- "name": "BackupLongTermRetentionVaultName",
- "modelAsString": true
- }
- },
- {
- "name": "parameters",
- "in": "body",
- "required": true,
- "schema": {
- "$ref": "#/definitions/BackupLongTermRetentionVault"
- },
- "description": "The required parameters to update a backup long term retention vault"
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "schema": {
- "$ref": "#/definitions/BackupLongTermRetentionVault"
- }
- },
- "201": {
- "description": "Created",
- "schema": {
- "$ref": "#/definitions/BackupLongTermRetentionVault"
- }
- },
- "202": {
- "description": "Accepted"
- }
- },
- "x-ms-long-running-operation": true
- }
- },
- "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/backupLongTermRetentionVaults": {
- "get": {
- "tags": [
- "BackupLongTermRetentionVaults"
- ],
- "operationId": "BackupLongTermRetentionVaults_ListByServer",
- "description": "Gets server backup long term retention vaults in a server",
- "x-ms-examples": {
- "Get backup long term retention vault": {
- "$ref": "./examples/BackupLongTermRetentionVaultList.json"
- }
- },
- "parameters": [
- {
- "$ref": "../../../common/v1/types.json#/parameters/ApiVersionParameter"
- },
- {
- "$ref": "../../../common/v1/types.json#/parameters/SubscriptionIdParameter"
- },
- {
- "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupParameter"
- },
- {
- "$ref": "#/parameters/ServerNameParameter"
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "schema": {
- "$ref": "#/definitions/BackupLongTermRetentionVaultListResult"
- }
- }
- },
- "x-ms-pageable": {
- "nextLinkName": null
- }
- }
- }
- },
- "definitions": {
- "BackupLongTermRetentionVaultProperties": {
- "properties": {
- "recoveryServicesVaultResourceId": {
- "type": "string",
- "description": "The azure recovery services vault resource id"
- }
- },
- "required": [
- "recoveryServicesVaultResourceId"
- ],
- "description": "The properties of a backup long term retention vault."
- },
- "BackupLongTermRetentionVault": {
- "properties": {
- "location": {
- "type": "string",
- "readOnly": true,
- "description": "The geo-location where the resource lives"
- },
- "properties": {
- "$ref": "#/definitions/BackupLongTermRetentionVaultProperties",
- "description": "The properties of the backup long term retention vault",
- "x-ms-client-flatten": true
- }
- },
- "allOf": [
- {
- "$ref": "../../../common/v1/types.json#/definitions/ProxyResource"
- }
- ],
- "description": "A backup long term retention vault"
- },
- "BackupLongTermRetentionVaultListResult": {
- "properties": {
- "value": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/BackupLongTermRetentionVault"
- },
- "description": "The list of vaults in the server."
- }
- },
- "required": [
- "value"
- ],
- "description": "Represents the response to a list vaults request."
- }
- },
- "parameters": {
- "ServerNameParameter": {
- "name": "serverName",
- "in": "path",
- "required": true,
- "type": "string",
- "description": "The name of the server.",
- "x-ms-parameter-location": "method"
- }
- },
- "securityDefinitions": {
- "azure_auth": {
- "type": "oauth2",
- "description": "Azure Active Directory OAuth2 Flow",
- "flow": "implicit",
- "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize",
- "scopes": {
- "user_impersonation": "impersonate your user account"
- }
- }
- }
-}
diff --git a/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/examples/BackupLongTermRetentionPolicyGet.json b/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/examples/BackupLongTermRetentionPolicyGet.json
deleted file mode 100644
index 93363b068510..000000000000
--- a/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/examples/BackupLongTermRetentionPolicyGet.json
+++ /dev/null
@@ -1,24 +0,0 @@
-{
- "parameters": {
- "subscriptionId": "00000000-1111-2222-3333-444444444444",
- "resourceGroupName": "longtermretentiontest-1234",
- "serverName": "longtermretentiontest-5678",
- "databaseName": "longtermretentiontest-9012",
- "backupLongTermRetentionPolicyName": "Default",
- "api-version": "2014-04-01"
- },
- "responses": {
- "200": {
- "body": {
- "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/longtermretentiontest-1234/providers/Microsoft.Sql/servers/longtermretentiontest-5678/databases/longtermretentiontest-9012/backupLongTermRetentionPolicies/Default",
- "name": "Default",
- "type": "Microsoft.Sql/servers/databases/backupLongTermRetentionPolicies",
- "location": "Japan East",
- "properties": {
- "recoveryServicesBackupPolicyResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/longtermretentionvaulttest-1234/providers/Microsoft.RecoveryServices/vaults/testVaultabc/backupPolicies/testPolicyxyz",
- "state": "Enabled"
- }
- }
- }
- }
-}
diff --git a/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/examples/BackupLongTermRetentionPolicyList.json b/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/examples/BackupLongTermRetentionPolicyList.json
deleted file mode 100644
index 28f8c70d6fd4..000000000000
--- a/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/examples/BackupLongTermRetentionPolicyList.json
+++ /dev/null
@@ -1,28 +0,0 @@
-{
- "parameters": {
- "subscriptionId": "00000000-1111-2222-3333-444444444444",
- "resourceGroupName": "longtermretentiontest-1234",
- "serverName": "longtermretentiontest-5678",
- "databaseName": "longtermretentiontest-9012",
- "backupLongTermRetentionPolicyName": "Default",
- "api-version": "2014-04-01"
- },
- "responses": {
- "200": {
- "body": {
- "value": [
- {
- "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/longtermretentiontest-1234/providers/Microsoft.Sql/servers/longtermretentiontest-5678/databases/longtermretentiontest-9012/backupLongTermRetentionPolicies/Default",
- "name": "Default",
- "type": "Microsoft.Sql/servers/databases/backupLongTermRetentionPolicies",
- "location": "Japan East",
- "properties": {
- "recoveryServicesBackupPolicyResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/longtermretentionvaulttest-1234/providers/Microsoft.RecoveryServices/vaults/testVaultabc/backupPolicies/testPolicyxyz",
- "state": "Enabled"
- }
- }
- ]
- }
- }
- }
-}
diff --git a/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/examples/BackupLongTermRetentionPolicyUpdate.json b/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/examples/BackupLongTermRetentionPolicyUpdate.json
deleted file mode 100644
index de1cf5233a3a..000000000000
--- a/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/examples/BackupLongTermRetentionPolicyUpdate.json
+++ /dev/null
@@ -1,44 +0,0 @@
-{
- "parameters": {
- "subscriptionId": "00000000-1111-2222-3333-444444444444",
- "resourceGroupName": "longtermretentiontest-1234",
- "serverName": "longtermretentiontest-5678",
- "databaseName": "longtermretentiontest-9012",
- "backupLongTermRetentionPolicyName": "Default",
- "api-version": "2014-04-01",
- "parameters": {
- "properties": {
- "recoveryServicesBackupPolicyResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/longtermretentionvaulttest-1234/providers/Microsoft.RecoveryServices/vaults/testVaultabc/backupPolicies/testPolicyxyz",
- "state": "Enabled"
- },
- "location": "Japan East"
- }
- },
- "responses": {
- "200": {
- "body": {
- "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/longtermretentiontest-1234/providers/Microsoft.Sql/servers/longtermretentiontest-5678/databases/longtermretentiontest-9012/backupLongTermRetentionPolicies/Default",
- "name": "Default",
- "type": "Microsoft.Sql/servers/databases/backupLongTermRetentionPolicies",
- "location": "Japan East",
- "properties": {
- "recoveryServicesBackupPolicyResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/longtermretentionvaulttest-1234/providers/Microsoft.RecoveryServices/vaults/testVaultabc/backupPolicies/testPolicyxyz",
- "state": "Enabled"
- }
- }
- },
- "201": {
- "body": {
- "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/longtermretentiontest-1234/providers/Microsoft.Sql/servers/longtermretentiontest-5678/databases/longtermretentiontest-9012/backupLongTermRetentionPolicies/Default",
- "name": "Default",
- "type": "Microsoft.Sql/servers/databases/backupLongTermRetentionPolicies",
- "location": "Japan East",
- "properties": {
- "recoveryServicesBackupPolicyResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/longtermretentionvaulttest-1234/providers/Microsoft.RecoveryServices/vaults/testVaultabc/backupPolicies/testPolicyxyz",
- "state": "Enabled"
- }
- }
- },
- "202": {}
- }
-}
diff --git a/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/examples/BackupLongTermRetentionVaultGet.json b/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/examples/BackupLongTermRetentionVaultGet.json
deleted file mode 100644
index 71d522217d44..000000000000
--- a/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/examples/BackupLongTermRetentionVaultGet.json
+++ /dev/null
@@ -1,22 +0,0 @@
-{
- "parameters": {
- "subscriptionId": "00000000-1111-2222-3333-444444444444",
- "resourceGroupName": "longtermretentiontest-1234",
- "serverName": "longtermretentiontest-5678",
- "backupLongTermRetentionVaultName": "RegisteredVault",
- "api-version": "2014-04-01"
- },
- "responses": {
- "200": {
- "body": {
- "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/longtermretentiontest-1234/providers/Microsoft.Sql/servers/longtermretentiontest-5678/backupLongTermRetentionVaults/RegisteredVault",
- "name": "RegisteredVault",
- "type": "Microsoft.Sql/servers/backupLongTermRetentionVaults",
- "location": "Japan East",
- "properties": {
- "recoveryServicesVaultResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/longtermretentionvaulttest-1234/providers/Microsoft.RecoveryServices/vaults/testVaultabc"
- }
- }
- }
- }
-}
diff --git a/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/examples/BackupLongTermRetentionVaultList.json b/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/examples/BackupLongTermRetentionVaultList.json
deleted file mode 100644
index 309ca317552c..000000000000
--- a/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/examples/BackupLongTermRetentionVaultList.json
+++ /dev/null
@@ -1,25 +0,0 @@
-{
- "parameters": {
- "subscriptionId": "00000000-1111-2222-3333-444444444444",
- "resourceGroupName": "longtermretentiontest-1234",
- "serverName": "longtermretentiontest-5678",
- "api-version": "2014-04-01"
- },
- "responses": {
- "200": {
- "body": {
- "value": [
- {
- "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/longtermretentiontest-1234/providers/Microsoft.Sql/servers/longtermretentiontest-5678/backupLongTermRetentionVaults/RegisteredVault",
- "name": "RegisteredVault",
- "type": "Microsoft.Sql/servers/backupLongTermRetentionVaults",
- "location": "Japan East",
- "properties": {
- "recoveryServicesVaultResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/longtermretentionvaulttest-1234/providers/Microsoft.RecoveryServices/vaults/testVaultabc"
- }
- }
- ]
- }
- }
- }
-}
diff --git a/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/examples/BackupLongTermRetentionVaultUpdate.json b/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/examples/BackupLongTermRetentionVaultUpdate.json
deleted file mode 100644
index f6c1aadd3e9b..000000000000
--- a/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/examples/BackupLongTermRetentionVaultUpdate.json
+++ /dev/null
@@ -1,40 +0,0 @@
-{
- "parameters": {
- "subscriptionId": "00000000-1111-2222-3333-444444444444",
- "resourceGroupName": "longtermretentiontest-1234",
- "serverName": "longtermretentiontest-5678",
- "backupLongTermRetentionVaultName": "RegisteredVault",
- "api-version": "2014-04-01",
- "parameters": {
- "properties": {
- "recoveryServicesVaultResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/longtermretentiontest-5678/providers/Microsoft.RecoveryServices/vaults/testVaultabc"
- },
- "location": "Japan East"
- }
- },
- "responses": {
- "200": {
- "body": {
- "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/longtermretentiontest-1234/providers/Microsoft.Sql/servers/longtermretentiontest-5678/backupLongTermRetentionVaults/RegisteredVault",
- "name": "RegisteredVault",
- "type": "Microsoft.Sql/servers/backupLongTermRetentionVaults",
- "location": "Japan East",
- "properties": {
- "recoveryServicesVaultResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/longtermretentionvaulttest-1234/providers/Microsoft.RecoveryServices/vaults/testVaultabc"
- }
- }
- },
- "201": {
- "body": {
- "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/longtermretentiontest-1234/providers/Microsoft.Sql/servers/longtermretentiontest-5678/backupLongTermRetentionVaults/RegisteredVault",
- "name": "RegisteredVault",
- "type": "Microsoft.Sql/servers/backupLongTermRetentionVaults",
- "location": "Japan East",
- "properties": {
- "recoveryServicesVaultResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/longtermretentionvaulttest-1234/providers/Microsoft.RecoveryServices/vaults/testVaultabc"
- }
- }
- },
- "202": {}
- }
-}
diff --git a/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/examples/OperationList.json b/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/examples/OperationList.json
index 5b54c709b1f8..e2eebc1c75e7 100644
--- a/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/examples/OperationList.json
+++ b/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/examples/OperationList.json
@@ -1136,22 +1136,6 @@
"resource": "Data Warehouse Query Step",
"operation": "Get details about data warehouse query step"
}
- },
- {
- "name": "Microsoft.Sql/servers/backupLongTermRetentionVaults/read",
- "display": {
- "provider": "Microsoft SQL Database",
- "resource": "A backup long term retention vault",
- "operation": "Read a backup long term retention vault"
- }
- },
- {
- "name": "Microsoft.Sql/servers/backupLongTermRetentionVaults/write",
- "display": {
- "provider": "Microsoft SQL Database",
- "resource": "A backup long term retention vault",
- "operation": "This operation is used to register a backup long term retention vault to a server."
- }
}
]
}
diff --git a/specification/sql/resource-manager/readme.md b/specification/sql/resource-manager/readme.md
index 6aaa7bfd7c89..b67d56d4dc40 100644
--- a/specification/sql/resource-manager/readme.md
+++ b/specification/sql/resource-manager/readme.md
@@ -85,8 +85,6 @@ input-file:
- 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/syncGroups.json
-- Microsoft.Sql/preview/2015-05-01-preview/syncMembers.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
@@ -140,6 +138,8 @@ input-file:
- Microsoft.Sql/preview/2019-06-01-preview/managedDatabases.json
- Microsoft.Sql/preview/2019-06-01-preview/ServerAzureADAdministrators.json
- Microsoft.Sql/preview/2019-06-01-preview/managedInstanceOperations.json
+- Microsoft.Sql/preview/2019-06-01-preview/syncGroups.json
+- Microsoft.Sql/preview/2019-06-01-preview/syncMembers.json
# Needed when there is more than one input file
override-info:
@@ -189,8 +189,6 @@ input-file:
- 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/syncGroups.json
-- Microsoft.Sql/preview/2015-05-01-preview/syncMembers.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
@@ -241,6 +239,8 @@ input-file:
- Microsoft.Sql/preview/2019-06-01-preview/WorkloadClassifiers.json
- Microsoft.Sql/preview/2019-06-01-preview/managedDatabases.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
# Needed when there is more than one input file
override-info:
@@ -257,8 +257,6 @@ APIs must only be added to this section when the API is publicly available in at
``` yaml $(tag) == 'package-composite-v1'
input-file:
-- Microsoft.Sql/stable/2014-04-01/backupLongTermRetentionPolicies.json
-- Microsoft.Sql/stable/2014-04-01/backupLongTermRetentionVaults.json
- Microsoft.Sql/stable/2014-04-01/backups.json
- Microsoft.Sql/stable/2014-04-01/capabilities.json
- Microsoft.Sql/stable/2014-04-01/connectionPolicies.json
@@ -282,8 +280,6 @@ input-file:
- 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/syncGroups.json
-- Microsoft.Sql/preview/2015-05-01-preview/syncMembers.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
@@ -333,6 +329,8 @@ input-file:
- Microsoft.Sql/preview/2019-06-01-preview/WorkloadClassifiers.json
- Microsoft.Sql/preview/2019-06-01-preview/managedDatabases.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
# Needed when there is more than one input file
override-info:
@@ -349,8 +347,6 @@ APIs must only be added to this section when the API is publicly available in at
``` yaml $(tag) == 'package-2017-03-preview'
input-file:
-- Microsoft.Sql/stable/2014-04-01/backupLongTermRetentionPolicies.json
-- Microsoft.Sql/stable/2014-04-01/backupLongTermRetentionVaults.json
- Microsoft.Sql/stable/2014-04-01/backups.json
- Microsoft.Sql/stable/2014-04-01/capabilities.json
- Microsoft.Sql/stable/2014-04-01/checkNameAvailability.json
@@ -414,8 +410,6 @@ APIs must only be added to this section when the API is publicly available in at
``` yaml $(tag) == 'package-2015-05-preview'
input-file:
-- Microsoft.Sql/stable/2014-04-01/backupLongTermRetentionPolicies.json
-- Microsoft.Sql/stable/2014-04-01/backupLongTermRetentionVaults.json
- Microsoft.Sql/stable/2014-04-01/backups.json
- Microsoft.Sql/stable/2014-04-01/restorePoints.json
- Microsoft.Sql/stable/2014-04-01/checkNameAvailability.json
@@ -501,6 +495,8 @@ input-file:
- ./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
# Needed when there is more than one input file
override-info:
@@ -660,8 +656,6 @@ These can be regenerated by running the following PowerShell script from this re
``` yaml $(tag) == 'package-pure-2014-04'
input-file:
- ./Microsoft.Sql/stable/2014-04-01/advisors.json
- - ./Microsoft.Sql/stable/2014-04-01/backupLongTermRetentionPolicies.json
- - ./Microsoft.Sql/stable/2014-04-01/backupLongTermRetentionVaults.json
- ./Microsoft.Sql/stable/2014-04-01/backups.json
- ./Microsoft.Sql/stable/2014-04-01/capabilities.json
- ./Microsoft.Sql/stable/2014-04-01/checkNameAvailability.json
@@ -821,8 +815,6 @@ input-file:
- $(this-folder)/Microsoft.Sql/preview/2015-05-01-preview/operations.json
- $(this-folder)/Microsoft.Sql/preview/2015-05-01-preview/serverKeys.json
- $(this-folder)/Microsoft.Sql/preview/2015-05-01-preview/syncAgents.json
- - $(this-folder)/Microsoft.Sql/preview/2015-05-01-preview/syncGroups.json
- - $(this-folder)/Microsoft.Sql/preview/2015-05-01-preview/syncMembers.json
- $(this-folder)/Microsoft.Sql/preview/2015-05-01-preview/usages.json
- $(this-folder)/Microsoft.Sql/preview/2015-05-01-preview/virtualclusters.json
- $(this-folder)/Microsoft.Sql/preview/2015-05-01-preview/virtualNetworkRules.json
@@ -876,17 +868,19 @@ input-file:
- $(this-folder)/Microsoft.Sql/preview/2019-06-01-preview/managedDatabases.json
- $(this-folder)/Microsoft.Sql/preview/2019-06-01-preview/ServerAzureADAdministrators.json
- $(this-folder)/Microsoft.Sql/preview/2019-06-01-preview/managedInstanceOperations.json
+ - $(this-folder)/Microsoft.Sql/preview/2019-06-01-preview/syncGroups.json
+ - $(this-folder)/Microsoft.Sql/preview/2019-06-01-preview/syncMembers.json
- $(this-folder)/Microsoft.Sql/stable/2014-04-01/capabilities.json
- $(this-folder)/Microsoft.Sql/stable/2014-04-01/databases.json
- $(this-folder)/Microsoft.Sql/stable/2014-04-01/elasticPools.json
- $(this-folder)/Microsoft.Sql/stable/2014-04-01/recommendedElasticPools.json
- $(this-folder)/Microsoft.Sql/preview/2017-03-01-preview/renameDatabase.json
- - $(this-folder)/Microsoft.Sql/stable/2014-04-01/backupLongTermRetentionPolicies.json
- - $(this-folder)/Microsoft.Sql/stable/2014-04-01/backupLongTermRetentionVaults.json
- $(this-folder)/Microsoft.Sql/stable/2014-04-01/checkNameAvailability.json
- $(this-folder)/Microsoft.Sql/stable/2014-04-01/serverAzureADAdministrators.json
- $(this-folder)/Microsoft.Sql/preview/2015-05-01-preview/managedInstances.json
- $(this-folder)/Microsoft.Sql/preview/2015-05-01-preview/servers.json
+ - $(this-folder)/Microsoft.Sql/preview/2015-05-01-preview/syncGroups.json
+ - $(this-folder)/Microsoft.Sql/preview/2015-05-01-preview/syncMembers.json
- $(this-folder)/Microsoft.Sql/preview/2017-03-01-preview/cancelOperations.json
- $(this-folder)/Microsoft.Sql/preview/2017-03-01-preview/dataWarehouseUserActivities.json
- $(this-folder)/Microsoft.Sql/preview/2017-03-01-preview/managedDatabases.json
@@ -901,6 +895,8 @@ input-file:
- $(this-folder)/./Microsoft.Sql/preview/2019-06-01-preview/WorkloadClassifiers.json
- $(this-folder)/./Microsoft.Sql/preview/2019-06-01-preview/managedInstanceOperations.json
- $(this-folder)/./Microsoft.Sql/preview/2019-06-01-preview/ServerAzureADAdministrators.json
+ - $(this-folder)/./Microsoft.Sql/preview/2019-06-01-preview/syncGroups.json
+ - $(this-folder)/./Microsoft.Sql/preview/2019-06-01-preview/syncMembers.json
- $(this-folder)/./Microsoft.Sql/preview/2018-06-01-preview/DatabaseSecurityAlertPolicies.json
- $(this-folder)/./Microsoft.Sql/preview/2018-06-01-preview/managedDatabaseSensitivityLabels.json
- $(this-folder)/./Microsoft.Sql/preview/2018-06-01-preview/ManagedInstanceVulnerabilityAssessments.json
@@ -970,8 +966,6 @@ input-file:
- $(this-folder)/./Microsoft.Sql/preview/2015-05-01-preview/virtualclusters.json
- $(this-folder)/./Microsoft.Sql/preview/2015-05-01-preview/virtualNetworkRules.json
- $(this-folder)/./Microsoft.Sql/stable/2014-04-01/advisors.json
- - $(this-folder)/./Microsoft.Sql/stable/2014-04-01/backupLongTermRetentionPolicies.json
- - $(this-folder)/./Microsoft.Sql/stable/2014-04-01/backupLongTermRetentionVaults.json
- $(this-folder)/./Microsoft.Sql/stable/2014-04-01/backups.json
- $(this-folder)/./Microsoft.Sql/stable/2014-04-01/capabilities.json
- $(this-folder)/./Microsoft.Sql/stable/2014-04-01/checkNameAvailability.json
diff --git a/specification/storage/resource-manager/Microsoft.Storage/stable/2016-12-01/storage.json b/specification/storage/resource-manager/Microsoft.Storage/stable/2016-12-01/storage.json
index 5675ac9790fd..8a63727a08be 100644
--- a/specification/storage/resource-manager/Microsoft.Storage/stable/2016-12-01/storage.json
+++ b/specification/storage/resource-manager/Microsoft.Storage/stable/2016-12-01/storage.json
@@ -1191,6 +1191,10 @@
"f",
"s"
],
+ "x-ms-enum": {
+ "name": "signedResource",
+ "modelAsString": true
+ },
"x-ms-client-name": "Resource",
"description": "The signed services accessible with the service SAS. Possible values include: Blob (b), Container (c), File (f), Share (s)."
},
@@ -1206,6 +1210,10 @@
"u",
"p"
],
+ "x-ms-enum": {
+ "name": "Permissions",
+ "modelAsString": true
+ },
"x-ms-client-name": "Permissions",
"description": "The signed permissions for the service SAS. Possible values include: Read (r), Write (w), Delete (d), List (l), Add (a), Create (c), Update (u) and Process (p)."
},
diff --git a/specification/storage/resource-manager/Microsoft.Storage/stable/2019-06-01/blob.json b/specification/storage/resource-manager/Microsoft.Storage/stable/2019-06-01/blob.json
index 824471ca5f73..57ebabb6a0b9 100644
--- a/specification/storage/resource-manager/Microsoft.Storage/stable/2019-06-01/blob.json
+++ b/specification/storage/resource-manager/Microsoft.Storage/stable/2019-06-01/blob.json
@@ -149,6 +149,9 @@
"x-ms-examples": {
"ListContainers": {
"$ref": "./examples/BlobContainersList.json"
+ },
+ "ListDeletedContainers": {
+ "$ref": "./examples/DeletedBlobContainersList.json"
}
},
"description": "Lists all containers and does not support a prefix like data plane. Also SRP today does not return continuation token.",
@@ -176,6 +179,20 @@
"in": "query",
"type": "string",
"description": "Optional. When specified, only container names starting with the filter will be listed."
+ },
+ {
+ "name": "$include",
+ "in": "query",
+ "required": false,
+ "type": "string",
+ "enum": [
+ "deleted"
+ ],
+ "x-ms-enum": {
+ "name": "ListContainersInclude",
+ "modelAsString": true
+ },
+ "description": "Optional, used to include the properties for soft deleted blob containers."
}
],
"responses": {
@@ -800,6 +817,27 @@
"definitions": {
"ContainerProperties": {
"properties": {
+ "version": {
+ "type": "string",
+ "readOnly": true,
+ "description": "The version of the deleted blob container."
+ },
+ "deleted": {
+ "type": "boolean",
+ "readOnly": true,
+ "description": "Indicates whether the blob container was deleted."
+ },
+ "deletedTime": {
+ "type": "string",
+ "format": "date-time",
+ "readOnly": true,
+ "description": "Blob container deletion time."
+ },
+ "remainingRetentionDays": {
+ "type": "integer",
+ "readOnly": true,
+ "description": "Remaining retention days for soft deleted blob container."
+ },
"defaultEncryptionScope": {
"type": "string",
"description": "Default the container to use specified encryption scope for all writes."
diff --git a/specification/storage/resource-manager/Microsoft.Storage/stable/2019-06-01/examples/DeletedBlobContainersList.json b/specification/storage/resource-manager/Microsoft.Storage/stable/2019-06-01/examples/DeletedBlobContainersList.json
new file mode 100644
index 000000000000..eefea4e85461
--- /dev/null
+++ b/specification/storage/resource-manager/Microsoft.Storage/stable/2019-06-01/examples/DeletedBlobContainersList.json
@@ -0,0 +1,50 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "res9290",
+ "accountName": "sto1590",
+ "$include": "deleted",
+ "api-version": "2019-06-01",
+ "monitor": "true"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/res9290/providers/Microsoft.Storage/storageAccounts/sto1590/blobServices/default/containers/container1644",
+ "name": "container1644",
+ "type": "Microsoft.Storage/storageAccounts/blobServices/containers",
+ "etag": "\"0x8D589847D51C7DE\"",
+ "properties": {
+ "publicAccess": "Container",
+ "leaseStatus": "Unlocked",
+ "leaseState": "Available",
+ "lastModifiedTime": "2018-03-14T08:20:47Z",
+ "hasImmutabilityPolicy": false,
+ "hasLegalHold": false
+ }
+ },
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/res9290/providers/Microsoft.Storage/storageAccounts/sto1590/blobServices/default/containers/container4052",
+ "name": "container4052",
+ "type": "Microsoft.Storage/storageAccounts/blobServices/containers",
+ "etag": "\"0x8D589847DAB5AF9\"",
+ "properties": {
+ "publicAccess": "None",
+ "leaseStatus": "Unlocked",
+ "leaseState": "Expired",
+ "lastModifiedTime": "2018-03-14T08:20:47Z",
+ "hasImmutabilityPolicy": false,
+ "hasLegalHold": false,
+ "version": "1234567890",
+ "deleted": true,
+ "deletedTime": "2019-12-14T08:20:47Z",
+ "remainingRetentionDays": 30
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/storage/resource-manager/Microsoft.Storage/stable/2019-06-01/examples/DeletedFileSharesList.json b/specification/storage/resource-manager/Microsoft.Storage/stable/2019-06-01/examples/DeletedFileSharesList.json
new file mode 100644
index 000000000000..6cb4b6cf9987
--- /dev/null
+++ b/specification/storage/resource-manager/Microsoft.Storage/stable/2019-06-01/examples/DeletedFileSharesList.json
@@ -0,0 +1,42 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "res9290",
+ "accountName": "sto1590",
+ "$expand": "deleted",
+ "api-version": "2019-06-01",
+ "monitor": "true"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/res9290/providers/Microsoft.Storage/storageAccounts/sto1590/fileServices/default/shares/share1644_1234567890",
+ "name": "share1644",
+ "type": "Microsoft.Storage/storageAccounts/fileServices/shares",
+ "etag": "\"0x8D589847D51C7DE\"",
+ "properties": {
+ "lastModifiedTime": "2019-05-14T08:20:47Z",
+ "shareQuota": 1024,
+ "version": "1234567890",
+ "deleted": true,
+ "deletedTime": "2019-12-14T08:20:47Z",
+ "remainingRetentionDays": 30
+ }
+ },
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/res9290/providers/Microsoft.Storage/storageAccounts/sto1590/fileServices/default/shares/share4052",
+ "name": "share4052",
+ "type": "Microsoft.Storage/storageAccounts/fileServices/shares",
+ "etag": "\"0x8D589847DAB5AF9\"",
+ "properties": {
+ "lastModifiedTime": "2019-05-14T08:20:47Z",
+ "shareQuota": 1024
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/storage/resource-manager/Microsoft.Storage/stable/2019-06-01/examples/FileSharesGet_Stats.json b/specification/storage/resource-manager/Microsoft.Storage/stable/2019-06-01/examples/FileSharesGet_Stats.json
new file mode 100644
index 000000000000..a9efdd6ad550
--- /dev/null
+++ b/specification/storage/resource-manager/Microsoft.Storage/stable/2019-06-01/examples/FileSharesGet_Stats.json
@@ -0,0 +1,26 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "res9871",
+ "accountName": "sto6217",
+ "shareName": "share1634",
+ "$expand": "stats",
+ "api-version": "2019-06-01",
+ "monitor": "true"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/res9871/providers/Microsoft.Storage/storageAccounts/sto6217/fileServices/default/shares/share1634",
+ "name": "share1634",
+ "type": "Microsoft.Storage/storageAccounts/fileServices/shares",
+ "etag": "\"0x8D592D74CC20EBA\"",
+ "properties": {
+ "lastModifiedTime": "2019-05-26T05:06:14Z",
+ "shareQuota": 1024,
+ "shareUsageBytes": 652945
+ }
+ }
+ }
+ }
+}
diff --git a/specification/storage/resource-manager/Microsoft.Storage/stable/2019-06-01/examples/FileSharesPut_AccessTier.json b/specification/storage/resource-manager/Microsoft.Storage/stable/2019-06-01/examples/FileSharesPut_AccessTier.json
new file mode 100644
index 000000000000..eb6f38e058f7
--- /dev/null
+++ b/specification/storage/resource-manager/Microsoft.Storage/stable/2019-06-01/examples/FileSharesPut_AccessTier.json
@@ -0,0 +1,37 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "res346",
+ "accountName": "sto666",
+ "shareName": "share1235",
+ "api-version": "2019-06-01",
+ "monitor": "true",
+ "fileShare": {
+ "properties": {
+ "accessTier": "Hot"
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "body": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/res346/providers/Microsoft.Storage/storageAccounts/sto666/fileServices/default/shares/share1235",
+ "name": "share1235",
+ "type": "Microsoft.Storage/storageAccounts/fileServices/shares",
+ "properties": {
+ "accessTier": "Hot"
+ }
+ }
+ },
+ "200": {
+ "body": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/res346/providers/Microsoft.Storage/storageAccounts/sto666/fileServices/default/shares/share1235",
+ "name": "share1235",
+ "type": "Microsoft.Storage/storageAccounts/fileServices/shares",
+ "properties": {
+ "accessTier": "Hot"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/storage/resource-manager/Microsoft.Storage/stable/2019-06-01/examples/FileSharesPut_NFS.json b/specification/storage/resource-manager/Microsoft.Storage/stable/2019-06-01/examples/FileSharesPut_NFS.json
new file mode 100644
index 000000000000..dfc1bd7b0285
--- /dev/null
+++ b/specification/storage/resource-manager/Microsoft.Storage/stable/2019-06-01/examples/FileSharesPut_NFS.json
@@ -0,0 +1,37 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "res346",
+ "accountName": "sto666",
+ "shareName": "share1235",
+ "api-version": "2019-06-01",
+ "monitor": "true",
+ "fileShare": {
+ "properties": {
+ "enabledProtocols": "NFS"
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "body": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/res346/providers/Microsoft.Storage/storageAccounts/sto666/fileServices/default/shares/share1235",
+ "name": "share1235",
+ "type": "Microsoft.Storage/storageAccounts/fileServices/shares",
+ "properties": {
+ "enabledProtocols": "NFS"
+ }
+ }
+ },
+ "200": {
+ "body": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/res346/providers/Microsoft.Storage/storageAccounts/sto666/fileServices/default/shares/share1235",
+ "name": "share1235",
+ "type": "Microsoft.Storage/storageAccounts/fileServices/shares",
+ "properties": {
+ "enabledProtocols": "NFS"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/storage/resource-manager/Microsoft.Storage/stable/2019-06-01/examples/FileSharesRestore.json b/specification/storage/resource-manager/Microsoft.Storage/stable/2019-06-01/examples/FileSharesRestore.json
new file mode 100644
index 000000000000..0a53f017d0c0
--- /dev/null
+++ b/specification/storage/resource-manager/Microsoft.Storage/stable/2019-06-01/examples/FileSharesRestore.json
@@ -0,0 +1,17 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "res3376",
+ "accountName": "sto328",
+ "shareName": "share1249",
+ "deletedShare": {
+ "deletedShareName": "share1249",
+ "deletedShareVersion": "1234567890"
+ },
+ "api-version": "2019-06-01",
+ "monitor": "true"
+ },
+ "responses": {
+ "200": {}
+ }
+}
diff --git a/specification/storage/resource-manager/Microsoft.Storage/stable/2019-06-01/examples/QueueOperationDelete.json b/specification/storage/resource-manager/Microsoft.Storage/stable/2019-06-01/examples/QueueOperationDelete.json
new file mode 100644
index 000000000000..355ec2716a4a
--- /dev/null
+++ b/specification/storage/resource-manager/Microsoft.Storage/stable/2019-06-01/examples/QueueOperationDelete.json
@@ -0,0 +1,13 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "res3376",
+ "accountName": "sto328",
+ "queueName": "queue6185",
+ "api-version": "2019-06-01",
+ "monitor": "true"
+ },
+ "responses": {
+ "204": {}
+ }
+}
diff --git a/specification/storage/resource-manager/Microsoft.Storage/stable/2019-06-01/examples/QueueOperationGet.json b/specification/storage/resource-manager/Microsoft.Storage/stable/2019-06-01/examples/QueueOperationGet.json
new file mode 100644
index 000000000000..fad951eeeec4
--- /dev/null
+++ b/specification/storage/resource-manager/Microsoft.Storage/stable/2019-06-01/examples/QueueOperationGet.json
@@ -0,0 +1,25 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "res3376",
+ "accountName": "sto328",
+ "queueName": "queue6185",
+ "api-version": "2019-06-01",
+ "monitor": "true"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/res3376/providers/Microsoft.Storage/storageAccounts/sto328/queueServices/default/queues/queue6185",
+ "name": "queue6185",
+ "type": "Microsoft.Storage/storageAccounts/queueServices/queues",
+ "properties": {
+ "metadata": {
+ "sample1": "meta1",
+ "sample2": "meta2"
+ }
+ }
+ }
+ }
+ }
+}
diff --git a/specification/storage/resource-manager/Microsoft.Storage/stable/2019-06-01/examples/QueueOperationList.json b/specification/storage/resource-manager/Microsoft.Storage/stable/2019-06-01/examples/QueueOperationList.json
new file mode 100644
index 000000000000..9554cb861681
--- /dev/null
+++ b/specification/storage/resource-manager/Microsoft.Storage/stable/2019-06-01/examples/QueueOperationList.json
@@ -0,0 +1,40 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "res9290",
+ "accountName": "sto328",
+ "api-version": "2019-06-01",
+ "monitor": "true"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/res3376/providers/Microsoft.Storage/storageAccounts/sto328/queueServices/default/queues/queue6185",
+ "name": "queue6185",
+ "type": "Microsoft.Storage/storageAccounts/queueServices/queues",
+ "properties": {
+ "metadata": {
+ "sample1": "meta1",
+ "sample2": "meta2"
+ }
+ }
+ },
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/res3376/providers/Microsoft.Storage/storageAccounts/sto328/queueServices/default/queues/queue6186",
+ "name": "queue6186",
+ "type": "Microsoft.Storage/storageAccounts/queueServices/queues",
+ "properties": {
+ "metadata": {
+ "sample1": "meta1",
+ "sample2": "meta2"
+ }
+ }
+ }
+ ],
+ "nextLink": "https://sto1590endpoint/subscriptions/{subscription-id}/resourceGroups/res9290/providers/Microsoft.Storage/storageAccounts/sto328/queueServices/default/queues?api-version=2019-06-01&$maxpagesize=2&$skipToken=/sto328/queue6187"
+ }
+ }
+ }
+}
diff --git a/specification/storage/resource-manager/Microsoft.Storage/stable/2019-06-01/examples/QueueOperationPatch.json b/specification/storage/resource-manager/Microsoft.Storage/stable/2019-06-01/examples/QueueOperationPatch.json
new file mode 100644
index 000000000000..b2270a4ca9c6
--- /dev/null
+++ b/specification/storage/resource-manager/Microsoft.Storage/stable/2019-06-01/examples/QueueOperationPatch.json
@@ -0,0 +1,20 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "res3376",
+ "accountName": "sto328",
+ "queueName": "queue6185",
+ "api-version": "2019-06-01",
+ "monitor": "true",
+ "queue": {}
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/res3376/providers/Microsoft.Storage/storageAccounts/sto328/queueServices/default/queues/queue6185",
+ "name": "queue6185",
+ "type": "Microsoft.Storage/storageAccounts/queueServices/queues"
+ }
+ }
+ }
+}
diff --git a/specification/storage/resource-manager/Microsoft.Storage/stable/2019-06-01/examples/QueueOperationPut.json b/specification/storage/resource-manager/Microsoft.Storage/stable/2019-06-01/examples/QueueOperationPut.json
new file mode 100644
index 000000000000..b2270a4ca9c6
--- /dev/null
+++ b/specification/storage/resource-manager/Microsoft.Storage/stable/2019-06-01/examples/QueueOperationPut.json
@@ -0,0 +1,20 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "res3376",
+ "accountName": "sto328",
+ "queueName": "queue6185",
+ "api-version": "2019-06-01",
+ "monitor": "true",
+ "queue": {}
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/res3376/providers/Microsoft.Storage/storageAccounts/sto328/queueServices/default/queues/queue6185",
+ "name": "queue6185",
+ "type": "Microsoft.Storage/storageAccounts/queueServices/queues"
+ }
+ }
+ }
+}
diff --git a/specification/storage/resource-manager/Microsoft.Storage/stable/2019-06-01/examples/QueueOperationPutWithMetadata.json b/specification/storage/resource-manager/Microsoft.Storage/stable/2019-06-01/examples/QueueOperationPutWithMetadata.json
new file mode 100644
index 000000000000..b1a1a4776e4d
--- /dev/null
+++ b/specification/storage/resource-manager/Microsoft.Storage/stable/2019-06-01/examples/QueueOperationPutWithMetadata.json
@@ -0,0 +1,33 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "res3376",
+ "accountName": "sto328",
+ "queueName": "queue6185",
+ "api-version": "2019-06-01",
+ "monitor": "true",
+ "queue": {
+ "properties": {
+ "metadata": {
+ "sample1": "meta1",
+ "sample2": "meta2"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/res3376/providers/Microsoft.Storage/storageAccounts/sto328/queueServices/default/queues/queue6185",
+ "name": "queue6185",
+ "type": "Microsoft.Storage/storageAccounts/queueServices/queues",
+ "properties": {
+ "metadata": {
+ "sample1": "meta1",
+ "sample2": "meta2"
+ }
+ }
+ }
+ }
+ }
+}
diff --git a/specification/storage/resource-manager/Microsoft.Storage/stable/2019-06-01/examples/QueueServicesGet.json b/specification/storage/resource-manager/Microsoft.Storage/stable/2019-06-01/examples/QueueServicesGet.json
new file mode 100644
index 000000000000..59a9502132e4
--- /dev/null
+++ b/specification/storage/resource-manager/Microsoft.Storage/stable/2019-06-01/examples/QueueServicesGet.json
@@ -0,0 +1,82 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "res4410",
+ "accountName": "sto8607",
+ "queueServiceName": "default",
+ "api-version": "2019-06-01",
+ "monitor": "true"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/res4410/providers/Microsoft.Storage/storageAccounts/sto8607/queueServices/default",
+ "name": "default",
+ "type": "Microsoft.Storage/storageAccounts/queueServices",
+ "properties": {
+ "cors": {
+ "corsRules": [
+ {
+ "allowedOrigins": [
+ "http://www.contoso.com",
+ "http://www.fabrikam.com"
+ ],
+ "allowedMethods": [
+ "GET",
+ "HEAD",
+ "POST",
+ "OPTIONS",
+ "MERGE",
+ "PUT"
+ ],
+ "maxAgeInSeconds": 100,
+ "exposedHeaders": [
+ "x-ms-meta-*"
+ ],
+ "allowedHeaders": [
+ "x-ms-meta-abc",
+ "x-ms-meta-data*",
+ "x-ms-meta-target*"
+ ]
+ },
+ {
+ "allowedOrigins": [
+ "*"
+ ],
+ "allowedMethods": [
+ "GET"
+ ],
+ "maxAgeInSeconds": 2,
+ "exposedHeaders": [
+ "*"
+ ],
+ "allowedHeaders": [
+ "*"
+ ]
+ },
+ {
+ "allowedOrigins": [
+ "http://www.abc23.com",
+ "https://www.fabrikam.com/*"
+ ],
+ "allowedMethods": [
+ "GET",
+ "PUT"
+ ],
+ "maxAgeInSeconds": 2000,
+ "exposedHeaders": [
+ "x-ms-meta-abc",
+ "x-ms-meta-data*",
+ "x-ms-meta-target*"
+ ],
+ "allowedHeaders": [
+ "x-ms-meta-12345675754564*"
+ ]
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+}
diff --git a/specification/storage/resource-manager/Microsoft.Storage/stable/2019-06-01/examples/QueueServicesList.json b/specification/storage/resource-manager/Microsoft.Storage/stable/2019-06-01/examples/QueueServicesList.json
new file mode 100644
index 000000000000..e797fa2e065f
--- /dev/null
+++ b/specification/storage/resource-manager/Microsoft.Storage/stable/2019-06-01/examples/QueueServicesList.json
@@ -0,0 +1,85 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "res9290",
+ "accountName": "sto1590",
+ "api-version": "2019-06-01",
+ "monitor": "true"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/res4410/providers/Microsoft.Storage/storageAccounts/sto8607/queueServices/default",
+ "name": "default",
+ "type": "Microsoft.Storage/storageAccounts/queueServices",
+ "properties": {
+ "cors": {
+ "corsRules": [
+ {
+ "allowedOrigins": [
+ "http://www.contoso.com",
+ "http://www.fabrikam.com"
+ ],
+ "allowedMethods": [
+ "GET",
+ "HEAD",
+ "POST",
+ "OPTIONS",
+ "MERGE",
+ "PUT"
+ ],
+ "maxAgeInSeconds": 100,
+ "exposedHeaders": [
+ "x-ms-meta-*"
+ ],
+ "allowedHeaders": [
+ "x-ms-meta-abc",
+ "x-ms-meta-data*",
+ "x-ms-meta-target*"
+ ]
+ },
+ {
+ "allowedOrigins": [
+ "*"
+ ],
+ "allowedMethods": [
+ "GET"
+ ],
+ "maxAgeInSeconds": 2,
+ "exposedHeaders": [
+ "*"
+ ],
+ "allowedHeaders": [
+ "*"
+ ]
+ },
+ {
+ "allowedOrigins": [
+ "http://www.abc23.com",
+ "https://www.fabrikam.com/*"
+ ],
+ "allowedMethods": [
+ "GET",
+ "PUT"
+ ],
+ "maxAgeInSeconds": 2000,
+ "exposedHeaders": [
+ "x-ms-meta-abc",
+ "x-ms-meta-data*",
+ "x-ms-meta-target*"
+ ],
+ "allowedHeaders": [
+ "x-ms-meta-12345675754564*"
+ ]
+ }
+ ]
+ }
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/storage/resource-manager/Microsoft.Storage/stable/2019-06-01/examples/QueueServicesPut.json b/specification/storage/resource-manager/Microsoft.Storage/stable/2019-06-01/examples/QueueServicesPut.json
new file mode 100644
index 000000000000..141c1417a860
--- /dev/null
+++ b/specification/storage/resource-manager/Microsoft.Storage/stable/2019-06-01/examples/QueueServicesPut.json
@@ -0,0 +1,147 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "res4410",
+ "accountName": "sto8607",
+ "queueServiceName": "default",
+ "api-version": "2019-06-01",
+ "monitor": "true",
+ "parameters": {
+ "properties": {
+ "cors": {
+ "corsRules": [
+ {
+ "allowedOrigins": [
+ "http://www.contoso.com",
+ "http://www.fabrikam.com"
+ ],
+ "allowedMethods": [
+ "GET",
+ "HEAD",
+ "POST",
+ "OPTIONS",
+ "MERGE",
+ "PUT"
+ ],
+ "maxAgeInSeconds": 100,
+ "exposedHeaders": [
+ "x-ms-meta-*"
+ ],
+ "allowedHeaders": [
+ "x-ms-meta-abc",
+ "x-ms-meta-data*",
+ "x-ms-meta-target*"
+ ]
+ },
+ {
+ "allowedOrigins": [
+ "*"
+ ],
+ "allowedMethods": [
+ "GET"
+ ],
+ "maxAgeInSeconds": 2,
+ "exposedHeaders": [
+ "*"
+ ],
+ "allowedHeaders": [
+ "*"
+ ]
+ },
+ {
+ "allowedOrigins": [
+ "http://www.abc23.com",
+ "https://www.fabrikam.com/*"
+ ],
+ "allowedMethods": [
+ "GET",
+ "PUT"
+ ],
+ "maxAgeInSeconds": 2000,
+ "exposedHeaders": [
+ "x-ms-meta-abc",
+ "x-ms-meta-data*",
+ "x-ms-meta-target*"
+ ],
+ "allowedHeaders": [
+ "x-ms-meta-12345675754564*"
+ ]
+ }
+ ]
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/res4410/providers/Microsoft.Storage/storageAccounts/sto8607/queueServices/default",
+ "name": "default",
+ "type": "Microsoft.Storage/storageAccounts/queueServices",
+ "properties": {
+ "cors": {
+ "corsRules": [
+ {
+ "allowedOrigins": [
+ "http://www.contoso.com",
+ "http://www.fabrikam.com"
+ ],
+ "allowedMethods": [
+ "GET",
+ "HEAD",
+ "POST",
+ "OPTIONS",
+ "MERGE",
+ "PUT"
+ ],
+ "maxAgeInSeconds": 100,
+ "exposedHeaders": [
+ "x-ms-meta-*"
+ ],
+ "allowedHeaders": [
+ "x-ms-meta-abc",
+ "x-ms-meta-data*",
+ "x-ms-meta-target*"
+ ]
+ },
+ {
+ "allowedOrigins": [
+ "*"
+ ],
+ "allowedMethods": [
+ "GET"
+ ],
+ "maxAgeInSeconds": 2,
+ "exposedHeaders": [
+ "*"
+ ],
+ "allowedHeaders": [
+ "*"
+ ]
+ },
+ {
+ "allowedOrigins": [
+ "http://www.abc23.com",
+ "https://www.fabrikam.com/*"
+ ],
+ "allowedMethods": [
+ "GET",
+ "PUT"
+ ],
+ "maxAgeInSeconds": 2000,
+ "exposedHeaders": [
+ "x-ms-meta-abc",
+ "x-ms-meta-data*",
+ "x-ms-meta-target*"
+ ],
+ "allowedHeaders": [
+ "x-ms-meta-12345675754564*"
+ ]
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+}
diff --git a/specification/storage/resource-manager/Microsoft.Storage/stable/2019-06-01/examples/StorageAccountCreate.json b/specification/storage/resource-manager/Microsoft.Storage/stable/2019-06-01/examples/StorageAccountCreate.json
index 6b81e637edb1..13f6c5388b0b 100644
--- a/specification/storage/resource-manager/Microsoft.Storage/stable/2019-06-01/examples/StorageAccountCreate.json
+++ b/specification/storage/resource-manager/Microsoft.Storage/stable/2019-06-01/examples/StorageAccountCreate.json
@@ -28,6 +28,7 @@
"enabled": true
}
},
+ "requireInfrastructureEncryption": false,
"keySource": "Microsoft.Storage"
}
},
@@ -89,6 +90,7 @@
"lastEnabledTime": "2019-12-11T20:49:31.7036140Z"
}
},
+ "requireInfrastructureEncryption": false,
"keySource": "Microsoft.Storage"
},
"secondaryLocation": "centraluseuap",
diff --git a/specification/storage/resource-manager/Microsoft.Storage/stable/2019-06-01/examples/StorageAccountListPrivateEndpointConnections.json b/specification/storage/resource-manager/Microsoft.Storage/stable/2019-06-01/examples/StorageAccountListPrivateEndpointConnections.json
new file mode 100644
index 000000000000..9c23e8ea819c
--- /dev/null
+++ b/specification/storage/resource-manager/Microsoft.Storage/stable/2019-06-01/examples/StorageAccountListPrivateEndpointConnections.json
@@ -0,0 +1,49 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "res6977",
+ "accountName": "sto2527",
+ "api-version": "2019-06-01",
+ "monitor": "true"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/res7231/providers/Microsoft.Storage/storageAccounts/sto288/privateEndpointConnections/{privateEndpointConnectionName}",
+ "name": "{privateEndpointConnectionName}",
+ "type": "Microsoft.Storage/storageAccounts/privateEndpointConnections",
+ "properties": {
+ "provisioningState": "Succeeded",
+ "privateEndpoint": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/res7231/providers/Microsoft.Network/privateEndpoints/petest01"
+ },
+ "privateLinkServiceConnectionState": {
+ "status": "Approved",
+ "description": "Auto-Approved",
+ "actionRequired": "None"
+ }
+ }
+ },
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/res7231/providers/Microsoft.Storage/storageAccounts/sto288/privateEndpointConnections/{privateEndpointConnectionName}",
+ "name": "{privateEndpointConnectionName}",
+ "type": "Microsoft.Storage/storageAccounts/privateEndpointConnections",
+ "properties": {
+ "provisioningState": "Succeeded",
+ "privateEndpoint": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/res7231/providers/Microsoft.Network/privateEndpoints/petest02"
+ },
+ "privateLinkServiceConnectionState": {
+ "status": "Approved",
+ "description": "Auto-Approved",
+ "actionRequired": "None"
+ }
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/storage/resource-manager/Microsoft.Storage/stable/2019-06-01/examples/StorageAccountSetManagementPolicy.json b/specification/storage/resource-manager/Microsoft.Storage/stable/2019-06-01/examples/StorageAccountSetManagementPolicy.json
index bba4c1218aa0..8382e903ca24 100644
--- a/specification/storage/resource-manager/Microsoft.Storage/stable/2019-06-01/examples/StorageAccountSetManagementPolicy.json
+++ b/specification/storage/resource-manager/Microsoft.Storage/stable/2019-06-01/examples/StorageAccountSetManagementPolicy.json
@@ -12,7 +12,7 @@
"rules": [
{
"enabled": true,
- "name": "olcmtest",
+ "name": "olcmtest1",
"type": "Lifecycle",
"definition": {
"filters": {
@@ -20,7 +20,7 @@
"blockBlob"
],
"prefixMatch": [
- "olcmtestcontainer"
+ "olcmtestcontainer1"
]
},
"actions": {
@@ -42,6 +42,46 @@
}
}
}
+ },
+ {
+ "enabled": true,
+ "name": "olcmtest2",
+ "type": "Lifecycle",
+ "definition": {
+ "filters": {
+ "blobTypes": [
+ "blockBlob"
+ ],
+ "prefixMatch": [
+ "olcmtestcontainer2"
+ ],
+ "blobIndexMatch": [
+ {
+ "name": "tag1",
+ "op": "==",
+ "value": "val1"
+ },
+ {
+ "name": "tag2",
+ "op": "==",
+ "value": "val2"
+ }
+ ]
+ },
+ "actions": {
+ "baseBlob": {
+ "tierToCool": {
+ "daysAfterModificationGreaterThan": 30
+ },
+ "tierToArchive": {
+ "daysAfterModificationGreaterThan": 90
+ },
+ "delete": {
+ "daysAfterModificationGreaterThan": 1000
+ }
+ }
+ }
+ }
}
]
}
@@ -59,7 +99,7 @@
"rules": [
{
"enabled": true,
- "name": "olcmtest",
+ "name": "olcmtest1",
"type": "Lifecycle",
"definition": {
"filters": {
@@ -67,7 +107,7 @@
"blockBlob"
],
"prefixMatch": [
- "olcmtestcontainer"
+ "olcmtestcontainer1"
]
},
"actions": {
@@ -89,6 +129,46 @@
}
}
}
+ },
+ {
+ "enabled": true,
+ "name": "olcmtest2",
+ "type": "Lifecycle",
+ "definition": {
+ "filters": {
+ "blobTypes": [
+ "blockBlob"
+ ],
+ "prefixMatch": [
+ "olcmtestcontainer2"
+ ],
+ "blobIndexMatch": [
+ {
+ "name": "tag1",
+ "op": "==",
+ "value": "val1"
+ },
+ {
+ "name": "tag2",
+ "op": "==",
+ "value": "val2"
+ }
+ ]
+ },
+ "actions": {
+ "baseBlob": {
+ "tierToCool": {
+ "daysAfterModificationGreaterThan": 30
+ },
+ "tierToArchive": {
+ "daysAfterModificationGreaterThan": 90
+ },
+ "delete": {
+ "daysAfterModificationGreaterThan": 1000
+ }
+ }
+ }
+ }
}
]
},
diff --git a/specification/storage/resource-manager/Microsoft.Storage/stable/2019-06-01/examples/TableOperationDelete.json b/specification/storage/resource-manager/Microsoft.Storage/stable/2019-06-01/examples/TableOperationDelete.json
new file mode 100644
index 000000000000..b50907bcf6ba
--- /dev/null
+++ b/specification/storage/resource-manager/Microsoft.Storage/stable/2019-06-01/examples/TableOperationDelete.json
@@ -0,0 +1,13 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "res3376",
+ "accountName": "sto328",
+ "tableName": "table6185",
+ "api-version": "2019-06-01",
+ "monitor": "true"
+ },
+ "responses": {
+ "204": {}
+ }
+}
diff --git a/specification/storage/resource-manager/Microsoft.Storage/stable/2019-06-01/examples/TableOperationGet.json b/specification/storage/resource-manager/Microsoft.Storage/stable/2019-06-01/examples/TableOperationGet.json
new file mode 100644
index 000000000000..ad61ecff6513
--- /dev/null
+++ b/specification/storage/resource-manager/Microsoft.Storage/stable/2019-06-01/examples/TableOperationGet.json
@@ -0,0 +1,22 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "res3376",
+ "accountName": "sto328",
+ "tableName": "table6185",
+ "api-version": "2019-06-01",
+ "monitor": "true"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/res3376/providers/Microsoft.Storage/storageAccounts/sto328/tableServices/default/tables/table6185",
+ "name": "table6185",
+ "type": "Microsoft.Storage/storageAccounts/tableServices/tables",
+ "properties": {
+ "tableName": "table6185"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/storage/resource-manager/Microsoft.Storage/stable/2019-06-01/examples/TableOperationList.json b/specification/storage/resource-manager/Microsoft.Storage/stable/2019-06-01/examples/TableOperationList.json
new file mode 100644
index 000000000000..c239b4e52023
--- /dev/null
+++ b/specification/storage/resource-manager/Microsoft.Storage/stable/2019-06-01/examples/TableOperationList.json
@@ -0,0 +1,34 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "res9290",
+ "accountName": "sto328",
+ "api-version": "2019-06-01",
+ "monitor": "true"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/res3376/providers/Microsoft.Storage/storageAccounts/sto328/tableServices/default/tables/table6185",
+ "name": "table6185",
+ "type": "Microsoft.Storage/storageAccounts/tableServices/tables",
+ "properties": {
+ "tableName": "table6185"
+ }
+ },
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/res3376/providers/Microsoft.Storage/storageAccounts/sto328/tableServices/default/tables/table6186",
+ "name": "table6186",
+ "type": "Microsoft.Storage/storageAccounts/tableServices/tables",
+ "properties": {
+ "tableName": "table6186"
+ }
+ }
+ ],
+ "nextLink": "https://sto1590endpoint/subscriptions/{subscription-id}/resourceGroups/res9290/providers/Microsoft.Storage/storageAccounts/sto328/tableServices/default/tables?api-version=2019-06-01&NextTableName=1!40!bXl0YWJsZXNoYzU0OAEwMWQ2MTI5ZTJmYjVmODFh"
+ }
+ }
+ }
+}
diff --git a/specification/storage/resource-manager/Microsoft.Storage/stable/2019-06-01/examples/TableOperationPatch.json b/specification/storage/resource-manager/Microsoft.Storage/stable/2019-06-01/examples/TableOperationPatch.json
new file mode 100644
index 000000000000..ad61ecff6513
--- /dev/null
+++ b/specification/storage/resource-manager/Microsoft.Storage/stable/2019-06-01/examples/TableOperationPatch.json
@@ -0,0 +1,22 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "res3376",
+ "accountName": "sto328",
+ "tableName": "table6185",
+ "api-version": "2019-06-01",
+ "monitor": "true"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/res3376/providers/Microsoft.Storage/storageAccounts/sto328/tableServices/default/tables/table6185",
+ "name": "table6185",
+ "type": "Microsoft.Storage/storageAccounts/tableServices/tables",
+ "properties": {
+ "tableName": "table6185"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/storage/resource-manager/Microsoft.Storage/stable/2019-06-01/examples/TableOperationPut.json b/specification/storage/resource-manager/Microsoft.Storage/stable/2019-06-01/examples/TableOperationPut.json
new file mode 100644
index 000000000000..ad61ecff6513
--- /dev/null
+++ b/specification/storage/resource-manager/Microsoft.Storage/stable/2019-06-01/examples/TableOperationPut.json
@@ -0,0 +1,22 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "res3376",
+ "accountName": "sto328",
+ "tableName": "table6185",
+ "api-version": "2019-06-01",
+ "monitor": "true"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/res3376/providers/Microsoft.Storage/storageAccounts/sto328/tableServices/default/tables/table6185",
+ "name": "table6185",
+ "type": "Microsoft.Storage/storageAccounts/tableServices/tables",
+ "properties": {
+ "tableName": "table6185"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/storage/resource-manager/Microsoft.Storage/stable/2019-06-01/examples/TableServicesGet.json b/specification/storage/resource-manager/Microsoft.Storage/stable/2019-06-01/examples/TableServicesGet.json
new file mode 100644
index 000000000000..53b11ad310d2
--- /dev/null
+++ b/specification/storage/resource-manager/Microsoft.Storage/stable/2019-06-01/examples/TableServicesGet.json
@@ -0,0 +1,82 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "res4410",
+ "accountName": "sto8607",
+ "tableServiceName": "default",
+ "api-version": "2019-06-01",
+ "monitor": "true"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/res4410/providers/Microsoft.Storage/storageAccounts/sto8607/tableServices/default",
+ "name": "default",
+ "type": "Microsoft.Storage/storageAccounts/tableServices",
+ "properties": {
+ "cors": {
+ "corsRules": [
+ {
+ "allowedOrigins": [
+ "http://www.contoso.com",
+ "http://www.fabrikam.com"
+ ],
+ "allowedMethods": [
+ "GET",
+ "HEAD",
+ "POST",
+ "OPTIONS",
+ "MERGE",
+ "PUT"
+ ],
+ "maxAgeInSeconds": 100,
+ "exposedHeaders": [
+ "x-ms-meta-*"
+ ],
+ "allowedHeaders": [
+ "x-ms-meta-abc",
+ "x-ms-meta-data*",
+ "x-ms-meta-target*"
+ ]
+ },
+ {
+ "allowedOrigins": [
+ "*"
+ ],
+ "allowedMethods": [
+ "GET"
+ ],
+ "maxAgeInSeconds": 2,
+ "exposedHeaders": [
+ "*"
+ ],
+ "allowedHeaders": [
+ "*"
+ ]
+ },
+ {
+ "allowedOrigins": [
+ "http://www.abc23.com",
+ "https://www.fabrikam.com/*"
+ ],
+ "allowedMethods": [
+ "GET",
+ "PUT"
+ ],
+ "maxAgeInSeconds": 2000,
+ "exposedHeaders": [
+ "x-ms-meta-abc",
+ "x-ms-meta-data*",
+ "x-ms-meta-target*"
+ ],
+ "allowedHeaders": [
+ "x-ms-meta-12345675754564*"
+ ]
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+}
diff --git a/specification/storage/resource-manager/Microsoft.Storage/stable/2019-06-01/examples/TableServicesList.json b/specification/storage/resource-manager/Microsoft.Storage/stable/2019-06-01/examples/TableServicesList.json
new file mode 100644
index 000000000000..9fc35a182c54
--- /dev/null
+++ b/specification/storage/resource-manager/Microsoft.Storage/stable/2019-06-01/examples/TableServicesList.json
@@ -0,0 +1,85 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "res9290",
+ "accountName": "sto1590",
+ "api-version": "2019-06-01",
+ "monitor": "true"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/res4410/providers/Microsoft.Storage/storageAccounts/sto8607/tableServices/default",
+ "name": "default",
+ "type": "Microsoft.Storage/storageAccounts/tableServices",
+ "properties": {
+ "cors": {
+ "corsRules": [
+ {
+ "allowedOrigins": [
+ "http://www.contoso.com",
+ "http://www.fabrikam.com"
+ ],
+ "allowedMethods": [
+ "GET",
+ "HEAD",
+ "POST",
+ "OPTIONS",
+ "MERGE",
+ "PUT"
+ ],
+ "maxAgeInSeconds": 100,
+ "exposedHeaders": [
+ "x-ms-meta-*"
+ ],
+ "allowedHeaders": [
+ "x-ms-meta-abc",
+ "x-ms-meta-data*",
+ "x-ms-meta-target*"
+ ]
+ },
+ {
+ "allowedOrigins": [
+ "*"
+ ],
+ "allowedMethods": [
+ "GET"
+ ],
+ "maxAgeInSeconds": 2,
+ "exposedHeaders": [
+ "*"
+ ],
+ "allowedHeaders": [
+ "*"
+ ]
+ },
+ {
+ "allowedOrigins": [
+ "http://www.abc23.com",
+ "https://www.fabrikam.com/*"
+ ],
+ "allowedMethods": [
+ "GET",
+ "PUT"
+ ],
+ "maxAgeInSeconds": 2000,
+ "exposedHeaders": [
+ "x-ms-meta-abc",
+ "x-ms-meta-data*",
+ "x-ms-meta-target*"
+ ],
+ "allowedHeaders": [
+ "x-ms-meta-12345675754564*"
+ ]
+ }
+ ]
+ }
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/storage/resource-manager/Microsoft.Storage/stable/2019-06-01/examples/TableServicesPut.json b/specification/storage/resource-manager/Microsoft.Storage/stable/2019-06-01/examples/TableServicesPut.json
new file mode 100644
index 000000000000..e66436e66d07
--- /dev/null
+++ b/specification/storage/resource-manager/Microsoft.Storage/stable/2019-06-01/examples/TableServicesPut.json
@@ -0,0 +1,147 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "res4410",
+ "accountName": "sto8607",
+ "tableServiceName": "default",
+ "api-version": "2019-06-01",
+ "monitor": "true",
+ "parameters": {
+ "properties": {
+ "cors": {
+ "corsRules": [
+ {
+ "allowedOrigins": [
+ "http://www.contoso.com",
+ "http://www.fabrikam.com"
+ ],
+ "allowedMethods": [
+ "GET",
+ "HEAD",
+ "POST",
+ "OPTIONS",
+ "MERGE",
+ "PUT"
+ ],
+ "maxAgeInSeconds": 100,
+ "exposedHeaders": [
+ "x-ms-meta-*"
+ ],
+ "allowedHeaders": [
+ "x-ms-meta-abc",
+ "x-ms-meta-data*",
+ "x-ms-meta-target*"
+ ]
+ },
+ {
+ "allowedOrigins": [
+ "*"
+ ],
+ "allowedMethods": [
+ "GET"
+ ],
+ "maxAgeInSeconds": 2,
+ "exposedHeaders": [
+ "*"
+ ],
+ "allowedHeaders": [
+ "*"
+ ]
+ },
+ {
+ "allowedOrigins": [
+ "http://www.abc23.com",
+ "https://www.fabrikam.com/*"
+ ],
+ "allowedMethods": [
+ "GET",
+ "PUT"
+ ],
+ "maxAgeInSeconds": 2000,
+ "exposedHeaders": [
+ "x-ms-meta-abc",
+ "x-ms-meta-data*",
+ "x-ms-meta-target*"
+ ],
+ "allowedHeaders": [
+ "x-ms-meta-12345675754564*"
+ ]
+ }
+ ]
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/res4410/providers/Microsoft.Storage/storageAccounts/sto8607/tableServices/default",
+ "name": "default",
+ "type": "Microsoft.Storage/storageAccounts/tableServices",
+ "properties": {
+ "cors": {
+ "corsRules": [
+ {
+ "allowedOrigins": [
+ "http://www.contoso.com",
+ "http://www.fabrikam.com"
+ ],
+ "allowedMethods": [
+ "GET",
+ "HEAD",
+ "POST",
+ "OPTIONS",
+ "MERGE",
+ "PUT"
+ ],
+ "maxAgeInSeconds": 100,
+ "exposedHeaders": [
+ "x-ms-meta-*"
+ ],
+ "allowedHeaders": [
+ "x-ms-meta-abc",
+ "x-ms-meta-data*",
+ "x-ms-meta-target*"
+ ]
+ },
+ {
+ "allowedOrigins": [
+ "*"
+ ],
+ "allowedMethods": [
+ "GET"
+ ],
+ "maxAgeInSeconds": 2,
+ "exposedHeaders": [
+ "*"
+ ],
+ "allowedHeaders": [
+ "*"
+ ]
+ },
+ {
+ "allowedOrigins": [
+ "http://www.abc23.com",
+ "https://www.fabrikam.com/*"
+ ],
+ "allowedMethods": [
+ "GET",
+ "PUT"
+ ],
+ "maxAgeInSeconds": 2000,
+ "exposedHeaders": [
+ "x-ms-meta-abc",
+ "x-ms-meta-data*",
+ "x-ms-meta-target*"
+ ],
+ "allowedHeaders": [
+ "x-ms-meta-12345675754564*"
+ ]
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+}
diff --git a/specification/storage/resource-manager/Microsoft.Storage/stable/2019-06-01/file.json b/specification/storage/resource-manager/Microsoft.Storage/stable/2019-06-01/file.json
index 10cc15aa9a7e..9e603d1881fa 100644
--- a/specification/storage/resource-manager/Microsoft.Storage/stable/2019-06-01/file.json
+++ b/specification/storage/resource-manager/Microsoft.Storage/stable/2019-06-01/file.json
@@ -164,6 +164,9 @@
"x-ms-examples": {
"ListShares": {
"$ref": "./examples/FileSharesList.json"
+ },
+ "ListDeletedShares": {
+ "$ref": "./examples/DeletedFileSharesList.json"
}
},
"description": "Lists all shares.",
@@ -191,6 +194,20 @@
"in": "query",
"type": "string",
"description": "Optional. When specified, only share names starting with the filter will be listed."
+ },
+ {
+ "name": "$expand",
+ "in": "query",
+ "required": false,
+ "type": "string",
+ "enum": [
+ "deleted"
+ ],
+ "x-ms-enum": {
+ "name": "ListSharesExpand",
+ "modelAsString": false
+ },
+ "description": "Optional, used to expand the properties within share's properties."
}
],
"responses": {
@@ -221,6 +238,12 @@
"x-ms-examples": {
"PutShares": {
"$ref": "./examples/FileSharesPut.json"
+ },
+ "Create NFS Shares": {
+ "$ref": "./examples/FileSharesPut_NFS.json"
+ },
+ "PutShares with Access Tier": {
+ "$ref": "./examples/FileSharesPut_AccessTier.json"
}
},
"description": "Creates a new share under the specified account as described by request body. The share resource includes metadata and properties for that share. It does not include a list of the files contained by the share. ",
@@ -332,6 +355,9 @@
"x-ms-examples": {
"GetShares": {
"$ref": "./examples/FileSharesGet.json"
+ },
+ "GetShareStats": {
+ "$ref": "./examples/FileSharesGet_Stats.json"
}
},
"description": "Gets properties of a specified share.",
@@ -350,6 +376,20 @@
},
{
"$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "name": "$expand",
+ "in": "query",
+ "required": false,
+ "type": "string",
+ "enum": [
+ "stats"
+ ],
+ "x-ms-enum": {
+ "name": "GetShareExpand",
+ "modelAsString": false
+ },
+ "description": "Optional, used to expand the properties within share's properties."
}
],
"responses": {
@@ -410,6 +450,56 @@
}
}
}
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/fileServices/default/shares/{shareName}/restore": {
+ "post": {
+ "tags": [
+ "FileShares"
+ ],
+ "operationId": "FileShares_Restore",
+ "x-ms-examples": {
+ "RestoreShares": {
+ "$ref": "./examples/FileSharesRestore.json"
+ }
+ },
+ "description": "Restore a file share within a valid retention days if share soft delete is enabled",
+ "parameters": [
+ {
+ "$ref": "./storage.json#/parameters/ResourceGroupName"
+ },
+ {
+ "$ref": "./storage.json#/parameters/StorageAccountName"
+ },
+ {
+ "$ref": "#/parameters/ShareName"
+ },
+ {
+ "name": "deletedShare",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/DeletedShare"
+ }
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK -- The Share is successfully restored."
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ }
+ }
}
},
"definitions": {
@@ -471,6 +561,23 @@
],
"description": "Properties of the file share, including Id, resource name, resource type, Etag."
},
+ "DeletedShare": {
+ "properties": {
+ "deletedShareName": {
+ "type": "string",
+ "description": "Required. Identify the name of the deleted share that will be restored."
+ },
+ "deletedShareVersion": {
+ "type": "string",
+ "description": "Required. Identify the version of the deleted share that will be restored."
+ }
+ },
+ "required": [
+ "deletedShareName",
+ "deletedShareVersion"
+ ],
+ "description": "The deleted share to be restored."
+ },
"FileShareItem": {
"properties": {
"properties": {
@@ -524,6 +631,87 @@
"minimum": 1,
"maximum": 102400,
"description": "The maximum size of the share, in gigabytes. Must be greater than 0, and less than or equal to 5TB (5120). For Large File Shares, the maximum size is 102400."
+ },
+ "enabledProtocols": {
+ "type": "string",
+ "enum": [
+ "SMB",
+ "NFS"
+ ],
+ "x-ms-enum": {
+ "name": "EnabledProtocols",
+ "modelAsString": true
+ },
+ "description": "The authentication protocol that is used for the file share. Can only be specified when creating a share.",
+ "x-ms-mutability": [
+ "create",
+ "read"
+ ]
+ },
+ "rootSquash": {
+ "type": "string",
+ "enum": [
+ "NoRootSquash",
+ "RootSquash",
+ "AllSquash"
+ ],
+ "x-ms-enum": {
+ "name": "RootSquashType",
+ "modelAsString": true
+ },
+ "description": "The property is for NFS share only. The default is NoRootSquash."
+ },
+ "version": {
+ "type": "string",
+ "readOnly": true,
+ "description": "The version of the share."
+ },
+ "deleted": {
+ "type": "boolean",
+ "readOnly": true,
+ "description": "Indicates whether the share was deleted."
+ },
+ "deletedTime": {
+ "type": "string",
+ "format": "date-time",
+ "readOnly": true,
+ "description": "The deleted time if the share was deleted."
+ },
+ "remainingRetentionDays": {
+ "type": "integer",
+ "readOnly": true,
+ "description": "Remaining retention days for share that was soft deleted."
+ },
+ "accessTier": {
+ "type": "string",
+ "enum": [
+ "TransactionOptimized",
+ "Hot",
+ "Cool",
+ "Premium"
+ ],
+ "x-ms-enum": {
+ "name": "ShareAccessTier",
+ "modelAsString": true
+ },
+ "description": "Access tier for specific share. GpV2 account can choose between TransactionOptimized (default), Hot, and Cool. FileStorage account can choose Premium."
+ },
+ "accessTierChangeTime": {
+ "type": "string",
+ "format": "date-time",
+ "readOnly": true,
+ "description": "Indicates the last modification time for share access tier."
+ },
+ "accessTierStatus": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Indicates if there is a pending transition for access tier."
+ },
+ "shareUsageBytes": {
+ "type": "integer",
+ "format": "int64",
+ "readOnly": true,
+ "description": "The approximate size of the data stored on the share. Note that this value may not include all recently created or recently resized files."
}
},
"description": "The properties of the file share."
diff --git a/specification/storage/resource-manager/Microsoft.Storage/stable/2019-06-01/queue.json b/specification/storage/resource-manager/Microsoft.Storage/stable/2019-06-01/queue.json
new file mode 100644
index 000000000000..d7cf16d5a438
--- /dev/null
+++ b/specification/storage/resource-manager/Microsoft.Storage/stable/2019-06-01/queue.json
@@ -0,0 +1,560 @@
+{
+ "swagger": "2.0",
+ "info": {
+ "version": "2019-06-01",
+ "title": "StorageManagementClient",
+ "description": "The Azure Storage Management API."
+ },
+ "host": "management.azure.com",
+ "schemes": [
+ "https"
+ ],
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "paths": {
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/queueServices": {
+ "get": {
+ "tags": [
+ "QueueServiceProperties"
+ ],
+ "operationId": "QueueServices_List",
+ "x-ms-examples": {
+ "QueueServicesList": {
+ "$ref": "./examples/QueueServicesList.json"
+ }
+ },
+ "description": "List all queue services for the storage account",
+ "parameters": [
+ {
+ "$ref": "./storage.json#/parameters/ResourceGroupName"
+ },
+ {
+ "$ref": "./storage.json#/parameters/StorageAccountName"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK -- returned the properties of a storage account’s Queue service.",
+ "schema": {
+ "$ref": "#/definitions/ListQueueServices"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "./file.json#/definitions/CloudError"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/queueServices/{queueServiceName}": {
+ "put": {
+ "tags": [
+ "QueueServiceProperties"
+ ],
+ "operationId": "QueueServices_SetServiceProperties",
+ "x-ms-examples": {
+ "QueueServicesPut": {
+ "$ref": "./examples/QueueServicesPut.json"
+ }
+ },
+ "description": "Sets the properties of a storage account’s Queue service, including properties for Storage Analytics and CORS (Cross-Origin Resource Sharing) rules. ",
+ "parameters": [
+ {
+ "$ref": "./storage.json#/parameters/ResourceGroupName"
+ },
+ {
+ "$ref": "./storage.json#/parameters/StorageAccountName"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/QueueServiceName"
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/QueueServiceProperties"
+ },
+ "description": "The properties of a storage account’s Queue service, only properties for Storage Analytics and CORS (Cross-Origin Resource Sharing) rules can be specified."
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK -- Sets The properties of a storage account’s Queue service successfully.",
+ "schema": {
+ "$ref": "#/definitions/QueueServiceProperties"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "./file.json#/definitions/CloudError"
+ }
+ }
+ }
+ },
+ "get": {
+ "tags": [
+ "QueueServiceProperties"
+ ],
+ "operationId": "QueueServices_GetServiceProperties",
+ "x-ms-examples": {
+ "QueueServicesGet": {
+ "$ref": "./examples/QueueServicesGet.json"
+ }
+ },
+ "description": "Gets the properties of a storage account’s Queue service, including properties for Storage Analytics and CORS (Cross-Origin Resource Sharing) rules.",
+ "parameters": [
+ {
+ "$ref": "./storage.json#/parameters/ResourceGroupName"
+ },
+ {
+ "$ref": "./storage.json#/parameters/StorageAccountName"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/QueueServiceName"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK -- returned the properties of a storage account’s Queue service.",
+ "schema": {
+ "$ref": "#/definitions/QueueServiceProperties"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "./file.json#/definitions/CloudError"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/queueServices/default/queues/{queueName}": {
+ "put": {
+ "tags": [
+ "QueueService"
+ ],
+ "operationId": "Queue_Create",
+ "x-ms-examples": {
+ "QueueOperationPut": {
+ "$ref": "./examples/QueueOperationPut.json"
+ },
+ "QueueOperationPutWithMetadata": {
+ "$ref": "./examples/QueueOperationPutWithMetadata.json"
+ }
+ },
+ "description": "Creates a new queue with the specified queue name, under the specified account.",
+ "parameters": [
+ {
+ "$ref": "./storage.json#/parameters/ResourceGroupName"
+ },
+ {
+ "$ref": "./storage.json#/parameters/StorageAccountName"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/QueueName"
+ },
+ {
+ "name": "queue",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/StorageQueue"
+ },
+ "description": "Queue properties and metadata to be created with"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK -- Creates a queue with the given queue name successfully.",
+ "schema": {
+ "$ref": "#/definitions/StorageQueue"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "./file.json#/definitions/CloudError"
+ }
+ }
+ }
+ },
+ "patch": {
+ "tags": [
+ "QueueService"
+ ],
+ "operationId": "Queue_Update",
+ "x-ms-examples": {
+ "QueueOperationPatch": {
+ "$ref": "./examples/QueueOperationPatch.json"
+ }
+ },
+ "description": "Creates a new queue with the specified queue name, under the specified account.",
+ "parameters": [
+ {
+ "$ref": "./storage.json#/parameters/ResourceGroupName"
+ },
+ {
+ "$ref": "./storage.json#/parameters/StorageAccountName"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/QueueName"
+ },
+ {
+ "name": "queue",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/StorageQueue"
+ },
+ "description": "Queue properties and metadata to be created with"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK -- Creates a queue with the given queue name successfully.",
+ "schema": {
+ "$ref": "#/definitions/StorageQueue"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "./file.json#/definitions/CloudError"
+ }
+ }
+ }
+ },
+ "get": {
+ "tags": [
+ "QueueService"
+ ],
+ "operationId": "Queue_Get",
+ "x-ms-examples": {
+ "QueueOperationGet": {
+ "$ref": "./examples/QueueOperationGet.json"
+ }
+ },
+ "description": "Gets the queue with the specified queue name, under the specified account if it exists.",
+ "parameters": [
+ {
+ "$ref": "./storage.json#/parameters/ResourceGroupName"
+ },
+ {
+ "$ref": "./storage.json#/parameters/StorageAccountName"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/QueueName"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK -- returned table with the specified table name successfully.",
+ "schema": {
+ "$ref": "#/definitions/StorageQueue"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "./file.json#/definitions/CloudError"
+ }
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "QueueService"
+ ],
+ "operationId": "Queue_Delete",
+ "x-ms-examples": {
+ "QueueOperationDelete": {
+ "$ref": "./examples/QueueOperationDelete.json"
+ }
+ },
+ "description": "Deletes the queue with the specified queue name, under the specified account if it exists.",
+ "parameters": [
+ {
+ "$ref": "./storage.json#/parameters/ResourceGroupName"
+ },
+ {
+ "$ref": "./storage.json#/parameters/StorageAccountName"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/QueueName"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "No Content - Successfully deleted the queue with the specified queue name"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "./file.json#/definitions/CloudError"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/queueServices/default/queues": {
+ "get": {
+ "tags": [
+ "QueueService"
+ ],
+ "operationId": "Queue_List",
+ "x-ms-examples": {
+ "QueueOperationList": {
+ "$ref": "./examples/QueueOperationList.json"
+ }
+ },
+ "description": "Gets a list of all the queues under the specified storage account",
+ "parameters": [
+ {
+ "$ref": "./storage.json#/parameters/ResourceGroupName"
+ },
+ {
+ "$ref": "./storage.json#/parameters/StorageAccountName"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "name": "$maxpagesize",
+ "in": "query",
+ "type": "string",
+ "description": "Optional, a maximum number of queues that should be included in a list queue response"
+ },
+ {
+ "name": "$filter",
+ "in": "query",
+ "type": "string",
+ "description": "Optional, When specified, only the queues with a name starting with the given filter will be listed."
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK -- returned a list of queues successfully.",
+ "schema": {
+ "$ref": "#/definitions/ListQueueResource"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "./file.json#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ }
+ },
+ "definitions": {
+ "ListQueueServices": {
+ "properties": {
+ "value": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/QueueServiceProperties"
+ },
+ "description": "List of queue services returned.",
+ "readOnly": true
+ }
+ }
+ },
+ "QueueServiceProperties": {
+ "properties": {
+ "properties": {
+ "properties": {
+ "cors": {
+ "$ref": "./common.json#/definitions/CorsRules",
+ "description": "Specifies CORS rules for the Queue service. You can include up to five CorsRule elements in the request. If no CorsRule elements are included in the request body, all CORS rules will be deleted, and CORS will be disabled for the Queue service."
+ }
+ },
+ "x-ms-client-flatten": true,
+ "x-ms-client-name": "QueueServiceProperties",
+ "description": "The properties of a storage account’s Queue service."
+ }
+ },
+ "allOf": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/Resource"
+ }
+ ],
+ "description": "The properties of a storage account’s Queue service."
+ },
+ "StorageQueue": {
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/QueueProperties",
+ "x-ms-client-flatten": true,
+ "x-ms-client-name": "QueueProperties",
+ "description": "Queue resource properties."
+ }
+ },
+ "allOf": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/Resource"
+ }
+ ]
+ },
+ "QueueProperties": {
+ "properties": {
+ "metadata": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "A name-value pair that represents queue metadata."
+ },
+ "approximateMessageCount": {
+ "type": "integer",
+ "readOnly": true,
+ "description": "Integer indicating an approximate number of messages in the queue. This number is not lower than the actual number of messages in the queue, but could be higher."
+ }
+ }
+ },
+ "ListQueue": {
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/ListQueueProperties",
+ "x-ms-client-flatten": true,
+ "x-ms-client-name": "QueueProperties",
+ "description": "List Queue resource properties."
+ }
+ },
+ "allOf": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/Resource"
+ }
+ ]
+ },
+ "ListQueueProperties": {
+ "properties": {
+ "metadata": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "A name-value pair that represents queue metadata."
+ }
+ }
+ },
+ "ListQueueResource": {
+ "properties": {
+ "value": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ListQueue"
+ },
+ "description": "List of queues returned.",
+ "readOnly": true
+ },
+ "nextLink": {
+ "type": "string",
+ "description": "Request URL that can be used to list next page of queues",
+ "readOnly": true
+ }
+ },
+ "description": "Response schema. Contains list of queues returned"
+ }
+ },
+ "parameters": {
+ "QueueServiceName": {
+ "name": "queueServiceName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the Queue Service within the specified storage account. Queue Service Name must be 'default'",
+ "enum": [
+ "default"
+ ],
+ "x-ms-parameter-location": "method"
+ },
+ "QueueName": {
+ "name": "queueName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "A queue name must be unique within a storage account and must be between 3 and 63 characters.The name must comprise of lowercase alphanumeric and dash(-) characters only, it should begin and end with an alphanumeric character and it cannot have two consecutive dash(-) characters.",
+ "maxLength": 63,
+ "minLength": 3,
+ "pattern": "^[a-z0-9]([a-z0-9]|(-(?!-))){1,61}[a-z0-9]$",
+ "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/storage/resource-manager/Microsoft.Storage/stable/2019-06-01/storage.json b/specification/storage/resource-manager/Microsoft.Storage/stable/2019-06-01/storage.json
index 2c92c20bbc2e..9416555d58d2 100644
--- a/specification/storage/resource-manager/Microsoft.Storage/stable/2019-06-01/storage.json
+++ b/specification/storage/resource-manager/Microsoft.Storage/stable/2019-06-01/storage.json
@@ -815,6 +815,45 @@
}
}
},
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/privateEndpointConnections": {
+ "get": {
+ "tags": [
+ "PrivateEndpointConnections"
+ ],
+ "operationId": "PrivateEndpointConnections_List",
+ "description": "List all the private endpoint connections associated with the storage account.",
+ "x-ms-examples": {
+ "StorageAccountListPrivateEndpointConnections": {
+ "$ref": "./examples/StorageAccountListPrivateEndpointConnections.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/ResourceGroupName"
+ },
+ {
+ "$ref": "#/parameters/StorageAccountName"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK -- Successfully retrieved private endpoint connections.",
+ "schema": {
+ "$ref": "../../../../../common-types/resource-management/v1/privatelinks.json#/definitions/PrivateEndpointConnectionListResult"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": null
+ }
+ }
+ },
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/privateEndpointConnections/{privateEndpointConnectionName}": {
"get": {
"tags": [
@@ -841,14 +880,14 @@
"$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter"
},
{
- "$ref": "#/parameters/PrivateEndpointConnectionName"
+ "$ref": "../../../../../common-types/resource-management/v1/privatelinks.json#/parameters/PrivateEndpointConnectionName"
}
],
"responses": {
"200": {
"description": "OK -- Get the private endpoint connection properties successfully.",
"schema": {
- "$ref": "#/definitions/PrivateEndpointConnection"
+ "$ref": "../../../../../common-types/resource-management/v1/privatelinks.json#/definitions/PrivateEndpointConnection"
}
},
"default": {
@@ -884,14 +923,14 @@
"$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter"
},
{
- "$ref": "#/parameters/PrivateEndpointConnectionName"
+ "$ref": "../../../../../common-types/resource-management/v1/privatelinks.json#/parameters/PrivateEndpointConnectionName"
},
{
"name": "properties",
"in": "body",
"required": true,
"schema": {
- "$ref": "#/definitions/PrivateEndpointConnection"
+ "$ref": "../../../../../common-types/resource-management/v1/privatelinks.json#/definitions/PrivateEndpointConnection"
},
"description": "The private endpoint connection properties."
}
@@ -900,7 +939,7 @@
"200": {
"description": "OK -- Update the private endpoint connection properties successfully.",
"schema": {
- "$ref": "#/definitions/PrivateEndpointConnection"
+ "$ref": "../../../../../common-types/resource-management/v1/privatelinks.json#/definitions/PrivateEndpointConnection"
}
},
"default": {
@@ -936,7 +975,7 @@
"$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter"
},
{
- "$ref": "#/parameters/PrivateEndpointConnectionName"
+ "$ref": "../../../../../common-types/resource-management/v1/privatelinks.json#/parameters/PrivateEndpointConnectionName"
}
],
"responses": {
@@ -985,7 +1024,7 @@
"200": {
"description": "Successfully retrieved private link resources.",
"schema": {
- "$ref": "#/definitions/PrivateLinkResourceListResult"
+ "$ref": "../../../../../common-types/resource-management/v1/privatelinks.json#/definitions/PrivateLinkResourceListResult"
}
}
}
@@ -1839,6 +1878,11 @@
},
"default": "Microsoft.Storage"
},
+ "requireInfrastructureEncryption": {
+ "type": "boolean",
+ "x-ms-client-name": "RequireInfrastructureEncryption",
+ "description": "A boolean indicating whether or not the service applies a secondary layer of encryption with platform managed keys for data at rest."
+ },
"keyvaultproperties": {
"$ref": "#/definitions/KeyVaultProperties",
"x-ms-client-name": "KeyVaultProperties",
@@ -2508,7 +2552,7 @@
"readOnly": true,
"type": "array",
"items": {
- "$ref": "#/definitions/PrivateEndpointConnection"
+ "$ref": "../../../../../common-types/resource-management/v1/privatelinks.json#/definitions/PrivateEndpointConnection"
},
"description": "List of private endpoint connection associated with the specified storage account"
},
@@ -3193,6 +3237,13 @@
"type": "string"
},
"description": "An array of predefined enum values. Only blockBlob is supported."
+ },
+ "blobIndexMatch": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/TagFilter"
+ },
+ "description": "An array of blob index tag based filters, there can be at most 10 tag filters"
}
},
"required": [
@@ -3200,6 +3251,32 @@
],
"description": "Filters limit rule actions to a subset of blobs within the storage account. If multiple filters are defined, a logical AND is performed on all filters. "
},
+ "TagFilter": {
+ "properties": {
+ "name": {
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 128,
+ "description": "This is the filter tag name, it can have 1 - 128 characters"
+ },
+ "op": {
+ "type": "string",
+ "description": "This is the comparison operator which is used for object comparison and filtering. Only == (equality operator) is currently supported"
+ },
+ "value": {
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 256,
+ "description": "This is the filter tag value field used for tag based filtering, it can have 0 - 256 characters"
+ }
+ },
+ "required": [
+ "name",
+ "op",
+ "value"
+ ],
+ "description": "Blob index tag based filtering for blob objects"
+ },
"ManagementPolicyAction": {
"properties": {
"baseBlob": {
@@ -3267,148 +3344,6 @@
],
"description": "Object to define the number of days after creation."
},
- "PrivateEndpointConnection": {
- "properties": {
- "properties": {
- "$ref": "#/definitions/PrivateEndpointConnectionProperties",
- "x-ms-client-flatten": true,
- "description": "Resource properties."
- }
- },
- "allOf": [
- {
- "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/Resource"
- }
- ],
- "description": "The Private Endpoint Connection resource."
- },
- "PrivateEndpointConnectionProperties": {
- "properties": {
- "privateEndpoint": {
- "$ref": "#/definitions/PrivateEndpoint",
- "description": "The resource of private end point."
- },
- "privateLinkServiceConnectionState": {
- "$ref": "#/definitions/PrivateLinkServiceConnectionState",
- "description": "A collection of information about the state of the connection between service consumer and provider."
- },
- "provisioningState": {
- "$ref": "#/definitions/PrivateEndpointConnectionProvisioningState",
- "description": "The provisioning state of the private endpoint connection resource."
- }
- },
- "required": [
- "privateLinkServiceConnectionState"
- ],
- "description": "Properties of the PrivateEndpointConnectProperties."
- },
- "PrivateEndpoint": {
- "properties": {
- "id": {
- "readOnly": true,
- "type": "string",
- "description": "The ARM identifier for Private Endpoint"
- }
- },
- "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."
- },
- "actionRequired": {
- "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"
- ],
- "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": "../../../../../common-types/resource-management/v1/types.json#/definitions/Resource"
- }
- ],
- "description": "A private link resource"
- },
- "PrivateLinkResourceProperties": {
- "properties": {
- "groupId": {
- "description": "The private link resource group id.",
- "type": "string",
- "readOnly": true
- },
- "requiredMembers": {
- "description": "The private link resource required member names.",
- "type": "array",
- "items": {
- "type": "string"
- },
- "readOnly": true
- },
- "requiredZoneNames": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "description": "The private link resource Private link DNS zone name."
- }
- },
- "description": "Properties of a private link resource."
- },
"EncryptionScope": {
"properties": {
"properties": {
@@ -3651,14 +3586,6 @@
},
"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 Storage Account",
- "x-ms-parameter-location": "method"
- },
"EncryptionScopeName": {
"name": "encryptionScopeName",
"in": "path",
diff --git a/specification/storage/resource-manager/Microsoft.Storage/stable/2019-06-01/table.json b/specification/storage/resource-manager/Microsoft.Storage/stable/2019-06-01/table.json
new file mode 100644
index 000000000000..3d99550ab402
--- /dev/null
+++ b/specification/storage/resource-manager/Microsoft.Storage/stable/2019-06-01/table.json
@@ -0,0 +1,495 @@
+{
+ "swagger": "2.0",
+ "info": {
+ "version": "2019-06-01",
+ "title": "StorageManagementClient",
+ "description": "The Azure Storage Management API."
+ },
+ "host": "management.azure.com",
+ "schemes": [
+ "https"
+ ],
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "paths": {
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/tableServices": {
+ "get": {
+ "tags": [
+ "TableServiceProperties"
+ ],
+ "operationId": "TableServices_List",
+ "x-ms-examples": {
+ "TableServicesList": {
+ "$ref": "./examples/TableServicesList.json"
+ }
+ },
+ "description": "List all table services for the storage account.",
+ "parameters": [
+ {
+ "$ref": "./storage.json#/parameters/ResourceGroupName"
+ },
+ {
+ "$ref": "./storage.json#/parameters/StorageAccountName"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK -- returned the properties of a storage account’s Table service.",
+ "schema": {
+ "$ref": "#/definitions/ListTableServices"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "./file.json#/definitions/CloudError"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/tableServices/{tableServiceName}": {
+ "put": {
+ "tags": [
+ "TableServiceProperties"
+ ],
+ "operationId": "TableServices_SetServiceProperties",
+ "x-ms-examples": {
+ "TableServicesPut": {
+ "$ref": "./examples/TableServicesPut.json"
+ }
+ },
+ "description": "Sets the properties of a storage account’s Table service, including properties for Storage Analytics and CORS (Cross-Origin Resource Sharing) rules. ",
+ "parameters": [
+ {
+ "$ref": "./storage.json#/parameters/ResourceGroupName"
+ },
+ {
+ "$ref": "./storage.json#/parameters/StorageAccountName"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/TableServiceName"
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/TableServiceProperties"
+ },
+ "description": "The properties of a storage account’s Table service, only properties for Storage Analytics and CORS (Cross-Origin Resource Sharing) rules can be specified."
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK -- Sets The properties of a storage account’s Table service successfully.",
+ "schema": {
+ "$ref": "#/definitions/TableServiceProperties"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "./file.json#/definitions/CloudError"
+ }
+ }
+ }
+ },
+ "get": {
+ "tags": [
+ "TableServiceProperties"
+ ],
+ "operationId": "TableServices_GetServiceProperties",
+ "x-ms-examples": {
+ "TableServicesGet": {
+ "$ref": "./examples/TableServicesGet.json"
+ }
+ },
+ "description": "Gets the properties of a storage account’s Table service, including properties for Storage Analytics and CORS (Cross-Origin Resource Sharing) rules.",
+ "parameters": [
+ {
+ "$ref": "./storage.json#/parameters/ResourceGroupName"
+ },
+ {
+ "$ref": "./storage.json#/parameters/StorageAccountName"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/TableServiceName"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK -- returned the properties of a storage account’s Table service.",
+ "schema": {
+ "$ref": "#/definitions/TableServiceProperties"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "./file.json#/definitions/CloudError"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/tableServices/default/tables/{tableName}": {
+ "put": {
+ "tags": [
+ "TableService"
+ ],
+ "operationId": "Table_Create",
+ "x-ms-examples": {
+ "TableOperationPut": {
+ "$ref": "./examples/TableOperationPut.json"
+ }
+ },
+ "description": "Creates a new table with the specified table name, under the specified account.",
+ "parameters": [
+ {
+ "$ref": "./storage.json#/parameters/ResourceGroupName"
+ },
+ {
+ "$ref": "./storage.json#/parameters/StorageAccountName"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/TableName"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK -- Creates a table with the given table name successfully.",
+ "schema": {
+ "$ref": "#/definitions/Table"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "./file.json#/definitions/CloudError"
+ }
+ }
+ }
+ },
+ "patch": {
+ "tags": [
+ "TableService"
+ ],
+ "operationId": "Table_Update",
+ "x-ms-examples": {
+ "TableOperationPatch": {
+ "$ref": "./examples/TableOperationPatch.json"
+ }
+ },
+ "description": "Creates a new table with the specified table name, under the specified account.",
+ "parameters": [
+ {
+ "$ref": "./storage.json#/parameters/ResourceGroupName"
+ },
+ {
+ "$ref": "./storage.json#/parameters/StorageAccountName"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/TableName"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK -- Creates a table with the given table name successfully.",
+ "schema": {
+ "$ref": "#/definitions/Table"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "./file.json#/definitions/CloudError"
+ }
+ }
+ }
+ },
+ "get": {
+ "tags": [
+ "TableService"
+ ],
+ "operationId": "Table_Get",
+ "x-ms-examples": {
+ "TableOperationGet": {
+ "$ref": "./examples/TableOperationGet.json"
+ }
+ },
+ "description": "Gets the table with the specified table name, under the specified account if it exists.",
+ "parameters": [
+ {
+ "$ref": "./storage.json#/parameters/ResourceGroupName"
+ },
+ {
+ "$ref": "./storage.json#/parameters/StorageAccountName"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/TableName"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK -- returned table with the specified table name successfully.",
+ "schema": {
+ "$ref": "#/definitions/Table"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "./file.json#/definitions/CloudError"
+ }
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "TableService"
+ ],
+ "operationId": "Table_Delete",
+ "x-ms-examples": {
+ "TableOperationDelete": {
+ "$ref": "./examples/TableOperationDelete.json"
+ }
+ },
+ "description": "Deletes the table with the specified table name, under the specified account if it exists.",
+ "parameters": [
+ {
+ "$ref": "./storage.json#/parameters/ResourceGroupName"
+ },
+ {
+ "$ref": "./storage.json#/parameters/StorageAccountName"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/TableName"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "No Content - Successfully deleted the table with the specified table name"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "./file.json#/definitions/CloudError"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/tableServices/default/tables": {
+ "get": {
+ "tags": [
+ "TableService"
+ ],
+ "operationId": "Table_List",
+ "x-ms-examples": {
+ "TableOperationList": {
+ "$ref": "./examples/TableOperationList.json"
+ }
+ },
+ "description": "Gets a list of all the tables under the specified storage account",
+ "parameters": [
+ {
+ "$ref": "./storage.json#/parameters/ResourceGroupName"
+ },
+ {
+ "$ref": "./storage.json#/parameters/StorageAccountName"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK -- returned a list of tables successfully.",
+ "schema": {
+ "$ref": "#/definitions/ListTableResource"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "./file.json#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ }
+ },
+ "definitions": {
+ "ListTableServices": {
+ "properties": {
+ "value": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/TableServiceProperties"
+ },
+ "description": "List of table services returned.",
+ "readOnly": true
+ }
+ }
+ },
+ "TableServiceProperties": {
+ "properties": {
+ "properties": {
+ "properties": {
+ "cors": {
+ "$ref": "./common.json#/definitions/CorsRules",
+ "description": "Specifies CORS rules for the Table service. You can include up to five CorsRule elements in the request. If no CorsRule elements are included in the request body, all CORS rules will be deleted, and CORS will be disabled for the Table service."
+ }
+ },
+ "x-ms-client-flatten": true,
+ "x-ms-client-name": "TableServiceProperties",
+ "description": "The properties of a storage account’s Table service."
+ }
+ },
+ "allOf": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/Resource"
+ }
+ ],
+ "description": "The properties of a storage account’s Table service."
+ },
+ "Table": {
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/TableProperties",
+ "x-ms-client-flatten": true,
+ "x-ms-client-name": "TableProperties",
+ "description": "Table resource properties."
+ }
+ },
+ "allOf": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/Resource"
+ }
+ ],
+ "description": "Properties of the table, including Id, resource name, resource type."
+ },
+ "TableProperties": {
+ "properties": {
+ "tableName": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Table name under the specified account"
+ }
+ }
+ },
+ "ListTableResource": {
+ "properties": {
+ "value": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/Table"
+ },
+ "description": "List of tables returned.",
+ "readOnly": true
+ },
+ "nextLink": {
+ "type": "string",
+ "description": "Request URL that can be used to query next page of tables",
+ "readOnly": true
+ }
+ },
+ "description": "Response schema. Contains list of tables returned"
+ }
+ },
+ "parameters": {
+ "TableServiceName": {
+ "name": "tableServiceName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the Table Service within the specified storage account. Table Service Name must be 'default'",
+ "enum": [
+ "default"
+ ],
+ "x-ms-parameter-location": "method"
+ },
+ "TableName": {
+ "name": "tableName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "A table name must be unique within a storage account and must be between 3 and 63 characters.The name must comprise of only alphanumeric characters and it cannot begin with a numeric character.",
+ "maxLength": 63,
+ "minLength": 3,
+ "pattern": "^[A-Za-z][A-Za-z0-9]{2,62}$",
+ "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/storage/resource-manager/readme.md b/specification/storage/resource-manager/readme.md
index a13e1dafd348..2e22b135e433 100644
--- a/specification/storage/resource-manager/readme.md
+++ b/specification/storage/resource-manager/readme.md
@@ -38,6 +38,8 @@ input-file:
- Microsoft.Storage/stable/2019-06-01/storage.json
- Microsoft.Storage/stable/2019-06-01/blob.json
- Microsoft.Storage/stable/2019-06-01/file.json
+- Microsoft.Storage/stable/2019-06-01/queue.json
+- Microsoft.Storage/stable/2019-06-01/table.json
directive:
- suppress: R3018
@@ -269,6 +271,7 @@ swagger-to-sdk:
after_scripts:
- python ./scripts/multiapi_init_gen.py azure-mgmt-storage
- python ./scripts/trim_aio.py ./sdk/storage/azure-mgmt-storage
+ - repo: azure-sdk-for-python-track2
- repo: azure-sdk-for-java
- repo: azure-sdk-for-go
- repo: azure-sdk-for-node
@@ -297,6 +300,8 @@ input-file:
- $(this-folder)/Microsoft.Storage/stable/2019-06-01/storage.json
- $(this-folder)/Microsoft.Storage/stable/2019-06-01/blob.json
- $(this-folder)/Microsoft.Storage/stable/2019-06-01/file.json
+ - $(this-folder)/Microsoft.Storage/stable/2019-06-01/queue.json
+ - $(this-folder)/Microsoft.Storage/stable/2019-06-01/table.json
- $(this-folder)/Microsoft.Storage/stable/2019-04-01/storage.json
- $(this-folder)/Microsoft.Storage/stable/2019-04-01/blob.json
- $(this-folder)/Microsoft.Storage/stable/2019-04-01/file.json
diff --git a/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2020-03-01/examples/AscOperations_Get.json b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2020-03-01/examples/AscOperations_Get.json
new file mode 100644
index 000000000000..783476d2d00e
--- /dev/null
+++ b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2020-03-01/examples/AscOperations_Get.json
@@ -0,0 +1,20 @@
+{
+ "parameters": {
+ "subscriptionId": "613192d7-503f-477a-9cfe-4efc3ee2bd60",
+ "location": "West US",
+ "operationId": "testoperationid",
+ "api-version": "2020-03-01"
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": {
+ "id": "/subscriptions/id/locations/westus/ascOperations/testoperationid",
+ "name": "testoperationid",
+ "startTime": "2020-03-01T13:13:13.933Z",
+ "endTime": "2020-03-01T16:13:13.933Z",
+ "status": "Succeeded"
+ }
+ }
+ }
+}
diff --git a/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2020-03-01/examples/Caches_CreateOrUpdate.json b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2020-03-01/examples/Caches_CreateOrUpdate.json
new file mode 100644
index 000000000000..5673dedad5c4
--- /dev/null
+++ b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2020-03-01/examples/Caches_CreateOrUpdate.json
@@ -0,0 +1,97 @@
+{
+ "parameters": {
+ "resourceGroupName": "scgroup",
+ "cacheName": "sc1",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "api-version": "2020-03-01",
+ "cache": {
+ "tags": {
+ "Dept": "ContosoAds"
+ },
+ "location": "westus",
+ "properties": {
+ "cacheSizeGB": 3072,
+ "subnet": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.Network/virtualNetworks/scvnet/subnets/sub1"
+ },
+ "sku": {
+ "name": "Standard_2G"
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "body": {
+ "tags": {
+ "Dept": "ContosoAds"
+ },
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.StorageCache/caches/sc1",
+ "location": "westus",
+ "name": "sc1",
+ "type": "Microsoft.StorageCache/Cache",
+ "properties": {
+ "cacheSizeGB": 3072,
+ "health": {
+ "state": "Transitioning",
+ "statusDescription": "Cache is being created."
+ },
+ "mountAddresses": [
+ "192.168.1.1",
+ "192.168.1.2"
+ ],
+ "provisioningState": "Succeeded",
+ "subnet": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.Network/virtualNetworks/scvnet/subnets/sub1",
+ "upgradeStatus": {
+ "currentFirmwareVersion": "5.3.23",
+ "firmwareUpdateStatus": "available",
+ "firmwareUpdateDeadline": "2019-04-21T18:25:43.511Z",
+ "lastFirmwareUpdate": "2019-01-21T18:25:43.511Z",
+ "pendingFirmwareVersion": "5.3.24"
+ },
+ "networkSettings": {
+ "mtu": 1500
+ }
+ },
+ "sku": {
+ "name": "Standard_2G"
+ }
+ }
+ },
+ "200": {
+ "body": {
+ "tags": {
+ "Dept": "ContosoAds"
+ },
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.StorageCache/caches/sc1",
+ "location": "westus",
+ "name": "sc1",
+ "type": "Microsoft.StorageCache/Cache",
+ "properties": {
+ "cacheSizeGB": 3072,
+ "health": {
+ "state": "Transitioning",
+ "statusDescription": "Cache is being created."
+ },
+ "mountAddresses": [
+ "192.168.1.1",
+ "192.168.1.2"
+ ],
+ "provisioningState": "Updating",
+ "subnet": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.Network/virtualNetworks/scvnet/subnets/sub1",
+ "upgradeStatus": {
+ "currentFirmwareVersion": "V5.1.12",
+ "firmwareUpdateStatus": "available",
+ "firmwareUpdateDeadline": "2019-04-21T18:25:43.511Z",
+ "lastFirmwareUpdate": "2019-01-21T18:25:43.511Z",
+ "pendingFirmwareVersion": "V5.1.15"
+ },
+ "networkSettings": {
+ "mtu": 1500
+ }
+ },
+ "sku": {
+ "name": "Standard_2G"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2020-03-01/examples/Caches_Delete.json b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2020-03-01/examples/Caches_Delete.json
new file mode 100644
index 000000000000..84d0398fe28d
--- /dev/null
+++ b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2020-03-01/examples/Caches_Delete.json
@@ -0,0 +1,19 @@
+{
+ "parameters": {
+ "resourceGroupName": "scgroup",
+ "cacheName": "sc",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "api-version": "2020-03-01"
+ },
+ "responses": {
+ "200": {
+ "body": ""
+ },
+ "202": {
+ "body": ""
+ },
+ "204": {
+ "body": ""
+ }
+ }
+}
diff --git a/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2020-03-01/examples/Caches_Flush.json b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2020-03-01/examples/Caches_Flush.json
new file mode 100644
index 000000000000..84d0398fe28d
--- /dev/null
+++ b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2020-03-01/examples/Caches_Flush.json
@@ -0,0 +1,19 @@
+{
+ "parameters": {
+ "resourceGroupName": "scgroup",
+ "cacheName": "sc",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "api-version": "2020-03-01"
+ },
+ "responses": {
+ "200": {
+ "body": ""
+ },
+ "202": {
+ "body": ""
+ },
+ "204": {
+ "body": ""
+ }
+ }
+}
diff --git a/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2020-03-01/examples/Caches_Get.json b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2020-03-01/examples/Caches_Get.json
new file mode 100644
index 000000000000..51ff1db2e017
--- /dev/null
+++ b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2020-03-01/examples/Caches_Get.json
@@ -0,0 +1,47 @@
+{
+ "parameters": {
+ "resourceGroupName": "scgroup",
+ "cacheName": "sc1",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "api-version": "2020-03-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "tags": {
+ "Dept": "ContosoAds"
+ },
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.StorageCache/caches/sc1",
+ "location": "westus",
+ "name": "sc1",
+ "type": "Microsoft.StorageCache/Cache",
+ "properties": {
+ "cacheSizeGB": 3072,
+ "health": {
+ "state": "Transitioning",
+ "statusDescription": "Cache is being created."
+ },
+ "mountAddresses": [
+ "192.168.1.1",
+ "192.168.1.2"
+ ],
+ "provisioningState": "Succeeded",
+ "subnet": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.Network/virtualNetworks/scvnet/subnets/sub1",
+ "upgradeStatus": {
+ "currentFirmwareVersion": "V5.1.12",
+ "firmwareUpdateStatus": "available",
+ "firmwareUpdateDeadline": "2019-04-21T18:25:43.511Z",
+ "lastFirmwareUpdate": "2019-01-21T18:25:43.511Z",
+ "pendingFirmwareVersion": "V5.1.15"
+ },
+ "networkSettings": {
+ "mtu": 1500
+ }
+ },
+ "sku": {
+ "name": "Standard_2G"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2020-03-01/examples/Caches_List.json b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2020-03-01/examples/Caches_List.json
new file mode 100644
index 000000000000..30094bbfd392
--- /dev/null
+++ b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2020-03-01/examples/Caches_List.json
@@ -0,0 +1,84 @@
+{
+ "parameters": {
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "api-version": "2020-03-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "tags": {
+ "Dept": "ContosoAds"
+ },
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.StorageCache/caches/sc1",
+ "location": "westus",
+ "name": "sc1",
+ "type": "Microsoft.StorageCache/Cache",
+ "properties": {
+ "cacheSizeGB": 3072,
+ "health": {
+ "state": "Transitioning",
+ "statusDescription": "Cache is being created."
+ },
+ "mountAddresses": [
+ "192.168.1.1",
+ "192.168.1.2"
+ ],
+ "provisioningState": "Succeeded",
+ "subnet": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.Network/virtualNetworks/scvnet/subnets/sub1",
+ "upgradeStatus": {
+ "currentFirmwareVersion": "V5.1.12",
+ "firmwareUpdateStatus": "available",
+ "firmwareUpdateDeadline": "2019-04-21T18:25:43.511Z",
+ "lastFirmwareUpdate": "2019-01-21T18:25:43.511Z",
+ "pendingFirmwareVersion": "V5.1.15"
+ },
+ "networkSettings": {
+ "mtu": 1500
+ }
+ },
+ "sku": {
+ "name": "Standard_2G"
+ }
+ },
+ {
+ "tags": {
+ "Dept": "ContosoAds"
+ },
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.StorageCache/caches/sc2",
+ "location": "westus",
+ "name": "sc2",
+ "type": "Microsoft.StorageCache/Cache",
+ "properties": {
+ "cacheSizeGB": 3072,
+ "health": {
+ "state": "Transitioning",
+ "statusDescription": "Cache is being created."
+ },
+ "mountAddresses": [
+ "192.168.1.1",
+ "192.168.1.2"
+ ],
+ "provisioningState": "Updating",
+ "subnet": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.Network/virtualNetworks/scvnet/subnets/sub2",
+ "upgradeStatus": {
+ "currentFirmwareVersion": "V5.1.12",
+ "firmwareUpdateStatus": "available",
+ "firmwareUpdateDeadline": "2019-04-21T18:25:43.511Z",
+ "lastFirmwareUpdate": "2019-01-21T18:25:43.511Z",
+ "pendingFirmwareVersion": "V5.1.15"
+ },
+ "networkSettings": {
+ "mtu": 1500
+ }
+ },
+ "sku": {
+ "name": "Standard_2G"
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2020-03-01/examples/Caches_ListByResourceGroup.json b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2020-03-01/examples/Caches_ListByResourceGroup.json
new file mode 100644
index 000000000000..015a5719b0a4
--- /dev/null
+++ b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2020-03-01/examples/Caches_ListByResourceGroup.json
@@ -0,0 +1,85 @@
+{
+ "parameters": {
+ "resourceGroupName": "scgroup",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "api-version": "2020-03-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "tags": {
+ "Dept": "ContosoAds"
+ },
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.StorageCache/caches/sc1",
+ "location": "westus",
+ "name": "sc1",
+ "type": "Microsoft.StorageCache/Cache",
+ "properties": {
+ "cacheSizeGB": 3072,
+ "health": {
+ "state": "Transitioning",
+ "statusDescription": "Cache is being created."
+ },
+ "mountAddresses": [
+ "192.168.1.1",
+ "192.168.1.2"
+ ],
+ "provisioningState": "Succeeded",
+ "subnet": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.Network/virtualNetworks/scvnet/subnets/sub1",
+ "upgradeStatus": {
+ "currentFirmwareVersion": "V5.1.12",
+ "firmwareUpdateStatus": "available",
+ "firmwareUpdateDeadline": "2019-04-21T18:25:43.511Z",
+ "lastFirmwareUpdate": "2019-01-21T18:25:43.511Z",
+ "pendingFirmwareVersion": "V5.1.15"
+ },
+ "networkSettings": {
+ "mtu": 1500
+ }
+ },
+ "sku": {
+ "name": "Standard_2G"
+ }
+ },
+ {
+ "tags": {
+ "Dept": "ContosoAds"
+ },
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.StorageCache/caches/sc2",
+ "location": "westus",
+ "name": "sc2",
+ "type": "Microsoft.StorageCache/Cache",
+ "properties": {
+ "cacheSizeGB": 3072,
+ "health": {
+ "state": "Transitioning",
+ "statusDescription": "Cache is being created."
+ },
+ "mountAddresses": [
+ "192.168.1.1",
+ "192.168.1.2"
+ ],
+ "provisioningState": "Updating",
+ "subnet": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.Network/virtualNetworks/scvnet/subnets/sub2",
+ "upgradeStatus": {
+ "currentFirmwareVersion": "V5.1.12",
+ "firmwareUpdateStatus": "available",
+ "firmwareUpdateDeadline": "2019-04-21T18:25:43.511Z",
+ "lastFirmwareUpdate": "2019-01-21T18:25:43.511Z",
+ "pendingFirmwareVersion": "V5.1.15"
+ },
+ "networkSettings": {
+ "mtu": 1500
+ }
+ },
+ "sku": {
+ "name": "Standard_2G"
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2020-03-01/examples/Caches_Start.json b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2020-03-01/examples/Caches_Start.json
new file mode 100644
index 000000000000..84d0398fe28d
--- /dev/null
+++ b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2020-03-01/examples/Caches_Start.json
@@ -0,0 +1,19 @@
+{
+ "parameters": {
+ "resourceGroupName": "scgroup",
+ "cacheName": "sc",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "api-version": "2020-03-01"
+ },
+ "responses": {
+ "200": {
+ "body": ""
+ },
+ "202": {
+ "body": ""
+ },
+ "204": {
+ "body": ""
+ }
+ }
+}
diff --git a/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2020-03-01/examples/Caches_Stop.json b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2020-03-01/examples/Caches_Stop.json
new file mode 100644
index 000000000000..84d0398fe28d
--- /dev/null
+++ b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2020-03-01/examples/Caches_Stop.json
@@ -0,0 +1,19 @@
+{
+ "parameters": {
+ "resourceGroupName": "scgroup",
+ "cacheName": "sc",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "api-version": "2020-03-01"
+ },
+ "responses": {
+ "200": {
+ "body": ""
+ },
+ "202": {
+ "body": ""
+ },
+ "204": {
+ "body": ""
+ }
+ }
+}
diff --git a/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2020-03-01/examples/Caches_Update.json b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2020-03-01/examples/Caches_Update.json
new file mode 100644
index 000000000000..61fac4750c6d
--- /dev/null
+++ b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2020-03-01/examples/Caches_Update.json
@@ -0,0 +1,60 @@
+{
+ "parameters": {
+ "resourceGroupName": "scgroup",
+ "cacheName": "sc1",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "api-version": "2020-03-01",
+ "cache": {
+ "tags": {
+ "Dept": "ContosoAds"
+ },
+ "location": "westus",
+ "properties": {
+ "cacheSizeGB": 3072,
+ "subnet": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.Network/virtualNetworks/scvnet/subnets/sub1"
+ },
+ "sku": {
+ "name": "Standard_2G"
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "tags": {
+ "Dept": "ContosoAds"
+ },
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.StorageCache/caches/sc1",
+ "location": "westus",
+ "name": "sc1",
+ "type": "Microsoft.StorageCache/Cache",
+ "properties": {
+ "cacheSizeGB": 3072,
+ "health": {
+ "state": "Transitioning",
+ "statusDescription": "Cache is being created."
+ },
+ "mountAddresses": [
+ "192.168.1.1",
+ "192.168.1.2"
+ ],
+ "provisioningState": "Updating",
+ "subnet": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.Network/virtualNetworks/scvnet/subnets/sub1",
+ "upgradeStatus": {
+ "currentFirmwareVersion": "V5.1.12",
+ "firmwareUpdateStatus": "available",
+ "firmwareUpdateDeadline": "2019-04-21T18:25:43.511Z",
+ "lastFirmwareUpdate": "2019-01-21T18:25:43.511Z",
+ "pendingFirmwareVersion": "V5.1.15"
+ },
+ "networkSettings": {
+ "mtu": 1500
+ }
+ },
+ "sku": {
+ "name": "Standard_2G"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2020-03-01/examples/Caches_UpgradeFirmware.json b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2020-03-01/examples/Caches_UpgradeFirmware.json
new file mode 100644
index 000000000000..8fc7d10d1476
--- /dev/null
+++ b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2020-03-01/examples/Caches_UpgradeFirmware.json
@@ -0,0 +1,19 @@
+{
+ "parameters": {
+ "resourceGroupName": "scgroup",
+ "cacheName": "sc1",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "api-version": "2020-03-01"
+ },
+ "responses": {
+ "201": {
+ "body": ""
+ },
+ "202": {
+ "body": ""
+ },
+ "204": {
+ "body": ""
+ }
+ }
+}
diff --git a/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2020-03-01/examples/Operations_List.json b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2020-03-01/examples/Operations_List.json
new file mode 100644
index 000000000000..458e833f469c
--- /dev/null
+++ b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2020-03-01/examples/Operations_List.json
@@ -0,0 +1,35 @@
+{
+ "parameters": {
+ "api-version": "2020-03-01",
+ "x-ms-client-request-id": [
+ "7e655b68-e491-4cb6-90c3-6a5b10b7bd17"
+ ],
+ "accept-language": [
+ "en-US"
+ ]
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "name": "Microsoft.StorageCache/caches/write",
+ "display": {
+ "operation": "Create or Update Cache",
+ "provider": "Azure Storage Cache",
+ "resource": "Caches"
+ }
+ },
+ {
+ "name": "Microsoft.StorageCache/caches/delete",
+ "display": {
+ "operation": "Delete Cache",
+ "provider": "Azure Storage Cache",
+ "resource": "Caches"
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2020-03-01/examples/Skus_List.json b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2020-03-01/examples/Skus_List.json
new file mode 100644
index 000000000000..39f07ea8835a
--- /dev/null
+++ b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2020-03-01/examples/Skus_List.json
@@ -0,0 +1,86 @@
+{
+ "parameters": {
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "api-version": "2020-03-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "resourceType": "caches",
+ "name": "Standard_2G",
+ "locations": [
+ "East US"
+ ],
+ "locationInfo": [
+ {
+ "location": "East US",
+ "zones": []
+ }
+ ],
+ "capabilities": [
+ {
+ "name": "throughput GB/s",
+ "value": "2"
+ },
+ {
+ "name": "cache sizes(GB)",
+ "value": "3072,6144,12288"
+ }
+ ],
+ "restrictions": []
+ },
+ {
+ "resourceType": "caches",
+ "name": "Standard_4G",
+ "locations": [
+ "East US"
+ ],
+ "locationInfo": [
+ {
+ "location": "East US",
+ "zones": []
+ }
+ ],
+ "capabilities": [
+ {
+ "name": "throughput GB/s",
+ "value": "4"
+ },
+ {
+ "name": "cache sizes(GB)",
+ "value": "6144,12288,24576"
+ }
+ ],
+ "restrictions": []
+ },
+ {
+ "resourceType": "caches",
+ "name": "Standard_8G",
+ "locations": [
+ "East US"
+ ],
+ "locationInfo": [
+ {
+ "location": "East US",
+ "zones": []
+ }
+ ],
+ "capabilities": [
+ {
+ "name": "throughput GB/s",
+ "value": "8"
+ },
+ {
+ "name": "cache sizes(GB)",
+ "value": "12288,24576,49152"
+ }
+ ],
+ "restrictions": []
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2020-03-01/examples/StorageTargets_CreateOrUpdate.json b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2020-03-01/examples/StorageTargets_CreateOrUpdate.json
new file mode 100644
index 000000000000..805692e66fd3
--- /dev/null
+++ b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2020-03-01/examples/StorageTargets_CreateOrUpdate.json
@@ -0,0 +1,84 @@
+{
+ "parameters": {
+ "resourceGroupName": "scgroup",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "api-version": "2020-03-01",
+ "cacheName": "sc1",
+ "storageTargetName": "st1",
+ "storagetarget": {
+ "properties": {
+ "junctions": [
+ {
+ "namespacePath": "/path/on/cache",
+ "targetPath": "/path/on/exp1",
+ "nfsExport": "exp1"
+ },
+ {
+ "namespacePath": "/path2/on/cache",
+ "targetPath": "/path2/on/exp2",
+ "nfsExport": "exp2"
+ }
+ ],
+ "targetType": "nfs3",
+ "nfs3": {
+ "target": "10.0.44.44",
+ "usageModel": "READ_HEAVY_INFREQ"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "name": "st1",
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.StorageCache/caches/sc1/storagetargets/st1",
+ "type": "Microsoft.StorageCache/Cache/StorageTarget",
+ "properties": {
+ "junctions": [
+ {
+ "namespacePath": "/path/on/cache",
+ "targetPath": "/path/on/exp1",
+ "nfsExport": "exp1"
+ },
+ {
+ "namespacePath": "/path2/on/cache",
+ "targetPath": "/path2/on/exp2",
+ "nfsExport": "exp2"
+ }
+ ],
+ "targetType": "nfs3",
+ "nfs3": {
+ "target": "10.0.44.44",
+ "usageModel": "READ_HEAVY_INFREQ"
+ }
+ }
+ }
+ },
+ "201": {
+ "body": {
+ "name": "st1",
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.StorageCache/caches/sc1/storagetargets/st1",
+ "type": "Microsoft.StorageCache/Cache/StorageTarget",
+ "properties": {
+ "junctions": [
+ {
+ "namespacePath": "/path/on/cache",
+ "targetPath": "/path/on/exp1",
+ "nfsExport": "exp1"
+ },
+ {
+ "namespacePath": "/path2/on/cache",
+ "targetPath": "/path2/on/exp2",
+ "nfsExport": "exp2"
+ }
+ ],
+ "targetType": "nfs3",
+ "nfs3": {
+ "target": "10.0.44.44",
+ "usageModel": "READ_HEAVY_INFREQ"
+ }
+ }
+ }
+ }
+ }
+}
diff --git a/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2020-03-01/examples/StorageTargets_Delete.json b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2020-03-01/examples/StorageTargets_Delete.json
new file mode 100644
index 000000000000..1eff5e3b6b78
--- /dev/null
+++ b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2020-03-01/examples/StorageTargets_Delete.json
@@ -0,0 +1,20 @@
+{
+ "parameters": {
+ "resourceGroupName": "scgroup",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "api-version": "2020-03-01",
+ "cacheName": "sc1",
+ "storageTargetName": "st1"
+ },
+ "responses": {
+ "200": {
+ "body": ""
+ },
+ "202": {
+ "body": ""
+ },
+ "204": {
+ "body": ""
+ }
+ }
+}
diff --git a/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2020-03-01/examples/StorageTargets_Get.json b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2020-03-01/examples/StorageTargets_Get.json
new file mode 100644
index 000000000000..a574190989f5
--- /dev/null
+++ b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2020-03-01/examples/StorageTargets_Get.json
@@ -0,0 +1,37 @@
+{
+ "parameters": {
+ "resourceGroupName": "scgroup",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "api-version": "2020-03-01",
+ "cacheName": "sc1",
+ "storageTargetName": "st1"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "name": "st1",
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.StorageCache/caches/sc1/storagetargets/st1",
+ "type": "Microsoft.StorageCache/Cache/StorageTarget",
+ "properties": {
+ "junctions": [
+ {
+ "namespacePath": "/path/on/cache",
+ "targetPath": "/path/on/exp1",
+ "nfsExport": "exp1"
+ },
+ {
+ "namespacePath": "/path2/on/cache",
+ "targetPath": "/path2/on/exp2",
+ "nfsExport": "exp2"
+ }
+ ],
+ "targetType": "nfs3",
+ "nfs3": {
+ "target": "10.0.44.44",
+ "usageModel": "READ_HEAVY_FREQ"
+ }
+ }
+ }
+ }
+ }
+}
diff --git a/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2020-03-01/examples/StorageTargets_ListByCache.json b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2020-03-01/examples/StorageTargets_ListByCache.json
new file mode 100644
index 000000000000..cd34e580eccf
--- /dev/null
+++ b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2020-03-01/examples/StorageTargets_ListByCache.json
@@ -0,0 +1,78 @@
+{
+ "parameters": {
+ "resourceGroupName": "scgroup",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "api-version": "2020-03-01",
+ "cacheName": "sc1"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "name": "st1",
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.StorageCache/caches/sc1/storagetargets/st1",
+ "type": "Microsoft.StorageCache/Cache/StorageTarget",
+ "properties": {
+ "junctions": [
+ {
+ "namespacePath": "/path/on/cache",
+ "targetPath": "/path/on/exp1",
+ "nfsExport": "exp1"
+ },
+ {
+ "namespacePath": "/path2/on/cache",
+ "targetPath": "/path2/on/exp2",
+ "nfsExport": "exp2"
+ }
+ ],
+ "targetType": "nfs3",
+ "nfs3": {
+ "target": "10.0.44.44",
+ "usageModel": "READ_HEAVY_FREQ"
+ }
+ }
+ },
+ {
+ "name": "st2",
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.StorageCache/caches/sc1/storagetargets/st2",
+ "type": "Microsoft.StorageCache/Cache/StorageTarget",
+ "properties": {
+ "junctions": [
+ {
+ "namespacePath": "/some/crazy/place/on/cache",
+ "targetPath": "/"
+ }
+ ],
+ "targetType": "clfs",
+ "clfs": {
+ "target": "https://atj5c2fc9b8c00.blob.core.windows.net/atj5c2fc9b8c01"
+ }
+ }
+ },
+ {
+ "name": "st3",
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.StorageCache/caches/sc1/storagetargets/st3",
+ "type": "Microsoft.StorageCache/Cache/StorageTarget",
+ "properties": {
+ "junctions": [
+ {
+ "namespacePath": "/some/crazier/place/on/cache",
+ "targetPath": "/",
+ "nfsExport": ""
+ }
+ ],
+ "targetType": "unknown",
+ "unknown": {
+ "unknownMap": {
+ "foo": "bar",
+ "foo2": "test"
+ }
+ }
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2020-03-01/examples/UsageModels_List.json b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2020-03-01/examples/UsageModels_List.json
new file mode 100644
index 000000000000..dbfb82b4dba2
--- /dev/null
+++ b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2020-03-01/examples/UsageModels_List.json
@@ -0,0 +1,35 @@
+{
+ "parameters": {
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "api-version": "2020-03-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "modelName": "READ_HEAVY_INFREQ",
+ "targetType": "nfs3",
+ "display": {
+ "description": "Read heavy, infrequent changes"
+ }
+ },
+ {
+ "modelName": "WRITE_AROUND",
+ "targetType": "nfs3",
+ "display": {
+ "description": "Clients write directly to storage"
+ }
+ },
+ {
+ "modelName": "WRITE_WORKLOAD_15",
+ "targetType": "nfs3",
+ "display": {
+ "description": "Write workload > 15%"
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2020-03-01/storagecache.json b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2020-03-01/storagecache.json
new file mode 100644
index 000000000000..2e1cdcb3872d
--- /dev/null
+++ b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2020-03-01/storagecache.json
@@ -0,0 +1,1875 @@
+{
+ "swagger": "2.0",
+ "info": {
+ "description": "A Storage Cache provides scalable caching service for NAS clients, serving data from either NFSv3 or Blob at-rest storage (referred to as \"Storage Targets\"). These operations allow you to manage Caches.",
+ "title": "Storage Cache Mgmt Client",
+ "version": "2020-03-01"
+ },
+ "host": "management.azure.com",
+ "basePath": "/",
+ "schemes": [
+ "https"
+ ],
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "security": [
+ {
+ "azure_auth": [
+ "user_impersonation"
+ ]
+ }
+ ],
+ "securityDefinitions": {
+ "azure_auth": {
+ "type": "oauth2",
+ "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize",
+ "flow": "implicit",
+ "description": "Azure Active Directory OAuth2 Flow.",
+ "scopes": {
+ "user_impersonation": "impersonate your user account"
+ }
+ }
+ },
+ "paths": {
+ "/providers/Microsoft.StorageCache/operations": {
+ "get": {
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The list of available Resource Provider operations.",
+ "schema": {
+ "$ref": "#/definitions/ApiOperationListResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "tags": [
+ "Operations"
+ ],
+ "description": "Lists all of the available Resource Provider operations.",
+ "x-ms-examples": {
+ "StorageTargets_List": {
+ "$ref": "./examples/Operations_List.json"
+ }
+ },
+ "operationId": "Operations_List",
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/providers/Microsoft.StorageCache/skus": {
+ "get": {
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "A list of SKU descriptors.",
+ "schema": {
+ "$ref": "#/definitions/ResourceSkusResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-examples": {
+ "Skus_List": {
+ "$ref": "./examples/Skus_List.json"
+ }
+ },
+ "tags": [
+ "SKUs"
+ ],
+ "description": "Get the list of StorageCache.Cache SKUs available to this subscription.",
+ "operationId": "Skus_List"
+ }
+ },
+ "/subscriptions/{subscriptionId}/providers/Microsoft.StorageCache/usageModels": {
+ "get": {
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "A list of UsageModel descriptors.",
+ "schema": {
+ "$ref": "#/definitions/UsageModelsResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-examples": {
+ "UsageModels_List": {
+ "$ref": "./examples/UsageModels_List.json"
+ }
+ },
+ "tags": [
+ "UsageModels"
+ ],
+ "description": "Get the list of Cache Usage Models available to this subscription.",
+ "operationId": "UsageModels_List"
+ }
+ },
+ "/subscriptions/{subscriptionId}/providers/Microsoft.StorageCache/locations/{location}/ascOperations/{operationId}": {
+ "get": {
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "name": "location",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The region name which the operation will lookup into."
+ },
+ {
+ "name": "operationId",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The operation id which uniquely identifies the asynchronous operation."
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Gets the status of an asynchronous operation for the Azure HPC cache",
+ "schema": {
+ "$ref": "#/definitions/AscOperation"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "AscOperations_Get": {
+ "$ref": "./examples/AscOperations_Get.json"
+ }
+ },
+ "tags": [
+ "AscOperations"
+ ],
+ "description": "Gets the status of an asynchronous operation for the Azure HPC cache",
+ "operationId": "AscOperations_Get"
+ }
+ },
+ "/subscriptions/{subscriptionId}/providers/Microsoft.StorageCache/caches": {
+ "get": {
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "A list of Cache objects. Note that entity references might replace complete Cache objects, as described in http://docs.oasis-open.org/odata/odata-json-format/v4.01/cs01/odata-json-format-v4.01-cs01.html#sec_EntityReference",
+ "schema": {
+ "$ref": "#/definitions/CachesListResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-examples": {
+ "Caches_List": {
+ "$ref": "./examples/Caches_List.json"
+ }
+ },
+ "tags": [
+ "Caches"
+ ],
+ "description": "Returns all Caches the user has access to under a subscription.",
+ "operationId": "Caches_List"
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StorageCache/caches": {
+ "get": {
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "description": "Target resource group.",
+ "in": "path",
+ "name": "resourceGroupName",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "A list of Cache objects. Note that entity references might replace complete Cache objects, as described in http://docs.oasis-open.org/odata/odata-json-format/v4.01/cs01/odata-json-format-v4.01-cs01.html#sec_EntityReference",
+ "schema": {
+ "$ref": "#/definitions/CachesListResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Caches_ListByResourceGroup": {
+ "$ref": "./examples/Caches_ListByResourceGroup.json"
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "tags": [
+ "Caches"
+ ],
+ "description": "Returns all Caches the user has access to under a resource group.",
+ "operationId": "Caches_ListByResourceGroup"
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StorageCache/caches/{cacheName}": {
+ "delete": {
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "description": "Target resource group.",
+ "in": "path",
+ "name": "resourceGroupName",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "description": "Name of Cache. Length of name must be not greater than 80 and chars must be in list of [-0-9a-zA-Z_] char class.",
+ "in": "path",
+ "name": "cacheName",
+ "pattern": "^[-0-9a-zA-Z_]{1,80}$",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Cache deleted.",
+ "schema": {}
+ },
+ "202": {
+ "description": "Started the Cache's transition to Deleted state. Poll the Cache to monitor.",
+ "schema": {}
+ },
+ "204": {
+ "description": "Cache deleted.",
+ "schema": {}
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Caches_Delete": {
+ "$ref": "./examples/Caches_Delete.json"
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "tags": [
+ "Caches"
+ ],
+ "description": "Schedules a Cache for deletion.",
+ "operationId": "Caches_Delete"
+ },
+ "get": {
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "description": "Target resource group.",
+ "in": "path",
+ "name": "resourceGroupName",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "description": "Name of Cache. Length of name must be not greater than 80 and chars must be in list of [-0-9a-zA-Z_] char class.",
+ "in": "path",
+ "name": "cacheName",
+ "pattern": "^[-0-9a-zA-Z_]{1,80}$",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Returns the Cache object corresponding to cacheName.",
+ "schema": {
+ "$ref": "#/definitions/Cache"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Caches_Get": {
+ "$ref": "./examples/Caches_Get.json"
+ }
+ },
+ "tags": [
+ "Caches"
+ ],
+ "description": "Returns a Cache.",
+ "operationId": "Caches_Get"
+ },
+ "put": {
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "description": "Target resource group.",
+ "in": "path",
+ "name": "resourceGroupName",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "description": "Name of Cache. Length of name must be not greater than 80 and chars must be in list of [-0-9a-zA-Z_] char class.",
+ "in": "path",
+ "name": "cacheName",
+ "pattern": "^[-0-9a-zA-Z_]{1,80}$",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "description": "Object containing the user-selectable properties of the new Cache. If read-only properties are included, they must match the existing values of those properties.",
+ "in": "body",
+ "name": "cache",
+ "schema": {
+ "$ref": "#/definitions/Cache"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Cache created or updated.",
+ "schema": {
+ "$ref": "#/definitions/Cache"
+ }
+ },
+ "201": {
+ "description": "Cache creation or update has been initiated. Poll the new Cache's provisioningState property to monitor creation progress.",
+ "schema": {
+ "$ref": "#/definitions/Cache"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Caches_CreateOrUpdate": {
+ "$ref": "./examples/Caches_CreateOrUpdate.json"
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "tags": [
+ "Caches"
+ ],
+ "description": "Create or update a Cache.",
+ "operationId": "Caches_CreateOrUpdate"
+ },
+ "patch": {
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "description": "Target resource group.",
+ "in": "path",
+ "name": "resourceGroupName",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "description": "Name of Cache. Length of name must be not greater than 80 and chars must be in list of [-0-9a-zA-Z_] char class.",
+ "in": "path",
+ "name": "cacheName",
+ "pattern": "^[-0-9a-zA-Z_]{1,80}$",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "description": "Object containing the user-selectable properties of the Cache. If read-only properties are included, they must match the existing values of those properties.",
+ "in": "body",
+ "name": "cache",
+ "schema": {
+ "$ref": "#/definitions/Cache"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Updated the Cache.",
+ "schema": {
+ "$ref": "#/definitions/Cache"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Caches_Update": {
+ "$ref": "./examples/Caches_Update.json"
+ }
+ },
+ "tags": [
+ "Caches"
+ ],
+ "description": "Update a Cache instance.",
+ "operationId": "Caches_Update"
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StorageCache/caches/{cacheName}/flush": {
+ "post": {
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "description": "Target resource group.",
+ "in": "path",
+ "name": "resourceGroupName",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "description": "Name of Cache. Length of name must be not greater than 80 and chars must be in list of [-0-9a-zA-Z_] char class.",
+ "in": "path",
+ "name": "cacheName",
+ "pattern": "^[-0-9a-zA-Z_]{1,80}$",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "All cached data has been flushed to the Storage Target(s).",
+ "schema": {}
+ },
+ "202": {
+ "description": "Cache has started flushing to its Storage Target(s). Poll the Cache's state field to monitor.",
+ "schema": {}
+ },
+ "204": {
+ "description": "Cache flushed.",
+ "schema": {}
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Caches_Flush": {
+ "$ref": "./examples/Caches_Flush.json"
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-long-running-operation-options": {
+ "final-state-via": "azure-async-operation"
+ },
+ "tags": [
+ "Caches"
+ ],
+ "description": "Tells a Cache to write all dirty data to the Storage Target(s). During the flush, clients will see errors returned until the flush is complete.",
+ "operationId": "Caches_Flush"
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StorageCache/caches/{cacheName}/start": {
+ "post": {
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "description": "Target resource group.",
+ "in": "path",
+ "name": "resourceGroupName",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "description": "Name of Cache. Length of name must be not greater than 80 and chars must be in list of [-0-9a-zA-Z_] char class.",
+ "in": "path",
+ "name": "cacheName",
+ "pattern": "^[-0-9a-zA-Z_]{1,80}$",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Cache is Active.",
+ "schema": {}
+ },
+ "202": {
+ "description": "Cache has started the transition to Active. Poll the Cache's state field to monitor.",
+ "schema": {}
+ },
+ "204": {
+ "description": "Restarted VMs associated with the cache.",
+ "schema": {}
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Caches_Start": {
+ "$ref": "./examples/Caches_Start.json"
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-long-running-operation-options": {
+ "final-state-via": "azure-async-operation"
+ },
+ "tags": [
+ "Caches"
+ ],
+ "description": "Tells a Stopped state Cache to transition to Active state.",
+ "operationId": "Caches_Start"
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StorageCache/caches/{cacheName}/stop": {
+ "post": {
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "description": "Target resource group.",
+ "in": "path",
+ "name": "resourceGroupName",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "description": "Name of Cache. Length of name must be not greater than 80 and chars must be in list of [-0-9a-zA-Z_] char class.",
+ "in": "path",
+ "name": "cacheName",
+ "pattern": "^[-0-9a-zA-Z_]{1,80}$",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Cache is stopped.",
+ "schema": {}
+ },
+ "202": {
+ "description": "Cache has started the transition to Stopped. Poll the Cache's state field to monitor.",
+ "schema": {}
+ },
+ "204": {
+ "description": "Stopped VMs associated with the cache.",
+ "schema": {}
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Caches_Stop": {
+ "$ref": "./examples/Caches_Stop.json"
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-long-running-operation-options": {
+ "final-state-via": "azure-async-operation"
+ },
+ "tags": [
+ "Caches"
+ ],
+ "description": "Tells an Active Cache to transition to Stopped state.",
+ "operationId": "Caches_Stop"
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StorageCache/caches/{cacheName}/storageTargets": {
+ "get": {
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "description": "Target resource group.",
+ "in": "path",
+ "name": "resourceGroupName",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "description": "Name of Cache. Length of name must be not greater than 80 and chars must be in list of [-0-9a-zA-Z_] char class.",
+ "in": "path",
+ "name": "cacheName",
+ "pattern": "^[-0-9a-zA-Z_]{1,80}$",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Returns the list of Storage Targets defined by cacheName.",
+ "schema": {
+ "$ref": "#/definitions/StorageTargetsResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "StorageTargets_List": {
+ "$ref": "./examples/StorageTargets_ListByCache.json"
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "tags": [
+ "StorageTargets"
+ ],
+ "description": "Returns a list of Storage Targets for the specified Cache.",
+ "operationId": "StorageTargets_ListByCache"
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StorageCache/caches/{cacheName}/storageTargets/{storageTargetName}": {
+ "delete": {
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "description": "Target resource group.",
+ "in": "path",
+ "name": "resourceGroupName",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "description": "Name of Cache. Length of name must be not greater than 80 and chars must be in list of [-0-9a-zA-Z_] char class.",
+ "in": "path",
+ "name": "cacheName",
+ "pattern": "^[-0-9a-zA-Z_]{1,80}$",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "description": "Name of Storage Target.",
+ "in": "path",
+ "name": "storageTargetName",
+ "pattern": "^[-0-9a-zA-Z_]{1,80}$",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Storage target deleted.",
+ "schema": {}
+ },
+ "202": {
+ "description": "Started the Storage Target's deletion. Poll the Cache's Storage Targets to monitor.",
+ "schema": {}
+ },
+ "204": {
+ "description": "Storage Target deleted.",
+ "schema": {}
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "StorageTargets_Delete": {
+ "$ref": "./examples/StorageTargets_Delete.json"
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "tags": [
+ "StorageTargets"
+ ],
+ "description": "Removes a Storage Target from a Cache. This operation is allowed at any time, but if the Cache is down or unhealthy, the actual removal of the Storage Target may be delayed until the Cache is healthy again. Note that if the Cache has data to flush to the Storage Target, the data will be flushed before the Storage Target will be deleted.",
+ "operationId": "StorageTargets_Delete"
+ },
+ "get": {
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "description": "Target resource group.",
+ "in": "path",
+ "name": "resourceGroupName",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "description": "Name of Cache. Length of name must be not greater than 80 and chars must be in list of [-0-9a-zA-Z_] char class.",
+ "in": "path",
+ "name": "cacheName",
+ "pattern": "^[-0-9a-zA-Z_]{1,80}$",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "description": "Name of the Storage Target. Length of name must be not greater than 80 and chars must be in list of [-0-9a-zA-Z_] char class.",
+ "in": "path",
+ "name": "storageTargetName",
+ "pattern": "^[-0-9a-zA-Z_]{1,80}$",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Returns the Storage Target object corresponding to storageTargetName.",
+ "schema": {
+ "$ref": "#/definitions/StorageTarget"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "StorageTargets_Get": {
+ "$ref": "./examples/StorageTargets_Get.json"
+ }
+ },
+ "tags": [
+ "StorageTargets"
+ ],
+ "description": "Returns a Storage Target from a Cache.",
+ "operationId": "StorageTargets_Get"
+ },
+ "put": {
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "description": "Target resource group.",
+ "in": "path",
+ "name": "resourceGroupName",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "description": "Name of Cache. Length of name must be not greater than 80 and chars must be in list of [-0-9a-zA-Z_] char class.",
+ "in": "path",
+ "name": "cacheName",
+ "pattern": "^[-0-9a-zA-Z_]{1,80}$",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "description": "Name of the Storage Target. Length of name must be not greater than 80 and chars must be in list of [-0-9a-zA-Z_] char class.",
+ "in": "path",
+ "name": "storageTargetName",
+ "pattern": "^[-0-9a-zA-Z_]{1,80}$",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "description": "Object containing the definition of a Storage Target.",
+ "in": "body",
+ "name": "storagetarget",
+ "schema": {
+ "$ref": "#/definitions/StorageTarget"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Storage Target has been created or updated.",
+ "schema": {
+ "$ref": "#/definitions/StorageTarget"
+ }
+ },
+ "201": {
+ "description": "Storage Target creation or update has been initiated. Poll the new Storage Target's provisioningState property to monitor creation progress.",
+ "schema": {
+ "$ref": "#/definitions/StorageTarget"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "StorageTargets_CreateOrUpdate": {
+ "$ref": "./examples/StorageTargets_CreateOrUpdate.json"
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "tags": [
+ "StorageTargets"
+ ],
+ "description": "Create or update a Storage Target. This operation is allowed at any time, but if the Cache is down or unhealthy, the actual creation/modification of the Storage Target may be delayed until the Cache is healthy again.",
+ "operationId": "StorageTargets_CreateOrUpdate"
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StorageCache/caches/{cacheName}/upgrade": {
+ "post": {
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "description": "Target resource group.",
+ "in": "path",
+ "name": "resourceGroupName",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "description": "Name of Cache. Length of name must be not greater than 80 and chars must be in list of [-0-9a-zA-Z_] char class.",
+ "in": "path",
+ "name": "cacheName",
+ "pattern": "^[-0-9a-zA-Z_]{1,80}$",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "201": {
+ "description": "Cache firmware is up to date.",
+ "schema": {}
+ },
+ "202": {
+ "description": "Cache has started the upgrade. Poll the Cache's state field to monitor.",
+ "schema": {}
+ },
+ "204": {
+ "description": "Cache firmware is up to date.",
+ "schema": {}
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Caches_UpgradeFirmware": {
+ "$ref": "./examples/Caches_UpgradeFirmware.json"
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-long-running-operation-options": {
+ "final-state-via": "azure-async-operation"
+ },
+ "tags": [
+ "Caches"
+ ],
+ "description": "Upgrade a Cache's firmware if a new version is available. Otherwise, this operation has no effect.",
+ "operationId": "Caches_UpgradeFirmware"
+ }
+ }
+ },
+ "definitions": {
+ "ApiOperation": {
+ "description": "REST API operation description: see https://github.com/Azure/azure-rest-api-specs/blob/master/documentation/openapi-authoring-automated-guidelines.md#r3023-operationsapiimplementation",
+ "properties": {
+ "display": {
+ "description": "The object that represents the operation.",
+ "properties": {
+ "operation": {
+ "description": "Operation type: Read, write, delete, etc.",
+ "type": "string"
+ },
+ "provider": {
+ "description": "Service provider: Microsoft.StorageCache",
+ "type": "string"
+ },
+ "resource": {
+ "description": "Resource on which the operation is performed: Cache, etc.",
+ "type": "string"
+ }
+ }
+ },
+ "name": {
+ "description": "Operation name: {provider}/{resource}/{operation}",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ApiOperationListResult": {
+ "description": "Result of the request to list Resource Provider operations. It contains a list of operations and a URL link to get the next set of results.",
+ "properties": {
+ "nextLink": {
+ "description": "URL to get the next set of operation list results if there are any.",
+ "type": "string"
+ },
+ "value": {
+ "description": "List of Resource Provider operations supported by the Microsoft.StorageCache resource provider.",
+ "items": {
+ "$ref": "#/definitions/ApiOperation"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "CloudError": {
+ "x-ms-external": true,
+ "description": "An error response.",
+ "properties": {
+ "error": {
+ "description": "The body of the error.",
+ "$ref": "#/definitions/CloudErrorBody"
+ }
+ },
+ "type": "object"
+ },
+ "CloudErrorBody": {
+ "description": "An error response.",
+ "properties": {
+ "code": {
+ "description": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically.",
+ "type": "string"
+ },
+ "details": {
+ "description": "A list of additional details about the error.",
+ "items": {
+ "$ref": "#/definitions/CloudErrorBody"
+ },
+ "type": "array"
+ },
+ "message": {
+ "description": "A message describing the error, intended to be suitable for display in a user interface.",
+ "type": "string"
+ },
+ "target": {
+ "description": "The target of the particular error. For example, the name of the property in error.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "AscOperation": {
+ "description": "The status of operation.",
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "The operation Id."
+ },
+ "name": {
+ "type": "string",
+ "description": "The operation name."
+ },
+ "startTime": {
+ "type": "string",
+ "description": "The start time of the operation."
+ },
+ "endTime": {
+ "type": "string",
+ "description": "The end time of the operation."
+ },
+ "status": {
+ "type": "string",
+ "description": "The status of the operation."
+ },
+ "error": {
+ "type": "object",
+ "description": "The error detail of the operation if any.",
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "ErrorResponse": {
+ "description": "Describes the format of Error response.",
+ "type": "object",
+ "properties": {
+ "code": {
+ "description": "Error code",
+ "type": "string"
+ },
+ "message": {
+ "description": "Error message indicating why the operation failed.",
+ "type": "string"
+ }
+ }
+ },
+ "Cache": {
+ "description": "A Cache instance. Follows Azure Resource Manager standards: https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/resource-api-reference.md",
+ "properties": {
+ "tags": {
+ "description": "ARM tags as name/value pairs.",
+ "type": "object"
+ },
+ "id": {
+ "description": "Resource ID of the Cache.",
+ "readOnly": true,
+ "$ref": "#/definitions/URLString"
+ },
+ "location": {
+ "description": "Region name string.",
+ "type": "string"
+ },
+ "name": {
+ "description": "Name of Cache.",
+ "readOnly": true,
+ "$ref": "#/definitions/ResourceName"
+ },
+ "type": {
+ "description": "Type of the Cache; Microsoft.StorageCache/Cache",
+ "readOnly": true,
+ "type": "string"
+ },
+ "identity": {
+ "$ref": "#/definitions/CacheIdentity",
+ "description": "The identity of the cache, if configured."
+ },
+ "properties": {
+ "x-ms-client-flatten": true,
+ "description": "Properties of the Cache.",
+ "properties": {
+ "cacheSizeGB": {
+ "description": "The size of this Cache, in GB.",
+ "type": "integer"
+ },
+ "health": {
+ "description": "Health of the Cache.",
+ "readOnly": true,
+ "$ref": "#/definitions/CacheHealth"
+ },
+ "mountAddresses": {
+ "description": "Array of IP addresses that can be used by clients mounting this Cache.",
+ "readOnly": true,
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "provisioningState": {
+ "description": "ARM provisioning state, see https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/Addendum.md#provisioningstate-property",
+ "enum": [
+ "Succeeded",
+ "Failed",
+ "Cancelled",
+ "Creating",
+ "Deleting",
+ "Updating"
+ ],
+ "x-ms-enum": {
+ "name": "ProvisioningStateType",
+ "modelAsString": true
+ },
+ "type": "string"
+ },
+ "subnet": {
+ "description": "Subnet used for the Cache.",
+ "$ref": "#/definitions/URLString"
+ },
+ "upgradeStatus": {
+ "description": "Upgrade status of the Cache.",
+ "$ref": "#/definitions/CacheUpgradeStatus"
+ },
+ "networkSettings": {
+ "$ref": "#/definitions/CacheNetworkSettings",
+ "description": "Specifies network settings of the cache."
+ },
+ "encryptionSettings": {
+ "$ref": "#/definitions/CacheEncryptionSettings",
+ "description": "Specifies encryption settings of the cache."
+ },
+ "securitySettings": {
+ "$ref": "#/definitions/CacheSecuritySettings",
+ "description": "Specifies security settings of the cache."
+ }
+ },
+ "type": "object"
+ },
+ "sku": {
+ "description": "SKU for the Cache.",
+ "properties": {
+ "name": {
+ "description": "SKU name for this Cache.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ }
+ },
+ "x-ms-azure-resource": true,
+ "type": "object"
+ },
+ "CacheIdentity": {
+ "description": "Cache identity properties.",
+ "properties": {
+ "principalId": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The principal id of the cache."
+ },
+ "tenantId": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The tenant id associated with the cache."
+ },
+ "type": {
+ "type": "string",
+ "description": "The type of identity used for the cache",
+ "enum": [
+ "SystemAssigned",
+ "None"
+ ],
+ "x-ms-enum": {
+ "name": "CacheIdentityType",
+ "modelAsString": false
+ }
+ }
+ }
+ },
+ "CacheNetworkSettings": {
+ "description": "Cache network settings.",
+ "properties": {
+ "mtu": {
+ "description": "The IPv4 maximum transmission unit configured for the subnet.",
+ "type": "integer",
+ "minimum": 576,
+ "maximum": 1500,
+ "default": 1500
+ },
+ "utilityAddresses": {
+ "description": "Array of additional IP addresses used by this Cache.",
+ "readOnly": true,
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ }
+ },
+ "CacheEncryptionSettings": {
+ "description": "Cache encryption settings.",
+ "properties": {
+ "keyEncryptionKey": {
+ "x-ms-secret": true,
+ "$ref": "#/definitions/KeyVaultKeyReference",
+ "description": "Specifies the location of the key encryption key in Key Vault."
+ }
+ }
+ },
+ "CacheSecuritySettings": {
+ "description": "Cache security settings.",
+ "properties": {
+ "rootSquash": {
+ "type": "boolean",
+ "description": "root squash of cache property."
+ }
+ }
+ },
+ "KeyVaultKeyReference": {
+ "description": "Describes a reference to Key Vault Key.",
+ "properties": {
+ "keyUrl": {
+ "type": "string",
+ "description": "The URL referencing a key encryption key in Key Vault."
+ },
+ "sourceVault": {
+ "description": "Describes a resource Id to source Key Vault.",
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "Resource Id."
+ }
+ }
+ }
+ },
+ "required": [
+ "keyUrl",
+ "sourceVault"
+ ]
+ },
+ "CachesListResult": {
+ "description": "Result of the request to list Caches. It contains a list of Caches and a URL link to get the next set of results.",
+ "properties": {
+ "nextLink": {
+ "description": "URL to get the next set of Cache list results, if there are any.",
+ "type": "string"
+ },
+ "value": {
+ "description": "List of Caches.",
+ "items": {
+ "$ref": "#/definitions/Cache"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "CacheHealth": {
+ "description": "An indication of Cache health. Gives more information about health than just that related to provisioning.",
+ "properties": {
+ "state": {
+ "description": "List of Cache health states.",
+ "enum": [
+ "Unknown",
+ "Healthy",
+ "Degraded",
+ "Down",
+ "Transitioning",
+ "Stopping",
+ "Stopped",
+ "Upgrading",
+ "Flushing"
+ ],
+ "x-ms-enum": {
+ "name": "HealthStateType",
+ "modelAsString": true
+ },
+ "type": "string"
+ },
+ "statusDescription": {
+ "description": "Describes explanation of state.",
+ "type": "string"
+ }
+ }
+ },
+ "CacheUpgradeStatus": {
+ "description": "Properties describing the software upgrade state of the Cache.",
+ "properties": {
+ "currentFirmwareVersion": {
+ "description": "Version string of the firmware currently installed on this Cache.",
+ "type": "string",
+ "readOnly": true
+ },
+ "firmwareUpdateStatus": {
+ "description": "True if there is a firmware update ready to install on this Cache. The firmware will automatically be installed after firmwareUpdateDeadline if not triggered earlier via the upgrade operation.",
+ "enum": [
+ "available",
+ "unavailable"
+ ],
+ "x-ms-enum": {
+ "name": "FirmwareStatusType",
+ "modelAsString": true
+ },
+ "readOnly": true,
+ "type": "string"
+ },
+ "firmwareUpdateDeadline": {
+ "description": "Time at which the pending firmware update will automatically be installed on the Cache.",
+ "format": "date-time",
+ "type": "string",
+ "readOnly": true
+ },
+ "lastFirmwareUpdate": {
+ "description": "Time of the last successful firmware update.",
+ "format": "date-time",
+ "type": "string",
+ "readOnly": true
+ },
+ "pendingFirmwareVersion": {
+ "description": "When firmwareUpdateAvailable is true, this field holds the version string for the update.",
+ "type": "string",
+ "readOnly": true
+ }
+ },
+ "type": "object"
+ },
+ "UnknownProperties": {
+ "description": "Properties of an unknown type of Storage Target.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "StorageTarget": {
+ "type": "object",
+ "description": "Type of the Storage Target.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/StorageTargetResource"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "properties": {
+ "x-ms-client-flatten": true,
+ "description": "StorageTarget properties",
+ "$ref": "#/definitions/StorageTargetProperties"
+ }
+ }
+ }
+ ]
+ },
+ "StorageTargetResource": {
+ "description": "Resource used by a Cache.",
+ "properties": {
+ "name": {
+ "description": "Name of the Storage Target.",
+ "readOnly": true,
+ "$ref": "#/definitions/ResourceName"
+ },
+ "id": {
+ "readOnly": true,
+ "type": "string",
+ "description": "Resource ID of the Storage Target."
+ },
+ "type": {
+ "description": "Type of the Storage Target; Microsoft.StorageCache/Cache/StorageTarget",
+ "readOnly": true,
+ "type": "string"
+ }
+ },
+ "x-ms-azure-resource": true
+ },
+ "StorageTargetProperties": {
+ "type": "object",
+ "description": "Properties of the Storage Target.",
+ "discriminator": "targetBaseType",
+ "properties": {
+ "targetBaseType": {
+ "description": "Type of the Storage Target.",
+ "$ref": "#/definitions/StorageTargetType"
+ },
+ "junctions": {
+ "description": "List of Cache namespace junctions to target for namespace associations.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/NamespaceJunction"
+ }
+ },
+ "targetType": {
+ "description": "Type of the Storage Target.",
+ "type": "string"
+ },
+ "provisioningState": {
+ "description": "ARM provisioning state, see https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/Addendum.md#provisioningstate-property",
+ "enum": [
+ "Succeeded",
+ "Failed",
+ "Cancelled",
+ "Creating",
+ "Deleting",
+ "Updating"
+ ],
+ "x-ms-enum": {
+ "name": "ProvisioningStateType",
+ "modelAsString": true
+ },
+ "type": "string"
+ },
+ "nfs3": {
+ "description": "Properties when targetType is nfs3.",
+ "$ref": "#/definitions/Nfs3Target"
+ },
+ "clfs": {
+ "description": "Properties when targetType is clfs.",
+ "$ref": "#/definitions/ClfsTarget"
+ },
+ "unknown": {
+ "description": "Properties when targetType is unknown.",
+ "$ref": "#/definitions/UnknownTarget"
+ }
+ },
+ "required": [
+ "targetBaseType"
+ ]
+ },
+ "StorageTargetType": {
+ "type": "string",
+ "description": "Type of the Storage Target.",
+ "enum": [
+ "nfs3",
+ "clfs",
+ "unknown"
+ ],
+ "x-ms-enum": {
+ "name": "StorageTargetType",
+ "modelAsString": true
+ }
+ },
+ "Nfs3TargetProperties": {
+ "description": "An NFSv3 mount point for use as a Storage Target.",
+ "type": "object",
+ "x-ms-discriminator-value": "nfs3",
+ "allOf": [
+ {
+ "$ref": "#/definitions/StorageTargetProperties"
+ }
+ ]
+ },
+ "Nfs3Target": {
+ "description": "Properties pertained to Nfs3Target",
+ "properties": {
+ "target": {
+ "description": "IP address or host name of an NFSv3 host (e.g., 10.0.44.44).",
+ "pattern": "^[-.0-9a-zA-Z]+$",
+ "type": "string"
+ },
+ "usageModel": {
+ "description": "Identifies the primary usage model to be used for this Storage Target. Get choices from .../usageModels",
+ "type": "string"
+ }
+ }
+ },
+ "ClfsTargetProperties": {
+ "description": "Storage container for use as a CLFS Storage Target.",
+ "type": "object",
+ "x-ms-discriminator-value": "clfs",
+ "allOf": [
+ {
+ "$ref": "#/definitions/StorageTargetProperties"
+ }
+ ]
+ },
+ "ClfsTarget": {
+ "description": "Properties pertained to ClfsTarget",
+ "properties": {
+ "target": {
+ "description": "Resource ID of storage container.",
+ "$ref": "#/definitions/URLString"
+ }
+ }
+ },
+ "UnknownTargetProperties": {
+ "description": "Storage container for use as an Unknown Storage Target.",
+ "type": "object",
+ "x-ms-discriminator-value": "unknown",
+ "allOf": [
+ {
+ "$ref": "#/definitions/StorageTargetProperties"
+ }
+ ]
+ },
+ "UnknownTarget": {
+ "description": "Properties pertained to UnknownTarget",
+ "properties": {
+ "unknownMap": {
+ "description": "Dictionary of string->string pairs containing information about the Storage Target.",
+ "$ref": "#/definitions/UnknownProperties"
+ }
+ }
+ },
+ "ResourceName": {
+ "description": "Schema for the name of resources served by this provider. Note that objects will contain an odata @id annotation as appropriate. This will contain the complete URL of the object. These names are case-preserving, but not case sensitive.",
+ "pattern": "^[-0-9a-zA-Z_]{1,80}$",
+ "type": "string"
+ },
+ "ResourceSku": {
+ "description": "A resource SKU.",
+ "properties": {
+ "resourceType": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The type of resource the SKU applies to."
+ },
+ "capabilities": {
+ "description": "A list of capabilities of this SKU, such as throughput or ops/sec.",
+ "items": {
+ "$ref": "#/definitions/ResourceSkuCapabilities"
+ },
+ "type": "array"
+ },
+ "locations": {
+ "readOnly": true,
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "The set of locations that the SKU is available. This will be supported and registered Azure Geo Regions (e.g., West US, East US, Southeast Asia, etc.)."
+ },
+ "locationInfo": {
+ "description": "The set of locations that the SKU is available.",
+ "items": {
+ "$ref": "#/definitions/ResourceSkuLocationInfo"
+ },
+ "type": "array"
+ },
+ "name": {
+ "description": "The name of this SKU.",
+ "type": "string"
+ },
+ "restrictions": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/Restriction"
+ },
+ "description": "The restrictions preventing this SKU from being used. This is empty if there are no restrictions."
+ }
+ },
+ "type": "object"
+ },
+ "Restriction": {
+ "properties": {
+ "type": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The type of restrictions. In this version, the only possible value for this is location."
+ },
+ "values": {
+ "readOnly": true,
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "The value of restrictions. If the restriction type is set to location, then this would be the different locations where the SKU is restricted."
+ },
+ "reasonCode": {
+ "type": "string",
+ "enum": [
+ "QuotaId",
+ "NotAvailableForSubscription"
+ ],
+ "x-ms-enum": {
+ "name": "ReasonCode",
+ "modelAsString": true
+ },
+ "description": "The reason for the restriction. As of now this can be \"QuotaId\" or \"NotAvailableForSubscription\". \"QuotaId\" is set when the SKU has requiredQuotas parameter as the subscription does not belong to that quota. \"NotAvailableForSubscription\" is related to capacity at the datacenter."
+ }
+ },
+ "description": "The restrictions preventing this SKU from being used."
+ },
+ "ResourceSkuCapabilities": {
+ "description": "A resource SKU capability.",
+ "properties": {
+ "name": {
+ "description": "Name of a capability, such as ops/sec.",
+ "type": "string"
+ },
+ "value": {
+ "description": "Quantity, if the capability is measured by quantity.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ResourceSkuLocationInfo": {
+ "description": "Resource SKU location information.",
+ "properties": {
+ "location": {
+ "description": "Location where this SKU is available.",
+ "type": "string"
+ },
+ "zones": {
+ "description": "Zones if any.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "type": "object"
+ },
+ "ResourceSkusResult": {
+ "description": "The response from the List Cache SKUs operation.",
+ "properties": {
+ "nextLink": {
+ "description": "The URI to fetch the next page of Cache SKUs.",
+ "type": "string"
+ },
+ "value": {
+ "description": "The list of SKUs available for the subscription.",
+ "readOnly": true,
+ "items": {
+ "$ref": "#/definitions/ResourceSku"
+ },
+ "type": "array"
+ }
+ }
+ },
+ "NamespaceJunction": {
+ "description": "A namespace junction.",
+ "type": "object",
+ "properties": {
+ "namespacePath": {
+ "description": "Namespace path on a Cache for a Storage Target.",
+ "type": "string"
+ },
+ "targetPath": {
+ "description": "Path in Storage Target to which namespacePath points.",
+ "type": "string"
+ },
+ "nfsExport": {
+ "description": "NFS export where targetPath exists.",
+ "type": "string"
+ }
+ }
+ },
+ "StorageTargetsResult": {
+ "description": "A list of Storage Targets.",
+ "properties": {
+ "nextLink": {
+ "description": "The URI to fetch the next page of Storage Targets.",
+ "type": "string"
+ },
+ "value": {
+ "description": "The list of Storage Targets defined for the Cache.",
+ "items": {
+ "$ref": "#/definitions/StorageTarget"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "URLString": {
+ "description": "A fully qualified URL.",
+ "type": "string"
+ },
+ "UsageModel": {
+ "description": "A usage model.",
+ "properties": {
+ "display": {
+ "description": "Localized information describing this usage model.",
+ "type": "object",
+ "properties": {
+ "description": {
+ "description": "String to display for this usage model.",
+ "type": "string"
+ }
+ }
+ },
+ "modelName": {
+ "description": "Non-localized keyword name for this usage model.",
+ "type": "string"
+ },
+ "targetType": {
+ "description": "The type of Storage Target to which this model is applicable (only nfs3 as of this version).",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "UsageModelsResult": {
+ "description": "A list of Cache usage models.",
+ "properties": {
+ "nextLink": {
+ "description": "The URI to fetch the next page of Cache usage models.",
+ "type": "string"
+ },
+ "value": {
+ "description": "The list of usage models available for the subscription.",
+ "items": {
+ "$ref": "#/definitions/UsageModel"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ }
+ },
+ "parameters": {
+ "SubscriptionIdParameter": {
+ "name": "subscriptionId",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call."
+ },
+ "ApiVersionParameter": {
+ "name": "api-version",
+ "in": "query",
+ "required": true,
+ "type": "string",
+ "description": "Client API version."
+ }
+ }
+}
diff --git a/specification/storagecache/resource-manager/readme.go.md b/specification/storagecache/resource-manager/readme.go.md
index 87b00ff4bf30..3a18770658db 100644
--- a/specification/storagecache/resource-manager/readme.go.md
+++ b/specification/storagecache/resource-manager/readme.go.md
@@ -13,10 +13,20 @@ go:
``` yaml $(go) && $(multiapi)
batch:
+ - tag: package-2020-03-01
- tag: package-2019-11-01
- tag: package-2019-08
```
+### Tag: package-2020-03-01 and go
+
+These settings apply only when `--tag=package-2020-03-01 --go` is specified on the command line.
+Please also specify `--go-sdk-folder=`.
+
+``` yaml $(tag) == 'package-2020-03-01' && $(go)
+output-folder: $(go-sdk-folder)/services/$(namespace)/mgmt/2020-03-01/$(namespace)
+```
+
### Tag: package-2019-11-01 and go
These settings apply only when `--tag=package-2019-11-01 --go` is specified on the command line.
diff --git a/specification/storagecache/resource-manager/readme.java.md b/specification/storagecache/resource-manager/readme.java.md
index c6117d3c8365..4f494817750c 100644
--- a/specification/storagecache/resource-manager/readme.java.md
+++ b/specification/storagecache/resource-manager/readme.java.md
@@ -16,10 +16,25 @@ output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-storagecache
``` yaml $(java) && $(multiapi)
batch:
+ - tag: package-2020-03-01
- tag: package-2019-11-01
- tag: package-2019-08
```
+
+### Tag: package-2020-03-01 and java
+
+These settings apply only when `--tag=package-2020-03-01 --java` is specified on the command line.
+Please also specify the `--azure-libraries-for-java-folder=`.
+
+``` yaml $(tag) == 'package-2020-03-01' && $(java) && $(multiapi)
+java:
+ namespace: com.microsoft.azure.management.storagecache.v2020_03_01
+ output-folder: $(azure-libraries-for-java-folder)/sdk/storagecache/mgmt-v2020_03_01
+regenerate-manager: true
+generate-interface: true
+```
+
### Tag: package-2019-11-01 and java
These settings apply only when `--tag=package-2019-11-01 --java` is specified on the command line.
diff --git a/specification/storagecache/resource-manager/readme.md b/specification/storagecache/resource-manager/readme.md
index db96192347e6..e6fe45a52294 100644
--- a/specification/storagecache/resource-manager/readme.md
+++ b/specification/storagecache/resource-manager/readme.md
@@ -26,11 +26,18 @@ These are the global settings for the StorageCache API.
``` yaml
openapi-type: arm
-tag: package-2019-11-01
+tag: package-2020-03-01
add-credentials: true
title: StorageCacheManagementClient
```
+### 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'
+input-file:
+ - Microsoft.StorageCache/stable/2020-03-01/storagecache.json
+```
### Tag: package-2019-11-01
These settings apply only when `--tag=package-2019-11-01` is specified on the command line.
@@ -104,6 +111,7 @@ require: $(this-folder)/../../../profiles/readme.md
# all the input files across all versions
input-file:
+ - $(this-folder)/Microsoft.StorageCache/stable/2020-03-01/storagecache.json
- $(this-folder)/Microsoft.StorageCache/stable/2019-11-01/storagecache.json
- $(this-folder)/Microsoft.StorageCache/preview/2019-08-01-preview/storagecache.json
diff --git a/specification/storagecache/resource-manager/readme.ruby.md b/specification/storagecache/resource-manager/readme.ruby.md
index 89fe6cc517ce..57c66942a852 100644
--- a/specification/storagecache/resource-manager/readme.ruby.md
+++ b/specification/storagecache/resource-manager/readme.ruby.md
@@ -12,10 +12,21 @@ azure-arm: true
``` yaml $(ruby) && $(multiapi)
batch:
+ - tag: package-2020-03-01
- tag: package-2019-11-01
- tag: package-2019-08
```
+### Tag: package-2020-03-01 and ruby
+
+These settings apply only when `--tag=package-2020-03-01 --ruby` is specified on the command line.
+Please also specify `--ruby-sdks-folder=`.
+
+``` yaml $(tag) == 'package-2020-03-01' && $(ruby)
+namespace: "Azure::StorageCache::Mgmt::V2020-03-01"
+output-folder: $(ruby-sdks-folder)/management/azure_mgmt_storagecache/lib
+```
+
### Tag: package-2019-11-01 and ruby
These settings apply only when `--tag=package-2019-11-01 --ruby` is specified on the command line.
diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2019-10-01/storagesync.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2019-10-01/storagesync.json
index 79e43cd1bd1f..fc8ffc68f0ae 100644
--- a/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2019-10-01/storagesync.json
+++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2019-10-01/storagesync.json
@@ -3864,22 +3864,22 @@
"readOnly": true
},
"uploadStatus": {
- "$ref": "#/definitions/ServerEndpointSyncSessionStatus",
+ "$ref": "#/definitions/SyncSessionStatus",
"description": "Upload Status",
"readOnly": true
},
"downloadStatus": {
- "$ref": "#/definitions/ServerEndpointSyncSessionStatus",
+ "$ref": "#/definitions/SyncSessionStatus",
"description": "Download Status",
"readOnly": true
},
"uploadActivity": {
- "$ref": "#/definitions/ServerEndpointSyncActivityStatus",
+ "$ref": "#/definitions/SyncActivityStatus",
"description": "Upload sync activity",
"readOnly": true
},
"downloadActivity": {
- "$ref": "#/definitions/ServerEndpointSyncActivityStatus",
+ "$ref": "#/definitions/SyncActivityStatus",
"description": "Download sync activity",
"readOnly": true
},
@@ -3890,7 +3890,7 @@
}
}
},
- "ServerEndpointSyncSessionStatus": {
+ "SyncSessionStatus": {
"type": "object",
"description": "Sync Session status object.",
"properties": {
@@ -3943,7 +3943,7 @@
}
}
},
- "ServerEndpointSyncActivityStatus": {
+ "SyncActivityStatus": {
"type": "object",
"description": "Sync Session status object.",
"properties": {
diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-03-01/examples/CloudEndpoints_Create.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-03-01/examples/CloudEndpoints_Create.json
new file mode 100644
index 000000000000..8a5307bf3614
--- /dev/null
+++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-03-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-03-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-03-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-03-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/stable/2020-03-01/examples/CloudEndpoints_Delete.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-03-01/examples/CloudEndpoints_Delete.json
new file mode 100644
index 000000000000..284eb395736b
--- /dev/null
+++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-03-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-03-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-03-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-03-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/stable/2020-03-01/examples/CloudEndpoints_Get.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-03-01/examples/CloudEndpoints_Get.json
new file mode 100644
index 000000000000..a3845ccab224
--- /dev/null
+++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-03-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-03-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/stable/2020-03-01/examples/CloudEndpoints_ListBySyncGroup.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-03-01/examples/CloudEndpoints_ListBySyncGroup.json
new file mode 100644
index 000000000000..6249461d7b7f
--- /dev/null
+++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-03-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-03-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/stable/2020-03-01/examples/CloudEndpoints_PostBackup.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-03-01/examples/CloudEndpoints_PostBackup.json
new file mode 100644
index 000000000000..50e7f9ab6c05
--- /dev/null
+++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-03-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-03-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-03-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/stable/2020-03-01/examples/CloudEndpoints_PostRestore.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-03-01/examples/CloudEndpoints_PostRestore.json
new file mode 100644
index 000000000000..f866d3fbef48
--- /dev/null
+++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-03-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-03-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-03-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/stable/2020-03-01/examples/CloudEndpoints_PreBackup.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-03-01/examples/CloudEndpoints_PreBackup.json
new file mode 100644
index 000000000000..7fdc51dec579
--- /dev/null
+++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-03-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-03-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-03-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/stable/2020-03-01/examples/CloudEndpoints_PreRestore.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-03-01/examples/CloudEndpoints_PreRestore.json
new file mode 100644
index 000000000000..0e04987629e6
--- /dev/null
+++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-03-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-03-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-03-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/stable/2020-03-01/examples/CloudEndpoints_RestoreHeatbeat.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-03-01/examples/CloudEndpoints_RestoreHeatbeat.json
new file mode 100644
index 000000000000..6a8fb0f24e4e
--- /dev/null
+++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-03-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-03-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/stable/2020-03-01/examples/CloudEndpoints_TriggerChangeDetection.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-03-01/examples/CloudEndpoints_TriggerChangeDetection.json
new file mode 100644
index 000000000000..e7d195f47680
--- /dev/null
+++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-03-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-03-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-03-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/stable/2020-03-01/examples/OperationStatus_Get.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-03-01/examples/OperationStatus_Get.json
new file mode 100644
index 000000000000..4627ffadabeb
--- /dev/null
+++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-03-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-03-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/stable/2020-03-01/examples/Operations_List.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-03-01/examples/Operations_List.json
new file mode 100644
index 000000000000..d32697790cb7
--- /dev/null
+++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-03-01/examples/Operations_List.json
@@ -0,0 +1,214 @@
+{
+ "parameters": {
+ "api-version": "2020-03-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "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/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/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/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/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"
+ }
+ ],
+ "nextLink": null
+ }
+ }
+ }
+}
diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-03-01/examples/PrivateEndpointConnections_Create.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-03-01/examples/PrivateEndpointConnections_Create.json
new file mode 100644
index 000000000000..b9a1522924a0
--- /dev/null
+++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-03-01/examples/PrivateEndpointConnections_Create.json
@@ -0,0 +1,46 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "res7687",
+ "storageSyncServiceName": "sss2527",
+ "privateEndpointConnectionName": "{privateEndpointConnectionName}",
+ "api-version": "2020-03-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-03-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-03-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/stable/2020-03-01/examples/PrivateEndpointConnections_Delete.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-03-01/examples/PrivateEndpointConnections_Delete.json
new file mode 100644
index 000000000000..4fee43b02deb
--- /dev/null
+++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-03-01/examples/PrivateEndpointConnections_Delete.json
@@ -0,0 +1,23 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "res6977",
+ "storageSyncServiceName": "sss2527",
+ "privateEndpointConnectionName": "{privateEndpointConnectionName}",
+ "api-version": "2020-03-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-03-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-03-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/stable/2020-03-01/examples/PrivateEndpointConnections_Get.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-03-01/examples/PrivateEndpointConnections_Get.json
new file mode 100644
index 000000000000..f60d6c249f5a
--- /dev/null
+++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-03-01/examples/PrivateEndpointConnections_Get.json
@@ -0,0 +1,29 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "res6977",
+ "storageSyncServiceName": "sss2527",
+ "privateEndpointConnectionName": "{privateEndpointConnectionName}",
+ "api-version": "2020-03-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/stable/2020-03-01/examples/PrivateEndpointConnections_ListByStorageSyncService.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-03-01/examples/PrivateEndpointConnections_ListByStorageSyncService.json
new file mode 100644
index 000000000000..cbd766242f59
--- /dev/null
+++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-03-01/examples/PrivateEndpointConnections_ListByStorageSyncService.json
@@ -0,0 +1,48 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "res6977",
+ "storageSyncServiceName": "sss2527",
+ "privateEndpointConnectionName": "{privateEndpointConnectionName}",
+ "api-version": "2020-03-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/stable/2020-03-01/examples/PrivateLinkResources_List.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-03-01/examples/PrivateLinkResources_List.json
new file mode 100644
index 000000000000..76ea546bb838
--- /dev/null
+++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-03-01/examples/PrivateLinkResources_List.json
@@ -0,0 +1,33 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "res6977",
+ "storageSyncServiceName": "sss2527",
+ "api-version": "2020-03-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/stable/2020-03-01/examples/RegisteredServers_Create.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-03-01/examples/RegisteredServers_Create.json
new file mode 100644
index 000000000000..a6154160c2b7
--- /dev/null
+++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-03-01/examples/RegisteredServers_Create.json
@@ -0,0 +1,60 @@
+{
+ "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=\"",
+ "lastHeartBeat": "\"2017-08-08T18:29:06.470652Z\"",
+ "serverOSVersion": "10.0.14393.0",
+ "agentVersion": "1.0.277.0"
+ }
+ },
+ "api-version": "2020-03-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",
+ "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",
+ "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-03-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-03-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/stable/2020-03-01/examples/RegisteredServers_Delete.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-03-01/examples/RegisteredServers_Delete.json
new file mode 100644
index 000000000000..046eec927723
--- /dev/null
+++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-03-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-03-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-03-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-03-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/stable/2020-03-01/examples/RegisteredServers_Get.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-03-01/examples/RegisteredServers_Get.json
new file mode 100644
index 000000000000..61bf5549f754
--- /dev/null
+++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-03-01/examples/RegisteredServers_Get.json
@@ -0,0 +1,42 @@
+{
+ "parameters": {
+ "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb",
+ "resourceGroupName": "SampleResourceGroup_1",
+ "storageSyncServiceName": "SampleStorageSyncService_1",
+ "serverId": "080d4133-bdb5-40a0-96a0-71a6057bfe9a",
+ "api-version": "2020-03-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",
+ "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",
+ "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/stable/2020-03-01/examples/RegisteredServers_ListByStorageSyncService.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-03-01/examples/RegisteredServers_ListByStorageSyncService.json
new file mode 100644
index 000000000000..2167b27133a6
--- /dev/null
+++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-03-01/examples/RegisteredServers_ListByStorageSyncService.json
@@ -0,0 +1,45 @@
+{
+ "parameters": {
+ "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb",
+ "resourceGroupName": "SampleResourceGroup_1",
+ "storageSyncServiceName": "SampleStorageSyncService_1",
+ "api-version": "2020-03-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",
+ "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",
+ "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/stable/2020-03-01/examples/RegisteredServers_TriggerRollover.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-03-01/examples/RegisteredServers_TriggerRollover.json
new file mode 100644
index 000000000000..9a9d23a1ca57
--- /dev/null
+++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-03-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-03-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-03-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-03-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/stable/2020-03-01/examples/ServerEndpoints_Create.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-03-01/examples/ServerEndpoints_Create.json
new file mode 100644
index 000000000000..e74edbf1d9cd
--- /dev/null
+++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-03-01/examples/ServerEndpoints_Create.json
@@ -0,0 +1,65 @@
+{
+ "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-03-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",
+ "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-03-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-03-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/stable/2020-03-01/examples/ServerEndpoints_Delete.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-03-01/examples/ServerEndpoints_Delete.json
new file mode 100644
index 000000000000..886b32de214e
--- /dev/null
+++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-03-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-03-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-03-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-03-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/stable/2020-03-01/examples/ServerEndpoints_Get.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-03-01/examples/ServerEndpoints_Get.json
new file mode 100644
index 000000000000..827e8be2c572
--- /dev/null
+++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-03-01/examples/ServerEndpoints_Get.json
@@ -0,0 +1,149 @@
+{
+ "parameters": {
+ "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb",
+ "resourceGroupName": "SampleResourceGroup_1",
+ "storageSyncServiceName": "SampleStorageSyncService_1",
+ "syncGroupName": "SampleSyncGroup_1",
+ "serverEndpointName": "SampleServerEndpoint_1",
+ "api-version": "2020-03-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",
+ "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/stable/2020-03-01/examples/ServerEndpoints_ListBySyncGroup.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-03-01/examples/ServerEndpoints_ListBySyncGroup.json
new file mode 100644
index 000000000000..dbc632f1ac8e
--- /dev/null
+++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-03-01/examples/ServerEndpoints_ListBySyncGroup.json
@@ -0,0 +1,193 @@
+{
+ "parameters": {
+ "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb",
+ "resourceGroupName": "SampleResourceGroup_1",
+ "storageSyncServiceName": "SampleStorageSyncService_1",
+ "syncGroupName": "SampleSyncGroup_1",
+ "api-version": "2020-03-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",
+ "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",
+ "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/stable/2020-03-01/examples/ServerEndpoints_Recall.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-03-01/examples/ServerEndpoints_Recall.json
new file mode 100644
index 000000000000..466850f60302
--- /dev/null
+++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-03-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-03-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-03-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-03-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/stable/2020-03-01/examples/ServerEndpoints_Update.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-03-01/examples/ServerEndpoints_Update.json
new file mode 100644
index 000000000000..aa4801c8dcff
--- /dev/null
+++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-03-01/examples/ServerEndpoints_Update.json
@@ -0,0 +1,88 @@
+{
+ "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-03-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",
+ "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-03-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-03-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/stable/2020-03-01/examples/StorageSyncServiceCheckNameAvailability_AlreadyExists.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-03-01/examples/StorageSyncServiceCheckNameAvailability_AlreadyExists.json
new file mode 100644
index 000000000000..41d15e171736
--- /dev/null
+++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-03-01/examples/StorageSyncServiceCheckNameAvailability_AlreadyExists.json
@@ -0,0 +1,20 @@
+{
+ "parameters": {
+ "api-version": "2020-03-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/stable/2020-03-01/examples/StorageSyncServiceCheckNameAvailability_Available.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-03-01/examples/StorageSyncServiceCheckNameAvailability_Available.json
new file mode 100644
index 000000000000..59c213db9340
--- /dev/null
+++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-03-01/examples/StorageSyncServiceCheckNameAvailability_Available.json
@@ -0,0 +1,18 @@
+{
+ "parameters": {
+ "api-version": "2020-03-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/stable/2020-03-01/examples/StorageSyncServices_Create.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-03-01/examples/StorageSyncServices_Create.json
new file mode 100644
index 000000000000..db27bee3da50
--- /dev/null
+++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-03-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-03-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-03-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-03-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/stable/2020-03-01/examples/StorageSyncServices_Delete.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-03-01/examples/StorageSyncServices_Delete.json
new file mode 100644
index 000000000000..157f3446933d
--- /dev/null
+++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-03-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-03-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-03-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-03-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/stable/2020-03-01/examples/StorageSyncServices_Get.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-03-01/examples/StorageSyncServices_Get.json
new file mode 100644
index 000000000000..1173d25d8ea1
--- /dev/null
+++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-03-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-03-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/stable/2020-03-01/examples/StorageSyncServices_ListByResourceGroup.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-03-01/examples/StorageSyncServices_ListByResourceGroup.json
new file mode 100644
index 000000000000..4128dc7a996a
--- /dev/null
+++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-03-01/examples/StorageSyncServices_ListByResourceGroup.json
@@ -0,0 +1,55 @@
+{
+ "parameters": {
+ "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb",
+ "resourceGroupName": "SampleResourceGroup_1",
+ "api-version": "2020-03-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/stable/2020-03-01/examples/StorageSyncServices_ListBySubscription.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-03-01/examples/StorageSyncServices_ListBySubscription.json
new file mode 100644
index 000000000000..3b6f7dc65348
--- /dev/null
+++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-03-01/examples/StorageSyncServices_ListBySubscription.json
@@ -0,0 +1,54 @@
+{
+ "parameters": {
+ "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb",
+ "api-version": "2020-03-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/stable/2020-03-01/examples/StorageSyncServices_Update.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-03-01/examples/StorageSyncServices_Update.json
new file mode 100644
index 000000000000..b12820afdbf2
--- /dev/null
+++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-03-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-03-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-03-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-03-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/stable/2020-03-01/examples/SyncGroups_Create.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-03-01/examples/SyncGroups_Create.json
new file mode 100644
index 000000000000..d47d2920ebbb
--- /dev/null
+++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-03-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-03-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/stable/2020-03-01/examples/SyncGroups_Delete.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-03-01/examples/SyncGroups_Delete.json
new file mode 100644
index 000000000000..4f0bb8ee1a87
--- /dev/null
+++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-03-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-03-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/stable/2020-03-01/examples/SyncGroups_Get.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-03-01/examples/SyncGroups_Get.json
new file mode 100644
index 000000000000..22da7a115d22
--- /dev/null
+++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-03-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-03-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/stable/2020-03-01/examples/SyncGroups_ListByStorageSyncService.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-03-01/examples/SyncGroups_ListByStorageSyncService.json
new file mode 100644
index 000000000000..010c48180298
--- /dev/null
+++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-03-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-03-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/stable/2020-03-01/examples/Workflows_Abort.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-03-01/examples/Workflows_Abort.json
new file mode 100644
index 000000000000..605597fa6e1a
--- /dev/null
+++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-03-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-03-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/stable/2020-03-01/examples/Workflows_Get.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-03-01/examples/Workflows_Get.json
new file mode 100644
index 000000000000..16fa6186c2d7
--- /dev/null
+++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-03-01/examples/Workflows_Get.json
@@ -0,0 +1,29 @@
+{
+ "parameters": {
+ "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb",
+ "resourceGroupName": "SampleResourceGroup_1",
+ "storageSyncServiceName": "SampleStorageSyncService_1",
+ "workflowId": "828219ea-083e-48b5-89ea-8fd9991b2e75",
+ "api-version": "2020-03-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}]"
+ },
+ "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/stable/2020-03-01/examples/Workflows_ListByStorageSyncService.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-03-01/examples/Workflows_ListByStorageSyncService.json
new file mode 100644
index 000000000000..56206a6e1350
--- /dev/null
+++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-03-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-03-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/stable/2020-03-01/storagesync.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-03-01/storagesync.json
new file mode 100644
index 000000000000..15d0e9160781
--- /dev/null
+++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-03-01/storagesync.json
@@ -0,0 +1,4954 @@
+{
+ "swagger": "2.0",
+ "info": {
+ "title": "Microsoft Storage Sync",
+ "description": "Microsoft Storage Sync Service API",
+ "version": "2020-03-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."
+ }
+ }
+ },
+ "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."
+ }
+ }
+ },
+ "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."
+ }
+ }
+ },
+ "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."
+ }
+ }
+ },
+ "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"
+ },
+ "status": {
+ "$ref": "#/definitions/WorkflowStatus",
+ "description": "workflow status."
+ },
+ "operation": {
+ "$ref": "#/definitions/OperationDirection",
+ "description": "operation direction."
+ },
+ "steps": {
+ "type": "string",
+ "description": "workflow steps"
+ },
+ "lastOperationId": {
+ "type": "string",
+ "description": "workflow last operation identifier."
+ }
+ }
+ },
+ "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"
+ },
+ "serverOSVersion": {
+ "type": "string",
+ "description": "Registered Server OS Version"
+ },
+ "serverManagementErrorCode": {
+ "type": "integer",
+ "description": "Registered Server Management Error Code"
+ },
+ "lastHeartBeat": {
+ "type": "string",
+ "description": "Registered Server last heart beat"
+ },
+ "provisioningState": {
+ "type": "string",
+ "description": "Registered Server Provisioning State"
+ },
+ "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"
+ },
+ "lastWorkflowId": {
+ "type": "string",
+ "description": "Registered Server lastWorkflowId"
+ },
+ "lastOperationName": {
+ "type": "string",
+ "description": "Resource Last Operation Name"
+ },
+ "discoveryEndpointUri": {
+ "type": "string",
+ "description": "Resource discoveryEndpointUri"
+ },
+ "resourceLocation": {
+ "type": "string",
+ "description": "Resource Location"
+ },
+ "serviceLocation": {
+ "type": "string",
+ "description": "Service Location"
+ },
+ "friendlyName": {
+ "type": "string",
+ "description": "Friendly Name"
+ },
+ "managementEndpointUri": {
+ "type": "string",
+ "description": "Management Endpoint Uri"
+ },
+ "monitoringEndpointUri": {
+ "type": "string",
+ "description": "Telemetry Endpoint Uri"
+ },
+ "monitoringConfiguration": {
+ "type": "string",
+ "description": "Monitoring Configuration"
+ }
+ }
+ },
+ "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."
+ }
+ }
+ },
+ "ServerEndpointSyncStatus": {
+ "type": "object",
+ "description": "Server Endpoint sync status",
+ "properties": {
+ "downloadHealth": {
+ "$ref": "#/definitions/ServerEndpointSyncHealthState",
+ "description": "Download Health Status.",
+ "readOnly": true
+ },
+ "uploadHealth": {
+ "$ref": "#/definitions/ServerEndpointSyncHealthState",
+ "description": "Upload Health Status.",
+ "readOnly": true
+ },
+ "combinedHealth": {
+ "$ref": "#/definitions/ServerEndpointSyncHealthState",
+ "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
+ }
+ }
+ },
+ "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
+ }
+ }
+ },
+ "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
+ }
+ }
+ },
+ "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
+ }
+ }
+ },
+ "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": false
+ }
+ },
+ "InitialDownloadPolicy": {
+ "type": "string",
+ "description": "Policy for how namespace and files are recalled during FastDr",
+ "enum": [
+ "NamespaceOnly",
+ "NamespaceThenModifiedFiles",
+ "AvoidTieredFiles"
+ ],
+ "x-ms-enum": {
+ "name": "InitialDownloadPolicy",
+ "modelAsString": false
+ }
+ },
+ "ServerEndpointSyncHealthState": {
+ "type": "string",
+ "description": "Type of the sync health state",
+ "enum": [
+ "Healthy",
+ "Error",
+ "SyncBlockedForRestore",
+ "SyncBlockedForChangeDetectionPostRestore",
+ "NoActivity"
+ ],
+ "x-ms-enum": {
+ "name": "ServerEndpointSyncHealthState",
+ "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/ServerEndpointCloudTieringHealthState",
+ "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
+ }
+ }
+ },
+ "ServerEndpointCloudTieringHealthState": {
+ "type": "string",
+ "description": "Type of the cloud tiering health state",
+ "enum": [
+ "Healthy",
+ "Error"
+ ],
+ "x-ms-enum": {
+ "name": "ServerEndpointCloudTieringHealthState",
+ "modelAsString": 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
+ }
+ }
+ }
+ },
+ "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 852b278f6e0b..425ca4443e60 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-2019-10-01
+tag: package-2020-03-01
```
+### 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'
+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.
-```yaml $(tag) == 'package-2019-10-01'
+``` yaml $(tag) == 'package-2019-10-01'
input-file:
- Microsoft.StorageSync/stable/2019-10-01/storagesync.json
```
+
### Tag: package-2019-06-01
These settings apply only when `--tag=package-2019-06-01` is specified on the command line.
@@ -186,6 +195,7 @@ require: $(this-folder)/../../../profiles/readme.md
# all the input files across all versions
input-file:
+ - $(this-folder)/Microsoft.StorageSync/stable/2020-03-01/storagesync.json
- $(this-folder)/Microsoft.StorageSync/stable/2019-10-01/storagesync.json
- $(this-folder)/Microsoft.StorageSync/stable/2019-06-01/storagesync.json
- $(this-folder)/Microsoft.StorageSync/stable/2019-03-01/storagesync.json
diff --git a/specification/storagesync/resource-manager/readme.ruby.md b/specification/storagesync/resource-manager/readme.ruby.md
index 1742006e1f1c..fc40a959dbd7 100644
--- a/specification/storagesync/resource-manager/readme.ruby.md
+++ b/specification/storagesync/resource-manager/readme.ruby.md
@@ -12,12 +12,23 @@ azure-arm: true
``` yaml $(ruby) && $(multiapi)
batch:
+ - tag: package-2020-03-01
- tag: package-2019-02-01
- tag: package-2018-10-01
- tag: package-2018-07-01
- tag: package-2018-04-02
```
+### Tag: package-2020-03-01 and ruby
+
+These settings apply only when `--tag=package-2020-03-01 --ruby` is specified on the command line.
+Please also specify `--ruby-sdks-folder=`.
+
+``` yaml $(tag) == 'package-2020-03-01' && $(ruby)
+namespace: "Azure::StorageSync::Mgmt::V2020_03_01"
+output-folder: $(ruby-sdks-folder)/management/azure_mgmt_storagesync_management/lib
+```
+
### Tag: package-2019-02-01 and ruby
These settings apply only when `--tag=package-2019-02-01 --ruby` is specified on the command line.
diff --git a/specification/subscription/resource-manager/Microsoft.Subscription/preview/2019-10-01-preview/examples/createLegacySubscription.json b/specification/subscription/resource-manager/Microsoft.Subscription/preview/2019-10-01-preview/examples/createLegacySubscription.json
index 65ad499728a9..e0e193269f79 100644
--- a/specification/subscription/resource-manager/Microsoft.Subscription/preview/2019-10-01-preview/examples/createLegacySubscription.json
+++ b/specification/subscription/resource-manager/Microsoft.Subscription/preview/2019-10-01-preview/examples/createLegacySubscription.json
@@ -12,7 +12,13 @@
{
"objectId": "67439a9e-8519-4016-a630-f5f805eba567"
}
- ]
+ ],
+ "additionalParameters": {
+ "customData": {
+ "key1": "value1",
+ "key2": true
+ }
+ }
}
},
"responses": {
diff --git a/specification/subscription/resource-manager/Microsoft.Subscription/preview/2019-10-01-preview/examples/createSubscription.json b/specification/subscription/resource-manager/Microsoft.Subscription/preview/2019-10-01-preview/examples/createSubscription.json
index 84f6fd17ba23..4483cd796e9d 100644
--- a/specification/subscription/resource-manager/Microsoft.Subscription/preview/2019-10-01-preview/examples/createSubscription.json
+++ b/specification/subscription/resource-manager/Microsoft.Subscription/preview/2019-10-01-preview/examples/createSubscription.json
@@ -10,6 +10,12 @@
"costCenter": "135366376",
"owner": {
"objectId": "973034ff-acb7-409c-b731-e789672c7b32"
+ },
+ "additionalParameters": {
+ "customData": {
+ "key1": "value1",
+ "key2": true
+ }
}
}
},
diff --git a/specification/subscription/resource-manager/Microsoft.Subscription/preview/2019-10-01-preview/examples/renameSubscription.json b/specification/subscription/resource-manager/Microsoft.Subscription/preview/2019-10-01-preview/examples/renameSubscription.json
index c673259dde23..0c7f7c131eb7 100644
--- a/specification/subscription/resource-manager/Microsoft.Subscription/preview/2019-10-01-preview/examples/renameSubscription.json
+++ b/specification/subscription/resource-manager/Microsoft.Subscription/preview/2019-10-01-preview/examples/renameSubscription.json
@@ -3,7 +3,7 @@
"subscriptionId": "83aa47df-e3e9-49ff-877b-94304bf3d3ad",
"api-version": "2019-10-01-preview",
"body": {
- "SubscriptionName": "Test Sub"
+ "subscriptionName": "Test Sub"
}
},
"responses": {
diff --git a/specification/subscription/resource-manager/Microsoft.Subscription/preview/2019-10-01-preview/subscriptions.json b/specification/subscription/resource-manager/Microsoft.Subscription/preview/2019-10-01-preview/subscriptions.json
index a065c890aa85..8605058478c8 100644
--- a/specification/subscription/resource-manager/Microsoft.Subscription/preview/2019-10-01-preview/subscriptions.json
+++ b/specification/subscription/resource-manager/Microsoft.Subscription/preview/2019-10-01-preview/subscriptions.json
@@ -542,6 +542,13 @@
"MS-AZR-0017P",
"MS-AZR-0148P"
]
+ },
+ "additionalParameters": {
+ "description": "Additional, untyped parameters to support custom subscription creation scenarios.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "object"
+ }
}
}
},
@@ -571,6 +578,13 @@
"managementGroupId": {
"description": "The identifier of the management group to which this subscription will be associated.",
"type": "string"
+ },
+ "additionalParameters": {
+ "description": "Additional, untyped parameters to support custom subscription creation scenarios.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "object"
+ }
}
}
},
diff --git a/specification/subscription/resource-manager/Microsoft.Subscription/stable/2016-06-01/examples/getSubscription.json b/specification/subscription/resource-manager/Microsoft.Subscription/stable/2016-06-01/examples/getSubscription.json
new file mode 100644
index 000000000000..bbc99e2a75fd
--- /dev/null
+++ b/specification/subscription/resource-manager/Microsoft.Subscription/stable/2016-06-01/examples/getSubscription.json
@@ -0,0 +1,22 @@
+{
+ "parameters": {
+ "subscriptionId": "83aa47df-e3e9-49ff-877b-94304bf3d3ad",
+ "api-version": "2016-06-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/83aa47df-e3e9-49ff-877b-94304bf3d3ad",
+ "authorizationSource": "Legacy",
+ "subscriptionId": "83aa47df-e3e9-49ff-877b-94304bf3d3ad",
+ "displayName": "Subscription2",
+ "state": "Enabled",
+ "subscriptionPolicies": {
+ "locationPlacementId": "Internal_2014-09-01",
+ "quotaId": "Internal_2014-09-01",
+ "spendingLimit": "Off"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/subscription/resource-manager/Microsoft.Subscription/stable/2016-06-01/examples/listLocations.json b/specification/subscription/resource-manager/Microsoft.Subscription/stable/2016-06-01/examples/listLocations.json
new file mode 100644
index 000000000000..7c44bf0f50b9
--- /dev/null
+++ b/specification/subscription/resource-manager/Microsoft.Subscription/stable/2016-06-01/examples/listLocations.json
@@ -0,0 +1,28 @@
+{
+ "parameters": {
+ "subscriptionId": "83aa47df-e3e9-49ff-877b-94304bf3d3ad",
+ "api-version": "2016-06-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "/subscriptions/83aa47df-e3e9-49ff-877b-94304bf3d3ad/locations/eastasia",
+ "name": "eastasia",
+ "displayName": "East Asia",
+ "longitude": "114.188",
+ "latitude": "22.267"
+ },
+ {
+ "id": "/subscriptions/83aa47df-e3e9-49ff-877b-94304bf3d3ad/locations/southeastasia",
+ "name": "southeastasia",
+ "displayName": "Southeast Asia",
+ "longitude": "103.833",
+ "latitude": "1.283"
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/subscription/resource-manager/Microsoft.Subscription/stable/2016-06-01/examples/listSubscriptions.json b/specification/subscription/resource-manager/Microsoft.Subscription/stable/2016-06-01/examples/listSubscriptions.json
new file mode 100644
index 000000000000..5a6caa076237
--- /dev/null
+++ b/specification/subscription/resource-manager/Microsoft.Subscription/stable/2016-06-01/examples/listSubscriptions.json
@@ -0,0 +1,26 @@
+{
+ "parameters": {
+ "api-version": "2016-06-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "nextLink": "string",
+ "value": [
+ {
+ "id": "/subscriptions/83aa47df-e3e9-49ff-877b-94304bf3d3ad",
+ "authorizationSource": "Legacy",
+ "subscriptionId": "83aa47df-e3e9-49ff-877b-94304bf3d3ad",
+ "displayName": "SubscriptionName",
+ "state": "Enabled",
+ "subscriptionPolicies": {
+ "locationPlacementId": "Internal_2014-09-01",
+ "quotaId": "Internal_2014-09-01",
+ "spendingLimit": "Off"
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/subscription/resource-manager/Microsoft.Subscription/stable/2016-06-01/examples/listTenants.json b/specification/subscription/resource-manager/Microsoft.Subscription/stable/2016-06-01/examples/listTenants.json
new file mode 100644
index 000000000000..0b5ecbff5055
--- /dev/null
+++ b/specification/subscription/resource-manager/Microsoft.Subscription/stable/2016-06-01/examples/listTenants.json
@@ -0,0 +1,22 @@
+{
+ "parameters": {
+ "api-version": "2016-06-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "nextLink": "string",
+ "value": [
+ {
+ "id": "/tenants/72f988bf-86f1-41af-91ab-2d7cd011db47",
+ "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47"
+ },
+ {
+ "id": "/tenants/33e01921-4d64-4f8c-a055-5bdaffd5e33d",
+ "tenantId": "33e01921-4d64-4f8c-a055-5bdaffd5e33d"
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/subscription/resource-manager/Microsoft.Subscription/stable/2016-06-01/subscriptions.json b/specification/subscription/resource-manager/Microsoft.Subscription/stable/2016-06-01/subscriptions.json
index 020fda6e55cb..60771a02d266 100644
--- a/specification/subscription/resource-manager/Microsoft.Subscription/stable/2016-06-01/subscriptions.json
+++ b/specification/subscription/resource-manager/Microsoft.Subscription/stable/2016-06-01/subscriptions.json
@@ -42,6 +42,11 @@
"operationId": "Subscriptions_ListLocations",
"summary": "Gets all available geo-locations.",
"description": "This operation provides all the locations that are available for resource providers; however, each resource provider may support a subset of this list.",
+ "x-ms-examples": {
+ "listLocations": {
+ "$ref": "./examples/listLocations.json"
+ }
+ },
"parameters": [
{
"$ref": "#/parameters/SubscriptionIdParameter"
@@ -70,6 +75,11 @@
],
"operationId": "Subscriptions_Get",
"description": "Gets details about a specified subscription.",
+ "x-ms-examples": {
+ "getSubscription": {
+ "$ref": "./examples/getSubscription.json"
+ }
+ },
"parameters": [
{
"$ref": "#/parameters/SubscriptionIdParameter"
@@ -95,6 +105,11 @@
],
"operationId": "Subscriptions_List",
"description": "Gets all subscriptions for a tenant.",
+ "x-ms-examples": {
+ "listSubscriptions": {
+ "$ref": "./examples/listSubscriptions.json"
+ }
+ },
"parameters": [
{
"$ref": "#/parameters/ApiVersionParameter"
@@ -120,6 +135,11 @@
],
"operationId": "Tenants_List",
"description": "Gets the tenants for your account.",
+ "x-ms-examples": {
+ "listTenants": {
+ "$ref": "./examples/listTenants.json"
+ }
+ },
"parameters": [
{
"$ref": "#/parameters/ApiVersionParameter"
diff --git a/specification/subscription/resource-manager/readme.go.md b/specification/subscription/resource-manager/readme.go.md
index df396b0b4fb0..b52d772b3e18 100644
--- a/specification/subscription/resource-manager/readme.go.md
+++ b/specification/subscription/resource-manager/readme.go.md
@@ -13,10 +13,20 @@ go:
``` yaml $(go) && $(multiapi)
batch:
+ - tag: package-2019-10-preview
- tag: package-2018-03-preview
- tag: package-2017-11-preview
```
+### Tag: package-2019-10-preview and go
+
+These settings apply only when `--tag=package-2019-10-preview --go` is specified on the command line.
+Please also specify `--go-sdk-folder=`.
+
+``` yaml $(tag)=='package-2019-10-preview' && $(go)
+output-folder: $(go-sdk-folder)/services/preview/$(namespace)/mgmt/2019-10-01-preview/$(namespace)
+```
+
### Tag: package-2018-03-preview and go
These settings apply only when `--tag=package-2018-03-preview --go` is specified on the command line.
diff --git a/specification/subscription/resource-manager/readme.md b/specification/subscription/resource-manager/readme.md
index 8aeaf4c34934..214a5e7d5dec 100644
--- a/specification/subscription/resource-manager/readme.md
+++ b/specification/subscription/resource-manager/readme.md
@@ -51,6 +51,7 @@ These settings apply only when `--tag=package-2019-10-preview` is specified on t
``` yaml $(tag) == 'package-2019-10-preview'
input-file:
+- Microsoft.Subscription/stable/2016-06-01/subscriptions.json
- Microsoft.Subscription/preview/2019-10-01-preview/subscriptions.json
title: SubscriptionClient
description: The subscription client
@@ -146,9 +147,23 @@ output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-subscription
``` yaml $(java) && $(multiapi)
batch:
+ - tag: package-2019-10-preview
- tag: package-2017-11-preview
```
+### Tag: package-2019-10-preview and java
+
+These settings apply only when `--tag=package-2019-10-preview --java` is specified on the command line.
+Please also specify `--azure-libraries-for-java=`.
+
+``` yaml $(tag) == 'package-2019-10-preview' && $(java) && $(multiapi)
+java:
+ namespace: com.microsoft.azure.management.subscription.v2019_10_01_preview
+ output-folder: $(azure-libraries-for-java-folder)/sdk/subscription/mgmt-v2019_10_01_preview
+regenerate-manager: true
+generate-interface: true
+```
+
### Tag: package-2017-11-preview and java
These settings apply only when `--tag=package-2017-11-preview --java` is specified on the command line.
@@ -187,12 +202,12 @@ require: $(this-folder)/../../../profiles/readme.md
# all the input files across all versions
input-file:
- $(this-folder)/Microsoft.Subscription/stable/2020-01-01/subscriptions.json
+ - $(this-folder)/Microsoft.Subscription/stable/2016-06-01/subscriptions.json
- $(this-folder)/Microsoft.Subscription/preview/2019-10-01-preview/subscriptions.json
- $(this-folder)/Microsoft.Subscription/preview/2019-03-01-preview/subscriptions.json
- $(this-folder)/Microsoft.Subscription/preview/2018-11-01-preview/subscriptions.json
- $(this-folder)/Microsoft.Subscription/preview/2018-03-01-preview/subscriptions.json
- $(this-folder)/Microsoft.Subscription/preview/2018-03-01-preview/operations.json
- - $(this-folder)/Microsoft.Subscription/stable/2016-06-01/subscriptions.json
- $(this-folder)/Microsoft.Subscription/preview/2017-11-01-preview/subscriptionDefinitions.json
```
diff --git a/specification/support/resource-manager/readme.cli.md b/specification/support/resource-manager/readme.cli.md
new file mode 100644
index 000000000000..220310005660
--- /dev/null
+++ b/specification/support/resource-manager/readme.cli.md
@@ -0,0 +1,64 @@
+## CLI
+
+These settings apply only when `--cli` is specified on the command line.
+
+``` yaml $(cli)
+cli:
+ test-scenario:
+ - name: /SupportTickets/put/Create a ticket to request Quota increase for Low-priority cores for a Batch account
+ disabled: true
+ - name: /SupportTickets/put/Create a ticket to request Quota increase for Servers for Azure Synapse Analytics
+ disabled: true
+ - name: /SupportTickets/put/Create a ticket to request Quota increase for DTUs for Azure Synapse Analytics
+ disabled: true
+ - name: /SupportTickets/put/Create a ticket to request Quota increase for Servers for SQL Database
+ disabled: true
+ - name: /SupportTickets/put/Create a ticket to request Quota increase for DTUs for SQL Database
+ disabled: true
+ - name: /SupportTickets/put/Create a ticket to request Quota increase for specific VM family cores for Machine Learning service
+ disabled: true
+ - name: /SupportTickets/put/Create a ticket to request Quota increase for Active Jobs and Job Schedules for a Batch account
+ disabled: true
+ - name: /SupportTickets/put/Create a ticket to request Quota increase for Pools for a Batch account
+ disabled: true
+ - name: /SupportTickets/put/Create a ticket to request Quota increase for specific VM family cores for a Batch account
+ disabled: true
+ - name: /SupportTickets/put/Create a ticket for Billing related issues
+ disabled: true
+ - name: /SupportTickets/put/Create a ticket for Subscription Management related issues
+ disabled: true
+ - name: /SupportTickets/put/Create a ticket to request Quota increase for Low-priority cores for Machine Learning service
+ disabled: true
+ - name: /SupportTickets/put/Create a ticket for Technical issue related to a specific resource
+ disabled: true
+ - name: /SupportTickets/put/Create a ticket to request Quota increase for services that do not require additional details in the quotaTi
+ disabled: true
+ - name: /SupportTickets/put/Create a ticket to request Quota increase for Compute VM Cores
+ disabled: true
+ - name: /SupportTickets/put/Create a ticket to request Quota increase for Batch accounts for a subscription
+ disabled: true
+ - name: /Communications/put/AddCommunicationToSubscriptionTicket
+ disabled: true
+ - name: /Communications/get/Get communication details for a subscription support ticket
+ disabled: true
+ - name: /Communications/get/List web communications for a subscription support ticket
+ disabled: true
+ - name: /Communications/get/List communications for a subscription support ticket
+ disabled: true
+ - name: /Communications/get/List web communication created on or after a specific date for a subscription support ticket
+ disabled: true
+ - name: /ProblemClassifications/get/Gets details of problemClassification for Azure service
+ - name: /SupportTickets/get/Get details of a subscription ticket
+ disabled: true
+ - name: /SupportTickets/get/List support tickets in open state for a subscription
+ - name: /ProblemClassifications/get/Gets list of problemClassifications for a service for which a support ticket can be created
+ - name: /SupportTickets/get/List support tickets created on or after a certain date and in open state for a subscription
+ - name: /Services/get/Gets list of services for which a support ticket can be created
+ - name: /Communications/post/Checks whether name is available for Communication resource
+ - name: /SupportTickets/patch/Update contact details of a support ticket
+ disabled: true
+ - name: /SupportTickets/patch/Update severity of a support ticket
+ disabled: true
+ - name: /SupportTickets/patch/Update status of a support ticket
+ disabled: true
+ - name: /SupportTickets/post/Checks whether name is available for SupportTicket resource
diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/datafactory.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/artifacts.json
similarity index 95%
rename from specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/datafactory.json
rename to specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/artifacts.json
index ecb09e0842b3..f78900be895d 100644
--- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/datafactory.json
+++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/artifacts.json
@@ -1,25 +1,18 @@
{
"swagger": "2.0",
"info": {
- "version": "2019-11-01-preview",
- "title": "SynapseClient",
+ "version": "2019-06-01-preview",
+ "title": "ArtifactsClient",
"x-ms-code-generation-settings": {
"useDateTimeOffset": true
}
},
"x-ms-parameterized-host": {
- "hostTemplate": "{workspaceName}.{SynapseDnsSuffix}",
+ "hostTemplate": "{endpoint}",
+ "useSchemePrefix": false,
"parameters": [
{
- "name": "workspaceName",
- "description": "The name of the workspace to execute operations on.",
- "required": true,
- "type": "string",
- "in": "path",
- "x-ms-skip-url-encoding": true
- },
- {
- "$ref": "#/parameters/SynapseDnsSuffixInPath"
+ "$ref": "#/parameters/Endpoint"
}
]
},
@@ -38,7 +31,7 @@
"tags": [
"linkedServices"
],
- "operationId": "LinkedServices_ListByWorkspace",
+ "operationId": "LinkedService_GetLinkedServicesByWorkspace",
"x-ms-examples": {
"LinkedServices_ListByWorkspace": {
"$ref": "./examples/LinkedServices_ListByWorkspace.json"
@@ -74,7 +67,7 @@
"tags": [
"linkedServices"
],
- "operationId": "LinkedServices_CreateOrUpdate",
+ "operationId": "LinkedService_CreateOrUpdateLinkedService",
"x-ms-examples": {
"LinkedServices_Create": {
"$ref": "./examples/LinkedServices_Create.json"
@@ -127,7 +120,7 @@
"tags": [
"linkedServices"
],
- "operationId": "LinkedServices_Get",
+ "operationId": "LinkedService_GetLinkedService",
"x-ms-examples": {
"LinkedServices_Get": {
"$ref": "./examples/LinkedServices_Get.json"
@@ -171,7 +164,7 @@
"tags": [
"linkedServices"
],
- "operationId": "LinkedServices_Delete",
+ "operationId": "LinkedService_DeleteLinkedService",
"x-ms-examples": {
"LinkedServices_Delete": {
"$ref": "./examples/LinkedServices_Delete.json"
@@ -207,7 +200,7 @@
"tags": [
"datasets"
],
- "operationId": "Datasets_ListByWorkspace",
+ "operationId": "Dataset_GetDatasetsByWorkspace",
"x-ms-examples": {
"Datasets_ListByWorkspace": {
"$ref": "./examples/Datasets_ListByWorkspace.json"
@@ -243,7 +236,7 @@
"tags": [
"datasets"
],
- "operationId": "Datasets_CreateOrUpdate",
+ "operationId": "Dataset_CreateOrUpdateDataset",
"x-ms-examples": {
"Datasets_Create": {
"$ref": "./examples/Datasets_Create.json"
@@ -296,7 +289,7 @@
"tags": [
"datasets"
],
- "operationId": "Datasets_Get",
+ "operationId": "Dataset_GetDataset",
"x-ms-examples": {
"Datasets_Get": {
"$ref": "./examples/Datasets_Get.json"
@@ -340,7 +333,7 @@
"tags": [
"datasets"
],
- "operationId": "Datasets_Delete",
+ "operationId": "Dataset_DeleteDataset",
"x-ms-examples": {
"Datasets_Delete": {
"$ref": "./examples/Datasets_Delete.json"
@@ -376,7 +369,7 @@
"tags": [
"pipelines"
],
- "operationId": "Pipelines_ListByWorkspace",
+ "operationId": "Pipeline_GetPipelinesByWorkspace",
"x-ms-examples": {
"Pipelines_ListByWorkspace": {
"$ref": "./examples/Pipelines_ListByWorkspace.json"
@@ -412,7 +405,7 @@
"tags": [
"pipelines"
],
- "operationId": "Pipelines_CreateOrUpdate",
+ "operationId": "Pipeline_CreateOrUpdatePipeline",
"x-ms-examples": {
"Pipelines_Create": {
"$ref": "./examples/Pipelines_Create.json"
@@ -465,7 +458,7 @@
"tags": [
"pipelines"
],
- "operationId": "Pipelines_Get",
+ "operationId": "Pipeline_GetPipeline",
"x-ms-examples": {
"Pipelines_Get": {
"$ref": "./examples/Pipelines_Get.json"
@@ -509,7 +502,7 @@
"tags": [
"pipelines"
],
- "operationId": "Pipelines_Delete",
+ "operationId": "Pipeline_DeletePipeline",
"x-ms-examples": {
"Pipelines_Delete": {
"$ref": "./examples/Pipelines_Delete.json"
@@ -545,7 +538,7 @@
"tags": [
"pipelines"
],
- "operationId": "Pipelines_CreateRun",
+ "operationId": "Pipeline_CreatePipelineRun",
"x-ms-examples": {
"Pipelines_CreateRun": {
"$ref": "./examples/Pipelines_CreateRun.json"
@@ -611,7 +604,7 @@
},
"/queryPipelineRuns": {
"post": {
- "operationId": "PipelineRuns_QueryByWorkspace",
+ "operationId": "PipelineRun_QueryPipelineRunsByWorkspace",
"x-ms-examples": {
"PipelineRuns_QueryByWorkspace": {
"$ref": "./examples/PipelineRuns_QueryByWorkspace.json"
@@ -653,7 +646,7 @@
},
"/pipelineruns/{runId}": {
"get": {
- "operationId": "PipelineRuns_Get",
+ "operationId": "PipelineRun_GetPipelineRun",
"x-ms-examples": {
"PipelineRuns_Get": {
"$ref": "./examples/PipelineRuns_Get.json"
@@ -689,7 +682,7 @@
},
"/pipelines/{pipelineName}/pipelineruns/{runId}/queryActivityruns": {
"post": {
- "operationId": "ActivityRuns_QueryByPipelineRun",
+ "operationId": "PipelineRun_QueryActivityRuns",
"x-ms-examples": {
"ActivityRuns_QueryByPipelineRun": {
"$ref": "./examples/ActivityRuns_QueryByPipelineRun.json"
@@ -737,7 +730,7 @@
},
"/pipelineruns/{runId}/cancel": {
"post": {
- "operationId": "PipelineRuns_Cancel",
+ "operationId": "PipelineRun_CancelPipelineRun",
"x-ms-examples": {
"PipelineRuns_Cancel": {
"$ref": "./examples/PipelineRuns_Cancel.json"
@@ -780,7 +773,7 @@
"tags": [
"triggers"
],
- "operationId": "Triggers_ListByWorkspace",
+ "operationId": "Trigger_GetTriggersByWorkspace",
"x-ms-examples": {
"Triggers_ListByWorkspace": {
"$ref": "./examples/Triggers_ListByWorkspace.json"
@@ -816,7 +809,7 @@
"tags": [
"triggers"
],
- "operationId": "Triggers_CreateOrUpdate",
+ "operationId": "Trigger_CreateOrUpdateTrigger",
"x-ms-examples": {
"Triggers_Create": {
"$ref": "./examples/Triggers_Create.json"
@@ -869,7 +862,7 @@
"tags": [
"trigger"
],
- "operationId": "Triggers_Get",
+ "operationId": "Trigger_GetTrigger",
"x-ms-examples": {
"Triggers_Get": {
"$ref": "./examples/Triggers_Get.json"
@@ -913,7 +906,7 @@
"tags": [
"triggers"
],
- "operationId": "Triggers_Delete",
+ "operationId": "Trigger_DeleteTrigger",
"x-ms-examples": {
"Triggers_Delete": {
"$ref": "./examples/Triggers_Delete.json"
@@ -949,7 +942,7 @@
"tags": [
"triggers"
],
- "operationId": "Triggers_SubscribeToEvents",
+ "operationId": "Trigger_SubscribeTriggerToEvents",
"x-ms-examples": {
"Triggers_SubscribeToEvents": {
"$ref": "./examples/Triggers_SubscribeToEvents.json"
@@ -989,7 +982,7 @@
"tags": [
"triggers"
],
- "operationId": "Triggers_GetEventSubscriptionStatus",
+ "operationId": "Trigger_GetEventSubscriptionStatus",
"x-ms-examples": {
"Triggers_GetEventSubscriptionStatus": {
"$ref": "./examples/Triggers_GetEventSubscriptionStatus.json"
@@ -1025,7 +1018,7 @@
"tags": [
"triggers"
],
- "operationId": "Triggers_UnsubscribeFromEvents",
+ "operationId": "Trigger_UnsubscribeTriggerFromEvents",
"x-ms-examples": {
"Triggers_UnsubscribeFromEvents": {
"$ref": "./examples/Triggers_UnsubscribeFromEvents.json"
@@ -1065,7 +1058,7 @@
"tags": [
"triggers"
],
- "operationId": "Triggers_Start",
+ "operationId": "Trigger_StartTrigger",
"x-ms-examples": {
"Triggers_Start": {
"$ref": "./examples/Triggers_Start.json"
@@ -1099,7 +1092,7 @@
"tags": [
"triggers"
],
- "operationId": "Triggers_Stop",
+ "operationId": "Trigger_StopTrigger",
"x-ms-examples": {
"Triggers_Stop": {
"$ref": "./examples/Triggers_Stop.json"
@@ -1133,7 +1126,7 @@
"tags": [
"triggerruns"
],
- "operationId": "TriggerRuns_Rerun",
+ "operationId": "TriggerRun_RerunTriggerInstance",
"x-ms-examples": {
"Triggers_Rerun": {
"$ref": "./examples/TriggerRuns_Rerun.json"
@@ -1169,7 +1162,7 @@
"tags": [
"triggerruns"
],
- "operationId": "TriggerRuns_QueryByWorkspace",
+ "operationId": "TriggerRun_QueryTriggerRunsByWorkspace",
"x-ms-examples": {
"TriggerRuns_QueryByWorkspace": {
"$ref": "./examples/TriggerRuns_QueryByWorkspace.json"
@@ -1211,7 +1204,7 @@
"tags": [
"dataFlows"
],
- "operationId": "DataFlows_CreateOrUpdate",
+ "operationId": "DataFlow_CreateOrUpdateDataFlow",
"x-ms-examples": {
"DataFlows_Create": {
"$ref": "./examples/DataFlows_Create.json"
@@ -1264,7 +1257,7 @@
"tags": [
"dataFlows"
],
- "operationId": "DataFlows_Get",
+ "operationId": "DataFlow_GetDataFlow",
"x-ms-examples": {
"DataFlows_Get": {
"$ref": "./examples/DataFlows_Get.json"
@@ -1305,7 +1298,7 @@
"tags": [
"dataFlows"
],
- "operationId": "DataFlows_Delete",
+ "operationId": "DataFlow_DeleteDataFlow",
"x-ms-examples": {
"DataFlows_Delete": {
"$ref": "./examples/DataFlows_Delete.json"
@@ -1341,7 +1334,7 @@
"tags": [
"dataFlows"
],
- "operationId": "DataFlows_ListByWorkspace",
+ "operationId": "DataFlow_GetDataFlowsByWorkspace",
"x-ms-examples": {
"DataFlows_ListByWorkspace": {
"$ref": "./examples/DataFlows_ListByWorkspace.json"
@@ -1377,7 +1370,7 @@
"tags": [
"dataFlowDebugSession"
],
- "operationId": "DataFlowDebugSession_Create",
+ "operationId": "DataFlowDebugSession_CreateDataFlowDebugSession",
"x-ms-examples": {
"DataFlowDebugSession_Create": {
"$ref": "./examples/DataFlowDebugSession_Create.json"
@@ -1429,7 +1422,7 @@
"tags": [
"dataFlowDebugSession"
],
- "operationId": "DataFlowDebugSession_QueryByWorkspace",
+ "operationId": "DataFlowDebugSession_QueryDataFlowDebugSessionsByWorkspace",
"x-ms-examples": {
"DataFlowDebugSession_QueryByWorkspace": {
"$ref": "./examples/DataFlowDebugSession_QueryByWorkspace.json"
@@ -1507,7 +1500,7 @@
"tags": [
"dataFlowDebugSession"
],
- "operationId": "DataFlowDebugSession_Delete",
+ "operationId": "DataFlowDebugSession_DeleteDataFlowDebugSession",
"x-ms-examples": {
"DataFlowDebugSession_Delete": {
"$ref": "./examples/DataFlowDebugSession_Delete.json"
@@ -1598,7 +1591,7 @@
"tags": [
"sqlScripts"
],
- "operationId": "SqlScripts_ListByWorkspace",
+ "operationId": "SqlScript_GetSqlScriptsByWorkspace",
"x-ms-examples": {
"SqlScripts_ListByWorkspace": {
"$ref": "./examples/SqlScripts_ListByWorkspace.json"
@@ -1634,7 +1627,7 @@
"tags": [
"sqlScripts"
],
- "operationId": "SqlScripts_CreateOrUpdate",
+ "operationId": "SqlScript_CreateOrUpdateSqlScript",
"x-ms-examples": {
"SqlScripts_Create": {
"$ref": "./examples/SqlScripts_Create.json"
@@ -1687,7 +1680,7 @@
"tags": [
"sqlScripts"
],
- "operationId": "SqlScripts_Get",
+ "operationId": "SqlScript_GetSqlScript",
"x-ms-examples": {
"SqlScripts_Get": {
"$ref": "./examples/SqlScripts_Get.json"
@@ -1731,7 +1724,7 @@
"tags": [
"sqlScripts"
],
- "operationId": "SqlScripts_Delete",
+ "operationId": "SqlScript_DeleteSqlScript",
"x-ms-examples": {
"SqlScripts_Delete": {
"$ref": "./examples/SqlScripts_Delete.json"
@@ -1767,7 +1760,7 @@
"tags": [
"sparkJobDefinitions"
],
- "operationId": "SparkJobDefinitions_ListByWorkspace",
+ "operationId": "SparkJobDefinition_GetSparkJobDefinitionsByWorkspace",
"x-ms-examples": {
"SparkJobDefinitions_ListByWorkspace": {
"$ref": "./examples/SparkJobDefinitions_ListByWorkspace.json"
@@ -1803,7 +1796,7 @@
"tags": [
"sparkJobDefinitions"
],
- "operationId": "SparkJobDefinitions_CreateOrUpdate",
+ "operationId": "SparkJobDefinition_CreateOrUpdateSparkJobDefinition",
"x-ms-examples": {
"SparkJobDefinitions_Create": {
"$ref": "./examples/SparkJobDefinitions_Create.json"
@@ -1856,7 +1849,7 @@
"tags": [
"sparkJobDefinitions"
],
- "operationId": "SparkJobDefinitions_Get",
+ "operationId": "SparkJobDefinition_GetSparkJobDefinition",
"x-ms-examples": {
"SparkJobDefinitions_Get": {
"$ref": "./examples/SparkJobDefinitions_Get.json"
@@ -1900,7 +1893,7 @@
"tags": [
"sparkJobDefinitions"
],
- "operationId": "SparkJobDefinitions_Delete",
+ "operationId": "SparkJobDefinition_DeleteSparkJobDefinition",
"x-ms-examples": {
"SparkJobDefinitions_Delete": {
"$ref": "./examples/SparkJobDefinitions_Delete.json"
@@ -1936,7 +1929,7 @@
"tags": [
"sparkJobDefinitions"
],
- "operationId": "SparkJobDefinitions_Execute",
+ "operationId": "SparkJobDefinition_ExecuteSparkJobDefinition",
"x-ms-examples": {
"SparkJobDefinitions_Execute": {
"$ref": "./examples/SparkJobDefinitions_Execute.json"
@@ -1959,13 +1952,13 @@
"202": {
"description": "Accepted.",
"schema": {
- "$ref": "../sparkFrontend.json#/definitions/ExtendedLivyBatchResponse"
+ "$ref": "../2019-11-01-preview/sparkJob.json#/definitions/SparkBatchJob"
}
},
"200": {
"description": "OK.",
"schema": {
- "$ref": "../sparkFrontend.json#/definitions/ExtendedLivyBatchResponse"
+ "$ref": "../2019-11-01-preview/sparkJob.json#/definitions/SparkBatchJob"
}
},
"default": {
@@ -1982,7 +1975,7 @@
"tags": [
"sparkJobDefinitions"
],
- "operationId": "SparkJobDefinitions_Debug",
+ "operationId": "SparkJobDefinition_DebugSparkJobDefinition",
"x-ms-examples": {
"SparkJobDefinitions_Debug": {
"$ref": "./examples/SparkJobDefinitions_Debug.json"
@@ -2011,13 +2004,13 @@
"202": {
"description": "Accepted.",
"schema": {
- "$ref": "../sparkFrontend.json#/definitions/ExtendedLivyBatchResponse"
+ "$ref": "../2019-11-01-preview/sparkJob.json#/definitions/SparkBatchJob"
}
},
"200": {
"description": "OK.",
"schema": {
- "$ref": "../sparkFrontend.json#/definitions/ExtendedLivyBatchResponse"
+ "$ref": "../2019-11-01-preview/sparkJob.json#/definitions/SparkBatchJob"
}
},
"default": {
@@ -2032,15 +2025,15 @@
"/notebooks": {
"get": {
"tags": [
- "noteBooks"
+ "notebooks"
],
- "operationId": "NoteBooks_ListByWorkspace",
+ "operationId": "Notebook_GetNotebooksByWorkspace",
"x-ms-examples": {
- "NoteBooks_ListByWorkspace": {
- "$ref": "./examples/NoteBooks_ListByWorkspace.json"
+ "Notebooks_ListByWorkspace": {
+ "$ref": "./examples/Notebooks_ListByWorkspace.json"
}
},
- "description": "Lists notebooks.",
+ "description": "Lists Notebooks.",
"parameters": [
{
"$ref": "#/parameters/ApiVersionParameter"
@@ -2050,7 +2043,7 @@
"200": {
"description": "OK.",
"schema": {
- "$ref": "#/definitions/NoteBookListResponse"
+ "$ref": "#/definitions/NotebookListResponse"
}
},
"default": {
@@ -2068,15 +2061,15 @@
"/notebooks/summary": {
"get": {
"tags": [
- "noteBooks"
+ "notebooks"
],
- "operationId": "NoteBooks_ListSummaryByWorkSpace",
+ "operationId": "Notebook_GetNotebookSummaryByWorkSpace",
"x-ms-examples": {
- "NoteBooks_ListSummaryByWorkSpace": {
- "$ref": "./examples/NoteBooks_ListSummaryByWorkSpace.json"
+ "Notebooks_ListSummaryByWorkSpace": {
+ "$ref": "./examples/Notebooks_ListSummaryByWorkSpace.json"
}
},
- "description": "Lists a summary of notebooks.",
+ "description": "Lists a summary of Notebooks.",
"parameters": [
{
"$ref": "#/parameters/ApiVersionParameter"
@@ -2086,7 +2079,7 @@
"200": {
"description": "OK.",
"schema": {
- "$ref": "#/definitions/NoteBookListResponse"
+ "$ref": "#/definitions/NotebookListResponse"
}
},
"default": {
@@ -2101,24 +2094,24 @@
}
}
},
- "/notebooks/{noteBookName}": {
+ "/notebooks/{notebookName}": {
"put": {
"tags": [
- "noteBooks"
+ "notebooks"
],
- "operationId": "NoteBooks_CreateOrUpdate",
+ "operationId": "Notebook_CreateOrUpdateNotebook",
"x-ms-examples": {
- "NoteBooks_Create": {
- "$ref": "./examples/NoteBooks_Create.json"
+ "Notebooks_Create": {
+ "$ref": "./examples/Notebooks_Create.json"
},
- "NoteBooks_Update": {
- "$ref": "./examples/NoteBooks_Update.json"
+ "Notebooks_Update": {
+ "$ref": "./examples/Notebooks_Update.json"
}
},
"description": "Creates or updates a Note Book.",
"parameters": [
{
- "$ref": "#/parameters/noteBookName"
+ "$ref": "#/parameters/NotebookName"
},
{
"$ref": "#/parameters/ApiVersionParameter"
@@ -2131,12 +2124,12 @@
"description": "ETag of the Note book entity. Should only be specified for update, for which it should match existing entity or can be * for unconditional update."
},
{
- "name": "noteBook",
+ "name": "Notebook",
"description": "Note book resource definition.",
"in": "body",
"required": true,
"schema": {
- "$ref": "#/definitions/NoteBookResource"
+ "$ref": "#/definitions/NotebookResource"
}
}
],
@@ -2144,7 +2137,7 @@
"200": {
"description": "OK.",
"schema": {
- "$ref": "#/definitions/NoteBookResource"
+ "$ref": "#/definitions/NotebookResource"
}
},
"default": {
@@ -2157,18 +2150,18 @@
},
"get": {
"tags": [
- "noteBooks"
+ "notebooks"
],
- "operationId": "NoteBooks_Get",
+ "operationId": "Notebook_GetNotebook",
"x-ms-examples": {
- "NoteBooks_Get": {
- "$ref": "./examples/NoteBooks_Get.json"
+ "Notebooks_Get": {
+ "$ref": "./examples/Notebooks_Get.json"
}
},
"description": "Gets a Note Book.",
"parameters": [
{
- "$ref": "#/parameters/noteBookName"
+ "$ref": "#/parameters/NotebookName"
},
{
"$ref": "#/parameters/ApiVersionParameter"
@@ -2178,14 +2171,14 @@
"in": "header",
"required": false,
"type": "string",
- "description": "ETag of the notebook entity. Should only be specified for get. If the ETag matches the existing entity tag, or if * was provided, then no content will be returned."
+ "description": "ETag of the Notebook entity. Should only be specified for get. If the ETag matches the existing entity tag, or if * was provided, then no content will be returned."
}
],
"responses": {
"200": {
"description": "OK.",
"schema": {
- "$ref": "#/definitions/NoteBookResource"
+ "$ref": "#/definitions/NotebookResource"
}
},
"304": {
@@ -2201,18 +2194,18 @@
},
"delete": {
"tags": [
- "noteBooks"
+ "notebooks"
],
- "operationId": "NoteBooks_Delete",
+ "operationId": "Notebook_DeleteNotebook",
"x-ms-examples": {
- "NoteBooks_Delete": {
- "$ref": "./examples/NoteBooks_Delete.json"
+ "Notebooks_Delete": {
+ "$ref": "./examples/Notebooks_Delete.json"
}
},
"description": "Deletes a Note book.",
"parameters": [
{
- "$ref": "#/parameters/noteBookName"
+ "$ref": "#/parameters/NotebookName"
},
{
"$ref": "#/parameters/ApiVersionParameter"
@@ -3177,7 +3170,7 @@
"DatasetReference"
],
"x-ms-enum": {
- "name": "Type",
+ "name": "DatasetReferenceType",
"modelAsString": true
}
},
@@ -3365,8 +3358,8 @@
"properties"
]
},
- "NoteBookListResponse": {
- "description": "A list of notebook resources.",
+ "NotebookListResponse": {
+ "description": "A list of Notebook resources.",
"type": "object",
"required": [
"value"
@@ -3374,9 +3367,9 @@
"properties": {
"value": {
"type": "array",
- "description": "List of notebooks.",
+ "description": "List of Notebooks.",
"items": {
- "$ref": "#/definitions/NoteBookResource"
+ "$ref": "#/definitions/NotebookResource"
}
},
"nextLink": {
@@ -3385,8 +3378,8 @@
}
}
},
- "NoteBookResource": {
- "description": "NoteBook resource type.",
+ "NotebookResource": {
+ "description": "Notebook resource type.",
"allOf": [
{
"$ref": "#/definitions/SubResource"
@@ -3394,8 +3387,8 @@
],
"properties": {
"properties": {
- "$ref": "./entityTypes/NoteBook.json#/definitions/NoteBook",
- "description": "Properties of NoteBook."
+ "$ref": "./entityTypes/Notebook.json#/definitions/Notebook",
+ "description": "Properties of Notebook."
}
},
"required": [
@@ -4136,24 +4129,6 @@
}
},
"parameters": {
- "subscriptionId": {
- "name": "subscriptionId",
- "description": "The subscription identifier.",
- "in": "path",
- "required": true,
- "type": "string"
- },
- "resourceGroupName": {
- "name": "resourceGroupName",
- "description": "The resource group name.",
- "in": "path",
- "required": true,
- "type": "string",
- "pattern": "^[-\\w\\._\\(\\)]+$",
- "minLength": 1,
- "maxLength": 90,
- "x-ms-parameter-location": "method"
- },
"workspaceName": {
"name": "workspaceName",
"description": "The workspace name.",
@@ -4162,22 +4137,6 @@
"type": "string",
"x-ms-parameter-location": "method"
},
- "sqlComputeName": {
- "name": "sqlComputeName",
- "description": "The sql compute name.",
- "in": "path",
- "required": true,
- "type": "string",
- "x-ms-parameter-location": "method"
- },
- "sparkComputeName": {
- "name": "sparkComputeName",
- "description": "The spark compute name.",
- "in": "path",
- "required": true,
- "type": "string",
- "x-ms-parameter-location": "method"
- },
"sqlScriptName": {
"name": "sqlScriptName",
"description": "The sql script name.",
@@ -4194,9 +4153,9 @@
"type": "string",
"x-ms-parameter-location": "method"
},
- "noteBookName": {
- "name": "noteBookName",
- "description": "The note book name.",
+ "NotebookName": {
+ "name": "notebookName",
+ "description": "The notebook name.",
"in": "path",
"required": true,
"type": "string",
@@ -4318,14 +4277,13 @@
"type": "string",
"description": "The Synapse client API Version."
},
- "SynapseDnsSuffixInPath": {
- "name": "SynapseDnsSuffix",
- "in": "path",
+ "Endpoint": {
+ "name": "endpoint",
+ "description": "The workspace development endpoint, for example https://myworkspace.dev.azuresynapse.net.",
"required": true,
"type": "string",
- "default": "dev.azuresynapse.net",
+ "in": "path",
"x-ms-skip-url-encoding": true,
- "description": "Gets the DNS suffix used as the base for all Synapse service requests.",
"x-ms-parameter-location": "client"
}
}
diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/entityTypes/DataFlow.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/entityTypes/DataFlow.json
similarity index 94%
rename from specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/entityTypes/DataFlow.json
rename to specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/entityTypes/DataFlow.json
index d1317f5bd0e2..cc6adc44e2fd 100644
--- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/entityTypes/DataFlow.json
+++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/entityTypes/DataFlow.json
@@ -1,8 +1,8 @@
{
"swagger": "2.0",
"info": {
- "title": "SynapseClient",
- "version": "2019-11-01-preview"
+ "title": "ArtifactsClient",
+ "version": "2019-06-01-preview"
},
"paths": {},
"definitions": {
@@ -115,7 +115,7 @@
"properties": {
"dataset": {
"description": "Dataset reference.",
- "$ref": "../datafactory.json#/definitions/DatasetReference"
+ "$ref": "../artifacts.json#/definitions/DatasetReference"
}
}
},
@@ -129,7 +129,7 @@
"properties": {
"dataset": {
"description": "Dataset reference.",
- "$ref": "../datafactory.json#/definitions/DatasetReference"
+ "$ref": "../artifacts.json#/definitions/DatasetReference"
}
}
}
diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/entityTypes/Dataset.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/entityTypes/Dataset.json
similarity index 99%
rename from specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/entityTypes/Dataset.json
rename to specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/entityTypes/Dataset.json
index 29f8b205d98f..1aa9e4d000f2 100644
--- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/entityTypes/Dataset.json
+++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/entityTypes/Dataset.json
@@ -1,8 +1,8 @@
{
"swagger": "2.0",
"info": {
- "title": "SynapseClient",
- "version": "2019-11-01-preview"
+ "title": "ArtifactsClient",
+ "version": "2019-06-01-preview"
},
"paths": {},
"definitions": {
@@ -29,10 +29,10 @@
},
"linkedServiceName": {
"description": "Linked service reference.",
- "$ref": "../datafactory.json#/definitions/LinkedServiceReference"
+ "$ref": "../artifacts.json#/definitions/LinkedServiceReference"
},
"parameters": {
- "$ref": "../datafactory.json#/definitions/ParameterDefinitionSpecification",
+ "$ref": "../artifacts.json#/definitions/ParameterDefinitionSpecification",
"description": "Parameters for dataset."
},
"annotations": {
diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/entityTypes/LinkedService.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/entityTypes/LinkedService.json
similarity index 96%
rename from specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/entityTypes/LinkedService.json
rename to specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/entityTypes/LinkedService.json
index bbee397ae546..8f54c7fb088c 100644
--- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/entityTypes/LinkedService.json
+++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/entityTypes/LinkedService.json
@@ -1,8 +1,8 @@
{
"swagger": "2.0",
"info": {
- "title": "SynapseClient",
- "version": "2019-11-01-preview"
+ "title": "ArtifactsClient",
+ "version": "2019-06-01-preview"
},
"paths": {},
"definitions": {
@@ -17,14 +17,14 @@
},
"connectVia": {
"description": "The integration runtime reference.",
- "$ref": "../datafactory.json#/definitions/IntegrationRuntimeReference"
+ "$ref": "../artifacts.json#/definitions/IntegrationRuntimeReference"
},
"description": {
"description": "Linked service description.",
"type": "string"
},
"parameters": {
- "$ref": "../datafactory.json#/definitions/ParameterDefinitionSpecification",
+ "$ref": "../artifacts.json#/definitions/ParameterDefinitionSpecification",
"description": "Parameters for linked service."
},
"annotations": {
@@ -110,7 +110,7 @@
"type": "object"
},
"accountKey": {
- "$ref": "../datafactory.json#/definitions/AzureKeyVaultSecretReference",
+ "$ref": "../artifacts.json#/definitions/AzureKeyVaultSecretReference",
"description": "The Azure key vault secret reference of accountKey in connection string."
},
"sasUri": {
@@ -118,7 +118,7 @@
"type": "object"
},
"sasToken": {
- "$ref": "../datafactory.json#/definitions/AzureKeyVaultSecretReference",
+ "$ref": "../artifacts.json#/definitions/AzureKeyVaultSecretReference",
"description": "The Azure key vault secret reference of sasToken in sas uri."
},
"encryptedCredential": {
@@ -135,7 +135,7 @@
"description": "The connection string. It is mutually exclusive with sasUri, serviceEndpoint property. Type: string, SecureString or AzureKeyVaultSecretReference."
},
"accountKey": {
- "$ref": "../datafactory.json#/definitions/AzureKeyVaultSecretReference",
+ "$ref": "../artifacts.json#/definitions/AzureKeyVaultSecretReference",
"description": "The Azure key vault secret reference of accountKey in connection string."
},
"sasUri": {
@@ -143,7 +143,7 @@
"type": "object"
},
"sasToken": {
- "$ref": "../datafactory.json#/definitions/AzureKeyVaultSecretReference",
+ "$ref": "../artifacts.json#/definitions/AzureKeyVaultSecretReference",
"description": "The Azure key vault secret reference of sasToken in sas uri."
},
"serviceEndpoint": {
@@ -155,7 +155,7 @@
"description": "The ID of the service principal used to authenticate against Azure SQL Data Warehouse. Type: string (or Expression with resultType string)."
},
"servicePrincipalKey": {
- "$ref": "../datafactory.json#/definitions/SecretBase",
+ "$ref": "../artifacts.json#/definitions/SecretBase",
"description": "The key of the service principal used to authenticate against Azure SQL Data Warehouse."
},
"tenant": {
@@ -196,7 +196,7 @@
"type": "object"
},
"password": {
- "$ref": "../datafactory.json#/definitions/AzureKeyVaultSecretReference",
+ "$ref": "../artifacts.json#/definitions/AzureKeyVaultSecretReference",
"description": "The Azure key vault secret reference of password in connection string."
},
"servicePrincipalId": {
@@ -204,7 +204,7 @@
"description": "The ID of the service principal used to authenticate against Azure SQL Data Warehouse. Type: string (or Expression with resultType string)."
},
"servicePrincipalKey": {
- "$ref": "../datafactory.json#/definitions/SecretBase",
+ "$ref": "../artifacts.json#/definitions/SecretBase",
"description": "The key of the service principal used to authenticate against Azure SQL Data Warehouse."
},
"tenant": {
@@ -253,7 +253,7 @@
},
"password": {
"description": "The on-premises Windows authentication password.",
- "$ref": "../datafactory.json#/definitions/SecretBase"
+ "$ref": "../artifacts.json#/definitions/SecretBase"
},
"encryptedCredential": {
"type": "object",
@@ -292,7 +292,7 @@
"type": "object"
},
"password": {
- "$ref": "../datafactory.json#/definitions/AzureKeyVaultSecretReference",
+ "$ref": "../artifacts.json#/definitions/AzureKeyVaultSecretReference",
"description": "The Azure key vault secret reference of password in connection string."
},
"servicePrincipalId": {
@@ -300,7 +300,7 @@
"description": "The ID of the service principal used to authenticate against Azure SQL Database. Type: string (or Expression with resultType string)."
},
"servicePrincipalKey": {
- "$ref": "../datafactory.json#/definitions/SecretBase",
+ "$ref": "../artifacts.json#/definitions/SecretBase",
"description": "The key of the service principal used to authenticate against Azure SQL Database."
},
"tenant": {
@@ -344,7 +344,7 @@
"type": "object"
},
"password": {
- "$ref": "../datafactory.json#/definitions/AzureKeyVaultSecretReference",
+ "$ref": "../artifacts.json#/definitions/AzureKeyVaultSecretReference",
"description": "The Azure key vault secret reference of password in connection string."
},
"servicePrincipalId": {
@@ -352,7 +352,7 @@
"description": "The ID of the service principal used to authenticate against Azure SQL Managed Instance. Type: string (or Expression with resultType string)."
},
"servicePrincipalKey": {
- "$ref": "../datafactory.json#/definitions/SecretBase",
+ "$ref": "../artifacts.json#/definitions/SecretBase",
"description": "The key of the service principal used to authenticate against Azure SQL Managed Instance."
},
"tenant": {
@@ -397,7 +397,7 @@
},
"accessKey": {
"description": "The Azure Batch account access key.",
- "$ref": "../datafactory.json#/definitions/SecretBase"
+ "$ref": "../artifacts.json#/definitions/SecretBase"
},
"batchUri": {
"type": "object",
@@ -409,7 +409,7 @@
},
"linkedServiceName": {
"description": "The Azure Storage linked service reference.",
- "$ref": "../datafactory.json#/definitions/LinkedServiceReference"
+ "$ref": "../artifacts.json#/definitions/LinkedServiceReference"
},
"encryptedCredential": {
"type": "object",
@@ -491,7 +491,7 @@
"type": "object"
},
"accountKey": {
- "$ref": "../datafactory.json#/definitions/SecretBase",
+ "$ref": "../artifacts.json#/definitions/SecretBase",
"description": "The account key of the Azure CosmosDB account. Type: SecureString or AzureKeyVaultSecretReference."
},
"encryptedCredential": {
@@ -570,7 +570,7 @@
},
"password": {
"description": "Password to access the Dynamics instance.",
- "$ref": "../datafactory.json#/definitions/SecretBase"
+ "$ref": "../artifacts.json#/definitions/SecretBase"
},
"servicePrincipalId": {
"type": "object",
@@ -589,7 +589,7 @@
"description": "The service principal credential type to use in Server-To-Server authentication. 'ServicePrincipalKey' for key/secret, 'ServicePrincipalCert' for certificate. Type: string (or Expression with resultType string)."
},
"servicePrincipalCredential": {
- "$ref": "../datafactory.json#/definitions/SecretBase",
+ "$ref": "../artifacts.json#/definitions/SecretBase",
"description": "The credential of the service principal object in Azure Active Directory. If servicePrincipalCredentialType is 'ServicePrincipalKey', servicePrincipalCredential can be SecureString or AzureKeyVaultSecretReference. If servicePrincipalCredentialType is 'ServicePrincipalCert', servicePrincipalCredential can only be AzureKeyVaultSecretReference."
},
"encryptedCredential": {
@@ -672,7 +672,7 @@
},
"password": {
"description": "Password to access the Dynamics CRM instance.",
- "$ref": "../datafactory.json#/definitions/SecretBase"
+ "$ref": "../artifacts.json#/definitions/SecretBase"
},
"servicePrincipalId": {
"type": "object",
@@ -691,7 +691,7 @@
"description": "The service principal credential type to use in Server-To-Server authentication. 'ServicePrincipalKey' for key/secret, 'ServicePrincipalCert' for certificate. Type: string (or Expression with resultType string)."
},
"servicePrincipalCredential": {
- "$ref": "../datafactory.json#/definitions/SecretBase",
+ "$ref": "../artifacts.json#/definitions/SecretBase",
"description": "The credential of the service principal object in Azure Active Directory. If servicePrincipalCredentialType is 'ServicePrincipalKey', servicePrincipalCredential can be SecureString or AzureKeyVaultSecretReference. If servicePrincipalCredentialType is 'ServicePrincipalCert', servicePrincipalCredential can only be AzureKeyVaultSecretReference."
},
"encryptedCredential": {
@@ -774,7 +774,7 @@
},
"password": {
"description": "Password to access the Common Data Service for Apps instance.",
- "$ref": "../datafactory.json#/definitions/SecretBase"
+ "$ref": "../artifacts.json#/definitions/SecretBase"
},
"servicePrincipalId": {
"type": "object",
@@ -793,7 +793,7 @@
"description": "The service principal credential type to use in Server-To-Server authentication. 'ServicePrincipalKey' for key/secret, 'ServicePrincipalCert' for certificate. Type: string (or Expression with resultType string)."
},
"servicePrincipalCredential": {
- "$ref": "../datafactory.json#/definitions/SecretBase",
+ "$ref": "../artifacts.json#/definitions/SecretBase",
"description": "The credential of the service principal object in Azure Active Directory. If servicePrincipalCredentialType is 'ServicePrincipalKey', servicePrincipalCredential can be SecureString or AzureKeyVaultSecretReference. If servicePrincipalCredentialType is 'ServicePrincipalCert', servicePrincipalCredential can only be AzureKeyVaultSecretReference."
},
"encryptedCredential": {
@@ -839,15 +839,15 @@
},
"password": {
"description": "HDInsight cluster password.",
- "$ref": "../datafactory.json#/definitions/SecretBase"
+ "$ref": "../artifacts.json#/definitions/SecretBase"
},
"linkedServiceName": {
"description": "The Azure Storage linked service reference.",
- "$ref": "../datafactory.json#/definitions/LinkedServiceReference"
+ "$ref": "../artifacts.json#/definitions/LinkedServiceReference"
},
"hcatalogLinkedServiceName": {
"description": "A reference to the Azure SQL linked service that points to the HCatalog database.",
- "$ref": "../datafactory.json#/definitions/LinkedServiceReference"
+ "$ref": "../artifacts.json#/definitions/LinkedServiceReference"
},
"encryptedCredential": {
"type": "object",
@@ -899,7 +899,7 @@
},
"password": {
"description": "Password to logon the server.",
- "$ref": "../datafactory.json#/definitions/SecretBase"
+ "$ref": "../artifacts.json#/definitions/SecretBase"
},
"encryptedCredential": {
"type": "object",
@@ -943,7 +943,7 @@
},
"password": {
"description": "Password to logon the server.",
- "$ref": "../datafactory.json#/definitions/SecretBase"
+ "$ref": "../artifacts.json#/definitions/SecretBase"
},
"encryptedCredential": {
"type": "object",
@@ -983,7 +983,7 @@
},
"secretAccessKey": {
"description": "The secret access key of the Google Cloud Storage Identity and Access Management (IAM) user.",
- "$ref": "../datafactory.json#/definitions/SecretBase"
+ "$ref": "../artifacts.json#/definitions/SecretBase"
},
"serviceUrl": {
"type": "object",
@@ -1023,7 +1023,7 @@
"type": "object"
},
"password": {
- "$ref": "../datafactory.json#/definitions/AzureKeyVaultSecretReference",
+ "$ref": "../artifacts.json#/definitions/AzureKeyVaultSecretReference",
"description": "The Azure key vault secret reference of password in connection string."
},
"encryptedCredential": {
@@ -1063,7 +1063,7 @@
"type": "object"
},
"password": {
- "$ref": "../datafactory.json#/definitions/AzureKeyVaultSecretReference",
+ "$ref": "../artifacts.json#/definitions/AzureKeyVaultSecretReference",
"description": "The Azure key vault secret reference of password in connection string."
},
"encryptedCredential": {
@@ -1103,7 +1103,7 @@
"type": "object"
},
"password": {
- "$ref": "../datafactory.json#/definitions/AzureKeyVaultSecretReference",
+ "$ref": "../artifacts.json#/definitions/AzureKeyVaultSecretReference",
"description": "The Azure key vault secret reference of password in connection string."
},
"encryptedCredential": {
@@ -1143,7 +1143,7 @@
"type": "object"
},
"password": {
- "$ref": "../datafactory.json#/definitions/AzureKeyVaultSecretReference",
+ "$ref": "../artifacts.json#/definitions/AzureKeyVaultSecretReference",
"description": "The Azure key vault secret reference of password in connection string."
},
"encryptedCredential": {
@@ -1208,7 +1208,7 @@
},
"password": {
"description": "Password for authentication.",
- "$ref": "../datafactory.json#/definitions/SecretBase"
+ "$ref": "../artifacts.json#/definitions/SecretBase"
},
"encryptedCredential": {
"type": "object",
@@ -1268,7 +1268,7 @@
},
"password": {
"description": "Password for authentication.",
- "$ref": "../datafactory.json#/definitions/SecretBase"
+ "$ref": "../artifacts.json#/definitions/SecretBase"
},
"packageCollection": {
"type": "object",
@@ -1337,7 +1337,7 @@
},
"password": {
"description": "Password for authentication.",
- "$ref": "../datafactory.json#/definitions/SecretBase"
+ "$ref": "../artifacts.json#/definitions/SecretBase"
},
"encryptedCredential": {
"type": "object",
@@ -1374,7 +1374,7 @@
},
"apiKey": {
"description": "The API key for accessing the Azure ML model endpoint.",
- "$ref": "../datafactory.json#/definitions/SecretBase"
+ "$ref": "../artifacts.json#/definitions/SecretBase"
},
"updateResourceEndpoint": {
"type": "object",
@@ -1385,7 +1385,7 @@
"description": "The ID of the service principal used to authenticate against the ARM-based updateResourceEndpoint of an Azure ML Studio web service. Type: string (or Expression with resultType string)."
},
"servicePrincipalKey": {
- "$ref": "../datafactory.json#/definitions/SecretBase",
+ "$ref": "../artifacts.json#/definitions/SecretBase",
"description": "The key of the service principal used to authenticate against the ARM-based updateResourceEndpoint of an Azure ML Studio web service."
},
"tenant": {
@@ -1442,7 +1442,7 @@
"description": "The ID of the service principal used to authenticate against the endpoint of a published Azure ML Service pipeline. Type: string (or Expression with resultType string)."
},
"servicePrincipalKey": {
- "$ref": "../datafactory.json#/definitions/SecretBase",
+ "$ref": "../artifacts.json#/definitions/SecretBase",
"description": "The key of the service principal used to authenticate against the endpoint of a published Azure ML Service pipeline."
},
"tenant": {
@@ -1493,7 +1493,7 @@
},
"credential": {
"description": "The access credential portion of the connection string specified in driver-specific property-value format.",
- "$ref": "../datafactory.json#/definitions/SecretBase"
+ "$ref": "../artifacts.json#/definitions/SecretBase"
},
"userName": {
"type": "object",
@@ -1501,7 +1501,7 @@
},
"password": {
"description": "Password for Basic authentication.",
- "$ref": "../datafactory.json#/definitions/SecretBase"
+ "$ref": "../artifacts.json#/definitions/SecretBase"
},
"encryptedCredential": {
"type": "object",
@@ -1545,7 +1545,7 @@
},
"credential": {
"description": "The access credential portion of the connection string specified in driver-specific property-value format.",
- "$ref": "../datafactory.json#/definitions/SecretBase"
+ "$ref": "../artifacts.json#/definitions/SecretBase"
},
"userName": {
"type": "object",
@@ -1553,7 +1553,7 @@
},
"password": {
"description": "Password for Basic authentication.",
- "$ref": "../datafactory.json#/definitions/SecretBase"
+ "$ref": "../artifacts.json#/definitions/SecretBase"
},
"encryptedCredential": {
"type": "object",
@@ -1597,7 +1597,7 @@
},
"credential": {
"description": "The access credential portion of the connection string specified in driver-specific property-value format.",
- "$ref": "../datafactory.json#/definitions/SecretBase"
+ "$ref": "../artifacts.json#/definitions/SecretBase"
},
"userName": {
"type": "object",
@@ -1605,7 +1605,7 @@
},
"password": {
"description": "Password for Basic authentication.",
- "$ref": "../datafactory.json#/definitions/SecretBase"
+ "$ref": "../artifacts.json#/definitions/SecretBase"
},
"encryptedCredential": {
"type": "object",
@@ -1657,7 +1657,7 @@
},
"password": {
"description": "Password for Windows authentication.",
- "$ref": "../datafactory.json#/definitions/SecretBase"
+ "$ref": "../artifacts.json#/definitions/SecretBase"
}
},
"required": [
@@ -1712,7 +1712,7 @@
},
"password": {
"description": "Password of the OData service.",
- "$ref": "../datafactory.json#/definitions/SecretBase"
+ "$ref": "../artifacts.json#/definitions/SecretBase"
},
"tenant": {
"type": "object",
@@ -1740,15 +1740,15 @@
},
"servicePrincipalKey": {
"description": "Specify the secret of your application registered in Azure Active Directory. Type: string (or Expression with resultType string).",
- "$ref": "../datafactory.json#/definitions/SecretBase"
+ "$ref": "../artifacts.json#/definitions/SecretBase"
},
"servicePrincipalEmbeddedCert": {
"description": "Specify the base64 encoded certificate of your application registered in Azure Active Directory. Type: string (or Expression with resultType string).",
- "$ref": "../datafactory.json#/definitions/SecretBase"
+ "$ref": "../artifacts.json#/definitions/SecretBase"
},
"servicePrincipalEmbeddedCertPassword": {
"description": "Specify the password of your certificate if your certificate has a password and you are using AadServicePrincipal authentication. Type: string (or Expression with resultType string).",
- "$ref": "../datafactory.json#/definitions/SecretBase"
+ "$ref": "../artifacts.json#/definitions/SecretBase"
},
"encryptedCredential": {
"type": "object",
@@ -1830,7 +1830,7 @@
},
"password": {
"description": "The password for Basic authentication.",
- "$ref": "../datafactory.json#/definitions/SecretBase"
+ "$ref": "../artifacts.json#/definitions/SecretBase"
}
},
"required": [
@@ -1849,11 +1849,11 @@
"properties": {
"pfx": {
"description": "Base64-encoded contents of a PFX file.",
- "$ref": "../datafactory.json#/definitions/SecretBase"
+ "$ref": "../artifacts.json#/definitions/SecretBase"
},
"password": {
"description": "Password for the PFX file.",
- "$ref": "../datafactory.json#/definitions/SecretBase"
+ "$ref": "../artifacts.json#/definitions/SecretBase"
}
},
"required": [
@@ -1902,7 +1902,7 @@
},
"password": {
"description": "Password for authentication.",
- "$ref": "../datafactory.json#/definitions/SecretBase"
+ "$ref": "../artifacts.json#/definitions/SecretBase"
},
"encryptedCredential": {
"type": "object",
@@ -1962,7 +1962,7 @@
},
"password": {
"description": "Password for authentication.",
- "$ref": "../datafactory.json#/definitions/SecretBase"
+ "$ref": "../artifacts.json#/definitions/SecretBase"
},
"authSource": {
"type": "object",
@@ -2097,7 +2097,7 @@
},
"servicePrincipalKey": {
"description": "The Key of the application used to authenticate against the Azure Data Lake Store account.",
- "$ref": "../datafactory.json#/definitions/SecretBase"
+ "$ref": "../artifacts.json#/definitions/SecretBase"
},
"tenant": {
"type": "object",
@@ -2161,7 +2161,7 @@
},
"servicePrincipalKey": {
"description": "The Key of the application used to authenticate against the Azure Data Lake Storage Gen2 account.",
- "$ref": "../datafactory.json#/definitions/SecretBase"
+ "$ref": "../artifacts.json#/definitions/SecretBase"
},
"tenant": {
"type": "object",
@@ -2213,7 +2213,7 @@
},
"servicePrincipalKey": {
"description": "Specify the application's key.",
- "$ref": "../datafactory.json#/definitions/SecretBase"
+ "$ref": "../artifacts.json#/definitions/SecretBase"
},
"encryptedCredential": {
"type": "object",
@@ -2260,11 +2260,11 @@
},
"password": {
"description": "The password for Basic authentication of the Salesforce instance.",
- "$ref": "../datafactory.json#/definitions/SecretBase"
+ "$ref": "../artifacts.json#/definitions/SecretBase"
},
"securityToken": {
"description": "The security token is required to remotely access Salesforce instance.",
- "$ref": "../datafactory.json#/definitions/SecretBase"
+ "$ref": "../artifacts.json#/definitions/SecretBase"
},
"encryptedCredential": {
"type": "object",
@@ -2305,11 +2305,11 @@
},
"password": {
"description": "The password for Basic authentication of the Salesforce instance.",
- "$ref": "../datafactory.json#/definitions/SecretBase"
+ "$ref": "../artifacts.json#/definitions/SecretBase"
},
"securityToken": {
"description": "The security token is required to remotely access Salesforce instance.",
- "$ref": "../datafactory.json#/definitions/SecretBase"
+ "$ref": "../artifacts.json#/definitions/SecretBase"
},
"extendedProperties": {
"type": "object",
@@ -2354,7 +2354,7 @@
},
"password": {
"description": "The password for Basic authentication.",
- "$ref": "../datafactory.json#/definitions/SecretBase"
+ "$ref": "../artifacts.json#/definitions/SecretBase"
},
"encryptedCredential": {
"type": "object",
@@ -2398,7 +2398,7 @@
},
"password": {
"description": "The password for Basic authentication.",
- "$ref": "../datafactory.json#/definitions/SecretBase"
+ "$ref": "../artifacts.json#/definitions/SecretBase"
},
"encryptedCredential": {
"type": "string",
@@ -2454,7 +2454,7 @@
},
"password": {
"description": "Password to access the SAP BW server where the open hub destination is located.",
- "$ref": "../datafactory.json#/definitions/SecretBase"
+ "$ref": "../artifacts.json#/definitions/SecretBase"
},
"encryptedCredential": {
"type": "object",
@@ -2518,7 +2518,7 @@
},
"password": {
"description": "The password used in Basic authentication type.",
- "$ref": "../datafactory.json#/definitions/SecretBase"
+ "$ref": "../artifacts.json#/definitions/SecretBase"
},
"servicePrincipalId": {
"description": "The application's client ID used in AadServicePrincipal authentication type.",
@@ -2526,7 +2526,7 @@
},
"servicePrincipalKey": {
"description": "The application's key used in AadServicePrincipal authentication type.",
- "$ref": "../datafactory.json#/definitions/SecretBase"
+ "$ref": "../artifacts.json#/definitions/SecretBase"
},
"tenant": {
"description": "The tenant information (domain name or tenant ID) used in AadServicePrincipal authentication type under which your application resides.",
@@ -2575,7 +2575,7 @@
},
"secretAccessKey": {
"description": "The secret access key of the Amazon S3 Identity and Access Management (IAM) user.",
- "$ref": "../datafactory.json#/definitions/SecretBase"
+ "$ref": "../artifacts.json#/definitions/SecretBase"
},
"serviceUrl": {
"type": "object",
@@ -2620,7 +2620,7 @@
},
"password": {
"description": "The password of the Amazon Redshift source.",
- "$ref": "../datafactory.json#/definitions/SecretBase"
+ "$ref": "../artifacts.json#/definitions/SecretBase"
},
"database": {
"type": "object",
@@ -2689,7 +2689,7 @@
},
"key": {
"description": "Admin Key for Azure Search service",
- "$ref": "../datafactory.json#/definitions/SecretBase"
+ "$ref": "../artifacts.json#/definitions/SecretBase"
},
"encryptedCredential": {
"type": "object",
@@ -2748,7 +2748,7 @@
},
"password": {
"description": "Password for Basic, Digest, Windows, or ClientCertificate with EmbeddedCertData authentication.",
- "$ref": "../datafactory.json#/definitions/SecretBase"
+ "$ref": "../artifacts.json#/definitions/SecretBase"
},
"embeddedCertData": {
"type": "object",
@@ -2820,7 +2820,7 @@
},
"password": {
"description": "Password to logon the FTP server.",
- "$ref": "../datafactory.json#/definitions/SecretBase"
+ "$ref": "../artifacts.json#/definitions/SecretBase"
},
"encryptedCredential": {
"type": "object",
@@ -2888,7 +2888,7 @@
},
"password": {
"description": "Password to logon the SFTP server for Basic authentication.",
- "$ref": "../datafactory.json#/definitions/SecretBase"
+ "$ref": "../artifacts.json#/definitions/SecretBase"
},
"encryptedCredential": {
"type": "object",
@@ -2900,11 +2900,11 @@
},
"privateKeyContent": {
"description": "Base64 encoded SSH private key content for SshPublicKey authentication. For on-premises copy with SshPublicKey authentication, either PrivateKeyPath or PrivateKeyContent should be specified. SSH private key should be OpenSSH format.",
- "$ref": "../datafactory.json#/definitions/SecretBase"
+ "$ref": "../artifacts.json#/definitions/SecretBase"
},
"passPhrase": {
"description": "The password to decrypt the SSH private key if the SSH private key is encrypted.",
- "$ref": "../datafactory.json#/definitions/SecretBase"
+ "$ref": "../artifacts.json#/definitions/SecretBase"
},
"skipHostKeyValidation": {
"type": "object",
@@ -2960,7 +2960,7 @@
},
"password": {
"description": "Password to access the SAP BW server.",
- "$ref": "../datafactory.json#/definitions/SecretBase"
+ "$ref": "../artifacts.json#/definitions/SecretBase"
},
"encryptedCredential": {
"type": "object",
@@ -3022,7 +3022,7 @@
},
"password": {
"description": "Password to access the SAP HANA server.",
- "$ref": "../datafactory.json#/definitions/SecretBase"
+ "$ref": "../artifacts.json#/definitions/SecretBase"
},
"encryptedCredential": {
"type": "object",
@@ -3070,7 +3070,7 @@
},
"mwsAuthToken": {
"description": "The Amazon MWS authentication token.",
- "$ref": "../datafactory.json#/definitions/SecretBase"
+ "$ref": "../artifacts.json#/definitions/SecretBase"
},
"accessKeyId": {
"description": "The access key id used to access data.",
@@ -3078,7 +3078,7 @@
},
"secretKey": {
"description": "The secret key used to access data.",
- "$ref": "../datafactory.json#/definitions/SecretBase"
+ "$ref": "../artifacts.json#/definitions/SecretBase"
},
"useEncryptedEndpoints": {
"description": "Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.",
@@ -3132,7 +3132,7 @@
"type": "object"
},
"password": {
- "$ref": "../datafactory.json#/definitions/AzureKeyVaultSecretReference",
+ "$ref": "../artifacts.json#/definitions/AzureKeyVaultSecretReference",
"description": "The Azure key vault secret reference of password in connection string."
},
"encryptedCredential": {
@@ -3174,7 +3174,7 @@
},
"password": {
"description": "The password corresponding to the user name that you provided in the username field.",
- "$ref": "../datafactory.json#/definitions/SecretBase"
+ "$ref": "../artifacts.json#/definitions/SecretBase"
},
"useEncryptedEndpoints": {
"description": "Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.",
@@ -3226,7 +3226,7 @@
"type": "object"
},
"credString": {
- "$ref": "../datafactory.json#/definitions/AzureKeyVaultSecretReference",
+ "$ref": "../artifacts.json#/definitions/AzureKeyVaultSecretReference",
"description": "The Azure key vault secret reference of credString in connection string."
},
"encryptedCredential": {
@@ -3263,7 +3263,7 @@
"type": "object"
},
"pwd": {
- "$ref": "../datafactory.json#/definitions/AzureKeyVaultSecretReference",
+ "$ref": "../artifacts.json#/definitions/AzureKeyVaultSecretReference",
"description": "The Azure key vault secret reference of password in connection string."
},
"encryptedCredential": {
@@ -3305,7 +3305,7 @@
},
"password": {
"description": "The password corresponding to the user name.",
- "$ref": "../datafactory.json#/definitions/SecretBase"
+ "$ref": "../artifacts.json#/definitions/SecretBase"
},
"useEncryptedEndpoints": {
"description": "Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.",
@@ -3378,7 +3378,7 @@
},
"refreshToken": {
"description": "The refresh token obtained from Google for authorizing access to BigQuery for UserAuthentication.",
- "$ref": "../datafactory.json#/definitions/SecretBase"
+ "$ref": "../artifacts.json#/definitions/SecretBase"
},
"clientId": {
"description": "The client id of the google application used to acquire the refresh token. Type: string (or Expression with resultType string).",
@@ -3386,7 +3386,7 @@
},
"clientSecret": {
"description": "The client secret of the google application used to acquire the refresh token.",
- "$ref": "../datafactory.json#/definitions/SecretBase"
+ "$ref": "../artifacts.json#/definitions/SecretBase"
},
"email": {
"description": "The service account email ID that is used for ServiceAuthentication and can only be used on self-hosted IR.",
@@ -3442,7 +3442,7 @@
"type": "object"
},
"pwd": {
- "$ref": "../datafactory.json#/definitions/AzureKeyVaultSecretReference",
+ "$ref": "../artifacts.json#/definitions/AzureKeyVaultSecretReference",
"description": "The Azure key vault secret reference of password in connection string."
},
"encryptedCredential": {
@@ -3504,7 +3504,7 @@
},
"password": {
"description": "The password corresponding to the user name.",
- "$ref": "../datafactory.json#/definitions/SecretBase"
+ "$ref": "../artifacts.json#/definitions/SecretBase"
},
"enableSsl": {
"description": "Specifies whether the connections to the server are encrypted using SSL. The default value is false.",
@@ -3621,7 +3621,7 @@
},
"password": {
"description": "The password corresponding to the user name that you provided in the Username field",
- "$ref": "../datafactory.json#/definitions/SecretBase"
+ "$ref": "../artifacts.json#/definitions/SecretBase"
},
"httpPath": {
"description": "The partial URL corresponding to the Hive server.",
@@ -3686,15 +3686,15 @@
},
"clientSecret": {
"description": "The client secret associated with your Hubspot application.",
- "$ref": "../datafactory.json#/definitions/SecretBase"
+ "$ref": "../artifacts.json#/definitions/SecretBase"
},
"accessToken": {
"description": "The access token obtained when initially authenticating your OAuth integration.",
- "$ref": "../datafactory.json#/definitions/SecretBase"
+ "$ref": "../artifacts.json#/definitions/SecretBase"
},
"refreshToken": {
"description": "The refresh token obtained when initially authenticating your OAuth integration.",
- "$ref": "../datafactory.json#/definitions/SecretBase"
+ "$ref": "../artifacts.json#/definitions/SecretBase"
},
"useEncryptedEndpoints": {
"description": "Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.",
@@ -3767,7 +3767,7 @@
},
"password": {
"description": "The password corresponding to the user name when using UsernameAndPassword.",
- "$ref": "../datafactory.json#/definitions/SecretBase"
+ "$ref": "../artifacts.json#/definitions/SecretBase"
},
"enableSsl": {
"description": "Specifies whether the connections to the server are encrypted using SSL. The default value is false.",
@@ -3836,7 +3836,7 @@
},
"password": {
"description": "The password corresponding to the user name that you provided in the username field.",
- "$ref": "../datafactory.json#/definitions/SecretBase"
+ "$ref": "../artifacts.json#/definitions/SecretBase"
},
"useEncryptedEndpoints": {
"description": "Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.",
@@ -3889,7 +3889,7 @@
},
"accessToken": {
"description": "The access token from Magento.",
- "$ref": "../datafactory.json#/definitions/SecretBase"
+ "$ref": "../artifacts.json#/definitions/SecretBase"
},
"useEncryptedEndpoints": {
"description": "Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.",
@@ -3940,7 +3940,7 @@
"type": "object"
},
"pwd": {
- "$ref": "../datafactory.json#/definitions/AzureKeyVaultSecretReference",
+ "$ref": "../artifacts.json#/definitions/AzureKeyVaultSecretReference",
"description": "The Azure key vault secret reference of password in connection string."
},
"encryptedCredential": {
@@ -3977,7 +3977,7 @@
"type": "object"
},
"pwd": {
- "$ref": "../datafactory.json#/definitions/AzureKeyVaultSecretReference",
+ "$ref": "../artifacts.json#/definitions/AzureKeyVaultSecretReference",
"description": "The Azure key vault secret reference of password in connection string."
},
"encryptedCredential": {
@@ -4019,7 +4019,7 @@
},
"clientSecret": {
"description": "The client secret of your Marketo service.",
- "$ref": "../datafactory.json#/definitions/SecretBase"
+ "$ref": "../artifacts.json#/definitions/SecretBase"
},
"useEncryptedEndpoints": {
"description": "Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.",
@@ -4076,7 +4076,7 @@
},
"clientSecret": {
"description": "The client secret associated with your PayPal application.",
- "$ref": "../datafactory.json#/definitions/SecretBase"
+ "$ref": "../artifacts.json#/definitions/SecretBase"
},
"useEncryptedEndpoints": {
"description": "Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.",
@@ -4154,7 +4154,7 @@
},
"password": {
"description": "The password corresponding to the user name.",
- "$ref": "../datafactory.json#/definitions/SecretBase"
+ "$ref": "../artifacts.json#/definitions/SecretBase"
},
"enableSsl": {
"description": "Specifies whether the connections to the server are encrypted using SSL. The default value is false.",
@@ -4243,7 +4243,7 @@
},
"password": {
"description": "The password corresponding to the user name.",
- "$ref": "../datafactory.json#/definitions/SecretBase"
+ "$ref": "../artifacts.json#/definitions/SecretBase"
},
"enableSsl": {
"description": "Specifies whether the connections to the server are encrypted using SSL. The default value is false.",
@@ -4318,15 +4318,15 @@
},
"consumerSecret": {
"description": "The consumer secret for OAuth 1.0 authentication.",
- "$ref": "../datafactory.json#/definitions/SecretBase"
+ "$ref": "../artifacts.json#/definitions/SecretBase"
},
"accessToken": {
"description": "The access token for OAuth 1.0 authentication.",
- "$ref": "../datafactory.json#/definitions/SecretBase"
+ "$ref": "../artifacts.json#/definitions/SecretBase"
},
"accessTokenSecret": {
"description": "The access token secret for OAuth 1.0 authentication.",
- "$ref": "../datafactory.json#/definitions/SecretBase"
+ "$ref": "../artifacts.json#/definitions/SecretBase"
},
"useEncryptedEndpoints": {
"description": "Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.",
@@ -4391,7 +4391,7 @@
},
"password": {
"description": "The password corresponding to the user name for Basic and OAuth2 authentication.",
- "$ref": "../datafactory.json#/definitions/SecretBase"
+ "$ref": "../artifacts.json#/definitions/SecretBase"
},
"clientId": {
"description": "The client id for OAuth2 authentication.",
@@ -4399,7 +4399,7 @@
},
"clientSecret": {
"description": "The client secret for OAuth2 authentication.",
- "$ref": "../datafactory.json#/definitions/SecretBase"
+ "$ref": "../artifacts.json#/definitions/SecretBase"
},
"useEncryptedEndpoints": {
"description": "Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.",
@@ -4452,7 +4452,7 @@
},
"accessToken": {
"description": "The API access token that can be used to access Shopify’s data. The token won't expire if it is offline mode.",
- "$ref": "../datafactory.json#/definitions/SecretBase"
+ "$ref": "../artifacts.json#/definitions/SecretBase"
},
"useEncryptedEndpoints": {
"description": "Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.",
@@ -4552,7 +4552,7 @@
},
"password": {
"description": "The password corresponding to the user name that you provided in the Username field",
- "$ref": "../datafactory.json#/definitions/SecretBase"
+ "$ref": "../artifacts.json#/definitions/SecretBase"
},
"httpPath": {
"description": "The partial URL corresponding to the Spark server.",
@@ -4622,7 +4622,7 @@
},
"clientSecret": {
"description": "The client secret associated with your Square application.",
- "$ref": "../datafactory.json#/definitions/SecretBase"
+ "$ref": "../artifacts.json#/definitions/SecretBase"
},
"redirectUri": {
"description": "The redirect URL assigned in the Square application dashboard. (i.e. http://localhost:2500)",
@@ -4680,11 +4680,11 @@
},
"consumerKey": {
"description": "The consumer key associated with the Xero application.",
- "$ref": "../datafactory.json#/definitions/SecretBase"
+ "$ref": "../artifacts.json#/definitions/SecretBase"
},
"privateKey": {
"description": "The private key from the .pem file that was generated for your Xero private application. You must include all the text from the .pem file, including the Unix line endings(\n).",
- "$ref": "../datafactory.json#/definitions/SecretBase"
+ "$ref": "../artifacts.json#/definitions/SecretBase"
},
"useEncryptedEndpoints": {
"description": "Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.",
@@ -4736,7 +4736,7 @@
},
"accessToken": {
"description": "The access token for Zoho authentication.",
- "$ref": "../datafactory.json#/definitions/SecretBase"
+ "$ref": "../artifacts.json#/definitions/SecretBase"
},
"useEncryptedEndpoints": {
"description": "Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.",
@@ -4787,7 +4787,7 @@
"type": "object"
},
"pwd": {
- "$ref": "../datafactory.json#/definitions/AzureKeyVaultSecretReference",
+ "$ref": "../artifacts.json#/definitions/AzureKeyVaultSecretReference",
"description": "The Azure key vault secret reference of password in connection string."
},
"encryptedCredential": {
@@ -4824,7 +4824,7 @@
"type": "object"
},
"pwd": {
- "$ref": "../datafactory.json#/definitions/AzureKeyVaultSecretReference",
+ "$ref": "../artifacts.json#/definitions/AzureKeyVaultSecretReference",
"description": "The Azure key vault secret reference of password in connection string."
},
"encryptedCredential": {
@@ -4862,7 +4862,7 @@
},
"clientSecret": {
"description": "The client secret associated with the Salesforce Marketing Cloud application. Type: string (or Expression with resultType string).",
- "$ref": "../datafactory.json#/definitions/SecretBase"
+ "$ref": "../artifacts.json#/definitions/SecretBase"
},
"useEncryptedEndpoints": {
"description": "Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true. Type: boolean (or Expression with resultType boolean).",
@@ -4922,7 +4922,7 @@
},
"linkedServiceName": {
"description": "Azure Storage linked service to be used by the on-demand cluster for storing and processing data.",
- "$ref": "../datafactory.json#/definitions/LinkedServiceReference"
+ "$ref": "../artifacts.json#/definitions/LinkedServiceReference"
},
"hostSubscriptionId": {
"type": "object",
@@ -4934,7 +4934,7 @@
},
"servicePrincipalKey": {
"description": "The key for the service principal id.",
- "$ref": "../datafactory.json#/definitions/SecretBase"
+ "$ref": "../artifacts.json#/definitions/SecretBase"
},
"tenant": {
"type": "object",
@@ -4954,7 +4954,7 @@
},
"clusterPassword": {
"description": "The password to access the cluster.",
- "$ref": "../datafactory.json#/definitions/SecretBase"
+ "$ref": "../artifacts.json#/definitions/SecretBase"
},
"clusterSshUserName": {
"type": "object",
@@ -4962,18 +4962,18 @@
},
"clusterSshPassword": {
"description": "The password to SSH remotely connect cluster’s node (for Linux).",
- "$ref": "../datafactory.json#/definitions/SecretBase"
+ "$ref": "../artifacts.json#/definitions/SecretBase"
},
"additionalLinkedServiceNames": {
"description": "Specifies additional storage accounts for the HDInsight linked service so that the Data Factory service can register them on your behalf.",
"type": "array",
"items": {
- "$ref": "../datafactory.json#/definitions/LinkedServiceReference"
+ "$ref": "../artifacts.json#/definitions/LinkedServiceReference"
}
},
"hcatalogLinkedServiceName": {
"description": "The name of Azure SQL linked service that point to the HCatalog database. The on-demand HDInsight cluster is created by using the Azure SQL database as the metastore.",
- "$ref": "../datafactory.json#/definitions/LinkedServiceReference"
+ "$ref": "../artifacts.json#/definitions/LinkedServiceReference"
},
"clusterType": {
"type": "object",
@@ -5126,7 +5126,7 @@
},
"servicePrincipalKey": {
"description": "The Key of the application used to authenticate against the Azure Data Lake Analytics account.",
- "$ref": "../datafactory.json#/definitions/SecretBase"
+ "$ref": "../artifacts.json#/definitions/SecretBase"
},
"tenant": {
"type": "object",
@@ -5183,7 +5183,7 @@
},
"accessToken": {
"description": "Access token for databricks REST API. Refer to https://docs.azuredatabricks.net/api/latest/authentication.html. Type: string (or Expression with resultType string).",
- "$ref": "../datafactory.json#/definitions/SecretBase"
+ "$ref": "../artifacts.json#/definitions/SecretBase"
},
"existingClusterId": {
"type": "object",
@@ -5284,7 +5284,7 @@
},
"clientSecret": {
"description": "The client secret associated with the Responsys application. Type: string (or Expression with resultType string).",
- "$ref": "../datafactory.json#/definitions/SecretBase"
+ "$ref": "../artifacts.json#/definitions/SecretBase"
},
"useEncryptedEndpoints": {
"description": "Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true. Type: boolean (or Expression with resultType boolean).",
@@ -5341,7 +5341,7 @@
},
"servicePrincipalKey": {
"description": "Specify the application's key. Mark this field as a SecureString to store it securely in Data Factory, or reference a secret stored in Azure Key Vault. Type: string (or Expression with resultType string).",
- "$ref": "../datafactory.json#/definitions/SecretBase"
+ "$ref": "../artifacts.json#/definitions/SecretBase"
},
"tenant": {
"description": "Specify the tenant information (domain name or tenant ID) under which your application resides. Retrieve it by hovering the mouse in the top-right corner of the Azure portal. Type: string (or Expression with resultType string).",
@@ -5397,7 +5397,7 @@
},
"password": {
"description": "The password corresponding to the user name that you provided in the username key.",
- "$ref": "../datafactory.json#/definitions/SecretBase"
+ "$ref": "../artifacts.json#/definitions/SecretBase"
},
"useEncryptedEndpoints": {
"description": "Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true. Type: boolean (or Expression with resultType boolean).",
@@ -5451,7 +5451,7 @@
},
"developerToken": {
"description": "The developer token associated with the manager account that you use to grant access to the AdWords API.",
- "$ref": "../datafactory.json#/definitions/SecretBase"
+ "$ref": "../artifacts.json#/definitions/SecretBase"
},
"authenticationType": {
"description": "The OAuth 2.0 authentication mechanism used for authentication. ServiceAuthentication can only be used on self-hosted IR.",
@@ -5467,7 +5467,7 @@
},
"refreshToken": {
"description": "The refresh token obtained from Google for authorizing access to AdWords for UserAuthentication.",
- "$ref": "../datafactory.json#/definitions/SecretBase"
+ "$ref": "../artifacts.json#/definitions/SecretBase"
},
"clientId": {
"description": "The client id of the google application used to acquire the refresh token. Type: string (or Expression with resultType string).",
@@ -5475,7 +5475,7 @@
},
"clientSecret": {
"description": "The client secret of the google application used to acquire the refresh token.",
- "$ref": "../datafactory.json#/definitions/SecretBase"
+ "$ref": "../artifacts.json#/definitions/SecretBase"
},
"email": {
"description": "The service account email ID that is used for ServiceAuthentication and can only be used on self-hosted IR.",
@@ -5553,7 +5553,7 @@
},
"password": {
"description": "Password to access the SAP server where the table is located.",
- "$ref": "../datafactory.json#/definitions/SecretBase"
+ "$ref": "../artifacts.json#/definitions/SecretBase"
},
"messageServer": {
"type": "object",
@@ -5625,7 +5625,7 @@
"description": "The ID of the service principal used to authenticate against Azure Data Explorer. Type: string (or Expression with resultType string)."
},
"servicePrincipalKey": {
- "$ref": "../datafactory.json#/definitions/SecretBase",
+ "$ref": "../artifacts.json#/definitions/SecretBase",
"description": "The key of the service principal used to authenticate against Kusto."
},
"database": {
@@ -5674,7 +5674,7 @@
},
"functionKey": {
"description": "Function or Host key for Azure Function App.",
- "$ref": "../datafactory.json#/definitions/SecretBase"
+ "$ref": "../artifacts.json#/definitions/SecretBase"
},
"encryptedCredential": {
"description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).",
diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/entityTypes/NoteBook.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/entityTypes/Notebook.json
similarity index 98%
rename from specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/entityTypes/NoteBook.json
rename to specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/entityTypes/Notebook.json
index 1958284c390e..9035e958e8b9 100644
--- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/entityTypes/NoteBook.json
+++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/entityTypes/Notebook.json
@@ -1,12 +1,12 @@
{
"swagger": "2.0",
"info": {
- "title": "SynapseClient",
- "version": "2019-11-01-preview"
+ "title": "ArtifactsClient",
+ "version": "2019-06-01-preview"
},
"paths": {},
"definitions": {
- "NoteBook": {
+ "Notebook": {
"description": "Notebook.",
"type": "object",
"properties": {
diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/entityTypes/Pipeline.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/entityTypes/Pipeline.json
similarity index 98%
rename from specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/entityTypes/Pipeline.json
rename to specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/entityTypes/Pipeline.json
index a2f4d1c618bb..2f1930156943 100644
--- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/entityTypes/Pipeline.json
+++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/entityTypes/Pipeline.json
@@ -1,8 +1,8 @@
{
"swagger": "2.0",
"info": {
- "title": "SynapseClient",
- "version": "2019-11-01-preview"
+ "title": "ArtifactsClient",
+ "version": "2019-06-01-preview"
},
"paths": {},
"definitions": {
@@ -22,11 +22,11 @@
}
},
"parameters": {
- "$ref": "../datafactory.json#/definitions/ParameterDefinitionSpecification",
+ "$ref": "../artifacts.json#/definitions/ParameterDefinitionSpecification",
"description": "List of parameters for pipeline."
},
"variables": {
- "$ref": "../datafactory.json#/definitions/VariableDefinitionSpecification",
+ "$ref": "../artifacts.json#/definitions/VariableDefinitionSpecification",
"description": "List of variables for pipeline."
},
"concurrency": {
@@ -174,7 +174,7 @@
"properties": {
"linkedServiceName": {
"description": "Linked service reference.",
- "$ref": "../datafactory.json#/definitions/LinkedServiceReference"
+ "$ref": "../artifacts.json#/definitions/LinkedServiceReference"
},
"policy": {
"$ref": "#/definitions/ActivityPolicy",
@@ -966,14 +966,14 @@
"type": "array",
"description": "List of inputs for the activity.",
"items": {
- "$ref": "../datafactory.json#/definitions/DatasetReference"
+ "$ref": "../artifacts.json#/definitions/DatasetReference"
}
},
"outputs": {
"type": "array",
"description": "List of outputs for the activity.",
"items": {
- "$ref": "../datafactory.json#/definitions/DatasetReference"
+ "$ref": "../artifacts.json#/definitions/DatasetReference"
}
}
},
@@ -2820,7 +2820,7 @@
"properties": {
"s3LinkedServiceName": {
"description": "The name of the Amazon S3 linked service which will be used for the unload operation when copying from the Amazon Redshift source.",
- "$ref": "../datafactory.json#/definitions/LinkedServiceReference"
+ "$ref": "../artifacts.json#/definitions/LinkedServiceReference"
},
"bucketName": {
"type": "object",
@@ -3362,7 +3362,7 @@
"properties": {
"linkedServiceName": {
"description": "Log storage linked service reference.",
- "$ref": "../datafactory.json#/definitions/LinkedServiceReference"
+ "$ref": "../artifacts.json#/definitions/LinkedServiceReference"
},
"path": {
"type": "object",
@@ -3382,7 +3382,7 @@
"properties": {
"linkedServiceName": {
"description": "Staging linked service reference.",
- "$ref": "../datafactory.json#/definitions/LinkedServiceReference"
+ "$ref": "../artifacts.json#/definitions/LinkedServiceReference"
},
"path": {
"type": "object",
@@ -3810,7 +3810,7 @@
"description": "Storage linked service references.",
"type": "array",
"items": {
- "$ref": "../datafactory.json#/definitions/LinkedServiceReference"
+ "$ref": "../artifacts.json#/definitions/LinkedServiceReference"
}
},
"arguments": {
@@ -3831,7 +3831,7 @@
},
"scriptLinkedService": {
"description": "Script linked service reference.",
- "$ref": "../datafactory.json#/definitions/LinkedServiceReference"
+ "$ref": "../artifacts.json#/definitions/LinkedServiceReference"
},
"defines": {
"description": "Allows user to specify defines for Hive job request.",
@@ -3894,7 +3894,7 @@
"description": "Storage linked service references.",
"type": "array",
"items": {
- "$ref": "../datafactory.json#/definitions/LinkedServiceReference"
+ "$ref": "../artifacts.json#/definitions/LinkedServiceReference"
}
},
"arguments": {
@@ -3911,7 +3911,7 @@
},
"scriptLinkedService": {
"description": "Script linked service reference.",
- "$ref": "../datafactory.json#/definitions/LinkedServiceReference"
+ "$ref": "../artifacts.json#/definitions/LinkedServiceReference"
},
"defines": {
"description": "Allows user to specify defines for Pig job request.",
@@ -3949,7 +3949,7 @@
"description": "Storage linked service references.",
"type": "array",
"items": {
- "$ref": "../datafactory.json#/definitions/LinkedServiceReference"
+ "$ref": "../artifacts.json#/definitions/LinkedServiceReference"
}
},
"arguments": {
@@ -3974,7 +3974,7 @@
},
"jarLinkedService": {
"description": "Jar linked service reference.",
- "$ref": "../datafactory.json#/definitions/LinkedServiceReference"
+ "$ref": "../artifacts.json#/definitions/LinkedServiceReference"
},
"jarLibs": {
"description": "Jar libs.",
@@ -4024,7 +4024,7 @@
"description": "Storage linked service references.",
"type": "array",
"items": {
- "$ref": "../datafactory.json#/definitions/LinkedServiceReference"
+ "$ref": "../artifacts.json#/definitions/LinkedServiceReference"
}
},
"arguments": {
@@ -4065,7 +4065,7 @@
},
"fileLinkedService": {
"description": "Linked service reference where the files are located.",
- "$ref": "../datafactory.json#/definitions/LinkedServiceReference"
+ "$ref": "../artifacts.json#/definitions/LinkedServiceReference"
},
"combiner": {
"type": "object",
@@ -4140,7 +4140,7 @@
},
"sparkJobLinkedService": {
"description": "The storage linked service for uploading the entry file and dependencies, and for receiving logs.",
- "$ref": "../datafactory.json#/definitions/LinkedServiceReference"
+ "$ref": "../artifacts.json#/definitions/LinkedServiceReference"
},
"className": {
"description": "The application's Java/Spark main class.",
@@ -4208,7 +4208,7 @@
},
"connectVia": {
"description": "The integration runtime reference.",
- "$ref": "../datafactory.json#/definitions/IntegrationRuntimeReference"
+ "$ref": "../artifacts.json#/definitions/IntegrationRuntimeReference"
},
"projectParameters": {
"description": "The project level parameters to execute the SSIS package.",
@@ -4288,7 +4288,7 @@
"type": "object",
"properties": {
"packagePassword": {
- "$ref": "../datafactory.json#/definitions/SecretBase",
+ "$ref": "../artifacts.json#/definitions/SecretBase",
"description": "Password of the package."
},
"accessCredential": {
@@ -4370,7 +4370,7 @@
"description": "UseName for windows authentication."
},
"password": {
- "$ref": "../datafactory.json#/definitions/SecureString",
+ "$ref": "../artifacts.json#/definitions/SecureString",
"description": "Password for windows authentication."
}
},
@@ -4393,7 +4393,7 @@
"description": "UseName for windows authentication."
},
"password": {
- "$ref": "../datafactory.json#/definitions/SecretBase",
+ "$ref": "../artifacts.json#/definitions/SecretBase",
"description": "Password for windows authentication."
}
},
@@ -4502,7 +4502,7 @@
},
"resourceLinkedService": {
"description": "Resource linked service reference.",
- "$ref": "../datafactory.json#/definitions/LinkedServiceReference"
+ "$ref": "../artifacts.json#/definitions/LinkedServiceReference"
},
"folderPath": {
"type": "object",
@@ -4536,14 +4536,14 @@
"description": "Linked service references.",
"type": "array",
"items": {
- "$ref": "../datafactory.json#/definitions/LinkedServiceReference"
+ "$ref": "../artifacts.json#/definitions/LinkedServiceReference"
}
},
"datasets": {
"description": "Dataset references.",
"type": "array",
"items": {
- "$ref": "../datafactory.json#/definitions/DatasetReference"
+ "$ref": "../artifacts.json#/definitions/DatasetReference"
}
}
}
@@ -4611,11 +4611,11 @@
"properties": {
"pipeline": {
"description": "Pipeline reference.",
- "$ref": "../datafactory.json#/definitions/PipelineReference"
+ "$ref": "../artifacts.json#/definitions/PipelineReference"
},
"parameters": {
"description": "Pipeline parameters.",
- "$ref": "../datafactory.json#/definitions/ParameterValueSpecification"
+ "$ref": "../artifacts.json#/definitions/ParameterValueSpecification"
},
"waitOnCompletion": {
"description": "Defines whether activity execution will wait for the dependent pipeline execution to finish. Default is false.",
@@ -4667,7 +4667,7 @@
},
"dataset": {
"description": "Delete activity dataset reference.",
- "$ref": "../datafactory.json#/definitions/DatasetReference"
+ "$ref": "../artifacts.json#/definitions/DatasetReference"
}
},
"required": [
@@ -4737,7 +4737,7 @@
},
"dataset": {
"description": "Lookup activity dataset reference.",
- "$ref": "../datafactory.json#/definitions/DatasetReference"
+ "$ref": "../artifacts.json#/definitions/DatasetReference"
},
"firstRowOnly": {
"type": "object",
@@ -4791,7 +4791,7 @@
},
"pfx": {
"description": "Base64-encoded contents of a PFX file.",
- "$ref": "../datafactory.json#/definitions/SecretBase"
+ "$ref": "../artifacts.json#/definitions/SecretBase"
},
"username": {
"description": "Web activity authentication user name for basic authentication.",
@@ -4799,7 +4799,7 @@
},
"password": {
"description": "Password for the PFX file or basic authentication.",
- "$ref": "../datafactory.json#/definitions/SecretBase"
+ "$ref": "../artifacts.json#/definitions/SecretBase"
},
"resource": {
"description": "Resource for which Azure Auth token will be requested when using MSI Authentication.",
@@ -4837,19 +4837,19 @@
"type": "array",
"description": "List of datasets passed to web endpoint.",
"items": {
- "$ref": "../datafactory.json#/definitions/DatasetReference"
+ "$ref": "../artifacts.json#/definitions/DatasetReference"
}
},
"linkedServices": {
"type": "array",
"description": "List of linked services passed to web endpoint.",
"items": {
- "$ref": "../datafactory.json#/definitions/LinkedServiceReference"
+ "$ref": "../artifacts.json#/definitions/LinkedServiceReference"
}
},
"connectVia": {
"description": "The integration runtime reference.",
- "$ref": "../datafactory.json#/definitions/IntegrationRuntimeReference"
+ "$ref": "../artifacts.json#/definitions/IntegrationRuntimeReference"
}
},
"required": [
@@ -4881,7 +4881,7 @@
"properties": {
"dataset": {
"description": "GetMetadata activity dataset reference.",
- "$ref": "../datafactory.json#/definitions/DatasetReference"
+ "$ref": "../artifacts.json#/definitions/DatasetReference"
},
"fieldList": {
"description": "Fields of metadata to get from dataset.",
@@ -4920,7 +4920,7 @@
"properties": {
"expression": {
"description": "An expression that would evaluate to Boolean. This is used to determine the block of activities (ifTrueActivities or ifFalseActivities) that will be executed.",
- "$ref": "../datafactory.json#/definitions/Expression"
+ "$ref": "../artifacts.json#/definitions/Expression"
},
"ifTrueActivities": {
"type": "array",
@@ -4965,7 +4965,7 @@
"properties": {
"on": {
"description": "An expression that would evaluate to a string or integer. This is used to determine the block of activities in cases that will be executed.",
- "$ref": "../datafactory.json#/definitions/Expression"
+ "$ref": "../artifacts.json#/definitions/Expression"
},
"cases": {
"type": "array",
@@ -5036,7 +5036,7 @@
},
"items": {
"description": "Collection to iterate.",
- "$ref": "../datafactory.json#/definitions/Expression"
+ "$ref": "../artifacts.json#/definitions/Expression"
},
"activities": {
"type": "array",
@@ -5107,7 +5107,7 @@
},
"linkedServiceName": {
"description": "Reference to an Azure Storage LinkedService, where Azure ML WebService Input/Output file located.",
- "$ref": "../datafactory.json#/definitions/LinkedServiceReference"
+ "$ref": "../artifacts.json#/definitions/LinkedServiceReference"
}
},
"required": [
@@ -5143,7 +5143,7 @@
},
"trainedModelLinkedServiceName": {
"description": "Name of Azure Storage linked service holding the .ilearner file that will be uploaded by the update operation.",
- "$ref": "../datafactory.json#/definitions/LinkedServiceReference"
+ "$ref": "../artifacts.json#/definitions/LinkedServiceReference"
},
"trainedModelFilePath": {
"type": "object",
@@ -5239,7 +5239,7 @@
},
"scriptLinkedService": {
"description": "Script linked service reference.",
- "$ref": "../datafactory.json#/definitions/LinkedServiceReference"
+ "$ref": "../artifacts.json#/definitions/LinkedServiceReference"
},
"degreeOfParallelism": {
"type": "object",
@@ -5326,7 +5326,7 @@
"properties": {
"expression": {
"description": "An expression that would evaluate to Boolean. The loop will continue until this expression evaluates to true",
- "$ref": "../datafactory.json#/definitions/Expression"
+ "$ref": "../artifacts.json#/definitions/Expression"
},
"timeout": {
"type": "object",
@@ -5385,7 +5385,7 @@
},
"dataset": {
"description": "Validation activity dataset reference.",
- "$ref": "../datafactory.json#/definitions/DatasetReference"
+ "$ref": "../artifacts.json#/definitions/DatasetReference"
}
},
"required": [
@@ -5416,11 +5416,11 @@
"properties": {
"items": {
"description": "Input array on which filter should be applied.",
- "$ref": "../datafactory.json#/definitions/Expression"
+ "$ref": "../artifacts.json#/definitions/Expression"
},
"condition": {
"description": "Condition to be used for filtering the input.",
- "$ref": "../datafactory.json#/definitions/Expression"
+ "$ref": "../artifacts.json#/definitions/Expression"
}
},
"required": [
@@ -5448,7 +5448,7 @@
]
},
"DatabricksNotebookActivityTypeProperties": {
- "description": "Databricks Notebook activity properties.",
+ "description": "Databricks notebook activity properties.",
"properties": {
"notebookPath": {
"type": "object",
@@ -5794,15 +5794,15 @@
"properties": {
"dataFlow": {
"description": "Data flow reference.",
- "$ref": "../datafactory.json#/definitions/DataFlowReference"
+ "$ref": "../artifacts.json#/definitions/DataFlowReference"
},
"staging": {
"description": "Staging info for execute data flow activity.",
- "$ref": "../datafactory.json#/definitions/DataFlowStagingInfo"
+ "$ref": "../artifacts.json#/definitions/DataFlowStagingInfo"
},
"integrationRuntime": {
"description": "The integration runtime reference.",
- "$ref": "../datafactory.json#/definitions/IntegrationRuntimeReference"
+ "$ref": "../artifacts.json#/definitions/IntegrationRuntimeReference"
},
"compute": {
"description": "Compute properties for data flow activity.",
diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/entityTypes/SparkJobDefinition.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/entityTypes/SparkJobDefinition.json
similarity index 96%
rename from specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/entityTypes/SparkJobDefinition.json
rename to specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/entityTypes/SparkJobDefinition.json
index 87caabcdaced..32c5484c99cd 100644
--- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/entityTypes/SparkJobDefinition.json
+++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/entityTypes/SparkJobDefinition.json
@@ -1,8 +1,8 @@
{
"swagger": "2.0",
"info": {
- "title": "SynapseClient",
- "version": "2019-11-01-preview"
+ "title": "ArtifactsClient",
+ "version": "2019-06-01-preview"
},
"paths": {},
"definitions": {
@@ -16,7 +16,7 @@
},
"targetBigDataPool": {
"description": "Big data pool reference.",
- "$ref": "./NoteBook.json#/definitions/BigDataPoolReference"
+ "$ref": "./Notebook.json#/definitions/BigDataPoolReference"
},
"requiredSparkVersion": {
"description": "The required Spark version of the application.",
diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/entityTypes/SqlScript.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/entityTypes/SqlScript.json
similarity index 97%
rename from specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/entityTypes/SqlScript.json
rename to specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/entityTypes/SqlScript.json
index ba7c44589f83..ab23bc7f45ff 100644
--- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/entityTypes/SqlScript.json
+++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/entityTypes/SqlScript.json
@@ -1,8 +1,8 @@
{
"swagger": "2.0",
"info": {
- "title": "SynapseClient",
- "version": "2019-11-01-preview"
+ "title": "ArtifactsClient",
+ "version": "2019-06-01-preview"
},
"paths": {},
"definitions": {
diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/entityTypes/Trigger.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/entityTypes/Trigger.json
similarity index 97%
rename from specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/entityTypes/Trigger.json
rename to specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/entityTypes/Trigger.json
index f8f4ac9763e2..37376429432c 100644
--- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/entityTypes/Trigger.json
+++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/entityTypes/Trigger.json
@@ -1,8 +1,8 @@
{
"swagger": "2.0",
"info": {
- "title": "SynapseClient",
- "version": "2019-11-01-preview"
+ "title": "ArtifactsClient",
+ "version": "2019-06-01-preview"
},
"paths": {},
"definitions": {
@@ -64,7 +64,7 @@
"pipelines": {
"type": "array",
"items": {
- "$ref": "../datafactory.json#/definitions/TriggerPipelineReference"
+ "$ref": "../artifacts.json#/definitions/TriggerPipelineReference"
},
"description": "Pipelines that need to be started."
}
@@ -268,7 +268,7 @@
},
"linkedService": {
"description": "The Azure Storage linked service reference.",
- "$ref": "../datafactory.json#/definitions/LinkedServiceReference"
+ "$ref": "../artifacts.json#/definitions/LinkedServiceReference"
}
},
"required": [
@@ -351,7 +351,7 @@
],
"properties": {
"pipeline": {
- "$ref": "../datafactory.json#/definitions/TriggerPipelineReference",
+ "$ref": "../artifacts.json#/definitions/TriggerPipelineReference",
"description": "Pipeline for which runs are created when an event is fired for trigger window that is ready."
},
"typeProperties": {
@@ -604,7 +604,7 @@
],
"properties": {
"pipeline": {
- "$ref": "../datafactory.json#/definitions/TriggerPipelineReference",
+ "$ref": "../artifacts.json#/definitions/TriggerPipelineReference",
"description": "Pipeline for which runs are created when all upstream pipelines complete successfully."
},
"typeProperties": {
@@ -614,7 +614,7 @@
"dependsOn": {
"type": "array",
"items": {
- "$ref": "../datafactory.json#/definitions/PipelineReference"
+ "$ref": "../artifacts.json#/definitions/PipelineReference"
},
"description": "Upstream Pipelines."
},
diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/ActivityRuns_QueryByPipelineRun.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/ActivityRuns_QueryByPipelineRun.json
similarity index 96%
rename from specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/ActivityRuns_QueryByPipelineRun.json
rename to specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/ActivityRuns_QueryByPipelineRun.json
index 1d0e4bb38f62..f5662d347497 100644
--- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/ActivityRuns_QueryByPipelineRun.json
+++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/ActivityRuns_QueryByPipelineRun.json
@@ -1,14 +1,13 @@
{
"parameters": {
- "workspaceName": "exampleWorkspace",
- "SynapseDnsSuffix": "dev.azuresynapse.net",
+ "endpoint": "exampleWorkspace.dev.azuresynapse.net",
"pipelineName": "examplePipeline",
"runId": "2f7fdb90-5df1-4b8e-ac2f-064cfa58202b",
"filterParameters": {
"lastUpdatedAfter": "2018-06-16T00:36:44.3345758Z",
"lastUpdatedBefore": "2018-06-16T00:49:48.3686473Z"
},
- "api-version": "2019-11-01-preview"
+ "api-version": "2019-06-01-preview"
},
"responses": {
"200": {
diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/CreateManagedPrivateEndpoint.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/CreateManagedPrivateEndpoint.json
new file mode 100644
index 000000000000..546fa6e7fe84
--- /dev/null
+++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/CreateManagedPrivateEndpoint.json
@@ -0,0 +1,33 @@
+{
+ "parameters": {
+ "workspaceName": "myWorkspace",
+ "SynapseDnsSuffix": "dev.azuresynapse.net",
+ "api-version": "2019-06-01-preview",
+ "managedVirtualNetworkName": "default",
+ "managedPrivateEndpointName": "myPrivateEndpoint",
+ "parameters": {
+ "properties": {
+ "privateLinkResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.Storage/accounts/myStorageAccount",
+ "groupId": "blob"
+ }
+ }
+ },
+ "responses": {
+ "202": {
+ "body": {
+ "type": "Microsoft.Synapse/workspaces/managedVirtualNetworks/managedPrivateEndpoints",
+ "name": "myPrivateEndpoint",
+ "properties": {
+ "privateLinkResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.Storage/accounts/myStorageAccount",
+ "groupId": "blob",
+ "provisioningState": "Provisioning",
+ "connectionState": {
+ "status": "Pending",
+ "description": "",
+ "actionsRequired": ""
+ }
+ }
+ }
+ }
+ }
+}
diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/DataFlowDebugSession_AddDataFlow.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/DataFlowDebugSession_AddDataFlow.json
similarity index 95%
rename from specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/DataFlowDebugSession_AddDataFlow.json
rename to specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/DataFlowDebugSession_AddDataFlow.json
index 3fe211fe4d36..adf054457fcc 100644
--- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/DataFlowDebugSession_AddDataFlow.json
+++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/DataFlowDebugSession_AddDataFlow.json
@@ -1,7 +1,6 @@
{
"parameters": {
- "workspaceName": "exampleWorkspace",
- "SynapseDnsSuffix": "dev.azuresynapse.net",
+ "endpoint": "exampleWorkspace.dev.azuresynapse.net",
"request": {
"dataFlow": {
"name": "dataflow1",
@@ -90,7 +89,7 @@
},
"sessionId": "f06ed247-9d07-49b2-b05e-2cb4a2fc871e"
},
- "api-version": "2019-11-01-preview"
+ "api-version": "2019-06-01-preview"
},
"responses": {
"200": {
diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/DataFlowDebugSession_Create.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/DataFlowDebugSession_Create.json
similarity index 87%
rename from specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/DataFlowDebugSession_Create.json
rename to specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/DataFlowDebugSession_Create.json
index 2b8e9fb98143..b1644c6737c5 100644
--- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/DataFlowDebugSession_Create.json
+++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/DataFlowDebugSession_Create.json
@@ -1,7 +1,6 @@
{
"parameters": {
- "workspaceName": "exampleWorkspace",
- "SynapseDnsSuffix": "dev.azuresynapse.net",
+ "endpoint": "exampleWorkspace.dev.azuresynapse.net",
"request": {
"dataFlowName": "dataflow",
"existingClusterId": "1221221",
@@ -21,7 +20,7 @@
}
}
},
- "api-version": "2019-11-01-preview"
+ "api-version": "2019-06-01-preview"
},
"responses": {
"202": {
@@ -31,7 +30,7 @@
"x-ms-ratelimit-remaining-subscription-reads": "14989",
"x-ms-request-id": "2f955e10-c6df-45a7-97d4-81acdb8540cd",
"x-ms-correlation-request-id": "2f955e10-c6df-45a7-97d4-81acdb8540cd",
- "location": "https://exampleWorkspaceName.dev.azuresynapse.net/operationStatuses/dfCreateSession$$229c688c-944c-44ac-b31a-82d50f347154?api-version=2019-11-01-preview"
+ "location": "https://exampleWorkspaceName.dev.azuresynapse.net/operationStatuses/dfCreateSession$$229c688c-944c-44ac-b31a-82d50f347154?api-version=2019-06-01-preview"
}
},
"200": {
diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/DataFlowDebugSession_Delete.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/DataFlowDebugSession_Delete.json
similarity index 78%
rename from specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/DataFlowDebugSession_Delete.json
rename to specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/DataFlowDebugSession_Delete.json
index be1da7df23ce..7eecf68ab320 100644
--- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/DataFlowDebugSession_Delete.json
+++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/DataFlowDebugSession_Delete.json
@@ -1,11 +1,10 @@
{
"parameters": {
- "workspaceName": "exampleWorkspace",
- "SynapseDnsSuffix": "dev.azuresynapse.net",
+ "endpoint": "exampleWorkspace.dev.azuresynapse.net",
"request": {
"sessionId": "91fb57e0-8292-47be-89ff-c8f2d2bb2a7e"
},
- "api-version": "2019-11-01-preview"
+ "api-version": "2019-06-01-preview"
},
"responses": {
"200": {
diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/DataFlowDebugSession_ExecuteCommand.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/DataFlowDebugSession_ExecuteCommand.json
similarity index 83%
rename from specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/DataFlowDebugSession_ExecuteCommand.json
rename to specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/DataFlowDebugSession_ExecuteCommand.json
index 45e86f142046..9c88adb10bde 100644
--- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/DataFlowDebugSession_ExecuteCommand.json
+++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/DataFlowDebugSession_ExecuteCommand.json
@@ -1,7 +1,6 @@
{
"parameters": {
- "workspaceName": "exampleWorkspace",
- "SynapseDnsSuffix": "dev.azuresynapse.net",
+ "endpoint": "exampleWorkspace.dev.azuresynapse.net",
"request": {
"dataFlowName": "dataFlowName",
"commandPayload": {
@@ -11,7 +10,7 @@
"commandName": "executePreviewQuery",
"sessionId": "f06ed247-9d07-49b2-b05e-2cb4a2fc871e"
},
- "api-version": "2019-11-01-preview"
+ "api-version": "2019-06-01-preview"
},
"responses": {
"202": {
@@ -21,7 +20,7 @@
"x-ms-ratelimit-remaining-subscription-reads": "14989",
"x-ms-request-id": "2f955e10-c6df-45a7-97d4-81acdb8540cd",
"x-ms-correlation-request-id": "2f955e10-c6df-45a7-97d4-81acdb8540cd",
- "location": "https://exampleWorkspaceName.dev.azuresynapse.net/operationResults/dfCommandOutput$$f06ed247-9d07-49b2-b05e-2cb4a2fc871e$$e5328ee7-c524-4207-8ba4-b709010db33d$$ace5eaf0-3e93-45ba-ada3-bf77da321a7b?api-version=2019-11-01-preview"
+ "location": "https://exampleWorkspaceName.dev.azuresynapse.net/operationResults/dfCommandOutput$$f06ed247-9d07-49b2-b05e-2cb4a2fc871e$$e5328ee7-c524-4207-8ba4-b709010db33d$$ace5eaf0-3e93-45ba-ada3-bf77da321a7b?api-version=2019-06-01-preview"
}
},
"200": {
diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/DataFlowDebugSession_QueryByWorkspace.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/DataFlowDebugSession_QueryByWorkspace.json
similarity index 87%
rename from specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/DataFlowDebugSession_QueryByWorkspace.json
rename to specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/DataFlowDebugSession_QueryByWorkspace.json
index 8489bf43ada4..fee006e7bfa3 100644
--- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/DataFlowDebugSession_QueryByWorkspace.json
+++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/DataFlowDebugSession_QueryByWorkspace.json
@@ -1,8 +1,7 @@
{
"parameters": {
- "workspaceName": "exampleWorkspace",
- "SynapseDnsSuffix": "dev.azuresynapse.net",
- "api-version": "2019-11-01-preview"
+ "endpoint": "exampleWorkspace.dev.azuresynapse.net",
+ "api-version": "2019-06-01-preview"
},
"responses": {
"200": {
diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/DataFlows_Create.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/DataFlows_Create.json
similarity index 97%
rename from specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/DataFlows_Create.json
rename to specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/DataFlows_Create.json
index b7ed67fcc853..d684ba316241 100644
--- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/DataFlows_Create.json
+++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/DataFlows_Create.json
@@ -1,7 +1,6 @@
{
"parameters": {
- "workspaceName": "exampleWorkspace",
- "SynapseDnsSuffix": "dev.azuresynapse.net",
+ "endpoint": "exampleWorkspace.dev.azuresynapse.net",
"dataFlowName": "exampleDataFlow",
"ifMatch": null,
"dataFlow": {
@@ -45,7 +44,7 @@
}
}
},
- "api-version": "2019-11-01-preview"
+ "api-version": "2019-06-01-preview"
},
"responses": {
"200": {
diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/DataFlows_Delete.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/DataFlows_Delete.json
new file mode 100644
index 000000000000..6adacca27788
--- /dev/null
+++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/DataFlows_Delete.json
@@ -0,0 +1,11 @@
+{
+ "parameters": {
+ "endpoint": "exampleWorkspace.dev.azuresynapse.net",
+ "dataFlowName": "exampleDataFlow",
+ "api-version": "2019-06-01-preview"
+ },
+ "responses": {
+ "200": {},
+ "204": {}
+ }
+}
diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/DataFlows_Get.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/DataFlows_Get.json
similarity index 95%
rename from specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/DataFlows_Get.json
rename to specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/DataFlows_Get.json
index 62b69ff0b194..5320762f2207 100644
--- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/DataFlows_Get.json
+++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/DataFlows_Get.json
@@ -1,10 +1,9 @@
{
"parameters": {
- "workspaceName": "exampleWorkspace",
- "SynapseDnsSuffix": "dev.azuresynapse.net",
+ "endpoint": "exampleWorkspace.dev.azuresynapse.net",
"dataFlowName": "exampleDataFlow",
"ifNoneMatch": "15004c4f-0000-0200-0000-5cbe090e0000",
- "api-version": "2019-11-01-preview"
+ "api-version": "2019-06-01-preview"
},
"responses": {
"200": {
diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/DataFlows_ListByWorkspace.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/DataFlows_ListByWorkspace.json
similarity index 95%
rename from specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/DataFlows_ListByWorkspace.json
rename to specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/DataFlows_ListByWorkspace.json
index 822e92e95dcc..24af45cebd60 100644
--- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/DataFlows_ListByWorkspace.json
+++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/DataFlows_ListByWorkspace.json
@@ -1,8 +1,7 @@
{
"parameters": {
- "workspaceName": "exampleWorkspace",
- "SynapseDnsSuffix": "dev.azuresynapse.net",
- "api-version": "2019-11-01-preview"
+ "endpoint": "exampleWorkspace.dev.azuresynapse.net",
+ "api-version": "2019-06-01-preview"
},
"responses": {
"200": {
diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/DataFlows_Update.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/DataFlows_Update.json
similarity index 97%
rename from specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/DataFlows_Update.json
rename to specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/DataFlows_Update.json
index 7dd8812dadde..f3c5fc5a031e 100644
--- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/DataFlows_Update.json
+++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/DataFlows_Update.json
@@ -1,7 +1,6 @@
{
"parameters": {
- "workspaceName": "exampleWorkspace",
- "SynapseDnsSuffix": "dev.azuresynapse.net",
+ "endpoint": "exampleWorkspace.dev.azuresynapse.net",
"dataFlowName": "exampleDataFlow",
"ifMatch": null,
"dataFlow": {
@@ -45,7 +44,7 @@
}
}
},
- "api-version": "2019-11-01-preview"
+ "api-version": "2019-06-01-preview"
},
"responses": {
"200": {
diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/Datasets_Create.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Datasets_Create.json
similarity index 95%
rename from specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/Datasets_Create.json
rename to specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Datasets_Create.json
index ac06a1b294d9..20f9a9b778ff 100644
--- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/Datasets_Create.json
+++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Datasets_Create.json
@@ -1,7 +1,6 @@
{
"parameters": {
- "workspaceName": "exampleWorkspace",
- "SynapseDnsSuffix": "dev.azuresynapse.net",
+ "endpoint": "exampleWorkspace.dev.azuresynapse.net",
"datasetName": "exampleDataset",
"ifMatch": null,
"dataset": {
@@ -34,7 +33,7 @@
}
}
},
- "api-version": "2019-11-01-preview"
+ "api-version": "2019-06-01-preview"
},
"responses": {
"200": {
diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Datasets_Delete.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Datasets_Delete.json
new file mode 100644
index 000000000000..ecbb3fd65993
--- /dev/null
+++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Datasets_Delete.json
@@ -0,0 +1,11 @@
+{
+ "parameters": {
+ "endpoint": "exampleWorkspace.dev.azuresynapse.net",
+ "datasetName": "exampleDataset",
+ "api-version": "2019-06-01-preview"
+ },
+ "responses": {
+ "200": {},
+ "204": {}
+ }
+}
diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/Datasets_Get.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Datasets_Get.json
similarity index 92%
rename from specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/Datasets_Get.json
rename to specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Datasets_Get.json
index e144948c6a4a..9ff129e80acb 100644
--- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/Datasets_Get.json
+++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Datasets_Get.json
@@ -1,10 +1,9 @@
{
"parameters": {
- "workspaceName": "exampleWorkspace",
- "SynapseDnsSuffix": "dev.azuresynapse.net",
+ "endpoint": "exampleWorkspace.dev.azuresynapse.net",
"datasetName": "exampleDataset",
"ifNoneMatch": "15004c4f-0000-0200-0000-5cbe090e0000",
- "api-version": "2019-11-01-preview"
+ "api-version": "2019-06-01-preview"
},
"responses": {
"304": {},
diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/Datasets_ListByWorkspace.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Datasets_ListByWorkspace.json
similarity index 93%
rename from specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/Datasets_ListByWorkspace.json
rename to specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Datasets_ListByWorkspace.json
index f447e965203b..9600e887321c 100644
--- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/Datasets_ListByWorkspace.json
+++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Datasets_ListByWorkspace.json
@@ -1,8 +1,7 @@
{
"parameters": {
- "workspaceName": "exampleWorkspace",
- "SynapseDnsSuffix": "dev.azuresynapse.net",
- "api-version": "2019-11-01-preview"
+ "endpoint": "exampleWorkspace.dev.azuresynapse.net",
+ "api-version": "2019-06-01-preview"
},
"responses": {
"200": {
diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/Datasets_Update.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Datasets_Update.json
similarity index 94%
rename from specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/Datasets_Update.json
rename to specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Datasets_Update.json
index bbb243a3e705..c17bc775bed6 100644
--- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/Datasets_Update.json
+++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Datasets_Update.json
@@ -1,7 +1,6 @@
{
"parameters": {
- "workspaceName": "exampleWorkspace",
- "SynapseDnsSuffix": "dev.azuresynapse.net",
+ "endpoint": "exampleWorkspace.dev.azuresynapse.net",
"datasetName": "exampleDataset",
"ifMatch": null,
"dataset": {
@@ -35,7 +34,7 @@
}
}
},
- "api-version": "2019-11-01-preview"
+ "api-version": "2019-06-01-preview"
},
"responses": {
"200": {
diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/DeleteManagedPrivateEndpoint.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/DeleteManagedPrivateEndpoint.json
new file mode 100644
index 000000000000..a82531a7ca46
--- /dev/null
+++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/DeleteManagedPrivateEndpoint.json
@@ -0,0 +1,13 @@
+{
+ "parameters": {
+ "workspaceName": "myWorkspace",
+ "SynapseDnsSuffix": "dev.azuresynapse.net",
+ "api-version": "2019-06-01-preview",
+ "managedVirtualNetworkName": "default",
+ "managedPrivateEndpointName": "myPrivateEndpoint"
+ },
+ "responses": {
+ "202": {},
+ "204": {}
+ }
+}
diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/GetManagedPrivateEndpoint.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/GetManagedPrivateEndpoint.json
new file mode 100644
index 000000000000..cb3551457722
--- /dev/null
+++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/GetManagedPrivateEndpoint.json
@@ -0,0 +1,27 @@
+{
+ "parameters": {
+ "workspaceName": "myWorkspace",
+ "SynapseDnsSuffix": "dev.azuresynapse.net",
+ "api-version": "2019-06-01-preview",
+ "managedVirtualNetworkName": "default",
+ "managedPrivateEndpointName": "myPrivateEndpoint"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "type": "Microsoft.Synapse/workspaces/managedVirtualNetworks/managedPrivateEndpoints",
+ "name": "myPrivateEndpoint",
+ "properties": {
+ "privateLinkResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.Storage/accounts/myStorageAccount",
+ "groupId": "blob",
+ "provisioningState": "Succeeded",
+ "connectionState": {
+ "status": "Approved",
+ "description": "",
+ "actionsRequired": ""
+ }
+ }
+ }
+ }
+ }
+}
diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/LinkedServices_Create.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/LinkedServices_Create.json
similarity index 92%
rename from specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/LinkedServices_Create.json
rename to specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/LinkedServices_Create.json
index a390ebc6a97a..83813ca2dbd3 100644
--- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/LinkedServices_Create.json
+++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/LinkedServices_Create.json
@@ -1,7 +1,6 @@
{
"parameters": {
- "workspaceName": "exampleWorkspace",
- "SynapseDnsSuffix": "dev.azuresynapse.net",
+ "endpoint": "exampleWorkspace.dev.azuresynapse.net",
"linkedServiceName": "exampleLinkedService",
"ifMatch": null,
"linkedService": {
@@ -15,7 +14,7 @@
}
}
},
- "api-version": "2019-11-01-preview"
+ "api-version": "2019-06-01-preview"
},
"responses": {
"200": {
diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/LinkedServices_Delete.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/LinkedServices_Delete.json
new file mode 100644
index 000000000000..d18fa82e8963
--- /dev/null
+++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/LinkedServices_Delete.json
@@ -0,0 +1,11 @@
+{
+ "parameters": {
+ "endpoint": "exampleWorkspace.dev.azuresynapse.net",
+ "linkedServiceName": "exampleLinkedService",
+ "api-version": "2019-06-01-preview"
+ },
+ "responses": {
+ "200": {},
+ "204": {}
+ }
+}
diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/LinkedServices_Get.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/LinkedServices_Get.json
similarity index 91%
rename from specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/LinkedServices_Get.json
rename to specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/LinkedServices_Get.json
index 0febc6bb3664..a1f58bc731fd 100644
--- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/LinkedServices_Get.json
+++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/LinkedServices_Get.json
@@ -1,10 +1,9 @@
{
"parameters": {
- "workspaceName": "exampleWorkspace",
- "SynapseDnsSuffix": "dev.azuresynapse.net",
+ "endpoint": "exampleWorkspace.dev.azuresynapse.net",
"linkedServiceName": "exampleLinkedService",
"ifNoneMatch": "1500474f-0000-0200-0000-5cbe090d0000",
- "api-version": "2019-11-01-preview"
+ "api-version": "2019-06-01-preview"
},
"responses": {
"304": {},
diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/LinkedServices_ListByWorkspace.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/LinkedServices_ListByWorkspace.json
similarity index 91%
rename from specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/LinkedServices_ListByWorkspace.json
rename to specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/LinkedServices_ListByWorkspace.json
index 2624517adc08..73b500bfb22e 100644
--- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/LinkedServices_ListByWorkspace.json
+++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/LinkedServices_ListByWorkspace.json
@@ -1,8 +1,7 @@
{
"parameters": {
- "workspaceName": "exampleWorkspace",
- "SynapseDnsSuffix": "dev.azuresynapse.net",
- "api-version": "2019-11-01-preview"
+ "endpoint": "exampleWorkspace.dev.azuresynapse.net",
+ "api-version": "2019-06-01-preview"
},
"responses": {
"200": {
diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/LinkedServices_Update.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/LinkedServices_Update.json
similarity index 93%
rename from specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/LinkedServices_Update.json
rename to specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/LinkedServices_Update.json
index a5b3f337bcf1..217788a059e1 100644
--- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/LinkedServices_Update.json
+++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/LinkedServices_Update.json
@@ -1,7 +1,6 @@
{
"parameters": {
- "workspaceName": "exampleWorkspace",
- "SynapseDnsSuffix": "dev.azuresynapse.net",
+ "endpoint": "exampleWorkspace.dev.azuresynapse.net",
"linkedServiceName": "exampleLinkedService",
"ifMatch": null,
"linkedService": {
@@ -16,7 +15,7 @@
"description": "Example description"
}
},
- "api-version": "2019-11-01-preview"
+ "api-version": "2019-06-01-preview"
},
"responses": {
"200": {
diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/ListManagedPrivateEndpoints.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/ListManagedPrivateEndpoints.json
new file mode 100644
index 000000000000..2dfbbc8c6aef
--- /dev/null
+++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/ListManagedPrivateEndpoints.json
@@ -0,0 +1,45 @@
+{
+ "parameters": {
+ "workspaceName": "myWorkspace",
+ "SynapseDnsSuffix": "dev.azuresynapse.net",
+ "api-version": "2019-06-01-preview",
+ "managedVirtualNetworkName": "default"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "type": "Microsoft.Synapse/workspaces/managedVirtualNetworks/managedPrivateEndpoints",
+ "name": "myPrivateEndpoint1",
+ "properties": {
+ "privateLinkResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.Storage/accounts/myStorageAccount1",
+ "groupId": "blob",
+ "provisioningState": "Succeeded",
+ "connectionState": {
+ "status": "Approved",
+ "description": "",
+ "actionsRequired": ""
+ }
+ }
+ },
+ {
+ "type": "Microsoft.Synapse/workspaces/managedVirtualNetworks/managedPrivateEndpoints",
+ "name": "myPrivateEndpoint2",
+ "properties": {
+ "privateLinkResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.Storage/accounts/myStorageAccount2",
+ "groupId": "blob",
+ "provisioningState": "Succeeded",
+ "connectionState": {
+ "status": "Pending",
+ "description": "",
+ "actionsRequired": ""
+ }
+ }
+ }
+ ],
+ "nextLink": ""
+ }
+ }
+ }
+}
diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/NoteBooks_Create.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Notebooks_Create.json
similarity index 88%
rename from specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/NoteBooks_Create.json
rename to specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Notebooks_Create.json
index 6e096bebb3de..6dfcafc232ee 100644
--- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/NoteBooks_Create.json
+++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Notebooks_Create.json
@@ -1,12 +1,11 @@
{
"parameters": {
- "workspaceName": "exampleWorkspace",
- "SynapseDnsSuffix": "dev.azuresynapse.net",
- "noteBookName": "exampleNoteBook",
+ "endpoint": "exampleWorkspace.dev.azuresynapse.net",
+ "notebookName": "exampleNotebook",
"ifMatch": null,
- "noteBook": {
+ "Notebook": {
"properties": {
- "description": "A sample notebook",
+ "description": "A sample Notebook",
"nbformat": 4,
"nbformat_minor": 2,
"bigDataPool": {
@@ -54,7 +53,7 @@
]
}
},
- "api-version": "2019-11-01-preview"
+ "api-version": "2019-06-01-preview"
},
"responses": {
"200": {
@@ -66,11 +65,11 @@
"x-ms-correlation-request-id": "e4c589b7-a9fe-4c28-981c-3855ec27d264"
},
"body": {
- "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspaceName/notebooks/exampleNoteBook",
- "name": "exampleNoteBook",
- "type": "Microsoft.Synapse/workspaces/notebooks",
+ "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspaceName/Notebooks/exampleNotebook",
+ "name": "exampleNotebook",
+ "type": "Microsoft.Synapse/workspaces/Notebooks",
"properties": {
- "description": "A sample notebook",
+ "description": "A sample Notebook",
"nbformat": 4,
"nbformat_minor": 2,
"bigDataPool": {
diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Notebooks_Delete.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Notebooks_Delete.json
new file mode 100644
index 000000000000..58395fa417a1
--- /dev/null
+++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Notebooks_Delete.json
@@ -0,0 +1,11 @@
+{
+ "parameters": {
+ "endpoint": "exampleWorkspace.dev.azuresynapse.net",
+ "notebookName": "exampleNotebook",
+ "api-version": "2019-06-01-preview"
+ },
+ "responses": {
+ "200": {},
+ "204": {}
+ }
+}
diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/NoteBooks_Get.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Notebooks_Get.json
similarity index 84%
rename from specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/NoteBooks_Get.json
rename to specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Notebooks_Get.json
index 1231f1525ebb..c60e7f3695a6 100644
--- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/NoteBooks_Get.json
+++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Notebooks_Get.json
@@ -1,10 +1,9 @@
{
"parameters": {
- "workspaceName": "exampleWorkspace",
- "SynapseDnsSuffix": "dev.azuresynapse.net",
- "noteBookName": "exampleNoteBook",
+ "endpoint": "exampleWorkspace.dev.azuresynapse.net",
+ "notebookName": "exampleNotebook",
"ifNoneMatch": "1500504f-0000-0200-0000-5cbe090f0000",
- "api-version": "2019-11-01-preview"
+ "api-version": "2019-06-01-preview"
},
"responses": {
"200": {
@@ -16,11 +15,11 @@
"x-ms-correlation-request-id": "e4c589b7-a9fe-4c28-981c-3855ec27d264"
},
"body": {
- "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspaceName/notebooks/exampleNoteBook",
- "name": "exampleNoteBook",
- "type": "Microsoft.Synapse/workspaces/notebooks",
+ "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspaceName/notebooks/exampleNotebook",
+ "name": "exampleNotebook",
+ "type": "Microsoft.Synapse/workspaces/Notebooks",
"properties": {
- "description": "A sample notebook",
+ "description": "A sample Notebook",
"nbformat": 4,
"nbformat_minor": 2,
"bigDataPool": {
diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/NoteBooks_ListByWorkspace.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Notebooks_ListByWorkspace.json
similarity index 86%
rename from specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/NoteBooks_ListByWorkspace.json
rename to specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Notebooks_ListByWorkspace.json
index b45c79479777..e339a9103d65 100644
--- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/NoteBooks_ListByWorkspace.json
+++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Notebooks_ListByWorkspace.json
@@ -1,8 +1,7 @@
{
"parameters": {
- "workspaceName": "exampleWorkspace",
- "SynapseDnsSuffix": "dev.azuresynapse.net",
- "api-version": "2019-11-01-preview"
+ "endpoint": "exampleWorkspace.dev.azuresynapse.net",
+ "api-version": "2019-06-01-preview"
},
"responses": {
"200": {
@@ -16,11 +15,11 @@
"body": {
"value": [
{
- "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspaceName/notebooks/exampleNoteBook",
- "name": "exampleNoteBook",
- "type": "Microsoft.Synapse/workspaces/notebooks",
+ "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspaceName/notebooks/exampleNotebook",
+ "name": "exampleNotebook",
+ "type": "Microsoft.Synapse/workspaces/Notebooks",
"properties": {
- "description": "A sample notebook",
+ "description": "A sample Notebook",
"nbformat": 4,
"nbformat_minor": 2,
"bigDataPool": {
diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/NoteBooks_ListSummaryByWorkSpace.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Notebooks_ListSummaryByWorkSpace.json
similarity index 86%
rename from specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/NoteBooks_ListSummaryByWorkSpace.json
rename to specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Notebooks_ListSummaryByWorkSpace.json
index b45c79479777..e339a9103d65 100644
--- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/NoteBooks_ListSummaryByWorkSpace.json
+++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Notebooks_ListSummaryByWorkSpace.json
@@ -1,8 +1,7 @@
{
"parameters": {
- "workspaceName": "exampleWorkspace",
- "SynapseDnsSuffix": "dev.azuresynapse.net",
- "api-version": "2019-11-01-preview"
+ "endpoint": "exampleWorkspace.dev.azuresynapse.net",
+ "api-version": "2019-06-01-preview"
},
"responses": {
"200": {
@@ -16,11 +15,11 @@
"body": {
"value": [
{
- "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspaceName/notebooks/exampleNoteBook",
- "name": "exampleNoteBook",
- "type": "Microsoft.Synapse/workspaces/notebooks",
+ "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspaceName/notebooks/exampleNotebook",
+ "name": "exampleNotebook",
+ "type": "Microsoft.Synapse/workspaces/Notebooks",
"properties": {
- "description": "A sample notebook",
+ "description": "A sample Notebook",
"nbformat": 4,
"nbformat_minor": 2,
"bigDataPool": {
diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/NoteBooks_Update.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Notebooks_Update.json
similarity index 90%
rename from specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/NoteBooks_Update.json
rename to specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Notebooks_Update.json
index 3add275201f5..c84e1a5f1741 100644
--- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/NoteBooks_Update.json
+++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Notebooks_Update.json
@@ -1,10 +1,9 @@
{
"parameters": {
- "workspaceName": "exampleWorkspace",
- "SynapseDnsSuffix": "dev.azuresynapse.net",
- "noteBookName": "exampleNoteBook",
+ "endpoint": "exampleWorkspace.dev.azuresynapse.net",
+ "notebookName": "exampleNotebook",
"ifMatch": null,
- "noteBook": {
+ "Notebook": {
"properties": {
"description": "Modified description",
"nbformat": 4,
@@ -54,7 +53,7 @@
]
}
},
- "api-version": "2019-11-01-preview"
+ "api-version": "2019-06-01-preview"
},
"responses": {
"200": {
@@ -66,9 +65,9 @@
"x-ms-correlation-request-id": "e4c589b7-a9fe-4c28-981c-3855ec27d264"
},
"body": {
- "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspaceName/notebooks/exampleNoteBook",
- "name": "exampleNoteBook",
- "type": "Microsoft.Synapse/workspaces/notebooks",
+ "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspaceName/notebooks/exampleNotebook",
+ "name": "exampleNotebook",
+ "type": "Microsoft.Synapse/workspaces/Notebooks",
"properties": {
"description": "Modified description",
"nbformat": 4,
diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/PipelineRuns_Cancel.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/PipelineRuns_Cancel.json
new file mode 100644
index 000000000000..223ee4eea674
--- /dev/null
+++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/PipelineRuns_Cancel.json
@@ -0,0 +1,10 @@
+{
+ "parameters": {
+ "endpoint": "exampleWorkspace.dev.azuresynapse.net",
+ "runId": "16ac5348-ff82-4f95-a80d-638c1d47b721",
+ "api-version": "2019-06-01-preview"
+ },
+ "responses": {
+ "200": {}
+ }
+}
diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/PipelineRuns_Get.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/PipelineRuns_Get.json
similarity index 89%
rename from specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/PipelineRuns_Get.json
rename to specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/PipelineRuns_Get.json
index c70c28bcd545..23b48073aed1 100644
--- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/PipelineRuns_Get.json
+++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/PipelineRuns_Get.json
@@ -1,9 +1,8 @@
{
"parameters": {
- "workspaceName": "exampleWorkspace",
- "SynapseDnsSuffix": "dev.azuresynapse.net",
+ "endpoint": "exampleWorkspace.dev.azuresynapse.net",
"runId": "2f7fdb90-5df1-4b8e-ac2f-064cfa58202b",
- "api-version": "2019-11-01-preview"
+ "api-version": "2019-06-01-preview"
},
"responses": {
"200": {
diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/PipelineRuns_QueryByWorkspace.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/PipelineRuns_QueryByWorkspace.json
similarity index 94%
rename from specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/PipelineRuns_QueryByWorkspace.json
rename to specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/PipelineRuns_QueryByWorkspace.json
index 729a2293c584..c93f18b8301c 100644
--- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/PipelineRuns_QueryByWorkspace.json
+++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/PipelineRuns_QueryByWorkspace.json
@@ -1,7 +1,6 @@
{
"parameters": {
- "workspaceName": "exampleWorkspace",
- "SynapseDnsSuffix": "dev.azuresynapse.net",
+ "endpoint": "exampleWorkspace.dev.azuresynapse.net",
"filterParameters": {
"lastUpdatedAfter": "2018-06-16T00:36:44.3345758Z",
"lastUpdatedBefore": "2018-06-16T00:49:48.3686473Z",
@@ -15,7 +14,7 @@
}
]
},
- "api-version": "2019-11-01-preview"
+ "api-version": "2019-06-01-preview"
},
"responses": {
"200": {
diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/Pipelines_Create.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Pipelines_Create.json
similarity index 97%
rename from specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/Pipelines_Create.json
rename to specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Pipelines_Create.json
index aa5d08c13e96..399eb460bf34 100644
--- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/Pipelines_Create.json
+++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Pipelines_Create.json
@@ -1,7 +1,6 @@
{
"parameters": {
- "workspaceName": "exampleWorkspace",
- "SynapseDnsSuffix": "dev.azuresynapse.net",
+ "endpoint": "exampleWorkspace.dev.azuresynapse.net",
"pipelineName": "examplePipeline",
"ifMatch": null,
"pipeline": {
@@ -78,7 +77,7 @@
}
}
},
- "api-version": "2019-11-01-preview"
+ "api-version": "2019-06-01-preview"
},
"responses": {
"200": {
diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/Pipelines_CreateRun.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Pipelines_CreateRun.json
similarity index 83%
rename from specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/Pipelines_CreateRun.json
rename to specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Pipelines_CreateRun.json
index 9ccab2c1f7a4..7c4ec522a5a3 100644
--- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/Pipelines_CreateRun.json
+++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Pipelines_CreateRun.json
@@ -1,7 +1,6 @@
{
"parameters": {
- "workspaceName": "exampleWorkspace",
- "SynapseDnsSuffix": "dev.azuresynapse.net",
+ "endpoint": "exampleWorkspace.dev.azuresynapse.net",
"pipelineName": "examplePipeline",
"referencePipelineRunId": null,
"parameters": {
@@ -9,7 +8,7 @@
"exampleoutput.csv"
]
},
- "api-version": "2019-11-01-preview"
+ "api-version": "2019-06-01-preview"
},
"responses": {
"200": {
diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Pipelines_Delete.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Pipelines_Delete.json
new file mode 100644
index 000000000000..4a7573f09103
--- /dev/null
+++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Pipelines_Delete.json
@@ -0,0 +1,11 @@
+{
+ "parameters": {
+ "endpoint": "exampleWorkspace.dev.azuresynapse.net",
+ "pipelineName": "examplePipeline",
+ "api-version": "2019-06-01-preview"
+ },
+ "responses": {
+ "200": {},
+ "204": {}
+ }
+}
diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/Pipelines_Get.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Pipelines_Get.json
similarity index 95%
rename from specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/Pipelines_Get.json
rename to specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Pipelines_Get.json
index 5336cd82dc2b..48e8f695574e 100644
--- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/Pipelines_Get.json
+++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Pipelines_Get.json
@@ -1,10 +1,9 @@
{
"parameters": {
- "workspaceName": "exampleWorkspace",
- "SynapseDnsSuffix": "dev.azuresynapse.net",
+ "endpoint": "exampleWorkspace.dev.azuresynapse.net",
"pipelineName": "examplePipeline",
"ifNoneMatch": "1500504f-0000-0200-0000-5cbe090f0000",
- "api-version": "2019-11-01-preview"
+ "api-version": "2019-06-01-preview"
},
"responses": {
"304": {},
diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/Pipelines_ListByWorkspace.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Pipelines_ListByWorkspace.json
similarity index 95%
rename from specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/Pipelines_ListByWorkspace.json
rename to specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Pipelines_ListByWorkspace.json
index d5ecfa79951a..e9b5dfc8816d 100644
--- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/Pipelines_ListByWorkspace.json
+++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Pipelines_ListByWorkspace.json
@@ -1,8 +1,7 @@
{
"parameters": {
- "workspaceName": "exampleWorkspace",
- "SynapseDnsSuffix": "dev.azuresynapse.net",
- "api-version": "2019-11-01-preview"
+ "endpoint": "exampleWorkspace.dev.azuresynapse.net",
+ "api-version": "2019-06-01-preview"
},
"responses": {
"200": {
diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/Pipelines_Update.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Pipelines_Update.json
similarity index 97%
rename from specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/Pipelines_Update.json
rename to specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Pipelines_Update.json
index 831858484fd3..b5718b15aa75 100644
--- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/Pipelines_Update.json
+++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Pipelines_Update.json
@@ -1,7 +1,6 @@
{
"parameters": {
- "workspaceName": "exampleWorkspace",
- "SynapseDnsSuffix": "dev.azuresynapse.net",
+ "endpoint": "exampleWorkspace.dev.azuresynapse.net",
"pipelineName": "examplePipeline",
"ifMatch": null,
"pipeline": {
@@ -65,7 +64,7 @@
}
}
},
- "api-version": "2019-11-01-preview"
+ "api-version": "2019-06-01-preview"
},
"responses": {
"200": {
diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/SparkJobDefinitions_Create.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/SparkJobDefinitions_Create.json
similarity index 95%
rename from specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/SparkJobDefinitions_Create.json
rename to specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/SparkJobDefinitions_Create.json
index 6572cbb38414..d969cd11b3e3 100644
--- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/SparkJobDefinitions_Create.json
+++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/SparkJobDefinitions_Create.json
@@ -1,7 +1,6 @@
{
"parameters": {
- "workspaceName": "exampleWorkspace",
- "SynapseDnsSuffix": "dev.azuresynapse.net",
+ "endpoint": "exampleWorkspace.dev.azuresynapse.net",
"sparkJobDefinitionName": "exampleSparkJobDefinition",
"ifMatch": null,
"sparkJobDefinition": {
@@ -32,7 +31,7 @@
}
}
},
- "api-version": "2019-11-01-preview"
+ "api-version": "2019-06-01-preview"
},
"responses": {
"200": {
diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/SparkJobDefinitions_Debug.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/SparkJobDefinitions_Debug.json
similarity index 97%
rename from specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/SparkJobDefinitions_Debug.json
rename to specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/SparkJobDefinitions_Debug.json
index e274b30ea43a..d470f6b59a75 100644
--- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/SparkJobDefinitions_Debug.json
+++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/SparkJobDefinitions_Debug.json
@@ -1,7 +1,6 @@
{
"parameters": {
- "workspaceName": "exampleWorkspace",
- "SynapseDnsSuffix": "dev.azuresynapse.net",
+ "endpoint": "exampleWorkspace.dev.azuresynapse.net",
"sparkJobDefinitionAzureResource": {
"properties": {
"description": "A sample spark job definition",
@@ -23,7 +22,7 @@
}
}
},
- "api-version": "2019-11-01-preview"
+ "api-version": "2019-06-01-preview"
},
"responses": {
"202": {
@@ -33,7 +32,7 @@
"x-ms-ratelimit-remaining-subscription-writes": "1192",
"x-ms-request-id": "e4c589b7-a9fe-4c28-981c-3855ec27d264",
"x-ms-correlation-request-id": "e4c589b7-a9fe-4c28-981c-3855ec27d264",
- "location": "https://exampleWorkspaceName.dev.azuresynapse.net/operationResults/arcadiaSpark$$exampleBigDataPool$$batch$$1?api-version=2019-11-01-preview"
+ "location": "https://exampleWorkspaceName.dev.azuresynapse.net/operationResults/arcadiaSpark$$exampleBigDataPool$$batch$$1?api-version=2019-06-01-preview"
},
"body": {
"livyInfo": {
diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/SparkJobDefinitions_Delete.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/SparkJobDefinitions_Delete.json
similarity index 51%
rename from specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/SparkJobDefinitions_Delete.json
rename to specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/SparkJobDefinitions_Delete.json
index 5ebb9f424a2a..37e6bcc064e8 100644
--- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/SparkJobDefinitions_Delete.json
+++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/SparkJobDefinitions_Delete.json
@@ -1,9 +1,8 @@
{
"parameters": {
- "workspaceName": "exampleWorkspace",
- "SynapseDnsSuffix": "dev.azuresynapse.net",
+ "endpoint": "exampleWorkspace.dev.azuresynapse.net",
"sparkJobDefinitionName": "exampleSparkJobDefinition",
- "api-version": "2019-11-01-preview"
+ "api-version": "2019-06-01-preview"
},
"responses": {
"200": {},
diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/SparkJobDefinitions_Execute.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/SparkJobDefinitions_Execute.json
similarity index 97%
rename from specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/SparkJobDefinitions_Execute.json
rename to specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/SparkJobDefinitions_Execute.json
index 0c8aabb09867..8ba9acd78875 100644
--- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/SparkJobDefinitions_Execute.json
+++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/SparkJobDefinitions_Execute.json
@@ -1,9 +1,8 @@
{
"parameters": {
- "workspaceName": "exampleWorkspace",
- "SynapseDnsSuffix": "dev.azuresynapse.net",
+ "endpoint": "exampleWorkspace.dev.azuresynapse.net",
"sparkJobDefinitionName": "exampleSparkJobDefinition",
- "api-version": "2019-11-01-preview"
+ "api-version": "2019-06-01-preview"
},
"responses": {
"202": {
@@ -13,7 +12,7 @@
"x-ms-ratelimit-remaining-subscription-writes": "1192",
"x-ms-request-id": "e4c589b7-a9fe-4c28-981c-3855ec27d264",
"x-ms-correlation-request-id": "e4c589b7-a9fe-4c28-981c-3855ec27d264",
- "location": "https://exampleWorkspaceName.dev.azuresynapse.net/operationResults/arcadiaSpark$$exampleBigDataPool$$batch$$1?api-version=2019-11-01-preview"
+ "location": "https://exampleWorkspaceName.dev.azuresynapse.net/operationResults/arcadiaSpark$$exampleBigDataPool$$batch$$1?api-version=2019-06-01-preview"
},
"body": {
"livyInfo": {
diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/SparkJobDefinitions_Get.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/SparkJobDefinitions_Get.json
similarity index 93%
rename from specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/SparkJobDefinitions_Get.json
rename to specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/SparkJobDefinitions_Get.json
index d36ba238c79a..fb4857b4d515 100644
--- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/SparkJobDefinitions_Get.json
+++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/SparkJobDefinitions_Get.json
@@ -1,10 +1,9 @@
{
"parameters": {
- "workspaceName": "exampleWorkspace",
- "SynapseDnsSuffix": "dev.azuresynapse.net",
+ "endpoint": "exampleWorkspace.dev.azuresynapse.net",
"sparkJobDefinitionName": "exampleSparkJobDefinition",
"ifNoneMatch": "1500504f-0000-0200-0000-5cbe090f0000",
- "api-version": "2019-11-01-preview"
+ "api-version": "2019-06-01-preview"
},
"responses": {
"200": {
diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/SparkJobDefinitions_ListByWorkspace.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/SparkJobDefinitions_ListByWorkspace.json
similarity index 93%
rename from specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/SparkJobDefinitions_ListByWorkspace.json
rename to specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/SparkJobDefinitions_ListByWorkspace.json
index f05b845f65ba..1e021182a881 100644
--- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/SparkJobDefinitions_ListByWorkspace.json
+++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/SparkJobDefinitions_ListByWorkspace.json
@@ -1,8 +1,7 @@
{
"parameters": {
- "workspaceName": "exampleWorkspace",
- "SynapseDnsSuffix": "dev.azuresynapse.net",
- "api-version": "2019-11-01-preview"
+ "endpoint": "exampleWorkspace.dev.azuresynapse.net",
+ "api-version": "2019-06-01-preview"
},
"responses": {
"200": {
diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/SparkJobDefinitions_Update.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/SparkJobDefinitions_Update.json
similarity index 95%
rename from specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/SparkJobDefinitions_Update.json
rename to specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/SparkJobDefinitions_Update.json
index 005764c7dc47..61f620544311 100644
--- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/SparkJobDefinitions_Update.json
+++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/SparkJobDefinitions_Update.json
@@ -1,7 +1,6 @@
{
"parameters": {
- "workspaceName": "exampleWorkspace",
- "SynapseDnsSuffix": "dev.azuresynapse.net",
+ "endpoint": "exampleWorkspace.dev.azuresynapse.net",
"sparkJobDefinitionName": "exampleSparkJobDefinition",
"ifMatch": null,
"sparkJobDefinition": {
@@ -32,7 +31,7 @@
}
}
},
- "api-version": "2019-11-01-preview"
+ "api-version": "2019-06-01-preview"
},
"responses": {
"200": {
diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/SqlScripts_Create.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/SqlScripts_Create.json
similarity index 93%
rename from specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/SqlScripts_Create.json
rename to specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/SqlScripts_Create.json
index 5dc6861614b9..aa96d82b50df 100644
--- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/SqlScripts_Create.json
+++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/SqlScripts_Create.json
@@ -1,7 +1,6 @@
{
"parameters": {
- "workspaceName": "exampleWorkspace",
- "SynapseDnsSuffix": "dev.azuresynapse.net",
+ "endpoint": "exampleWorkspace.dev.azuresynapse.net",
"sqlScriptName": "exampleSqlScript",
"ifMatch": null,
"sqlScript": {
@@ -20,7 +19,7 @@
"type": "SqlQuery"
}
},
- "api-version": "2019-11-01-preview"
+ "api-version": "2019-06-01-preview"
},
"responses": {
"200": {
diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/SqlScripts_Delete.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/SqlScripts_Delete.json
new file mode 100644
index 000000000000..b01abf40c85b
--- /dev/null
+++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/SqlScripts_Delete.json
@@ -0,0 +1,11 @@
+{
+ "parameters": {
+ "endpoint": "exampleWorkspace.dev.azuresynapse.net",
+ "sqlScriptName": "exampleSqlScript",
+ "api-version": "2019-06-01-preview"
+ },
+ "responses": {
+ "200": {},
+ "204": {}
+ }
+}
diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/SqlScripts_Get.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/SqlScripts_Get.json
similarity index 91%
rename from specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/SqlScripts_Get.json
rename to specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/SqlScripts_Get.json
index 829447fd448f..58b0d64cc81b 100644
--- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/SqlScripts_Get.json
+++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/SqlScripts_Get.json
@@ -1,10 +1,9 @@
{
"parameters": {
- "workspaceName": "exampleWorkspace",
- "SynapseDnsSuffix": "dev.azuresynapse.net",
+ "endpoint": "exampleWorkspace.dev.azuresynapse.net",
"sqlScriptName": "exampleSqlScript",
"ifNoneMatch": "1500504f-0000-0200-0000-5cbe090f0000",
- "api-version": "2019-11-01-preview"
+ "api-version": "2019-06-01-preview"
},
"responses": {
"304": {},
diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/SqlScripts_ListByWorkspace.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/SqlScripts_ListByWorkspace.json
similarity index 91%
rename from specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/SqlScripts_ListByWorkspace.json
rename to specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/SqlScripts_ListByWorkspace.json
index c999df7b1828..7625964f4a73 100644
--- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/SqlScripts_ListByWorkspace.json
+++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/SqlScripts_ListByWorkspace.json
@@ -1,8 +1,7 @@
{
"parameters": {
- "workspaceName": "exampleWorkspace",
- "SynapseDnsSuffix": "dev.azuresynapse.net",
- "api-version": "2019-11-01-preview"
+ "endpoint": "exampleWorkspace.dev.azuresynapse.net",
+ "api-version": "2019-06-01-preview"
},
"responses": {
"200": {
diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/SqlScripts_Update.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/SqlScripts_Update.json
similarity index 92%
rename from specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/SqlScripts_Update.json
rename to specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/SqlScripts_Update.json
index 0c377a063cbd..cd482ba8c7e9 100644
--- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/SqlScripts_Update.json
+++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/SqlScripts_Update.json
@@ -1,7 +1,6 @@
{
"parameters": {
- "workspaceName": "exampleWorkspace",
- "SynapseDnsSuffix": "dev.azuresynapse.net",
+ "endpoint": "exampleWorkspace.dev.azuresynapse.net",
"sqlScriptName": "exampleSqlScript",
"ifMatch": null,
"sqlScript": {
@@ -20,7 +19,7 @@
"type": "SqlQuery"
}
},
- "api-version": "2019-11-01-preview"
+ "api-version": "2019-06-01-preview"
},
"responses": {
"200": {
diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/TriggerRuns_QueryByWorkspace.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/TriggerRuns_QueryByWorkspace.json
similarity index 91%
rename from specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/TriggerRuns_QueryByWorkspace.json
rename to specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/TriggerRuns_QueryByWorkspace.json
index 48c13c4038c3..e90f9a56ffbf 100644
--- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/TriggerRuns_QueryByWorkspace.json
+++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/TriggerRuns_QueryByWorkspace.json
@@ -1,7 +1,6 @@
{
"parameters": {
- "workspaceName": "exampleWorkspace",
- "SynapseDnsSuffix": "dev.azuresynapse.net",
+ "endpoint": "exampleWorkspace.dev.azuresynapse.net",
"filterParameters": {
"lastUpdatedAfter": "2018-06-16T00:36:44.3345758Z",
"lastUpdatedBefore": "2018-06-16T00:49:48.3686473Z",
@@ -15,7 +14,7 @@
}
]
},
- "api-version": "2019-11-01-preview"
+ "api-version": "2019-06-01-preview"
},
"responses": {
"200": {
diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/TriggerRuns_Rerun.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/TriggerRuns_Rerun.json
similarity index 79%
rename from specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/TriggerRuns_Rerun.json
rename to specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/TriggerRuns_Rerun.json
index edd3551ad448..169d70a4e4b5 100644
--- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/TriggerRuns_Rerun.json
+++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/TriggerRuns_Rerun.json
@@ -1,10 +1,9 @@
{
"parameters": {
- "workspaceName": "exampleWorkspace",
- "SynapseDnsSuffix": "dev.azuresynapse.net",
+ "endpoint": "exampleWorkspace.dev.azuresynapse.net",
"triggerName": "exampleTrigger",
"runId": "2f7fdb90-5df1-4b8e-ac2f-064cfa58202b",
- "api-version": "2019-11-01-preview"
+ "api-version": "2019-06-01-preview"
},
"responses": {
"200": {
diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/Triggers_Create.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Triggers_Create.json
similarity index 94%
rename from specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/Triggers_Create.json
rename to specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Triggers_Create.json
index d7210bda0148..c93a8820594c 100644
--- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/Triggers_Create.json
+++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Triggers_Create.json
@@ -1,7 +1,6 @@
{
"parameters": {
- "workspaceName": "exampleWorkspace",
- "SynapseDnsSuffix": "dev.azuresynapse.net",
+ "endpoint": "exampleWorkspace.dev.azuresynapse.net",
"triggerName": "exampleTrigger",
"ifMatch": null,
"trigger": {
@@ -31,7 +30,7 @@
]
}
},
- "api-version": "2019-11-01-preview"
+ "api-version": "2019-06-01-preview"
},
"responses": {
"200": {
diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Triggers_Delete.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Triggers_Delete.json
new file mode 100644
index 000000000000..b3a88c1cd75e
--- /dev/null
+++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Triggers_Delete.json
@@ -0,0 +1,11 @@
+{
+ "parameters": {
+ "endpoint": "exampleWorkspace.dev.azuresynapse.net",
+ "triggerName": "exampleTrigger",
+ "api-version": "2019-06-01-preview"
+ },
+ "responses": {
+ "200": {},
+ "204": {}
+ }
+}
diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/Triggers_Get.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Triggers_Get.json
similarity index 92%
rename from specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/Triggers_Get.json
rename to specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Triggers_Get.json
index bc4d1d09b735..d0a33e28322e 100644
--- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/Triggers_Get.json
+++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Triggers_Get.json
@@ -1,10 +1,9 @@
{
"parameters": {
- "workspaceName": "exampleWorkspace",
- "SynapseDnsSuffix": "dev.azuresynapse.net",
+ "endpoint": "exampleWorkspace.dev.azuresynapse.net",
"triggerName": "exampleTrigger",
"ifNoneMatch": "1500544f-0000-0200-0000-5cbe09100000",
- "api-version": "2019-11-01-preview"
+ "api-version": "2019-06-01-preview"
},
"responses": {
"304": {},
diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/Triggers_GetEventSubscriptionStatus.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Triggers_GetEventSubscriptionStatus.json
similarity index 60%
rename from specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/Triggers_GetEventSubscriptionStatus.json
rename to specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Triggers_GetEventSubscriptionStatus.json
index 89e4b4c407c0..b53d893ae8dc 100644
--- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/Triggers_GetEventSubscriptionStatus.json
+++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Triggers_GetEventSubscriptionStatus.json
@@ -1,9 +1,8 @@
{
"parameters": {
- "workspaceName": "exampleWorkspace",
- "SynapseDnsSuffix": "dev.azuresynapse.net",
+ "endpoint": "exampleWorkspace.dev.azuresynapse.net",
"triggerName": "exampleTrigger",
- "api-version": "2019-11-01-preview"
+ "api-version": "2019-06-01-preview"
},
"responses": {
"200": {
diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/Triggers_ListByWorkspace.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Triggers_ListByWorkspace.json
similarity index 93%
rename from specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/Triggers_ListByWorkspace.json
rename to specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Triggers_ListByWorkspace.json
index ec31d1d1ad90..cd9b246ab465 100644
--- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/Triggers_ListByWorkspace.json
+++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Triggers_ListByWorkspace.json
@@ -1,8 +1,7 @@
{
"parameters": {
- "workspaceName": "exampleWorkspace",
- "SynapseDnsSuffix": "dev.azuresynapse.net",
- "api-version": "2019-11-01-preview"
+ "endpoint": "exampleWorkspace.dev.azuresynapse.net",
+ "api-version": "2019-06-01-preview"
},
"responses": {
"200": {
diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Triggers_Start.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Triggers_Start.json
new file mode 100644
index 000000000000..b4062d3fb605
--- /dev/null
+++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Triggers_Start.json
@@ -0,0 +1,10 @@
+{
+ "parameters": {
+ "endpoint": "exampleWorkspace.dev.azuresynapse.net",
+ "triggerName": "exampleTrigger",
+ "api-version": "2019-06-01-preview"
+ },
+ "responses": {
+ "200": {}
+ }
+}
diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Triggers_Stop.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Triggers_Stop.json
new file mode 100644
index 000000000000..b4062d3fb605
--- /dev/null
+++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Triggers_Stop.json
@@ -0,0 +1,10 @@
+{
+ "parameters": {
+ "endpoint": "exampleWorkspace.dev.azuresynapse.net",
+ "triggerName": "exampleTrigger",
+ "api-version": "2019-06-01-preview"
+ },
+ "responses": {
+ "200": {}
+ }
+}
diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/Triggers_SubscribeToEvents.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Triggers_SubscribeToEvents.json
similarity index 76%
rename from specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/Triggers_SubscribeToEvents.json
rename to specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Triggers_SubscribeToEvents.json
index 012cdd41ae33..6fc40f69c0fb 100644
--- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/Triggers_SubscribeToEvents.json
+++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Triggers_SubscribeToEvents.json
@@ -1,14 +1,13 @@
{
"parameters": {
- "workspaceName": "exampleWorkspace",
- "SynapseDnsSuffix": "dev.azuresynapse.net",
+ "endpoint": "exampleWorkspace.dev.azuresynapse.net",
"triggerName": "exampleTrigger",
- "api-version": "2019-11-01-preview"
+ "api-version": "2019-06-01-preview"
},
"responses": {
"202": {
"headers": {
- "Location": "https://management.azure.com/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspaceName/triggers/exampleTrigger/getEventSubscriptionStatus?api-version=2019-11-01-preview"
+ "Location": "https://management.azure.com/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspaceName/triggers/exampleTrigger/getEventSubscriptionStatus?api-version=2019-06-01-preview"
}
},
"200": {
diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/Triggers_UnsubscribeFromEvents.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Triggers_UnsubscribeFromEvents.json
similarity index 76%
rename from specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/Triggers_UnsubscribeFromEvents.json
rename to specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Triggers_UnsubscribeFromEvents.json
index c3df05a1a218..d2d6e6b8e538 100644
--- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/Triggers_UnsubscribeFromEvents.json
+++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Triggers_UnsubscribeFromEvents.json
@@ -1,14 +1,13 @@
{
"parameters": {
- "workspaceName": "exampleWorkspace",
- "SynapseDnsSuffix": "dev.azuresynapse.net",
+ "endpoint": "exampleWorkspace.dev.azuresynapse.net",
"triggerName": "exampleTrigger",
- "api-version": "2019-11-01-preview"
+ "api-version": "2019-06-01-preview"
},
"responses": {
"202": {
"headers": {
- "Location": "https://management.azure.com/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspaceName/triggers/exampleTrigger/getEventSubscriptionStatus?api-version=2019-11-01-preview"
+ "Location": "https://management.azure.com/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspaceName/triggers/exampleTrigger/getEventSubscriptionStatus?api-version=2019-06-01-preview"
}
},
"200": {
diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/Triggers_Update.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Triggers_Update.json
similarity index 94%
rename from specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/Triggers_Update.json
rename to specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Triggers_Update.json
index ae377e99c8c9..a86583945183 100644
--- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/Triggers_Update.json
+++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Triggers_Update.json
@@ -1,7 +1,6 @@
{
"parameters": {
- "workspaceName": "exampleWorkspace",
- "SynapseDnsSuffix": "dev.azuresynapse.net",
+ "endpoint": "exampleWorkspace.dev.azuresynapse.net",
"triggerName": "exampleTrigger",
"ifMatch": null,
"trigger": {
@@ -32,7 +31,7 @@
"description": "Example description"
}
},
- "api-version": "2019-11-01-preview"
+ "api-version": "2019-06-01-preview"
},
"responses": {
"200": {
diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/managedPrivateEndpoints.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/managedPrivateEndpoints.json
new file mode 100644
index 000000000000..8322fd96043d
--- /dev/null
+++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/managedPrivateEndpoints.json
@@ -0,0 +1,299 @@
+{
+ "swagger": "2.0",
+ "info": {
+ "version": "2019-06-01-preview",
+ "title": "VnetClient"
+ },
+ "x-ms-parameterized-host": {
+ "hostTemplate": "{workspaceName}.{SynapseDnsSuffix}",
+ "parameters": [
+ {
+ "name": "workspaceName",
+ "description": "The name of the workspace to execute operations on.",
+ "required": true,
+ "type": "string",
+ "in": "path",
+ "x-ms-skip-url-encoding": true
+ },
+ {
+ "$ref": "#/parameters/SynapseDnsSuffixInPath"
+ }
+ ]
+ },
+ "schemes": [
+ "https"
+ ],
+ "paths": {
+ "/managedVirtualNetworks/{managedVirtualNetworkName}/managedPrivateEndpoints/{managedPrivateEndpointName}": {
+ "get": {
+ "tags": [
+ "ManagedPrivateEndpoints"
+ ],
+ "operationId": "ManagedPrivateEndpoints_Get",
+ "description": "Get Managed Private Endpoints",
+ "consumes": [],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/ManagedVirtualNetworkNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ManagedPrivateEndpointNameParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "schema": {
+ "$ref": "#/definitions/ManagedPrivateEndpoint"
+ },
+ "description": ""
+ }
+ },
+ "x-ms-examples": {
+ "Get a managed private endpoint": {
+ "$ref": "./examples/GetManagedPrivateEndpoint.json"
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "ManagedPrivateEndpoints"
+ ],
+ "operationId": "ManagedPrivateEndpoints_Create",
+ "description": "Create Managed Private Endpoints",
+ "consumes": [],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/ManagedVirtualNetworkNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ManagedPrivateEndpointNameParameter"
+ }
+ ],
+ "responses": {
+ "202": {
+ "schema": {
+ "$ref": "#/definitions/ManagedPrivateEndpoint"
+ },
+ "description": ""
+ }
+ },
+ "x-ms-examples": {
+ "Create a managed private endpoint": {
+ "$ref": "./examples/CreateManagedPrivateEndpoint.json"
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "ManagedPrivateEndpoints"
+ ],
+ "operationId": "ManagedPrivateEndpoints_Delete",
+ "description": "Delete Managed Private Endpoints",
+ "consumes": [],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/ManagedVirtualNetworkNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ManagedPrivateEndpointNameParameter"
+ }
+ ],
+ "responses": {
+ "202": {
+ "description": "Accepted"
+ },
+ "204": {
+ "description": "Already deleted"
+ }
+ },
+ "x-ms-examples": {
+ "Delete a managed private endpoint": {
+ "$ref": "./examples/DeleteManagedPrivateEndpoint.json"
+ }
+ }
+ }
+ },
+ "/managedVirtualNetworks/{managedVirtualNetworkName}/managedPrivateEndpoints": {
+ "get": {
+ "tags": [
+ "ManagedPrivateEndpoints"
+ ],
+ "operationId": "ManagedPrivateEndpoints_List",
+ "description": "List Managed Private Endpoints",
+ "consumes": [],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/ManagedVirtualNetworkNameParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "schema": {
+ "$ref": "#/definitions/ManagedPrivateEndpointListResponse"
+ },
+ "description": ""
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-examples": {
+ "List managed private endpoints": {
+ "$ref": "./examples/ListManagedPrivateEndpoints.json"
+ }
+ }
+ }
+ }
+ },
+ "definitions": {
+ "ManagedPrivateEndpointListResponse": {
+ "description": "A list of managed private endpoints",
+ "type": "object",
+ "properties": {
+ "value": {
+ "type": "array",
+ "description": "List of managed private endpoints",
+ "items": {
+ "$ref": "#/definitions/ManagedPrivateEndpoint"
+ }
+ },
+ "nextLink": {
+ "description": "The link to the next page of results, if any remaining results exist.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "ManagedPrivateEndpoint": {
+ "description": "Managed private endpoint",
+ "type": "object",
+ "properties": {
+ "id": {
+ "readOnly": true,
+ "type": "string",
+ "description": "Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
+ },
+ "name": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The name of the resource"
+ },
+ "type": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts."
+ },
+ "properties": {
+ "$ref": "#/definitions/ManagedPrivateEndpointProperties",
+ "description": "Managed private endpoint properties"
+ }
+ }
+ },
+ "ManagedPrivateEndpointProperties": {
+ "description": "Properties of a managed private endpoint",
+ "type": "object",
+ "properties": {
+ "privateLinkResourceId": {
+ "description": "The ARM resource ID of the resource to which the managed private endpoint is created",
+ "type": "string"
+ },
+ "groupId": {
+ "description": "The groupId to which the managed private endpoint is created",
+ "type": "string"
+ },
+ "provisioningState": {
+ "description": "The managed private endpoint provisioning state",
+ "type": "string",
+ "readOnly": true
+ },
+ "connectionState": {
+ "description": "The managed private endpoint connection state",
+ "$ref": "#/definitions/ManagedPrivateEndpointConnectionState"
+ },
+ "isReserved": {
+ "description": "Denotes whether the managed private endpoint is reserved",
+ "type": "boolean",
+ "readOnly": true
+ }
+ }
+ },
+ "ManagedPrivateEndpointConnectionState": {
+ "description": "The connection state of a managed private endpoint",
+ "type": "object",
+ "properties": {
+ "status": {
+ "description": "The approval status",
+ "type": "string",
+ "readOnly": true
+ },
+ "description": {
+ "description": "The managed private endpoint description",
+ "type": "string"
+ },
+ "actionsRequired": {
+ "description": "The actions required on the managed private endpoint",
+ "type": "string"
+ }
+ }
+ }
+ },
+ "parameters": {
+ "ApiVersionParameter": {
+ "name": "api-version",
+ "in": "query",
+ "required": true,
+ "type": "string",
+ "description": "The Synapse client API Version."
+ },
+ "SynapseDnsSuffixInPath": {
+ "name": "SynapseDnsSuffix",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "default": "dev.azuresynapse.net",
+ "x-ms-skip-url-encoding": true,
+ "description": "Gets the DNS suffix used as the base for all Synapse service requests.",
+ "x-ms-parameter-location": "client"
+ },
+ "ManagedVirtualNetworkNameParameter": {
+ "name": "managedVirtualNetworkName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "Managed virtual network name",
+ "x-ms-parameter-location": "method"
+ },
+ "ManagedPrivateEndpointNameParameter": {
+ "name": "managedPrivateEndpointName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "Managed private endpoint name",
+ "x-ms-parameter-location": "method"
+ }
+ }
+}
diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/DataFlows_Delete.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/DataFlows_Delete.json
deleted file mode 100644
index c17410917a90..000000000000
--- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/DataFlows_Delete.json
+++ /dev/null
@@ -1,12 +0,0 @@
-{
- "parameters": {
- "workspaceName": "exampleWorkspace",
- "SynapseDnsSuffix": "dev.azuresynapse.net",
- "dataFlowName": "exampleDataFlow",
- "api-version": "2019-11-01-preview"
- },
- "responses": {
- "200": {},
- "204": {}
- }
-}
diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/Datasets_Delete.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/Datasets_Delete.json
deleted file mode 100644
index e82de485176e..000000000000
--- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/Datasets_Delete.json
+++ /dev/null
@@ -1,12 +0,0 @@
-{
- "parameters": {
- "workspaceName": "exampleWorkspace",
- "SynapseDnsSuffix": "dev.azuresynapse.net",
- "datasetName": "exampleDataset",
- "api-version": "2019-11-01-preview"
- },
- "responses": {
- "200": {},
- "204": {}
- }
-}
diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/LinkedServices_Delete.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/LinkedServices_Delete.json
deleted file mode 100644
index e4cc97bbd8e9..000000000000
--- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/LinkedServices_Delete.json
+++ /dev/null
@@ -1,12 +0,0 @@
-{
- "parameters": {
- "workspaceName": "exampleWorkspace",
- "SynapseDnsSuffix": "dev.azuresynapse.net",
- "linkedServiceName": "exampleLinkedService",
- "api-version": "2019-11-01-preview"
- },
- "responses": {
- "200": {},
- "204": {}
- }
-}
diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/NoteBooks_Delete.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/NoteBooks_Delete.json
deleted file mode 100644
index 5b9d485f645f..000000000000
--- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/NoteBooks_Delete.json
+++ /dev/null
@@ -1,12 +0,0 @@
-{
- "parameters": {
- "workspaceName": "exampleWorkspace",
- "SynapseDnsSuffix": "dev.azuresynapse.net",
- "noteBookName": "exampleNoteBook",
- "api-version": "2019-11-01-preview"
- },
- "responses": {
- "200": {},
- "204": {}
- }
-}
diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/PipelineRuns_Cancel.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/PipelineRuns_Cancel.json
deleted file mode 100644
index 240fccae8866..000000000000
--- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/PipelineRuns_Cancel.json
+++ /dev/null
@@ -1,11 +0,0 @@
-{
- "parameters": {
- "workspaceName": "exampleWorkspace",
- "SynapseDnsSuffix": "dev.azuresynapse.net",
- "runId": "16ac5348-ff82-4f95-a80d-638c1d47b721",
- "api-version": "2019-11-01-preview"
- },
- "responses": {
- "200": {}
- }
-}
diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/Pipelines_Delete.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/Pipelines_Delete.json
deleted file mode 100644
index cb459371f543..000000000000
--- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/Pipelines_Delete.json
+++ /dev/null
@@ -1,12 +0,0 @@
-{
- "parameters": {
- "workspaceName": "exampleWorkspace",
- "SynapseDnsSuffix": "dev.azuresynapse.net",
- "pipelineName": "examplePipeline",
- "api-version": "2019-11-01-preview"
- },
- "responses": {
- "200": {},
- "204": {}
- }
-}
diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/SqlScripts_Delete.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/SqlScripts_Delete.json
deleted file mode 100644
index e67581c0ef4d..000000000000
--- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/SqlScripts_Delete.json
+++ /dev/null
@@ -1,12 +0,0 @@
-{
- "parameters": {
- "workspaceName": "exampleWorkspace",
- "SynapseDnsSuffix": "dev.azuresynapse.net",
- "sqlScriptName": "exampleSqlScript",
- "api-version": "2019-11-01-preview"
- },
- "responses": {
- "200": {},
- "204": {}
- }
-}
diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/Triggers_Delete.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/Triggers_Delete.json
deleted file mode 100644
index 430e2cfba554..000000000000
--- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/Triggers_Delete.json
+++ /dev/null
@@ -1,12 +0,0 @@
-{
- "parameters": {
- "workspaceName": "exampleWorkspace",
- "SynapseDnsSuffix": "dev.azuresynapse.net",
- "triggerName": "exampleTrigger",
- "api-version": "2019-11-01-preview"
- },
- "responses": {
- "200": {},
- "204": {}
- }
-}
diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/Triggers_Start.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/Triggers_Start.json
deleted file mode 100644
index 8d61a0a08228..000000000000
--- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/Triggers_Start.json
+++ /dev/null
@@ -1,11 +0,0 @@
-{
- "parameters": {
- "workspaceName": "exampleWorkspace",
- "SynapseDnsSuffix": "dev.azuresynapse.net",
- "triggerName": "exampleTrigger",
- "api-version": "2019-11-01-preview"
- },
- "responses": {
- "200": {}
- }
-}
diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/Triggers_Stop.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/Triggers_Stop.json
deleted file mode 100644
index 8d61a0a08228..000000000000
--- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/Triggers_Stop.json
+++ /dev/null
@@ -1,11 +0,0 @@
-{
- "parameters": {
- "workspaceName": "exampleWorkspace",
- "SynapseDnsSuffix": "dev.azuresynapse.net",
- "triggerName": "exampleTrigger",
- "api-version": "2019-11-01-preview"
- },
- "responses": {
- "200": {}
- }
-}
diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/examples/SparkFrontend_SparkBatch_Create.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/examples/SparkFrontend_SparkBatch_Create.json
index c00010474fcd..55db4134cc83 100644
--- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/examples/SparkFrontend_SparkBatch_Create.json
+++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/examples/SparkFrontend_SparkBatch_Create.json
@@ -1,11 +1,10 @@
{
"parameters": {
- "workspaceName": "myWorkspace",
- "SynapseDnsSuffix": "dev.azuresynapse.net",
+ "endpoint": "myWorkspace.dev.azuresynapse.net",
"livyApiVersion": "2019-11-01-preview",
"sparkPoolName": "mySparkPool",
"detailed": true,
- "livyRequest": {
+ "sparkBatchJobOptions": {
"tags": null,
"artifactId": "fill in here",
"name": "jobname",
diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/examples/SparkFrontend_SparkBatch_Delete.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/examples/SparkFrontend_SparkBatch_Delete.json
index 2d724570df6f..4065e60cf5ca 100644
--- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/examples/SparkFrontend_SparkBatch_Delete.json
+++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/examples/SparkFrontend_SparkBatch_Delete.json
@@ -1,7 +1,6 @@
{
"parameters": {
- "workspaceName": "myWorkspace",
- "SynapseDnsSuffix": "dev.azuresynapse.net",
+ "endpoint": "myWorkspace.dev.azuresynapse.net",
"livyApiVersion": "2019-11-01-preview",
"sparkPoolName": "mySparkPool",
"batchId": 123,
diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/examples/SparkFrontend_SparkBatch_Get.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/examples/SparkFrontend_SparkBatch_Get.json
index bf6362b33a76..2efdc6815217 100644
--- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/examples/SparkFrontend_SparkBatch_Get.json
+++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/examples/SparkFrontend_SparkBatch_Get.json
@@ -1,7 +1,6 @@
{
"parameters": {
- "workspaceName": "myWorkspace",
- "SynapseDnsSuffix": "dev.azuresynapse.net",
+ "endpoint": "myWorkspace.dev.azuresynapse.net",
"livyApiVersion": "2019-11-01-preview",
"sparkPoolName": "mySparkPool",
"batchId": 123,
diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/examples/SparkFrontend_SparkBatch_List.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/examples/SparkFrontend_SparkBatch_List.json
index a112d816c54d..008b004dfb27 100644
--- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/examples/SparkFrontend_SparkBatch_List.json
+++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/examples/SparkFrontend_SparkBatch_List.json
@@ -1,7 +1,6 @@
{
"parameters": {
- "workspaceName": "myWorkspace",
- "SynapseDnsSuffix": "dev.azuresynapse.net",
+ "endpoint": "myWorkspace.dev.azuresynapse.net",
"livyApiVersion": "2019-11-01-preview",
"sparkPoolName": "mySparkPool",
"from": 0,
diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/examples/SparkFrontend_SparkSession_Create.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/examples/SparkFrontend_SparkSession_Create.json
index 40aa196c6d1c..392544470614 100644
--- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/examples/SparkFrontend_SparkSession_Create.json
+++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/examples/SparkFrontend_SparkSession_Create.json
@@ -1,11 +1,10 @@
{
"parameters": {
- "workspaceName": "myWorkspace",
- "SynapseDnsSuffix": "dev.azuresynapse.net",
+ "endpoint": "myWorkspace.dev.azuresynapse.net",
"livyApiVersion": "2019-11-01-preview",
"sparkPoolName": "mySparkPool",
"detailed": true,
- "livyRequest": {
+ "SparkSessionOptions": {
"tags": null,
"artifactId": "fill in here",
"name": "jobname",
diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/examples/SparkFrontend_SparkSession_CreateStatement.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/examples/SparkFrontend_SparkSession_CreateStatement.json
index a5fd2a5fc372..1c9c2cef0441 100644
--- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/examples/SparkFrontend_SparkSession_CreateStatement.json
+++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/examples/SparkFrontend_SparkSession_CreateStatement.json
@@ -1,11 +1,10 @@
{
"parameters": {
- "workspaceName": "myWorkspace",
- "SynapseDnsSuffix": "dev.azuresynapse.net",
+ "endpoint": "myWorkspace.dev.azuresynapse.net",
"livyApiVersion": "2019-11-01-preview",
"sparkPoolName": "mySparkPool",
"sessionId": 123,
- "livyRequest": {
+ "SparkStatementOptions": {
"code": "fill in here",
"kind": "fill in here"
}
diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/examples/SparkFrontend_SparkSession_Delete.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/examples/SparkFrontend_SparkSession_Delete.json
index d74f7b31bdc8..50dcbafe48eb 100644
--- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/examples/SparkFrontend_SparkSession_Delete.json
+++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/examples/SparkFrontend_SparkSession_Delete.json
@@ -1,7 +1,6 @@
{
"parameters": {
- "workspaceName": "myWorkspace",
- "SynapseDnsSuffix": "dev.azuresynapse.net",
+ "endpoint": "myWorkspace.dev.azuresynapse.net",
"livyApiVersion": "2019-11-01-preview",
"sparkPoolName": "mySparkPool",
"sessionId": 123,
diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/examples/SparkFrontend_SparkSession_DeleteStatement.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/examples/SparkFrontend_SparkSession_DeleteStatement.json
index 09f511d90fbd..0f4624035909 100644
--- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/examples/SparkFrontend_SparkSession_DeleteStatement.json
+++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/examples/SparkFrontend_SparkSession_DeleteStatement.json
@@ -1,7 +1,6 @@
{
"parameters": {
- "workspaceName": "myWorkspace",
- "SynapseDnsSuffix": "dev.azuresynapse.net",
+ "endpoint": "myWorkspace.dev.azuresynapse.net",
"livyApiVersion": "2019-11-01-preview",
"sparkPoolName": "mySparkPool",
"sessionId": 123,
diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/examples/SparkFrontend_SparkSession_Get.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/examples/SparkFrontend_SparkSession_Get.json
index c7a828d05e7f..56fb7dd2ae81 100644
--- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/examples/SparkFrontend_SparkSession_Get.json
+++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/examples/SparkFrontend_SparkSession_Get.json
@@ -1,7 +1,6 @@
{
"parameters": {
- "workspaceName": "myWorkspace",
- "SynapseDnsSuffix": "dev.azuresynapse.net",
+ "endpoint": "myWorkspace.dev.azuresynapse.net",
"livyApiVersion": "2019-11-01-preview",
"sparkPoolName": "mySparkPool",
"sessionId": 123,
diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/examples/SparkFrontend_SparkSession_GetStatement.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/examples/SparkFrontend_SparkSession_GetStatement.json
index d45676affe42..86d5cb20c081 100644
--- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/examples/SparkFrontend_SparkSession_GetStatement.json
+++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/examples/SparkFrontend_SparkSession_GetStatement.json
@@ -1,7 +1,6 @@
{
"parameters": {
- "workspaceName": "myWorkspace",
- "SynapseDnsSuffix": "dev.azuresynapse.net",
+ "endpoint": "myWorkspace.dev.azuresynapse.net",
"livyApiVersion": "2019-11-01-preview",
"sparkPoolName": "mySparkPool",
"sessionId": 123,
diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/examples/SparkFrontend_SparkSession_List.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/examples/SparkFrontend_SparkSession_List.json
index a112d816c54d..008b004dfb27 100644
--- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/examples/SparkFrontend_SparkSession_List.json
+++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/examples/SparkFrontend_SparkSession_List.json
@@ -1,7 +1,6 @@
{
"parameters": {
- "workspaceName": "myWorkspace",
- "SynapseDnsSuffix": "dev.azuresynapse.net",
+ "endpoint": "myWorkspace.dev.azuresynapse.net",
"livyApiVersion": "2019-11-01-preview",
"sparkPoolName": "mySparkPool",
"from": 0,
diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/examples/SparkFrontend_SparkSession_ListStatements.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/examples/SparkFrontend_SparkSession_ListStatements.json
index e59988a5549f..4603d8c5feef 100644
--- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/examples/SparkFrontend_SparkSession_ListStatements.json
+++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/examples/SparkFrontend_SparkSession_ListStatements.json
@@ -1,7 +1,6 @@
{
"parameters": {
- "workspaceName": "myWorkspace",
- "SynapseDnsSuffix": "dev.azuresynapse.net",
+ "endpoint": "myWorkspace.dev.azuresynapse.net",
"livyApiVersion": "2019-11-01-preview",
"sparkPoolName": "mySparkPool",
"sessionId": 123
diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/examples/SparkFrontend_SparkSession_ResetTimeout.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/examples/SparkFrontend_SparkSession_ResetTimeout.json
index b9406468d90b..f6cdbf056b23 100644
--- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/examples/SparkFrontend_SparkSession_ResetTimeout.json
+++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/examples/SparkFrontend_SparkSession_ResetTimeout.json
@@ -1,7 +1,6 @@
{
"parameters": {
- "workspaceName": "myWorkspace",
- "SynapseDnsSuffix": "dev.azuresynapse.net",
+ "endpoint": "myWorkspace.dev.azuresynapse.net",
"livyApiVersion": "2019-11-01-preview",
"sparkPoolName": "mySparkPool",
"sessionId": 123
diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/sparkFrontend.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/sparkJob.json
similarity index 75%
rename from specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/sparkFrontend.json
rename to specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/sparkJob.json
index 537b1b03a4df..7f1d16f415b7 100644
--- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/sparkFrontend.json
+++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/sparkJob.json
@@ -2,24 +2,23 @@
"swagger": "2.0",
"info": {
"version": "2019-11-01-preview",
- "title": "SynapseClient",
+ "title": "SparkClient",
"x-ms-code-generation-settings": {
"useDateTimeOffset": true
}
},
"x-ms-parameterized-host": {
- "hostTemplate": "{workspaceName}.{SynapseDnsSuffix}",
+ "hostTemplate": "{endpoint}/livyApi/versions/{livyApiVersion}/sparkPools/{sparkPoolName}",
+ "useSchemePrefix": false,
"parameters": [
{
- "name": "workspaceName",
- "description": "The name of the workspace to execute operations on.",
- "required": true,
- "type": "string",
- "in": "path",
- "x-ms-skip-url-encoding": true
+ "$ref": "#/parameters/Endpoint"
},
{
- "$ref": "#/parameters/SynapseDnsSuffixInPath"
+ "$ref": "#/parameters/LivyApiVersion"
+ },
+ {
+ "$ref": "#/parameters/SparkPoolName"
}
]
},
@@ -33,13 +32,13 @@
"application/json"
],
"paths": {
- "/livyApi/versions/{livyApiVersion}/sparkPools/{sparkPoolName}/batches": {
+ "/batches": {
"get": {
"tags": [
"SparkBatch"
],
"description": "List all spark batch jobs which are running under a particular spark pool.",
- "operationId": "SparkBatch_List",
+ "operationId": "SparkBatch_GetSparkBatchJobs",
"x-ms-examples": {
"List all spark batch jobs": {
"$ref": "./examples/SparkFrontend_SparkBatch_List.json"
@@ -52,16 +51,6 @@
"application/json"
],
"parameters": [
- {
- "$ref": "#/parameters/LivyApiVersionInPath"
- },
- {
- "name": "sparkPoolName",
- "in": "path",
- "description": "Name of the spark pool. \"ondemand\" targets the ondemand pool.",
- "required": true,
- "type": "string"
- },
{
"name": "from",
"in": "query",
@@ -90,7 +79,7 @@
"200": {
"description": "Success",
"schema": {
- "$ref": "#/definitions/ExtendedLivyListBatchResponse"
+ "$ref": "#/definitions/SparkBatchJobCollection"
}
}
}
@@ -100,7 +89,7 @@
"SparkBatch"
],
"description": "Create new spark batch job.",
- "operationId": "SparkBatch_Create",
+ "operationId": "SparkBatch_CreateSparkBatchJob",
"x-ms-examples": {
"Create new spark batch job.": {
"$ref": "./examples/SparkFrontend_SparkBatch_Create.json"
@@ -113,16 +102,6 @@
"application/json"
],
"parameters": [
- {
- "$ref": "#/parameters/LivyApiVersionInPath"
- },
- {
- "name": "sparkPoolName",
- "in": "path",
- "description": "Name of the spark pool. \"ondemand\" targets the ondemand pool.",
- "required": true,
- "type": "string"
- },
{
"name": "detailed",
"in": "query",
@@ -131,12 +110,12 @@
"type": "boolean"
},
{
- "name": "livyRequest",
+ "name": "sparkBatchJobOptions",
"in": "body",
"description": "Livy compatible batch job request payload.",
"required": true,
"schema": {
- "$ref": "#/definitions/ExtendedLivyBatchRequest"
+ "$ref": "#/definitions/sparkBatchJobOptions"
}
}
],
@@ -144,19 +123,19 @@
"200": {
"description": "Success",
"schema": {
- "$ref": "#/definitions/ExtendedLivyBatchResponse"
+ "$ref": "#/definitions/SparkBatchJob"
}
}
}
}
},
- "/livyApi/versions/{livyApiVersion}/sparkPools/{sparkPoolName}/batches/{batchId}": {
+ "/batches/{batchId}": {
"get": {
"tags": [
"SparkBatch"
],
"description": "Gets a single spark batch job.",
- "operationId": "SparkBatch_Get",
+ "operationId": "SparkBatch_GetSparkBatchJob",
"x-ms-examples": {
"Gets a single spark batch job.": {
"$ref": "./examples/SparkFrontend_SparkBatch_Get.json"
@@ -169,16 +148,6 @@
"application/json"
],
"parameters": [
- {
- "$ref": "#/parameters/LivyApiVersionInPath"
- },
- {
- "name": "sparkPoolName",
- "in": "path",
- "description": "Name of the spark pool. \"ondemand\" targets the ondemand pool.",
- "required": true,
- "type": "string"
- },
{
"name": "batchId",
"in": "path",
@@ -199,7 +168,7 @@
"200": {
"description": "Success",
"schema": {
- "$ref": "#/definitions/ExtendedLivyBatchResponse"
+ "$ref": "#/definitions/SparkBatchJob"
}
}
}
@@ -209,7 +178,7 @@
"SparkBatch"
],
"description": "Cancels a running spark batch job.",
- "operationId": "SparkBatch_Delete",
+ "operationId": "SparkBatch_CancelSparkBatchJob",
"x-ms-examples": {
"Cancels a running spark batch job.": {
"$ref": "./examples/SparkFrontend_SparkBatch_Delete.json"
@@ -222,16 +191,6 @@
"application/json"
],
"parameters": [
- {
- "$ref": "#/parameters/LivyApiVersionInPath"
- },
- {
- "name": "sparkPoolName",
- "in": "path",
- "description": "Name of the spark pool. \"ondemand\" targets the ondemand pool.",
- "required": true,
- "type": "string"
- },
{
"name": "batchId",
"in": "path",
@@ -248,13 +207,13 @@
}
}
},
- "/livyApi/versions/{livyApiVersion}/sparkPools/{sparkPoolName}/sessions": {
+ "/sessions": {
"get": {
"tags": [
"SparkSession"
],
"description": "List all spark sessions which are running under a particular spark pool.",
- "operationId": "SparkSession_List",
+ "operationId": "SparkSession_GetSparkSessions",
"x-ms-examples": {
"List all spark session jobs": {
"$ref": "./examples/SparkFrontend_SparkSession_List.json"
@@ -267,16 +226,6 @@
"application/json"
],
"parameters": [
- {
- "$ref": "#/parameters/LivyApiVersionInPath"
- },
- {
- "name": "sparkPoolName",
- "in": "path",
- "description": "Name of the spark pool. \"ondemand\" targets the ondemand pool.",
- "required": true,
- "type": "string"
- },
{
"name": "from",
"in": "query",
@@ -305,7 +254,7 @@
"200": {
"description": "Success",
"schema": {
- "$ref": "#/definitions/ExtendedLivyListSessionResponse"
+ "$ref": "#/definitions/SparkSessionCollection"
}
}
}
@@ -315,7 +264,7 @@
"SparkSession"
],
"description": "Create new spark session.",
- "operationId": "SparkSession_Create",
+ "operationId": "SparkSession_CreateSparkSession",
"x-ms-examples": {
"Create new spark session.": {
"$ref": "./examples/SparkFrontend_SparkSession_Create.json"
@@ -328,16 +277,6 @@
"application/json"
],
"parameters": [
- {
- "$ref": "#/parameters/LivyApiVersionInPath"
- },
- {
- "name": "sparkPoolName",
- "in": "path",
- "description": "Name of the spark pool. \"ondemand\" targets the ondemand pool.",
- "required": true,
- "type": "string"
- },
{
"name": "detailed",
"in": "query",
@@ -346,12 +285,12 @@
"type": "boolean"
},
{
- "name": "livyRequest",
+ "name": "SparkSessionOptions",
"in": "body",
"description": "Livy compatible batch job request payload.",
"required": true,
"schema": {
- "$ref": "#/definitions/ExtendedLivySessionRequest"
+ "$ref": "#/definitions/SparkSessionOptions"
}
}
],
@@ -359,19 +298,19 @@
"200": {
"description": "Success",
"schema": {
- "$ref": "#/definitions/ExtendedLivySessionResponse"
+ "$ref": "#/definitions/SparkSession"
}
}
}
}
},
- "/livyApi/versions/{livyApiVersion}/sparkPools/{sparkPoolName}/sessions/{sessionId}": {
+ "/sessions/{sessionId}": {
"get": {
"tags": [
"SparkSession"
],
"description": "Gets a single spark session.",
- "operationId": "SparkSession_Get",
+ "operationId": "SparkSession_GetSparkSession",
"x-ms-examples": {
"Gets a single spark session.": {
"$ref": "./examples/SparkFrontend_SparkSession_Get.json"
@@ -384,16 +323,6 @@
"application/json"
],
"parameters": [
- {
- "$ref": "#/parameters/LivyApiVersionInPath"
- },
- {
- "name": "sparkPoolName",
- "in": "path",
- "description": "Name of the spark pool. \"ondemand\" targets the ondemand pool.",
- "required": true,
- "type": "string"
- },
{
"name": "sessionId",
"in": "path",
@@ -414,7 +343,7 @@
"200": {
"description": "Success",
"schema": {
- "$ref": "#/definitions/ExtendedLivySessionResponse"
+ "$ref": "#/definitions/SparkSession"
}
}
}
@@ -424,7 +353,7 @@
"SparkSession"
],
"description": "Cancels a running spark session.",
- "operationId": "SparkSession_Delete",
+ "operationId": "SparkSession_CancelSparkSession",
"x-ms-examples": {
"Cancels a running spark session.": {
"$ref": "./examples/SparkFrontend_SparkSession_Delete.json"
@@ -437,16 +366,6 @@
"application/json"
],
"parameters": [
- {
- "$ref": "#/parameters/LivyApiVersionInPath"
- },
- {
- "name": "sparkPoolName",
- "in": "path",
- "description": "Name of the spark pool. \"ondemand\"\r\n targets the ondemand pool.",
- "required": true,
- "type": "string"
- },
{
"name": "sessionId",
"in": "path",
@@ -463,13 +382,13 @@
}
}
},
- "/livyApi/versions/{livyApiVersion}/sparkPools/{sparkPoolName}/sessions/{sessionId}/reset-timeout": {
+ "/sessions/{sessionId}/reset-timeout": {
"put": {
"tags": [
"SparkSession"
],
"description": "Sends a keep alive call to the current session to reset the session timeout.",
- "operationId": "SparkSession_ResetTimeout",
+ "operationId": "SparkSession_ResetSparkSessionTimeout",
"x-ms-examples": {
"Reset the session timeout.": {
"$ref": "./examples/SparkFrontend_SparkSession_ResetTimeout.json"
@@ -482,16 +401,6 @@
"application/json"
],
"parameters": [
- {
- "$ref": "#/parameters/LivyApiVersionInPath"
- },
- {
- "name": "sparkPoolName",
- "in": "path",
- "description": "Name of the spark pool. \"ondemand\"\r\n targets the ondemand pool.",
- "required": true,
- "type": "string"
- },
{
"name": "sessionId",
"in": "path",
@@ -508,13 +417,13 @@
}
}
},
- "/livyApi/versions/{livyApiVersion}/sparkPools/{sparkPoolName}/sessions/{sessionId}/statements": {
+ "/sessions/{sessionId}/statements": {
"get": {
"tags": [
"SparkSession"
],
"description": "Gets a list of statements within a spark session.",
- "operationId": "SparkSession_ListStatements",
+ "operationId": "SparkSession_GetSparkStatements",
"x-ms-examples": {
"Gets a list of statements within a spark session.": {
"$ref": "./examples/SparkFrontend_SparkSession_ListStatements.json"
@@ -527,16 +436,6 @@
"application/json"
],
"parameters": [
- {
- "$ref": "#/parameters/LivyApiVersionInPath"
- },
- {
- "name": "sparkPoolName",
- "in": "path",
- "description": "Name of the spark pool. \"ondemand\" targets the ondemand pool.",
- "required": true,
- "type": "string"
- },
{
"name": "sessionId",
"in": "path",
@@ -550,7 +449,7 @@
"200": {
"description": "Success",
"schema": {
- "$ref": "#/definitions/LivyStatementsResponseBody"
+ "$ref": "#/definitions/SparkStatementCollection"
}
}
}
@@ -560,7 +459,7 @@
"SparkSession"
],
"description": "Create statement within a spark session.",
- "operationId": "SparkSession_CreateStatement",
+ "operationId": "SparkSession_CreateSparkStatement",
"x-ms-examples": {
"Create statement within a spark session.": {
"$ref": "./examples/SparkFrontend_SparkSession_CreateStatement.json"
@@ -573,16 +472,6 @@
"application/json"
],
"parameters": [
- {
- "$ref": "#/parameters/LivyApiVersionInPath"
- },
- {
- "name": "sparkPoolName",
- "in": "path",
- "description": "Name of the spark pool. \"ondemand\" targets the ondemand pool.",
- "required": true,
- "type": "string"
- },
{
"name": "sessionId",
"in": "path",
@@ -592,12 +481,12 @@
"format": "int32"
},
{
- "name": "livyRequest",
+ "name": "SparkStatementOptions",
"in": "body",
"description": "Livy compatible batch job request payload.",
"required": true,
"schema": {
- "$ref": "#/definitions/LivyStatementRequestBody"
+ "$ref": "#/definitions/SparkStatementOptions"
}
}
],
@@ -605,19 +494,19 @@
"200": {
"description": "Success",
"schema": {
- "$ref": "#/definitions/LivyStatementResponseBody"
+ "$ref": "#/definitions/SparkStatement"
}
}
}
}
},
- "/livyApi/versions/{livyApiVersion}/sparkPools/{sparkPoolName}/sessions/{sessionId}/statements/{statementId}": {
+ "/sessions/{sessionId}/statements/{statementId}": {
"get": {
"tags": [
"SparkSession"
],
"description": "Gets a single statement within a spark session.",
- "operationId": "SparkSession_GetStatement",
+ "operationId": "SparkSession_GetSparkStatement",
"x-ms-examples": {
"Gets a single statement within a spark session.": {
"$ref": "./examples/SparkFrontend_SparkSession_GetStatement.json"
@@ -630,16 +519,6 @@
"application/json"
],
"parameters": [
- {
- "$ref": "#/parameters/LivyApiVersionInPath"
- },
- {
- "name": "sparkPoolName",
- "in": "path",
- "description": "Name of the spark pool. \"ondemand\" targets the ondemand pool.",
- "required": true,
- "type": "string"
- },
{
"name": "sessionId",
"in": "path",
@@ -661,19 +540,19 @@
"200": {
"description": "Success",
"schema": {
- "$ref": "#/definitions/LivyStatementResponseBody"
+ "$ref": "#/definitions/SparkStatement"
}
}
}
}
},
- "/livyApi/versions/{livyApiVersion}/sparkPools/{sparkPoolName}/sessions/{sessionId}/statements/{statementId}/cancel": {
+ "/sessions/{sessionId}/statements/{statementId}/cancel": {
"post": {
"tags": [
"SparkSession"
],
"description": "Kill a statement within a session.",
- "operationId": "SparkSession_DeleteStatement",
+ "operationId": "SparkSession_CancelSparkStatement",
"x-ms-examples": {
"Kill a statement within a session.": {
"$ref": "./examples/SparkFrontend_SparkSession_DeleteStatement.json"
@@ -686,16 +565,6 @@
"application/json"
],
"parameters": [
- {
- "$ref": "#/parameters/LivyApiVersionInPath"
- },
- {
- "name": "sparkPoolName",
- "in": "path",
- "description": "Name of the spark pool. \"ondemand\" targets the ondemand pool.",
- "required": true,
- "type": "string"
- },
{
"name": "sessionId",
"in": "path",
@@ -717,7 +586,7 @@
"200": {
"description": "Success",
"schema": {
- "$ref": "#/definitions/LivyStatementCancellationResponse"
+ "$ref": "#/definitions/SparkStatementCancellationResult"
}
}
}
@@ -725,49 +594,63 @@
}
},
"definitions": {
- "ExtendedLivyListBatchResponse": {
+ "SparkBatchJobCollection": {
"type": "object",
"properties": {
"from": {
"format": "int32",
- "type": "integer"
+ "type": "integer",
+ "description": "The start index of fetched sessions."
},
"total": {
"format": "int32",
- "type": "integer"
+ "type": "integer",
+ "description": "Number of sessions fetched."
},
"sessions": {
"uniqueItems": false,
"type": "array",
+ "description": "Batch list",
"items": {
- "$ref": "#/definitions/ExtendedLivyBatchResponse"
+ "$ref": "#/definitions/SparkBatchJob"
}
}
- }
+ },
+ "required": [
+ "from",
+ "total"
+ ],
+ "description": "Response for batch list operation."
},
- "ExtendedLivyBatchResponse": {
+ "SparkBatchJob": {
"type": "object",
"properties": {
"livyInfo": {
- "$ref": "#/definitions/LivyBatchStateInformation"
+ "$ref": "#/definitions/SparkBatchJobState"
},
"name": {
- "type": "string"
+ "type": "string",
+ "description": "The batch name."
},
"workspaceName": {
- "type": "string"
+ "type": "string",
+ "description": "The workspace name."
},
"sparkPoolName": {
- "type": "string"
+ "type": "string",
+ "description": "The Spark pool name."
},
"submitterName": {
- "type": "string"
+ "type": "string",
+ "description": "The submitter name."
},
"submitterId": {
- "type": "string"
+ "type": "string",
+ "description": "The submitter identifier."
},
"artifactId": {
- "type": "string"
+ "type": "string",
+ "description": "The artifact identifier."
},
"jobType": {
"enum": [
@@ -775,10 +658,11 @@
"SparkSession"
],
"x-ms-enum": {
- "name": "JobType",
+ "name": "SparkJobType",
"modelAsString": true
},
- "type": "string"
+ "type": "string",
+ "description": "The job type."
},
"result": {
"enum": [
@@ -788,95 +672,121 @@
"Cancelled"
],
"x-ms-enum": {
- "name": "JobResult",
+ "name": "SparkBatchJobResultType",
"modelAsString": true
},
- "type": "string"
+ "type": "string",
+ "description": "The Spark batch job result."
},
"schedulerInfo": {
- "$ref": "#/definitions/SchedulerInformation"
+ "x-ms-client-name": "scheduler",
+ "$ref": "#/definitions/SparkScheduler",
+ "description": "The scheduler information."
},
"pluginInfo": {
- "$ref": "#/definitions/SparkServicePluginInformation"
+ "x-ms-client-name": "plugin",
+ "$ref": "#/definitions/SparkServicePlugin",
+ "description": "The plugin information."
},
"errorInfo": {
+ "x-ms-client-name": "errors",
"uniqueItems": false,
"type": "array",
"items": {
- "$ref": "#/definitions/ErrorInformation"
- }
+ "$ref": "#/definitions/SparkServiceError"
+ },
+ "description": "The error information."
},
"tags": {
"type": "object",
"additionalProperties": {
"type": "string"
- }
+ },
+ "description": "The tags."
},
"id": {
"format": "int32",
- "type": "integer"
+ "type": "integer",
+ "description": "The session Id."
},
"appId": {
- "type": "string"
+ "type": "string",
+ "description": "The application id of this session"
},
"appInfo": {
"type": "object",
"additionalProperties": {
"type": "string"
- }
+ },
+ "description": "The detailed application info."
},
"state": {
- "type": "string"
+ "type": "string",
+ "description": "The batch state"
},
"log": {
+ "x-ms-client-name": "logLines",
"uniqueItems": false,
"type": "array",
"items": {
"type": "string"
- }
+ },
+ "description": "The log lines."
}
- }
+ },
+ "required": [
+ "id"
+ ]
},
- "LivyBatchStateInformation": {
+ "SparkBatchJobState": {
"type": "object",
"properties": {
"notStartedAt": {
"format": "date-time",
- "type": "string"
+ "type": "string",
+ "description": "the time that at which \"not_started\" livy state was first seen."
},
"startingAt": {
"format": "date-time",
- "type": "string"
+ "type": "string",
+ "description": "the time that at which \"starting\" livy state was first seen."
},
"runningAt": {
"format": "date-time",
- "type": "string"
+ "type": "string",
+ "description": "the time that at which \"running\" livy state was first seen."
},
"deadAt": {
"format": "date-time",
- "type": "string"
+ "type": "string",
+ "description": "time that at which \"dead\" livy state was first seen."
},
"successAt": {
"format": "date-time",
- "type": "string"
+ "type": "string",
+ "description": "the time that at which \"success\" livy state was first seen."
},
"killedAt": {
+ "x-ms-client-name": "terminatedAt",
"format": "date-time",
- "type": "string"
+ "type": "string",
+ "description": "the time that at which \"killed\" livy state was first seen."
},
"recoveringAt": {
"format": "date-time",
- "type": "string"
+ "type": "string",
+ "description": "the time that at which \"recovering\" livy state was first seen."
},
"currentState": {
- "type": "string"
+ "type": "string",
+ "description": "the Spark job state."
},
"jobCreationRequest": {
- "$ref": "#/definitions/LivyRequestBase"
+ "$ref": "#/definitions/SparkRequest"
}
}
},
- "SchedulerInformation": {
+ "SparkScheduler": {
"type": "object",
"properties": {
"submittedAt": {
@@ -909,7 +819,7 @@
}
}
},
- "SparkServicePluginInformation": {
+ "SparkServicePlugin": {
"type": "object",
"properties": {
"preparationStartedAt": {
@@ -950,7 +860,7 @@
}
}
},
- "ErrorInformation": {
+ "SparkServiceError": {
"type": "object",
"properties": {
"message": {
@@ -967,14 +877,14 @@
"Dependency"
],
"x-ms-enum": {
- "name": "ErrorSource",
+ "name": "SparkErrorSource",
"modelAsString": true
},
"type": "string"
}
}
},
- "LivyRequestBase": {
+ "SparkRequest": {
"type": "object",
"properties": {
"name": {
@@ -987,6 +897,7 @@
"type": "string"
},
"args": {
+ "x-ms-client-name": "arguments",
"uniqueItems": false,
"type": "array",
"items": {
@@ -1000,6 +911,14 @@
"type": "string"
}
},
+ "pyFiles": {
+ "x-ms-client-name": "pythonFiles",
+ "uniqueItems": false,
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
"files": {
"uniqueItems": false,
"type": "array",
@@ -1015,6 +934,7 @@
}
},
"conf": {
+ "x-ms-client-name": "configuration",
"type": "object",
"additionalProperties": {
"type": "string"
@@ -1035,12 +955,13 @@
"type": "integer"
},
"numExecutors": {
+ "x-ms-client-name": "executorCount",
"format": "int32",
"type": "integer"
}
}
},
- "ExtendedLivyBatchRequest": {
+ "sparkBatchJobOptions": {
"type": "object",
"properties": {
"tags": {
@@ -1062,6 +983,7 @@
"type": "string"
},
"args": {
+ "x-ms-client-name": "arguments",
"uniqueItems": false,
"type": "array",
"items": {
@@ -1075,6 +997,14 @@
"type": "string"
}
},
+ "pyFiles": {
+ "x-ms-client-name": "pythonFiles",
+ "uniqueItems": false,
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
"files": {
"uniqueItems": false,
"type": "array",
@@ -1090,6 +1020,7 @@
}
},
"conf": {
+ "x-ms-client-name": "configuration",
"type": "object",
"additionalProperties": {
"type": "string"
@@ -1110,12 +1041,17 @@
"type": "integer"
},
"numExecutors": {
+ "x-ms-client-name": "executorCount",
"format": "int32",
"type": "integer"
}
- }
+ },
+ "required": [
+ "name",
+ "file"
+ ]
},
- "ExtendedLivyListSessionResponse": {
+ "SparkSessionCollection": {
"type": "object",
"properties": {
"from": {
@@ -1130,16 +1066,20 @@
"uniqueItems": false,
"type": "array",
"items": {
- "$ref": "#/definitions/ExtendedLivySessionResponse"
+ "$ref": "#/definitions/SparkSession"
}
}
- }
+ },
+ "required": [
+ "from",
+ "total"
+ ]
},
- "ExtendedLivySessionResponse": {
+ "SparkSession": {
"type": "object",
"properties": {
"livyInfo": {
- "$ref": "#/definitions/LivySessionStateInformation"
+ "$ref": "#/definitions/SparkSessionState"
},
"name": {
"type": "string"
@@ -1165,7 +1105,7 @@
"SparkSession"
],
"x-ms-enum": {
- "name": "JobType",
+ "name": "SparkJobType",
"modelAsString": true
},
"type": "string"
@@ -1178,22 +1118,25 @@
"Cancelled"
],
"x-ms-enum": {
- "name": "JobResult",
+ "name": "SparkSessionResultType",
"modelAsString": true
},
"type": "string"
},
"schedulerInfo": {
- "$ref": "#/definitions/SchedulerInformation"
+ "x-ms-client-name": "scheduler",
+ "$ref": "#/definitions/SparkScheduler"
},
"pluginInfo": {
- "$ref": "#/definitions/SparkServicePluginInformation"
+ "x-ms-client-name": "plugin",
+ "$ref": "#/definitions/SparkServicePlugin"
},
"errorInfo": {
+ "x-ms-client-name": "errors",
"uniqueItems": false,
"type": "array",
"items": {
- "$ref": "#/definitions/ErrorInformation"
+ "$ref": "#/definitions/SparkServiceError"
}
},
"tags": {
@@ -1219,15 +1162,19 @@
"type": "string"
},
"log": {
+ "x-ms-client-name": "logLines",
"uniqueItems": false,
"type": "array",
"items": {
"type": "string"
}
}
- }
+ },
+ "required": [
+ "id"
+ ]
},
- "LivySessionStateInformation": {
+ "SparkSessionState": {
"type": "object",
"properties": {
"notStartedAt": {
@@ -1251,6 +1198,7 @@
"type": "string"
},
"killedAt": {
+ "x-ms-client-name": "terminatedAt",
"format": "date-time",
"type": "string"
},
@@ -1270,11 +1218,11 @@
"type": "string"
},
"jobCreationRequest": {
- "$ref": "#/definitions/LivyRequestBase"
+ "$ref": "#/definitions/SparkRequest"
}
}
},
- "ExtendedLivySessionRequest": {
+ "SparkSessionOptions": {
"type": "object",
"properties": {
"tags": {
@@ -1296,6 +1244,7 @@
"type": "string"
},
"args": {
+ "x-ms-client-name": "arguments",
"uniqueItems": false,
"type": "array",
"items": {
@@ -1309,6 +1258,14 @@
"type": "string"
}
},
+ "pyFiles": {
+ "x-ms-client-name": "pythonFiles",
+ "uniqueItems": false,
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
"files": {
"uniqueItems": false,
"type": "array",
@@ -1324,6 +1281,7 @@
}
},
"conf": {
+ "x-ms-client-name": "configuration",
"type": "object",
"additionalProperties": {
"type": "string"
@@ -1344,15 +1302,20 @@
"type": "integer"
},
"numExecutors": {
+ "x-ms-client-name": "executorCount",
"format": "int32",
"type": "integer"
}
- }
+ },
+ "required": [
+ "name"
+ ]
},
- "LivyStatementsResponseBody": {
+ "SparkStatementCollection": {
"type": "object",
"properties": {
"total_statements": {
+ "x-ms-client-name": "total",
"format": "int32",
"type": "integer"
},
@@ -1360,12 +1323,15 @@
"uniqueItems": false,
"type": "array",
"items": {
- "$ref": "#/definitions/LivyStatementResponseBody"
+ "$ref": "#/definitions/SparkStatement"
}
}
- }
+ },
+ "required": [
+ "total_statements"
+ ]
},
- "LivyStatementResponseBody": {
+ "SparkStatement": {
"type": "object",
"properties": {
"id": {
@@ -1379,11 +1345,14 @@
"type": "string"
},
"output": {
- "$ref": "#/definitions/LivyStatementOutput"
+ "$ref": "#/definitions/SparkStatementOutput"
}
- }
+ },
+ "required": [
+ "id"
+ ]
},
- "LivyStatementOutput": {
+ "SparkStatementOutput": {
"type": "object",
"properties": {
"status": {
@@ -1397,9 +1366,11 @@
"type": "object"
},
"ename": {
+ "x-ms-client-name": "errorName",
"type": "string"
},
"evalue": {
+ "x-ms-client-name": "errorValue",
"type": "string"
},
"traceback": {
@@ -1409,20 +1380,33 @@
"type": "string"
}
}
- }
+ },
+ "required": [
+ "execution_count"
+ ]
},
- "LivyStatementRequestBody": {
+ "SparkStatementOptions": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"kind": {
+ "enum": [
+ "spark",
+ "pyspark",
+ "dotnetspark",
+ "sql"
+ ],
+ "x-ms-enum": {
+ "name": "SparkStatementLanguageType",
+ "modelAsString": true
+ },
"type": "string"
}
}
},
- "LivyStatementCancellationResponse": {
+ "SparkStatementCancellationResult": {
"type": "object",
"properties": {
"msg": {
@@ -1432,7 +1416,16 @@
}
},
"parameters": {
- "LivyApiVersionInPath": {
+ "Endpoint": {
+ "name": "endpoint",
+ "description": "The workspace development endpoint, for example https://myworkspace.dev.azuresynapse.net.",
+ "required": true,
+ "type": "string",
+ "in": "path",
+ "x-ms-skip-url-encoding": true,
+ "x-ms-parameter-location": "client"
+ },
+ "LivyApiVersion": {
"name": "livyApiVersion",
"in": "path",
"description": "Valid api-version for the request.",
@@ -1442,14 +1435,13 @@
"x-ms-skip-url-encoding": true,
"x-ms-parameter-location": "client"
},
- "SynapseDnsSuffixInPath": {
- "name": "SynapseDnsSuffix",
+ "SparkPoolName": {
+ "name": "sparkPoolName",
"in": "path",
+ "description": "Name of the spark pool.",
"required": true,
"type": "string",
- "default": "dev.azuresynapse.net",
"x-ms-skip-url-encoding": true,
- "description": "Gets the DNS suffix used as the base for all Synapse service requests.",
"x-ms-parameter-location": "client"
}
}
diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/examples/RoleAssignments_CreateRoleAssignment.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2020-02-01-preview/examples/RoleAssignments_CreateRoleAssignment.json
similarity index 85%
rename from specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/examples/RoleAssignments_CreateRoleAssignment.json
rename to specification/synapse/data-plane/Microsoft.Synapse/preview/2020-02-01-preview/examples/RoleAssignments_CreateRoleAssignment.json
index 97212e8071ce..bca528607878 100644
--- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/examples/RoleAssignments_CreateRoleAssignment.json
+++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2020-02-01-preview/examples/RoleAssignments_CreateRoleAssignment.json
@@ -1,9 +1,8 @@
{
"parameters": {
- "workspaceName": "exampleWorkspace",
- "SynapseDnsSuffix": "azuresynapse.net",
+ "endpoint": "exampleWorkspace.dev.azuresynapse.net",
"api-version": "2020-02-01-preview",
- "request": {
+ "createRoleAssignmentOptions": {
"roleId": "00000000-0000-0000-0000-000000000000",
"principalId": "00000000-0000-0000-0000-000000000000"
}
diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/examples/RoleAssignments_DeleteRoleAssignmentById.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2020-02-01-preview/examples/RoleAssignments_DeleteRoleAssignmentById.json
similarity index 81%
rename from specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/examples/RoleAssignments_DeleteRoleAssignmentById.json
rename to specification/synapse/data-plane/Microsoft.Synapse/preview/2020-02-01-preview/examples/RoleAssignments_DeleteRoleAssignmentById.json
index ba09f1f27aa0..0171f555a8cf 100644
--- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/examples/RoleAssignments_DeleteRoleAssignmentById.json
+++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2020-02-01-preview/examples/RoleAssignments_DeleteRoleAssignmentById.json
@@ -1,7 +1,6 @@
{
"parameters": {
- "workspaceName": "exampleWorkspace",
- "SynapseDnsSuffix": "azuresynapse.net",
+ "endpoint": "exampleWorkspace.dev.azuresynapse.net",
"roleAssignmentId": "00000000-0000-0000-0000-000000000000-00000000-0000-0000-0000-000000000000",
"api-version": "2020-02-01-preview"
},
diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/examples/RoleAssignments_GetRoleAssignmentById.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2020-02-01-preview/examples/RoleAssignments_GetRoleAssignmentById.json
similarity index 87%
rename from specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/examples/RoleAssignments_GetRoleAssignmentById.json
rename to specification/synapse/data-plane/Microsoft.Synapse/preview/2020-02-01-preview/examples/RoleAssignments_GetRoleAssignmentById.json
index 4374be7f52ec..2e0e8d8896bf 100644
--- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/examples/RoleAssignments_GetRoleAssignmentById.json
+++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2020-02-01-preview/examples/RoleAssignments_GetRoleAssignmentById.json
@@ -1,7 +1,6 @@
{
"parameters": {
- "workspaceName": "exampleWorkspace",
- "SynapseDnsSuffix": "azuresynapse.net",
+ "endpoint": "exampleWorkspace.dev.azuresynapse.net",
"roleAssignmentId": "00000000-0000-0000-0000-000000000000-00000000-0000-0000-0000-000000000000",
"api-version": "2020-02-01-preview"
},
diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/examples/RoleAssignments_ListCallerRoleAssignments.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2020-02-01-preview/examples/RoleAssignments_ListCallerRoleAssignments.json
similarity index 81%
rename from specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/examples/RoleAssignments_ListCallerRoleAssignments.json
rename to specification/synapse/data-plane/Microsoft.Synapse/preview/2020-02-01-preview/examples/RoleAssignments_ListCallerRoleAssignments.json
index 2dca414a3784..becbc1cd5b26 100644
--- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/examples/RoleAssignments_ListCallerRoleAssignments.json
+++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2020-02-01-preview/examples/RoleAssignments_ListCallerRoleAssignments.json
@@ -1,7 +1,6 @@
{
"parameters": {
- "workspaceName": "exampleWorkspace",
- "SynapseDnsSuffix": "azuresynapse.net",
+ "endpoint": "exampleWorkspace.dev.azuresynapse.net",
"api-version": "2020-02-01-preview"
},
"responses": {
diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/examples/RoleAssignments_ListRoleAssignments.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2020-02-01-preview/examples/RoleAssignments_ListRoleAssignments.json
similarity index 91%
rename from specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/examples/RoleAssignments_ListRoleAssignments.json
rename to specification/synapse/data-plane/Microsoft.Synapse/preview/2020-02-01-preview/examples/RoleAssignments_ListRoleAssignments.json
index f1af57ba8b4b..c9a190167d43 100644
--- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/examples/RoleAssignments_ListRoleAssignments.json
+++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2020-02-01-preview/examples/RoleAssignments_ListRoleAssignments.json
@@ -1,7 +1,6 @@
{
"parameters": {
- "workspaceName": "exampleWorkspace",
- "SynapseDnsSuffix": "azuresynapse.net",
+ "endpoint": "exampleWorkspace.dev.azuresynapse.net",
"api-version": "2020-02-01-preview",
"roleId": "00000000-0000-0000-0000-000000000000",
"principalId": "00000000-0000-0000-0000-000000000000"
diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/examples/Roles_GetRoleById.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2020-02-01-preview/examples/Roles_GetRoleById.json
similarity index 84%
rename from specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/examples/Roles_GetRoleById.json
rename to specification/synapse/data-plane/Microsoft.Synapse/preview/2020-02-01-preview/examples/Roles_GetRoleById.json
index 5c6f07d2e9f0..7b709acbdfff 100644
--- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/examples/Roles_GetRoleById.json
+++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2020-02-01-preview/examples/Roles_GetRoleById.json
@@ -1,7 +1,6 @@
{
"parameters": {
- "workspaceName": "exampleWorkspace",
- "SynapseDnsSuffix": "azuresynapse.net",
+ "endpoint": "exampleWorkspace.dev.azuresynapse.net",
"roleId": "00000000-0000-0000-0000-000000000000",
"api-version": "2020-02-01-preview"
},
diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/examples/Roles_ListRoles.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2020-02-01-preview/examples/Roles_ListRoles.json
similarity index 87%
rename from specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/examples/Roles_ListRoles.json
rename to specification/synapse/data-plane/Microsoft.Synapse/preview/2020-02-01-preview/examples/Roles_ListRoles.json
index 74838831ed04..305559688c49 100644
--- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/examples/Roles_ListRoles.json
+++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2020-02-01-preview/examples/Roles_ListRoles.json
@@ -1,7 +1,6 @@
{
"parameters": {
- "workspaceName": "exampleWorkspace",
- "SynapseDnsSuffix": "azuresynapse.net",
+ "endpoint": "exampleWorkspace.dev.azuresynapse.net",
"api-version": "2020-02-01-preview"
},
"responses": {
diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/roleAssignments.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2020-02-01-preview/roleAssignments.json
similarity index 88%
rename from specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/roleAssignments.json
rename to specification/synapse/data-plane/Microsoft.Synapse/preview/2020-02-01-preview/roleAssignments.json
index 922d6074a432..634133c68370 100644
--- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/roleAssignments.json
+++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2020-02-01-preview/roleAssignments.json
@@ -1,22 +1,15 @@
{
"swagger": "2.0",
"info": {
- "version": "2019-11-01-preview",
- "title": "SynapseClient"
+ "version": "2020-02-01-preview",
+ "title": "AccessControlClient"
},
"x-ms-parameterized-host": {
- "hostTemplate": "{workspaceName}.{SynapseDnsSuffix}",
+ "hostTemplate": "{endpoint}",
+ "useSchemePrefix": false,
"parameters": [
{
- "name": "workspaceName",
- "description": "The name of the workspace to execute operations on.",
- "required": true,
- "type": "string",
- "in": "path",
- "x-ms-skip-url-encoding": true
- },
- {
- "$ref": "#/parameters/SynapseDnsSuffixInPath"
+ "$ref": "#/parameters/Endpoint"
}
]
},
@@ -29,7 +22,7 @@
"tags": [
"RoleAssignments"
],
- "operationId": "RoleAssignments_CreateRoleAssignment",
+ "operationId": "AccessControl_CreateRoleAssignment",
"description": "Create role assignment.",
"x-ms-examples": {
"Create role assignment": {
@@ -44,12 +37,12 @@
],
"parameters": [
{
- "name": "request",
+ "name": "createRoleAssignmentOptions",
"in": "body",
"required": true,
"description": "Details of role id and object id.",
"schema": {
- "$ref": "#/definitions/RoleAssignmentRequest"
+ "$ref": "#/definitions/RoleAssignmentOptions"
}
},
{
@@ -75,7 +68,7 @@
"tags": [
"RoleAssignments"
],
- "operationId": "RoleAssignments_ListRoleAssignments",
+ "operationId": "AccessControl_GetRoleAssignments",
"description": "List role assignments.",
"x-ms-examples": {
"Get role assignment information": {
@@ -127,7 +120,7 @@
"tags": [
"RoleAssignments"
],
- "operationId": "RoleAssignments_GetRoleAssignmentById",
+ "operationId": "AccessControl_GetRoleAssignmentById",
"description": "Get role assignment by role assignment Id.",
"x-ms-examples": {
"Get role assignment information": {
@@ -141,6 +134,9 @@
"parameters": [
{
"$ref": "#/parameters/RoleAssignmentIdParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
}
],
"responses": {
@@ -162,7 +158,7 @@
"tags": [
"RoleAssignments"
],
- "operationId": "RoleAssignments_DeleteRoleAssignmentById",
+ "operationId": "AccessControl_DeleteRoleAssignmentById",
"description": "Delete role assignment by role assignment Id.",
"x-ms-examples": {
"Delete role assignment": {
@@ -176,6 +172,9 @@
"parameters": [
{
"$ref": "#/parameters/RoleAssignmentIdParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
}
],
"responses": {
@@ -199,7 +198,7 @@
"tags": [
"RoleAssignments"
],
- "operationId": "RoleAssignments_ListCallerRoleAssignments",
+ "operationId": "AccessControl_GetCallerRoleAssignments",
"description": "List role assignments of the caller.",
"x-ms-examples": {
"Get caller role assignments": {
@@ -222,7 +221,6 @@
"type": "array",
"items": {
"description": "Role ID of the Synapse Built-In Role",
- "format": "uuid",
"type": "string"
}
}
@@ -298,18 +296,16 @@
"$ref": "#/definitions/RoleAssignmentDetails"
}
},
- "RoleAssignmentRequest": {
+ "RoleAssignmentOptions": {
"description": "Role Assignment request details",
"type": "object",
"properties": {
"roleId": {
"description": "Role ID of the Synapse Built-In Role",
- "format": "uuid",
"type": "string"
},
"principalId": {
"description": "Object ID of the AAD principal or security-group",
- "format": "uuid",
"type": "string"
}
},
@@ -328,18 +324,25 @@
},
"roleId": {
"description": "Role ID of the Synapse Built-In Role",
- "format": "uuid",
"type": "string"
},
"principalId": {
"description": "Object ID of the AAD principal or security-group",
- "format": "uuid",
"type": "string"
}
}
}
},
"parameters": {
+ "Endpoint": {
+ "name": "endpoint",
+ "description": "The workspace development endpoint, for example https://myworkspace.dev.azuresynapse.net.",
+ "required": true,
+ "type": "string",
+ "in": "path",
+ "x-ms-skip-url-encoding": true,
+ "x-ms-parameter-location": "client"
+ },
"ApiVersionParameter": {
"name": "api-version",
"in": "query",
@@ -347,16 +350,6 @@
"type": "string",
"description": "The Synapse client API Version."
},
- "SynapseDnsSuffixInPath": {
- "name": "SynapseDnsSuffix",
- "in": "path",
- "required": true,
- "type": "string",
- "default": "dev.azuresynapse.net",
- "x-ms-skip-url-encoding": true,
- "description": "Gets the DNS suffix used as the base for all Synapse service requests.",
- "x-ms-parameter-location": "client"
- },
"RoleIdParameterInQuery": {
"name": "roleId",
"in": "query",
@@ -384,6 +377,7 @@
},
"XMsContinuationToken": {
"name": "x-ms-continuation",
+ "x-ms-client-name": "continuationToken",
"in": "header",
"required": false,
"type": "string",
diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/roles.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2020-02-01-preview/roles.json
similarity index 83%
rename from specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/roles.json
rename to specification/synapse/data-plane/Microsoft.Synapse/preview/2020-02-01-preview/roles.json
index f566e171de1f..f17f83f41ade 100644
--- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/roles.json
+++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2020-02-01-preview/roles.json
@@ -1,22 +1,15 @@
{
"swagger": "2.0",
"info": {
- "version": "2019-11-01-preview",
- "title": "SynapseClient"
+ "version": "2020-02-01-preview",
+ "title": "AccessControlClient"
},
"x-ms-parameterized-host": {
- "hostTemplate": "{workspaceName}.{SynapseDnsSuffix}",
+ "hostTemplate": "{endpoint}",
+ "useSchemePrefix": false,
"parameters": [
{
- "name": "workspaceName",
- "description": "The name of the workspace to execute operations on.",
- "required": true,
- "type": "string",
- "in": "path",
- "x-ms-skip-url-encoding": true
- },
- {
- "$ref": "#/parameters/SynapseDnsSuffixInPath"
+ "$ref": "#/parameters/Endpoint"
}
]
},
@@ -29,7 +22,7 @@
"tags": [
"SynapseRoles"
],
- "operationId": "Roles_ListRoles",
+ "operationId": "AccessControl_GetRoleDefinitions",
"description": "List roles.",
"x-ms-examples": {
"Get access control information": {
@@ -69,7 +62,7 @@
"tags": [
"SynapseRoles"
],
- "operationId": "Roles_GetRoleById",
+ "operationId": "AccessControl_GetRoleDefinitionById",
"description": "Get role by role Id.",
"x-ms-examples": {
"Get access control information": {
@@ -83,6 +76,9 @@
"parameters": [
{
"$ref": "#/parameters/RoleIdParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
}
],
"responses": {
@@ -129,7 +125,6 @@
"properties": {
"id": {
"description": "Role ID",
- "format": "uuid",
"type": "string"
},
"name": {
@@ -140,10 +135,22 @@
"description": "Is a built-in role or not",
"type": "boolean"
}
- }
+ },
+ "required": [
+ "isBuiltIn"
+ ]
}
},
"parameters": {
+ "Endpoint": {
+ "name": "endpoint",
+ "description": "The workspace development endpoint, for example https://myworkspace.dev.azuresynapse.net.",
+ "required": true,
+ "type": "string",
+ "in": "path",
+ "x-ms-skip-url-encoding": true,
+ "x-ms-parameter-location": "client"
+ },
"ApiVersionParameter": {
"name": "api-version",
"in": "query",
@@ -151,16 +158,6 @@
"type": "string",
"description": "The Synapse client API Version."
},
- "SynapseDnsSuffixInPath": {
- "name": "SynapseDnsSuffix",
- "in": "path",
- "required": true,
- "type": "string",
- "default": "dev.azuresynapse.net",
- "x-ms-skip-url-encoding": true,
- "description": "Gets the DNS suffix used as the base for all Synapse service requests.",
- "x-ms-parameter-location": "client"
- },
"RoleIdParameter": {
"name": "roleId",
"in": "path",
diff --git a/specification/synapse/data-plane/readme.md b/specification/synapse/data-plane/readme.md
index f2f3be08766f..27db372758be 100644
--- a/specification/synapse/data-plane/readme.md
+++ b/specification/synapse/data-plane/readme.md
@@ -20,14 +20,64 @@ To see additional help and options, run:
## Configuration
-
-
### Basic Information
These are the global settings for the Azure Synapse Analytics API.
``` yaml
openapi-type: data-plane
-tag: package-2019-11-01-preview
+```
+
+``` yaml $(package-spark)
+tag: package-spark-2019-11-01-preview
+```
+
+``` yaml $(package-artifacts)
+tag: package-artifacts-2019-06-01-preview
+```
+
+``` yaml $(package-access-control)
+tag: package-access-control-2020-02-01-preview
+```
+
+``` yaml $(package-vnet)
+tag: package-vnet-2019-06-01-preview
+```
+
+### Tag: package-spark-2019-11-01-preview
+
+These settings apply only when `--tag=package-spark-2019-11-01-preview` is specified on the command line.
+
+``` yaml $(tag) == 'package-spark-2019-11-01-preview'
+input-file:
+- Microsoft.Synapse/preview/2019-11-01-preview/sparkJob.json
+```
+
+### Tag: package-artifacts-2019-06-01-preview
+
+These settings apply only when `--tag=package-artifacts-2019-06-01-preview` is specified on the command line.
+
+``` yaml $(tag) == 'package-artifacts-2019-06-01-preview'
+input-file:
+- Microsoft.Synapse/preview/2019-06-01-preview/artifacts.json
+```
+
+### Tag: package-access-control-2020-02-01-preview
+
+These settings apply only when `--tag=package-access-control-2020-02-01-preview` is specified on the command line.
+
+``` yaml $(tag) == 'package-access-control-2020-02-01-preview'
+input-file:
+- Microsoft.Synapse/preview/2020-02-01-preview/roles.json
+- Microsoft.Synapse/preview/2020-02-01-preview/roleAssignments.json
+```
+
+### Tag: package-vnet-2019-06-01-preview
+
+These settings apply only when `--tag=package-vnet-2019-06-01-preview` is specified on the command line
+
+``` yaml $(tag) == 'package-vnet-2019-06-01-preview'
+input-file:
+- Microsoft.Synapse/preview/2019-06-01-preview/managedPrivateEndpoints.json
```
## Suppression
@@ -35,14 +85,14 @@ tag: package-2019-11-01-preview
directive:
- suppress: DefinitionsPropertiesNamesCamelCase
reason: This would require a breaking change, and need to be consistent with the response from RP side.
- from: Microsoft.Synapse/preview/2019-11-01-preview/sparkFrontend.json
+ from: sparkJob.json
where:
- - $.definitions.LivyStatementsResponseBody.properties.total_statements
- - $.definitions.LivyStatementOutput.properties.execution_count
+ - $.definitions.SparkStatementCollection.properties.total_statements
+ - $.definitions.SparkStatementOutput.properties.execution_count
- suppress: DefinitionsPropertiesNamesCamelCase
- reason: These properties need to keep the same with jupyter notebook. Rp can't change these proeprties.
- from: Microsoft.Synapse/preview/2019-11-01-preview/adf/entityTypes/NoteBook.json
+ reason: These properties need to keep the same with jupyter Notebook. Rp can't change these proeprties.
+ from: Notebook.json
where:
- $.definitions.NotebookCellOutputItem.properties.execution_count
- $.definitions.NotebookCellOutputItem.properties.output_type
@@ -50,26 +100,12 @@ directive:
- $.definitions.NotebookLanguageInfo.properties.codemirror_mode
- $.definitions.NotebookKernelSpec.properties.display_name
- $.definitions.NotebookMetadata.properties.language_info
- - $.definitions.NoteBook.properties.nbformat_minor
-```
-
-### Tag: package-2019-11-01-preview
-
-These settings apply only when `--tag=package-2019-11-01-preview` is specified on the command line
-
-``` yaml $(tag) == 'package-2019-11-01-preview'
-input-file:
-- Microsoft.Synapse/preview/2019-11-01-preview/monitoring.json
-- Microsoft.Synapse/preview/2019-11-01-preview/sparkFrontend.json
-- Microsoft.Synapse/preview/2019-11-01-preview/roles.json
-- Microsoft.Synapse/preview/2019-11-01-preview/roleAssignments.json
-- Microsoft.Synapse/preview/2019-11-01-preview/adf/datafactory.json
+ - $.definitions.Notebook.properties.nbformat_minor
```
---
# Code Generation
-
## Swagger to SDK
Swagger to SDK has been intentionally disabled for this spec.
@@ -86,6 +122,10 @@ csharp:
namespace: Microsoft.Azure.Synapse
output-folder: $(csharp-sdks-folder)/synapse/Microsoft.Azure.Synapse/src/Generated
clear-output-folder: true
+batch:
+ - package-spark: true
+ - package-artifacts: true
+ - package-access-control: true
```
## TypeScript
@@ -103,12 +143,11 @@ require: $(this-folder)/../../../profiles/readme.md
# all the input files across all versions
input-file:
+ - $(this-folder)/Microsoft.Synapse/preview/2019-06-01-preview/artifacts.json
+ - $(this-folder)/Microsoft.Synapse/preview/2019-11-01-preview/sparkJob.json
- $(this-folder)/Microsoft.Synapse/preview/2019-11-01-preview/monitoring.json
- - $(this-folder)/Microsoft.Synapse/preview/2019-11-01-preview/sparkFrontend.json
- - $(this-folder)/Microsoft.Synapse/preview/2019-11-01-preview/roles.json
- - $(this-folder)/Microsoft.Synapse/preview/2019-11-01-preview/roleAssignments.json
- - $(this-folder)/Microsoft.Synapse/preview/2019-11-01-preview/adf/datafactory.json
-
+ - $(this-folder)/Microsoft.Synapse/preview/2020-02-01-preview/roles.json
+ - $(this-folder)/Microsoft.Synapse/preview/2020-02-01-preview/roleAssignments.json
```
If there are files that should not be in the `all-api-versions` set,
diff --git a/specification/synapse/data-plane/readme.python.md b/specification/synapse/data-plane/readme.python.md
index cf2ba5dbe061..30169a5bf708 100644
--- a/specification/synapse/data-plane/readme.python.md
+++ b/specification/synapse/data-plane/readme.python.md
@@ -5,21 +5,30 @@ Please also specify `--python-sdks-folder=`.
+
+```yaml $(csharp)
+csharp:
+ package-version: 0.3.0
+ azure-arm: true
+ license-header: MICROSOFT_MIT_NO_VERSION
+ payload-flattening-threshold: 2
+ clear-output-folder: true
+ namespace: Microsoft.Azure.Management.VMware
+ output-folder: $(csharp-sdks-folder)/VMware/Management.VMware/Generated
+```
\ No newline at end of file
diff --git a/specification/vmware/resource-manager/readme.md b/specification/vmware/resource-manager/readme.md
new file mode 100644
index 000000000000..a2a404bfe4b6
--- /dev/null
+++ b/specification/vmware/resource-manager/readme.md
@@ -0,0 +1,96 @@
+# VMware Solution
+
+> see https://aka.ms/autorest
+
+This is the AutoRest configuration file for VMware Solution.
+
+## Getting Started
+To build the SDK for VMware Solution, 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 VMware Solution API.
+
+``` yaml
+openapi-type: arm
+tag: package-2019-08-09-preview
+```
+
+### Tag: package-2019-08-09-preview
+
+These settings apply only when `--tag=package-2019-08-09-preview` is specified on the command line.
+
+``` yaml $(tag) == 'package-2019-08-09-preview'
+input-file:
+- Microsoft.AVS/preview/2019-08-09-preview/vmware.json
+directive:
+ - suppress: R3020
+ from: vmware.json
+ reason: Microsoft.AVS was chosen over Microsoft.AzureVMwareSolution
+ - suppress: R3010
+ from: vmware.json
+ reason: list by immediate parent operations are defined
+ - suppress: R2001
+ from: vmware.json
+ reason: x-ms-client-flatten will be used in next API version
+```
+
+---
+# 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-js
+ - repo: azure-sdk-for-python
+ - repo: azure-sdk-for-net
+```
+
+## TypeScript
+
+See configuration in [readme.typescript.md](./readme.typescript.md)
+
+## Python
+
+See configuration in [readme.python.md](./readme.python.md)
+
+## C#
+
+See configuration in [readme.csharp.md](./readme.csharp.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.AVS/preview/2019-08-09-preview/vmware.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/vmware/resource-manager/readme.python.md b/specification/vmware/resource-manager/readme.python.md
new file mode 100644
index 000000000000..ab4c07555c3b
--- /dev/null
+++ b/specification/vmware/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:
+ package-version: 0.3.0
+ azure-arm: true
+ license-header: MICROSOFT_MIT_NO_VERSION
+ payload-flattening-threshold: 2
+ namespace: azure.mgmt.vmware
+ package-name: azure-mgmt-vmware
+ clear-output-folder: true
+```
+``` yaml $(python) && $(python-mode) == 'update'
+python:
+ no-namespace-folders: true
+ output-folder: $(python-sdks-folder)/compute/azure-mgmt-vmware/azure/mgmt/vmware
+```
+``` yaml $(python) && $(python-mode) == 'create'
+python:
+ basic-setup-py: true
+ output-folder: $(python-sdks-folder)/compute/azure-mgmt-vmware
+```
\ No newline at end of file
diff --git a/specification/vmware/resource-manager/readme.typescript.md b/specification/vmware/resource-manager/readme.typescript.md
new file mode 100644
index 000000000000..97824659f448
--- /dev/null
+++ b/specification/vmware/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:
+ package-version: 0.3.0
+ azure-arm: true
+ package-name: "@azure/arm-vmware"
+ output-folder: "$(typescript-sdks-folder)/sdk/vmware/arm-vmware"
+ payload-flattening-threshold: 1
+ generate-metadata: true
+```
\ No newline at end of file
diff --git a/specification/vmwarevirtustream/resource-manager/Microsoft.VMwareVirtustream/preview/2019-08-09-preview/examples/CheckQuotaAvailability.json b/specification/vmwarevirtustream/resource-manager/Microsoft.VMwareVirtustream/preview/2019-08-09-preview/examples/CheckQuotaAvailability.json
new file mode 100644
index 000000000000..98a126c10073
--- /dev/null
+++ b/specification/vmwarevirtustream/resource-manager/Microsoft.VMwareVirtustream/preview/2019-08-09-preview/examples/CheckQuotaAvailability.json
@@ -0,0 +1,18 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "api-version": "2019-08-09-preview",
+ "location": "eastus"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "hostsRemaining": {
+ "gp": 0,
+ "he": 999
+ },
+ "quotaEnabled": "Enabled"
+ }
+ }
+ }
+}
diff --git a/specification/vmwarevirtustream/resource-manager/Microsoft.VMwareVirtustream/preview/2019-08-09-preview/vmwarevirtustream.json b/specification/vmwarevirtustream/resource-manager/Microsoft.VMwareVirtustream/preview/2019-08-09-preview/vmwarevirtustream.json
index 14389afe3a36..3d7ca4fd555f 100644
--- a/specification/vmwarevirtustream/resource-manager/Microsoft.VMwareVirtustream/preview/2019-08-09-preview/vmwarevirtustream.json
+++ b/specification/vmwarevirtustream/resource-manager/Microsoft.VMwareVirtustream/preview/2019-08-09-preview/vmwarevirtustream.json
@@ -41,6 +41,14 @@
{
"name": "Clusters",
"description": ""
+ },
+ {
+ "name": "Operations",
+ "description": ""
+ },
+ {
+ "name": "Quotas",
+ "description": ""
}
],
"parameters": {
@@ -120,6 +128,49 @@
}
}
},
+ "/subscriptions/{subscriptionId}/providers/Microsoft.VMwareVirtustream/locations/{location}/checkQuotaAvailability": {
+ "post": {
+ "tags": [
+ "Quotas"
+ ],
+ "description": "Return quota for subscription by region",
+ "operationId": "CheckQuotaAvailability",
+ "parameters": [
+ {
+ "$ref": "#/parameters/subscriptionId"
+ },
+ {
+ "name": "location",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "Azure region"
+ },
+ {
+ "$ref": "#/parameters/apiVersion"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Request has succeeded",
+ "schema": {
+ "$ref": "#/definitions/Quota"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed",
+ "schema": {
+ "$ref": "#/definitions/ApiError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "CheckQuotaAvailability": {
+ "$ref": "./examples/CheckQuotaAvailability.json"
+ }
+ }
+ }
+ },
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VMwareVirtustream/privateClouds": {
"get": {
"operationId": "PrivateClouds_List",
@@ -702,6 +753,32 @@
}
},
"definitions": {
+ "Quota": {
+ "description": "Subscription quotas",
+ "properties": {
+ "hostsRemaining": {
+ "description": "Remaining hosts quota by sku type",
+ "type": "object",
+ "readOnly": true,
+ "additionalProperties": {
+ "type": "integer",
+ "readOnly": true
+ }
+ },
+ "quotaEnabled": {
+ "description": "Host quota is active for current subscription",
+ "type": "string",
+ "enum": [
+ "Enabled",
+ "Disabled"
+ ],
+ "x-ms-enum": {
+ "name": "QuotaEnabled",
+ "modelAsString": true
+ }
+ }
+ }
+ },
"Resource": {
"description": "The core properties of ARM resources",
"properties": {
diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2019-08-01/AppServicePlans.json b/specification/web/resource-manager/Microsoft.Web/stable/2019-08-01/AppServicePlans.json
index 487977095b1c..c5b99cff768f 100644
--- a/specification/web/resource-manager/Microsoft.Web/stable/2019-08-01/AppServicePlans.json
+++ b/specification/web/resource-manager/Microsoft.Web/stable/2019-08-01/AppServicePlans.json
@@ -1540,7 +1540,7 @@
"readOnly": true
},
"reserved": {
- "description": "If Linux app service plan true, false otherwise.",
+ "description": "This needs to set to true when creating a Linux App Service Plan, along with kind set to Linux. It should be false otherwise.",
"default": false,
"type": "boolean",
"x-ms-mutability": [
diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2019-08-01/CommonDefinitions.json b/specification/web/resource-manager/Microsoft.Web/stable/2019-08-01/CommonDefinitions.json
index fe02ddd901a7..cf72d9b7c660 100644
--- a/specification/web/resource-manager/Microsoft.Web/stable/2019-08-01/CommonDefinitions.json
+++ b/specification/web/resource-manager/Microsoft.Web/stable/2019-08-01/CommonDefinitions.json
@@ -1232,9 +1232,10 @@
"type": {
"description": "Type of managed service identity.",
"enum": [
- "None",
"SystemAssigned",
- "UserAssigned"
+ "UserAssigned",
+ "SystemAssigned, UserAssigned",
+ "None"
],
"type": "string",
"x-ms-enum": {
diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2019-08-01/WebApps.json b/specification/web/resource-manager/Microsoft.Web/stable/2019-08-01/WebApps.json
index 1efc1c1d5478..281daf0188c8 100644
--- a/specification/web/resource-manager/Microsoft.Web/stable/2019-08-01/WebApps.json
+++ b/specification/web/resource-manager/Microsoft.Web/stable/2019-08-01/WebApps.json
@@ -710,6 +710,253 @@
"x-ms-long-running-operation": true
}
},
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/basicPublishingCredentialsPolicies": {
+ "get": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Returns whether Scm basic auth is allowed and whether Ftp is allowed for a given site.",
+ "description": "Description for Returns whether Scm basic auth is allowed and whether Ftp is allowed for a given site.",
+ "operationId": "WebApps_GetBasicPublishingCredentialsPolicies",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/CsmPublishingCredentialsPoliciesCollection"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "List Publishing Credentials Policies": {
+ "$ref": "./examples/ListPublishingCredentialsPolicies.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/basicPublishingCredentialsPolicies/ftp": {
+ "get": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Returns whether FTP is allowed on the site or not.",
+ "description": "Description for Returns whether FTP is allowed on the site or not.",
+ "operationId": "WebApps_GetFtpAllowed",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/CsmPublishingCredentialsPoliciesEntity"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Get FTP Allowed": {
+ "$ref": "./examples/GetPublishingCredentialsPolicy.json"
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Updates whether FTP is allowed on the site or not.",
+ "description": "Description for Updates whether FTP is allowed on the site or not.",
+ "operationId": "WebApps_UpdateFtpAllowed",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "csmPublishingAccessPoliciesEntity",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/CsmPublishingCredentialsPoliciesEntity"
+ }
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/CsmPublishingCredentialsPoliciesEntity"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Update FTP Allowed": {
+ "$ref": "./examples/UpdatePublishingCredentialsPolicy.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/basicPublishingCredentialsPolicies/scm": {
+ "get": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Returns whether Scm basic auth is allowed on the site or not.",
+ "description": "Description for Returns whether Scm basic auth is allowed on the site or not.",
+ "operationId": "WebApps_GetScmAllowed",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/CsmPublishingCredentialsPoliciesEntity"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Get SCM Allowed": {
+ "$ref": "./examples/GetPublishingCredentialsPolicy.json"
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Updates whether user publishing credentials are allowed on the site or not.",
+ "description": "Description for Updates whether user publishing credentials are allowed on the site or not.",
+ "operationId": "WebApps_UpdateScmAllowed",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "csmPublishingAccessPoliciesEntity",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/CsmPublishingCredentialsPoliciesEntity"
+ }
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/CsmPublishingCredentialsPoliciesEntity"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Update SCM Allowed": {
+ "$ref": "./examples/UpdatePublishingCredentialsPolicy.json"
+ }
+ }
+ }
+ },
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config": {
"get": {
"tags": [
@@ -19827,9 +20074,10 @@
},
"identityType": {
"enum": [
- "None",
"SystemAssigned",
- "UserAssigned"
+ "UserAssigned",
+ "SystemAssigned, UserAssigned",
+ "None"
],
"type": "string",
"x-ms-enum": {
@@ -20581,6 +20829,59 @@
}
}
},
+ "CsmPublishingCredentialsPoliciesCollection": {
+ "description": "Publishing Credentials Policies collection.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "description": "CsmPublishingCredentialsPoliciesCollection resource specific properties",
+ "required": [
+ "ftp",
+ "scm"
+ ],
+ "properties": {
+ "ftp": {
+ "$ref": "#/definitions/CsmPublishingCredentialsPoliciesEntity",
+ "description": "Whether FTP is allowed."
+ },
+ "scm": {
+ "$ref": "#/definitions/CsmPublishingCredentialsPoliciesEntity",
+ "description": "Whether Scm Basic Auth is allowed."
+ }
+ },
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "CsmPublishingCredentialsPoliciesEntity": {
+ "description": "Publishing Credentials Policies parameters.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "description": "CsmPublishingCredentialsPoliciesEntity resource specific properties",
+ "required": [
+ "allow"
+ ],
+ "properties": {
+ "allow": {
+ "description": "true to allow access to a publishing method; otherwise, false.",
+ "type": "boolean"
+ }
+ },
+ "x-ms-client-flatten": true
+ }
+ }
+ },
"CsmPublishingProfileOptions": {
"description": "Publishing options for requested profile.",
"type": "object",
@@ -21289,9 +21590,10 @@
},
"identityType": {
"enum": [
- "None",
"SystemAssigned",
- "UserAssigned"
+ "UserAssigned",
+ "SystemAssigned, UserAssigned",
+ "None"
],
"type": "string",
"x-ms-enum": {
diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2019-08-01/examples/GetPublishingCredentialsPolicy.json b/specification/web/resource-manager/Microsoft.Web/stable/2019-08-01/examples/GetPublishingCredentialsPolicy.json
new file mode 100644
index 000000000000..1a2b02bb2b8d
--- /dev/null
+++ b/specification/web/resource-manager/Microsoft.Web/stable/2019-08-01/examples/GetPublishingCredentialsPolicy.json
@@ -0,0 +1,18 @@
+{
+ "parameters": {
+ "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345",
+ "resourceGroupName": "rg",
+ "name": "testSite",
+ "api-version": "2019-08-01"
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": {
+ "properties": {
+ "allow": false
+ }
+ }
+ }
+ }
+}
diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2019-08-01/examples/ListPublishingCredentialsPolicies.json b/specification/web/resource-manager/Microsoft.Web/stable/2019-08-01/examples/ListPublishingCredentialsPolicies.json
new file mode 100644
index 000000000000..f96c4a736517
--- /dev/null
+++ b/specification/web/resource-manager/Microsoft.Web/stable/2019-08-01/examples/ListPublishingCredentialsPolicies.json
@@ -0,0 +1,27 @@
+{
+ "parameters": {
+ "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345",
+ "resourceGroupName": "rg",
+ "name": "testSite",
+ "api-version": "2019-08-01"
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": {
+ "properties": {
+ "ftp": {
+ "properties": {
+ "allow": false
+ }
+ },
+ "scm": {
+ "properties": {
+ "allow": false
+ }
+ }
+ }
+ }
+ }
+ }
+}
diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2019-08-01/examples/UpdatePublishingCredentialsPolicy.json b/specification/web/resource-manager/Microsoft.Web/stable/2019-08-01/examples/UpdatePublishingCredentialsPolicy.json
new file mode 100644
index 000000000000..b8c83f16c837
--- /dev/null
+++ b/specification/web/resource-manager/Microsoft.Web/stable/2019-08-01/examples/UpdatePublishingCredentialsPolicy.json
@@ -0,0 +1,23 @@
+{
+ "parameters": {
+ "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345",
+ "resourceGroupName": "rg",
+ "name": "testSite",
+ "api-version": "2019-08-01",
+ "csmPublishingAccessPoliciesEntity": {
+ "properties": {
+ "allow": true
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": {
+ "properties": {
+ "allow": true
+ }
+ }
+ }
+ }
+}
diff --git a/specification/windowsiot/resource-manager/readme.az.md b/specification/windowsiot/resource-manager/readme.az.md
new file mode 100644
index 000000000000..59e35976c253
--- /dev/null
+++ b/specification/windowsiot/resource-manager/readme.az.md
@@ -0,0 +1,24 @@
+## AZ
+
+These settings apply only when `--az` is specified on the command line.
+
+``` yaml $(az)
+az:
+ extensions: windowsiotservices
+ namespace: azure.mgmt.windowsiot
+ package-name: azure-mgmt-windowsiot
+az-output-folder: $(azure-cli-extension-folder)/src/windowsiot
+python-sdk-output-folder: "$(az-output-folder)/azext_windowsiotservices/vendored_sdks/windowsiot"
+
+#cli:
+# cli-directive:
+# directive on operationGroup
+# - select: 'operationGroup'
+# where:
+# operationGroup: 'operations'
+# hidden: true
+# - where:
+# parameter: location
+# required: true
+
+```
diff --git a/specification/windowsiot/resource-manager/readme.cli.md b/specification/windowsiot/resource-manager/readme.cli.md
new file mode 100644
index 000000000000..a9e918eefe21
--- /dev/null
+++ b/specification/windowsiot/resource-manager/readme.cli.md
@@ -0,0 +1,9 @@
+ CLI
+
+These settings apply only when `--cli` is specified on the command line.
+
+``` yaml $(cli)
+#cli:
+# test-scenario:
+# - name: Factories_CreateOrUpdate
+```
diff --git a/specification/windowsiot/resource-manager/readme.md b/specification/windowsiot/resource-manager/readme.md
index c2d94f9818f4..ce4b3c452b4f 100644
--- a/specification/windowsiot/resource-manager/readme.md
+++ b/specification/windowsiot/resource-manager/readme.md
@@ -65,6 +65,7 @@ swagger-to-sdk:
- repo: azure-sdk-for-ruby
after_scripts:
- bundle install && rake arm:regen_all_profiles['azure_mgmt_windowsiot']
+ - repo: azure-cli-extensions
```
## C#
@@ -129,3 +130,17 @@ uncomment the `exclude-file` section below and add the file paths.
# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json
```
+## trenton
+
+These settings apply only when `--trenton` is specified on the command line.
+
+``` yaml $(trenton)
+trenton:
+ cli-name: windowsiot
+ azure_arm: true
+ license_header: MICROSOFT_MIT_NO_VERSION
+ payload_flattening_threshold: 2
+ namespace: windowsiot
+ package-name: windowsiot
+ clear_output_folder: false
+```
diff --git a/specification/windowsiot/resource-manager/readme.python.md b/specification/windowsiot/resource-manager/readme.python.md
index 3f3407198310..534f3b35f6c0 100644
--- a/specification/windowsiot/resource-manager/readme.python.md
+++ b/specification/windowsiot/resource-manager/readme.python.md
@@ -12,6 +12,7 @@ python:
payload-flattening-threshold: 2
namespace: azure.mgmt.windowsiot
package-name: azure-mgmt-windowsiot
+ package-version: 0.1.0
clear-output-folder: true
```
diff --git a/specificationRepositoryConfiguration.json b/specificationRepositoryConfiguration.json
index 84b1131de2e0..dbcddfeb40e2 100644
--- a/specificationRepositoryConfiguration.json
+++ b/specificationRepositoryConfiguration.json
@@ -20,6 +20,11 @@
"mainRepository": "Azure/azure-sdk-for-net"
},
"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"
},
@@ -33,8 +38,10 @@
"mainRepository": "Azure/azure-sdk-for-ruby"
},
"azure-sdk-for-trenton": {
- "integrationRepository": "test-repo-billy/azure-sdk-for-trenton",
- "mainRepository": "Azure/azure-sdk-for-trenton"
+ "integrationRepository": "Azure/azure-sdk-for-trenton",
+ "mainRepository": "Azure/azure-sdk-for-trenton",
+ "secondaryRepository": "Azure/azure-sdk-for-trenton",
+ "secondaryBranch": "secondary"
}
}
}